summaryrefslogtreecommitdiff
path: root/include/arch/x86_64/linux/timex.h
blob: 64c9a14e911b02c39ef15dd81a6b5141d5a8e12b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
/*****************************************************************************
 *                                                                           *
 * Copyright (c) David L. Mills 1993                                         *
 *                                                                           *
 * Permission to use, copy, modify, and distribute this software and its     *
 * documentation for any purpose and without fee is hereby granted, provided *
 * that the above copyright notice appears in all copies and that both the   *
 * copyright notice and this permission notice appear in supporting          *
 * documentation, and that the name University of Delaware not be used in    *
 * advertising or publicity pertaining to distribution of the software       *
 * without specific, written prior permission.  The University of Delaware   *
 * makes no representations about the suitability this software for any      *
 * purpose.  It is provided "as is" without express or implied warranty.     *
 *                                                                           *
 *****************************************************************************/

/*
 * Modification history timex.h
 *
 * 29 Dec 97	Russell King
 *	Moved CLOCK_TICK_RATE, CLOCK_TICK_FACTOR and FINETUNE to asm/timex.h
 *	for ARM machines
 *
 *  9 Jan 97    Adrian Sun
 *      Shifted LATCH define to allow access to alpha machines.
 *
 * 26 Sep 94	David L. Mills
 *	Added defines for hybrid phase/frequency-lock loop.
 *
 * 19 Mar 94	David L. Mills
 *	Moved defines from kernel routines to header file and added new
 *	defines for PPS phase-lock loop.
 *
 * 20 Feb 94	David L. Mills
 *	Revised status codes and structures for external clock and PPS
 *	signal discipline.
 *
 * 28 Nov 93	David L. Mills
 *	Adjusted parameters to improve stability and increase poll
 *	interval.
 *
 * 17 Sep 93    David L. Mills
 *      Created file $NTP/include/sys/timex.h
 * 07 Oct 93    Torsten Duwe
 *      Derived linux/timex.h
 * 1995-08-13    Torsten Duwe
 *      kernel PLL updated to 1994-12-13 specs (rfc-1589)
 * 1997-08-30    Ulrich Windl
 *      Added new constant NTP_PHASE_LIMIT
 * 2004-08-12    Christoph Lameter
 *      Reworked time interpolation logic
 */
#ifndef _LINUX_TIMEX_H
#define _LINUX_TIMEX_H

#include <linux/time.h>

#define NTP_API 4 /* NTP API version */

/*
 * syscall interface - used (mainly by NTP daemon)
 * to discipline kernel clock oscillator
 */
struct timex {
	unsigned int modes;	   /* mode selector */
	__kernel_long_t offset;	   /* time offset (usec) */
	__kernel_long_t freq;	   /* frequency offset (scaled ppm) */
	__kernel_long_t maxerror;  /* maximum error (usec) */
	__kernel_long_t esterror;  /* estimated error (usec) */
	int status;		   /* clock command/status */
	__kernel_long_t constant;  /* pll time constant */
	__kernel_long_t precision; /* clock precision (usec) (read only) */
	__kernel_long_t tolerance; /* clock frequency tolerance (ppm)
				    * (read only)
				    */
	struct timeval time;	   /* (read only, except for ADJ_SETOFFSET) */
	__kernel_long_t tick;	   /* (modified) usecs between clock ticks */

	__kernel_long_t ppsfreq; /* pps frequency (scaled ppm) (ro) */
	__kernel_long_t jitter;	 /* pps jitter (us) (ro) */
	int shift;		 /* interval duration (s) (shift) (ro) */
	__kernel_long_t stabil;	 /* pps stability (scaled ppm) (ro) */
	__kernel_long_t jitcnt;	 /* jitter limit exceeded (ro) */
	__kernel_long_t calcnt;	 /* calibration intervals (ro) */
	__kernel_long_t errcnt;	 /* calibration errors (ro) */
	__kernel_long_t stbcnt;	 /* stability limit exceeded (ro) */

	int tai; /* TAI offset (ro) */

	int : 32;
	int : 32;
	int : 32;
	int : 32;
	int : 32;
	int : 32;
	int : 32;
	int : 32;
	int : 32;
	int : 32;
	int : 32;
};

struct __kernel_timex_timeval {
	__kernel_time64_t tv_sec;
	long long tv_usec;
};

struct __kernel_timex {
	unsigned int modes;		    /* mode selector */
	int : 32;			    /* pad */
	long long offset;		    /* time offset (usec) */
	long long freq;			    /* frequency offset (scaled ppm) */
	long long maxerror;		    /* maximum error (usec) */
	long long esterror;		    /* estimated error (usec) */
	int status;			    /* clock command/status */
	int : 32;			    /* pad */
	long long constant;		    /* pll time constant */
	long long precision;		    /* clock precision (usec) (read only) */
	long long tolerance;		    /* clock frequency tolerance (ppm)
					     * (read only)
					     */
	struct __kernel_timex_timeval time; /* (read only, except for
					       ADJ_SETOFFSET) */
	long long tick;			    /* (modified) usecs between clock ticks */

