mirror of
https://github.com/espressif/openthread.git
synced 2026-07-30 07:37:46 +00:00
[radio] update otPlatRadioSetRxOnWhenIdle documentation (#10307)
This commit is contained in:
@@ -53,7 +53,7 @@ extern "C" {
|
||||
* @note This number versions both OpenThread platform and user APIs.
|
||||
*
|
||||
*/
|
||||
#define OPENTHREAD_API_VERSION (416)
|
||||
#define OPENTHREAD_API_VERSION (417)
|
||||
|
||||
/**
|
||||
* @addtogroup api-instance
|
||||
|
||||
@@ -648,6 +648,10 @@ void otPlatRadioSetPromiscuous(otInstance *aInstance, bool aEnable);
|
||||
* If a platform supports `OT_RADIO_CAPS_RX_ON_WHEN_IDLE` it must also support `OT_RADIO_CAPS_CSMA_BACKOFF` and handle
|
||||
* idle periods after CCA as described above.
|
||||
*
|
||||
* Upon the transition of the "RxOnWhenIdle" flag from TRUE to FALSE, the radio platform should enter sleep mode.
|
||||
* If the radio is currently in receive mode, it should enter sleep mode immediately. Otherwise, it should enter sleep
|
||||
* mode after the current operation is completed.
|
||||
*
|
||||
* @param[in] aInstance The OpenThread instance structure.
|
||||
* @param[in] aEnable TRUE to keep radio in Receive state, FALSE to put to Sleep state during idle periods.
|
||||
*
|
||||
|
||||
Reference in New Issue
Block a user