precision_clock_api Struct Reference

Operations implemented by a precision clock adapter. More...

#include <zephyr/precision_timing/precision_clock.h>

Data Fields
int(*	read )(const struct precision_clock *precision_clk, precision_time_t *time_ns)
	Read the current clock value.
int(*	set )(const struct precision_clock *precision_clk, precision_time_t time_ns)
	Set the current clock value.
int(*	adjust_phase )(const struct precision_clock *precision_clk, precision_time_t phase_ns)
	Apply a signed phase adjustment in nanoseconds.
int(*	adjust_rate )(const struct precision_clock *precision_clk, int64_t scaled_ppm)
	Set the clock rate offset from its nominal frequency.

Detailed Description

Operations implemented by a precision clock adapter.

All operations are mandatory. Callers must provide a valid initialized clock and valid operation arguments.

Field Documentation

adjust_phase

int(* precision_clock_api::adjust_phase) (const struct precision_clock *precision_clk, precision_time_t phase_ns)

Apply a signed phase adjustment in nanoseconds.

adjust_rate

int(* precision_clock_api::adjust_rate) (const struct precision_clock *precision_clk, int64_t scaled_ppm)

Set the clock rate offset from its nominal frequency.

read

int(* precision_clock_api::read) (const struct precision_clock *precision_clk, precision_time_t *time_ns)

Read the current clock value.

set

int(* precision_clock_api::set) (const struct precision_clock *precision_clk, precision_time_t time_ns)

Set the current clock value.

---

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

• zephyr/precision_timing/precision_clock.h