Symbols ![]()
loading...
Files ![]()
loading...
ot::Mac::TxFrame class
Supports IEEE 802.15.4 MAC frame generation for transmission.
Syntax
class TxFrame : public Frame
{
public:
struct Info : public Clearable<Info>
{
Info(void) { Clear(); }
void PrepareHeadersIn(TxFrame &aTxFrame) const;
Type mType;
Version mVersion;
Addresses mAddrs;
PanIds mPanIds;
SecurityLevel mSecurityLevel;
KeyIdMode mKeyIdMode;
CommandId mCommandId;
bool mSuppressSequence : 1;
#if OPENTHREAD_CONFIG_MAC_HEADER_IE_SUPPORT
#if OPENTHREAD_CONFIG_TIME_SYNC_ENABLE
bool mAppendTimeIe : 1;
#endif
#if OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE
bool mAppendCslIe : 1;
#endif
bool mEmptyPayload : 1;
#endif
};
void SetChannel(uint8_t aChannel)
{
mChannel = aChannel;
SetRxChannelAfterTxDone(aChannel);
}
void SetTxPower(int8_t aTxPower) { mInfo.mTxInfo.mTxPower = aTxPower; }
uint8_t GetRxChannelAfterTxDone(void) const { return mInfo.mTxInfo.mRxChannelAfterTxDone; }
void SetRxChannelAfterTxDone(uint8_t aChannel) { mInfo.mTxInfo.mRxChannelAfterTxDone = aChannel; }
uint8_t GetMaxCsmaBackoffs(void) const { return mInfo.mTxInfo.mMaxCsmaBackoffs; }
void SetMaxCsmaBackoffs(uint8_t aMaxCsmaBackoffs) { mInfo.mTxInfo.mMaxCsmaBackoffs = aMaxCsmaBackoffs; }
uint8_t GetMaxFrameRetries(void) const { return mInfo.mTxInfo.mMaxFrameRetries; }
void SetMaxFrameRetries(uint8_t aMaxFrameRetries) { mInfo.mTxInfo.mMaxFrameRetries = aMaxFrameRetries; }
bool IsARetransmission(void) const { return mInfo.mTxInfo.mIsARetx; }
void SetIsARetransmission(bool aIsARetx) { mInfo.mTxInfo.mIsARetx = aIsARetx; }
bool IsCsmaCaEnabled(void) const { return mInfo.mTxInfo.mCsmaCaEnabled; }
void SetCsmaCaEnabled(bool aCsmaCaEnabled) { mInfo.mTxInfo.mCsmaCaEnabled = aCsmaCaEnabled; }
const Mac::KeyMaterial &GetAesKey(void) const
{
return *static_cast<const Mac::KeyMaterial *>(mInfo.mTxInfo.mAesKey);
}
void SetAesKey(const Mac::KeyMaterial &aAesKey) { mInfo.mTxInfo.mAesKey = &aAesKey; }
void CopyFrom(const TxFrame &aFromFrame);
void ProcessTransmitAesCcm(const ExtAddress &aExtAddress);
bool IsSecurityProcessed(void) const { return mInfo.mTxInfo.mIsSecurityProcessed; }
void SetIsSecurityProcessed(bool aIsSecurityProcessed)
{
mInfo.mTxInfo.mIsSecurityProcessed = aIsSecurityProcessed;
}
bool IsCslIePresent(void) const { return mInfo.mTxInfo.mCslPresent; }
void SetCslIePresent(bool aCslPresent) { mInfo.mTxInfo.mCslPresent = aCslPresent; }
bool IsHeaderUpdated(void) const { return mInfo.mTxInfo.mIsHeaderUpdated; }
void SetIsHeaderUpdated(bool aIsHeaderUpdated) { mInfo.mTxInfo.mIsHeaderUpdated = aIsHeaderUpdated; }
#if OPENTHREAD_CONFIG_TIME_SYNC_ENABLE
void SetTimeIeOffset(uint8_t aOffset) { mInfo.mTxInfo.mIeInfo->mTimeIeOffset = aOffset; }
uint8_t GetTimeIeOffset(void) const { return mInfo.mTxInfo.mIeInfo->mTimeIeOffset; }
void SetNetworkTimeOffset(int64_t aNetworkTimeOffset)
{
mInfo.mTxInfo.mIeInfo->mNetworkTimeOffset = aNetworkTimeOffset;
}
void SetTimeSyncSeq(uint8_t aTimeSyncSeq) { mInfo.mTxInfo.mIeInfo->mTimeSyncSeq = aTimeSyncSeq; }
#endif
void GenerateImmAck(const RxFrame &aFrame, bool aIsFramePending);
Error GenerateEnhAck(const RxFrame &aRxFrame, bool aIsFramePending, const uint8_t *aIeData, uint8_t aIeLength);
#if OPENTHREAD_CONFIG_WAKEUP_COORDINATOR_ENABLE
Error GenerateWakeupFrame(PanId aPanId, const Address &aDest, const Address &aSource);
#endif
#if OPENTHREAD_CONFIG_THREAD_VERSION >= OT_THREAD_VERSION_1_2
void SetTxDelay(uint32_t aTxDelay) { mInfo.mTxInfo.mTxDelay = aTxDelay; }
void SetTxDelayBaseTime(uint32_t aTxDelayBaseTime) { mInfo.mTxInfo.mTxDelayBaseTime = aTxDelayBaseTime; }
#endif
};
Related Functions
Found 39 other functions taking a TxFrame
argument:
Function
Description
Prepares MAC headers based on `Info` fields in a given `TxFrame`. This method uses the `Info` structure to construct the MAC address and security headers in @p aTxFrame. It determines the Frame Control Field (FCF), including setting the appropriate frame type, security level, and addressing mode flags. It populates the source and destination addresses and PAN IDs within the MAC header based on the information provided in the `Info` structure. It sets the Ack Request bit in the FCF if the following criteria are met: - A destination address is present - The destination address is not the broadcast address - The frame type is not an ACK frame The header IE entries are prepared based on `mAppendTimeIe` and `mAppendCslIe` flags and the IE Present flag in FCF is determined accordingly. The Frame Pending flag in FCF is not set. It may need to be set separately depending on the specific requirements of the frame being transmitted.
Notifies user of `SubMac` of the status of a frame transmission attempt. This is intended for updating counters, logging, and/or collecting statistics.
The method notifies user of `SubMac` that the transmit operation has completed, providing, if applicable, the received ACK frame.
This callback method requests a frame to be prepared for CSL transmission to a given SSED.
This callback method notifies the end of CSL frame transmission to a child.
This callback method requests a frame to be prepared for indirect transmission to a given sleepy child.
This callback method notifies the end of indirect frame transmission to a child.
Starts the transmit sequence on the radio. The caller must form the IEEE 802.15.4 frame in the buffer provided by `GetTransmitBuffer()` before requesting transmission. The channel and transmit power are also included in the frame.
Is called to handle transmit events.
Informs the data poll sender of success/error status of a previously requested poll frame transmission. In case of transmit failure, the data poll sender may choose to send the next data poll more quickly (up to some fixed number of attempts).
Informs the data poll sender to process a transmitted MAC frame.
Copies the PSDU and all attributes (except for frame link type) from another frame.
This callback method handles a "Transmit Started" event from radio platform.
This callback method handles a "Transmit Done" event from radio platform.
This callback method handles a "Transmit Done" event from radio platform when diagnostics mode is enabled.
Records the status of a frame transmission attempt, updating MAC counters. Unlike `HandleTransmitDone` which is called after all transmission attempts of frame to indicate final status of a frame transmission request, this method is invoked on all frame transmission attempts.
Invokes the mTransmitDoneCallback, if set.
Sets the current MAC frame counter value from the value from a `TxFrame`.