| /* |
| * Copyright (c) 2016, The OpenThread Authors. |
| * All rights reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions are met: |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in the |
| * documentation and/or other materials provided with the distribution. |
| * 3. Neither the name of the copyright holder nor the |
| * names of its contributors may be used to endorse or promote products |
| * derived from this software without specific prior written permission. |
| * |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
| * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| * POSSIBILITY OF SUCH DAMAGE. |
| */ |
| |
| /** |
| * @file |
| * This file includes definitions for generating and processing IEEE 802.15.4 MAC frames. |
| */ |
| |
| #ifndef MAC_FRAME_HPP_ |
| #define MAC_FRAME_HPP_ |
| |
| #include "openthread-core-config.h" |
| |
| #include <limits.h> |
| #include <stdint.h> |
| |
| #include "common/as_core_type.hpp" |
| #include "common/const_cast.hpp" |
| #include "common/encoding.hpp" |
| #include "mac/mac_types.hpp" |
| #include "meshcop/network_name.hpp" |
| |
| namespace ot { |
| namespace Mac { |
| |
| using ot::Encoding::LittleEndian::HostSwap16; |
| using ot::Encoding::LittleEndian::HostSwap64; |
| using ot::Encoding::LittleEndian::ReadUint24; |
| using ot::Encoding::LittleEndian::WriteUint24; |
| |
| /** |
| * @addtogroup core-mac |
| * |
| * @{ |
| * |
| */ |
| |
| /** |
| * This class implements IEEE 802.15.4 IE (Information Element) header generation and parsing. |
| * |
| */ |
| OT_TOOL_PACKED_BEGIN |
| class HeaderIe |
| { |
| public: |
| /** |
| * This method initializes the Header IE. |
| * |
| */ |
| void Init(void) { mFields.m16 = 0; } |
| |
| /** |
| * This method initializes the Header IE with Id and Length. |
| * |
| * @param[in] aId The IE Element Id. |
| * @param[in] aLen The IE content length. |
| * |
| */ |
| void Init(uint16_t aId, uint8_t aLen); |
| |
| /** |
| * This method returns the IE Element Id. |
| * |
| * @returns the IE Element Id. |
| * |
| */ |
| uint16_t GetId(void) const { return (HostSwap16(mFields.m16) & kIdMask) >> kIdOffset; } |
| |
| /** |
| * This method sets the IE Element Id. |
| * |
| * @param[in] aId The IE Element Id. |
| * |
| */ |
| void SetId(uint16_t aId) |
| { |
| mFields.m16 = HostSwap16((HostSwap16(mFields.m16) & ~kIdMask) | ((aId << kIdOffset) & kIdMask)); |
| } |
| |
| /** |
| * This method returns the IE content length. |
| * |
| * @returns the IE content length. |
| * |
| */ |
| uint8_t GetLength(void) const { return mFields.m8[0] & kLengthMask; } |
| |
| /** |
| * This method sets the IE content length. |
| * |
| * @param[in] aLength The IE content length. |
| * |
| */ |
| void SetLength(uint8_t aLength) { mFields.m8[0] = (mFields.m8[0] & ~kLengthMask) | (aLength & kLengthMask); } |
| |
| private: |
| // Header IE format: |
| // |
| // +-----------+------------+--------+ |
| // | Bits: 0-6 | 7-14 | 15 | |
| // +-----------+------------+--------+ |
| // | Length | Element ID | Type=0 | |
| // +-----------+------------+--------+ |
| |
| static constexpr uint8_t kSize = 2; |
| static constexpr uint8_t kIdOffset = 7; |
| static constexpr uint8_t kLengthMask = 0x7f; |
| static constexpr uint16_t kIdMask = 0x00ff << kIdOffset; |
| |
| union OT_TOOL_PACKED_FIELD |
| { |
| uint8_t m8[kSize]; |
| uint16_t m16; |
| } mFields; |
| |
| } OT_TOOL_PACKED_END; |
| |
| #if OPENTHREAD_CONFIG_TIME_SYNC_ENABLE || OPENTHREAD_CONFIG_MLE_LINK_METRICS_INITIATOR_ENABLE || \ |
| OPENTHREAD_CONFIG_MLE_LINK_METRICS_SUBJECT_ENABLE |
| /** |
| * This class implements vendor specific Header IE generation and parsing. |
| * |
| */ |
| OT_TOOL_PACKED_BEGIN |
| class VendorIeHeader |
| { |
| public: |
| static constexpr uint8_t kHeaderIeId = 0x00; |
| static constexpr uint8_t kIeContentSize = sizeof(uint8_t) * 4; |
| |
| /** |
| * This method returns the Vendor OUI. |
| * |
| * @returns The Vendor OUI. |
| * |
| */ |
| uint32_t GetVendorOui(void) const { return ReadUint24(mOui); } |
| |
| /** |
| * This method sets the Vendor OUI. |
| * |
| * @param[in] aVendorOui A Vendor OUI. |
| * |
| */ |
| void SetVendorOui(uint32_t aVendorOui) { WriteUint24(aVendorOui, mOui); } |
| |
| /** |
| * This method returns the Vendor IE sub-type. |
| * |
| * @returns The Vendor IE sub-type. |
| * |
| */ |
| uint8_t GetSubType(void) const { return mSubType; } |
| |
| /** |
| * This method sets the Vendor IE sub-type. |
| * |
| * @param[in] aSubType The Vendor IE sub-type. |
| * |
| */ |
| void SetSubType(uint8_t aSubType) { mSubType = aSubType; } |
| |
| private: |
| static constexpr uint8_t kOuiSize = 3; |
| |
| uint8_t mOui[kOuiSize]; |
| uint8_t mSubType; |
| } OT_TOOL_PACKED_END; |
| |
| #if OPENTHREAD_CONFIG_TIME_SYNC_ENABLE |
| /** |
| * This class implements Time Header IE generation and parsing. |
| * |
| */ |
| OT_TOOL_PACKED_BEGIN |
| class TimeIe : public VendorIeHeader |
| { |
| public: |
| static constexpr uint32_t kVendorOuiNest = 0x18b430; |
| static constexpr uint8_t kVendorIeTime = 0x01; |
| static constexpr uint8_t kHeaderIeId = VendorIeHeader::kHeaderIeId; |
| static constexpr uint8_t kIeContentSize = VendorIeHeader::kIeContentSize + sizeof(uint8_t) + sizeof(uint64_t); |
| |
| /** |
| * This method initializes the time IE. |
| * |
| */ |
| void Init(void) |
| { |
| SetVendorOui(kVendorOuiNest); |
| SetSubType(kVendorIeTime); |
| } |
| |
| /** |
| * This method returns the time sync sequence. |
| * |
| * @returns the time sync sequence. |
| * |
| */ |
| uint8_t GetSequence(void) const { return mSequence; } |
| |
| /** |
| * This method sets the tine sync sequence. |
| * |
| * @param[in] aSequence The time sync sequence. |
| * |
| */ |
| void SetSequence(uint8_t aSequence) { mSequence = aSequence; } |
| |
| /** |
| * This method returns the network time. |
| * |
| * @returns the network time, in microseconds. |
| * |
| */ |
| uint64_t GetTime(void) const { return HostSwap64(mTime); } |
| |
| /** |
| * This method sets the network time. |
| * |
| * @param[in] aTime The network time. |
| * |
| */ |
| void SetTime(uint64_t aTime) { mTime = HostSwap64(aTime); } |
| |
| private: |
| uint8_t mSequence; |
| uint64_t mTime; |
| } OT_TOOL_PACKED_END; |
| #endif // OPENTHREAD_CONFIG_TIME_SYNC_ENABLE |
| |
| #if OPENTHREAD_CONFIG_MLE_LINK_METRICS_INITIATOR_ENABLE || OPENTHREAD_CONFIG_MLE_LINK_METRICS_SUBJECT_ENABLE |
| class ThreadIe |
| { |
| public: |
| static constexpr uint8_t kHeaderIeId = VendorIeHeader::kHeaderIeId; |
| static constexpr uint8_t kIeContentSize = VendorIeHeader::kIeContentSize; |
| static constexpr uint32_t kVendorOuiThreadCompanyId = 0xeab89b; |
| static constexpr uint8_t kEnhAckProbingIe = 0x00; |
| }; |
| #endif |
| |
| #endif // OPENTHREAD_CONFIG_TIME_SYNC_ENABLE || OPENTHREAD_CONFIG_MLE_LINK_METRICS_INITIATOR_ENABLE || |
| // OPENTHREAD_CONFIG_MLE_LINK_METRICS_SUBJECT_ENABLE |
| |
| /** |
| * This class implements IEEE 802.15.4 MAC frame generation and parsing. |
| * |
| */ |
| class Frame : public otRadioFrame |
| { |
| public: |
| static constexpr uint8_t kFcfSize = sizeof(uint16_t); |
| static constexpr uint8_t kDsnSize = 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 k154FcsSize = sizeof(uint16_t); |
| |
| static constexpr uint16_t kFcfFrameBeacon = 0 << 0; |
| static constexpr uint16_t kFcfFrameData = 1 << 0; |
| static constexpr uint16_t kFcfFrameAck = 2 << 0; |
| static constexpr uint16_t kFcfFrameMacCmd = 3 << 0; |
| static constexpr uint16_t kFcfFrameTypeMask = 7 << 0; |
| 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 kFcfIePresent = 1 << 9; |
| static constexpr uint16_t kFcfDstAddrNone = 0 << 10; |
| static constexpr uint16_t kFcfDstAddrShort = 2 << 10; |
| static constexpr uint16_t kFcfDstAddrExt = 3 << 10; |
| static constexpr uint16_t kFcfDstAddrMask = 3 << 10; |
| static constexpr uint16_t kFcfFrameVersion2006 = 1 << 12; |
| static constexpr uint16_t kFcfFrameVersion2015 = 2 << 12; |
| static constexpr uint16_t kFcfFrameVersionMask = 3 << 12; |
| static constexpr uint16_t kFcfSrcAddrNone = 0 << 14; |
| static constexpr uint16_t kFcfSrcAddrShort = 2 << 14; |
| static constexpr uint16_t kFcfSrcAddrExt = 3 << 14; |
| static constexpr uint16_t kFcfSrcAddrMask = 3 << 14; |
| |
| static constexpr uint8_t kSecNone = 0 << 0; |
| static constexpr uint8_t kSecMic32 = 1 << 0; |
| static constexpr uint8_t kSecMic64 = 2 << 0; |
| static constexpr uint8_t kSecMic128 = 3 << 0; |
| static constexpr uint8_t kSecEnc = 4 << 0; |
| static constexpr uint8_t kSecEncMic32 = 5 << 0; |
| static constexpr uint8_t kSecEncMic64 = 6 << 0; |
| static constexpr uint8_t kSecEncMic128 = 7 << 0; |
| static constexpr uint8_t kSecLevelMask = 7 << 0; |
| |
| static constexpr uint8_t kMic0Size = 0; |
| static constexpr uint8_t kMic32Size = 32 / CHAR_BIT; |
| static constexpr uint8_t kMic64Size = 64 / CHAR_BIT; |
| static constexpr uint8_t kMic128Size = 128 / CHAR_BIT; |
| static constexpr uint8_t kMaxMicSize = kMic128Size; |
| |
| static constexpr uint8_t kKeyIdMode0 = 0 << 3; |
| static constexpr uint8_t kKeyIdMode1 = 1 << 3; |
| static constexpr uint8_t kKeyIdMode2 = 2 << 3; |
| static constexpr uint8_t kKeyIdMode3 = 3 << 3; |
| static constexpr uint8_t kKeyIdModeMask = 3 << 3; |
| |
| 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 kKeyIndexSize = sizeof(uint8_t); |
| |
| static constexpr uint8_t kMacCmdAssociationRequest = 1; |
| static constexpr uint8_t kMacCmdAssociationResponse = 2; |
| static constexpr uint8_t kMacCmdDisassociationNotification = 3; |
| static constexpr uint8_t kMacCmdDataRequest = 4; |
| static constexpr uint8_t kMacCmdPanidConflictNotification = 5; |
| static constexpr uint8_t kMacCmdOrphanNotification = 6; |
| static constexpr uint8_t kMacCmdBeaconRequest = 7; |
| static constexpr uint8_t kMacCmdCoordinatorRealignment = 8; |
| static constexpr uint8_t kMacCmdGtsRequest = 9; |
| |
| static constexpr uint8_t kImmAckLength = kFcfSize + kDsnSize + k154FcsSize; |
| |
| static constexpr uint16_t kInfoStringSize = 128; ///< Max chars for `InfoString` (ToInfoString()). |
| |
| /** |
| * This type defines the fixed-length `String` object returned from `ToInfoString()` method. |
| * |
| */ |
| typedef String<kInfoStringSize> InfoString; |
| |
| /** |
| * This method indicates whether the frame is empty (no payload). |
| * |
| * @retval TRUE The frame is empty (no PSDU payload). |
| * @retval FALSE The frame is not empty. |
| * |
| */ |
| bool IsEmpty(void) const { return (mLength == 0); } |
| |
| /** |
| * This method initializes the MAC header. |
| * |
| * @param[in] aFcf The Frame Control field. |
| * @param[in] aSecurityControl The Security Control field. |
| * |
| */ |
| void InitMacHeader(uint16_t aFcf, uint8_t aSecurityControl); |
| |
| /** |
| * This method validates the frame. |
| * |
| * @retval kErrorNone Successfully parsed the MAC header. |
| * @retval kErrorParse Failed to parse through the MAC header. |
| * |
| */ |
| Error ValidatePsdu(void) const; |
| |
| /** |
| * This method returns the IEEE 802.15.4 Frame Type. |
| * |
| * @returns The IEEE 802.15.4 Frame Type. |
| * |
| */ |
| uint8_t GetType(void) const { return GetPsdu()[0] & kFcfFrameTypeMask; } |
| |
| /** |
| * This method returns whether the frame is an Ack frame. |
| * |
| * @retval TRUE If this is an Ack. |
| * @retval FALSE If this is not an Ack. |
| * |
| */ |
| bool IsAck(void) const { return GetType() == kFcfFrameAck; } |
| |
| /** |
| * This method returns the IEEE 802.15.4 Frame Version. |
| * |
| * @returns The IEEE 802.15.4 Frame Version. |
| * |
| */ |
| uint16_t GetVersion(void) const { return GetFrameControlField() & kFcfFrameVersionMask; } |
| |
| /** |
| * This method returns if this IEEE 802.15.4 frame's version is 2015. |
| * |
| * @returns TRUE if version is 2015, FALSE otherwise. |
| * |
| */ |
| bool IsVersion2015(void) const { return IsVersion2015(GetFrameControlField()); } |
| |
| /** |
| * This method indicates whether or not security is enabled. |
| * |
| * @retval TRUE If security is enabled. |
| * @retval FALSE If security is not enabled. |
| * |
| */ |
| bool GetSecurityEnabled(void) const { return (GetPsdu()[0] & kFcfSecurityEnabled) != 0; } |
| |
| /** |
| * This method indicates whether or not the Frame Pending bit is set. |
| * |
| * @retval TRUE If the Frame Pending bit is set. |
| * @retval FALSE If the Frame Pending bit is not set. |
| * |
| */ |
| bool GetFramePending(void) const { return (GetPsdu()[0] & kFcfFramePending) != 0; } |
| |
| /** |
| * This method sets the Frame Pending bit. |
| * |
| * @param[in] aFramePending The Frame Pending bit. |
| * |
| */ |
| void SetFramePending(bool aFramePending); |
| |
| /** |
| * This method indicates whether or not the Ack Request bit is set. |
| * |
| * @retval TRUE If the Ack Request bit is set. |
| * @retval FALSE If the Ack Request bit is not set. |
| * |
| */ |
| bool GetAckRequest(void) const { return (GetPsdu()[0] & kFcfAckRequest) != 0; } |
| |
| /** |
| * This method sets the Ack Request bit. |
| * |
| * @param[in] aAckRequest The Ack Request bit. |
| * |
| */ |
| void SetAckRequest(bool aAckRequest); |
| |
| /** |
| * This method indicates whether or not the PanId Compression bit is set. |
| * |
| * @retval TRUE If the PanId Compression bit is set. |
| * @retval FALSE If the PanId Compression bit is not set. |
| * |
| */ |
| bool IsPanIdCompressed(void) const { return (GetFrameControlField() & kFcfPanidCompression) != 0; } |
| |
| /** |
| * This method indicates whether or not IEs present. |
| * |
| * @retval TRUE If IEs present. |
| * @retval FALSE If no IE present. |
| * |
| */ |
| bool IsIePresent(void) const { return (GetFrameControlField() & kFcfIePresent) != 0; } |
| |
| /** |
| * This method returns the Sequence Number value. |
| * |
| * @returns The Sequence Number value. |
| * |
| */ |
| uint8_t GetSequence(void) const { return GetPsdu()[kSequenceIndex]; } |
| |
| /** |
| * This method sets the Sequence Number value. |
| * |
| * @param[in] aSequence The Sequence Number value. |
| * |
| */ |
| void SetSequence(uint8_t aSequence) { GetPsdu()[kSequenceIndex] = aSequence; } |
| |
| /** |
| * This method indicates whether or not the Destination PAN ID is present. |
| * |
| * @returns TRUE if the Destination PAN ID is present, FALSE otherwise. |
| * |
| */ |
| bool IsDstPanIdPresent(void) const { return IsDstPanIdPresent(GetFrameControlField()); } |
| |
| /** |
| * This method gets the Destination PAN Identifier. |
| * |
| * @param[out] aPanId The Destination PAN Identifier. |
| * |
| * @retval kErrorNone Successfully retrieved the Destination PAN Identifier. |
| * @retval kErrorParse Failed to parse the PAN Identifier. |
| * |
| */ |
| Error GetDstPanId(PanId &aPanId) const; |
| |
| /** |
| * This method sets the Destination PAN Identifier. |
| * |
| * @param[in] aPanId The Destination PAN Identifier. |
| * |
| */ |
| void SetDstPanId(PanId aPanId); |
| |
| /** |
| * This method indicates whether or not the Destination Address is present for this object. |
| * |
| * @retval TRUE If the Destination Address is present. |
| * @retval FALSE If the Destination Address is not present. |
| * |
| */ |
| bool IsDstAddrPresent() const { return IsDstAddrPresent(GetFrameControlField()); } |
| |
| /** |
| * This method gets the Destination Address. |
| * |
| * @param[out] aAddress The Destination Address. |
| * |
| * @retval kErrorNone Successfully retrieved the Destination Address. |
| * |
| */ |
| Error GetDstAddr(Address &aAddress) const; |
| |
| /** |
| * This method sets the Destination Address. |
| * |
| * @param[in] aShortAddress The Destination Address. |
| * |
| */ |
| void SetDstAddr(ShortAddress aShortAddress); |
| |
| /** |
| * This method sets the Destination Address. |
| * |
| * @param[in] aExtAddress The Destination Address. |
| * |
| */ |
| void SetDstAddr(const ExtAddress &aExtAddress); |
| |
| /** |
| * This method sets the Destination Address. |
| * |
| * @param[in] aAddress The Destination Address. |
| * |
| */ |
| void SetDstAddr(const Address &aAddress); |
| |
| /** |
| * This method indicates whether or not the Source Address is present for this object. |
| * |
| * @retval TRUE If the Source Address is present. |
| * @retval FALSE If the Source Address is not present. |
| * |
| */ |
| bool IsSrcPanIdPresent(void) const { return IsSrcPanIdPresent(GetFrameControlField()); } |
| |
| /** |
| * This method gets the Source PAN Identifier. |
| * |
| * @param[out] aPanId The Source PAN Identifier. |
| * |
| * @retval kErrorNone Successfully retrieved the Source PAN Identifier. |
| * |
| */ |
| Error GetSrcPanId(PanId &aPanId) const; |
| |
| /** |
| * This method sets the Source PAN Identifier. |
| * |
| * @param[in] aPanId The Source PAN Identifier. |
| * |
| * @retval kErrorNone Successfully set the Source PAN Identifier. |
| * |
| */ |
| Error SetSrcPanId(PanId aPanId); |
| |
| /** |
| * This method indicates whether or not the Source Address is present for this object. |
| * |
| * @retval TRUE If the Source Address is present. |
| * @retval FALSE If the Source Address is not present. |
| * |
| */ |
| bool IsSrcAddrPresent(void) const { return IsSrcAddrPresent(GetFrameControlField()); } |
| |
| /** |
| * This method gets the Source Address. |
| * |
| * @param[out] aAddress The Source Address. |
| * |
| * @retval kErrorNone Successfully retrieved the Source Address. |
| * |
| */ |
| Error GetSrcAddr(Address &aAddress) const; |
| |
| /** |
| * This method sets the Source Address. |
| * |
| * @param[in] aShortAddress The Source Address. |
| * |
| */ |
| void SetSrcAddr(ShortAddress aShortAddress); |
| |
| /** |
| * This method sets the Source Address. |
| * |
| * @param[in] aExtAddress The Source Address. |
| * |
| */ |
| void SetSrcAddr(const ExtAddress &aExtAddress); |
| |
| /** |
| * This method sets the Source Address. |
| * |
| * @param[in] aAddress The Source Address. |
| * |
| */ |
| void SetSrcAddr(const Address &aAddress); |
| |
| /** |
| * This method gets the Security Control Field. |
| * |
| * @param[out] aSecurityControlField The Security Control Field. |
| * |
| * @retval kErrorNone Successfully retrieved the Security Level Identifier. |
| * @retval kErrorParse Failed to find the security control field in the frame. |
| * |
| */ |
| Error GetSecurityControlField(uint8_t &aSecurityControlField) const; |
| |
| /** |
| * This method sets the Security Control Field. |
| * |
| * @param[in] aSecurityControlField The Security Control Field. |
| * |
| */ |
| void SetSecurityControlField(uint8_t aSecurityControlField); |
| |
| /** |
| * This method gets the Security Level Identifier. |
| * |
| * @param[out] aSecurityLevel The Security Level Identifier. |
| * |
| * @retval kErrorNone Successfully retrieved the Security Level Identifier. |
| * |
| */ |
| Error GetSecurityLevel(uint8_t &aSecurityLevel) const; |
| |
| /** |
| * This method gets the Key Identifier Mode. |
| * |
| * @param[out] aKeyIdMode The Key Identifier Mode. |
| * |
| * @retval kErrorNone Successfully retrieved the Key Identifier Mode. |
| * |
| */ |
| Error GetKeyIdMode(uint8_t &aKeyIdMode) const; |
| |
| /** |
| * This method gets the Frame Counter. |
| * |
| * @param[out] aFrameCounter The Frame Counter. |
| * |
| * @retval kErrorNone Successfully retrieved the Frame Counter. |
| * |
| */ |
| Error GetFrameCounter(uint32_t &aFrameCounter) const; |
| |
| /** |
| * This method sets the Frame Counter. |
| * |
| * @param[in] aFrameCounter The Frame Counter. |
| * |
| */ |
| void SetFrameCounter(uint32_t aFrameCounter); |
| |
| /** |
| * This method returns a pointer to the Key Source. |
| * |
| * @returns A pointer to the Key Source. |
| * |
| */ |
| const uint8_t *GetKeySource(void) const; |
| |
| /** |
| * This method sets the Key Source. |
| * |
| * @param[in] aKeySource A pointer to the Key Source value. |
| * |
| */ |
| void SetKeySource(const uint8_t *aKeySource); |
| |
| /** |
| * This method gets the Key Identifier. |
| * |
| * @param[out] aKeyId The Key Identifier. |
| * |
| * @retval kErrorNone Successfully retrieved the Key Identifier. |
| * |
| */ |
| Error GetKeyId(uint8_t &aKeyId) const; |
| |
| /** |
| * This method sets the Key Identifier. |
| * |
| * @param[in] aKeyId The Key Identifier. |
| * |
| */ |
| void SetKeyId(uint8_t aKeyId); |
| |
| /** |
| * This method gets the Command ID. |
| * |
| * @param[out] aCommandId The Command ID. |
| * |
| * @retval kErrorNone Successfully retrieved the Command ID. |
| * |
| */ |
| Error GetCommandId(uint8_t &aCommandId) const; |
| |
| /** |
| * This method sets the Command ID. |
| * |
| * @param[in] aCommandId The Command ID. |
| * |
| * @retval kErrorNone Successfully set the Command ID. |
| * |
| */ |
| Error SetCommandId(uint8_t aCommandId); |
| |
| /** |
| * This method indicates whether the frame is a MAC Data Request command (data poll). |
| * |
| * For 802.15.4-2015 and above frame, the frame should be already decrypted. |
| * |
| * @returns TRUE if frame is a MAC Data Request command, FALSE otherwise. |
| * |
| */ |
| bool IsDataRequestCommand(void) const; |
| |
| /** |
| * This method returns the MAC Frame Length. |
| * |
| * @returns The MAC Frame Length. |
| * |
| */ |
| uint16_t GetLength(void) const { return mLength; } |
| |
| /** |
| * This method sets the MAC Frame Length. |
| * |
| * @param[in] aLength The MAC Frame Length. |
| * |
| */ |
| void SetLength(uint16_t aLength) { mLength = aLength; } |
| |
| /** |
| * This method returns the MAC header size. |
| * |
| * @returns The MAC header size. |
| * |
| */ |
| uint8_t GetHeaderLength(void) const; |
| |
| /** |
| * This method returns the MAC footer size. |
| * |
| * @returns The MAC footer size. |
| * |
| */ |
| uint8_t GetFooterLength(void) const; |
| |
| /** |
| * This method returns the current MAC Payload length. |
| * |
| * @returns The current MAC Payload length. |
| * |
| */ |
| uint16_t GetPayloadLength(void) const; |
| |
| /** |
| * This method returns the maximum MAC Payload length for the given MAC header and footer. |
| * |
| * @returns The maximum MAC Payload length for the given MAC header and footer. |
| * |
| */ |
| uint16_t GetMaxPayloadLength(void) const; |
| |
| /** |
| * This method sets the MAC Payload length. |
| * |
| */ |
| void SetPayloadLength(uint16_t aLength); |
| |
| /** |
| * This method returns the IEEE 802.15.4 channel used for transmission or reception. |
| * |
| * @returns The IEEE 802.15.4 channel used for transmission or reception. |
| * |
| */ |
| uint8_t GetChannel(void) const { return mChannel; } |
| |
| /** |
| * This method sets the IEEE 802.15.4 channel used for transmission or reception. |
| * |
| * @param[in] aChannel The IEEE 802.15.4 channel used for transmission or reception. |
| * |
| */ |
| void SetChannel(uint8_t aChannel) { mChannel = aChannel; } |
| |
| /** |
| * This method returns the IEEE 802.15.4 PSDU length. |
| * |
| * @returns The IEEE 802.15.4 PSDU length. |
| * |
| */ |
| uint16_t GetPsduLength(void) const { return mLength; } |
| |
| /** |
| * This method returns a pointer to the PSDU. |
| * |
| * @returns A pointer to the PSDU. |
| * |
| */ |
| uint8_t *GetPsdu(void) { return mPsdu; } |
| |
| /** |
| * This const method returns a pointer to the PSDU. |
| * |
| * @returns A pointer to the PSDU. |
| * |
| */ |
| const uint8_t *GetPsdu(void) const { return mPsdu; } |
| |
| /** |
| * This method returns a pointer to the MAC Header. |
| * |
| * @returns A pointer to the MAC Header. |
| * |
| */ |
| uint8_t *GetHeader(void) { return GetPsdu(); } |
| |
| /** |
| * This const method returns a pointer to the MAC Header. |
| * |
| * @returns A pointer to the MAC Header. |
| * |
| */ |
| const uint8_t *GetHeader(void) const { return GetPsdu(); } |
| |
| /** |
| * This method returns a pointer to the MAC Payload. |
| * |
| * @returns A pointer to the MAC Payload. |
| * |
| */ |
| uint8_t *GetPayload(void) { return AsNonConst(AsConst(this)->GetPayload()); } |
| |
| /** |
| * This const method returns a pointer to the MAC Payload. |
| * |
| * @returns A pointer to the MAC Payload. |
| * |
| */ |
| const uint8_t *GetPayload(void) const; |
| |
| /** |
| * This method returns a pointer to the MAC Footer. |
| * |
| * @returns A pointer to the MAC Footer. |
| * |
| */ |
| uint8_t *GetFooter(void) { return AsNonConst(AsConst(this)->GetFooter()); } |
| |
| /** |
| * This const method returns a pointer to the MAC Footer. |
| * |
| * @returns A pointer to the MAC Footer. |
| * |
| */ |
| const uint8_t *GetFooter(void) const; |
| |
| #if OPENTHREAD_CONFIG_TIME_SYNC_ENABLE |
| |
| /** |
| * This method returns a pointer to the vendor specific Time IE. |
| * |
| * @returns A pointer to the Time IE, `nullptr` if not found. |
| * |
| */ |
| TimeIe *GetTimeIe(void) { return AsNonConst(AsConst(this)->GetTimeIe()); } |
| |
| /** |
| * This method returns a pointer to the vendor specific Time IE. |
| * |
| * @returns A pointer to the Time IE, `nullptr` if not found. |
| * |
| */ |
| const TimeIe *GetTimeIe(void) const; |
| #endif // OPENTHREAD_CONFIG_TIME_SYNC_ENABLE |
| |
| #if OPENTHREAD_CONFIG_MAC_HEADER_IE_SUPPORT |
| /** |
| * This template method appends an Header IE at specified index in this frame. |
| * |
| * @param[in,out] aIndex The index to append IE. If `aIndex` is `0` on input, this method finds the index |
| * for the first IE and appends the IE at that position. If the position is not found |
| * successfully, `aIndex` will be set to `kInvalidIndex`. Otherwise the IE will be |
| * appended at `aIndex` on input. And on output, `aIndex` will be set to the end of the |
| * IE just appended. |
| * |
| * @tparam IeType The Header IE type, it MUST contain a constant `kHeaderIeId` equal to the IE's Id |
| * and a constant `kIeContentSize` indicating the IE body's size. |
| * |
| * @retval kErrorNone Successfully appended the Header IE. |
| * @retval kErrorNotFound The position for first IE is not found. |
| * |
| */ |
| template <typename IeType> Error AppendHeaderIeAt(uint8_t &aIndex); |
| |
| /** |
| * This method returns a pointer to the Header IE. |
| * |
| * @param[in] aIeId The Element Id of the Header IE. |
| * |
| * @returns A pointer to the Header IE, `nullptr` if not found. |
| * |
| */ |
| uint8_t *GetHeaderIe(uint8_t aIeId) { return AsNonConst(AsConst(this)->GetHeaderIe(aIeId)); } |
| |
| /** |
| * This method returns a pointer to the Header IE. |
| * |
| * @param[in] aIeId The Element Id of the Header IE. |
| * |
| * @returns A pointer to the Header IE, `nullptr` if not found. |
| * |
| */ |
| const uint8_t *GetHeaderIe(uint8_t aIeId) const; |
| |
| /** |
| * This method returns a pointer to a specific Thread IE. |
| * |
| * A Thread IE is a vendor specific IE with Vendor OUI as `kVendorOuiThreadCompanyId`. |
| * |
| * @param[in] aSubType The sub type of the Thread IE. |
| * |
| * @returns A pointer to the Thread IE, `nullptr` if not found. |
| * |
| */ |
| uint8_t *GetThreadIe(uint8_t aSubType) { return AsNonConst(AsConst(this)->GetThreadIe(aSubType)); } |
| |
| /** |
| * This method returns a pointer to a specific Thread IE. |
| * |
| * A Thread IE is a vendor specific IE with Vendor OUI as `kVendorOuiThreadCompanyId`. |
| * |
| * @param[in] aSubType The sub type of the Thread IE. |
| * |
| * @returns A pointer to the Thread IE, `nullptr` if not found. |
| * |
| */ |
| const uint8_t *GetThreadIe(uint8_t aSubType) const; |
| |
| #if OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE |
| /** |
| * This method finds CSL IE in the frame and modify its content. |
| * |
| * @param[in] aCslPeriod CSL Period in CSL IE. |
| * @param[in] aCslPhase CSL Phase in CSL IE. |
| * |
| */ |
| void SetCslIe(uint16_t aCslPeriod, uint16_t aCslPhase); |
| #endif // OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE |
| |
| #if OPENTHREAD_CONFIG_MLE_LINK_METRICS_SUBJECT_ENABLE |
| /** |
| * This method finds Enhanced ACK Probing (Vendor Specific) IE and set its value. |
| * |
| * @param[in] aValue A pointer to the value to set. |
| * @param[in] aLen The length of @p aValue. |
| * |
| */ |
| void SetEnhAckProbingIe(const uint8_t *aValue, uint8_t aLen); |
| #endif // OPENTHREAD_CONFIG_MLE_LINK_METRICS_SUBJECT_ENABLE |
| |
| #endif // OPENTHREAD_CONFIG_MAC_HEADER_IE_SUPPORT |
| |
| #if OPENTHREAD_CONFIG_MULTI_RADIO |
| /** |
| * This method gets the radio link type of the frame. |
| * |
| * @returns Frame's radio link type. |
| * |
| */ |
| RadioType GetRadioType(void) const { return static_cast<RadioType>(mRadioType); } |
| |
| /** |
| * This method sets the radio link type of the frame. |
| * |
| * @param[in] aRadioType A radio link type. |
| * |
| */ |
| void SetRadioType(RadioType aRadioType) { mRadioType = static_cast<uint8_t>(aRadioType); } |
| #endif |
| |
| /** |
| * This method returns the maximum transmission unit size (MTU). |
| * |
| * @returns The maximum transmission unit (MTU). |
| * |
| */ |
| 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 |
| |
| /** |
| * This method returns the FCS size. |
| * |
| * @returns This method returns the FCS size. |
| * |
| */ |
| uint8_t GetFcsSize(void) const |
| #if !OPENTHREAD_CONFIG_MULTI_RADIO && OPENTHREAD_CONFIG_RADIO_LINK_IEEE_802_15_4_ENABLE |
| { |
| return k154FcsSize; |
| } |
| #else |
| ; |
| #endif |
| |
| /** |
| * This method returns information about the frame object as an `InfoString` object. |
| * |
| * @returns An `InfoString` containing info about the frame. |
| * |
| */ |
| InfoString ToInfoString(void) const; |
| |
| /** |
| * This method returns the Frame Control field of the frame. |
| * |
| * @returns The Frame Control field. |
| * |
| */ |
| uint16_t GetFrameControlField(void) const; |
| |
| protected: |
| static constexpr uint8_t kInvalidIndex = 0xff; |
| static constexpr uint8_t kInvalidSize = kInvalidIndex; |
| static constexpr uint8_t kMaxPsduSize = kInvalidSize - 1; |
| static constexpr uint8_t kSequenceIndex = kFcfSize; |
| |
| 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; |
| |
| Error InitIeHeaderAt(uint8_t &aIndex, uint8_t ieId, uint8_t ieContentSize); |
| template <typename IeType> void InitIeContentAt(uint8_t &aIndex); |
| #endif |
| |
| static uint8_t GetKeySourceLength(uint8_t aKeyIdMode); |
| |
| static bool IsDstAddrPresent(uint16_t aFcf) { return (aFcf & kFcfDstAddrMask) != kFcfDstAddrNone; } |
| static bool IsDstPanIdPresent(uint16_t aFcf); |
| static bool IsSrcAddrPresent(uint16_t aFcf) { return (aFcf & kFcfSrcAddrMask) != kFcfSrcAddrNone; } |
| static bool IsSrcPanIdPresent(uint16_t aFcf); |
| static bool IsVersion2015(uint16_t aFcf) { return (aFcf & kFcfFrameVersionMask) == kFcfFrameVersion2015; } |
| |
| static uint8_t CalculateAddrFieldSize(uint16_t aFcf); |
| static uint8_t CalculateSecurityHeaderSize(uint8_t aSecurityControl); |
| static uint8_t CalculateMicSize(uint8_t aSecurityControl); |
| }; |
| |
| /** |
| * This class supports received IEEE 802.15.4 MAC frame processing. |
| * |
| */ |
| class RxFrame : public Frame |
| { |
| public: |
| friend class TxFrame; |
| |
| /** |
| * This method returns the RSSI in dBm used for reception. |
| * |
| * @returns The RSSI in dBm used for reception. |
| * |
| */ |
| int8_t GetRssi(void) const { return mInfo.mRxInfo.mRssi; } |
| |
| /** |
| * This method sets the RSSI in dBm used for reception. |
| * |
| * @param[in] aRssi The RSSI in dBm used for reception. |
| * |
| */ |
| void SetRssi(int8_t aRssi) { mInfo.mRxInfo.mRssi = aRssi; } |
| |
| /** |
| * This method returns the receive Link Quality Indicator. |
| * |
| * @returns The receive Link Quality Indicator. |
| * |
| */ |
| uint8_t GetLqi(void) const { return mInfo.mRxInfo.mLqi; } |
| |
| /** |
| * This method sets the receive Link Quality Indicator. |
| * |
| * @param[in] aLqi The receive Link Quality Indicator. |
| * |
| */ |
| void SetLqi(uint8_t aLqi) { mInfo.mRxInfo.mLqi = aLqi; } |
| |
| /** |
| * This method indicates whether or not the received frame is acknowledged with frame pending set. |
| * |
| * @retval TRUE This frame is acknowledged with frame pending set. |
| * @retval FALSE This frame is acknowledged with frame pending not set. |
| * |
| */ |
| bool IsAckedWithFramePending(void) const { return mInfo.mRxInfo.mAckedWithFramePending; } |
| |
| /** |
| * This method returns the timestamp when the frame was received. |
| * |
| * @returns The timestamp when the frame was received, in microseconds. |
| * |
| */ |
| const uint64_t &GetTimestamp(void) const { return mInfo.mRxInfo.mTimestamp; } |
| |
| /** |
| * This method performs AES CCM on the frame which is received. |
| * |
| * @param[in] aExtAddress A reference to the extended address, which will be used to generate nonce |
| * for AES CCM computation. |
| * @param[in] aMacKey A reference to the MAC key to decrypt the received frame. |
| * |
| * @retval kErrorNone Process of received frame AES CCM succeeded. |
| * @retval kErrorSecurity Received frame MIC check failed. |
| * |
| */ |
| Error ProcessReceiveAesCcm(const ExtAddress &aExtAddress, const KeyMaterial &aMacKey); |
| |
| #if OPENTHREAD_CONFIG_TIME_SYNC_ENABLE |
| /** |
| * This method gets the offset to network time. |
| * |
| * @returns The offset to network time. |
| * |
| */ |
| int64_t ComputeNetworkTimeOffset(void) const |
| { |
| return static_cast<int64_t>(GetTimeIe()->GetTime() - GetTimestamp()); |
| } |
| |
| /** |
| * This method gets the time sync sequence. |
| * |
| * @returns The time sync sequence. |
| * |
| */ |
| uint8_t ReadTimeSyncSeq(void) const { return GetTimeIe()->GetSequence(); } |
| #endif // OPENTHREAD_CONFIG_TIME_SYNC_ENABLE |
| }; |
| |
| /** |
| * This class supports IEEE 802.15.4 MAC frame generation for transmission. |
| * |
| */ |
| class TxFrame : public Frame |
| { |
| public: |
| /** |
| * This method returns the maximum number of backoffs the CSMA-CA algorithm will attempt before declaring a channel |
| * access failure. |
| * |
| * Equivalent to macMaxCSMABackoffs in IEEE 802.15.4-2006. |
| * |
| * @returns The maximum number of backoffs the CSMA-CA algorithm will attempt before declaring a channel access |
| * failure. |
| * |
| */ |
| uint8_t GetMaxCsmaBackoffs(void) const { return mInfo.mTxInfo.mMaxCsmaBackoffs; } |
| |
| /** |
| * This method sets the maximum number of backoffs the CSMA-CA algorithm will attempt before declaring a channel |
| * access failure. |
| * |
| * Equivalent to macMaxCSMABackoffs in IEEE 802.15.4-2006. |
| * |
| * @param[in] aMaxCsmaBackoffs The maximum number of backoffs the CSMA-CA algorithm will attempt before declaring |
| * a channel access failure. |
| * |
| */ |
| void SetMaxCsmaBackoffs(uint8_t aMaxCsmaBackoffs) { mInfo.mTxInfo.mMaxCsmaBackoffs = aMaxCsmaBackoffs; } |
| |
| /** |
| * This method returns the maximum number of retries allowed after a transmission failure. |
| * |
| * Equivalent to macMaxFrameRetries in IEEE 802.15.4-2006. |
| * |
| * @returns The maximum number of retries allowed after a transmission failure. |
| * |
| */ |
| uint8_t GetMaxFrameRetries(void) const { return mInfo.mTxInfo.mMaxFrameRetries; } |
| |
| /** |
| * This method sets the maximum number of retries allowed after a transmission failure. |
| * |
| * Equivalent to macMaxFrameRetries in IEEE 802.15.4-2006. |
| * |
| * @param[in] aMaxFrameRetries The maximum number of retries allowed after a transmission failure. |
| * |
| */ |
| void SetMaxFrameRetries(uint8_t aMaxFrameRetries) { mInfo.mTxInfo.mMaxFrameRetries = aMaxFrameRetries; } |
| |
| /** |
| * This method indicates whether or not the frame is a retransmission. |
| * |
| * @retval TRUE Frame is a retransmission |
| * @retval FALSE This is a new frame and not a retransmission of an earlier frame. |
| * |
| */ |
| bool IsARetransmission(void) const { return mInfo.mTxInfo.mIsARetx; } |
| |
| /** |
| * This method sets the retransmission flag attribute. |
| * |
| * @param[in] aIsARetx TRUE if frame is a retransmission of an earlier frame, FALSE otherwise. |
| * |
| */ |
| void SetIsARetransmission(bool aIsARetx) { mInfo.mTxInfo.mIsARetx = aIsARetx; } |
| |
| /** |
| * This method indicates whether or not CSMA-CA is enabled. |
| * |
| * @retval TRUE CSMA-CA is enabled. |
| * @retval FALSE CSMA-CA is not enabled is not enabled. |
| * |
| */ |
| bool IsCsmaCaEnabled(void) const { return mInfo.mTxInfo.mCsmaCaEnabled; } |
| |
| /** |
| * This method sets the CSMA-CA enabled attribute. |
| * |
| * @param[in] aCsmaCaEnabled TRUE if CSMA-CA must be enabled for this packet, FALSE otherwise. |
| * |
| */ |
| void SetCsmaCaEnabled(bool aCsmaCaEnabled) { mInfo.mTxInfo.mCsmaCaEnabled = aCsmaCaEnabled; } |
| |
| /** |
| * This method returns the key used for frame encryption and authentication (AES CCM). |
| * |
| * @returns The pointer to the key. |
| * |
| */ |
| const Mac::KeyMaterial &GetAesKey(void) const |
| { |
| return *static_cast<const Mac::KeyMaterial *>(mInfo.mTxInfo.mAesKey); |
| } |
| |
| /** |
| * This method sets the key used for frame encryption and authentication (AES CCM). |
| * |
| * @param[in] aAesKey The pointer to the key. |
| * |
| */ |
| void SetAesKey(const Mac::KeyMaterial &aAesKey) { mInfo.mTxInfo.mAesKey = &aAesKey; } |
| |
| /** |
| * This method copies the PSDU and all attributes (except for frame link type) from another frame. |
| * |
| * @note This method performs a deep copy meaning the content of PSDU buffer from the given frame is copied into |
| * the PSDU buffer of the current frame. |
| |
| * @param[in] aFromFrame The frame to copy from. |
| * |
| */ |
| void CopyFrom(const TxFrame &aFromFrame); |
| |
| /** |
| * This method performs AES CCM on the frame which is going to be sent. |
| * |
| * @param[in] aExtAddress A reference to the extended address, which will be used to generate nonce |
| * for AES CCM computation. |
| * |
| */ |
| void ProcessTransmitAesCcm(const ExtAddress &aExtAddress); |
| |
| /** |
| * This method indicates whether or not the frame has security processed. |
| * |
| * @retval TRUE The frame already has security processed. |
| * @retval FALSE The frame does not have security processed. |
| * |
| */ |
| bool IsSecurityProcessed(void) const { return mInfo.mTxInfo.mIsSecurityProcessed; } |
| |
| /** |
| * This method sets the security processed flag attribute. |
| * |
| * @param[in] aIsSecurityProcessed TRUE if the frame already has security processed. |
| * |
| */ |
| void SetIsSecurityProcessed(bool aIsSecurityProcessed) |
| { |
| mInfo.mTxInfo.mIsSecurityProcessed = aIsSecurityProcessed; |
| } |
| |
| /** |
| * This method indicates whether or not the frame header is updated. |
| * |
| * @retval TRUE The frame already has the header updated. |
| * @retval FALSE The frame does not have the header updated. |
| * |
| */ |
| bool IsHeaderUpdated(void) const { return mInfo.mTxInfo.mIsHeaderUpdated; } |
| |
| /** |
| * This method sets the header updated flag attribute. |
| * |
| * @param[in] aIsHeaderUpdated TRUE if the frame header is updated. |
| * |
| */ |
| void SetIsHeaderUpdated(bool aIsHeaderUpdated) { mInfo.mTxInfo.mIsHeaderUpdated = aIsHeaderUpdated; } |
| |
| #if OPENTHREAD_CONFIG_TIME_SYNC_ENABLE |
| /** |
| * This method sets the Time IE offset. |
| * |
| * @param[in] aOffset The Time IE offset, 0 means no Time IE. |
| * |
| */ |
| void SetTimeIeOffset(uint8_t aOffset) { mInfo.mTxInfo.mIeInfo->mTimeIeOffset = aOffset; } |
| |
| /** |
| * This method gets the Time IE offset. |
| * |
| * @returns The Time IE offset, 0 means no Time IE. |
| * |
| */ |
| uint8_t GetTimeIeOffset(void) const { return mInfo.mTxInfo.mIeInfo->mTimeIeOffset; } |
| |
| /** |
| * This method sets the offset to network time. |
| * |
| * @param[in] aNetworkTimeOffset The offset to network time. |
| * |
| */ |
| void SetNetworkTimeOffset(int64_t aNetworkTimeOffset) |
| { |
| mInfo.mTxInfo.mIeInfo->mNetworkTimeOffset = aNetworkTimeOffset; |
| } |
| |
| /** |
| * This method sets the time sync sequence. |
| * |
| * @param[in] aTimeSyncSeq The time sync sequence. |
| * |
| */ |
| void SetTimeSyncSeq(uint8_t aTimeSyncSeq) { mInfo.mTxInfo.mIeInfo->mTimeSyncSeq = aTimeSyncSeq; } |
| #endif // OPENTHREAD_CONFIG_TIME_SYNC_ENABLE |
| |
| /** |
| * Generate Imm-Ack in this frame object. |
| * |
| * @param[in] aFrame A reference to the frame received. |
| * @param[in] aIsFramePending Value of the ACK's frame pending bit. |
| * |
| */ |
| void GenerateImmAck(const RxFrame &aFrame, bool aIsFramePending); |
| |
| /** |
| * Generate Enh-Ack in this frame object. |
| * |
| * @param[in] aFrame A reference to the frame received. |
| * @param[in] aIsFramePending Value of the ACK's frame pending bit. |
| * @param[in] aIeData A pointer to the IE data portion of the ACK to be sent. |
| * @param[in] aIeLength The length of IE data portion of the ACK to be sent. |
| * |
| * @retval kErrorNone Successfully generated Enh Ack. |
| * @retval kErrorParse @p aFrame has incorrect format. |
| * |
| */ |
| Error GenerateEnhAck(const RxFrame &aFrame, bool aIsFramePending, const uint8_t *aIeData, uint8_t aIeLength); |
| |
| #if OPENTHREAD_CONFIG_THREAD_VERSION >= OT_THREAD_VERSION_1_2 |
| /** |
| * Set TX delay field for the frame. |
| * |
| * @param[in] aTxDelay The delay time for the TX frame. |
| * |
| */ |
| void SetTxDelay(uint32_t aTxDelay) { mInfo.mTxInfo.mTxDelay = aTxDelay; } |
| |
| /** |
| * Set TX delay base time field for the frame. |
| * |
| * @param[in] aTxDelayBaseTime The delay base time for the TX frame. |
| * |
| */ |
| void SetTxDelayBaseTime(uint32_t aTxDelayBaseTime) { mInfo.mTxInfo.mTxDelayBaseTime = aTxDelayBaseTime; } |
| #endif |
| }; |
| |
| OT_TOOL_PACKED_BEGIN |
| class Beacon |
| { |
| public: |
| static constexpr uint16_t kSuperFrameSpec = 0x0fff; ///< Superframe Specification value. |
| |
| /** |
| * This method initializes the Beacon message. |
| * |
| */ |
| void Init(void) |
| { |
| mSuperframeSpec = HostSwap16(kSuperFrameSpec); |
| mGtsSpec = 0; |
| mPendingAddressSpec = 0; |
| } |
| |
| /** |
| * This method indicates whether or not the beacon appears to be a valid Thread Beacon message. |
| * |
| * @retval TRUE If the beacon appears to be a valid Thread Beacon message. |
| * @retval FALSE If the beacon does not appear to be a valid Thread Beacon message. |
| * |
| */ |
| bool IsValid(void) const |
| { |
| return (mSuperframeSpec == HostSwap16(kSuperFrameSpec)) && (mGtsSpec == 0) && (mPendingAddressSpec == 0); |
| } |
| |
| /** |
| * This method returns the pointer to the beacon payload. |
| * |
| * @returns A pointer to the beacon payload. |
| * |
| */ |
| uint8_t *GetPayload(void) { return reinterpret_cast<uint8_t *>(this) + sizeof(*this); } |
| |
| /** |
| * This method returns the pointer to the beacon payload. |
| * |
| * @returns A pointer to the beacon payload. |
| * |
| */ |
| const uint8_t *GetPayload(void) const { return reinterpret_cast<const uint8_t *>(this) + sizeof(*this); } |
| |
| private: |
| uint16_t mSuperframeSpec; |
| uint8_t mGtsSpec; |
| uint8_t mPendingAddressSpec; |
| } OT_TOOL_PACKED_END; |
| |
| /** |
| * This class implements IEEE 802.15.4 Beacon Payload generation and parsing. |
| * |
| */ |
| OT_TOOL_PACKED_BEGIN |
| class BeaconPayload |
| { |
| public: |
| static constexpr uint8_t kProtocolId = 3; ///< Thread Protocol ID. |
| static constexpr uint8_t kProtocolVersion = 2; ///< Thread Protocol version. |
| static constexpr uint8_t kVersionOffset = 4; ///< Version field bit offset. |
| static constexpr uint8_t kVersionMask = 0xf << kVersionOffset; ///< Version field mask. |
| static constexpr uint8_t kNativeFlag = 1 << 3; ///< Native Commissioner flag. |
| static constexpr uint8_t kJoiningFlag = 1 << 0; ///< Joining Permitted flag. |
| |
| /** |
| * This method initializes the Beacon Payload. |
| * |
| */ |
| void Init(void) |
| { |
| mProtocolId = kProtocolId; |
| mFlags = kProtocolVersion << kVersionOffset; |
| } |
| |
| /** |
| * This method indicates whether or not the beacon appears to be a valid Thread Beacon Payload. |
| * |
| * @retval TRUE If the beacon appears to be a valid Thread Beacon Payload. |
| * @retval FALSE If the beacon does not appear to be a valid Thread Beacon Payload. |
| * |
| */ |
| bool IsValid(void) const { return (mProtocolId == kProtocolId); } |
| |
| /** |
| * This method returns the Protocol ID value. |
| * |
| * @returns the Protocol ID value. |
| * |
| */ |
| uint8_t GetProtocolId(void) const { return mProtocolId; } |
| |
| /** |
| * This method returns the Protocol Version value. |
| * |
| * @returns The Protocol Version value. |
| * |
| */ |
| uint8_t GetProtocolVersion(void) const { return mFlags >> kVersionOffset; } |
| |
| /** |
| * This method indicates whether or not the Native Commissioner flag is set. |
| * |
| * @retval TRUE If the Native Commissioner flag is set. |
| * @retval FALSE If the Native Commissioner flag is not set. |
| * |
| */ |
| bool IsNative(void) const { return (mFlags & kNativeFlag) != 0; } |
| |
| /** |
| * This method clears the Native Commissioner flag. |
| * |
| */ |
| void ClearNative(void) { mFlags &= ~kNativeFlag; } |
| |
| /** |
| * This method sets the Native Commissioner flag. |
| * |
| */ |
| void SetNative(void) { mFlags |= kNativeFlag; } |
| |
| /** |
| * This method indicates whether or not the Joining Permitted flag is set. |
| * |
| * @retval TRUE If the Joining Permitted flag is set. |
| * @retval FALSE If the Joining Permitted flag is not set. |
| * |
| */ |
| bool IsJoiningPermitted(void) const { return (mFlags & kJoiningFlag) != 0; } |
| |
| /** |
| * This method clears the Joining Permitted flag. |
| * |
| */ |
| void ClearJoiningPermitted(void) { mFlags &= ~kJoiningFlag; } |
| |
| /** |
| * This method sets the Joining Permitted flag. |
| * |
| */ |
| void SetJoiningPermitted(void) |
| { |
| mFlags |= kJoiningFlag; |
| |
| #if OPENTHREAD_CONFIG_MAC_JOIN_BEACON_VERSION != 2 // check against kProtocolVersion |
| mFlags &= ~kVersionMask; |
| mFlags |= OPENTHREAD_CONFIG_MAC_JOIN_BEACON_VERSION << kVersionOffset; |
| #endif |
| } |
| |
| /** |
| * This method gets the Network Name field. |
| * |
| * @returns The Network Name field as `NameData`. |
| * |
| */ |
| MeshCoP::NameData GetNetworkName(void) const { return MeshCoP::NameData(mNetworkName, sizeof(mNetworkName)); } |
| |
| /** |
| * This method sets the Network Name field. |
| * |
| * @param[in] aNameData The Network Name (as a `NameData`). |
| * |
| */ |
| void SetNetworkName(const MeshCoP::NameData &aNameData) { aNameData.CopyTo(mNetworkName, sizeof(mNetworkName)); } |
| |
| /** |
| * This method returns the Extended PAN ID field. |
| * |
| * @returns The Extended PAN ID field. |
| * |
| */ |
| const otExtendedPanId &GetExtendedPanId(void) const { return mExtendedPanId; } |
| |
| /** |
| * This method sets the Extended PAN ID field. |
| * |
| * @param[in] aExtPanId An Extended PAN ID. |
| * |
| */ |
| void SetExtendedPanId(const otExtendedPanId &aExtPanId) { mExtendedPanId = aExtPanId; } |
| |
| private: |
| uint8_t mProtocolId; |
| uint8_t mFlags; |
| char mNetworkName[MeshCoP::NetworkName::kMaxSize]; |
| otExtendedPanId mExtendedPanId; |
| } OT_TOOL_PACKED_END; |
| |
| /** |
| * This class implements CSL IE data structure. |
| * |
| */ |
| OT_TOOL_PACKED_BEGIN |
| class CslIe |
| { |
| public: |
| static constexpr uint8_t kHeaderIeId = 0x1a; |
| static constexpr uint8_t kIeContentSize = sizeof(uint16_t) * 2; |
| |
| /** |
| * This method returns the CSL Period. |
| * |
| * @returns the CSL Period. |
| * |
| */ |
| uint16_t GetPeriod(void) const { return HostSwap16(mPeriod); } |
| |
| /** |
| * This method sets the CSL Period. |
| * |
| * @param[in] aPeriod The CSL Period. |
| * |
| */ |
| void SetPeriod(uint16_t aPeriod) { mPeriod = HostSwap16(aPeriod); } |
| |
| /** |
| * This method returns the CSL Phase. |
| * |
| * @returns the CSL Phase. |
| * |
| */ |
| uint16_t GetPhase(void) const { return HostSwap16(mPhase); } |
| |
| /** |
| * This method sets the CSL Phase. |
| * |
| * @param[in] aPhase The CSL Phase. |
| * |
| */ |
| void SetPhase(uint16_t aPhase) { mPhase = HostSwap16(aPhase); } |
| |
| private: |
| uint16_t mPhase; |
| uint16_t mPeriod; |
| } OT_TOOL_PACKED_END; |
| |
| /** |
| * This class implements Termination2 IE. |
| * |
| * This class is empty for template specialization. |
| * |
| */ |
| class Termination2Ie |
| { |
| public: |
| static constexpr uint8_t kHeaderIeId = 0x7f; |
| static constexpr uint8_t kIeContentSize = 0; |
| }; |
| |
| /** |
| * @} |
| * |
| */ |
| |
| } // namespace Mac |
| } // namespace ot |
| |
| #endif // MAC_FRAME_HPP_ |
