odp_timer_periodic_capability_t Struct Reference

Periodic timer capability. More...

#include <timer_types.h>

Collaboration diagram for odp_timer_periodic_capability_t:

Data Fields
odp_timer_type_t	type
	Periodic timer type for which to check the frequency support. More...
union {
struct {
odp_fract_u64_t   base_freq_hz
	Periodic timer pool base frequency in hertz. More...
uint64_t   max_multiplier
	Maximum base frequency multiplier.
}   base_mul
	Capability for ODP_TIMER_TYPE_PERIODIC_BASE_MUL.
struct {
odp_fract_u64_t *   freq_hz
	Array of constraining periodic timer frequencies for timer pool in hertz in ascending order.
uint32_t   num
	Number of items in 'freq_hz' array.
}   freq
	Capability for ODP_TIMER_TYPE_PERIODIC_FREQ.
};
	Type specific configuration.
uint64_t	res_ns
	Timeout resolution in nanoseconds.

Detailed Description

Periodic timer capability.

Examples

odp_timer_accuracy.c, and odp_timer_stress.c.

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

Field Documentation

type

odp_timer_type_t odp_timer_periodic_capability_t::type

Periodic timer type for which to check the frequency support.

Allowed types are ODP_TIMER_TYPE_PERIODIC_BASE_MUL and ODP_TIMER_TYPE_PERIODIC_FREQ.

Examples

odp_timer_accuracy.c.

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

base_freq_hz

odp_fract_u64_t odp_timer_periodic_capability_t::base_freq_hz

Periodic timer pool base frequency in hertz.

Base frequency is represented as a fractional number where the fraction part is always less than one. In other words, the integer part specifies whole hertz whereas the fraction part specifies parts of a hertz (if any). The fraction part does not need to be reduced to its lowest terms - e.g. 100.5 Hz may be represented as 100 1/2 Hz, 100 5/10 Hz, or 100 Hz with some other equivalent fraction part.

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

---

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

• api/spec/timer_types.h