From: Petri Savolainen <petri.savolai...@linaro.org> Specify explicitly what each timer pool parameter means. This does not change the intended use of the parameters.
Signed-off-by: Petri Savolainen <petri.savolai...@linaro.org> --- /** Email created from pull request 177 (psavol:next-timer-min-tmo) ** https://github.com/Linaro/odp/pull/177 ** Patch: https://github.com/Linaro/odp/pull/177.patch ** Base sha: 6b6253c30f88c80bf632436ff06c1b000860a2f1 ** Merge commit sha: 32ea46150ca537c8d97433ee4af826ccbe965434 **/ include/odp/api/spec/timer.h | 36 ++++++++++++++++++++++++++++++------ 1 file changed, 30 insertions(+), 6 deletions(-) diff --git a/include/odp/api/spec/timer.h b/include/odp/api/spec/timer.h index b76f5654..17daafc7 100644 --- a/include/odp/api/spec/timer.h +++ b/include/odp/api/spec/timer.h @@ -99,12 +99,36 @@ typedef enum { * Timer pool parameters are used when creating and querying timer pools. */ typedef struct { - uint64_t res_ns; /**< Timeout resolution in nanoseconds */ - uint64_t min_tmo; /**< Minimum relative timeout in nanoseconds */ - uint64_t max_tmo; /**< Maximum relative timeout in nanoseconds */ - uint32_t num_timers; /**< (Minimum) number of supported timers */ - int priv; /**< Shared (false) or private (true) timer pool */ - odp_timer_clk_src_t clk_src; /**< Clock source for timers */ + /** Timeout resolution in nanoseconds. Timer pool must serve timeouts + * with this or higher resolution. The minimum valid value (highest + * resolution) is defined by timer capability 'highest_res_ns'. */ + uint64_t res_ns; + + /** Minimum relative timeout in nanoseconds. All requested timeouts + * will be at least this many nanoseconds after the current + * time of the timer pool. Timer set functions return an error, if too + * short timeout was requested. The value may be also less than + * 'res_ns'. */ + uint64_t min_tmo; + + /** Maximum relative timeout in nanoseconds. All requested timeouts + * will be at most this many nanoseconds after the current + * time of the timer pool. Timer set functions return an error, if too + * long timeout was requested. */ + uint64_t max_tmo; + + /** Number of timers needed. Application will create in maximum this + * many concurrent timers from the timer pool. */ + uint32_t num_timers; + + /** Thread private timer pool. When zero, multiple thread may use the + * timer pool concurrently. When non-zero, only single thread uses the + * timer pool (concurrently). */ + int priv; + + /** Clock source for timers */ + odp_timer_clk_src_t clk_src; + } odp_timer_pool_param_t; /**
