2 * ----------------------------------------------------------------------------
3 * "THE BEER-WARE LICENSE" (Revision 42):
4 * <phk@FreeBSD.org> wrote this file. As long as you retain this notice you
5 * can do whatever you want with this stuff. If we meet some day, and you think
6 * this stuff is worth it, you can buy me a beer in return. Poul-Henning Kamp
7 * ----------------------------------------------------------------------------
9 * $FreeBSD: src/sys/sys/timepps.h,v 1.12 1999/12/29 04:24:48 peter Exp $
10 * $DragonFly: src/sys/sys/timepps.h,v 1.4 2004/01/30 05:42:18 dillon Exp $
12 * The is a FreeBSD protype version of the "draft-mogul-pps-api-05.txt"
13 * specification for Pulse Per Second timing interfaces.
16 #ifndef _SYS_TIMEPPS_H_
17 #define _SYS_TIMEPPS_H_
19 #include <sys/ioccom.h>
20 #include <sys/systimer.h>
22 #define PPS_API_VERS_1 1
24 typedef int pps_handle_t;
26 typedef unsigned pps_seq_t;
28 typedef struct ntp_fp {
29 unsigned int integral;
30 unsigned int fractional;
33 typedef union pps_timeu {
34 struct timespec tspec;
36 unsigned long longpad[3];
40 pps_seq_t assert_sequence; /* assert event seq # */
41 pps_seq_t clear_sequence; /* clear event seq # */
42 pps_timeu_t assert_tu;
44 int current_mode; /* current mode bits */
47 #define assert_timestamp assert_tu.tspec
48 #define clear_timestamp clear_tu.tspec
50 #define assert_timestamp_ntpfp assert_tu.ntpfp
51 #define clear_timestamp_ntpfp clear_tu.ntpfp
54 int api_version; /* API version # */
55 int mode; /* mode bits */
56 pps_timeu_t assert_off_tu;
57 pps_timeu_t clear_off_tu;
60 #define assert_offset assert_off_tu.tspec
61 #define clear_offset clear_off_tu.tspec
63 #define assert_offset_ntpfp assert_off_tu.ntpfp
64 #define clear_offset_ntpfp clear_off_tu.ntpfp
67 #define PPS_CAPTUREASSERT 0x01
68 #define PPS_CAPTURECLEAR 0x02
69 #define PPS_CAPTUREBOTH 0x03
71 #define PPS_OFFSETASSERT 0x10
72 #define PPS_OFFSETCLEAR 0x20
74 #define PPS_ECHOASSERT 0x40
75 #define PPS_ECHOCLEAR 0x80
77 #define PPS_CANWAIT 0x100
78 #define PPS_CANPOLL 0x200
80 #define PPS_TSFMT_TSPEC 0x1000
81 #define PPS_TSFMT_NTPFP 0x2000
83 #define PPS_KC_HARDPPS 0
84 #define PPS_KC_HARDPPS_PLL 1
85 #define PPS_KC_HARDPPS_FLL 2
87 struct pps_fetch_args {
89 pps_info_t pps_info_buf;
90 struct timespec timeout;
93 struct pps_kcbind_args {
99 #define PPS_IOC_CREATE _IO('1', 1)
100 #define PPS_IOC_DESTROY _IO('1', 2)
101 #define PPS_IOC_SETPARAMS _IOW('1', 3, pps_params_t)
102 #define PPS_IOC_GETPARAMS _IOR('1', 4, pps_params_t)
103 #define PPS_IOC_GETCAP _IOR('1', 5, int)
104 #define PPS_IOC_FETCH _IOWR('1', 6, struct pps_fetch_args)
105 #define PPS_IOC_KCBIND _IOW('1', 7, struct pps_kcbind_args)
109 pps_params_t ppsparam;
113 sysclock_t ppscount[3];
116 void pps_event (struct pps_state *pps, sysclock_t count, int event);
117 void pps_init (struct pps_state *pps);
118 int pps_ioctl (u_long cmd, caddr_t data, struct pps_state *pps);
119 void hardpps (struct timespec *tsp, long nsec);
124 time_pps_create(int filedes, pps_handle_t *handle)
129 error = ioctl(filedes, PPS_IOC_CREATE, 0);
137 time_pps_destroy(pps_handle_t handle)
139 return (ioctl(handle, PPS_IOC_DESTROY, 0));
143 time_pps_setparams(pps_handle_t handle, const pps_params_t *ppsparams)
145 return (ioctl(handle, PPS_IOC_SETPARAMS, ppsparams));
149 time_pps_getparams(pps_handle_t handle, pps_params_t *ppsparams)
151 return (ioctl(handle, PPS_IOC_GETPARAMS, ppsparams));
155 time_pps_getcap(pps_handle_t handle, int *mode)
157 return (ioctl(handle, PPS_IOC_GETCAP, mode));
161 time_pps_fetch(pps_handle_t handle, const int tsformat,
162 pps_info_t *ppsinfobuf, const struct timespec *timeout)
165 struct pps_fetch_args arg;
167 arg.tsformat = tsformat;
168 if (timeout == NULL) {
169 arg.timeout.tv_sec = -1;
170 arg.timeout.tv_nsec = -1;
172 arg.timeout = *timeout;
173 error = ioctl(handle, PPS_IOC_FETCH, &arg);
174 *ppsinfobuf = arg.pps_info_buf;
179 time_pps_kcbind(pps_handle_t handle, const int kernel_consumer,
180 const int edge, const int tsformat)
182 struct pps_kcbind_args arg;
184 arg.kernel_consumer = kernel_consumer;
186 arg.tsformat = tsformat;
187 return (ioctl(handle, PPS_IOC_KCBIND, &arg));
190 #endif /* !_KERNEL */
191 #endif /* _SYS_TIMEPPS_H_ */