[alarm] otPlatAlarm requirements clarification (#9067)

The requirement in the code comments is not completely accurate wrt to
the example implementations. As such, the requirements are updated to
match what is implemented for the posix platform.
This commit is contained in:
David Smith
2023-05-23 09:50:39 -07:00
committed by GitHub
parent f64b7cc73c
commit afe5041d07
3 changed files with 5 additions and 3 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 (326)
#define OPENTHREAD_API_VERSION (327)
/**
* @addtogroup api-instance
+2 -1
View File
@@ -53,7 +53,8 @@ extern "C" {
/**
* Set the alarm to fire at @p aDt microseconds after @p aT0.
*
* For both @p aT0 and @p aDt, the platform MUST support all values in [0, 2^32-1].
* For @p aT0, the platform MUST support all values in [0, 2^32-1].
* For @p aDt, the platform MUST support all values in [0, 2^31-1].
*
* @param[in] aInstance The OpenThread instance structure.
* @param[in] aT0 The reference time.
+2 -1
View File
@@ -56,7 +56,8 @@ extern "C" {
/**
* Set the alarm to fire at @p aDt milliseconds after @p aT0.
*
* For both @p aT0 and @p aDt, the platform MUST support all values in [0, 2^32-1].
* For @p aT0 the platform MUST support all values in [0, 2^32-1].
* For @p aDt, the platform MUST support all values in [0, 2^31-1].
*
* @param[in] aInstance The OpenThread instance structure.
* @param[in] aT0 The reference time.