ptp_clock.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 Intel Corporation.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_DRIVERS_PTP_CLOCK_H_
#define ZEPHYR_INCLUDE_DRIVERS_PTP_CLOCK_H_
 
#include <zephyr/kernel.h>
#include <stdint.h>
#include <zephyr/device.h>
#include <zephyr/sys/util.h>
#include <zephyr/net/ptp_time.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Name of the PTP clock driver */
#if !defined(PTP_CLOCK_NAME)
#define PTP_CLOCK_NAME "PTP_CLOCK"
#endif
 
__subsystem struct ptp_clock_driver_api {
        int (*set)(const struct device *dev, struct net_ptp_time *tm);
        int (*get)(const struct device *dev, struct net_ptp_time *tm);
        int (*adjust)(const struct device *dev, int increment);
        int (*rate_adjust)(const struct device *dev, double ratio);
};
 
static inline int ptp_clock_set(const struct device *dev,
                                struct net_ptp_time *tm)
{
        const struct ptp_clock_driver_api *api =
                (const struct ptp_clock_driver_api *)dev->api;
 
        return api->set(dev, tm);
}
 
__syscall int ptp_clock_get(const struct device *dev, struct net_ptp_time *tm);
 
static inline int z_impl_ptp_clock_get(const struct device *dev,
                                       struct net_ptp_time *tm)
{
        const struct ptp_clock_driver_api *api =
                (const struct ptp_clock_driver_api *)dev->api;
 
        return api->get(dev, tm);
}
 
static inline int ptp_clock_adjust(const struct device *dev, int increment)
{
        const struct ptp_clock_driver_api *api =
                (const struct ptp_clock_driver_api *)dev->api;
 
        return api->adjust(dev, increment);
}
 
static inline int ptp_clock_rate_adjust(const struct device *dev, double rate)
{
        const struct ptp_clock_driver_api *api =
                (const struct ptp_clock_driver_api *)dev->api;
 
        return api->rate_adjust(dev, rate);
}
 
#ifdef __cplusplus
}
#endif
 
#include <syscalls/ptp_clock.h>
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_PTP_CLOCK_H_ */