api: timer: clarify timer tick properties

Clarify that timer tick properties and especially the it may run
with a higher frequency than the resolution.

Signed-off-by: Petri Savolainen <petri.savolainen@nokia.com>
Reviewed-by: Tuomas Taipale <tuomas.taipale@nokia.com>
Reviewed-by: Jerin Jacob <jerinj@marvell.com>

1 files changed, 8 insertions, 0 deletions

diff --git a/include/odp/api/spec/timer.h b/include/odp/api/spec/timer.h
index c16ac6d64..74893a02d 100644
--- a/include/odp/api/spec/timer.h
+++ b/include/odp/api/spec/timer.h
@@ -134,9 +134,17 @@ uint64_t odp_timer_ns_to_tick(odp_timer_pool_t timer_pool, uint64_t ns);
 /**
  * Current tick value
  *
+ * Returns the current tick value of the timer pool. Timer tick is an implementation defined unit
+ * of time. Timer tick value increments with a constant, timer pool specific frequency. Tick
+ * frequency may be equal or higher than the requested timer pool resolution. The frequency can be
+ * checked with odp_timer_pool_info(). Tick value increments with implementation specific step
+ * sizes. The value will not wrap around in at least 10 years from the ODP instance startup.
+ *
  * @param timer_pool  Timer pool
  *
  * @return Current time in timer ticks
+ *
+ * @see odp_timer_tick_info_t
  */
 uint64_t odp_timer_current_tick(odp_timer_pool_t timer_pool);