Symbols ![]()
loading...
Files ![]()
loading...
ot::Mac::Frame class
Implements IEEE 802.15.4 MAC frame generation and parsing.
Syntax
class Frame : public otRadioFrame
{
public:
enum Type : uint16_t
{
kTypeBeacon = 0,
kTypeData = 1,
kTypeAck = 2,
kTypeMacCmd = 3,
kTypeMultipurpose = 5,
};
enum Version : uint16_t
{
kVersion2003 = 0 << 12,
kVersion2006 = 1 << 12,
kVersion2015 = 2 << 12,
};
enum SecurityLevel : uint8_t
{
kSecurityNone = 0,
kSecurityMic32 = 1,
kSecurityMic64 = 2,
kSecurityMic128 = 3,
kSecurityEnc = 4,
kSecurityEncMic32 = 5,
kSecurityEncMic64 = 6,
kSecurityEncMic128 = 7,
};
enum KeyIdMode : uint8_t
{
kKeyIdMode0 = 0 << 3,
kKeyIdMode1 = 1 << 3,
kKeyIdMode2 = 2 << 3,
kKeyIdMode3 = 3 << 3,
};
enum CommandId : uint8_t
{
kMacCmdAssociationRequest = 1,
kMacCmdAssociationResponse = 2,
kMacCmdDisassociationNotification = 3,
kMacCmdDataRequest = 4,
kMacCmdPanidConflictNotification = 5,
kMacCmdOrphanNotification = 6,
kMacCmdBeaconRequest = 7,
kMacCmdCoordinatorRealignment = 8,
kMacCmdGtsRequest = 9,
};
static constexpr uint16_t kInfoStringSize = 128;
static constexpr uint8_t kPreambleSize = 4;
static constexpr uint8_t kSfdSize = 1;
static constexpr uint8_t kPhrSize = 1;
static constexpr uint8_t kPhyHeaderSize = kPreambleSize + kSfdSize + kPhrSize;
static constexpr uint8_t kFcfSize = sizeof(uint16_t);
static constexpr uint8_t kDsnSize = sizeof(uint8_t);
static constexpr uint8_t k154FcsSize = sizeof(uint16_t);
static constexpr uint8_t kImmAckLength = kFcfSize + kDsnSize + k154FcsSize;
typedef String<kInfoStringSize> InfoString;
bool IsEmpty(void) const { return (mLength == 0); }
Error ValidatePsdu(void) const;
uint8_t GetType(void) const { return GetPsdu()[0] & kFcfFrameTypeMask; }
bool IsAck(void) const { return GetType() == kTypeAck; }
#if OPENTHREAD_CONFIG_WAKEUP_COORDINATOR_ENABLE || OPENTHREAD_CONFIG_WAKEUP_END_DEVICE_ENABLE
bool IsWakeupFrame(void) const;
RendezvousTimeIe *GetRendezvousTimeIe(void) { return AsNonConst(AsConst(this)->GetRendezvousTimeIe()); }
const RendezvousTimeIe *GetRendezvousTimeIe(void) const
{
const uint8_t *ie = GetHeaderIe(RendezvousTimeIe::kHeaderIeId);
return (ie != nullptr) ? reinterpret_cast<const RendezvousTimeIe *>(ie + sizeof(HeaderIe)) : nullptr;
}
ConnectionIe *GetConnectionIe(void) { return AsNonConst(AsConst(this)->GetConnectionIe()); }
const ConnectionIe *GetConnectionIe(void) const
{
const uint8_t *ie = GetThreadIe(ConnectionIe::kThreadIeSubtype);
return (ie != nullptr) ? reinterpret_cast<const ConnectionIe *>(ie + sizeof(HeaderIe)) : nullptr;
}
#endif
uint16_t GetVersion(void) const { return GetFrameControlField() & kFcfFrameVersionMask; }
bool IsVersion2015(void) const { return IsVersion2015(GetFrameControlField()); }
bool GetSecurityEnabled(void) const { return IsSecurityEnabled(GetFrameControlField()); }
bool GetFramePending(void) const { return IsFramePending(GetFrameControlField()); }
void SetFramePending(bool aFramePending);
bool GetAckRequest(void) const { return IsAckRequest(GetFrameControlField()); }
void SetAckRequest(bool aAckRequest);
bool IsPanIdCompressed(void) const { return (GetFrameControlField() & kFcfPanidCompression) != 0; }
bool IsIePresent(void) const { return IsIePresent(GetFrameControlField()); }
void SetIePresent(bool aIePresent);
uint8_t GetSequence(void) const;
void SetSequence(uint8_t aSequence);
uint8_t IsSequencePresent(void) const { return IsSequencePresent(GetFrameControlField()); }
bool IsDstPanIdPresent(void) const { return IsDstPanIdPresent(GetFrameControlField()); }
Error GetDstPanId(PanId &aPanId) const;
bool IsDstAddrPresent() const { return IsDstAddrPresent(GetFrameControlField()); }
Error GetDstAddr(Address &aAddress) const;
bool IsSrcPanIdPresent(void) const { return IsSrcPanIdPresent(GetFrameControlField()); }
Error GetSrcPanId(PanId &aPanId) const;
bool IsSrcAddrPresent(void) const { return IsSrcAddrPresent(GetFrameControlField()); }
Error GetSrcAddr(Address &aAddress) const;
Error GetSecurityControlField(uint8_t &aSecurityControlField) const;
Error GetSecurityLevel(uint8_t &aSecurityLevel) const;
Error GetKeyIdMode(uint8_t &aKeyIdMode) const;
Error GetFrameCounter(uint32_t &aFrameCounter) const;
void SetFrameCounter(uint32_t aFrameCounter);
const uint8_t *GetKeySource(void) const;
void SetKeySource(const uint8_t *aKeySource);
Error GetKeyId(uint8_t &aKeyId) const;
void SetKeyId(uint8_t aKeyId);
Error GetCommandId(uint8_t &aCommandId) const;
bool IsDataRequestCommand(void) const;
uint16_t GetLength(void) const { return mLength; }
void SetLength(uint16_t aLength) { mLength = aLength; }
uint8_t GetHeaderLength(void) const;
uint8_t GetFooterLength(void) const;
uint16_t GetPayloadLength(void) const;
uint16_t GetMaxPayloadLength(void) const;
void SetPayloadLength(uint16_t aLength);
uint8_t GetChannel(void) const { return mChannel; }
uint8_t *GetPsdu(void) { return mPsdu; }
const uint8_t *GetPsdu(void) const { return mPsdu; }
uint8_t *GetHeader(void) { return GetPsdu(); }
const uint8_t *GetHeader(void) const { return GetPsdu(); }
uint8_t *GetPayload(void) { return AsNonConst(AsConst(this)->GetPayload()); }
const uint8_t *GetPayload(void) const;
uint8_t *GetFooter(void) { return AsNonConst(AsConst(this)->GetFooter()); }
const uint8_t *GetFooter(void) const;
#if OPENTHREAD_CONFIG_TIME_SYNC_ENABLE
TimeIe *GetTimeIe(void) { return AsNonConst(AsConst(this)->GetTimeIe()); }
const TimeIe *GetTimeIe(void) const;
#endif
#if OPENTHREAD_CONFIG_MAC_HEADER_IE_SUPPORT
uint8_t *GetHeaderIe(uint8_t aIeId) { return AsNonConst(AsConst(this)->GetHeaderIe(aIeId)); }
const uint8_t *GetHeaderIe(uint8_t aIeId) const;
uint8_t *GetThreadIe(uint8_t aSubType) { return AsNonConst(AsConst(this)->GetThreadIe(aSubType)); }
const uint8_t *GetThreadIe(uint8_t aSubType) const;
#if OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE
void SetCslIe(uint16_t aCslPeriod, uint16_t aCslPhase);
bool HasCslIe(void) const;
#endif
#if OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE || (OPENTHREAD_FTD && OPENTHREAD_CONFIG_MAC_CSL_TRANSMITTER_ENABLE)
const CslIe *GetCslIe(void) const;
CslIe *GetCslIe(void) { return AsNonConst(AsConst(this)->GetCslIe()); }
#endif
#if OPENTHREAD_CONFIG_MLE_LINK_METRICS_SUBJECT_ENABLE
void SetEnhAckProbingIe(const uint8_t *aValue, uint8_t aLen);
#endif
#endif
#if OPENTHREAD_CONFIG_MULTI_RADIO
RadioType GetRadioType(void) const { return static_cast<RadioType>(mRadioType); }
void SetRadioType(RadioType aRadioType) { mRadioType = static_cast<uint8_t>(aRadioType); }
#endif
uint16_t GetMtu(void) const
#if !OPENTHREAD_CONFIG_MULTI_RADIO && OPENTHREAD_CONFIG_RADIO_LINK_IEEE_802_15_4_ENABLE
{
return OT_RADIO_FRAME_MAX_SIZE;
}
#else
;
#endif
uint8_t GetFcsSize(void) const
#if !OPENTHREAD_CONFIG_MULTI_RADIO && OPENTHREAD_CONFIG_RADIO_LINK_IEEE_802_15_4_ENABLE
{
return k154FcsSize;
}
#else
;
#endif
InfoString ToInfoString(void) const;
uint16_t GetFrameControlField(void) const
{
uint16_t fcf = mPsdu[0];
#if OPENTHREAD_CONFIG_MAC_MULTIPURPOSE_FRAME
if (!IsShortFcf(fcf))
#endif
{
fcf |= (mPsdu[1] << 8);
}
return fcf;
}
protected:
static constexpr uint8_t kShortFcfSize = sizeof(uint8_t);
static constexpr uint8_t kSecurityControlSize = sizeof(uint8_t);
static constexpr uint8_t kFrameCounterSize = sizeof(uint32_t);
static constexpr uint8_t kCommandIdSize = sizeof(uint8_t);
static constexpr uint8_t kKeyIndexSize = sizeof(uint8_t);
static constexpr uint16_t kFcfFrameTypeMask = 7 << 0;
static constexpr uint16_t kFcfAddrNone = 0;
static constexpr uint16_t kFcfAddrShort = 2;
static constexpr uint16_t kFcfAddrExt = 3;
static constexpr uint16_t kFcfAddrMask = 3;
static constexpr uint16_t kFcfSecurityEnabled = 1 << 3;
static constexpr uint16_t kFcfFramePending = 1 << 4;
static constexpr uint16_t kFcfAckRequest = 1 << 5;
static constexpr uint16_t kFcfPanidCompression = 1 << 6;
static constexpr uint16_t kFcfSequenceSuppression = 1 << 8;
static constexpr uint16_t kFcfIePresent = 1 << 9;
static constexpr uint16_t kFcfDstAddrShift = 10;
static constexpr uint16_t kFcfDstAddrNone = kFcfAddrNone << kFcfDstAddrShift;
static constexpr uint16_t kFcfDstAddrShort = kFcfAddrShort << kFcfDstAddrShift;
static constexpr uint16_t kFcfDstAddrExt = kFcfAddrExt << kFcfDstAddrShift;
static constexpr uint16_t kFcfDstAddrMask = kFcfAddrMask << kFcfDstAddrShift;
static constexpr uint16_t kFcfFrameVersionMask = 3 << 12;
static constexpr uint16_t kFcfSrcAddrShift = 14;
static constexpr uint16_t kFcfSrcAddrNone = kFcfAddrNone << kFcfSrcAddrShift;
static constexpr uint16_t kFcfSrcAddrShort = kFcfAddrShort << kFcfSrcAddrShift;
static constexpr uint16_t kFcfSrcAddrExt = kFcfAddrExt << kFcfSrcAddrShift;
static constexpr uint16_t kFcfSrcAddrMask = kFcfAddrMask << kFcfSrcAddrShift;
static constexpr uint16_t kMpFcfLongFrame = 1 << 3;
static constexpr uint16_t kMpFcfDstAddrShift = 4;
static constexpr uint16_t kMpFcfDstAddrNone = kFcfAddrNone << kMpFcfDstAddrShift;
static constexpr uint16_t kMpFcfDstAddrShort = kFcfAddrShort << kMpFcfDstAddrShift;
static constexpr uint16_t kMpFcfDstAddrExt = kFcfAddrExt << kMpFcfDstAddrShift;
static constexpr uint16_t kMpFcfDstAddrMask = kFcfAddrMask << kMpFcfDstAddrShift;
static constexpr uint16_t kMpFcfSrcAddrShift = 6;
static constexpr uint16_t kMpFcfSrcAddrNone = kFcfAddrNone << kMpFcfSrcAddrShift;
static constexpr uint16_t kMpFcfSrcAddrShort = kFcfAddrShort << kMpFcfSrcAddrShift;
static constexpr uint16_t kMpFcfSrcAddrExt = kFcfAddrExt << kMpFcfSrcAddrShift;
static constexpr uint16_t kMpFcfSrcAddrMask = kFcfAddrMask << kMpFcfSrcAddrShift;
static constexpr uint16_t kMpFcfPanidPresent = 1 << 8;
static constexpr uint16_t kMpFcfSecurityEnabled = 1 << 9;
static constexpr uint16_t kMpFcfSequenceSuppression = 1 << 10;
static constexpr uint16_t kMpFcfFramePending = 1 << 11;
static constexpr uint16_t kMpFcfAckRequest = 1 << 14;
static constexpr uint16_t kMpFcfIePresent = 1 << 15;
static constexpr uint8_t kSecLevelMask = 7 << 0;
static constexpr uint8_t kKeyIdModeMask = 3 << 3;
static constexpr uint8_t kMic0Size = 0;
static constexpr uint8_t kMic32Size = 32 / kBitsPerByte;
static constexpr uint8_t kMic64Size = 64 / kBitsPerByte;
static constexpr uint8_t kMic128Size = 128 / kBitsPerByte;
static constexpr uint8_t kMaxMicSize = kMic128Size;
static constexpr uint8_t kKeySourceSizeMode0 = 0;
static constexpr uint8_t kKeySourceSizeMode1 = 0;
static constexpr uint8_t kKeySourceSizeMode2 = 4;
static constexpr uint8_t kKeySourceSizeMode3 = 8;
static constexpr uint8_t kInvalidIndex = 0xff;
static constexpr uint8_t kInvalidSize = kInvalidIndex;
static constexpr uint8_t kMaxPsduSize = kInvalidSize - 1;
void SetFrameControlField(uint16_t aFcf);
uint8_t SkipSequenceIndex(void) const;
uint8_t FindDstPanIdIndex(void) const;
uint8_t FindDstAddrIndex(void) const;
uint8_t FindSrcPanIdIndex(void) const;
uint8_t FindSrcAddrIndex(void) const;
uint8_t SkipAddrFieldIndex(void) const;
uint8_t FindSecurityHeaderIndex(void) const;
uint8_t SkipSecurityHeaderIndex(void) const;
uint8_t FindPayloadIndex(void) const;
#if OPENTHREAD_CONFIG_MAC_HEADER_IE_SUPPORT
uint8_t FindHeaderIeIndex(void) const;
#endif
#if OPENTHREAD_CONFIG_MAC_MULTIPURPOSE_FRAME
static uint8_t GetFcfSize(uint16_t aFcf) { return IsShortFcf(aFcf) ? kShortFcfSize : kFcfSize; }
#else
static uint8_t GetFcfSize(uint16_t ) { return kFcfSize; }
#endif
#if OPENTHREAD_CONFIG_MAC_MULTIPURPOSE_FRAME
template <uint16_t kValue, uint16_t kMpValue> static uint16_t Select(uint16_t aFcf)
{
return IsMultipurpose(aFcf) ? kMpValue : kValue;
}
#else
template <uint16_t kValue, uint16_t kMpValue> static uint16_t Select(uint16_t ) { return kValue; }
#endif
template <uint16_t kValue, uint16_t kMpValue> static uint16_t MaskFcf(uint16_t aFcf)
{
return aFcf & Select<kValue, kMpValue>(aFcf);
}
static uint16_t GetFcfDstAddr(uint16_t aFcf)
{
return MaskFcf<kFcfDstAddrMask, kMpFcfDstAddrMask>(aFcf) >> Select<kFcfDstAddrShift, kMpFcfDstAddrShift>(aFcf);
}
static uint16_t GetFcfSrcAddr(uint16_t aFcf)
{
return MaskFcf<kFcfSrcAddrMask, kMpFcfSrcAddrMask>(aFcf) >> Select<kFcfSrcAddrShift, kMpFcfSrcAddrShift>(aFcf);
}
static bool IsMultipurpose(uint16_t aFcf) { return (aFcf & kFcfFrameTypeMask) == kTypeMultipurpose; }
static bool IsShortFcf(uint16_t aFcf)
{
return (aFcf & (kFcfFrameTypeMask | kMpFcfLongFrame)) == (kTypeMultipurpose | 0);
}
static bool IsSequencePresent(uint16_t aFcf)
{
return !MaskFcf<kFcfSequenceSuppression, kMpFcfSequenceSuppression>(aFcf);
}
static bool IsDstAddrPresent(uint16_t aFcf) { return MaskFcf<kFcfDstAddrMask, kMpFcfDstAddrMask>(aFcf); }
static bool IsDstPanIdPresent(uint16_t aFcf);
static bool IsSrcAddrPresent(uint16_t aFcf) { return MaskFcf<kFcfSrcAddrMask, kMpFcfSrcAddrMask>(aFcf); }
static bool IsSrcPanIdPresent(uint16_t aFcf);
static bool IsSecurityEnabled(uint16_t aFcf) { return MaskFcf<kFcfSecurityEnabled, kMpFcfSecurityEnabled>(aFcf); }
static bool IsFramePending(uint16_t aFcf) { return MaskFcf<kFcfFramePending, kMpFcfFramePending>(aFcf); }
static bool IsIePresent(uint16_t aFcf) { return MaskFcf<kFcfIePresent, kMpFcfIePresent>(aFcf); }
static bool IsAckRequest(uint16_t aFcf) { return MaskFcf<kFcfAckRequest, kMpFcfAckRequest>(aFcf); }
static bool IsVersion2015(uint16_t aFcf) { return (aFcf & kFcfFrameVersionMask) == kVersion2015; }
static uint16_t DetermineFcfAddrType(const Address &aAddress, uint16_t aBitShift);
static uint8_t CalculateAddrFieldSize(uint16_t aFcf);
static uint8_t CalculateSecurityHeaderSize(uint8_t aSecurityControl);
static uint8_t CalculateKeySourceSize(uint8_t aSecurityControl);
static uint8_t CalculateMicSize(uint8_t aSecurityControl);
};
Fields
Field
Related Functions
Found 3 other functions taking a Frame
argument:
Function
Description
Returns a reference to the current MAC key (for Key Mode 1) for a given Frame.
Returns a reference to the temporary MAC key (for Key Mode 1) for a given Frame based on a given Key Sequence.