2 * linux/kernel/time/ntp.c
4 * NTP state machine interfaces and logic.
6 * This code was mainly moved from kernel/timer.c and kernel/time.c
7 * Please see those files for relevant copyright info and historical
12 #include <linux/time.h>
13 #include <linux/timex.h>
14 #include <linux/jiffies.h>
15 #include <linux/hrtimer.h>
16 #include <linux/capability.h>
17 #include <asm/div64.h>
18 #include <asm/timex.h>
21 * Timekeeping variables
23 unsigned long tick_usec
= TICK_USEC
; /* USER_HZ period (usec) */
24 unsigned long tick_nsec
; /* ACTHZ period (nsec) */
25 static u64 tick_length
, tick_length_base
;
27 #define MAX_TICKADJ 500 /* microsecs */
28 #define MAX_TICKADJ_SCALED (((u64)(MAX_TICKADJ * NSEC_PER_USEC) << \
29 TICK_LENGTH_SHIFT) / NTP_INTERVAL_FREQ)
32 * phase-lock loop variables
34 /* TIME_ERROR prevents overwriting the CMOS clock */
35 static int time_state
= TIME_OK
; /* clock synchronization status */
36 int time_status
= STA_UNSYNC
; /* clock status bits */
37 static s64 time_offset
; /* time adjustment (ns) */
38 static long time_constant
= 2; /* pll time constant */
39 long time_maxerror
= NTP_PHASE_LIMIT
; /* maximum error (us) */
40 long time_esterror
= NTP_PHASE_LIMIT
; /* estimated error (us) */
41 long time_freq
; /* frequency offset (scaled ppm)*/
42 static long time_reftime
; /* time at last adjustment (s) */
45 #define CLOCK_TICK_OVERFLOW (LATCH * HZ - CLOCK_TICK_RATE)
46 #define CLOCK_TICK_ADJUST (((s64)CLOCK_TICK_OVERFLOW * NSEC_PER_SEC) / \
49 static void ntp_update_frequency(void)
51 u64 second_length
= (u64
)(tick_usec
* NSEC_PER_USEC
* USER_HZ
)
53 second_length
+= (s64
)CLOCK_TICK_ADJUST
<< TICK_LENGTH_SHIFT
;
54 second_length
+= (s64
)time_freq
<< (TICK_LENGTH_SHIFT
- SHIFT_NSEC
);
56 tick_length_base
= second_length
;
58 do_div(second_length
, HZ
);
59 tick_nsec
= second_length
>> TICK_LENGTH_SHIFT
;
61 do_div(tick_length_base
, NTP_INTERVAL_FREQ
);
65 * ntp_clear - Clears the NTP state variables
67 * Must be called while holding a write on the xtime_lock
71 time_adjust
= 0; /* stop active adjtime() */
72 time_status
|= STA_UNSYNC
;
73 time_maxerror
= NTP_PHASE_LIMIT
;
74 time_esterror
= NTP_PHASE_LIMIT
;
76 ntp_update_frequency();
78 tick_length
= tick_length_base
;
83 * this routine handles the overflow of the microsecond field
85 * The tricky bits of code to handle the accurate clock support
86 * were provided by Dave Mills (Mills@UDEL.EDU) of NTP fame.
87 * They were originally developed for SUN and DEC kernels.
88 * All the kudos should go to Dave for this stuff.
90 void second_overflow(void)
94 /* Bump the maxerror field */
95 time_maxerror
+= MAXFREQ
>> SHIFT_USEC
;
96 if (time_maxerror
> NTP_PHASE_LIMIT
) {
97 time_maxerror
= NTP_PHASE_LIMIT
;
98 time_status
|= STA_UNSYNC
;
102 * Leap second processing. If in leap-insert state at the end of the
103 * day, the system clock is set back one second; if in leap-delete
104 * state, the system clock is set ahead one second. The microtime()
105 * routine or external clock driver will insure that reported time is
106 * always monotonic. The ugly divides should be replaced.
108 switch (time_state
) {
110 if (time_status
& STA_INS
)
111 time_state
= TIME_INS
;
112 else if (time_status
& STA_DEL
)
113 time_state
= TIME_DEL
;
116 if (xtime
.tv_sec
% 86400 == 0) {
118 wall_to_monotonic
.tv_sec
++;
119 time_state
= TIME_OOP
;
120 printk(KERN_NOTICE
"Clock: inserting leap second "
125 if ((xtime
.tv_sec
+ 1) % 86400 == 0) {
127 wall_to_monotonic
.tv_sec
--;
128 time_state
= TIME_WAIT
;
129 printk(KERN_NOTICE
"Clock: deleting leap second "
134 time_state
= TIME_WAIT
;
137 if (!(time_status
& (STA_INS
| STA_DEL
)))
138 time_state
= TIME_OK
;
142 * Compute the phase adjustment for the next second. The offset is
143 * reduced by a fixed factor times the time constant.
145 tick_length
= tick_length_base
;
146 time_adj
= shift_right(time_offset
, SHIFT_PLL
+ time_constant
);
147 time_offset
-= time_adj
;
148 tick_length
+= (s64
)time_adj
<< (TICK_LENGTH_SHIFT
- SHIFT_UPDATE
);
150 if (unlikely(time_adjust
)) {
151 if (time_adjust
> MAX_TICKADJ
) {
152 time_adjust
-= MAX_TICKADJ
;
153 tick_length
+= MAX_TICKADJ_SCALED
;
154 } else if (time_adjust
< -MAX_TICKADJ
) {
155 time_adjust
+= MAX_TICKADJ
;
156 tick_length
-= MAX_TICKADJ_SCALED
;
158 tick_length
+= (s64
)(time_adjust
* NSEC_PER_USEC
/
159 NTP_INTERVAL_FREQ
) << TICK_LENGTH_SHIFT
;
166 * Return how long ticks are at the moment, that is, how much time
167 * update_wall_time_one_tick will add to xtime next time we call it
168 * (assuming no calls to do_adjtimex in the meantime).
169 * The return value is in fixed-point nanoseconds shifted by the
170 * specified number of bits to the right of the binary point.
171 * This function has no side-effects.
173 u64
current_tick_length(void)
179 void __attribute__ ((weak
)) notify_arch_cmos_timer(void)
184 /* adjtimex mainly allows reading (and writing, if superuser) of
185 * kernel time-keeping variables. used by xntpd.
187 int do_adjtimex(struct timex
*txc
)
189 long mtemp
, save_adjust
, rem
;
190 s64 freq_adj
, temp64
;
193 /* In order to modify anything, you gotta be super-user! */
194 if (txc
->modes
&& !capable(CAP_SYS_TIME
))
197 /* Now we validate the data before disabling interrupts */
199 if ((txc
->modes
& ADJ_OFFSET_SINGLESHOT
) == ADJ_OFFSET_SINGLESHOT
)
200 /* singleshot must not be used with any other mode bits */
201 if (txc
->modes
!= ADJ_OFFSET_SINGLESHOT
)
204 if (txc
->modes
!= ADJ_OFFSET_SINGLESHOT
&& (txc
->modes
& ADJ_OFFSET
))
205 /* adjustment Offset limited to +- .512 seconds */
206 if (txc
->offset
<= - MAXPHASE
|| txc
->offset
>= MAXPHASE
)
209 /* if the quartz is off by more than 10% something is VERY wrong ! */
210 if (txc
->modes
& ADJ_TICK
)
211 if (txc
->tick
< 900000/USER_HZ
||
212 txc
->tick
> 1100000/USER_HZ
)
215 write_seqlock_irq(&xtime_lock
);
216 result
= time_state
; /* mostly `TIME_OK' */
218 /* Save for later - semantics of adjtime is to return old value */
219 save_adjust
= time_adjust
;
221 #if 0 /* STA_CLOCKERR is never set yet */
222 time_status
&= ~STA_CLOCKERR
; /* reset STA_CLOCKERR */
224 /* If there are input parameters, then process them */
227 if (txc
->modes
& ADJ_STATUS
) /* only set allowed bits */
228 time_status
= (txc
->status
& ~STA_RONLY
) |
229 (time_status
& STA_RONLY
);
231 if (txc
->modes
& ADJ_FREQUENCY
) { /* p. 22 */
232 if (txc
->freq
> MAXFREQ
|| txc
->freq
< -MAXFREQ
) {
236 time_freq
= ((s64
)txc
->freq
* NSEC_PER_USEC
)
237 >> (SHIFT_USEC
- SHIFT_NSEC
);
240 if (txc
->modes
& ADJ_MAXERROR
) {
241 if (txc
->maxerror
< 0 || txc
->maxerror
>= NTP_PHASE_LIMIT
) {
245 time_maxerror
= txc
->maxerror
;
248 if (txc
->modes
& ADJ_ESTERROR
) {
249 if (txc
->esterror
< 0 || txc
->esterror
>= NTP_PHASE_LIMIT
) {
253 time_esterror
= txc
->esterror
;
256 if (txc
->modes
& ADJ_TIMECONST
) { /* p. 24 */
257 if (txc
->constant
< 0) { /* NTP v4 uses values > 6 */
261 time_constant
= min(txc
->constant
+ 4, (long)MAXTC
);
264 if (txc
->modes
& ADJ_OFFSET
) { /* values checked earlier */
265 if (txc
->modes
== ADJ_OFFSET_SINGLESHOT
) {
266 /* adjtime() is independent from ntp_adjtime() */
267 time_adjust
= txc
->offset
;
269 else if (time_status
& STA_PLL
) {
270 time_offset
= txc
->offset
* NSEC_PER_USEC
;
273 * Scale the phase adjustment and
274 * clamp to the operating range.
276 time_offset
= min(time_offset
, (s64
)MAXPHASE
* NSEC_PER_USEC
);
277 time_offset
= max(time_offset
, (s64
)-MAXPHASE
* NSEC_PER_USEC
);
280 * Select whether the frequency is to be controlled
281 * and in which mode (PLL or FLL). Clamp to the operating
282 * range. Ugly multiply/divide should be replaced someday.
285 if (time_status
& STA_FREQHOLD
|| time_reftime
== 0)
286 time_reftime
= xtime
.tv_sec
;
287 mtemp
= xtime
.tv_sec
- time_reftime
;
288 time_reftime
= xtime
.tv_sec
;
290 freq_adj
= time_offset
* mtemp
;
291 freq_adj
= shift_right(freq_adj
, time_constant
* 2 +
292 (SHIFT_PLL
+ 2) * 2 - SHIFT_NSEC
);
293 if (mtemp
>= MINSEC
&& (time_status
& STA_FLL
|| mtemp
> MAXSEC
)) {
294 temp64
= time_offset
<< (SHIFT_NSEC
- SHIFT_FLL
);
295 if (time_offset
< 0) {
297 do_div(temp64
, mtemp
);
300 do_div(temp64
, mtemp
);
304 freq_adj
+= time_freq
;
305 freq_adj
= min(freq_adj
, (s64
)MAXFREQ_NSEC
);
306 time_freq
= max(freq_adj
, (s64
)-MAXFREQ_NSEC
);
307 time_offset
= div_long_long_rem_signed(time_offset
,
310 time_offset
<<= SHIFT_UPDATE
;
312 } /* txc->modes & ADJ_OFFSET */
313 if (txc
->modes
& ADJ_TICK
)
314 tick_usec
= txc
->tick
;
316 if (txc
->modes
& (ADJ_TICK
|ADJ_FREQUENCY
|ADJ_OFFSET
))
317 ntp_update_frequency();
319 leave
: if ((time_status
& (STA_UNSYNC
|STA_CLOCKERR
)) != 0)
322 if ((txc
->modes
& ADJ_OFFSET_SINGLESHOT
) == ADJ_OFFSET_SINGLESHOT
)
323 txc
->offset
= save_adjust
;
325 txc
->offset
= ((long)shift_right(time_offset
, SHIFT_UPDATE
)) *
326 NTP_INTERVAL_FREQ
/ 1000;
327 txc
->freq
= (time_freq
/ NSEC_PER_USEC
) <<
328 (SHIFT_USEC
- SHIFT_NSEC
);
329 txc
->maxerror
= time_maxerror
;
330 txc
->esterror
= time_esterror
;
331 txc
->status
= time_status
;
332 txc
->constant
= time_constant
;
334 txc
->tolerance
= MAXFREQ
;
335 txc
->tick
= tick_usec
;
337 /* PPS is not implemented, so these are zero */
346 write_sequnlock_irq(&xtime_lock
);
347 do_gettimeofday(&txc
->time
);
348 notify_arch_cmos_timer();
This page took 0.039568 seconds and 6 git commands to generate.