odp_timer_tick_info_t Struct Reference

Timer tick information. More...

#include <timer_types.h>

Collaboration diagram for odp_timer_tick_info_t:

Data Fields
odp_fract_u64_t	freq
	Timer tick frequency in hertz. More...
odp_fract_u64_t	nsec
	One timer tick in nanoseconds. More...
odp_fract_u64_t	clk_cycle
	One timer tick in source clock cycles. More...

Detailed Description

Timer tick information.

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

Field Documentation

freq

odp_fract_u64_t odp_timer_tick_info_t::freq

Timer tick frequency in hertz.

Timer tick frequency expressed as a fractional number. The integer part contains full hertz. The fraction part (numerator / denominator) contains parts of a hertz to be added with the integer.

For example, a timer tick frequency of 333 333 and 1/3 Hz could be presented with these values: integer = 333 333, numer = 1, denom = 3. Implementation may choose numer and denom values freely.

Examples

odp_sysinfo.c.

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

nsec

odp_fract_u64_t odp_timer_tick_info_t::nsec

One timer tick in nanoseconds.

Nanoseconds per tick is expressed as a fractional number. The integer part contains full nanoseconds. The fraction part (numerator / denominator) contains parts of a nanosecond to be added with the integer.

For example, a timer tick period of 3.125 nanoseconds (320MHz) could be presented with these values: integer = 3, numer = 125 000 000, denom = 1 000 000 000. Implementation may choose numer and denom values freely.

Examples

odp_sysinfo.c.

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

clk_cycle

odp_fract_u64_t odp_timer_tick_info_t::clk_cycle

One timer tick in source clock cycles.

The clock cycle count is expressed as a fractional number. The integer part contains full clock cycles. The fraction part (numerator / denominator) contains parts of a clock cycle to be added with the integer.

For example, a timer tick period of 42 and 1/3 source clock cycles could be presented with these values: integer = 42, numer = 1, denom = 3. Implementation may choose numer and denom values freely.

The value is zero, when there is no direct connection between tick and the source clock signal.

Examples

odp_sysinfo.c.

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

---

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

• api/spec/timer_types.h