api: timer: clarify periodic first_tick documentation

Clarify that zero first_tick means that the first expiration time is
one period after the current time, not at the current time.

Signed-off-by: Jere Leppänen <jere.leppanen@nokia.com>
Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
Reviewed-by: Shijith Thotton <sthotton@marvell.com>

1 files changed, 4 insertions, 3 deletions

diff --git a/include/odp/api/spec/timer_types.h b/include/odp/api/spec/timer_types.h
index d61992fba..fd23bdeca 100644
--- a/include/odp/api/spec/timer_types.h
+++ b/include/odp/api/spec/timer_types.h
@@ -476,9 +476,10 @@ typedef struct odp_timer_start_t {
 typedef struct odp_timer_periodic_start_t {
 	/** First expiration time
 	 *
-	 *  The first expiration time in absolute timer ticks. When zero, timer expiration starts
-	 *  from the current time. After the first expiration, timer expiration continues with the
-	 *  defined frequency. The tick value must be within one timer period from the current time.
+	 *  The first expiration time in absolute timer ticks. When zero, the first expiration time
+	 *  is one period after the current time. After the first expiration, timer expiration
+	 *  continues with the defined frequency. The tick value must be within one timer period
+	 *  from the current time.
 	 */
 	uint64_t first_tick;