2 * NTP state machine interfaces and logic.
4 * This code was mainly moved from kernel/timer.c and kernel/time.c
5 * Please see those files for relevant copyright info and historical
8 #include <linux/capability.h>
9 #include <linux/clocksource.h>
10 #include <linux/workqueue.h>
11 #include <linux/hrtimer.h>
12 #include <linux/jiffies.h>
13 #include <linux/kthread.h>
14 #include <linux/math64.h>
15 #include <linux/timex.h>
16 #include <linux/time.h>
18 #include <linux/module.h>
19 #include <linux/rtc.h>
21 #include "ntp_internal.h"
24 * NTP timekeeping variables:
26 * Note: All of the NTP state is protected by the timekeeping locks.
30 /* USER_HZ period (usecs): */
31 unsigned long tick_usec = TICK_USEC;
33 /* SHIFTED_HZ period (nsecs): */
34 unsigned long tick_nsec;
36 static u64 tick_length;
37 static u64 tick_length_base;
39 #define SECS_PER_DAY 86400
40 #define MAX_TICKADJ 500LL /* usecs */
41 #define MAX_TICKADJ_SCALED \
42 (((MAX_TICKADJ * NSEC_PER_USEC) << NTP_SCALE_SHIFT) / NTP_INTERVAL_FREQ)
45 * phase-lock loop variables
49 * clock synchronization status
51 * (TIME_ERROR prevents overwriting the CMOS clock)
53 static int time_state = TIME_OK;
55 /* clock status bits: */
56 static int time_status = STA_UNSYNC;
58 /* time adjustment (nsecs): */
59 static s64 time_offset;
61 /* pll time constant: */
62 static long time_constant = 2;
64 /* maximum error (usecs): */
65 static long time_maxerror = NTP_PHASE_LIMIT;
67 /* estimated error (usecs): */
68 static long time_esterror = NTP_PHASE_LIMIT;
70 /* frequency offset (scaled nsecs/secs): */
73 /* time at last adjustment (secs): */
74 static long time_reftime;
76 static long time_adjust;
78 /* constant (boot-param configurable) NTP tick adjustment (upscaled) */
79 static s64 ntp_tick_adj;
81 /* second value of the next pending leapsecond, or TIME64_MAX if no leap */
82 static time64_t ntp_next_leap_sec = TIME64_MAX;
87 * The following variables are used when a pulse-per-second (PPS) signal
88 * is available. They establish the engineering parameters of the clock
89 * discipline loop when controlled by the PPS signal.
91 #define PPS_VALID 10 /* PPS signal watchdog max (s) */
92 #define PPS_POPCORN 4 /* popcorn spike threshold (shift) */
93 #define PPS_INTMIN 2 /* min freq interval (s) (shift) */
94 #define PPS_INTMAX 8 /* max freq interval (s) (shift) */
95 #define PPS_INTCOUNT 4 /* number of consecutive good intervals to
96 increase pps_shift or consecutive bad
97 intervals to decrease it */
98 #define PPS_MAXWANDER 100000 /* max PPS freq wander (ns/s) */
100 static int pps_valid; /* signal watchdog counter */
101 static long pps_tf[3]; /* phase median filter */
102 static long pps_jitter; /* current jitter (ns) */
103 static struct timespec64 pps_fbase; /* beginning of the last freq interval */
104 static int pps_shift; /* current interval duration (s) (shift) */
105 static int pps_intcnt; /* interval counter */
106 static s64 pps_freq; /* frequency offset (scaled ns/s) */
107 static long pps_stabil; /* current stability (scaled ns/s) */
110 * PPS signal quality monitors
112 static long pps_calcnt; /* calibration intervals */
113 static long pps_jitcnt; /* jitter limit exceeded */
114 static long pps_stbcnt; /* stability limit exceeded */
115 static long pps_errcnt; /* calibration errors */
118 /* PPS kernel consumer compensates the whole phase error immediately.
119 * Otherwise, reduce the offset by a fixed factor times the time constant.
121 static inline s64 ntp_offset_chunk(s64 offset)
123 if (time_status & STA_PPSTIME && time_status & STA_PPSSIGNAL)
126 return shift_right(offset, SHIFT_PLL + time_constant);
129 static inline void pps_reset_freq_interval(void)
131 /* the PPS calibration interval may end
132 surprisingly early */
133 pps_shift = PPS_INTMIN;
138 * pps_clear - Clears the PPS state variables
140 static inline void pps_clear(void)
142 pps_reset_freq_interval();
146 pps_fbase.tv_sec = pps_fbase.tv_nsec = 0;
150 /* Decrease pps_valid to indicate that another second has passed since
151 * the last PPS signal. When it reaches 0, indicate that PPS signal is
154 static inline void pps_dec_valid(void)
159 time_status &= ~(STA_PPSSIGNAL | STA_PPSJITTER |
160 STA_PPSWANDER | STA_PPSERROR);
165 static inline void pps_set_freq(s64 freq)
170 static inline int is_error_status(int status)
172 return (status & (STA_UNSYNC|STA_CLOCKERR))
173 /* PPS signal lost when either PPS time or
174 * PPS frequency synchronization requested
176 || ((status & (STA_PPSFREQ|STA_PPSTIME))
177 && !(status & STA_PPSSIGNAL))
178 /* PPS jitter exceeded when
179 * PPS time synchronization requested */
180 || ((status & (STA_PPSTIME|STA_PPSJITTER))
181 == (STA_PPSTIME|STA_PPSJITTER))
182 /* PPS wander exceeded or calibration error when
183 * PPS frequency synchronization requested
185 || ((status & STA_PPSFREQ)
186 && (status & (STA_PPSWANDER|STA_PPSERROR)));
189 static inline void pps_fill_timex(struct timex *txc)
191 txc->ppsfreq = shift_right((pps_freq >> PPM_SCALE_INV_SHIFT) *
192 PPM_SCALE_INV, NTP_SCALE_SHIFT);
193 txc->jitter = pps_jitter;
194 if (!(time_status & STA_NANO))
195 txc->jitter /= NSEC_PER_USEC;
196 txc->shift = pps_shift;
197 txc->stabil = pps_stabil;
198 txc->jitcnt = pps_jitcnt;
199 txc->calcnt = pps_calcnt;
200 txc->errcnt = pps_errcnt;
201 txc->stbcnt = pps_stbcnt;
204 #else /* !CONFIG_NTP_PPS */
206 static inline s64 ntp_offset_chunk(s64 offset)
208 return shift_right(offset, SHIFT_PLL + time_constant);
211 static inline void pps_reset_freq_interval(void) {}
212 static inline void pps_clear(void) {}
213 static inline void pps_dec_valid(void) {}
214 static inline void pps_set_freq(s64 freq) {}
216 static inline int is_error_status(int status)
218 return status & (STA_UNSYNC|STA_CLOCKERR);
221 static inline void pps_fill_timex(struct timex *txc)
223 /* PPS is not implemented, so these are zero */
234 #endif /* CONFIG_NTP_PPS */
238 * ntp_synced - Returns 1 if the NTP status is not UNSYNC
241 static inline int ntp_synced(void)
243 return !(time_status & STA_UNSYNC);
252 * Update (tick_length, tick_length_base, tick_nsec), based
253 * on (tick_usec, ntp_tick_adj, time_freq):
255 static void ntp_update_frequency(void)
260 second_length = (u64)(tick_usec * NSEC_PER_USEC * USER_HZ)
263 second_length += ntp_tick_adj;
264 second_length += time_freq;
266 tick_nsec = div_u64(second_length, HZ) >> NTP_SCALE_SHIFT;
267 new_base = div_u64(second_length, NTP_INTERVAL_FREQ);
270 * Don't wait for the next second_overflow, apply
271 * the change to the tick length immediately:
273 tick_length += new_base - tick_length_base;
274 tick_length_base = new_base;
277 static inline s64 ntp_update_offset_fll(s64 offset64, long secs)
279 time_status &= ~STA_MODE;
284 if (!(time_status & STA_FLL) && (secs <= MAXSEC))
287 time_status |= STA_MODE;
289 return div64_long(offset64 << (NTP_SCALE_SHIFT - SHIFT_FLL), secs);
292 static void ntp_update_offset(long offset)
298 if (!(time_status & STA_PLL))
301 if (!(time_status & STA_NANO))
302 offset *= NSEC_PER_USEC;
305 * Scale the phase adjustment and
306 * clamp to the operating range.
308 offset = min(offset, MAXPHASE);
309 offset = max(offset, -MAXPHASE);
312 * Select how the frequency is to be controlled
313 * and in which mode (PLL or FLL).
315 secs = get_seconds() - time_reftime;
316 if (unlikely(time_status & STA_FREQHOLD))
319 time_reftime = get_seconds();
322 freq_adj = ntp_update_offset_fll(offset64, secs);
325 * Clamp update interval to reduce PLL gain with low
326 * sampling rate (e.g. intermittent network connection)
327 * to avoid instability.
329 if (unlikely(secs > 1 << (SHIFT_PLL + 1 + time_constant)))
330 secs = 1 << (SHIFT_PLL + 1 + time_constant);
332 freq_adj += (offset64 * secs) <<
333 (NTP_SCALE_SHIFT - 2 * (SHIFT_PLL + 2 + time_constant));
335 freq_adj = min(freq_adj + time_freq, MAXFREQ_SCALED);
337 time_freq = max(freq_adj, -MAXFREQ_SCALED);
339 time_offset = div_s64(offset64 << NTP_SCALE_SHIFT, NTP_INTERVAL_FREQ);
343 * ntp_clear - Clears the NTP state variables
347 time_adjust = 0; /* stop active adjtime() */
348 time_status |= STA_UNSYNC;
349 time_maxerror = NTP_PHASE_LIMIT;
350 time_esterror = NTP_PHASE_LIMIT;
352 ntp_update_frequency();
354 tick_length = tick_length_base;
357 ntp_next_leap_sec = TIME64_MAX;
358 /* Clear PPS state variables */
363 u64 ntp_tick_length(void)
369 * ntp_get_next_leap - Returns the next leapsecond in CLOCK_REALTIME ktime_t
371 * Provides the time of the next leapsecond against CLOCK_REALTIME in
372 * a ktime_t format. Returns KTIME_MAX if no leapsecond is pending.
374 ktime_t ntp_get_next_leap(void)
378 if ((time_state == TIME_INS) && (time_status & STA_INS))
379 return ktime_set(ntp_next_leap_sec, 0);
380 ret.tv64 = KTIME_MAX;
385 * this routine handles the overflow of the microsecond field
387 * The tricky bits of code to handle the accurate clock support
388 * were provided by Dave Mills (Mills@UDEL.EDU) of NTP fame.
389 * They were originally developed for SUN and DEC kernels.
390 * All the kudos should go to Dave for this stuff.
392 * Also handles leap second processing, and returns leap offset
394 int second_overflow(unsigned long secs)
400 * Leap second processing. If in leap-insert state at the end of the
401 * day, the system clock is set back one second; if in leap-delete
402 * state, the system clock is set ahead one second.
404 switch (time_state) {
406 if (time_status & STA_INS) {
407 time_state = TIME_INS;
408 ntp_next_leap_sec = secs + SECS_PER_DAY -
409 (secs % SECS_PER_DAY);
410 } else if (time_status & STA_DEL) {
411 time_state = TIME_DEL;
412 ntp_next_leap_sec = secs + SECS_PER_DAY -
413 ((secs+1) % SECS_PER_DAY);
417 if (!(time_status & STA_INS)) {
418 ntp_next_leap_sec = TIME64_MAX;
419 time_state = TIME_OK;
420 } else if (secs % SECS_PER_DAY == 0) {
422 time_state = TIME_OOP;
424 "Clock: inserting leap second 23:59:60 UTC\n");
428 if (!(time_status & STA_DEL)) {
429 ntp_next_leap_sec = TIME64_MAX;
430 time_state = TIME_OK;
431 } else if ((secs + 1) % SECS_PER_DAY == 0) {
433 ntp_next_leap_sec = TIME64_MAX;
434 time_state = TIME_WAIT;
436 "Clock: deleting leap second 23:59:59 UTC\n");
440 ntp_next_leap_sec = TIME64_MAX;
441 time_state = TIME_WAIT;
444 if (!(time_status & (STA_INS | STA_DEL)))
445 time_state = TIME_OK;
450 /* Bump the maxerror field */
451 time_maxerror += MAXFREQ / NSEC_PER_USEC;
452 if (time_maxerror > NTP_PHASE_LIMIT) {
453 time_maxerror = NTP_PHASE_LIMIT;
454 time_status |= STA_UNSYNC;
457 /* Compute the phase adjustment for the next second */
458 tick_length = tick_length_base;
460 delta = ntp_offset_chunk(time_offset);
461 time_offset -= delta;
462 tick_length += delta;
464 /* Check PPS signal */
470 if (time_adjust > MAX_TICKADJ) {
471 time_adjust -= MAX_TICKADJ;
472 tick_length += MAX_TICKADJ_SCALED;
476 if (time_adjust < -MAX_TICKADJ) {
477 time_adjust += MAX_TICKADJ;
478 tick_length -= MAX_TICKADJ_SCALED;
482 tick_length += (s64)(time_adjust * NSEC_PER_USEC / NTP_INTERVAL_FREQ)
490 #ifdef CONFIG_GENERIC_CMOS_UPDATE
491 int __weak update_persistent_clock(struct timespec now)
496 int __weak update_persistent_clock64(struct timespec64 now64)
500 now = timespec64_to_timespec(now64);
501 return update_persistent_clock(now);
505 #if defined(CONFIG_GENERIC_CMOS_UPDATE) || defined(CONFIG_RTC_SYSTOHC)
506 static void sync_cmos_clock(struct work_struct *work);
508 static DECLARE_DELAYED_WORK(sync_cmos_work, sync_cmos_clock);
510 static void sync_cmos_clock(struct work_struct *work)
512 struct timespec64 now;
513 struct timespec64 next;
517 * If we have an externally synchronized Linux clock, then update
518 * CMOS clock accordingly every ~11 minutes. Set_rtc_mmss() has to be
519 * called as close as possible to 500 ms before the new second starts.
520 * This code is run on a timer. If the clock is set, that timer
521 * may not expire at the correct time. Thus, we adjust...
522 * We want the clock to be within a couple of ticks from the target.
526 * Not synced, exit, do not restart a timer (if one is
527 * running, let it run out).
532 getnstimeofday64(&now);
533 if (abs(now.tv_nsec - (NSEC_PER_SEC / 2)) <= tick_nsec * 5) {
534 struct timespec64 adjust = now;
537 if (persistent_clock_is_local)
538 adjust.tv_sec -= (sys_tz.tz_minuteswest * 60);
539 #ifdef CONFIG_GENERIC_CMOS_UPDATE
540 fail = update_persistent_clock64(adjust);
543 #ifdef CONFIG_RTC_SYSTOHC
545 fail = rtc_set_ntp_time(adjust);
549 next.tv_nsec = (NSEC_PER_SEC / 2) - now.tv_nsec - (TICK_NSEC / 2);
550 if (next.tv_nsec <= 0)
551 next.tv_nsec += NSEC_PER_SEC;
553 if (!fail || fail == -ENODEV)
558 if (next.tv_nsec >= NSEC_PER_SEC) {
560 next.tv_nsec -= NSEC_PER_SEC;
562 queue_delayed_work(system_power_efficient_wq,
563 &sync_cmos_work, timespec64_to_jiffies(&next));
566 #ifdef CONFIG_PREEMPT_RT_FULL
568 * RT can not call schedule_delayed_work from real interrupt context.
569 * Need to make a thread to do the real work.
571 static struct task_struct *cmos_delay_thread;
572 static bool do_cmos_delay;
574 static int run_cmos_delay(void *ignore)
576 while (!kthread_should_stop()) {
577 set_current_state(TASK_INTERRUPTIBLE);
579 do_cmos_delay = false;
580 queue_delayed_work(system_power_efficient_wq,
585 __set_current_state(TASK_RUNNING);
589 void ntp_notify_cmos_timer(void)
591 do_cmos_delay = true;
592 /* Make visible before waking up process */
594 wake_up_process(cmos_delay_thread);
597 static __init int create_cmos_delay_thread(void)
599 cmos_delay_thread = kthread_run(run_cmos_delay, NULL, "kcmosdelayd");
600 BUG_ON(!cmos_delay_thread);
603 early_initcall(create_cmos_delay_thread);
607 void ntp_notify_cmos_timer(void)
609 queue_delayed_work(system_power_efficient_wq, &sync_cmos_work, 0);
611 #endif /* CONFIG_PREEMPT_RT_FULL */
614 void ntp_notify_cmos_timer(void) { }
619 * Propagate a new txc->status value into the NTP state:
621 static inline void process_adj_status(struct timex *txc, struct timespec64 *ts)
623 if ((time_status & STA_PLL) && !(txc->status & STA_PLL)) {
624 time_state = TIME_OK;
625 time_status = STA_UNSYNC;
626 ntp_next_leap_sec = TIME64_MAX;
627 /* restart PPS frequency calibration */
628 pps_reset_freq_interval();
632 * If we turn on PLL adjustments then reset the
633 * reference time to current time.
635 if (!(time_status & STA_PLL) && (txc->status & STA_PLL))
636 time_reftime = get_seconds();
638 /* only set allowed bits */
639 time_status &= STA_RONLY;
640 time_status |= txc->status & ~STA_RONLY;
644 static inline void process_adjtimex_modes(struct timex *txc,
645 struct timespec64 *ts,
648 if (txc->modes & ADJ_STATUS)
649 process_adj_status(txc, ts);
651 if (txc->modes & ADJ_NANO)
652 time_status |= STA_NANO;
654 if (txc->modes & ADJ_MICRO)
655 time_status &= ~STA_NANO;
657 if (txc->modes & ADJ_FREQUENCY) {
658 time_freq = txc->freq * PPM_SCALE;
659 time_freq = min(time_freq, MAXFREQ_SCALED);
660 time_freq = max(time_freq, -MAXFREQ_SCALED);
661 /* update pps_freq */
662 pps_set_freq(time_freq);
665 if (txc->modes & ADJ_MAXERROR)
666 time_maxerror = txc->maxerror;
668 if (txc->modes & ADJ_ESTERROR)
669 time_esterror = txc->esterror;
671 if (txc->modes & ADJ_TIMECONST) {
672 time_constant = txc->constant;
673 if (!(time_status & STA_NANO))
675 time_constant = min(time_constant, (long)MAXTC);
676 time_constant = max(time_constant, 0l);
679 if (txc->modes & ADJ_TAI && txc->constant > 0)
680 *time_tai = txc->constant;
682 if (txc->modes & ADJ_OFFSET)
683 ntp_update_offset(txc->offset);
685 if (txc->modes & ADJ_TICK)
686 tick_usec = txc->tick;
688 if (txc->modes & (ADJ_TICK|ADJ_FREQUENCY|ADJ_OFFSET))
689 ntp_update_frequency();
695 * ntp_validate_timex - Ensures the timex is ok for use in do_adjtimex
697 int ntp_validate_timex(struct timex *txc)
699 if (txc->modes & ADJ_ADJTIME) {
700 /* singleshot must not be used with any other mode bits */
701 if (!(txc->modes & ADJ_OFFSET_SINGLESHOT))
703 if (!(txc->modes & ADJ_OFFSET_READONLY) &&
704 !capable(CAP_SYS_TIME))
707 /* In order to modify anything, you gotta be super-user! */
708 if (txc->modes && !capable(CAP_SYS_TIME))
711 * if the quartz is off by more than 10% then
712 * something is VERY wrong!
714 if (txc->modes & ADJ_TICK &&
715 (txc->tick < 900000/USER_HZ ||
716 txc->tick > 1100000/USER_HZ))
720 if (txc->modes & ADJ_SETOFFSET) {
721 /* In order to inject time, you gotta be super-user! */
722 if (!capable(CAP_SYS_TIME))
725 if (txc->modes & ADJ_NANO) {
728 ts.tv_sec = txc->time.tv_sec;
729 ts.tv_nsec = txc->time.tv_usec;
730 if (!timespec_inject_offset_valid(&ts))
734 if (!timeval_inject_offset_valid(&txc->time))
740 * Check for potential multiplication overflows that can
741 * only happen on 64-bit systems:
743 if ((txc->modes & ADJ_FREQUENCY) && (BITS_PER_LONG == 64)) {
744 if (LLONG_MIN / PPM_SCALE > txc->freq)
746 if (LLONG_MAX / PPM_SCALE < txc->freq)
755 * adjtimex mainly allows reading (and writing, if superuser) of
756 * kernel time-keeping variables. used by xntpd.
758 int __do_adjtimex(struct timex *txc, struct timespec64 *ts, s32 *time_tai)
762 if (txc->modes & ADJ_ADJTIME) {
763 long save_adjust = time_adjust;
765 if (!(txc->modes & ADJ_OFFSET_READONLY)) {
766 /* adjtime() is independent from ntp_adjtime() */
767 time_adjust = txc->offset;
768 ntp_update_frequency();
770 txc->offset = save_adjust;
773 /* If there are input parameters, then process them: */
775 process_adjtimex_modes(txc, ts, time_tai);
777 txc->offset = shift_right(time_offset * NTP_INTERVAL_FREQ,
779 if (!(time_status & STA_NANO))
780 txc->offset /= NSEC_PER_USEC;
783 result = time_state; /* mostly `TIME_OK' */
784 /* check for errors */
785 if (is_error_status(time_status))
788 txc->freq = shift_right((time_freq >> PPM_SCALE_INV_SHIFT) *
789 PPM_SCALE_INV, NTP_SCALE_SHIFT);
790 txc->maxerror = time_maxerror;
791 txc->esterror = time_esterror;
792 txc->status = time_status;
793 txc->constant = time_constant;
795 txc->tolerance = MAXFREQ_SCALED / PPM_SCALE;
796 txc->tick = tick_usec;
797 txc->tai = *time_tai;
799 /* fill PPS status fields */
802 txc->time.tv_sec = (time_t)ts->tv_sec;
803 txc->time.tv_usec = ts->tv_nsec;
804 if (!(time_status & STA_NANO))
805 txc->time.tv_usec /= NSEC_PER_USEC;
807 /* Handle leapsec adjustments */
808 if (unlikely(ts->tv_sec >= ntp_next_leap_sec)) {
809 if ((time_state == TIME_INS) && (time_status & STA_INS)) {
814 if ((time_state == TIME_DEL) && (time_status & STA_DEL)) {
819 if ((time_state == TIME_OOP) &&
820 (ts->tv_sec == ntp_next_leap_sec)) {
828 #ifdef CONFIG_NTP_PPS
830 /* actually struct pps_normtime is good old struct timespec, but it is
831 * semantically different (and it is the reason why it was invented):
832 * pps_normtime.nsec has a range of ( -NSEC_PER_SEC / 2, NSEC_PER_SEC / 2 ]
833 * while timespec.tv_nsec has a range of [0, NSEC_PER_SEC) */
834 struct pps_normtime {
835 s64 sec; /* seconds */
836 long nsec; /* nanoseconds */
839 /* normalize the timestamp so that nsec is in the
840 ( -NSEC_PER_SEC / 2, NSEC_PER_SEC / 2 ] interval */
841 static inline struct pps_normtime pps_normalize_ts(struct timespec64 ts)
843 struct pps_normtime norm = {
848 if (norm.nsec > (NSEC_PER_SEC >> 1)) {
849 norm.nsec -= NSEC_PER_SEC;
856 /* get current phase correction and jitter */
857 static inline long pps_phase_filter_get(long *jitter)
859 *jitter = pps_tf[0] - pps_tf[1];
863 /* TODO: test various filters */
867 /* add the sample to the phase filter */
868 static inline void pps_phase_filter_add(long err)
870 pps_tf[2] = pps_tf[1];
871 pps_tf[1] = pps_tf[0];
875 /* decrease frequency calibration interval length.
876 * It is halved after four consecutive unstable intervals.
878 static inline void pps_dec_freq_interval(void)
880 if (--pps_intcnt <= -PPS_INTCOUNT) {
881 pps_intcnt = -PPS_INTCOUNT;
882 if (pps_shift > PPS_INTMIN) {
889 /* increase frequency calibration interval length.
890 * It is doubled after four consecutive stable intervals.
892 static inline void pps_inc_freq_interval(void)
894 if (++pps_intcnt >= PPS_INTCOUNT) {
895 pps_intcnt = PPS_INTCOUNT;
896 if (pps_shift < PPS_INTMAX) {
903 /* update clock frequency based on MONOTONIC_RAW clock PPS signal
906 * At the end of the calibration interval the difference between the
907 * first and last MONOTONIC_RAW clock timestamps divided by the length
908 * of the interval becomes the frequency update. If the interval was
909 * too long, the data are discarded.
910 * Returns the difference between old and new frequency values.
912 static long hardpps_update_freq(struct pps_normtime freq_norm)
914 long delta, delta_mod;
917 /* check if the frequency interval was too long */
918 if (freq_norm.sec > (2 << pps_shift)) {
919 time_status |= STA_PPSERROR;
921 pps_dec_freq_interval();
922 printk_deferred(KERN_ERR
923 "hardpps: PPSERROR: interval too long - %lld s\n",
928 /* here the raw frequency offset and wander (stability) is
929 * calculated. If the wander is less than the wander threshold
930 * the interval is increased; otherwise it is decreased.
932 ftemp = div_s64(((s64)(-freq_norm.nsec)) << NTP_SCALE_SHIFT,
934 delta = shift_right(ftemp - pps_freq, NTP_SCALE_SHIFT);
936 if (delta > PPS_MAXWANDER || delta < -PPS_MAXWANDER) {
937 printk_deferred(KERN_WARNING
938 "hardpps: PPSWANDER: change=%ld\n", delta);
939 time_status |= STA_PPSWANDER;
941 pps_dec_freq_interval();
942 } else { /* good sample */
943 pps_inc_freq_interval();
946 /* the stability metric is calculated as the average of recent
947 * frequency changes, but is used only for performance
952 delta_mod = -delta_mod;
953 pps_stabil += (div_s64(((s64)delta_mod) <<
954 (NTP_SCALE_SHIFT - SHIFT_USEC),
955 NSEC_PER_USEC) - pps_stabil) >> PPS_INTMIN;
957 /* if enabled, the system clock frequency is updated */
958 if ((time_status & STA_PPSFREQ) != 0 &&
959 (time_status & STA_FREQHOLD) == 0) {
960 time_freq = pps_freq;
961 ntp_update_frequency();
967 /* correct REALTIME clock phase error against PPS signal */
968 static void hardpps_update_phase(long error)
970 long correction = -error;
973 /* add the sample to the median filter */
974 pps_phase_filter_add(correction);
975 correction = pps_phase_filter_get(&jitter);
977 /* Nominal jitter is due to PPS signal noise. If it exceeds the
978 * threshold, the sample is discarded; otherwise, if so enabled,
979 * the time offset is updated.
981 if (jitter > (pps_jitter << PPS_POPCORN)) {
982 printk_deferred(KERN_WARNING
983 "hardpps: PPSJITTER: jitter=%ld, limit=%ld\n",
984 jitter, (pps_jitter << PPS_POPCORN));
985 time_status |= STA_PPSJITTER;
987 } else if (time_status & STA_PPSTIME) {
988 /* correct the time using the phase offset */
989 time_offset = div_s64(((s64)correction) << NTP_SCALE_SHIFT,
991 /* cancel running adjtime() */
995 pps_jitter += (jitter - pps_jitter) >> PPS_INTMIN;
999 * __hardpps() - discipline CPU clock oscillator to external PPS signal
1001 * This routine is called at each PPS signal arrival in order to
1002 * discipline the CPU clock oscillator to the PPS signal. It takes two
1003 * parameters: REALTIME and MONOTONIC_RAW clock timestamps. The former
1004 * is used to correct clock phase error and the latter is used to
1005 * correct the frequency.
1007 * This code is based on David Mills's reference nanokernel
1008 * implementation. It was mostly rewritten but keeps the same idea.
1010 void __hardpps(const struct timespec64 *phase_ts, const struct timespec64 *raw_ts)
1012 struct pps_normtime pts_norm, freq_norm;
1014 pts_norm = pps_normalize_ts(*phase_ts);
1016 /* clear the error bits, they will be set again if needed */
1017 time_status &= ~(STA_PPSJITTER | STA_PPSWANDER | STA_PPSERROR);
1019 /* indicate signal presence */
1020 time_status |= STA_PPSSIGNAL;
1021 pps_valid = PPS_VALID;
1023 /* when called for the first time,
1024 * just start the frequency interval */
1025 if (unlikely(pps_fbase.tv_sec == 0)) {
1026 pps_fbase = *raw_ts;
1030 /* ok, now we have a base for frequency calculation */
1031 freq_norm = pps_normalize_ts(timespec64_sub(*raw_ts, pps_fbase));
1033 /* check that the signal is in the range
1034 * [1s - MAXFREQ us, 1s + MAXFREQ us], otherwise reject it */
1035 if ((freq_norm.sec == 0) ||
1036 (freq_norm.nsec > MAXFREQ * freq_norm.sec) ||
1037 (freq_norm.nsec < -MAXFREQ * freq_norm.sec)) {
1038 time_status |= STA_PPSJITTER;
1039 /* restart the frequency calibration interval */
1040 pps_fbase = *raw_ts;
1041 printk_deferred(KERN_ERR "hardpps: PPSJITTER: bad pulse\n");
1047 /* check if the current frequency interval is finished */
1048 if (freq_norm.sec >= (1 << pps_shift)) {
1050 /* restart the frequency calibration interval */
1051 pps_fbase = *raw_ts;
1052 hardpps_update_freq(freq_norm);
1055 hardpps_update_phase(pts_norm.nsec);
1058 #endif /* CONFIG_NTP_PPS */
1060 static int __init ntp_tick_adj_setup(char *str)
1062 int rc = kstrtol(str, 0, (long *)&ntp_tick_adj);
1066 ntp_tick_adj <<= NTP_SCALE_SHIFT;
1071 __setup("ntp_tick_adj=", ntp_tick_adj_setup);
1073 void __init ntp_init(void)