api/spec/timer_types.h File Reference

ODP timer API type definitions. More...

#include <odp/visibility_begin.h>
#include <odp/api/deprecated.h>
#include <odp/api/event_types.h>
#include <odp/api/std_types.h>
#include <odp/visibility_end.h>

Include dependency graph for api/spec/timer_types.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	odp_timer_res_capability_t
	Timer resolution capability. More...
struct	odp_timer_periodic_capability_t
	Periodic timer capability. More...
struct	odp_timer_capability_t
	Timer capability. More...
struct	odp_timer_pool_param_t
	Timer pool parameters. More...
struct	odp_timer_start_t
	Timer start parameters. More...
struct	odp_timer_periodic_start_t
	Periodic timer start parameters. More...
struct	odp_timer_tick_info_t
	Timer tick information. More...
struct	odp_timer_pool_info_t
	ODP timer pool information and configuration. More...

Macros
#define	ODP_CLOCK_DEFAULT   ODP_CLOCK_SRC_0
	The default clock source.

Typedefs
typedef struct odp_timer_start_t	odp_timer_start_t
	Timer start parameters.
typedef struct odp_timer_periodic_start_t	odp_timer_periodic_start_t
	Periodic timer start parameters. More...
typedef odp_timer_retval_t	odp_timer_set_t
	For backwards compatibility, odp_timer_set_t is synonym of odp_timer_retval_t. More...
typedef struct odp_timer_tick_info_t	odp_timer_tick_info_t
	Timer tick information.

Enumerations
enum	odp_timer_type_t { ODP_TIMER_TYPE_SINGLE = 0 , ODP_TIMER_TYPE_PERIODIC }
	Timer type. More...
enum	odp_timer_clk_src_t {   ODP_CLOCK_SRC_0 , ODP_CLOCK_SRC_1 , ODP_CLOCK_SRC_2 , ODP_CLOCK_SRC_3 ,   ODP_CLOCK_SRC_4 , ODP_CLOCK_SRC_5 , ODP_CLOCK_NUM_SRC }
	Clock sources for timer pools. More...
enum	odp_timer_exp_mode_t { ODP_TIMER_EXP_AFTER = 0 , ODP_TIMER_EXP_RELAXED }
	Timer expiration mode. More...
enum	odp_timer_tick_type_t { ODP_TIMER_TICK_REL = 0 , ODP_TIMER_TICK_ABS }
	Timer tick type. More...
enum	odp_timer_retval_t { ODP_TIMER_SUCCESS = 0 , ODP_TIMER_TOO_NEAR = -1 , ODP_TIMER_TOO_FAR = -2 , ODP_TIMER_FAIL = -3 }
	Return values for timer start, restart and cancel calls. More...

Detailed Description

ODP timer API type definitions.

Definition in file api/spec/timer_types.h.