xref: /freebsd/sys/compat/linuxkpi/common/include/linux/ptp_clock_kernel.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)
1 /*-
2  * Copyright (c) 2023 The FreeBSD Foundation
3  *
4  * This software was developed by Björn Zeeb under sponsorship from
5  * the FreeBSD Foundation.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #ifndef	_LINUXKPI_LINUX_PTP_CLOCK_KERNEL_H
30 #define	_LINUXKPI_LINUX_PTP_CLOCK_KERNEL_H
31 
32 #include <linux/types.h>
33 #include <linux/device.h>
34 #include <linux/kernel.h>	/* pr_debug */
35 #include <linux/ktime.h>	/* system_device_crosststamp */
36 
37 /* This very likely belongs elsewhere. */
38 struct system_device_crosststamp {
39 	ktime_t	device;
40 	ktime_t	sys_realtime;
41 	ktime_t	sys_monotonic_raw;	/* name guessed based on comment */
42 };
43 
44 struct ptp_clock_info {
45 	char		name[32];
46 	int		max_adj;
47 	void		*owner;			/* THIS_MODULE */
48 	int (*adjfine)(struct ptp_clock_info *, long);
49 	int (*adjtime)(struct ptp_clock_info *, s64);
50 	int (*getcrosststamp)(struct ptp_clock_info *, struct system_device_crosststamp *);
51 	int (*gettime64)(struct ptp_clock_info *, struct timespec *);
52 };
53 
54 static inline struct ptp_clock *
ptp_clock_register(struct ptp_clock_info * ptpci,struct device * dev)55 ptp_clock_register(struct ptp_clock_info *ptpci, struct device *dev)
56 {
57 
58 	pr_debug("%s: TODO\n", __func__);
59 	return (NULL);
60 }
61 
62 static inline void
ptp_clock_unregister(struct ptp_clock * ptpc)63 ptp_clock_unregister(struct ptp_clock *ptpc)
64 {
65 	pr_debug("%s: TODO\n", __func__);
66 }
67 
68 static inline int
ptp_clock_index(struct ptp_clock * ptpc)69 ptp_clock_index(struct ptp_clock *ptpc)
70 {
71 	pr_debug("%s: TODO\n", __func__);
72 	return (0);
73 }
74 
75 #endif	/* _LINUXKPI_LINUX_PTP_CLOCK_KERNEL_H */
76