espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-09-14 13:10:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

[radio] update docs on frame counter when RADIO_CAPS_TRANSMIT_SEC (#6448)

Browse Source 
This commit updates documentations in `radio.h` and adds more detail
on expected behavior on assigning of the frame counter (on retx or
first attempt frame) when radio provides `OT_RADIO_CAPS_TRANSMIT_SEC`
capability (i.e., radio platform layer handles the tx security and
frame counter management).
This commit is contained in:
Abtin Keshavarzian
2021-04-15 09:12:26 -07:00
committed by GitHub
parent 559f9c8d56
commit 4448b7b426
2 changed files with 30 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/openthread/instance.h
+1 -1
View File
@@ -53,7 +53,7 @@ extern "C" {
* @note This number versions both OpenThread platform and user APIs.
*
*/
#define OPENTHREAD_API_VERSION (100)
#define OPENTHREAD_API_VERSION (101)
/**
* @addtogroup api-instance
include/openthread/platform/radio.h
+29 -10
View File
@@ -230,16 +230,35 @@ typedef struct otRadioFrame
*/
struct
{
const otMacKey *mAesKey; ///< The key used for AES-CCM frame security.
otRadioIeInfo * mIeInfo; ///< The pointer to the Header IE(s) related information.
uint32_t mTxDelay; ///< The delay time for this transmission (based on `mTxDelayBaseTime`).
uint32_t mTxDelayBaseTime; ///< The base time for the transmission delay.
uint8_t mMaxCsmaBackoffs; ///< Maximum number of backoffs attempts before declaring CCA failure.
uint8_t mMaxFrameRetries; ///< Maximum number of retries allowed after a transmission failure.
bool mIsARetx : 1; ///< True if this frame is a retransmission (ignored by radio driver).
bool mCsmaCaEnabled : 1; ///< Set to true to enable CSMA-CA for this packet, false otherwise.
bool mCslPresent : 1; ///< Set to true if CSL header IE is present.
bool mIsSecurityProcessed : 1; ///< True if SubMac should skip the AES processing of this frame.
const otMacKey *mAesKey; ///< The key used for AES-CCM frame security.
otRadioIeInfo * mIeInfo; ///< The pointer to the Header IE(s) related information.
uint32_t mTxDelay; ///< The delay time for this transmission (based on `mTxDelayBaseTime`).
uint32_t mTxDelayBaseTime; ///< The base time for the transmission delay.
uint8_t mMaxCsmaBackoffs; ///< Maximum number of backoffs attempts before declaring CCA failure.
uint8_t mMaxFrameRetries; ///< Maximum number of retries allowed after a transmission failure.
/**
* 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).
*
*/
bool mIsARetx : 1;
bool mCsmaCaEnabled : 1; ///< Set to true to enable CSMA-CA for this packet, false otherwise.
bool mCslPresent : 1; ///< Set to true if CSL header IE is present.
bool mIsSecurityProcessed : 1; ///< True if SubMac should skip the AES processing of this frame.
} mTxInfo;
/**