| /* |
| * 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 the IEEE 802.15.4 MAC. |
| */ |
| |
| #ifndef MAC_HPP_ |
| #define MAC_HPP_ |
| |
| #include <openthread/platform/radio.h> |
| |
| #include "openthread-core-config.h" |
| #include "common/context.hpp" |
| #include "common/locator.hpp" |
| #include "common/tasklet.hpp" |
| #include "common/timer.hpp" |
| #include "mac/mac_blacklist.hpp" |
| #include "mac/mac_frame.hpp" |
| #include "mac/mac_whitelist.hpp" |
| #include "thread/key_manager.hpp" |
| #include "thread/network_diagnostic_tlvs.hpp" |
| #include "thread/topology.hpp" |
| |
| namespace ot { |
| |
| namespace Mle { class MleRouter; } |
| |
| /** |
| * @addtogroup core-mac |
| * |
| * @brief |
| * This module includes definitions for the IEEE 802.15.4 MAC |
| * |
| * @{ |
| * |
| */ |
| |
| namespace Mac { |
| |
| /** |
| * Protocol parameters and constants. |
| * |
| */ |
| enum |
| { |
| kMinBE = 3, ///< macMinBE (IEEE 802.15.4-2006) |
| kMaxBE = 5, ///< macMaxBE (IEEE 802.15.4-2006) |
| kMaxCSMABackoffs = 4, ///< macMaxCSMABackoffs (IEEE 802.15.4-2006) |
| kUnitBackoffPeriod = 20, ///< Number of symbols (IEEE 802.15.4-2006) |
| |
| kMinBackoff = 1, ///< Minimum backoff (milliseconds). |
| |
| kAckTimeout = 16, ///< Timeout for waiting on an ACK (milliseconds). |
| kDataPollTimeout = 100, ///< Timeout for receiving Data Frame (milliseconds). |
| kSleepDelay = 300, ///< Max sleep delay when frame is pending (milliseconds). |
| kNonceSize = 13, ///< Size of IEEE 802.15.4 Nonce (bytes). |
| |
| kScanChannelsAll = OT_CHANNEL_ALL, ///< All channels. |
| kScanDurationDefault = 300, ///< Default interval between channels (milliseconds). |
| |
| /** |
| * Maximum number of MAC layer tx attempts for an outbound direct frame. |
| * |
| */ |
| kDirectFrameMacTxAttempts = OPENTHREAD_CONFIG_MAX_TX_ATTEMPTS_DIRECT, |
| |
| /** |
| * Maximum number of MAC layer tx attempts for an outbound indirect frame (for a sleepy child) after receiving |
| * a data request command (data poll) from the child. |
| * |
| */ |
| kIndirectFrameMacTxAttempts = OPENTHREAD_CONFIG_MAX_TX_ATTEMPTS_INDIRECT_PER_POLL, |
| }; |
| |
| /** |
| * This class implements a MAC receiver client. |
| * |
| */ |
| class Receiver: public Context |
| { |
| friend class Mac; |
| |
| public: |
| /** |
| * This function pointer is called when a MAC frame is received. |
| * |
| * @param[in] aReceiver A reference to the MAC receiver client object. |
| * @param[in] aFrame A reference to the MAC frame. |
| * |
| */ |
| typedef void (*ReceiveFrameHandler)(Receiver &aReceiver, Frame &aFrame); |
| |
| /** |
| * This function pointer is called on a data request command (data poll) timeout, i.e., when the ack in response to |
| * a data request command indicated a frame is pending, but no frame was received after `kDataPollTimeout` interval. |
| * |
| * @param[in] aReceiver A reference to the MAC receiver client object. |
| * |
| */ |
| typedef void (*DataPollTimeoutHandler)(Receiver &aReceiver); |
| |
| /** |
| * This constructor creates a MAC receiver client. |
| * |
| * @param[in] aReceiveFrameHandler A pointer to a function that is called on MAC frame reception. |
| * @param[in] aPollTimeoutHandler A pointer to a function called on data poll timeout (may be set to NULL). |
| * @param[in] aContext A pointer to arbitrary context information. |
| * |
| */ |
| Receiver(ReceiveFrameHandler aReceiveFrameHandler, DataPollTimeoutHandler aPollTimeoutHandler, void *aContext): |
| Context(aContext), |
| mReceiveFrameHandler(aReceiveFrameHandler), |
| mPollTimeoutHandler(aPollTimeoutHandler), |
| mNext(NULL) { |
| } |
| |
| private: |
| void HandleReceivedFrame(Frame &frame) { mReceiveFrameHandler(*this, frame); } |
| |
| void HandleDataPollTimeout(void) { |
| if (mPollTimeoutHandler != NULL) { |
| mPollTimeoutHandler(*this); |
| } |
| } |
| |
| ReceiveFrameHandler mReceiveFrameHandler; |
| DataPollTimeoutHandler mPollTimeoutHandler; |
| Receiver *mNext; |
| }; |
| |
| /** |
| * This class implements a MAC sender client. |
| * |
| */ |
| class Sender: public Context |
| { |
| friend class Mac; |
| |
| public: |
| /** |
| * This function pointer is called when the MAC is about to transmit the frame. |
| * |
| * @param[in] aSender A reference to the MAC sender client object. |
| * @param[in] aFrame A reference to the MAC frame buffer. |
| * |
| */ |
| typedef otError(*FrameRequestHandler)(Sender &aSender, Frame &aFrame); |
| |
| /** |
| * This function pointer is called when the MAC is done sending the frame. |
| * |
| * @param[in] aSender A reference to the MAC sender client object. |
| * @param[in] aFrame A reference to the MAC frame buffer that was sent. |
| * @param[in] aError The status of the last MSDU transmission. |
| * |
| */ |
| typedef void (*SentFrameHandler)(Sender &aSender, Frame &aFrame, otError aError); |
| |
| /** |
| * This constructor creates a MAC sender client. |
| * |
| * @param[in] aFrameRequestHandler A pointer to a function that is called when about to send a MAC frame. |
| * @param[in] aSentFrameHandler A pointer to a function that is called when done sending the frame. |
| * @param[in] aContext A pointer to arbitrary context information. |
| * |
| */ |
| Sender(FrameRequestHandler aFrameRequestHandler, SentFrameHandler aSentFrameHandler, void *aContext): |
| Context(aContext), |
| mFrameRequestHandler(aFrameRequestHandler), |
| mSentFrameHandler(aSentFrameHandler), |
| mNext(NULL) { |
| } |
| |
| private: |
| otError HandleFrameRequest(Frame &frame) { return mFrameRequestHandler(*this, frame); } |
| void HandleSentFrame(Frame &frame, otError error) { mSentFrameHandler(*this, frame, error); } |
| |
| FrameRequestHandler mFrameRequestHandler; |
| SentFrameHandler mSentFrameHandler; |
| Sender *mNext; |
| }; |
| |
| /** |
| * This class implements the IEEE 802.15.4 MAC. |
| * |
| */ |
| class Mac: public ThreadNetifLocator |
| { |
| public: |
| /** |
| * This constructor initializes the MAC object. |
| * |
| * @param[in] aThreadNetif A reference to the network interface using this MAC. |
| * |
| */ |
| explicit Mac(ThreadNetif &aThreadNetif); |
| |
| /** |
| * This function pointer is called on receiving an IEEE 802.15.4 Beacon during an Active Scan. |
| * |
| * @param[in] aContext A pointer to arbitrary context information. |
| * @param[in] aBeaconFrame A pointer to the Beacon frame. |
| * |
| */ |
| typedef void (*ActiveScanHandler)(void *aContext, Frame *aBeaconFrame); |
| |
| /** |
| * This method starts an IEEE 802.15.4 Active Scan. |
| * |
| * @param[in] aScanChannels A bit vector indicating which channels to scan. |
| * @param[in] aScanDuration The time in milliseconds to spend scanning each channel. |
| * @param[in] aHandler A pointer to a function that is called on receiving an IEEE 802.15.4 Beacon. |
| * @param[in] aContext A pointer to arbitrary context information. |
| * |
| */ |
| otError ActiveScan(uint32_t aScanChannels, uint16_t aScanDuration, ActiveScanHandler aHandler, void *aContext); |
| |
| /** |
| * This method converts a beacon frame to an active scan result of type `otActiveScanResult`. |
| * |
| * @param[in] aBeaconFrame A pointer to a beacon frame. |
| * @param[out] aResult A reference to `otActiveScanResult` where the result is stored. |
| * |
| * @retval OT_ERROR_NONE Successfully converted the beacon into active scan result. |
| * @retval OT_ERROR_INVALID_ARGS The @a aBeaconFrame was NULL. |
| * @retval OT_ERROR_PARSE Failed parsing the beacon frame. |
| * |
| */ |
| otError ConvertBeaconToActiveScanResult(Frame *aBeaconFrame, otActiveScanResult &aResult); |
| |
| /** |
| * This function pointer is called during an "Energy Scan" when the result for a channel is ready or the scan |
| * completes. |
| * |
| * @param[in] aContext A pointer to arbitrary context information. |
| * @param[in] aResult A valid pointer to the energy scan result information or NULL when the energy scan completes. |
| * |
| */ |
| typedef void (*EnergyScanHandler)(void *aContext, otEnergyScanResult *aResult); |
| |
| /** |
| * This method starts an IEEE 802.15.4 Energy Scan. |
| * |
| * @param[in] aScanChannels A bit vector indicating on which channels to perform energy scan. |
| * @param[in] aScanDuration The time in milliseconds to spend scanning each channel. |
| * @param[in] aHandler A pointer to a function called to pass on scan result or indicate scan completion. |
| * @param[in] aContext A pointer to arbitrary context information. |
| * |
| * @retval OT_ERROR_NONE Accepted the Energy Scan request. |
| * @retval OT_ERROR_BUSY Could not start the energy scan. |
| * |
| */ |
| otError EnergyScan(uint32_t aScanChannels, uint16_t aScanDuration, EnergyScanHandler aHandler, void *aContext); |
| |
| /** |
| * This method indicates the energy scan for the current channel is complete. |
| * |
| * @param[in] aEnergyScanMaxRssi The maximum RSSI encountered on the scanned channel. |
| * |
| */ |
| void EnergyScanDone(int8_t aEnergyScanMaxRssi); |
| |
| /** |
| * This method indicates whether or not IEEE 802.15.4 Beacon transmissions are enabled. |
| * |
| * @retval TRUE if IEEE 802.15.4 Beacon transmissions are enabled, FALSE otherwise. |
| * |
| */ |
| bool IsBeaconEnabled(void) const { return mBeaconsEnabled; } |
| |
| /** |
| * This method enables/disables IEEE 802.15.4 Beacon transmissions. |
| * |
| * @param[in] aEnabled TRUE to enable IEEE 802.15.4 Beacon transmissions, FALSE otherwise. |
| * |
| */ |
| void SetBeaconEnabled(bool aEnabled) { mBeaconsEnabled = aEnabled; } |
| |
| /** |
| * This method indicates whether or not rx-on-when-idle is enabled. |
| * |
| * @retval TRUE If rx-on-when-idle is enabled. |
| * @retval FALSE If rx-on-when-idle is not enabled. |
| */ |
| bool GetRxOnWhenIdle(void) const { return mRxOnWhenIdle; } |
| |
| /** |
| * This method sets the rx-on-when-idle mode. |
| * |
| * @param[in] aRxOnWhenIdle The rx-on-when-idle mode. |
| * |
| */ |
| void SetRxOnWhenIdle(bool aRxOnWhenIdle); |
| |
| /** |
| * This method registers a new MAC receiver client. |
| * |
| * @param[in] aReceiver A reference to the MAC receiver client. |
| * |
| * @retval OT_ERROR_NONE Successfully registered the receiver. |
| * @retval OT_ERROR_ALREADY The receiver was already registered. |
| * |
| */ |
| otError RegisterReceiver(Receiver &aReceiver); |
| |
| /** |
| * This method registers a new MAC sender client. |
| * |
| * @param[in] aSender A reference to the MAC sender client. |
| * |
| * @retval OT_ERROR_NONE Successfully registered the sender. |
| * @retval OT_ERROR_ALREADY The sender was already registered. |
| * |
| */ |
| otError SendFrameRequest(Sender &aSender); |
| |
| /** |
| * This method generates a random IEEE 802.15.4 Extended Address. |
| * |
| * @param[out] aExtAddress A pointer to where the generated Extended Address is placed. |
| * |
| */ |
| void GenerateExtAddress(ExtAddress *aExtAddress); |
| |
| /** |
| * This method returns a pointer to the IEEE 802.15.4 Extended Address. |
| * |
| * @returns A pointer to the IEEE 802.15.4 Extended Address. |
| * |
| */ |
| const ExtAddress *GetExtAddress(void) const { return &mExtAddress; } |
| |
| /** |
| * This method sets the IEEE 802.15.4 Extended Address |
| * |
| * @param[in] aExtAddress A reference to the IEEE 802.15.4 Extended Address. |
| * |
| */ |
| void SetExtAddress(const ExtAddress &aExtAddress); |
| |
| /** |
| * This method gets the Hash Mac Address. |
| * |
| * Hash Mac Address is the first 64 bits of the result of computing SHA-256 over factory-assigned |
| * IEEE EUI-64, which is used as IEEE 802.15.4 Extended Address during commissioning process. |
| * |
| * @param[out] aHashMacAddress A pointer to where the Hash Mac Address is placed. |
| * |
| */ |
| void GetHashMacAddress(ExtAddress *aHashMacAddress); |
| |
| /** |
| * This method returns the IEEE 802.15.4 Short Address. |
| * |
| * @returns The IEEE 802.15.4 Short Address. |
| * |
| */ |
| ShortAddress GetShortAddress(void) const { return mShortAddress; } |
| |
| /** |
| * This method sets the IEEE 802.15.4 Short Address. |
| * |
| * @param[in] aShortAddress The IEEE 802.15.4 Short Address. |
| * |
| * @retval OT_ERROR_NONE Successfully set the IEEE 802.15.4 Short Address. |
| * |
| */ |
| otError SetShortAddress(ShortAddress aShortAddress); |
| |
| /** |
| * This method returns the IEEE 802.15.4 Channel. |
| * |
| * @returns The IEEE 802.15.4 Channel. |
| * |
| */ |
| uint8_t GetChannel(void) const { return mChannel; } |
| |
| /** |
| * This method sets the IEEE 802.15.4 Channel. |
| * |
| * @param[in] aChannel The IEEE 802.15.4 Channel. |
| * |
| * @retval OT_ERROR_NONE Successfully set the IEEE 802.15.4 Channel. |
| * |
| */ |
| otError SetChannel(uint8_t aChannel); |
| |
| /** |
| * This method returns the maximum transmit power in dBm. |
| * |
| * @returns The maximum transmit power in dBm. |
| * |
| */ |
| int8_t GetMaxTransmitPower(void) const { return mMaxTransmitPower; } |
| |
| /** |
| * This method sets the maximum transmit power in dBm. |
| * |
| * @param[in] aPower The maximum transmit power in dBm. |
| * |
| */ |
| void SetMaxTransmitPower(int8_t aPower) { mMaxTransmitPower = aPower; } |
| |
| /** |
| * This method returns the IEEE 802.15.4 Network Name. |
| * |
| * @returns A pointer to the IEEE 802.15.4 Network Name. |
| * |
| */ |
| const char *GetNetworkName(void) const { return mNetworkName.m8; } |
| |
| /** |
| * This method sets the IEEE 802.15.4 Network Name. |
| * |
| * @param[in] aNetworkName A pointer to the IEEE 802.15.4 Network Name. |
| * |
| * @retval OT_ERROR_NONE Successfully set the IEEE 802.15.4 Network Name. |
| * |
| */ |
| otError SetNetworkName(const char *aNetworkName); |
| |
| /** |
| * This method returns the IEEE 802.15.4 PAN ID. |
| * |
| * @returns The IEEE 802.15.4 PAN ID. |
| * |
| */ |
| uint16_t GetPanId(void) const { return mPanId; } |
| |
| /** |
| * This method sets the IEEE 802.15.4 PAN ID. |
| * |
| * @param[in] aPanId The IEEE 802.15.4 PAN ID. |
| * |
| * @retval OT_ERROR_NONE Successfully set the IEEE 802.15.4 PAN ID. |
| * |
| */ |
| otError SetPanId(uint16_t aPanId); |
| |
| /** |
| * This method returns the IEEE 802.15.4 Extended PAN ID. |
| * |
| * @returns A pointer to the IEEE 802.15.4 Extended PAN ID. |
| * |
| */ |
| const uint8_t *GetExtendedPanId(void) const { return mExtendedPanId.m8; } |
| |
| /** |
| * This method sets the IEEE 802.15.4 Extended PAN ID. |
| * |
| * @param[in] aExtPanId The IEEE 802.15.4 Extended PAN ID. |
| * |
| * @retval OT_ERROR_NONE Successfully set the IEEE 802.15.4 Extended PAN ID. |
| * |
| */ |
| otError SetExtendedPanId(const uint8_t *aExtPanId); |
| |
| /** |
| * This method returns the MAC whitelist filter. |
| * |
| * @returns A reference to the MAC whitelist filter. |
| * |
| */ |
| Whitelist &GetWhitelist(void) { return mWhitelist; } |
| |
| /** |
| * This method returns the MAC blacklist filter. |
| * |
| * @returns A reference to the MAC blacklist filter. |
| * |
| */ |
| Blacklist &GetBlacklist(void) { return mBlacklist; } |
| |
| /** |
| * This method is called to handle receive events. |
| * |
| * @param[in] aFrame A pointer to the received frame, or NULL if the receive operation aborted. |
| * @param[in] aError OT_ERROR_NONE when successfully received a frame, OT_ERROR_ABORT when reception |
| * was aborted and a frame was not received. |
| * |
| */ |
| void ReceiveDoneTask(Frame *aFrame, otError aError); |
| |
| #if OPENTHREAD_CONFIG_LEGACY_TRANSMIT_DONE |
| /** |
| * This method is called to handle transmit events. |
| * |
| * @param[in] aFrame A pointer to the frame that was transmitted. |
| * @param[in] aFramePending TRUE if an ACK frame was received and the Frame Pending bit was set. |
| * @param[in] aError OT_ERROR_NONE when the frame was transmitted, OT_ERROR_NO_ACK when the frame was |
| * transmitted but no ACK was received, OT_ERROR_CHANNEL_ACCESS_FAILURE when the |
| * transmission could not take place due to activity on the channel, OT_ERROR_ABORT when |
| * transmission was aborted for other reasons. |
| * |
| */ |
| void TransmitDoneTask(otRadioFrame *aFrame, bool aRxPending, otError aError); |
| |
| #else // #if OPENTHREAD_CONFIG_LEGACY_TRANSMIT_DONE |
| /** |
| * This method is called to handle transmit events. |
| * |
| * @param[in] aFrame A pointer to the frame that was transmitted. |
| * @param[in] aAckFrame A pointer to the ACK frame, NULL if no ACK was received. |
| * @param[in] aError OT_ERROR_NONE when the frame was transmitted, OT_ERROR_NO_ACK when the frame was |
| * transmitted but no ACK was received, OT_ERROR_CHANNEL_ACCESS_FAILURE when the |
| * transmission could not take place due to activity on the channel, OT_ERROR_ABORT when |
| * transmission was aborted for other reasons. |
| * |
| */ |
| void TransmitDoneTask(otRadioFrame *aFrame, otRadioFrame *aAckFrame, otError aError); |
| #endif // OPENTHREAD_CONFIG_LEGACY_TRANSMIT_DONE |
| |
| /** |
| * This method returns if an active scan is in progress. |
| * |
| */ |
| bool IsActiveScanInProgress(void); |
| |
| /** |
| * This method returns if an energy scan is in progress. |
| * |
| */ |
| bool IsEnergyScanInProgress(void); |
| |
| /** |
| * This method returns if the MAC layer is in transmit state. |
| * |
| * The MAC layer is in transmit state during CSMA/CA, CCA, transmission of Data, Beacon or Data Request frames and |
| * receiving of ACK frames. The MAC layer is not in transmit state during transmission of ACK frames or Beacon |
| * Requests. |
| * |
| */ |
| bool IsInTransmitState(void); |
| |
| /** |
| * This method registers a callback to provide received raw IEEE 802.15.4 frames. |
| * |
| * @param[in] aPcapCallback A pointer to a function that is called when receiving an IEEE 802.15.4 link frame or |
| * NULL to disable the callback. |
| * @param[in] aCallbackContext A pointer to application-specific context. |
| * |
| */ |
| void SetPcapCallback(otLinkPcapCallback aPcapCallback, void *aCallbackContext); |
| |
| /** |
| * This method indicates whether or not promiscuous mode is enabled at the link layer. |
| * |
| * @retval true Promiscuous mode is enabled. |
| * @retval false Promiscuous mode is not enabled. |
| * |
| */ |
| bool IsPromiscuous(void); |
| |
| /** |
| * This method enables or disables the link layer promiscuous mode. |
| * |
| * Promiscuous mode keeps the receiver enabled, overriding the value of mRxOnWhenIdle. |
| * |
| * @param[in] aPromiscuous true to enable promiscuous mode, or false otherwise. |
| * |
| */ |
| void SetPromiscuous(bool aPromiscuous); |
| |
| /** |
| * This method fills network diagnostic MacCounterTlv. |
| * |
| * @param[in] aMacCountersTlv The reference to the network diagnostic MacCounterTlv. |
| * |
| */ |
| void FillMacCountersTlv(NetworkDiagnostic::MacCountersTlv &aMacCounters) const; |
| |
| /** |
| * This method resets mac counters |
| * |
| */ |
| void ResetCounters(void); |
| |
| #if OPENTHREAD_CONFIG_ENABLE_BEACON_RSP_IF_JOINABLE |
| /** |
| * This method indicates if the beacon is joinable or non-joinable |
| * |
| * @retval true Beacon is joinable. |
| * @retval false Beacon is non-joinable. |
| * |
| */ |
| bool IsBeaconJoinable(void); |
| #endif // OPENTHREAD_CONFIG_ENABLE_BEACON_RSP_IF_JOINABLE |
| |
| /** |
| * This method returns the MAC counter. |
| * |
| * @returns A reference to the MAC counter. |
| * |
| */ |
| otMacCounters &GetCounters(void) { return mCounters; } |
| |
| /** |
| * This method returns the noise floor value (currently use the radio receive sensitivity value). |
| * |
| * @returns The noise floor value in dBm. |
| * |
| */ |
| int8_t GetNoiseFloor(void) { return otPlatRadioGetReceiveSensitivity(GetInstance()); } |
| |
| /** |
| * This method indicates whether or not CSMA backoff is supported by the radio layer. |
| * |
| * @retval true CSMA backoff is supported by the radio. |
| * @retval false CSMA backoff is not supported by the radio. |
| * |
| */ |
| bool RadioSupportsCsmaBackoff(void); |
| |
| /** |
| * This method indicates whether or not transmit retries is supported by the radio layer. |
| * |
| * @retval true Retries (and CSMA) are supported by the radio. |
| * @retval false Retries (and CSMA) are not supported by the radio. |
| * |
| */ |
| bool RadioSupportsRetries(void); |
| |
| private: |
| enum ScanType |
| { |
| kScanTypeNone = 0, |
| kScanTypeActive, |
| kScanTypeEnergy, |
| }; |
| |
| enum |
| { |
| kInvalidRssiValue = 127 |
| }; |
| |
| void GenerateNonce(const ExtAddress &aAddress, uint32_t aFrameCounter, uint8_t aSecurityLevel, uint8_t *aNonce); |
| void ProcessTransmitSecurity(Frame &aFrame); |
| otError ProcessReceiveSecurity(Frame &aFrame, const Address &aSrcAddr, Neighbor *aNeighbor); |
| void PutRadioInIdleMode(void); |
| void StartOperation(void); |
| void FinishOperation(void); |
| void SentFrame(otError aError); |
| void SendBeaconRequest(Frame &aFrame); |
| void SendBeacon(Frame &aFrame); |
| void StartBackoff(void); |
| void StartEnergyScan(void); |
| otError HandleMacCommand(Frame &aFrame); |
| |
| static void HandleMacTimer(Timer &aTimer); |
| void HandleMacTimer(void); |
| static void HandleBeginTransmit(void *aContext); |
| static void HandleBeginTransmit(Timer &aTimer); |
| void HandleBeginTransmit(void); |
| static void HandleReceiveTimer(Timer &aTimer); |
| void HandleReceiveTimer(void); |
| static void HandleEnergyScanSampleRssi(Tasklet &aTasklet); |
| void HandleEnergyScanSampleRssi(void); |
| |
| void StartCsmaBackoff(void); |
| otError Scan(ScanType aType, uint32_t aScanChannels, uint16_t aScanDuration, void *aContext); |
| |
| otError RadioTransmit(Frame *aSendFrame); |
| otError RadioReceive(uint8_t aChannel); |
| void RadioSleep(void); |
| |
| static Mac &GetOwner(const Context &aContext); |
| |
| Timer mMacTimer; |
| #if !OPENTHREAD_CONFIG_ENABLE_PLATFORM_USEC_BACKOFF_TIMER |
| Timer mBackoffTimer; |
| #endif |
| Timer mReceiveTimer; |
| |
| ExtAddress mExtAddress; |
| ShortAddress mShortAddress; |
| PanId mPanId; |
| uint8_t mChannel; |
| int8_t mMaxTransmitPower; |
| |
| otNetworkName mNetworkName; |
| otExtendedPanId mExtendedPanId; |
| |
| Sender *mSendHead, *mSendTail; |
| Receiver *mReceiveHead, *mReceiveTail; |
| |
| enum |
| { |
| kOperationNone = 0, |
| kOperationActiveScan, |
| kOperationEnergyScan, |
| kOperationTransmitBeacon, |
| kOperationTransmitData, |
| }; |
| uint8_t mOperation; |
| |
| uint8_t mBeaconSequence; |
| uint8_t mDataSequence; |
| bool mRxOnWhenIdle; |
| uint8_t mCsmaAttempts; |
| uint8_t mTransmitAttempts; |
| bool mTransmitBeacon; |
| bool mBeaconsEnabled; |
| |
| ScanType mPendingScanRequest; |
| uint8_t mScanChannel; |
| uint32_t mScanChannels; |
| uint16_t mScanDuration; |
| void *mScanContext; |
| union |
| { |
| ActiveScanHandler mActiveScanHandler; |
| EnergyScanHandler mEnergyScanHandler; |
| }; |
| int8_t mEnergyScanCurrentMaxRssi; |
| Tasklet mEnergyScanSampleRssiTask; |
| |
| otLinkPcapCallback mPcapCallback; |
| void *mPcapCallbackContext; |
| |
| Whitelist mWhitelist; |
| Blacklist mBlacklist; |
| |
| Frame *mTxFrame; |
| |
| otMacCounters mCounters; |
| uint32_t mKeyIdMode2FrameCounter; |
| |
| #if OPENTHREAD_CONFIG_STAY_AWAKE_BETWEEN_FRAGMENTS |
| bool mDelaySleep; |
| #endif |
| bool mWaitingForData; |
| }; |
| |
| /** |
| * @} |
| * |
| */ |
| |
| } // namespace Mac |
| } // namespace ot |
| |
| #endif // MAC_HPP_ |
