From afe5041d075647a2e6c812c04cbd803220b3b215 Mon Sep 17 00:00:00 2001 From: David Smith Date: Tue, 23 May 2023 12:50:39 -0400 Subject: [PATCH] [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. --- include/openthread/instance.h | 2 +- include/openthread/platform/alarm-micro.h | 3 ++- include/openthread/platform/alarm-milli.h | 3 ++- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/include/openthread/instance.h b/include/openthread/instance.h index 935987f0f..e317b9a16 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 (326) +#define OPENTHREAD_API_VERSION (327) /** * @addtogroup api-instance diff --git a/include/openthread/platform/alarm-micro.h b/include/openthread/platform/alarm-micro.h index c165a4033..9bbe05d19 100644 --- a/include/openthread/platform/alarm-micro.h +++ b/include/openthread/platform/alarm-micro.h @@ -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. diff --git a/include/openthread/platform/alarm-milli.h b/include/openthread/platform/alarm-milli.h index 0ddd9180b..48fb08cf2 100644 --- a/include/openthread/platform/alarm-milli.h +++ b/include/openthread/platform/alarm-milli.h @@ -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.