xref: /linux/include/uapi/linux/timex.h (revision 8dd06ef34b6e2f41b29fbf5fc1663780f2524285)
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 _UAPI_LINUX_TIMEX_H
54 #define _UAPI_LINUX_TIMEX_H
55 
56 #include <linux/time.h>
57 
58 #define NTP_API		4	/* NTP API version */
59 
60 #ifndef __KERNEL__
61 /*
62  * syscall interface - used (mainly by NTP daemon)
63  * to discipline kernel clock oscillator
64  */
65 struct timex {
66 	unsigned int modes;	/* mode selector */
67 	__kernel_long_t offset;	/* time offset (usec) */
68 	__kernel_long_t freq;	/* frequency offset (scaled ppm) */
69 	__kernel_long_t maxerror;/* maximum error (usec) */
70 	__kernel_long_t esterror;/* estimated error (usec) */
71 	int status;		/* clock command/status */
72 	__kernel_long_t constant;/* pll time constant */
73 	__kernel_long_t precision;/* clock precision (usec) (read only) */
74 	__kernel_long_t tolerance;/* clock frequency tolerance (ppm)
75 				   * (read only)
76 				   */
77 	struct timeval time;	/* (read only, except for ADJ_SETOFFSET) */
78 	__kernel_long_t tick;	/* (modified) usecs between clock ticks */
79 
80 	__kernel_long_t ppsfreq;/* pps frequency (scaled ppm) (ro) */
81 	__kernel_long_t jitter; /* pps jitter (us) (ro) */
82 	int shift;              /* interval duration (s) (shift) (ro) */
83 	__kernel_long_t stabil;            /* pps stability (scaled ppm) (ro) */
84 	__kernel_long_t jitcnt; /* jitter limit exceeded (ro) */
85 	__kernel_long_t calcnt; /* calibration intervals (ro) */
86 	__kernel_long_t errcnt; /* calibration errors (ro) */
87 	__kernel_long_t stbcnt; /* stability limit exceeded (ro) */
88 
89 	int tai;		/* TAI offset (ro) */
90 
91 	int  :32; int  :32; int  :32; int  :32;
92 	int  :32; int  :32; int  :32; int  :32;
93 	int  :32; int  :32; int  :32;
94 };
95 #endif
96 
97 struct __kernel_timex_timeval {
98 	__kernel_time64_t       tv_sec;
99 	long long		tv_usec;
100 };
101 
102 struct __kernel_timex {
103 	unsigned int modes;	/* mode selector */
104 	int :32;            /* pad */
105 	long long offset;	/* time offset (usec) */
106 	long long freq;	/* frequency offset (scaled ppm) */
107 	long long maxerror;/* maximum error (usec) */
108 	long long esterror;/* estimated error (usec) */
109 	int status;		/* clock command/status */
110 	int :32;            /* pad */
111 	long long constant;/* pll time constant */
112 	long long precision;/* clock precision (usec) (read only) */
113 	long long tolerance;/* clock frequency tolerance (ppm)
114 				   * (read only)
115 				   */
116 	struct __kernel_timex_timeval time;	/* (read only, except for ADJ_SETOFFSET) */
117 	long long tick;	/* (modified) usecs between clock ticks */
118 
119 	long long ppsfreq;/* pps frequency (scaled ppm) (ro) */
120 	long long jitter; /* pps jitter (us) (ro) */
121 	int shift;              /* interval duration (s) (shift) (ro) */
122 	int :32;            /* pad */
123 	long long stabil;            /* pps stability (scaled ppm) (ro) */
124 	long long jitcnt; /* jitter limit exceeded (ro) */
125 	long long calcnt; /* calibration intervals (ro) */
126 	long long errcnt; /* calibration errors (ro) */
127 	long long stbcnt; /* stability limit exceeded (ro) */
128 
129 	int tai;		/* TAI offset (ro) */
130 
131 	int  :32; int  :32; int  :32; int  :32;
132 	int  :32; int  :32; int  :32; int  :32;
133 	int  :32; int  :32; int  :32;
134 };
135 
136 /*
137  * Mode codes (timex.mode)
138  */
139 #define ADJ_OFFSET		0x0001	/* time offset */
140 #define ADJ_FREQUENCY		0x0002	/* frequency offset */
141 #define ADJ_MAXERROR		0x0004	/* maximum time error */
142 #define ADJ_ESTERROR		0x0008	/* estimated time error */
143 #define ADJ_STATUS		0x0010	/* clock status */
144 #define ADJ_TIMECONST		0x0020	/* pll time constant */
145 #define ADJ_TAI			0x0080	/* set TAI offset */
146 #define ADJ_SETOFFSET		0x0100  /* add 'time' to current time */
147 #define ADJ_MICRO		0x1000	/* select microsecond resolution */
148 #define ADJ_NANO		0x2000	/* select nanosecond resolution */
149 #define ADJ_TICK		0x4000	/* tick value */
150 
151 #ifndef __KERNEL__
152 #define ADJ_OFFSET_SINGLESHOT	0x8001	/* old-fashioned adjtime */
153 #define ADJ_OFFSET_SS_READ	0xa001	/* read-only adjtime */
154 #endif
155 
156 /* NTP userland likes the MOD_ prefix better */
157 #define MOD_OFFSET	ADJ_OFFSET
158 #define MOD_FREQUENCY	ADJ_FREQUENCY
159 #define MOD_MAXERROR	ADJ_MAXERROR
160 #define MOD_ESTERROR	ADJ_ESTERROR
161 #define MOD_STATUS	ADJ_STATUS
162 #define MOD_TIMECONST	ADJ_TIMECONST
163 #define MOD_TAI	ADJ_TAI
164 #define MOD_MICRO	ADJ_MICRO
165 #define MOD_NANO	ADJ_NANO
166 
167 
168 /*
169  * Status codes (timex.status)
170  */
171 #define STA_PLL		0x0001	/* enable PLL updates (rw) */
172 #define STA_PPSFREQ	0x0002	/* enable PPS freq discipline (rw) */
173 #define STA_PPSTIME	0x0004	/* enable PPS time discipline (rw) */
174 #define STA_FLL		0x0008	/* select frequency-lock mode (rw) */
175 
176 #define STA_INS		0x0010	/* insert leap (rw) */
177 #define STA_DEL		0x0020	/* delete leap (rw) */
178 #define STA_UNSYNC	0x0040	/* clock unsynchronized (rw) */
179 #define STA_FREQHOLD	0x0080	/* hold frequency (rw) */
180 
181 #define STA_PPSSIGNAL	0x0100	/* PPS signal present (ro) */
182 #define STA_PPSJITTER	0x0200	/* PPS signal jitter exceeded (ro) */
183 #define STA_PPSWANDER	0x0400	/* PPS signal wander exceeded (ro) */
184 #define STA_PPSERROR	0x0800	/* PPS signal calibration error (ro) */
185 
186 #define STA_CLOCKERR	0x1000	/* clock hardware fault (ro) */
187 #define STA_NANO	0x2000	/* resolution (0 = us, 1 = ns) (ro) */
188 #define STA_MODE	0x4000	/* mode (0 = PLL, 1 = FLL) (ro) */
189 #define STA_CLK		0x8000	/* clock source (0 = A, 1 = B) (ro) */
190 
191 /* read-only bits */
192 #define STA_RONLY (STA_PPSSIGNAL | STA_PPSJITTER | STA_PPSWANDER | \
193 	STA_PPSERROR | STA_CLOCKERR | STA_NANO | STA_MODE | STA_CLK)
194 
195 /*
196  * Clock states (time_state)
197  */
198 #define TIME_OK		0	/* clock synchronized, no leap second */
199 #define TIME_INS	1	/* insert leap second */
200 #define TIME_DEL	2	/* delete leap second */
201 #define TIME_OOP	3	/* leap second in progress */
202 #define TIME_WAIT	4	/* leap second has occurred */
203 #define TIME_ERROR	5	/* clock not synchronized */
204 #define TIME_BAD	TIME_ERROR /* bw compat */
205 
206 
207 #endif /* _UAPI_LINUX_TIMEX_H */
208