PTP Clock

Interfaces for Precision Time Protocol (PTP) clocks. More...

Files
file	ptp_clock.h
	Main header file for PTP (Precision Time Protocol) clock driver API.

Data Structures
struct	ptp_clock_driver_api

Macros
#define	PTP_CLOCK_NAME   "PTP_CLOCK"

Functions
static int	ptp_clock_set (const struct device *dev, struct net_ptp_time *tm)
	Set the time of the PTP clock.
int	ptp_clock_get (const struct device *dev, struct net_ptp_time *tm)
	Get the time of the PTP clock.
static int	ptp_clock_adjust (const struct device *dev, int increment)
	Adjust the PTP clock time.
static int	ptp_clock_rate_adjust (const struct device *dev, double rate)
	Adjust the PTP clock rate ratio based on its nominal frequency.

Detailed Description

Interfaces for Precision Time Protocol (PTP) clocks.

Macro Definition Documentation

PTP_CLOCK_NAME

#define PTP_CLOCK_NAME   "PTP_CLOCK"

#include <include/zephyr/drivers/ptp_clock.h>

Function Documentation

ptp_clock_adjust()

static int ptp_clock_adjust ( const struct device *  dev, int  increment  )

inlinestatic

#include <include/zephyr/drivers/ptp_clock.h>

Adjust the PTP clock time.

Parameters

dev	PTP clock device
increment	Increment of the clock in nanoseconds

Returns

0 if ok, <0 if error

ptp_clock_get()

int ptp_clock_get	(	const struct device *	dev,
		struct net_ptp_time *	tm
	)

#include <include/zephyr/drivers/ptp_clock.h>

Get the time of the PTP clock.

Parameters

dev	PTP clock device
tm	Where to store the current time.

Returns

0 if ok, <0 if error

ptp_clock_rate_adjust()

static int ptp_clock_rate_adjust ( const struct device *  dev, double  rate  )

inlinestatic

#include <include/zephyr/drivers/ptp_clock.h>

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

Parameters

dev	PTP clock device
rate	Rate ratio based on its nominal frequency

Returns

0 if ok, <0 if error

ptp_clock_set()

static int ptp_clock_set ( const struct device *  dev, struct net_ptp_time *  tm  )

inlinestatic

#include <include/zephyr/drivers/ptp_clock.h>

Set the time of the PTP clock.

Parameters

dev	PTP clock device
tm	Time to set

Returns

0 if ok, <0 if error