ot::Spinel::SpinelDriver class

Syntax

Show:

Summary

Declaration

class SpinelDriver : public otSpinelDriver, public Logger { public: typedef void ( *ReceivedFrameHandler)(const uint8_t *aFrame, uint16_t aLength, uint8_t aHeader, bool &aSave, void *aContext); typedef void (*SavedFrameHandler)(const uint8_t *aFrame, uint16_t aLength, void *aContext); SpinelDriver(void); CoprocessorType Init(SpinelInterface &aSpinelInterface, bool aSoftwareReset, const spinel_iid_t *aIidList, uint8_t aIidListLength); void Deinit(void); void ClearRxBuffer(void) { mRxFrameBuffer.Clear(); } void SetCoprocessorReady(void) { mIsCoprocessorReady = true; } otError SendReset(uint8_t aResetType); void ResetCoprocessor(bool aSoftwareReset); void Process(const void *aContext); bool HasPendingFrame(void) const { return mRxFrameBuffer.HasSavedFrame(); } const char *GetVersion(void) const { return mVersion; } otError SendCommand(uint32_t aCommand, spinel_prop_key_t aKey, spinel_tid_t aTid, const char *aFormat, va_list aArgs); otError SendCommand(uint32_t aCommand, spinel_prop_key_t aKey, spinel_tid_t aTid); void SetFrameHandler(ReceivedFrameHandler aReceivedFrameHandler, SavedFrameHandler aSavedFrameHandler, void *aContext); SpinelInterface *GetSpinelInterface(void) const { return mSpinelInterface; } bool CoprocessorHasCap(unsigned int aCapability) { return mCoprocessorCaps.Contains(aCapability); } spinel_iid_t GetIid(void) { return mIid; } private: static constexpr uint16_t kMaxSpinelFrame = SPINEL_FRAME_MAX_SIZE; static constexpr uint16_t kVersionStringSize = 128; static constexpr uint32_t kUsPerMs = 1000; static constexpr uint32_t kMaxWaitTime = 2000; static constexpr uint16_t kCapsBufferSize = 100; template <typename Type, uint16_t kMaxSize> class Array { static_assert(kMaxSize != 0, "Array `kMaxSize` cannot be zero"); public: Array(void) : mLength(0) { } uint16_t GetMaxSize(void) const { return kMaxSize; } bool IsFull(void) const { return (mLength == GetMaxSize()); } otError PushBack(const Type &aEntry) { return IsFull() ? OT_ERROR_NO_BUFS : (mElements[mLength++] = aEntry, OT_ERROR_NONE); } const Type *Find(const Type &aEntry) const { const Type *matched = nullptr; for (const Type &element : *this) { if (element == aEntry) { matched = &element; break; } } return matched; } bool Contains(const Type &aEntry) const { return Find(aEntry) != nullptr; } Type *begin(void) { return &mElements[0]; } Type *end(void) { return &mElements[mLength]; } const Type *begin(void) const { return &mElements[0]; } const Type *end(void) const { return &mElements[mLength]; } private: Type mElements[kMaxSize]; uint16_t mLength; }; otError WaitResponse(void); static void HandleReceivedFrame(void *aContext); void HandleReceivedFrame(void); static void HandleInitialFrame(const uint8_t *aFrame, uint16_t aLength, uint8_t aHeader, bool &aSave, void *aContext); void HandleInitialFrame(const uint8_t *aFrame, uint16_t aLength, uint8_t aHeader, bool &aSave); otError CheckSpinelVersion(void); otError GetCoprocessorVersion(void); otError GetCoprocessorCaps(void); CoprocessorType GetCoprocessorType(void); void ProcessFrameQueue(void); SpinelInterface::RxFrameBuffer mRxFrameBuffer; SpinelInterface *mSpinelInterface; spinel_prop_key_t mWaitingKey; bool mIsWaitingForResponse; spinel_iid_t mIid; Array<spinel_iid_t, kSpinelHeaderMaxNumIid> mIidList; ReceivedFrameHandler mReceivedFrameHandler; SavedFrameHandler mSavedFrameHandler; void *mFrameHandlerContext; int mSpinelVersionMajor; int mSpinelVersionMinor; bool mIsCoprocessorReady; char mVersion[kVersionStringSize]; Array<unsigned int, kCapsBufferSize> mCoprocessorCaps; };