Google is committed to advancing racial equity for Black communities. See how.

otRadioFrame

#include <radio.h>

This structure represents an IEEE 802.15.4 radio frame.

Summary

Public attributes

mAckFrameCounter
uint32_t
ACK security frame counter (applicable when mAckedWithSecEnhAck is set).
mAckKeyId
uint8_t
ACK security key index (applicable when mAckedWithSecEnhAck is set).
mAckedWithFramePending
bool
This indicates if this frame was acknowledged with frame pending set.
mAckedWithSecEnhAck
bool
This indicates if this frame was acknowledged with secured enhance ACK.
mAesKey
const otMacKey *
The key used for AES-CCM frame security.
mChannel
uint8_t
Channel used to transmit/receive the frame.
mCslPresent
bool
Set to true if CSL header IE is present.
mCsmaCaEnabled
bool
Set to true to enable CSMA-CA for this packet, false otherwise.
mIeInfo
The pointer to the Header IE(s) related information.
mInfo
union otRadioFrame::@14
The union of transmit and receive information for a radio frame.
mIsARetx
bool
Indicates whether the frame is a retransmission or not.
mIsSecurityProcessed
bool
True if SubMac should skip the AES processing of this frame.
mLength
uint16_t
Length of the PSDU.
mLqi
uint8_t
Link Quality Indicator for received frames.
mMaxCsmaBackoffs
uint8_t
Maximum number of backoffs attempts before declaring CCA failure.
mMaxFrameRetries
uint8_t
Maximum number of retries allowed after a transmission failure.
mPsdu
uint8_t *
The PSDU.
mRadioType
uint8_t
Radio link type - should be ignored by radio driver.
mRssi
int8_t
Received signal strength indicator in dBm for received frames.
mRxInfo
struct otRadioFrame::@14::@16
Structure representing radio frame receive information.
mTimestamp
uint64_t
The timestamp when the frame was received in microseconds.
mTxDelay
uint32_t
The delay time for this transmission (based on mTxDelayBaseTime).
mTxDelayBaseTime
uint32_t
The base time for the transmission delay.
mTxInfo
struct otRadioFrame::@14::@15
Structure representing radio frame transmit information.

Public attributes

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.

mAesKey

const otMacKey * otRadioFrame::mAesKey

The key used for AES-CCM frame security.

mChannel

uint8_t otRadioFrame::mChannel

Channel used to transmit/receive the frame.

mCslPresent

bool otRadioFrame::mCslPresent

Set to true if CSL header IE is present.

mCsmaCaEnabled

bool otRadioFrame::mCsmaCaEnabled

Set to true to enable CSMA-CA for this packet, false otherwise.

mIeInfo

otRadioIeInfo * otRadioFrame::mIeInfo

The pointer to the Header IE(s) related information.

mInfo

union otRadioFrame::@14 otRadioFrame::mInfo

The union of transmit and receive information for a radio frame.

mIsARetx

bool otRadioFrame::mIsARetx

Indicates whether the frame is a retransmission or not.

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 mIsARetx is set, it indicates that OpenThread core has already set the frame counter and key id (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 mIsARetx is not set, then the frame counter and key id are not set in the frame by OpenThread core and it is the responsibility of the radio platform to assign them. The platform should update the frame (assign counter and key id) even if the transmission gets aborted or fails (e.g., channel access error).

mIsSecurityProcessed

bool otRadioFrame::mIsSecurityProcessed

True if SubMac should skip the AES processing of this frame.

mLength

uint16_t otRadioFrame::mLength

Length of the PSDU.

mLqi

uint8_t otRadioFrame::mLqi

Link Quality Indicator for received frames.

mMaxCsmaBackoffs

uint8_t otRadioFrame::mMaxCsmaBackoffs

Maximum number of backoffs attempts before declaring CCA failure.

mMaxFrameRetries

uint8_t otRadioFrame::mMaxFrameRetries

Maximum number of retries allowed after a transmission failure.

mPsdu

uint8_t * otRadioFrame::mPsdu

The PSDU.

mRadioType

uint8_t otRadioFrame::mRadioType

Radio link type - should be ignored by radio driver.

mRssi

int8_t otRadioFrame::mRssi

Received signal strength indicator in dBm for received frames.

mRxInfo

struct otRadioFrame::@14::@16 otRadioFrame::mRxInfo

Structure representing radio frame receive information.

mTimestamp

uint64_t otRadioFrame::mTimestamp

The timestamp when the frame was received in microseconds.

The value SHALL be the time when the SFD was received when TIME_SYNC or CSL is enabled. Otherwise, the time when the MAC frame was fully received is also acceptable.

mTxDelay

uint32_t otRadioFrame::mTxDelay

The delay time for this transmission (based on mTxDelayBaseTime).

mTxDelayBaseTime

uint32_t otRadioFrame::mTxDelayBaseTime

The base time for the transmission delay.

mTxInfo

struct otRadioFrame::@14::@15 otRadioFrame::mTxInfo

Structure representing radio frame transmit information.