	long long ppsfreq; /* pps frequency (scaled ppm) (ro) */
	long long jitter;  /* pps jitter (us) (ro) */
	int shift;	   /* interval duration (s) (shift) (ro) */
	int : 32;	   /* pad */
	long long stabil;  /* pps stability (scaled ppm) (ro) */
	long long jitcnt;  /* jitter limit exceeded (ro) */
	long long calcnt;  /* calibration intervals (ro) */
	long long errcnt;  /* calibration errors (ro) */
	long long stbcnt;  /* stability limit exceeded (ro) */

	int tai; /* TAI offset (ro) */

	int : 32;
	int : 32;
	int : 32;
	int : 32;
	int : 32;
	int : 32;
	int : 32;
	int : 32;
	int : 32;
	int : 32;
	int : 32;
};

/*
 * Mode codes (timex.mode)
 */
#define ADJ_OFFSET    0x0001 /* time offset */
#define ADJ_FREQUENCY 0x0002 /* frequency offset */
#define ADJ_MAXERROR  0x0004 /* maximum time error */
#define ADJ_ESTERROR  0x0008 /* estimated time error */
#define ADJ_STATUS    0x0010 /* clock status */
#define ADJ_TIMECONST 0x0020 /* pll time constant */
#define ADJ_TAI	      0x0080 /* set TAI offset */
#define ADJ_SETOFFSET 0x0100 /* add 'time' to current time */
#define ADJ_MICRO     0x1000 /* select microsecond resolution */
#define ADJ_NANO      0x2000 /* select nanosecond resolution */
#define ADJ_TICK      0x4000 /* tick value */

#define ADJ_OFFSET_SINGLESHOT 0x8001 /* old-fashioned adjtime */
#define ADJ_OFFSET_SS_READ    0xa001 /* read-only adjtime */

/* NTP userland likes the MOD_ prefix better */
#define MOD_OFFSET    ADJ_OFFSET
#define MOD_FREQUENCY ADJ_FREQUENCY
#define MOD_MAXERROR  ADJ_MAXERROR
#define MOD_ESTERROR  ADJ_ESTERROR
#define MOD_STATUS    ADJ_STATUS
#define MOD_TIMECONST ADJ_TIMECONST
#define MOD_TAI	      ADJ_TAI
#define MOD_MICRO     ADJ_MICRO
#define MOD_NANO      ADJ_NANO

/*
 * Status codes (timex.status)
 */
#define STA_PLL	    0x0001 /* enable PLL updates (rw) */
#define STA_PPSFREQ 0x0002 /* enable PPS freq discipline (rw) */
#define STA_PPSTIME 0x0004 /* enable PPS time discipline (rw) */
#define STA_FLL	    0x0008 /* select frequency-lock mode (rw) */

#define STA_INS	     0x0010 /* insert leap (rw) */
#define STA_DEL	     0x0020 /* delete leap (rw) */
#define STA_UNSYNC   0x0040 /* clock unsynchronized (rw) */
#define STA_FREQHOLD 0x0080 /* hold frequency (rw) */

#define STA_PPSSIGNAL 0x0100 /* PPS signal present (ro) */
#define STA_PPSJITTER 0x0200 /* PPS signal jitter exceeded (ro) */
#define STA_PPSWANDER 0x0400 /* PPS signal wander exceeded (ro) */
#define STA_PPSERROR  0x0800 /* PPS signal calibration error (ro) */

#define STA_CLOCKERR 0x1000 /* clock hardware fault (ro) */
#define STA_NANO     0x2000 /* resolution (0 = us, 1 = ns) (ro) */
#define STA_MODE     0x4000 /* mode (0 = PLL, 1 = FLL) (ro) */
#define STA_CLK	     0x8000 /* clock source (0 = A, 1 = B) (ro) */

/* read-only bits */
#define STA_RONLY \
	(STA_PPSSIGNAL | STA_PPSJITTER | STA_PPSWANDER | STA_PPSERROR | STA_CLOCKERR | STA_NANO | STA_MODE | STA_CLK)

/*
 * Clock states (time_state)
 */
#define TIME_OK	   0	      /* clock synchronized, no leap second */
#define TIME_INS   1	      /* insert leap second */
#define TIME_DEL   2	      /* delete leap second */
#define TIME_OOP   3	      /* leap second in progress */
#define TIME_WAIT  4	      /* leap second has occurred */
#define TIME_ERROR 5	      /* clock not synchronized */
#define TIME_BAD   TIME_ERROR /* bw compat */

#endif /* _LINUX_TIMEX_H */