Represents an IEEE 802.15.4 radio frame.
Public Attributes#
The PSDU.
Length of the PSDU.
Channel used to transmit/receive the frame.
Radio link type - should be ignored by radio driver.
The key material used for AES-CCM frame security.
The pointer to the Header IE(s) related information.
The base time in microseconds for scheduled transmissions relative to the local radio clock, see otPlatRadioGetNow and mTxDelay.
The delay time in microseconds for this transmission referenced to mTxDelayBaseTime.
Maximum number of CSMA backoff attempts before declaring channel access failure.
Maximum number of retries allowed after a transmission failure.
The RX channel after frame TX is done (after all frame retries - ack received, or timeout, or abort).
The transmit power in dBm.
Indicates whether frame counter and CSL IEs are properly updated in the header.
Indicates whether the frame is a retransmission or not.
Set to true to enable CSMA-CA for this packet, false to disable both CSMA backoff and CCA.
Set to true if CSL header IE is present.
True if SubMac should skip the AES processing of this frame.
The time of the local radio clock in microseconds when the end of the SFD was present at the local antenna.
Structure representing radio frame transmit information.
ACK security frame counter (applicable when mAckedWithSecEnhAck is set).
ACK security key index (applicable when mAckedWithSecEnhAck is set).
Received signal strength indicator in dBm for received frames.
Link Quality Indicator for received frames.
This indicates if this frame was acknowledged with frame pending set.
This indicates if this frame was acknowledged with secured enhance ACK.
Structure representing radio frame receive information.
The union of transmit and receive information for a radio frame.
Public Attribute Documentation#
mAesKey#
const otMacKeyMaterial* otRadioFrame::mAesKey
The key material used for AES-CCM frame security.
mTxDelayBaseTime#
uint32_t otRadioFrame::mTxDelayBaseTime
The base time in microseconds for scheduled transmissions relative to the local radio clock, see otPlatRadioGetNow and mTxDelay.
If this field is non-zero, mMaxCsmaBackoffs should be ignored.
This field does not affect CCA behavior which is controlled by mCsmaCaEnabled.
mTxDelay#
uint32_t otRadioFrame::mTxDelay
The delay time in microseconds for this transmission referenced to mTxDelayBaseTime.
Note: mTxDelayBaseTime + mTxDelay SHALL point to the point in time when the end of the SFD will be present at the local antenna, relative to the local radio clock.
If this field is non-zero, mMaxCsmaBackoffs should be ignored.
This field does not affect CCA behavior which is controlled by mCsmaCaEnabled.
mMaxCsmaBackoffs#
uint8_t otRadioFrame::mMaxCsmaBackoffs
Maximum number of CSMA backoff attempts before declaring channel access failure.
This is applicable and MUST be used when radio platform provides the OT_RADIO_CAPS_CSMA_BACKOFF and/or OT_RADIO_CAPS_TRANSMIT_RETRIES.
This field MUST be ignored if mCsmaCaEnabled is set to false (CCA is disabled) or either mTxDelayBaseTime or mTxDelay is non-zero (frame transmission is expected at a specific time).
It can be set to 0 to skip backoff mechanism (note that CCA MUST still be performed assuming mCsmaCaEnabled is true).
mMaxFrameRetries#
uint8_t otRadioFrame::mMaxFrameRetries
Maximum number of retries allowed after a transmission failure.
mRxChannelAfterTxDone#
uint8_t otRadioFrame::mRxChannelAfterTxDone
The RX channel after frame TX is done (after all frame retries - ack received, or timeout, or abort).
Radio platforms can choose to fully ignore this. OT stack will make sure to call otPlatRadioReceive() with the desired RX channel after a frame TX is done and signaled in otPlatRadioTxDone() callback. Radio platforms that don't provide OT_RADIO_CAPS_TRANSMIT_RETRIES must always ignore this.
This is intended for situations where there may be delay in interactions between OT stack and radio, as an example this is used in RCP/host architecture to make sure RCP switches to PAN channel more quickly. In particular, this can help with CSL tx to a sleepy child, where the child may use a different channel for CSL than the PAN channel. After frame tx, we want the radio/RCP to go back to the PAN channel quickly to ensure that parent does not miss tx from child afterwards, e.g., child responding to the earlier CSL transmitted frame from parent using PAN channel while radio still staying on CSL channel.
The switch to the RX channel MUST happen after the frame TX is fully done, i.e., after all retries and when ack is received (when "Ack Request" flag is set on the TX frame) or ack timeout. Note that ack is expected on the same channel that frame is sent on.
mTxPower#
int8_t otRadioFrame::mTxPower
The transmit power in dBm.
If the platform layer does not provide OT_RADIO_CAPS_TRANSMIT_FRAME_POWER capability, it can ignore this value.
If the value is OT_RADIO_POWER_INVALID, then the platform should ignore this value and transmit the frame with its default transmit power.
Otherwise, the platform should transmit this frame with the maximum power no larger than minimal of the following values:
mTxPower,
The power limit set by otPlatRadioSetChannelTargetPower(),
The power limit set by otPlatRadioSetChannelMaxTransmitPower(),
The power limit set by otPlatRadioSetRegion().
mIsHeaderUpdated#
bool otRadioFrame::mIsHeaderUpdated
Indicates whether frame counter and CSL IEs are properly updated in the header.
If the platform layer does not provide OT_RADIO_CAPS_TRANSMIT_SEC capability, it can ignore this flag.
If the platform provides OT_RADIO_CAPS_TRANSMIT_SEC capability, then platform is expected to handle tx security processing and assignment of frame counter. In this case the following behavior is expected:
When mIsHeaderUpdated is set, it indicates that OpenThread core has already set the frame counter and CSL IEs (if security is enabled) in the prepared frame. The counter is ensured to match the counter value from the previous attempts of the same frame. The platform should not assign or change the frame counter (but may still need to perform security processing depending on mIsSecurityProcessed flag).
If mIsHeaderUpdated is not set, then the frame counter and key CSL IE not set in the frame by OpenThread core and it is the responsibility of the radio platform to assign them. The platform must update the frame header (assign counter and CSL IE values) before sending the frame over the air, however if the the transmission gets aborted and the frame is never sent over the air (e.g., channel access error) the platform may choose to not update the header. If the platform updates the header, it must also set this flag before passing the frame back from the otPlatRadioTxDone() callback.
mCsmaCaEnabled#
bool otRadioFrame::mCsmaCaEnabled
Set to true to enable CSMA-CA for this packet, false to disable both CSMA backoff and CCA.
When it is set to false, the frame MUST be sent without performing CCA. In this case mMaxCsmaBackoffs MUST also be ignored.
mIsSecurityProcessed#
bool otRadioFrame::mIsSecurityProcessed
True if SubMac should skip the AES processing of this frame.
mTimestamp#
uint64_t otRadioFrame::mTimestamp
The time of the local radio clock in microseconds when the end of the SFD was present at the local antenna.
The platform should update this field before otPlatRadioTxStarted() is fired for each transmit attempt.
mTxInfo#
struct otRadioFrame::@17::@18 otRadioFrame::mTxInfo
Structure representing radio frame transmit information.
mAckFrameCounter#
uint32_t otRadioFrame::mAckFrameCounter
ACK security frame counter (applicable when mAckedWithSecEnhAck is set).
mAckKeyId#
uint8_t otRadioFrame::mAckKeyId
ACK security key index (applicable when mAckedWithSecEnhAck is set).
mAckedWithFramePending#
bool otRadioFrame::mAckedWithFramePending
This indicates if this frame was acknowledged with frame pending set.
mAckedWithSecEnhAck#
bool otRadioFrame::mAckedWithSecEnhAck
This indicates if this frame was acknowledged with secured enhance ACK.
mRxInfo#
struct otRadioFrame::@17::@19 otRadioFrame::mRxInfo
Structure representing radio frame receive information.
mInfo#
union otRadioFrame::@17 otRadioFrame::mInfo
The union of transmit and receive information for a radio frame.