Timer capability. More...

#include <timer_types.h>

Collaboration diagram for odp_timer_capability_t:

Data Fields
uint32_t	max_pools_combined
	Maximum number of timer pools. More...

uint32_t	max_pools
	Maximum number of timer pools for single shot timers (per clock source) More...

uint32_t	max_timers
	Maximum number of single shot timers in a pool. More...

uint64_t	highest_res_ns
	Highest timer resolution in nanoseconds. More...

odp_timer_res_capability_t	max_res
	Maximum resolution. More...

odp_timer_res_capability_t	max_tmo
	Maximum timeout length. More...

odp_bool_t	queue_type_sched
	Scheduled queue destination support. More...

odp_bool_t	queue_type_plain
	Plain queue destination support. More...

struct {
uint32_t max_pools
	Maximum number of timer pools for periodic timers. More...

uint32_t max_timers
	Maximum number of periodic timers in a pool.

odp_fract_u64_t min_base_freq_hz
	Minimum supported base frequency value.

odp_fract_u64_t max_base_freq_hz
	Maximum supported base frequency value.

}	periodic
	Periodic timer capabilities.

Detailed Description

Timer capability.

Examples: odp_bench_timer.c, odp_debug.c, odp_sched_pktio.c, odp_stress.c, odp_sysinfo.c, odp_timer_accuracy.c, odp_timer_perf.c, and odp_timer_simple.c.

Definition at line 124 of file api/spec/timer_types.h.

Field Documentation

◆ max_pools_combined

uint32_t odp_timer_capability_t::max_pools_combined

Maximum number of timer pools.

The total number of timer pools that can be created combining both types and different clock sources.

Examples: odp_sysinfo.c.

Definition at line 130 of file api/spec/timer_types.h.

◆ max_pools

uint32_t odp_timer_capability_t::max_pools

Maximum number of timer pools for single shot timers (per clock source)

Maximum number of timer pools for periodic timers.

When zero, periodic timers (ODP_TIMER_TYPE_PERIODIC) are not supported.

Examples: odp_sysinfo.c, odp_timer_accuracy.c, and odp_timer_perf.c.

Definition at line 133 of file api/spec/timer_types.h.

◆ max_timers

uint32_t odp_timer_capability_t::max_timers

Maximum number of single shot timers in a pool.

Maximum number of periodic timers in a pool.

The value of zero means that limited only by the available memory size for the pool.

Examples: odp_sysinfo.c, odp_timer_accuracy.c, and odp_timer_perf.c.

Definition at line 139 of file api/spec/timer_types.h.

◆ highest_res_ns

uint64_t odp_timer_capability_t::highest_res_ns

Highest timer resolution in nanoseconds.

This defines the highest resolution supported by a timer. It's the minimum valid value for 'res_ns' timer pool parameter.

This value is equal to 'max_res.res_ns' capability.

Examples: odp_sched_pktio.c, odp_sysinfo.c, and odp_timer_simple.c.

Definition at line 149 of file api/spec/timer_types.h.

◆ max_res

odp_timer_res_capability_t odp_timer_capability_t::max_res

Maximum resolution.

This defines the highest resolution supported by a timer, with limits to min/max timeout values. The highest resolution for a timer pool is defined by 'max_res.res_ns' in nanoseconds and 'max_res.res_hz' in hertz. When this resolution is used:

'min_tmo' parameter value must be in minimum 'max_res.min_tmo'
'max_tmo' parameter value must be in maximum 'max_res.max_tmo'

Examples: odp_bench_timer.c, odp_sysinfo.c, odp_timer_accuracy.c, and odp_timer_perf.c.

Definition at line 162 of file api/spec/timer_types.h.

◆ max_tmo

odp_timer_res_capability_t odp_timer_capability_t::max_tmo

Maximum timeout length.

This defines the maximum relative timeout value supported by a timer, with limits to min timeout and max resolution values. The maximum value for 'max_tmo' timer pool parameter is defined by 'max_tmo.max_tmo'. When this max timeout value is used:

'min_tmo' parameter value must be in minimum 'max_tmo.min_tmo'
'res_ns' parameter value must be in minimum 'max_tmo.res_ns' or
'res_hz' parameter value must be in maximum 'max_tmo.res_hz'

Examples: odp_debug.c, and odp_sysinfo.c.

Definition at line 175 of file api/spec/timer_types.h.

◆ queue_type_sched

odp_bool_t odp_timer_capability_t::queue_type_sched

Scheduled queue destination support.

This defines whether schedule queues are supported as timeout destination queues. 0: Scheduled queues are not supported as timeout destination queues 1: Scheduled queues are supported as timeout destination queues

See also: odp_timer_alloc()

Examples: odp_bench_timer.c, odp_debug.c, odp_stress.c, and odp_sysinfo.c.

Definition at line 186 of file api/spec/timer_types.h.

◆ queue_type_plain

odp_bool_t odp_timer_capability_t::queue_type_plain

Plain queue destination support.

This defines whether plain queues are supported as timeout destination queues. 0: Plain queues are not supported as timeout destination queues 1: Plain queues are supported as timeout destination queues

See also: odp_timer_alloc()

Examples: odp_sysinfo.c.

Definition at line 197 of file api/spec/timer_types.h.

The documentation for this struct was generated from the following file:

api/spec/timer_types.h

Data Fields