Symbols ![]()
loading...
Files ![]()
loading...
ot::Mac::SubMac class
Implements the IEEE 802.15.4 MAC (sub-MAC). Sub-MAC layer implements a subset of IEEE802.15.4 MAC primitives which are shared by both MAC layer (in FTD/MTD modes) and Raw Link (Radio only mode). The sub-MAC layer handles the following (if not provided by radio platform): - Ack timeout for frame transmission, - CSMA backoff logic, - Frame re-transmissions, - Energy scan on a single channel and RSSI sampling. It also act as the interface (to radio platform) for setting/getting radio configurations such as short or extended addresses and PAN Id.
Syntax
class SubMac : public InstanceLocator,
private NonCopyable
{
friend class Radio::Callbacks;
friend class LinkRaw;
public:
class Callbacks : public InstanceLocator
{
public:
explicit Callbacks(Instance &aInstance);
void ReceiveDone(RxFrame *aFrame, Error aError);
void RecordCcaStatus(bool aCcaSuccess, uint8_t aChannel);
void RecordFrameTransmitStatus(const TxFrame &aFrame, Error aError, uint8_t aRetryCount, bool aWillRetx);
void TransmitDone(TxFrame &aFrame, RxFrame *aAckFrame, Error aError);
void EnergyScanDone(int8_t aMaxRssi);
void FrameCounterUsed(uint32_t aFrameCounter);
};
explicit SubMac(Instance &aInstance);
otRadioCaps GetRadioCaps(void) const { return mRadioCaps; }
otRadioCaps GetCaps(void) const;
void SetPanId(PanId aPanId);
ShortAddress GetShortAddress(void) const { return mShortAddress; }
void SetShortAddress(ShortAddress aShortAddress);
const ExtAddress &GetExtAddress(void) const { return mExtAddress; }
void SetExtAddress(const ExtAddress &aExtAddress);
void SetPcapCallback(otLinkPcapCallback aPcapCallback, void *aCallbackContext)
{
mPcapCallback.Set(aPcapCallback, aCallbackContext);
}
void SetRxOnWhenIdle(bool aRxOnWhenIdle);
Error Enable(void);
Error Disable(void);
Error Sleep(void);
bool IsTransmittingOrScanning(void) const { return (mState == kStateTransmit) || (mState == kStateEnergyScan); }
Error Receive(uint8_t aChannel);
TxFrame &GetTransmitFrame(void) { return mTransmitFrame; }
Error Send(void);
uint8_t GetTransmitRetries(void) const { return mTransmitRetries; }
int8_t GetRssi(void) const;
Error EnergyScan(uint8_t aScanChannel, uint16_t aScanDuration);
int8_t GetNoiseFloor(void) const;
#if OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE
bool UpdateCsl(uint16_t aPeriod, uint8_t aChannel, otShortAddress aShortAddr, const otExtAddress *aExtAddr);
void CslSample(void);
const CslAccuracy &GetCslParentAccuracy(void) const { return mCslParentAccuracy; }
void SetCslParentAccuracy(const CslAccuracy &aCslAccuracy) { mCslParentAccuracy = aCslAccuracy; }
#endif
void SetMacKey(uint8_t aKeyIdMode,
uint8_t aKeyId,
const KeyMaterial &aPrevKey,
const KeyMaterial &aCurrKey,
const KeyMaterial &aNextKey);
const KeyMaterial &GetCurrentMacKey(void) const { return mCurrKey; }
const KeyMaterial &GetPreviousMacKey(void) const { return mPrevKey; }
const KeyMaterial &GetNextMacKey(void) const { return mNextKey; }
void ClearMacKeys(void)
{
mPrevKey.Clear();
mCurrKey.Clear();
mNextKey.Clear();
}
uint32_t GetFrameCounter(void) const { return mFrameCounter; }
void SetFrameCounter(uint32_t aFrameCounter, bool aSetIfLarger);
#if OPENTHREAD_CONFIG_MAC_FILTER_ENABLE
void SetRadioFilterEnabled(bool aFilterEnabled) { mRadioFilterEnabled = aFilterEnabled; }
bool IsRadioFilterEnabled(void) const { return mRadioFilterEnabled; }
#endif
#if OPENTHREAD_CONFIG_WAKEUP_END_DEVICE_ENABLE
void UpdateWakeupListening(bool aEnable, uint32_t aInterval, uint32_t aDuration, uint8_t aChannel);
#endif
private:
#if OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE
void CslInit(void);
void UpdateCslLastSyncTimestamp(TxFrame &aFrame, RxFrame *aAckFrame);
void UpdateCslLastSyncTimestamp(RxFrame *aFrame, Error aError);
static void HandleCslTimer(Timer &aTimer);
void HandleCslTimer(void);
void GetCslWindowEdges(uint32_t &aAhead, uint32_t &aAfter);
uint32_t GetLocalTime(void);
#if OPENTHREAD_CONFIG_MAC_CSL_DEBUG_ENABLE
void LogReceived(RxFrame *aFrame);
#endif
#endif
#if OPENTHREAD_CONFIG_WAKEUP_END_DEVICE_ENABLE
void WedInit(void);
static void HandleWedTimer(Timer &aTimer);
void HandleWedTimer(void);
#endif
static constexpr uint8_t kCsmaMinBe = 3;
static constexpr uint8_t kCsmaMaxBe = 5;
static constexpr uint32_t kUnitBackoffPeriod = 20;
static constexpr uint32_t kAckTimeout = 16 * Time::kOneMsecInUsec;
static constexpr uint32_t kCcaSampleInterval = 128;
#if OPENTHREAD_CONFIG_MAC_ADD_DELAY_ON_NO_ACK_ERROR_BEFORE_RETRY
static constexpr uint8_t kRetxDelayMinBackoffExponent = OPENTHREAD_CONFIG_MAC_RETX_DELAY_MIN_BACKOFF_EXPONENT;
static constexpr uint8_t kRetxDelayMaxBackoffExponent = OPENTHREAD_CONFIG_MAC_RETX_DELAY_MAX_BACKOFF_EXPONENT;
#endif
#if OPENTHREAD_CONFIG_PLATFORM_USEC_TIMER_ENABLE
static constexpr uint32_t kEnergyScanRssiSampleInterval = 128;
#else
static constexpr uint32_t kEnergyScanRssiSampleInterval = 1000;
#endif
enum State : uint8_t
{
kStateDisabled,
kStateSleep,
kStateReceive,
kStateCsmaBackoff,
kStateTransmit,
kStateEnergyScan,
#if OPENTHREAD_CONFIG_MAC_ADD_DELAY_ON_NO_ACK_ERROR_BEFORE_RETRY
kStateDelayBeforeRetx,
#endif
#if !OPENTHREAD_MTD && OPENTHREAD_CONFIG_MAC_CSL_TRANSMITTER_ENABLE
kStateCslTransmit,
#endif
#if OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE
kStateCslSample,
#endif
};
#if OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE || OPENTHREAD_CONFIG_WAKEUP_END_DEVICE_ENABLE
static constexpr uint32_t kMinReceiveOnAhead = OPENTHREAD_CONFIG_MIN_RECEIVE_ON_AHEAD;
static constexpr uint32_t kMinReceiveOnAfter = OPENTHREAD_CONFIG_MIN_RECEIVE_ON_AFTER;
static constexpr uint32_t kCslReceiveTimeAhead = OPENTHREAD_CONFIG_CSL_RECEIVE_TIME_AHEAD;
#endif
#if OPENTHREAD_CONFIG_WAKEUP_END_DEVICE_ENABLE
static constexpr uint32_t kWedReceiveTimeAfter = OPENTHREAD_CONFIG_WED_RECEIVE_TIME_AFTER;
#endif
#if OPENTHREAD_CONFIG_MAC_CSL_TRANSMITTER_ENABLE
static constexpr uint32_t kCslTransmitTimeAhead = OPENTHREAD_CONFIG_CSL_TRANSMIT_TIME_AHEAD;
#endif
void Init(void);
bool RadioSupportsCsmaBackoff(void) const
{
return ((mRadioCaps & (OT_RADIO_CAPS_CSMA_BACKOFF | OT_RADIO_CAPS_TRANSMIT_RETRIES)) != 0);
}
bool RadioSupportsTransmitSecurity(void) const { return ((mRadioCaps & OT_RADIO_CAPS_TRANSMIT_SEC) != 0); }
bool RadioSupportsRetries(void) const { return ((mRadioCaps & OT_RADIO_CAPS_TRANSMIT_RETRIES) != 0); }
bool RadioSupportsAckTimeout(void) const { return ((mRadioCaps & OT_RADIO_CAPS_ACK_TIMEOUT) != 0); }
bool RadioSupportsEnergyScan(void) const { return ((mRadioCaps & OT_RADIO_CAPS_ENERGY_SCAN) != 0); }
bool RadioSupportsTransmitTiming(void) const { return ((mRadioCaps & OT_RADIO_CAPS_TRANSMIT_TIMING) != 0); }
bool RadioSupportsReceiveTiming(void) const { return ((mRadioCaps & OT_RADIO_CAPS_RECEIVE_TIMING) != 0); }
bool RadioSupportsRxOnWhenIdle(void) const { return ((mRadioCaps & OT_RADIO_CAPS_RX_ON_WHEN_IDLE) != 0); }
bool ShouldHandleTransmitSecurity(void) const;
bool ShouldHandleCsmaBackOff(void) const;
bool ShouldHandleAckTimeout(void) const;
bool ShouldHandleRetries(void) const;
bool ShouldHandleEnergyScan(void) const;
bool ShouldHandleTransmitTargetTime(void) const;
bool ShouldHandleTransitionToSleep(void) const;
void ProcessTransmitSecurity(void);
void SignalFrameCounterUsed(uint32_t aFrameCounter, uint8_t aKeyId);
void StartCsmaBackoff(void);
void StartTimerForBackoff(uint8_t aBackoffExponent);
void BeginTransmit(void);
void SampleRssi(void);
void StartTimer(uint32_t aDelayUs);
void StartTimerAt(Time aStartTime, uint32_t aDelayUs);
void HandleReceiveDone(RxFrame *aFrame, Error aError);
void HandleTransmitStarted(TxFrame &aFrame);
void HandleTransmitDone(TxFrame &aFrame, RxFrame *aAckFrame, Error aError);
void SignalFrameCounterUsedOnTxDone(const TxFrame &aFrame);
void HandleEnergyScanDone(int8_t aMaxRssi);
void HandleTimer(void);
void SetState(State aState);
static const char *StateToString(State aState);
using SubMacTimer =
#if OPENTHREAD_CONFIG_PLATFORM_USEC_TIMER_ENABLE
TimerMicroIn<SubMac, &SubMac::HandleTimer>;
#else
TimerMilliIn<SubMac, &SubMac::HandleTimer>;
#endif
otRadioCaps mRadioCaps;
State mState;
uint8_t mCsmaBackoffs;
uint8_t mTransmitRetries;
ShortAddress mShortAddress;
ExtAddress mExtAddress;
bool mRxOnWhenIdle : 1;
#if OPENTHREAD_CONFIG_MAC_FILTER_ENABLE
bool mRadioFilterEnabled : 1;
#endif
int8_t mEnergyScanMaxRssi;
TimeMilli mEnergyScanEndTime;
TxFrame &mTransmitFrame;
Callbacks mCallbacks;
Callback<otLinkPcapCallback> mPcapCallback;
KeyMaterial mPrevKey;
KeyMaterial mCurrKey;
KeyMaterial mNextKey;
uint32_t mFrameCounter;
uint8_t mKeyId;
#if OPENTHREAD_CONFIG_MAC_ADD_DELAY_ON_NO_ACK_ERROR_BEFORE_RETRY
uint8_t mRetxDelayBackOffExponent;
#endif
SubMacTimer mTimer;
#if OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE
uint16_t mCslPeriod;
uint8_t mCslChannel : 7;
bool mIsCslSampling : 1;
uint16_t mCslPeerShort;
TimeMicro mCslSampleTime;
TimeMicro mCslLastSync;
CslAccuracy mCslParentAccuracy;
TimerMicro mCslTimer;
#endif
#if OPENTHREAD_CONFIG_WAKEUP_END_DEVICE_ENABLE
uint32_t mWakeupListenInterval;
uint32_t mWakeupListenDuration;
uint8_t mWakeupChannel;
TimeMicro mWedSampleTime;
uint64_t mWedSampleTimeRadio;
TimerMicro mWedTimer;
#endif
};
Fields
Field
Declared as
bool : 1
Callback<otLinkPcapCallback>
uint32_t
uint8_t
SubMacTimer
References
Code
Location
Scope
Referrer
Class Tree
ot::Mac::SubMac is inherited by 2 classess:
Instances
Instance
Scope
Location
Project