[docs] clarify otPlatRadioGetNow() as free-running (#7135)

This commit is contained in:
Jonathan Hui
2021-11-08 09:02:53 -08:00
committed by GitHub
parent d1ae06ea20
commit 96a17b07ca
2 changed files with 5 additions and 2 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 (174)
#define OPENTHREAD_API_VERSION (175)
/**
* @addtogroup api-instance
+4 -1
View File
@@ -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.
*