timex.h (7816B) - Raw
1 /***************************************************************************** 2 * * 3 * Copyright (c) David L. Mills 1993 * 4 * * 5 * Permission to use, copy, modify, and distribute this software and its * 6 * documentation for any purpose and without fee is hereby granted, provided * 7 * that the above copyright notice appears in all copies and that both the * 8 * copyright notice and this permission notice appear in supporting * 9 * documentation, and that the name University of Delaware not be used in * 10 * advertising or publicity pertaining to distribution of the software * 11 * without specific, written prior permission. The University of Delaware * 12 * makes no representations about the suitability this software for any * 13 * purpose. It is provided "as is" without express or implied warranty. * 14 * * 15 *****************************************************************************/ 16 17 /* 18 * Modification history timex.h 19 * 20 * 29 Dec 97 Russell King 21 * Moved CLOCK_TICK_RATE, CLOCK_TICK_FACTOR and FINETUNE to asm/timex.h 22 * for ARM machines 23 * 24 * 9 Jan 97 Adrian Sun 25 * Shifted LATCH define to allow access to alpha machines. 26 * 27 * 26 Sep 94 David L. Mills 28 * Added defines for hybrid phase/frequency-lock loop. 29 * 30 * 19 Mar 94 David L. Mills 31 * Moved defines from kernel routines to header file and added new 32 * defines for PPS phase-lock loop. 33 * 34 * 20 Feb 94 David L. Mills 35 * Revised status codes and structures for external clock and PPS 36 * signal discipline. 37 * 38 * 28 Nov 93 David L. Mills 39 * Adjusted parameters to improve stability and increase poll 40 * interval. 41 * 42 * 17 Sep 93 David L. Mills 43 * Created file $NTP/include/sys/timex.h 44 * 07 Oct 93 Torsten Duwe 45 * Derived linux/timex.h 46 * 1995-08-13 Torsten Duwe 47 * kernel PLL updated to 1994-12-13 specs (rfc-1589) 48 * 1997-08-30 Ulrich Windl 49 * Added new constant NTP_PHASE_LIMIT 50 * 2004-08-12 Christoph Lameter 51 * Reworked time interpolation logic 52 */ 53 #ifndef _LINUX_TIMEX_H 54 #define _LINUX_TIMEX_H 55 56 #include <linux/time.h> 57 58 #define NTP_API 4 /* NTP API version */ 59 60 /* 61 * syscall interface - used (mainly by NTP daemon) 62 * to discipline kernel clock oscillator 63 */ 64 struct timex { 65 unsigned int modes; /* mode selector */ 66 __kernel_long_t offset; /* time offset (usec) */ 67 __kernel_long_t freq; /* frequency offset (scaled ppm) */ 68 __kernel_long_t maxerror;/* maximum error (usec) */ 69 __kernel_long_t esterror;/* estimated error (usec) */ 70 int status; /* clock command/status */ 71 __kernel_long_t constant;/* pll time constant */ 72 __kernel_long_t precision;/* clock precision (usec) (read only) */ 73 __kernel_long_t tolerance;/* clock frequency tolerance (ppm) 74 * (read only) 75 */ 76 struct timeval time; /* (read only, except for ADJ_SETOFFSET) */ 77 __kernel_long_t tick; /* (modified) usecs between clock ticks */ 78 79 __kernel_long_t ppsfreq;/* pps frequency (scaled ppm) (ro) */ 80 __kernel_long_t jitter; /* pps jitter (us) (ro) */ 81 int shift; /* interval duration (s) (shift) (ro) */ 82 __kernel_long_t stabil; /* pps stability (scaled ppm) (ro) */ 83 __kernel_long_t jitcnt; /* jitter limit exceeded (ro) */ 84 __kernel_long_t calcnt; /* calibration intervals (ro) */ 85 __kernel_long_t errcnt; /* calibration errors (ro) */ 86 __kernel_long_t stbcnt; /* stability limit exceeded (ro) */ 87 88 int tai; /* TAI offset (ro) */ 89 90 int :32; int :32; int :32; int :32; 91 int :32; int :32; int :32; int :32; 92 int :32; int :32; int :32; 93 }; 94 95 struct __kernel_timex_timeval { 96 __kernel_time64_t tv_sec; 97 long long tv_usec; 98 }; 99 100 struct __kernel_timex { 101 unsigned int modes; /* mode selector */ 102 int :32; /* pad */ 103 long long offset; /* time offset (usec) */ 104 long long freq; /* frequency offset (scaled ppm) */ 105 long long maxerror;/* maximum error (usec) */ 106 long long esterror;/* estimated error (usec) */ 107 int status; /* clock command/status */ 108 int :32; /* pad */ 109 long long constant;/* pll time constant */ 110 long long precision;/* clock precision (usec) (read only) */ 111 long long tolerance;/* clock frequency tolerance (ppm) 112 * (read only) 113 */ 114 struct __kernel_timex_timeval time; /* (read only, except for ADJ_SETOFFSET) */ 115 long long tick; /* (modified) usecs between clock ticks */ 116 117 long long ppsfreq;/* pps frequency (scaled ppm) (ro) */ 118 long long jitter; /* pps jitter (us) (ro) */ 119 int shift; /* interval duration (s) (shift) (ro) */ 120 int :32; /* pad */ 121 long long stabil; /* pps stability (scaled ppm) (ro) */ 122 long long jitcnt; /* jitter limit exceeded (ro) */ 123 long long calcnt; /* calibration intervals (ro) */ 124 long long errcnt; /* calibration errors (ro) */ 125 long long stbcnt; /* stability limit exceeded (ro) */ 126 127 int tai; /* TAI offset (ro) */ 128 129 int :32; int :32; int :32; int :32; 130 int :32; int :32; int :32; int :32; 131 int :32; int :32; int :32; 132 }; 133 134 /* 135 * Mode codes (timex.mode) 136 */ 137 #define ADJ_OFFSET 0x0001 /* time offset */ 138 #define ADJ_FREQUENCY 0x0002 /* frequency offset */ 139 #define ADJ_MAXERROR 0x0004 /* maximum time error */ 140 #define ADJ_ESTERROR 0x0008 /* estimated time error */ 141 #define ADJ_STATUS 0x0010 /* clock status */ 142 #define ADJ_TIMECONST 0x0020 /* pll time constant */ 143 #define ADJ_TAI 0x0080 /* set TAI offset */ 144 #define ADJ_SETOFFSET 0x0100 /* add 'time' to current time */ 145 #define ADJ_MICRO 0x1000 /* select microsecond resolution */ 146 #define ADJ_NANO 0x2000 /* select nanosecond resolution */ 147 #define ADJ_TICK 0x4000 /* tick value */ 148 149 #define ADJ_OFFSET_SINGLESHOT 0x8001 /* old-fashioned adjtime */ 150 #define ADJ_OFFSET_SS_READ 0xa001 /* read-only adjtime */ 151 152 /* NTP userland likes the MOD_ prefix better */ 153 #define MOD_OFFSET ADJ_OFFSET 154 #define MOD_FREQUENCY ADJ_FREQUENCY 155 #define MOD_MAXERROR ADJ_MAXERROR 156 #define MOD_ESTERROR ADJ_ESTERROR 157 #define MOD_STATUS ADJ_STATUS 158 #define MOD_TIMECONST ADJ_TIMECONST 159 #define MOD_TAI ADJ_TAI 160 #define MOD_MICRO ADJ_MICRO 161 #define MOD_NANO ADJ_NANO 162 163 164 /* 165 * Status codes (timex.status) 166 */ 167 #define STA_PLL 0x0001 /* enable PLL updates (rw) */ 168 #define STA_PPSFREQ 0x0002 /* enable PPS freq discipline (rw) */ 169 #define STA_PPSTIME 0x0004 /* enable PPS time discipline (rw) */ 170 #define STA_FLL 0x0008 /* select frequency-lock mode (rw) */ 171 172 #define STA_INS 0x0010 /* insert leap (rw) */ 173 #define STA_DEL 0x0020 /* delete leap (rw) */ 174 #define STA_UNSYNC 0x0040 /* clock unsynchronized (rw) */ 175 #define STA_FREQHOLD 0x0080 /* hold frequency (rw) */ 176 177 #define STA_PPSSIGNAL 0x0100 /* PPS signal present (ro) */ 178 #define STA_PPSJITTER 0x0200 /* PPS signal jitter exceeded (ro) */ 179 #define STA_PPSWANDER 0x0400 /* PPS signal wander exceeded (ro) */ 180 #define STA_PPSERROR 0x0800 /* PPS signal calibration error (ro) */ 181 182 #define STA_CLOCKERR 0x1000 /* clock hardware fault (ro) */ 183 #define STA_NANO 0x2000 /* resolution (0 = us, 1 = ns) (ro) */ 184 #define STA_MODE 0x4000 /* mode (0 = PLL, 1 = FLL) (ro) */ 185 #define STA_CLK 0x8000 /* clock source (0 = A, 1 = B) (ro) */ 186 187 /* read-only bits */ 188 #define STA_RONLY (STA_PPSSIGNAL | STA_PPSJITTER | STA_PPSWANDER | \ 189 STA_PPSERROR | STA_CLOCKERR | STA_NANO | STA_MODE | STA_CLK) 190 191 /* 192 * Clock states (time_state) 193 */ 194 #define TIME_OK 0 /* clock synchronized, no leap second */ 195 #define TIME_INS 1 /* insert leap second */ 196 #define TIME_DEL 2 /* delete leap second */ 197 #define TIME_OOP 3 /* leap second in progress */ 198 #define TIME_WAIT 4 /* leap second has occurred */ 199 #define TIME_ERROR 5 /* clock not synchronized */ 200 #define TIME_BAD TIME_ERROR /* bw compat */ 201 202 203 #endif /* _LINUX_TIMEX_H */