1/*- 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 * ---------------------------------------------------------------------------- 8 * 9 * Copyright (c) 2011 The FreeBSD Foundation 10 * All rights reserved. 11 * 12 * Portions of this software were developed by Julien Ridoux at the University 13 * of Melbourne under sponsorship from the FreeBSD Foundation. 14 * 15 * $FreeBSD$ 16 * 17 * The is a FreeBSD version of the RFC 2783 API for Pulse Per Second 18 * timing interfaces. 19 */ 20 21#ifndef _SYS_TIMEPPS_H_ 22#define _SYS_TIMEPPS_H_ 23 24#include <sys/_ffcounter.h> 25#include <sys/ioccom.h> 26#include <sys/time.h> 27 28#define PPS_API_VERS_1 1 29 30typedef int pps_handle_t; 31 32typedef unsigned pps_seq_t; 33 34typedef struct ntp_fp { 35 unsigned int integral; 36 unsigned int fractional; 37} ntp_fp_t; 38 39typedef union pps_timeu { 40 struct timespec tspec; 41 ntp_fp_t ntpfp; 42 unsigned long longpad[3]; 43} pps_timeu_t; 44 45typedef struct { 46 pps_seq_t assert_sequence; /* assert event seq # */ 47 pps_seq_t clear_sequence; /* clear event seq # */ 48 pps_timeu_t assert_tu; 49 pps_timeu_t clear_tu; 50 int current_mode; /* current mode bits */ 51} pps_info_t; 52 53typedef struct { 54 pps_seq_t assert_sequence; /* assert event seq # */ 55 pps_seq_t clear_sequence; /* clear event seq # */ 56 pps_timeu_t assert_tu; 57 pps_timeu_t clear_tu; 58 ffcounter assert_ffcount; /* ffcounter on assert event */ 59 ffcounter clear_ffcount; /* ffcounter on clear event */ 60 int current_mode; /* current mode bits */ 61} pps_info_ffc_t; 62 63#define assert_timestamp assert_tu.tspec 64#define clear_timestamp clear_tu.tspec 65 66#define assert_timestamp_ntpfp assert_tu.ntpfp 67#define clear_timestamp_ntpfp clear_tu.ntpfp 68 69typedef struct { 70 int api_version; /* API version # */ 71 int mode; /* mode bits */ 72 pps_timeu_t assert_off_tu; 73 pps_timeu_t clear_off_tu; 74} pps_params_t; 75 76#define assert_offset assert_off_tu.tspec 77#define clear_offset clear_off_tu.tspec 78 79#define assert_offset_ntpfp assert_off_tu.ntpfp 80#define clear_offset_ntpfp clear_off_tu.ntpfp 81 82 83#define PPS_CAPTUREASSERT 0x01 84#define PPS_CAPTURECLEAR 0x02 85#define PPS_CAPTUREBOTH 0x03 86 87#define PPS_OFFSETASSERT 0x10 88#define PPS_OFFSETCLEAR 0x20 89 90#define PPS_ECHOASSERT 0x40 91#define PPS_ECHOCLEAR 0x80 92 93#define PPS_CANWAIT 0x100 94#define PPS_CANPOLL 0x200 95 96#define PPS_TSFMT_TSPEC 0x1000 97#define PPS_TSFMT_NTPFP 0x2000 98 99#define PPS_TSCLK_FBCK 0x10000 100#define PPS_TSCLK_FFWD 0x20000 101#define PPS_TSCLK_MASK 0x30000 102 103#define PPS_KC_HARDPPS 0 104#define PPS_KC_HARDPPS_PLL 1 105#define PPS_KC_HARDPPS_FLL 2 106 107struct pps_fetch_args { 108 int tsformat; 109 pps_info_t pps_info_buf; 110 struct timespec timeout; 111}; 112 113struct pps_fetch_ffc_args { 114 int tsformat; 115 pps_info_ffc_t pps_info_buf_ffc; 116 struct timespec timeout; 117}; 118 119struct pps_kcbind_args { 120 int kernel_consumer; 121 int edge; 122 int tsformat; 123}; 124 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) 133 134#ifdef _KERNEL 135 136struct mtx; 137 138#define KCMODE_EDGEMASK 0x03 139#define KCMODE_ABIFLAG 0x80000000 /* Internal use: abi-aware driver. */ 140 141#define PPS_ABI_VERSION 1 142 143#define PPSFLAG_MTX_SPIN 0x01 /* Driver mtx is MTX_SPIN type. */ 144 145struct pps_state { 146 /* Capture information. */ 147 struct timehands *capth; 148 struct fftimehands *capffth; 149 unsigned capgen; 150 unsigned capcount; 151 152 /* State information. */ 153 pps_params_t ppsparam; 154 pps_info_t ppsinfo; 155 pps_info_ffc_t ppsinfo_ffc; 156 int kcmode; 157 int ppscap; 158 struct timecounter *ppstc; 159 unsigned ppscount[3]; 160 /* 161 * The following fields are valid if the driver calls pps_init_abi(). 162 */ 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. */ 166 uint32_t flags; 167}; 168 169void pps_capture(struct pps_state *pps); 170void pps_event(struct pps_state *pps, int event); 171void pps_init(struct pps_state *pps); 172void pps_init_abi(struct pps_state *pps); 173int pps_ioctl(unsigned long cmd, caddr_t data, struct pps_state *pps); 174void hardpps(struct timespec *tsp, long nsec); 175 176#else /* !_KERNEL */ 177 178static __inline int 179time_pps_create(int filedes, pps_handle_t *handle) 180{ 181 int error; 182 183 *handle = -1; 184 error = ioctl(filedes, PPS_IOC_CREATE, 0); 185 if (error < 0) 186 return (-1); 187 *handle = filedes; 188 return (0); 189} 190 191static __inline int 192time_pps_destroy(pps_handle_t handle) 193{ 194 return (ioctl(handle, PPS_IOC_DESTROY, 0)); 195} 196 197static __inline int 198time_pps_setparams(pps_handle_t handle, const pps_params_t *ppsparams) 199{ 200 return (ioctl(handle, PPS_IOC_SETPARAMS, ppsparams)); 201} 202 203static __inline int 204time_pps_getparams(pps_handle_t handle, pps_params_t *ppsparams) 205{ 206 return (ioctl(handle, PPS_IOC_GETPARAMS, ppsparams)); 207} 208 209static __inline int 210time_pps_getcap(pps_handle_t handle, int *mode) 211{ 212 return (ioctl(handle, PPS_IOC_GETCAP, mode)); 213} 214 215static __inline int 216time_pps_fetch(pps_handle_t handle, const int tsformat, 217 pps_info_t *ppsinfobuf, const struct timespec *timeout) 218{ 219 int error; 220 struct pps_fetch_args arg; 221 222 arg.tsformat = tsformat; 223 if (timeout == NULL) { 224 arg.timeout.tv_sec = -1; 225 arg.timeout.tv_nsec = -1; 226 } else 227 arg.timeout = *timeout; 228 error = ioctl(handle, PPS_IOC_FETCH, &arg); 229 *ppsinfobuf = arg.pps_info_buf; 230 return (error); 231} 232 233static __inline int 234time_pps_fetch_ffc(pps_handle_t handle, const int tsformat, 235 pps_info_ffc_t *ppsinfobuf, const struct timespec *timeout) 236{ 237 struct pps_fetch_ffc_args arg; 238 int error; 239 240 arg.tsformat = tsformat; 241 if (timeout == NULL) { 242 arg.timeout.tv_sec = -1; 243 arg.timeout.tv_nsec = -1; 244 } else { 245 arg.timeout = *timeout; 246 } 247 error = ioctl(handle, PPS_IOC_FETCH_FFCOUNTER, &arg); 248 *ppsinfobuf = arg.pps_info_buf_ffc; 249 return (error); 250} 251 252static __inline int 253time_pps_kcbind(pps_handle_t handle, const int kernel_consumer, 254 const int edge, const int tsformat) 255{ 256 struct pps_kcbind_args arg; 257 258 arg.kernel_consumer = kernel_consumer; 259 arg.edge = edge; 260 arg.tsformat = tsformat; 261 return (ioctl(handle, PPS_IOC_KCBIND, &arg)); 262} 263 264#endif /* KERNEL */ 265 266#endif /* !_SYS_TIMEPPS_H_ */ 267