Driver Operations PTP Clock driver operations More...

#include <zephyr/drivers/ptp_clock.h>

Data Fields
ptp_clock_api_set_t	set
	REQ Set the time of the PTP clock.
ptp_clock_api_get_t	get
	REQ Get the time of the PTP clock.
ptp_clock_api_adjust_t	adjust
	REQ Adjust the PTP clock time.
ptp_clock_api_rate_adjust_t	rate_adjust
	REQ Adjust the PTP clock rate ratio based on its nominal frequency.

Detailed Description

Driver Operations PTP Clock driver operations

This is the driver API structure any PTP Clock driver needs to define. It contains function pointers to the operations the driver implements, as well as any other driver-specific constant data.

Members marked with REQ MUST be set by the driver, whereas those marked with OPT are optional.

See also: DEVICE_DT_INST_DEFINE(); DEVICE_DT_DEFINE(); DEVICE_API()

Field Documentation

◆ adjust

ptp_clock_api_adjust_t ptp_clock_driver_api::adjust

REQ Adjust the PTP clock time.

◆ get

ptp_clock_api_get_t ptp_clock_driver_api::get

REQ Get the time of the PTP clock.

◆ rate_adjust

ptp_clock_api_rate_adjust_t ptp_clock_driver_api::rate_adjust

REQ Adjust the PTP clock rate ratio based on its nominal frequency.

◆ set

ptp_clock_api_set_t ptp_clock_driver_api::set

REQ Set the time of the PTP clock.

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

zephyr/drivers/ptp_clock.h