bbe5e1e6eb
Namespaced the generated headers with `zephyr` to prevent potential conflict with other headers. Introduce a temporary Kconfig `LEGACY_GENERATED_INCLUDE_PATH` that is enabled by default. This allows the developers to continue the use of the old include paths for the time being until it is deprecated and eventually removed. The Kconfig will generate a build-time warning message, similar to the `CONFIG_TIMER_RANDOM_GENERATOR`. Updated the includes path of in-tree sources accordingly. Most of the changes here are scripted, check the PR for more info. Signed-off-by: Yong Cong Sin <ycsin@meta.com>
107 lines
2.4 KiB
C
107 lines
2.4 KiB
C
/*
|
|
* 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);
|
|
};
|
|
|
|
/**
|
|
* @brief Set the time of the PTP clock.
|
|
*
|
|
* @param dev PTP clock device
|
|
* @param tm Time to set
|
|
*
|
|
* @return 0 if ok, <0 if error
|
|
*/
|
|
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);
|
|
}
|
|
|
|
/**
|
|
* @brief Get the time of the PTP clock.
|
|
*
|
|
* @param dev PTP clock device
|
|
* @param tm Where to store the current time.
|
|
*
|
|
* @return 0 if ok, <0 if error
|
|
*/
|
|
__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);
|
|
}
|
|
|
|
/**
|
|
* @brief Adjust the PTP clock time.
|
|
*
|
|
* @param dev PTP clock device
|
|
* @param increment Increment of the clock in nanoseconds
|
|
*
|
|
* @return 0 if ok, <0 if error
|
|
*/
|
|
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);
|
|
}
|
|
|
|
/**
|
|
* @brief Adjust the PTP clock time change rate when compared to its neighbor.
|
|
*
|
|
* @param dev PTP clock device
|
|
* @param rate Rate of the clock time change
|
|
*
|
|
* @return 0 if ok, <0 if error
|
|
*/
|
|
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 <zephyr/syscalls/ptp_clock.h>
|
|
|
|
#endif /* ZEPHYR_INCLUDE_DRIVERS_PTP_CLOCK_H_ */
|