kernel/time/ntp.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * NTP state machine interfaces and logic.
   4  *
   5  * This code was mainly moved from kernel/timer.c and kernel/time.c
   6  * Please see those files for relevant copyright info and historical
   7  * changelogs.
   8  */
   9 #include <linux/capability.h>
  10 #include <linux/clocksource.h>
  11 #include <linux/workqueue.h>
  12 #include <linux/hrtimer.h>
  13 #include <linux/jiffies.h>
  14 #include <linux/math64.h>
  15 #include <linux/timex.h>
  16 #include <linux/time.h>
  17 #include <linux/mm.h>
  18 #include <linux/module.h>
  19 #include <linux/rtc.h>
  20 #include <linux/audit.h>
  21
  22 #include "ntp_internal.h"
  23 #include "timekeeping_internal.h"
  24
  25
  26 /*
  27  * NTP timekeeping variables:
  28  *
  29  * Note: All of the NTP state is protected by the timekeeping locks.
  30  */
  31
  32
  33 /* USER_HZ period (usecs): */
  34 unsigned long                   tick_usec = USER_TICK_USEC;
  35
  36 /* SHIFTED_HZ period (nsecs): */
  37 unsigned long                   tick_nsec;
  38
  39 static u64                      tick_length;
  40 static u64                      tick_length_base;
  41
  42 #define SECS_PER_DAY            86400
  43 #define MAX_TICKADJ             500LL           /* usecs */
  44 #define MAX_TICKADJ_SCALED \
  45         (((MAX_TICKADJ * NSEC_PER_USEC) << NTP_SCALE_SHIFT) / NTP_INTERVAL_FREQ)
  46 #define MAX_TAI_OFFSET          100000
  47
  48 /*
  49  * phase-lock loop variables
  50  */
  51
  52 /*
  53  * clock synchronization status
  54  *
  55  * (TIME_ERROR prevents overwriting the CMOS clock)
  56  */
  57 static int                      time_state = TIME_OK;
  58
  59 /* clock status bits:                                                   */
  60 static int                      time_status = STA_UNSYNC;
  61
  62 /* time adjustment (nsecs):                                             */
  63 static s64                      time_offset;
  64
  65 /* pll time constant:                                                   */
  66 static long                     time_constant = 2;
  67
  68 /* maximum error (usecs):                                               */
  69 static long                     time_maxerror = NTP_PHASE_LIMIT;
  70
  71 /* estimated error (usecs):                                             */
  72 static long                     time_esterror = NTP_PHASE_LIMIT;
  73
  74 /* frequency offset (scaled nsecs/secs):                                */
  75 static s64                      time_freq;
  76
  77 /* time at last adjustment (secs):                                      */
  78 static time64_t         time_reftime;
  79
  80 static long                     time_adjust;
  81
  82 /* constant (boot-param configurable) NTP tick adjustment (upscaled)    */
  83 static s64                      ntp_tick_adj;
  84
  85 /* second value of the next pending leapsecond, or TIME64_MAX if no leap */
  86 static time64_t                 ntp_next_leap_sec = TIME64_MAX;
  87
  88 #ifdef CONFIG_NTP_PPS
  89
  90 /*
  91  * The following variables are used when a pulse-per-second (PPS) signal
  92  * is available. They establish the engineering parameters of the clock
  93  * discipline loop when controlled by the PPS signal.
  94  */
  95 #define PPS_VALID       10      /* PPS signal watchdog max (s) */
  96 #define PPS_POPCORN     4       /* popcorn spike threshold (shift) */
  97 #define PPS_INTMIN      2       /* min freq interval (s) (shift) */
  98 #define PPS_INTMAX      8       /* max freq interval (s) (shift) */
  99 #define PPS_INTCOUNT    4       /* number of consecutive good intervals to
 100                                    increase pps_shift or consecutive bad
 101                                    intervals to decrease it */
 102 #define PPS_MAXWANDER   100000  /* max PPS freq wander (ns/s) */
 103
 104 static int pps_valid;           /* signal watchdog counter */
 105 static long pps_tf[3];          /* phase median filter */
 106 static long pps_jitter;         /* current jitter (ns) */
 107 static struct timespec64 pps_fbase; /* beginning of the last freq interval */
 108 static int pps_shift;           /* current interval duration (s) (shift) */
 109 static int pps_intcnt;          /* interval counter */
 110 static s64 pps_freq;            /* frequency offset (scaled ns/s) */
 111 static long pps_stabil;         /* current stability (scaled ns/s) */
 112
 113 /*
 114  * PPS signal quality monitors
 115  */
 116 static long pps_calcnt;         /* calibration intervals */
 117 static long pps_jitcnt;         /* jitter limit exceeded */
 118 static long pps_stbcnt;         /* stability limit exceeded */
 119 static long pps_errcnt;         /* calibration errors */
 120
 121
 122 /* PPS kernel consumer compensates the whole phase error immediately.
 123  * Otherwise, reduce the offset by a fixed factor times the time constant.
 124  */
 125 static inline s64 ntp_offset_chunk(s64 offset)
 126 {
 127         if (time_status & STA_PPSTIME && time_status & STA_PPSSIGNAL)
 128                 return offset;
 129         else
 130                 return shift_right(offset, SHIFT_PLL + time_constant);
 131 }
 132
 133 static inline void pps_reset_freq_interval(void)
 134 {
 135         /* the PPS calibration interval may end
 136            surprisingly early */
 137         pps_shift = PPS_INTMIN;
 138         pps_intcnt = 0;
 139 }
 140
 141 /**
 142  * pps_clear - Clears the PPS state variables
 143  */
 144 static inline void pps_clear(void)
 145 {
 146         pps_reset_freq_interval();
 147         pps_tf[0] = 0;
 148         pps_tf[1] = 0;
 149         pps_tf[2] = 0;
 150         pps_fbase.tv_sec = pps_fbase.tv_nsec = 0;
 151         pps_freq = 0;
 152 }
 153
 154 /* Decrease pps_valid to indicate that another second has passed since
 155  * the last PPS signal. When it reaches 0, indicate that PPS signal is
 156  * missing.
 157  */
 158 static inline void pps_dec_valid(void)
 159 {
 160         if (pps_valid > 0)
 161                 pps_valid--;
 162         else {
 163                 time_status &= ~(STA_PPSSIGNAL | STA_PPSJITTER |
 164                                  STA_PPSWANDER | STA_PPSERROR);
 165                 pps_clear();
 166         }
 167 }
 168
 169 static inline void pps_set_freq(s64 freq)
 170 {
 171         pps_freq = freq;
 172 }
 173
 174 static inline int is_error_status(int status)
 175 {
 176         return (status & (STA_UNSYNC|STA_CLOCKERR))
 177                 /* PPS signal lost when either PPS time or
 178                  * PPS frequency synchronization requested
 179                  */
 180                 || ((status & (STA_PPSFREQ|STA_PPSTIME))
 181                         && !(status & STA_PPSSIGNAL))
 182                 /* PPS jitter exceeded when
 183                  * PPS time synchronization requested */
 184                 || ((status & (STA_PPSTIME|STA_PPSJITTER))
 185                         == (STA_PPSTIME|STA_PPSJITTER))
 186                 /* PPS wander exceeded or calibration error when
 187                  * PPS frequency synchronization requested
 188                  */
 189                 || ((status & STA_PPSFREQ)
 190                         && (status & (STA_PPSWANDER|STA_PPSERROR)));
 191 }
 192
 193 static inline void pps_fill_timex(struct __kernel_timex *txc)
 194 {
 195         txc->ppsfreq       = shift_right((pps_freq >> PPM_SCALE_INV_SHIFT) *
 196                                          PPM_SCALE_INV, NTP_SCALE_SHIFT);
 197         txc->jitter        = pps_jitter;
 198         if (!(time_status & STA_NANO))
 199                 txc->jitter = pps_jitter / NSEC_PER_USEC;
 200         txc->shift         = pps_shift;
 201         txc->stabil        = pps_stabil;
 202         txc->jitcnt        = pps_jitcnt;
 203         txc->calcnt        = pps_calcnt;
 204         txc->errcnt        = pps_errcnt;
 205         txc->stbcnt        = pps_stbcnt;
 206 }
 207
 208 #else /* !CONFIG_NTP_PPS */
 209
 210 static inline s64 ntp_offset_chunk(s64 offset)
 211 {
 212         return shift_right(offset, SHIFT_PLL + time_constant);
 213 }
 214
 215 static inline void pps_reset_freq_interval(void) {}
 216 static inline void pps_clear(void) {}
 217 static inline void pps_dec_valid(void) {}
 218 static inline void pps_set_freq(s64 freq) {}
 219
 220 static inline int is_error_status(int status)
 221 {
 222         return status & (STA_UNSYNC|STA_CLOCKERR);
 223 }
 224
 225 static inline void pps_fill_timex(struct __kernel_timex *txc)
 226 {
 227         /* PPS is not implemented, so these are zero */
 228         txc->ppsfreq       = 0;
 229         txc->jitter        = 0;
 230         txc->shift         = 0;
 231         txc->stabil        = 0;
 232         txc->jitcnt        = 0;
 233         txc->calcnt        = 0;
 234         txc->errcnt        = 0;
 235         txc->stbcnt        = 0;
 236 }
 237
 238 #endif /* CONFIG_NTP_PPS */
 239
 240
 241 /**
 242  * ntp_synced - Returns 1 if the NTP status is not UNSYNC
 243  *
 244  */
 245 static inline int ntp_synced(void)
 246 {
 247         return !(time_status & STA_UNSYNC);
 248 }
 249
 250
 251 /*
 252  * NTP methods:
 253  */
 254
 255 /*
 256  * Update (tick_length, tick_length_base, tick_nsec), based
 257  * on (tick_usec, ntp_tick_adj, time_freq):
 258  */
 259 static void ntp_update_frequency(void)
 260 {
 261         u64 second_length;
 262         u64 new_base;
 263
 264         second_length            = (u64)(tick_usec * NSEC_PER_USEC * USER_HZ)
 265                                                 << NTP_SCALE_SHIFT;
 266
 267         second_length           += ntp_tick_adj;
 268         second_length           += time_freq;
 269
 270         tick_nsec                = div_u64(second_length, HZ) >> NTP_SCALE_SHIFT;
 271         new_base                 = div_u64(second_length, NTP_INTERVAL_FREQ);
 272
 273         /*
 274          * Don't wait for the next second_overflow, apply
 275          * the change to the tick length immediately:
 276          */
 277         tick_length             += new_base - tick_length_base;
 278         tick_length_base         = new_base;
 279 }
 280
 281 static inline s64 ntp_update_offset_fll(s64 offset64, long secs)
 282 {
 283         time_status &= ~STA_MODE;
 284
 285         if (secs < MINSEC)
 286                 return 0;
 287
 288         if (!(time_status & STA_FLL) && (secs <= MAXSEC))
 289                 return 0;
 290
 291         time_status |= STA_MODE;
 292
 293         return div64_long(offset64 << (NTP_SCALE_SHIFT - SHIFT_FLL), secs);
 294 }
 295
 296 static void ntp_update_offset(long offset)
 297 {
 298         s64 freq_adj;
 299         s64 offset64;
 300         long secs;
 301
 302         if (!(time_status & STA_PLL))
 303                 return;
 304
 305         if (!(time_status & STA_NANO)) {
 306                 /* Make sure the multiplication below won't overflow */
 307                 offset = clamp(offset, -USEC_PER_SEC, USEC_PER_SEC);
 308                 offset *= NSEC_PER_USEC;
 309         }
 310
 311         /*
 312          * Scale the phase adjustment and
 313          * clamp to the operating range.
 314          */
 315         offset = clamp(offset, -MAXPHASE, MAXPHASE);
 316
 317         /*
 318          * Select how the frequency is to be controlled
 319          * and in which mode (PLL or FLL).
 320          */
 321         secs = (long)(__ktime_get_real_seconds() - time_reftime);
 322         if (unlikely(time_status & STA_FREQHOLD))
 323                 secs = 0;
 324
 325         time_reftime = __ktime_get_real_seconds();
 326
 327         offset64    = offset;
 328         freq_adj    = ntp_update_offset_fll(offset64, secs);
 329
 330         /*
 331          * Clamp update interval to reduce PLL gain with low
 332          * sampling rate (e.g. intermittent network connection)
 333          * to avoid instability.
 334          */
 335         if (unlikely(secs > 1 << (SHIFT_PLL + 1 + time_constant)))
 336                 secs = 1 << (SHIFT_PLL + 1 + time_constant);
 337
 338         freq_adj    += (offset64 * secs) <<
 339                         (NTP_SCALE_SHIFT - 2 * (SHIFT_PLL + 2 + time_constant));
 340
 341         freq_adj    = min(freq_adj + time_freq, MAXFREQ_SCALED);
 342
 343         time_freq   = max(freq_adj, -MAXFREQ_SCALED);
 344
 345         time_offset = div_s64(offset64 << NTP_SCALE_SHIFT, NTP_INTERVAL_FREQ);
 346 }
 347
 348 /**
 349  * ntp_clear - Clears the NTP state variables
 350  */
 351 void ntp_clear(void)
 352 {
 353         time_adjust     = 0;            /* stop active adjtime() */
 354         time_status     |= STA_UNSYNC;
 355         time_maxerror   = NTP_PHASE_LIMIT;
 356         time_esterror   = NTP_PHASE_LIMIT;
 357
 358         ntp_update_frequency();
 359
 360         tick_length     = tick_length_base;
 361         time_offset     = 0;
 362
 363         ntp_next_leap_sec = TIME64_MAX;
 364         /* Clear PPS state variables */
 365         pps_clear();
 366 }
 367
 368
 369 u64 ntp_tick_length(void)
 370 {
 371         return tick_length;
 372 }
 373
 374 /**
 375  * ntp_get_next_leap - Returns the next leapsecond in CLOCK_REALTIME ktime_t
 376  *
 377  * Provides the time of the next leapsecond against CLOCK_REALTIME in
 378  * a ktime_t format. Returns KTIME_MAX if no leapsecond is pending.
 379  */
 380 ktime_t ntp_get_next_leap(void)
 381 {
 382         ktime_t ret;
 383
 384         if ((time_state == TIME_INS) && (time_status & STA_INS))
 385                 return ktime_set(ntp_next_leap_sec, 0);
 386         ret = KTIME_MAX;
 387         return ret;
 388 }
 389
 390 /*
 391  * this routine handles the overflow of the microsecond field
 392  *
 393  * The tricky bits of code to handle the accurate clock support
 394  * were provided by Dave Mills (Mills@UDEL.EDU) of NTP fame.
 395  * They were originally developed for SUN and DEC kernels.
 396  * All the kudos should go to Dave for this stuff.
 397  *
 398  * Also handles leap second processing, and returns leap offset
 399  */
 400 int second_overflow(time64_t secs)
 401 {
 402         s64 delta;
 403         int leap = 0;
 404         s32 rem;
 405
 406         /*
 407          * Leap second processing. If in leap-insert state at the end of the
 408          * day, the system clock is set back one second; if in leap-delete
 409          * state, the system clock is set ahead one second.
 410          */
 411         switch (time_state) {
 412         case TIME_OK:
 413                 if (time_status & STA_INS) {
 414                         time_state = TIME_INS;
 415                         div_s64_rem(secs, SECS_PER_DAY, &rem);
 416                         ntp_next_leap_sec = secs + SECS_PER_DAY - rem;
 417                 } else if (time_status & STA_DEL) {
 418                         time_state = TIME_DEL;
 419                         div_s64_rem(secs + 1, SECS_PER_DAY, &rem);
 420                         ntp_next_leap_sec = secs + SECS_PER_DAY - rem;
 421                 }
 422                 break;
 423         case TIME_INS:
 424                 if (!(time_status & STA_INS)) {
 425                         ntp_next_leap_sec = TIME64_MAX;
 426                         time_state = TIME_OK;
 427                 } else if (secs == ntp_next_leap_sec) {
 428                         leap = -1;
 429                         time_state = TIME_OOP;
 430                         printk(KERN_NOTICE
 431                                 "Clock: inserting leap second 23:59:60 UTC\n");
 432                 }
 433                 break;
 434         case TIME_DEL:
 435                 if (!(time_status & STA_DEL)) {
 436                         ntp_next_leap_sec = TIME64_MAX;
 437                         time_state = TIME_OK;
 438                 } else if (secs == ntp_next_leap_sec) {
 439                         leap = 1;
 440                         ntp_next_leap_sec = TIME64_MAX;
 441                         time_state = TIME_WAIT;
 442                         printk(KERN_NOTICE
 443                                 "Clock: deleting leap second 23:59:59 UTC\n");
 444                 }
 445                 break;
 446         case TIME_OOP:
 447                 ntp_next_leap_sec = TIME64_MAX;
 448                 time_state = TIME_WAIT;
 449                 break;
 450         case TIME_WAIT:
 451                 if (!(time_status & (STA_INS | STA_DEL)))
 452                         time_state = TIME_OK;
 453                 break;
 454         }
 455
 456
 457         /* Bump the maxerror field */
 458         time_maxerror += MAXFREQ / NSEC_PER_USEC;
 459         if (time_maxerror > NTP_PHASE_LIMIT) {
 460                 time_maxerror = NTP_PHASE_LIMIT;
 461                 time_status |= STA_UNSYNC;
 462         }
 463
 464         /* Compute the phase adjustment for the next second */
 465         tick_length      = tick_length_base;
 466
 467         delta            = ntp_offset_chunk(time_offset);
 468         time_offset     -= delta;
 469         tick_length     += delta;
 470
 471         /* Check PPS signal */
 472         pps_dec_valid();
 473
 474         if (!time_adjust)
 475                 goto out;
 476
 477         if (time_adjust > MAX_TICKADJ) {
 478                 time_adjust -= MAX_TICKADJ;
 479                 tick_length += MAX_TICKADJ_SCALED;
 480                 goto out;
 481         }
 482
 483         if (time_adjust < -MAX_TICKADJ) {
 484                 time_adjust += MAX_TICKADJ;
 485                 tick_length -= MAX_TICKADJ_SCALED;
 486                 goto out;
 487         }
 488
 489         tick_length += (s64)(time_adjust * NSEC_PER_USEC / NTP_INTERVAL_FREQ)
 490                                                          << NTP_SCALE_SHIFT;
 491         time_adjust = 0;
 492
 493 out:
 494         return leap;
 495 }
 496
 497 #if defined(CONFIG_GENERIC_CMOS_UPDATE) || defined(CONFIG_RTC_SYSTOHC)
 498 static void sync_hw_clock(struct work_struct *work);
 499 static DECLARE_WORK(sync_work, sync_hw_clock);
 500 static struct hrtimer sync_hrtimer;
 501 #define SYNC_PERIOD_NS (11UL * 60 * NSEC_PER_SEC)
 502
 503 static enum hrtimer_restart sync_timer_callback(struct hrtimer *timer)
 504 {
 505         queue_work(system_power_efficient_wq, &sync_work);
 506
 507         return HRTIMER_NORESTART;
 508 }
 509
 510 static void sched_sync_hw_clock(unsigned long offset_nsec, bool retry)
 511 {
 512         ktime_t exp = ktime_set(ktime_get_real_seconds(), 0);
 513
 514         if (retry)
 515                 exp = ktime_add_ns(exp, 2 * NSEC_PER_SEC - offset_nsec);
 516         else
 517                 exp = ktime_add_ns(exp, SYNC_PERIOD_NS - offset_nsec);
 518
 519         hrtimer_start(&sync_hrtimer, exp, HRTIMER_MODE_ABS);
 520 }
 521
 522 /*
 523  * Determine if we can call to driver to set the time. Drivers can only be
 524  * called to set a second aligned time value, and the field set_offset_nsec
 525  * specifies how far away from the second aligned time to call the driver.
 526  *
 527  * This also computes 'to_set' which is the time we are trying to set, and has
 528  * a zero in tv_nsecs, such that:
 529  *    to_set - set_delay_nsec == now +/- FUZZ
 530  *
 531  */
 532 static inline bool rtc_tv_nsec_ok(long set_offset_nsec,
 533                                   struct timespec64 *to_set,
 534                                   const struct timespec64 *now)
 535 {
 536         /* Allowed error in tv_nsec, arbitarily set to 5 jiffies in ns. */
 537         const unsigned long TIME_SET_NSEC_FUZZ = TICK_NSEC * 5;
 538         struct timespec64 delay = {.tv_sec = 0,
 539                                    .tv_nsec = set_offset_nsec};
 540
 541         *to_set = timespec64_add(*now, delay);
 542
 543         if (to_set->tv_nsec < TIME_SET_NSEC_FUZZ) {
 544                 to_set->tv_nsec = 0;
 545                 return true;
 546         }
 547
 548         if (to_set->tv_nsec > NSEC_PER_SEC - TIME_SET_NSEC_FUZZ) {
 549                 to_set->tv_sec++;
 550                 to_set->tv_nsec = 0;
 551                 return true;
 552         }
 553         return false;
 554 }
 555
 556 #ifdef CONFIG_RTC_SYSTOHC
 557 /*
 558  * rtc_set_ntp_time - Save NTP synchronized time to the RTC
 559  */
 560 static int rtc_set_ntp_time(struct timespec64 now, unsigned long *target_nsec)
 561 {
 562         struct rtc_device *rtc;
 563         struct rtc_time tm;
 564         struct timespec64 to_set;
 565         int err = -ENODEV;
 566         bool ok;
 567
 568         rtc = rtc_class_open(CONFIG_RTC_SYSTOHC_DEVICE);
 569         if (!rtc)
 570                 goto out_err;
 571
 572         if (!rtc->ops || !rtc->ops->set_time)
 573                 goto out_close;
 574
 575         /*
 576          * Compute the value of tv_nsec we require the caller to supply in
 577          * now.tv_nsec.  This is the value such that (now +
 578          * set_offset_nsec).tv_nsec == 0.
 579          */
 580         set_normalized_timespec64(&to_set, 0, -rtc->set_offset_nsec);
 581         *target_nsec = to_set.tv_nsec;
 582
 583         /*
 584          * The ntp code must call this with the correct value in tv_nsec, if
 585          * it does not we update target_nsec and return EPROTO to make the ntp
 586          * code try again later.
 587          */
 588         ok = rtc_tv_nsec_ok(rtc->set_offset_nsec, &to_set, &now);
 589         if (!ok) {
 590                 err = -EPROTO;
 591                 goto out_close;
 592         }
 593
 594         rtc_time64_to_tm(to_set.tv_sec, &tm);
 595
 596         err = rtc_set_time(rtc, &tm);
 597
 598 out_close:
 599         rtc_class_close(rtc);
 600 out_err:
 601         return err;
 602 }
 603
 604 static void sync_rtc_clock(void)
 605 {
 606         unsigned long offset_nsec;
 607         struct timespec64 adjust;
 608         int rc;
 609
 610         ktime_get_real_ts64(&adjust);
 611
 612         if (persistent_clock_is_local)
 613                 adjust.tv_sec -= (sys_tz.tz_minuteswest * 60);
 614
 615         /*
 616          * The current RTC in use will provide the nanoseconds offset prior
 617          * to a full second it wants to be called at, and invokes
 618          * rtc_tv_nsec_ok() internally.
 619          */
 620         rc = rtc_set_ntp_time(adjust, &offset_nsec);
 621         if (rc == -ENODEV)
 622                 return;
 623
 624         sched_sync_hw_clock(offset_nsec, rc != 0);
 625 }
 626 #else
 627 static inline void sync_rtc_clock(void) { }
 628 #endif
 629
 630 #ifdef CONFIG_GENERIC_CMOS_UPDATE
 631 int __weak update_persistent_clock64(struct timespec64 now64)
 632 {
 633         return -ENODEV;
 634 }
 635 #endif
 636
 637 static bool sync_cmos_clock(void)
 638 {
 639         static bool no_cmos;
 640         struct timespec64 now;
 641         struct timespec64 adjust;
 642         int rc = -EPROTO;
 643         long target_nsec = NSEC_PER_SEC / 2;
 644
 645         if (!IS_ENABLED(CONFIG_GENERIC_CMOS_UPDATE))
 646                 return false;
 647
 648         if (no_cmos)
 649                 return false;
 650
 651         /*
 652          * Historically update_persistent_clock64() has followed x86
 653          * semantics, which match the MC146818A/etc RTC. This RTC will store
 654          * 'adjust' and then in .5s it will advance once second.
 655          *
 656          * Architectures are strongly encouraged to use rtclib and not
 657          * implement this legacy API.
 658          */
 659         ktime_get_real_ts64(&now);
 660         if (rtc_tv_nsec_ok(-1 * target_nsec, &adjust, &now)) {
 661                 if (persistent_clock_is_local)
 662                         adjust.tv_sec -= (sys_tz.tz_minuteswest * 60);
 663                 rc = update_persistent_clock64(adjust);
 664                 /*
 665                  * The machine does not support update_persistent_clock64 even
 666                  * though it defines CONFIG_GENERIC_CMOS_UPDATE.
 667                  */
 668                 if (rc == -ENODEV) {
 669                         no_cmos = true;
 670                         return false;
 671                 }
 672         }
 673
 674         sched_sync_hw_clock(target_nsec, rc != 0);
 675         return true;
 676 }
 677
 678 /*
 679  * If we have an externally synchronized Linux clock, then update RTC clock
 680  * accordingly every ~11 minutes. Generally RTCs can only store second
 681  * precision, but many RTCs will adjust the phase of their second tick to
 682  * match the moment of update. This infrastructure arranges to call to the RTC
 683  * set at the correct moment to phase synchronize the RTC second tick over
 684  * with the kernel clock.
 685  */
 686 static void sync_hw_clock(struct work_struct *work)
 687 {
 688         /*
 689          * Don't update if STA_UNSYNC is set and if ntp_notify_cmos_timer()
 690          * managed to schedule the work between the timer firing and the
 691          * work being able to rearm the timer. Wait for the timer to expire.
 692          */
 693         if (!ntp_synced() || hrtimer_is_queued(&sync_hrtimer))
 694                 return;
 695
 696         if (sync_cmos_clock())
 697                 return;
 698
 699         sync_rtc_clock();
 700 }
 701
 702 void ntp_notify_cmos_timer(void)
 703 {
 704         /*
 705          * When the work is currently executed but has not yet the timer
 706          * rearmed this queues the work immediately again. No big issue,
 707          * just a pointless work scheduled.
 708          */
 709         if (ntp_synced() && !hrtimer_is_queued(&sync_hrtimer))
 710                 queue_work(system_power_efficient_wq, &sync_work);
 711 }
 712
 713 static void __init ntp_init_cmos_sync(void)
 714 {
 715         hrtimer_init(&sync_hrtimer, CLOCK_REALTIME, HRTIMER_MODE_ABS);
 716         sync_hrtimer.function = sync_timer_callback;
 717 }
 718 #else /* CONFIG_GENERIC_CMOS_UPDATE) || defined(CONFIG_RTC_SYSTOHC) */
 719 static inline void __init ntp_init_cmos_sync(void) { }
 720 #endif /* !CONFIG_GENERIC_CMOS_UPDATE) || defined(CONFIG_RTC_SYSTOHC) */
 721
 722 /*
 723  * Propagate a new txc->status value into the NTP state:
 724  */
 725 static inline void process_adj_status(const struct __kernel_timex *txc)
 726 {
 727         if ((time_status & STA_PLL) && !(txc->status & STA_PLL)) {
 728                 time_state = TIME_OK;
 729                 time_status = STA_UNSYNC;
 730                 ntp_next_leap_sec = TIME64_MAX;
 731                 /* restart PPS frequency calibration */
 732                 pps_reset_freq_interval();
 733         }
 734
 735         /*
 736          * If we turn on PLL adjustments then reset the
 737          * reference time to current time.
 738          */
 739         if (!(time_status & STA_PLL) && (txc->status & STA_PLL))
 740                 time_reftime = __ktime_get_real_seconds();
 741
 742         /* only set allowed bits */
 743         time_status &= STA_RONLY;
 744         time_status |= txc->status & ~STA_RONLY;
 745 }
 746
 747
 748 static inline void process_adjtimex_modes(const struct __kernel_timex *txc,
 749                                           s32 *time_tai)
 750 {
 751         if (txc->modes & ADJ_STATUS)
 752                 process_adj_status(txc);
 753
 754         if (txc->modes & ADJ_NANO)
 755                 time_status |= STA_NANO;
 756
 757         if (txc->modes & ADJ_MICRO)
 758                 time_status &= ~STA_NANO;
 759
 760         if (txc->modes & ADJ_FREQUENCY) {
 761                 time_freq = txc->freq * PPM_SCALE;
 762                 time_freq = min(time_freq, MAXFREQ_SCALED);
 763                 time_freq = max(time_freq, -MAXFREQ_SCALED);
 764                 /* update pps_freq */
 765                 pps_set_freq(time_freq);
 766         }
 767
 768         if (txc->modes & ADJ_MAXERROR)
 769                 time_maxerror = txc->maxerror;
 770
 771         if (txc->modes & ADJ_ESTERROR)
 772                 time_esterror = txc->esterror;
 773
 774         if (txc->modes & ADJ_TIMECONST) {
 775                 time_constant = txc->constant;
 776                 if (!(time_status & STA_NANO))
 777                         time_constant += 4;
 778                 time_constant = min(time_constant, (long)MAXTC);
 779                 time_constant = max(time_constant, 0l);
 780         }
 781
 782         if (txc->modes & ADJ_TAI &&
 783                         txc->constant >= 0 && txc->constant <= MAX_TAI_OFFSET)
 784                 *time_tai = txc->constant;
 785
 786         if (txc->modes & ADJ_OFFSET)
 787                 ntp_update_offset(txc->offset);
 788
 789         if (txc->modes & ADJ_TICK)
 790                 tick_usec = txc->tick;
 791
 792         if (txc->modes & (ADJ_TICK|ADJ_FREQUENCY|ADJ_OFFSET))
 793                 ntp_update_frequency();
 794 }
 795
 796
 797 /*
 798  * adjtimex mainly allows reading (and writing, if superuser) of
 799  * kernel time-keeping variables. used by xntpd.
 800  */
 801 int __do_adjtimex(struct __kernel_timex *txc, const struct timespec64 *ts,
 802                   s32 *time_tai, struct audit_ntp_data *ad)
 803 {
 804         int result;
 805
 806         if (txc->modes & ADJ_ADJTIME) {
 807                 long save_adjust = time_adjust;
 808
 809                 if (!(txc->modes & ADJ_OFFSET_READONLY)) {
 810                         /* adjtime() is independent from ntp_adjtime() */
 811                         time_adjust = txc->offset;
 812                         ntp_update_frequency();
 813
 814                         audit_ntp_set_old(ad, AUDIT_NTP_ADJUST, save_adjust);
 815                         audit_ntp_set_new(ad, AUDIT_NTP_ADJUST, time_adjust);
 816                 }
 817                 txc->offset = save_adjust;
 818         } else {
 819                 /* If there are input parameters, then process them: */
 820                 if (txc->modes) {
 821                         audit_ntp_set_old(ad, AUDIT_NTP_OFFSET, time_offset);
 822                         audit_ntp_set_old(ad, AUDIT_NTP_FREQ,   time_freq);
 823                         audit_ntp_set_old(ad, AUDIT_NTP_STATUS, time_status);
 824                         audit_ntp_set_old(ad, AUDIT_NTP_TAI,    *time_tai);
 825                         audit_ntp_set_old(ad, AUDIT_NTP_TICK,   tick_usec);
 826
 827                         process_adjtimex_modes(txc, time_tai);
 828
 829                         audit_ntp_set_new(ad, AUDIT_NTP_OFFSET, time_offset);
 830                         audit_ntp_set_new(ad, AUDIT_NTP_FREQ,   time_freq);
 831                         audit_ntp_set_new(ad, AUDIT_NTP_STATUS, time_status);
 832                         audit_ntp_set_new(ad, AUDIT_NTP_TAI,    *time_tai);
 833                         audit_ntp_set_new(ad, AUDIT_NTP_TICK,   tick_usec);
 834                 }
 835
 836                 txc->offset = shift_right(time_offset * NTP_INTERVAL_FREQ,
 837                                   NTP_SCALE_SHIFT);
 838                 if (!(time_status & STA_NANO))
 839                         txc->offset = (u32)txc->offset / NSEC_PER_USEC;
 840         }
 841
 842         result = time_state;    /* mostly `TIME_OK' */
 843         /* check for errors */
 844         if (is_error_status(time_status))
 845                 result = TIME_ERROR;
 846
 847         txc->freq          = shift_right((time_freq >> PPM_SCALE_INV_SHIFT) *
 848                                          PPM_SCALE_INV, NTP_SCALE_SHIFT);
 849         txc->maxerror      = time_maxerror;
 850         txc->esterror      = time_esterror;
 851         txc->status        = time_status;
 852         txc->constant      = time_constant;
 853         txc->precision     = 1;
 854         txc->tolerance     = MAXFREQ_SCALED / PPM_SCALE;
 855         txc->tick          = tick_usec;
 856         txc->tai           = *time_tai;
 857
 858         /* fill PPS status fields */
 859         pps_fill_timex(txc);
 860
 861         txc->time.tv_sec = ts->tv_sec;
 862         txc->time.tv_usec = ts->tv_nsec;
 863         if (!(time_status & STA_NANO))
 864                 txc->time.tv_usec = ts->tv_nsec / NSEC_PER_USEC;
 865
 866         /* Handle leapsec adjustments */
 867         if (unlikely(ts->tv_sec >= ntp_next_leap_sec)) {
 868                 if ((time_state == TIME_INS) && (time_status & STA_INS)) {
 869                         result = TIME_OOP;
 870                         txc->tai++;
 871                         txc->time.tv_sec--;
 872                 }
 873                 if ((time_state == TIME_DEL) && (time_status & STA_DEL)) {
 874                         result = TIME_WAIT;
 875                         txc->tai--;
 876                         txc->time.tv_sec++;
 877                 }
 878                 if ((time_state == TIME_OOP) &&
 879                                         (ts->tv_sec == ntp_next_leap_sec)) {
 880                         result = TIME_WAIT;
 881                 }
 882         }
 883
 884         return result;
 885 }
 886
 887 #ifdef  CONFIG_NTP_PPS
 888
 889 /* actually struct pps_normtime is good old struct timespec, but it is
 890  * semantically different (and it is the reason why it was invented):
 891  * pps_normtime.nsec has a range of ( -NSEC_PER_SEC / 2, NSEC_PER_SEC / 2 ]
 892  * while timespec.tv_nsec has a range of [0, NSEC_PER_SEC) */
 893 struct pps_normtime {
 894         s64             sec;    /* seconds */
 895         long            nsec;   /* nanoseconds */
 896 };
 897
 898 /* normalize the timestamp so that nsec is in the
 899    ( -NSEC_PER_SEC / 2, NSEC_PER_SEC / 2 ] interval */
 900 static inline struct pps_normtime pps_normalize_ts(struct timespec64 ts)
 901 {
 902         struct pps_normtime norm = {
 903                 .sec = ts.tv_sec,
 904                 .nsec = ts.tv_nsec
 905         };
 906
 907         if (norm.nsec > (NSEC_PER_SEC >> 1)) {
 908                 norm.nsec -= NSEC_PER_SEC;
 909                 norm.sec++;
 910         }
 911
 912         return norm;
 913 }
 914
 915 /* get current phase correction and jitter */
 916 static inline long pps_phase_filter_get(long *jitter)
 917 {
 918         *jitter = pps_tf[0] - pps_tf[1];
 919         if (*jitter < 0)
 920                 *jitter = -*jitter;
 921
 922         /* TODO: test various filters */
 923         return pps_tf[0];
 924 }
 925
 926 /* add the sample to the phase filter */
 927 static inline void pps_phase_filter_add(long err)
 928 {
 929         pps_tf[2] = pps_tf[1];
 930         pps_tf[1] = pps_tf[0];
 931         pps_tf[0] = err;
 932 }
 933
 934 /* decrease frequency calibration interval length.
 935  * It is halved after four consecutive unstable intervals.
 936  */
 937 static inline void pps_dec_freq_interval(void)
 938 {
 939         if (--pps_intcnt <= -PPS_INTCOUNT) {
 940                 pps_intcnt = -PPS_INTCOUNT;
 941                 if (pps_shift > PPS_INTMIN) {
 942                         pps_shift--;
 943                         pps_intcnt = 0;
 944                 }
 945         }
 946 }
 947
 948 /* increase frequency calibration interval length.
 949  * It is doubled after four consecutive stable intervals.
 950  */
 951 static inline void pps_inc_freq_interval(void)
 952 {
 953         if (++pps_intcnt >= PPS_INTCOUNT) {
 954                 pps_intcnt = PPS_INTCOUNT;
 955                 if (pps_shift < PPS_INTMAX) {
 956                         pps_shift++;
 957                         pps_intcnt = 0;
 958                 }
 959         }
 960 }
 961
 962 /* update clock frequency based on MONOTONIC_RAW clock PPS signal
 963  * timestamps
 964  *
 965  * At the end of the calibration interval the difference between the
 966  * first and last MONOTONIC_RAW clock timestamps divided by the length
 967  * of the interval becomes the frequency update. If the interval was
 968  * too long, the data are discarded.
 969  * Returns the difference between old and new frequency values.
 970  */
 971 static long hardpps_update_freq(struct pps_normtime freq_norm)
 972 {
 973         long delta, delta_mod;
 974         s64 ftemp;
 975
 976         /* check if the frequency interval was too long */
 977         if (freq_norm.sec > (2 << pps_shift)) {
 978                 time_status |= STA_PPSERROR;
 979                 pps_errcnt++;
 980                 pps_dec_freq_interval();
 981                 printk_deferred(KERN_ERR
 982                         "hardpps: PPSERROR: interval too long - %lld s\n",
 983                         freq_norm.sec);
 984                 return 0;
 985         }
 986
 987         /* here the raw frequency offset and wander (stability) is
 988          * calculated. If the wander is less than the wander threshold
 989          * the interval is increased; otherwise it is decreased.
 990          */
 991         ftemp = div_s64(((s64)(-freq_norm.nsec)) << NTP_SCALE_SHIFT,
 992                         freq_norm.sec);
 993         delta = shift_right(ftemp - pps_freq, NTP_SCALE_SHIFT);
 994         pps_freq = ftemp;
 995         if (delta > PPS_MAXWANDER || delta < -PPS_MAXWANDER) {
 996                 printk_deferred(KERN_WARNING
 997                                 "hardpps: PPSWANDER: change=%ld\n", delta);
 998                 time_status |= STA_PPSWANDER;
 999                 pps_stbcnt++;
1000                 pps_dec_freq_interval();
1001         } else {        /* good sample */
1002                 pps_inc_freq_interval();
1003         }
1004
1005         /* the stability metric is calculated as the average of recent
1006          * frequency changes, but is used only for performance
1007          * monitoring
1008          */
1009         delta_mod = delta;
1010         if (delta_mod < 0)
1011                 delta_mod = -delta_mod;
1012         pps_stabil += (div_s64(((s64)delta_mod) <<
1013                                 (NTP_SCALE_SHIFT - SHIFT_USEC),
1014                                 NSEC_PER_USEC) - pps_stabil) >> PPS_INTMIN;
1015
1016         /* if enabled, the system clock frequency is updated */
1017         if ((time_status & STA_PPSFREQ) != 0 &&
1018             (time_status & STA_FREQHOLD) == 0) {
1019                 time_freq = pps_freq;
1020                 ntp_update_frequency();
1021         }
1022
1023         return delta;
1024 }
1025
1026 /* correct REALTIME clock phase error against PPS signal */
1027 static void hardpps_update_phase(long error)
1028 {
1029         long correction = -error;
1030         long jitter;
1031
1032         /* add the sample to the median filter */
1033         pps_phase_filter_add(correction);
1034         correction = pps_phase_filter_get(&jitter);
1035
1036         /* Nominal jitter is due to PPS signal noise. If it exceeds the
1037          * threshold, the sample is discarded; otherwise, if so enabled,
1038          * the time offset is updated.
1039          */
1040         if (jitter > (pps_jitter << PPS_POPCORN)) {
1041                 printk_deferred(KERN_WARNING
1042                                 "hardpps: PPSJITTER: jitter=%ld, limit=%ld\n",
1043                                 jitter, (pps_jitter << PPS_POPCORN));
1044                 time_status |= STA_PPSJITTER;
1045                 pps_jitcnt++;
1046         } else if (time_status & STA_PPSTIME) {
1047                 /* correct the time using the phase offset */
1048                 time_offset = div_s64(((s64)correction) << NTP_SCALE_SHIFT,
1049                                 NTP_INTERVAL_FREQ);
1050                 /* cancel running adjtime() */
1051                 time_adjust = 0;
1052         }
1053         /* update jitter */
1054         pps_jitter += (jitter - pps_jitter) >> PPS_INTMIN;
1055 }
1056
1057 /*
1058  * __hardpps() - discipline CPU clock oscillator to external PPS signal
1059  *
1060  * This routine is called at each PPS signal arrival in order to
1061  * discipline the CPU clock oscillator to the PPS signal. It takes two
1062  * parameters: REALTIME and MONOTONIC_RAW clock timestamps. The former
1063  * is used to correct clock phase error and the latter is used to
1064  * correct the frequency.
1065  *
1066  * This code is based on David Mills's reference nanokernel
1067  * implementation. It was mostly rewritten but keeps the same idea.
1068  */
1069 void __hardpps(const struct timespec64 *phase_ts, const struct timespec64 *raw_ts)
1070 {
1071         struct pps_normtime pts_norm, freq_norm;
1072
1073         pts_norm = pps_normalize_ts(*phase_ts);
1074
1075         /* clear the error bits, they will be set again if needed */
1076         time_status &= ~(STA_PPSJITTER | STA_PPSWANDER | STA_PPSERROR);
1077
1078         /* indicate signal presence */
1079         time_status |= STA_PPSSIGNAL;
1080         pps_valid = PPS_VALID;
1081
1082         /* when called for the first time,
1083          * just start the frequency interval */
1084         if (unlikely(pps_fbase.tv_sec == 0)) {
1085                 pps_fbase = *raw_ts;
1086                 return;
1087         }
1088
1089         /* ok, now we have a base for frequency calculation */
1090         freq_norm = pps_normalize_ts(timespec64_sub(*raw_ts, pps_fbase));
1091
1092         /* check that the signal is in the range
1093          * [1s - MAXFREQ us, 1s + MAXFREQ us], otherwise reject it */
1094         if ((freq_norm.sec == 0) ||
1095                         (freq_norm.nsec > MAXFREQ * freq_norm.sec) ||
1096                         (freq_norm.nsec < -MAXFREQ * freq_norm.sec)) {
1097                 time_status |= STA_PPSJITTER;
1098                 /* restart the frequency calibration interval */
1099                 pps_fbase = *raw_ts;
1100                 printk_deferred(KERN_ERR "hardpps: PPSJITTER: bad pulse\n");
1101                 return;
1102         }
1103
1104         /* signal is ok */
1105
1106         /* check if the current frequency interval is finished */
1107         if (freq_norm.sec >= (1 << pps_shift)) {
1108                 pps_calcnt++;
1109                 /* restart the frequency calibration interval */
1110                 pps_fbase = *raw_ts;
1111                 hardpps_update_freq(freq_norm);
1112         }
1113
1114         hardpps_update_phase(pts_norm.nsec);
1115
1116 }
1117 #endif  /* CONFIG_NTP_PPS */
1118
1119 static int __init ntp_tick_adj_setup(char *str)
1120 {
1121         int rc = kstrtos64(str, 0, &ntp_tick_adj);
1122         if (rc)
1123                 return rc;
1124
1125         ntp_tick_adj <<= NTP_SCALE_SHIFT;
1126         return 1;
1127 }
1128
1129 __setup("ntp_tick_adj=", ntp_tick_adj_setup);
1130
1131 void __init ntp_init(void)
1132 {
1133         ntp_clear();
1134         ntp_init_cmos_sync();
1135 }