API Reference Manual  1.45.0
api/spec/timer.h File Reference

ODP timer service. More...

#include <odp/visibility_begin.h>
#include <odp/api/timer_types.h>
#include <odp/api/event_types.h>
#include <odp/api/pool_types.h>
#include <odp/api/queue_types.h>
#include <odp/visibility_end.h>
Include dependency graph for api/spec/timer.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

int odp_timer_capability (odp_timer_clk_src_t clk_src, odp_timer_capability_t *capa)
 Query timer capabilities per clock source. More...
 
int odp_timer_res_capability (odp_timer_clk_src_t clk_src, odp_timer_res_capability_t *res_capa)
 Timer resolution capability. More...
 
int odp_timer_periodic_capability (odp_timer_clk_src_t clk_src, odp_timer_periodic_capability_t *capa)
 Periodic timer capability. More...
 
void odp_timer_pool_param_init (odp_timer_pool_param_t *param)
 Initialize timer pool parameters. More...
 
odp_timer_pool_t odp_timer_pool_create (const char *name, const odp_timer_pool_param_t *params)
 Create a timer pool. More...
 
void odp_timer_pool_start (void)
 Start a timer pool. More...
 
int odp_timer_pool_start_multi (odp_timer_pool_t timer_pool[], int num)
 Start timer pools. More...
 
void odp_timer_pool_destroy (odp_timer_pool_t timer_pool)
 Destroy a timer pool. More...
 
uint64_t odp_timer_tick_to_ns (odp_timer_pool_t timer_pool, uint64_t ticks)
 Convert timer ticks to nanoseconds. More...
 
uint64_t odp_timer_ns_to_tick (odp_timer_pool_t timer_pool, uint64_t ns)
 Convert nanoseconds to timer ticks. More...
 
uint64_t odp_timer_current_tick (odp_timer_pool_t timer_pool)
 Current tick value. More...
 
int odp_timer_sample_ticks (odp_timer_pool_t timer_pool[], uint64_t tick[], uint64_t clk_count[], int num)
 Sample tick values of timer pools. More...
 
int odp_timer_pool_info (odp_timer_pool_t timer_pool, odp_timer_pool_info_t *info)
 Query timer pool configuration and current state. More...
 
odp_timer_t odp_timer_alloc (odp_timer_pool_t timer_pool, odp_queue_t queue, const void *user_ptr)
 Allocate a timer. More...
 
int odp_timer_free (odp_timer_t timer)
 Free a timer. More...
 
int odp_timer_start (odp_timer_t timer, const odp_timer_start_t *start_param)
 Start a timer. More...
 
int odp_timer_restart (odp_timer_t timer, const odp_timer_start_t *start_param)
 Restart a timer. More...
 
int odp_timer_periodic_start (odp_timer_t timer, const odp_timer_periodic_start_t *start_param)
 Start a periodic timer. More...
 
int odp_timer_periodic_ack (odp_timer_t timer, odp_event_t tmo_ev)
 Acknowledge timeout from a periodic timer. More...
 
int odp_timer_periodic_cancel (odp_timer_t timer)
 Cancel a periodic timer. More...
 
int odp_timer_cancel (odp_timer_t timer, odp_event_t *tmo_ev)
 Cancel a timer. More...
 
odp_timeout_t odp_timeout_from_event (odp_event_t ev)
 Get timeout handle from a ODP_EVENT_TIMEOUT type event. More...
 
void odp_timeout_from_event_multi (odp_timeout_t tmo[], const odp_event_t ev[], int num)
 Convert multiple timeout events to timeout handles. More...
 
odp_event_t odp_timeout_to_event (odp_timeout_t tmo)
 Convert timeout handle to event handle. More...
 
int odp_timeout_fresh (odp_timeout_t tmo)
 Check for fresh timeout. More...
 
odp_timer_t odp_timeout_timer (odp_timeout_t tmo)
 Return timer handle for the timeout. More...
 
uint64_t odp_timeout_tick (odp_timeout_t tmo)
 Timeout expiration tick. More...
 
void * odp_timeout_user_ptr (odp_timeout_t tmo)
 Return user pointer for the timeout. More...
 
void * odp_timeout_user_area (odp_timeout_t tmo)
 Timeout user area. More...
 
odp_timeout_t odp_timeout_alloc (odp_pool_t pool)
 Timeout alloc. More...
 
int odp_timeout_alloc_multi (odp_pool_t pool, odp_timeout_t tmo[], int num)
 Allocate multiple timeouts. More...
 
void odp_timeout_free (odp_timeout_t tmo)
 Timeout free. More...
 
void odp_timeout_free_multi (odp_timeout_t tmo[], int num)
 Free multiple timeouts. More...
 
void odp_timer_pool_print (odp_timer_pool_t timer_pool)
 Print timer pool debug information. More...
 
void odp_timer_print (odp_timer_t timer)
 Print timer debug information. More...
 
void odp_timeout_print (odp_timeout_t tmo)
 Print timeout debug information. More...
 
uint64_t odp_timer_pool_to_u64 (odp_timer_pool_t timer_pool)
 Get printable value for an odp_timer_pool_t. More...
 
uint64_t odp_timer_to_u64 (odp_timer_t timer)
 Get printable value for an odp_timer_t. More...
 
uint64_t odp_timeout_to_u64 (odp_timeout_t tmo)
 Get printable value for an odp_timeout_t. More...
 

Detailed Description

ODP timer service.

Definition in file api/spec/timer.h.