From 1de9f500af8697e3123919f57f1ba8c67b83d6a0 Mon Sep 17 00:00:00 2001 From: Eduardo Montoya Date: Wed, 29 May 2024 13:05:40 +0200 Subject: [PATCH] [radio] update `otPlatRadioSetRxOnWhenIdle` documentation --- include/openthread/instance.h | 2 +- include/openthread/platform/radio.h | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/include/openthread/instance.h b/include/openthread/instance.h index df87b06cb699..690277cf9ee1 100644 --- a/include/openthread/instance.h +++ b/include/openthread/instance.h @@ -53,7 +53,7 @@ extern "C" { * @note This number versions both OpenThread platform and user APIs. * */ -#define OPENTHREAD_API_VERSION (415) +#define OPENTHREAD_API_VERSION (416) /** * @addtogroup api-instance diff --git a/include/openthread/platform/radio.h b/include/openthread/platform/radio.h index 9f6bd31a65eb..9b4688db6dd9 100644 --- a/include/openthread/platform/radio.h +++ b/include/openthread/platform/radio.h @@ -648,6 +648,8 @@ 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. * + * When @p `aEnable` is set to FALSE, it is expected that the radio platform will put the radio to sleep. + * * @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. *