From 96a17b07ca2126b211dd7ffc1e1896579e8987c1 Mon Sep 17 00:00:00 2001 From: Jonathan Hui Date: Mon, 8 Nov 2021 09:02:53 -0800 Subject: [PATCH] [docs] clarify `otPlatRadioGetNow()` as free-running (#7135) --- include/openthread/instance.h | 2 +- include/openthread/platform/radio.h | 5 ++++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/include/openthread/instance.h b/include/openthread/instance.h index 3bc8ca28f..242a97024 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 (174) +#define OPENTHREAD_API_VERSION (175) /** * @addtogroup api-instance diff --git a/include/openthread/platform/radio.h b/include/openthread/platform/radio.h index 02e58aeb8..318ed9d16 100644 --- a/include/openthread/platform/radio.h +++ b/include/openthread/platform/radio.h @@ -614,7 +614,10 @@ void otPlatRadioSetMacKey(otInstance * aInstance, void otPlatRadioSetMacFrameCounter(otInstance *aInstance, uint32_t aMacFrameCounter); /** - * Get the current estimated time (64bits width) of the radio chip. + * Get the current estimated time (in microseconds) of the radio chip. + * + * This microsecond timer must be a free-running timer. The timer must continue to advance with microsecond precision + * even when the radio is in the sleep state. * * @param[in] aInstance A pointer to an OpenThread instance. *