PTP Clock Driver Backend API

Data Structures
struct	ptp_clock_driver_api
	Driver Operations PTP Clock driver operations More...

Typedefs
typedef int(*	ptp_clock_api_set_t) (const struct device *dev, struct net_ptp_time *tm)
	Set the time of the PTP clock.
typedef int(*	ptp_clock_api_get_t) (const struct device *dev, struct net_ptp_time *tm)
	Get the time of the PTP clock.
typedef int(*	ptp_clock_api_adjust_t) (const struct device *dev, int increment)
	Adjust the PTP clock time.
typedef int(*	ptp_clock_api_rate_adjust_t) (const struct device *dev, double ratio)
	Adjust the PTP clock rate ratio based on its nominal frequency.

Detailed Description

This group contains the API type definitions, callback signatures, and other helpers required to implement a PTP Clock driver.

Typedef Documentation

ptp_clock_api_adjust_t

typedef int(* ptp_clock_api_adjust_t) (const struct device *dev, int increment)

#include <zephyr/drivers/ptp_clock.h>

Adjust the PTP clock time.

See ptp_clock_adjust() for argument description.

ptp_clock_api_get_t

typedef int(* ptp_clock_api_get_t) (const struct device *dev, struct net_ptp_time *tm)

#include <zephyr/drivers/ptp_clock.h>

Get the time of the PTP clock.

See ptp_clock_get() for argument description.

ptp_clock_api_rate_adjust_t

typedef int(* ptp_clock_api_rate_adjust_t) (const struct device *dev, double ratio)

#include <zephyr/drivers/ptp_clock.h>

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

See ptp_clock_rate_adjust() for argument description.

ptp_clock_api_set_t

typedef int(* ptp_clock_api_set_t) (const struct device *dev, struct net_ptp_time *tm)

#include <zephyr/drivers/ptp_clock.h>

Set the time of the PTP clock.

See ptp_clock_set() for argument description.