diff options
| author | Petri Savolainen <petri.savolainen@nokia.com> | 2020-01-10 16:33:49 +0200 |
|---|---|---|
| committer | Petri Savolainen <petri.savolainen@nokia.com> | 2020-05-15 15:46:07 +0300 |
| commit | 3683b57c5bcc7a02de7469ffb058f63474bbe11a (patch) | |
| tree | 03d8fff35e4890bc4b415183affafc17d3888f20 /include/odp/api/spec/timer.h | |
| parent | 1ce5491be2a81a1d4b3b20e935421be7898d509b (diff) | |
api: timer: odp_timeout_tick returns original expiration time
Specification was open if returned expiration time is
the original or actual expiration time. HW based
implementations will not likely modify timeout event with
actual expiration time. Also original expiration time is more
valuable to an application as it can be used to calculate
e.g. the next period.
Signed-off-by: Petri Savolainen <petri.savolainen@nokia.com>
Reviewed-by: Matias Elo <matias.elo@nokia.com>
Reviewed-by: Stanislaw Kardach <skardach@marvell.com>
Diffstat (limited to 'include/odp/api/spec/timer.h')
| -rw-r--r-- | include/odp/api/spec/timer.h | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/include/odp/api/spec/timer.h b/include/odp/api/spec/timer.h index 3466e23a0..a48e79bf5 100644 --- a/include/odp/api/spec/timer.h +++ b/include/odp/api/spec/timer.h @@ -489,7 +489,11 @@ int odp_timeout_fresh(odp_timeout_t tmo); odp_timer_t odp_timeout_timer(odp_timeout_t tmo); /** - * Return expiration tick for the timeout + * Timeout expiration tick + * + * Returns the absolute expiration time (in timer ticks) that was used to set + * (or reset) the timer. For timers set with absolute expiration time this + * equals the provided tick value. * * @param tmo Timeout handle * |