2 * SPDX-License-Identifier: Beerware
4 * ----------------------------------------------------------------------------
5 * "THE BEER-WARE LICENSE" (Revision 42):
6 * <phk@FreeBSD.org> wrote this file. As long as you retain this notice you
7 * can do whatever you want with this stuff. If we meet some day, and you think
8 * this stuff is worth it, you can buy me a beer in return. Poul-Henning Kamp
9 * ----------------------------------------------------------------------------
11 * Copyright (c) 2011 The FreeBSD Foundation
13 * Portions of this software were developed by Julien Ridoux at the University
14 * of Melbourne under sponsorship from the FreeBSD Foundation.
18 * The is a FreeBSD version of the RFC 2783 API for Pulse Per Second
22 #ifndef _SYS_TIMEPPS_H_
23 #define _SYS_TIMEPPS_H_
25 #include <sys/_ffcounter.h>
26 #include <sys/ioccom.h>
29 #define PPS_API_VERS_1 1
31 typedef int pps_handle_t;
33 typedef unsigned pps_seq_t;
35 typedef struct ntp_fp {
36 unsigned int integral;
37 unsigned int fractional;
40 typedef union pps_timeu {
41 struct timespec tspec;
43 unsigned long longpad[3];
47 pps_seq_t assert_sequence; /* assert event seq # */
48 pps_seq_t clear_sequence; /* clear event seq # */
49 pps_timeu_t assert_tu;
51 int current_mode; /* current mode bits */
55 pps_seq_t assert_sequence; /* assert event seq # */
56 pps_seq_t clear_sequence; /* clear event seq # */
57 pps_timeu_t assert_tu;
59 ffcounter assert_ffcount; /* ffcounter on assert event */
60 ffcounter clear_ffcount; /* ffcounter on clear event */
61 int current_mode; /* current mode bits */
64 #define assert_timestamp assert_tu.tspec
65 #define clear_timestamp clear_tu.tspec
67 #define assert_timestamp_ntpfp assert_tu.ntpfp
68 #define clear_timestamp_ntpfp clear_tu.ntpfp
71 int api_version; /* API version # */
72 int mode; /* mode bits */
73 pps_timeu_t assert_off_tu;
74 pps_timeu_t clear_off_tu;
77 #define assert_offset assert_off_tu.tspec
78 #define clear_offset clear_off_tu.tspec
80 #define assert_offset_ntpfp assert_off_tu.ntpfp
81 #define clear_offset_ntpfp clear_off_tu.ntpfp
83 #define PPS_CAPTUREASSERT 0x01
84 #define PPS_CAPTURECLEAR 0x02
85 #define PPS_CAPTUREBOTH 0x03
87 #define PPS_OFFSETASSERT 0x10
88 #define PPS_OFFSETCLEAR 0x20
90 #define PPS_ECHOASSERT 0x40
91 #define PPS_ECHOCLEAR 0x80
93 #define PPS_CANWAIT 0x100
94 #define PPS_CANPOLL 0x200
96 #define PPS_TSFMT_TSPEC 0x1000
97 #define PPS_TSFMT_NTPFP 0x2000
99 #define PPS_TSCLK_FBCK 0x10000
100 #define PPS_TSCLK_FFWD 0x20000
101 #define PPS_TSCLK_MASK 0x30000
103 #define PPS_KC_HARDPPS 0
104 #define PPS_KC_HARDPPS_PLL 1
105 #define PPS_KC_HARDPPS_FLL 2
107 struct pps_fetch_args {
109 pps_info_t pps_info_buf;
110 struct timespec timeout;
113 struct pps_fetch_ffc_args {
115 pps_info_ffc_t pps_info_buf_ffc;
116 struct timespec timeout;
119 struct pps_kcbind_args {
125 #define PPS_IOC_CREATE _IO('1', 1)
126 #define PPS_IOC_DESTROY _IO('1', 2)
127 #define PPS_IOC_SETPARAMS _IOW('1', 3, pps_params_t)
128 #define PPS_IOC_GETPARAMS _IOR('1', 4, pps_params_t)
129 #define PPS_IOC_GETCAP _IOR('1', 5, int)
130 #define PPS_IOC_FETCH _IOWR('1', 6, struct pps_fetch_args)
131 #define PPS_IOC_KCBIND _IOW('1', 7, struct pps_kcbind_args)
132 #define PPS_IOC_FETCH_FFCOUNTER _IOWR('1', 8, struct pps_fetch_ffc_args)
138 #define KCMODE_EDGEMASK 0x03
139 #define KCMODE_ABIFLAG 0x80000000 /* Internal use: abi-aware driver. */
141 #define PPS_ABI_VERSION 1
143 #define PPSFLAG_MTX_SPIN 0x01 /* Driver mtx is MTX_SPIN type. */
146 /* Capture information. */
147 struct timehands *capth;
148 struct fftimehands *capffth;
152 /* State information. */
153 pps_params_t ppsparam;
155 pps_info_ffc_t ppsinfo_ffc;
158 struct timecounter *ppstc;
159 unsigned ppscount[3];
161 * The following fields are valid if the driver calls pps_init_abi().
163 uint16_t driver_abi; /* Driver sets before pps_init_abi(). */
164 uint16_t kernel_abi; /* Kernel sets during pps_init_abi(). */
165 struct mtx *driver_mtx; /* Optional, valid if non-NULL. */
169 void pps_capture(struct pps_state *pps);
170 void pps_event(struct pps_state *pps, int event);
171 void pps_init(struct pps_state *pps);
172 void pps_init_abi(struct pps_state *pps);
173 int pps_ioctl(unsigned long cmd, caddr_t data, struct pps_state *pps);
174 void hardpps(struct timespec *tsp, long nsec);
179 time_pps_create(int filedes, pps_handle_t *handle)
184 error = ioctl(filedes, PPS_IOC_CREATE, 0);
192 time_pps_destroy(pps_handle_t handle)
194 return (ioctl(handle, PPS_IOC_DESTROY, 0));
198 time_pps_setparams(pps_handle_t handle, const pps_params_t *ppsparams)
200 return (ioctl(handle, PPS_IOC_SETPARAMS, ppsparams));
204 time_pps_getparams(pps_handle_t handle, pps_params_t *ppsparams)
206 return (ioctl(handle, PPS_IOC_GETPARAMS, ppsparams));
210 time_pps_getcap(pps_handle_t handle, int *mode)
212 return (ioctl(handle, PPS_IOC_GETCAP, mode));
216 time_pps_fetch(pps_handle_t handle, const int tsformat,
217 pps_info_t *ppsinfobuf, const struct timespec *timeout)
220 struct pps_fetch_args arg;
222 arg.tsformat = tsformat;
223 if (timeout == NULL) {
224 arg.timeout.tv_sec = -1;
225 arg.timeout.tv_nsec = -1;
227 arg.timeout = *timeout;
228 error = ioctl(handle, PPS_IOC_FETCH, &arg);
229 *ppsinfobuf = arg.pps_info_buf;
234 time_pps_fetch_ffc(pps_handle_t handle, const int tsformat,
235 pps_info_ffc_t *ppsinfobuf, const struct timespec *timeout)
237 struct pps_fetch_ffc_args arg;
240 arg.tsformat = tsformat;
241 if (timeout == NULL) {
242 arg.timeout.tv_sec = -1;
243 arg.timeout.tv_nsec = -1;
245 arg.timeout = *timeout;
247 error = ioctl(handle, PPS_IOC_FETCH_FFCOUNTER, &arg);
248 *ppsinfobuf = arg.pps_info_buf_ffc;
253 time_pps_kcbind(pps_handle_t handle, const int kernel_consumer,
254 const int edge, const int tsformat)
256 struct pps_kcbind_args arg;
258 arg.kernel_consumer = kernel_consumer;
260 arg.tsformat = tsformat;
261 return (ioctl(handle, PPS_IOC_KCBIND, &arg));
266 #endif /* !_SYS_TIMEPPS_H_ */