[radio] update otPlatRadioSetRxOnWhenIdle documentation (#10307)

This commit is contained in:
Eduardo Montoya
2024-05-30 14:13:12 -07:00
committed by GitHub
parent d2e74dc705
commit edad0f97ef
2 changed files with 5 additions and 1 deletions
+1 -1
View File
@@ -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
+4
View File
@@ -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.
*