zephyr/include/ptp_clock.h
Peter Bigot 6554a5e5b6 include: rearrange for standard use of extern "C" in various headers
Consistently place C++ use of extern "C" after all include directives,
within the negative branch of _ASMLANGUAGE if used.

The inclusion of the generated syscall files is placed outside the
extern "C" block as the generated file has its own extern "C" block.

Background from issue #17997:

Declarations that use C linkage should be placed within extern "C"
so the language linkage is correct when the header is included by
a C++ compiler.

Similarly #include directives should be outside the extern "C" to
ensure the language-specific default linkage is applied to any
declarations provided by the included header.

See: https://en.cppreference.com/w/cpp/language/language_linkage
Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no>
2019-08-13 18:00:31 +02:00

102 lines
2.2 KiB
C

/*
* Copyright (c) 2018 Intel Corporation.
*
* SPDX-License-Identifier: Apache-2.0
*/
#ifndef ZEPHYR_INCLUDE_PTP_CLOCK_H_
#define ZEPHYR_INCLUDE_PTP_CLOCK_H_
#include <kernel.h>
#include <stdint.h>
#include <device.h>
#include <sys/util.h>
#include <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
struct ptp_clock_driver_api {
int (*set)(struct device *dev, struct net_ptp_time *tm);
int (*get)(struct device *dev, struct net_ptp_time *tm);
int (*adjust)(struct device *dev, int increment);
int (*rate_adjust)(struct device *dev, float 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(struct device *dev, struct net_ptp_time *tm)
{
const struct ptp_clock_driver_api *api = dev->driver_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(struct device *dev, struct net_ptp_time *tm);
static inline int z_impl_ptp_clock_get(struct device *dev,
struct net_ptp_time *tm)
{
const struct ptp_clock_driver_api *api = dev->driver_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(struct device *dev, int increment)
{
const struct ptp_clock_driver_api *api = dev->driver_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(struct device *dev, float rate)
{
const struct ptp_clock_driver_api *api = dev->driver_api;
return api->rate_adjust(dev, rate);
}
#ifdef __cplusplus
}
#endif
#include <syscalls/ptp_clock.h>
#endif /* ZEPHYR_INCLUDE_PTP_CLOCK_H_ */