Symbols ![]()
loading...
Files ![]()
loading...
otRadioFrame struct
Represents an IEEE 802.15.4 radio frame.
Syntax
typedef struct otRadioFrame
{
uint8_t *mPsdu;
uint16_t mLength;
uint8_t mChannel;
uint8_t mRadioType;
union
{
struct
{
const otMacKeyMaterial *mAesKey;
otRadioIeInfo *mIeInfo;
uint32_t mTxDelayBaseTime;
uint32_t mTxDelay;
uint8_t mMaxCsmaBackoffs;
uint8_t mMaxFrameRetries;
uint8_t mRxChannelAfterTxDone;
int8_t mTxPower;
bool mIsHeaderUpdated : 1;
bool mIsARetx : 1;
bool mCsmaCaEnabled : 1;
bool mCslPresent : 1;
bool mIsSecurityProcessed : 1;
uint64_t mTimestamp;
} mTxInfo;
struct
{
uint64_t mTimestamp;
uint32_t mAckFrameCounter;
uint8_t mAckKeyId;
int8_t mRssi;
uint8_t mLqi;
bool mAckedWithFramePending : 1;
bool mAckedWithSecEnhAck : 1;
} mRxInfo;
} mInfo;
} otRadioFrame;
Fields
Field
Declared as
Description
uint8_t *
uint16_t
uint8_t
uint8_t
union
{
struct
{
const otMacKeyMaterial *mAesKey;
otRadioIeInfo *mIeInfo;
uint32_t mTxDelayBaseTime;
uint32_t mTxDelay;
uint8_t mMaxCsmaBackoffs;
uint8_t mMaxFrameRetries;
uint8_t mRxChannelAfterTxDone;
int8_t mTxPower;
bool mIsHeaderUpdated : 1;
bool mIsARetx : 1;
bool mCsmaCaEnabled : 1;
bool mCslPresent : 1;
bool mIsSecurityProcessed : 1;
uint64_t mTimestamp;
} mTxInfo;
struct
{
uint64_t mTimestamp;
uint32_t mAckFrameCounter;
uint8_t mAckKeyId;
int8_t mRssi;
uint8_t mLqi;
bool mAckedWithFramePending : 1;
bool mAckedWithSecEnhAck : 1;
} mRxInfo;
}
The union of transmit and receive information for a radio frame.
Related Functions
Found 43 other functions taking a otRadioFrame
argument:
Function
Description
Switches the radio state from Receive to Transmit.
The radio driver calls this method to notify OpenThread that the transmission has started.
The radio driver calls this function to notify OpenThread that the transmit operation has completed, providing both the transmitted frame and, if applicable, the received ack frame. When radio provides `OT_RADIO_CAPS_TRANSMIT_SEC` capability, radio platform layer updates @p aFrame with the security frame counter and key index values maintained by the radio.
The radio driver calls this method to notify OpenThread diagnostics module that the transmission has completed. Is used when diagnostics is enabled.
The radio driver calls this method to notify OpenThread of a received frame.
The radio driver calls this method to notify OpenThread diagnostics module of a received frame. Is used when diagnostics is enabled.
Begin the transmit sequence on the radio. The caller must form the IEEE 802.15.4 frame in the buffer provided by `otPlatRadioGetTransmitBuffer()` before requesting transmission. The channel and transmit power are also included in the otRadioFrame structure. The transmit sequence consists of: 1. Transitioning the radio to Transmit from one of the following states: - Receive if RX is on when the device is idle or OT_RADIO_CAPS_SLEEP_TO_TX is not supported - Sleep if RX is off when the device is idle and OT_RADIO_CAPS_SLEEP_TO_TX is supported. 2. Transmits the psdu on the given channel and at the given transmit power.
Performs AES CCM on the frame which is going to be sent.
Check if @p aFrame is an Ack frame.
Set key ID to @p aFrame with key ID mode 1.
Set frame counter to @p aFrame.
Tell if the security of @p aFrame is enabled.
Tell if the key ID mode of @p aFrame is 1.
Get the key ID of @p aFrame.
Process frame tx security.
Processes the received radio frame.
The radio driver calls this method to notify OpenThread diagnostics module of a received frame.
Check if @p aFrame matches the @p aPandId and @p aShortAddress or @p aExtAddress.
Get source MAC address.
Get destination MAC address.
Get the sequence of @p aFrame.
Tell if the version of @p aFrame is 2015.
Check if @p aFrame is a Data frame.
Check if @p aFrame is a Command frame.
Check if @p aFrame is a Data Request Command.
Check if @p aFrame requests ACK.
Get the frame counter of @p aFrame.
Generate Imm-Ack for @p aFrame.
Generate Enh-Ack for @p aFrame.
Perform processing of SFD callback from ISR. This function may do multiple tasks as follows. - CSL IE will be populated (if present) - Time IE will be populated (if present) - Tx timestamp will be populated - Tx security will be performed (including assignment of security frame counter and key id if not assigned)
Sets the data value of Enh-ACK Probing IE (Vendor IE with THREAD OUI) in a frame. If no Enh-ACK Probing IE is found in @p aFrame, nothing would be done.
Set CSL IE content into the frame.