kernel/time/ntp.c

   1 /*
   2  * NTP state machine interfaces and logic.
   3  *
   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
   6  * changelogs.
   7  */
   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/math64.h>
  14 #include <linux/timex.h>
  15 #include <linux/time.h>
  16 #include <linux/mm.h>
  17 #include <linux/module.h>
  18
  19 #include "tick-internal.h"
  20
  21 /*
  22  * NTP timekeeping variables:
  23  */
  24
  25 /* USER_HZ period (usecs): */
  26 unsigned long                   tick_usec = TICK_USEC;
  27
  28 /* ACTHZ period (nsecs): */
  29 unsigned long                   tick_nsec;
  30
  31 u64                             tick_length;
  32 static u64                      tick_length_base;
  33
  34 #define MAX_TICKADJ             500LL           /* usecs */
  35 #define MAX_TICKADJ_SCALED \
  36         (((MAX_TICKADJ * NSEC_PER_USEC) << NTP_SCALE_SHIFT) / NTP_INTERVAL_FREQ)
  37
  38 /*
  39  * phase-lock loop variables
  40  */
  41
  42 /*
  43  * clock synchronization status
  44  *
  45  * (TIME_ERROR prevents overwriting the CMOS clock)
  46  */
  47 static int                      time_state = TIME_OK;
  48
  49 /* clock status bits:                                                   */
  50 int                             time_status = STA_UNSYNC;
  51
  52 /* TAI offset (secs):                                                   */
  53 static long                     time_tai;
  54
  55 /* time adjustment (nsecs):                                             */
  56 static s64                      time_offset;
  57
  58 /* pll time constant:                                                   */
  59 static long                     time_constant = 2;
  60
  61 /* maximum error (usecs):                                               */
  62 static long                     time_maxerror = NTP_PHASE_LIMIT;
  63
  64 /* estimated error (usecs):                                             */
  65 static long                     time_esterror = NTP_PHASE_LIMIT;
  66
  67 /* frequency offset (scaled nsecs/secs):                                */
  68 static s64                      time_freq;
  69
  70 /* time at last adjustment (secs):                                      */
  71 static long                     time_reftime;
  72
  73 static long                     time_adjust;
  74
  75 /* constant (boot-param configurable) NTP tick adjustment (upscaled)    */
  76 static s64                      ntp_tick_adj;
  77
  78 #ifdef CONFIG_NTP_PPS
  79
  80 /*
  81  * The following variables are used when a pulse-per-second (PPS) signal
  82  * is available. They establish the engineering parameters of the clock
  83  * discipline loop when controlled by the PPS signal.
  84  */
  85 #define PPS_VALID       10      /* PPS signal watchdog max (s) */
  86 #define PPS_POPCORN     4       /* popcorn spike threshold (shift) */
  87 #define PPS_INTMIN      2       /* min freq interval (s) (shift) */
  88 #define PPS_INTMAX      8       /* max freq interval (s) (shift) */
  89 #define PPS_INTCOUNT    4       /* number of consecutive good intervals to
  90                                    increase pps_shift or consecutive bad
  91                                    intervals to decrease it */
  92 #define PPS_MAXWANDER   100000  /* max PPS freq wander (ns/s) */
  93
  94 static int pps_valid;           /* signal watchdog counter */
  95 static long pps_tf[3];          /* phase median filter */
  96 static long pps_jitter;         /* current jitter (ns) */
  97 static struct timespec pps_fbase; /* beginning of the last freq interval */
  98 static int pps_shift;           /* current interval duration (s) (shift) */
  99 static int pps_intcnt;          /* interval counter */
 100 static s64 pps_freq;            /* frequency offset (scaled ns/s) */
 101 static long pps_stabil;         /* current stability (scaled ns/s) */
 102
 103 /*
 104  * PPS signal quality monitors
 105  */
 106 static long pps_calcnt;         /* calibration intervals */
 107 static long pps_jitcnt;         /* jitter limit exceeded */
 108 static long pps_stbcnt;         /* stability limit exceeded */
 109 static long pps_errcnt;         /* calibration errors */
 110
 111
 112 /* PPS kernel consumer compensates the whole phase error immediately.
 113  * Otherwise, reduce the offset by a fixed factor times the time constant.
 114  */
 115 static inline s64 ntp_offset_chunk(s64 offset)
 116 {
 117         if (time_status & STA_PPSTIME && time_status & STA_PPSSIGNAL)
 118                 return offset;
 119         else
 120                 return shift_right(offset, SHIFT_PLL + time_constant);
 121 }
 122
 123 static inline void pps_reset_freq_interval(void)
 124 {
 125         /* the PPS calibration interval may end
 126            surprisingly early */
 127         pps_shift = PPS_INTMIN;
 128         pps_intcnt = 0;
 129 }
 130
 131 /**
 132  * pps_clear - Clears the PPS state variables
 133  *
 134  * Must be called while holding a write on the xtime_lock
 135  */
 136 static inline void pps_clear(void)
 137 {
 138         pps_reset_freq_interval();
 139         pps_tf[0] = 0;
 140         pps_tf[1] = 0;
 141         pps_tf[2] = 0;
 142         pps_fbase.tv_sec = pps_fbase.tv_nsec = 0;
 143         pps_freq = 0;
 144 }
 145
 146 /* Decrease pps_valid to indicate that another second has passed since
 147  * the last PPS signal. When it reaches 0, indicate that PPS signal is
 148  * missing.
 149  *
 150  * Must be called while holding a write on the xtime_lock
 151  */
 152 static inline void pps_dec_valid(void)
 153 {
 154         if (pps_valid > 0)
 155                 pps_valid--;
 156         else {
 157                 time_status &= ~(STA_PPSSIGNAL | STA_PPSJITTER |
 158                                  STA_PPSWANDER | STA_PPSERROR);
 159                 pps_clear();
 160         }
 161 }
 162
 163 static inline void pps_set_freq(s64 freq)
 164 {
 165         pps_freq = freq;
 166 }
 167
 168 static inline int is_error_status(int status)
 169 {
 170         return (time_status & (STA_UNSYNC|STA_CLOCKERR))
 171                 /* PPS signal lost when either PPS time or
 172                  * PPS frequency synchronization requested
 173                  */
 174                 || ((time_status & (STA_PPSFREQ|STA_PPSTIME))
 175                         && !(time_status & STA_PPSSIGNAL))
 176                 /* PPS jitter exceeded when
 177                  * PPS time synchronization requested */
 178                 || ((time_status & (STA_PPSTIME|STA_PPSJITTER))
 179                         == (STA_PPSTIME|STA_PPSJITTER))
 180                 /* PPS wander exceeded or calibration error when
 181                  * PPS frequency synchronization requested
 182                  */
 183                 || ((time_status & STA_PPSFREQ)
 184                         && (time_status & (STA_PPSWANDER|STA_PPSERROR)));
 185 }
 186
 187 static inline void pps_fill_timex(struct timex *txc)
 188 {
 189         txc->ppsfreq       = shift_right((pps_freq >> PPM_SCALE_INV_SHIFT) *
 190                                          PPM_SCALE_INV, NTP_SCALE_SHIFT);
 191         txc->jitter        = pps_jitter;
 192         if (!(time_status & STA_NANO))
 193                 txc->jitter /= NSEC_PER_USEC;
 194         txc->shift         = pps_shift;
 195         txc->stabil        = pps_stabil;
 196         txc->jitcnt        = pps_jitcnt;
 197         txc->calcnt        = pps_calcnt;
 198         txc->errcnt        = pps_errcnt;
 199         txc->stbcnt        = pps_stbcnt;
 200 }
 201
 202 #else /* !CONFIG_NTP_PPS */
 203
 204 static inline s64 ntp_offset_chunk(s64 offset)
 205 {
 206         return shift_right(offset, SHIFT_PLL + time_constant);
 207 }
 208
 209 static inline void pps_reset_freq_interval(void) {}
 210 static inline void pps_clear(void) {}
 211 static inline void pps_dec_valid(void) {}
 212 static inline void pps_set_freq(s64 freq) {}
 213
 214 static inline int is_error_status(int status)
 215 {
 216         return status & (STA_UNSYNC|STA_CLOCKERR);
 217 }
 218
 219 static inline void pps_fill_timex(struct timex *txc)
 220 {
 221         /* PPS is not implemented, so these are zero */
 222         txc->ppsfreq       = 0;
 223         txc->jitter        = 0;
 224         txc->shift         = 0;
 225         txc->stabil        = 0;
 226         txc->jitcnt        = 0;
 227         txc->calcnt        = 0;
 228         txc->errcnt        = 0;
 229         txc->stbcnt        = 0;
 230 }
 231
 232 #endif /* CONFIG_NTP_PPS */
 233
 234 /*
 235  * NTP methods:
 236  */
 237
 238 /*
 239  * Update (tick_length, tick_length_base, tick_nsec), based
 240  * on (tick_usec, ntp_tick_adj, time_freq):
 241  */
 242 static void ntp_update_frequency(void)
 243 {
 244         u64 second_length;
 245         u64 new_base;
 246
 247         second_length            = (u64)(tick_usec * NSEC_PER_USEC * USER_HZ)
 248                                                 << NTP_SCALE_SHIFT;
 249
 250         second_length           += ntp_tick_adj;
 251         second_length           += time_freq;
 252
 253         tick_nsec                = div_u64(second_length, HZ) >> NTP_SCALE_SHIFT;
 254         new_base                 = div_u64(second_length, NTP_INTERVAL_FREQ);
 255
 256         /*
 257          * Don't wait for the next second_overflow, apply
 258          * the change to the tick length immediately:
 259          */
 260         tick_length             += new_base - tick_length_base;
 261         tick_length_base         = new_base;
 262 }
 263
 264 static inline s64 ntp_update_offset_fll(s64 offset64, long secs)
 265 {
 266         time_status &= ~STA_MODE;
 267
 268         if (secs < MINSEC)
 269                 return 0;
 270
 271         if (!(time_status & STA_FLL) && (secs <= MAXSEC))
 272                 return 0;
 273
 274         time_status |= STA_MODE;
 275
 276         return div64_long(offset64 << (NTP_SCALE_SHIFT - SHIFT_FLL), secs);
 277 }
 278
 279 static void ntp_update_offset(long offset)
 280 {
 281         s64 freq_adj;
 282         s64 offset64;
 283         long secs;
 284
 285         if (!(time_status & STA_PLL))
 286                 return;
 287
 288         if (!(time_status & STA_NANO))
 289                 offset *= NSEC_PER_USEC;
 290
 291         /*
 292          * Scale the phase adjustment and
 293          * clamp to the operating range.
 294          */
 295         offset = min(offset, MAXPHASE);
 296         offset = max(offset, -MAXPHASE);
 297
 298         /*
 299          * Select how the frequency is to be controlled
 300          * and in which mode (PLL or FLL).
 301          */
 302         secs = get_seconds() - time_reftime;
 303         if (unlikely(time_status & STA_FREQHOLD))
 304                 secs = 0;
 305
 306         time_reftime = get_seconds();
 307
 308         offset64    = offset;
 309         freq_adj    = ntp_update_offset_fll(offset64, secs);
 310
 311         /*
 312          * Clamp update interval to reduce PLL gain with low
 313          * sampling rate (e.g. intermittent network connection)
 314          * to avoid instability.
 315          */
 316         if (unlikely(secs > 1 << (SHIFT_PLL + 1 + time_constant)))
 317                 secs = 1 << (SHIFT_PLL + 1 + time_constant);
 318
 319         freq_adj    += (offset64 * secs) <<
 320                         (NTP_SCALE_SHIFT - 2 * (SHIFT_PLL + 2 + time_constant));
 321
 322         freq_adj    = min(freq_adj + time_freq, MAXFREQ_SCALED);
 323
 324         time_freq   = max(freq_adj, -MAXFREQ_SCALED);
 325
 326         time_offset = div_s64(offset64 << NTP_SCALE_SHIFT, NTP_INTERVAL_FREQ);
 327 }
 328
 329 /**
 330  * ntp_clear - Clears the NTP state variables
 331  *
 332  * Must be called while holding a write on the xtime_lock
 333  */
 334 void ntp_clear(void)
 335 {
 336         time_adjust     = 0;            /* stop active adjtime() */
 337         time_status     |= STA_UNSYNC;
 338         time_maxerror   = NTP_PHASE_LIMIT;
 339         time_esterror   = NTP_PHASE_LIMIT;
 340
 341         ntp_update_frequency();
 342
 343         tick_length     = tick_length_base;
 344         time_offset     = 0;
 345
 346         /* Clear PPS state variables */
 347         pps_clear();
 348 }
 349
 350 /*
 351  * this routine handles the overflow of the microsecond field
 352  *
 353  * The tricky bits of code to handle the accurate clock support
 354  * were provided by Dave Mills (Mills@UDEL.EDU) of NTP fame.
 355  * They were originally developed for SUN and DEC kernels.
 356  * All the kudos should go to Dave for this stuff.
 357  *
 358  * Also handles leap second processing, and returns leap offset
 359  */
 360 int second_overflow(unsigned long secs)
 361 {
 362         int leap = 0;
 363         s64 delta;
 364
 365         /*
 366          * Leap second processing. If in leap-insert state at the end of the
 367          * day, the system clock is set back one second; if in leap-delete
 368          * state, the system clock is set ahead one second.
 369          */
 370         switch (time_state) {
 371         case TIME_OK:
 372                 if (time_status & STA_INS)
 373                         time_state = TIME_INS;
 374                 else if (time_status & STA_DEL)
 375                         time_state = TIME_DEL;
 376                 break;
 377         case TIME_INS:
 378                 if (secs % 86400 == 0) {
 379                         leap = -1;
 380                         time_state = TIME_OOP;
 381                         time_tai++;
 382                         printk(KERN_NOTICE
 383                                 "Clock: inserting leap second 23:59:60 UTC\n");
 384                 }
 385                 break;
 386         case TIME_DEL:
 387                 if ((secs + 1) % 86400 == 0) {
 388                         leap = 1;
 389                         time_tai--;
 390                         time_state = TIME_WAIT;
 391                         printk(KERN_NOTICE
 392                                 "Clock: deleting leap second 23:59:59 UTC\n");
 393                 }
 394                 break;
 395         case TIME_OOP:
 396                 time_state = TIME_WAIT;
 397                 break;
 398
 399         case TIME_WAIT:
 400                 if (!(time_status & (STA_INS | STA_DEL)))
 401                         time_state = TIME_OK;
 402                 break;
 403         }
 404
 405
 406         /* Bump the maxerror field */
 407         time_maxerror += MAXFREQ / NSEC_PER_USEC;
 408         if (time_maxerror > NTP_PHASE_LIMIT) {
 409                 time_maxerror = NTP_PHASE_LIMIT;
 410                 time_status |= STA_UNSYNC;
 411         }
 412
 413         /* Compute the phase adjustment for the next second */
 414         tick_length      = tick_length_base;
 415
 416         delta            = ntp_offset_chunk(time_offset);
 417         time_offset     -= delta;
 418         tick_length     += delta;
 419
 420         /* Check PPS signal */
 421         pps_dec_valid();
 422
 423         if (!time_adjust)
 424                 goto out;
 425
 426         if (time_adjust > MAX_TICKADJ) {
 427                 time_adjust -= MAX_TICKADJ;
 428                 tick_length += MAX_TICKADJ_SCALED;
 429                 goto out;
 430         }
 431
 432         if (time_adjust < -MAX_TICKADJ) {
 433                 time_adjust += MAX_TICKADJ;
 434                 tick_length -= MAX_TICKADJ_SCALED;
 435                 goto out;
 436         }
 437
 438         tick_length += (s64)(time_adjust * NSEC_PER_USEC / NTP_INTERVAL_FREQ)
 439                                                          << NTP_SCALE_SHIFT;
 440         time_adjust = 0;
 441 out:
 442         return leap;
 443 }
 444
 445 #ifdef CONFIG_GENERIC_CMOS_UPDATE
 446
 447 /* Disable the cmos update - used by virtualization and embedded */
 448 int no_sync_cmos_clock  __read_mostly;
 449
 450 static void sync_cmos_clock(struct work_struct *work);
 451
 452 static DECLARE_DELAYED_WORK(sync_cmos_work, sync_cmos_clock);
 453
 454 static void sync_cmos_clock(struct work_struct *work)
 455 {
 456         struct timespec now, next;
 457         int fail = 1;
 458
 459         /*
 460          * If we have an externally synchronized Linux clock, then update
 461          * CMOS clock accordingly every ~11 minutes. Set_rtc_mmss() has to be
 462          * called as close as possible to 500 ms before the new second starts.
 463          * This code is run on a timer.  If the clock is set, that timer
 464          * may not expire at the correct time.  Thus, we adjust...
 465          */
 466         if (!ntp_synced()) {
 467                 /*
 468                  * Not synced, exit, do not restart a timer (if one is
 469                  * running, let it run out).
 470                  */
 471                 return;
 472         }
 473
 474         getnstimeofday(&now);
 475         if (abs(now.tv_nsec - (NSEC_PER_SEC / 2)) <= tick_nsec / 2)
 476                 fail = update_persistent_clock(now);
 477
 478         next.tv_nsec = (NSEC_PER_SEC / 2) - now.tv_nsec - (TICK_NSEC / 2);
 479         if (next.tv_nsec <= 0)
 480                 next.tv_nsec += NSEC_PER_SEC;
 481
 482         if (!fail)
 483                 next.tv_sec = 659;
 484         else
 485                 next.tv_sec = 0;
 486
 487         if (next.tv_nsec >= NSEC_PER_SEC) {
 488                 next.tv_sec++;
 489                 next.tv_nsec -= NSEC_PER_SEC;
 490         }
 491         schedule_delayed_work(&sync_cmos_work, timespec_to_jiffies(&next));
 492 }
 493
 494 static void notify_cmos_timer(void)
 495 {
 496         if (!no_sync_cmos_clock)
 497                 schedule_delayed_work(&sync_cmos_work, 0);
 498 }
 499
 500 #else
 501 static inline void notify_cmos_timer(void) { }
 502 #endif
 503
 504
 505 /*
 506  * Propagate a new txc->status value into the NTP state:
 507  */
 508 static inline void process_adj_status(struct timex *txc, struct timespec *ts)
 509 {
 510         if ((time_status & STA_PLL) && !(txc->status & STA_PLL)) {
 511                 time_state = TIME_OK;
 512                 time_status = STA_UNSYNC;
 513                 /* restart PPS frequency calibration */
 514                 pps_reset_freq_interval();
 515         }
 516
 517         /*
 518          * If we turn on PLL adjustments then reset the
 519          * reference time to current time.
 520          */
 521         if (!(time_status & STA_PLL) && (txc->status & STA_PLL))
 522                 time_reftime = get_seconds();
 523
 524         /* only set allowed bits */
 525         time_status &= STA_RONLY;
 526         time_status |= txc->status & ~STA_RONLY;
 527
 528 }
 529 /*
 530  * Called with the xtime lock held, so we can access and modify
 531  * all the global NTP state:
 532  */
 533 static inline void process_adjtimex_modes(struct timex *txc, struct timespec *ts)
 534 {
 535         if (txc->modes & ADJ_STATUS)
 536                 process_adj_status(txc, ts);
 537
 538         if (txc->modes & ADJ_NANO)
 539                 time_status |= STA_NANO;
 540
 541         if (txc->modes & ADJ_MICRO)
 542                 time_status &= ~STA_NANO;
 543
 544         if (txc->modes & ADJ_FREQUENCY) {
 545                 time_freq = txc->freq * PPM_SCALE;
 546                 time_freq = min(time_freq, MAXFREQ_SCALED);
 547                 time_freq = max(time_freq, -MAXFREQ_SCALED);
 548                 /* update pps_freq */
 549                 pps_set_freq(time_freq);
 550         }
 551
 552         if (txc->modes & ADJ_MAXERROR)
 553                 time_maxerror = txc->maxerror;
 554
 555         if (txc->modes & ADJ_ESTERROR)
 556                 time_esterror = txc->esterror;
 557
 558         if (txc->modes & ADJ_TIMECONST) {
 559                 time_constant = txc->constant;
 560                 if (!(time_status & STA_NANO))
 561                         time_constant += 4;
 562                 time_constant = min(time_constant, (long)MAXTC);
 563                 time_constant = max(time_constant, 0l);
 564         }
 565
 566         if (txc->modes & ADJ_TAI && txc->constant > 0)
 567                 time_tai = txc->constant;
 568
 569         if (txc->modes & ADJ_OFFSET)
 570                 ntp_update_offset(txc->offset);
 571
 572         if (txc->modes & ADJ_TICK)
 573                 tick_usec = txc->tick;
 574
 575         if (txc->modes & (ADJ_TICK|ADJ_FREQUENCY|ADJ_OFFSET))
 576                 ntp_update_frequency();
 577 }
 578
 579 /*
 580  * adjtimex mainly allows reading (and writing, if superuser) of
 581  * kernel time-keeping variables. used by xntpd.
 582  */
 583 int do_adjtimex(struct timex *txc)
 584 {
 585         struct timespec ts;
 586         int result;
 587
 588         /* Validate the data before disabling interrupts */
 589         if (txc->modes & ADJ_ADJTIME) {
 590                 /* singleshot must not be used with any other mode bits */
 591                 if (!(txc->modes & ADJ_OFFSET_SINGLESHOT))
 592                         return -EINVAL;
 593                 if (!(txc->modes & ADJ_OFFSET_READONLY) &&
 594                     !capable(CAP_SYS_TIME))
 595                         return -EPERM;
 596         } else {
 597                 /* In order to modify anything, you gotta be super-user! */
 598                  if (txc->modes && !capable(CAP_SYS_TIME))
 599                         return -EPERM;
 600
 601                 /*
 602                  * if the quartz is off by more than 10% then
 603                  * something is VERY wrong!
 604                  */
 605                 if (txc->modes & ADJ_TICK &&
 606                     (txc->tick <  900000/USER_HZ ||
 607                      txc->tick > 1100000/USER_HZ))
 608                         return -EINVAL;
 609         }
 610
 611         /*
 612          * Check for potential multiplication overflows that can
 613          * only happen on 64-bit systems:
 614          */
 615         if ((txc->modes & ADJ_FREQUENCY) && (BITS_PER_LONG == 64)) {
 616                 if (LLONG_MIN / PPM_SCALE > txc->freq)
 617                         return -EINVAL;
 618                 if (LLONG_MAX / PPM_SCALE < txc->freq)
 619                         return -EINVAL;
 620         }
 621
 622         if (txc->modes & ADJ_SETOFFSET) {
 623                 struct timespec delta;
 624                 delta.tv_sec  = txc->time.tv_sec;
 625                 delta.tv_nsec = txc->time.tv_usec;
 626                 if (!capable(CAP_SYS_TIME))
 627                         return -EPERM;
 628                 if (!(txc->modes & ADJ_NANO))
 629                         delta.tv_nsec *= 1000;
 630                 result = timekeeping_inject_offset(&delta);
 631                 if (result)
 632                         return result;
 633         }
 634
 635         getnstimeofday(&ts);
 636
 637         write_seqlock_irq(&xtime_lock);
 638
 639         if (txc->modes & ADJ_ADJTIME) {
 640                 long save_adjust = time_adjust;
 641
 642                 if (!(txc->modes & ADJ_OFFSET_READONLY)) {
 643                         /* adjtime() is independent from ntp_adjtime() */
 644                         time_adjust = txc->offset;
 645                         ntp_update_frequency();
 646                 }
 647                 txc->offset = save_adjust;
 648         } else {
 649
 650                 /* If there are input parameters, then process them: */
 651                 if (txc->modes)
 652                         process_adjtimex_modes(txc, &ts);
 653
 654                 txc->offset = shift_right(time_offset * NTP_INTERVAL_FREQ,
 655                                   NTP_SCALE_SHIFT);
 656                 if (!(time_status & STA_NANO))
 657                         txc->offset /= NSEC_PER_USEC;
 658         }
 659
 660         result = time_state;    /* mostly `TIME_OK' */
 661         /* check for errors */
 662         if (is_error_status(time_status))
 663                 result = TIME_ERROR;
 664
 665         txc->freq          = shift_right((time_freq >> PPM_SCALE_INV_SHIFT) *
 666                                          PPM_SCALE_INV, NTP_SCALE_SHIFT);
 667         txc->maxerror      = time_maxerror;
 668         txc->esterror      = time_esterror;
 669         txc->status        = time_status;
 670         txc->constant      = time_constant;
 671         txc->precision     = 1;
 672         txc->tolerance     = MAXFREQ_SCALED / PPM_SCALE;
 673         txc->tick          = tick_usec;
 674         txc->tai           = time_tai;
 675
 676         /* fill PPS status fields */
 677         pps_fill_timex(txc);
 678
 679         write_sequnlock_irq(&xtime_lock);
 680
 681         txc->time.tv_sec = ts.tv_sec;
 682         txc->time.tv_usec = ts.tv_nsec;
 683         if (!(time_status & STA_NANO))
 684                 txc->time.tv_usec /= NSEC_PER_USEC;
 685
 686         notify_cmos_timer();
 687
 688         return result;
 689 }
 690
 691 #ifdef  CONFIG_NTP_PPS
 692
 693 /* actually struct pps_normtime is good old struct timespec, but it is
 694  * semantically different (and it is the reason why it was invented):
 695  * pps_normtime.nsec has a range of ( -NSEC_PER_SEC / 2, NSEC_PER_SEC / 2 ]
 696  * while timespec.tv_nsec has a range of [0, NSEC_PER_SEC) */
 697 struct pps_normtime {
 698         __kernel_time_t sec;    /* seconds */
 699         long            nsec;   /* nanoseconds */
 700 };
 701
 702 /* normalize the timestamp so that nsec is in the
 703    ( -NSEC_PER_SEC / 2, NSEC_PER_SEC / 2 ] interval */
 704 static inline struct pps_normtime pps_normalize_ts(struct timespec ts)
 705 {
 706         struct pps_normtime norm = {
 707                 .sec = ts.tv_sec,
 708                 .nsec = ts.tv_nsec
 709         };
 710
 711         if (norm.nsec > (NSEC_PER_SEC >> 1)) {
 712                 norm.nsec -= NSEC_PER_SEC;
 713                 norm.sec++;
 714         }
 715
 716         return norm;
 717 }
 718
 719 /* get current phase correction and jitter */
 720 static inline long pps_phase_filter_get(long *jitter)
 721 {
 722         *jitter = pps_tf[0] - pps_tf[1];
 723         if (*jitter < 0)
 724                 *jitter = -*jitter;
 725
 726         /* TODO: test various filters */
 727         return pps_tf[0];
 728 }
 729
 730 /* add the sample to the phase filter */
 731 static inline void pps_phase_filter_add(long err)
 732 {
 733         pps_tf[2] = pps_tf[1];
 734         pps_tf[1] = pps_tf[0];
 735         pps_tf[0] = err;
 736 }
 737
 738 /* decrease frequency calibration interval length.
 739  * It is halved after four consecutive unstable intervals.
 740  */
 741 static inline void pps_dec_freq_interval(void)
 742 {
 743         if (--pps_intcnt <= -PPS_INTCOUNT) {
 744                 pps_intcnt = -PPS_INTCOUNT;
 745                 if (pps_shift > PPS_INTMIN) {
 746                         pps_shift--;
 747                         pps_intcnt = 0;
 748                 }
 749         }
 750 }
 751
 752 /* increase frequency calibration interval length.
 753  * It is doubled after four consecutive stable intervals.
 754  */
 755 static inline void pps_inc_freq_interval(void)
 756 {
 757         if (++pps_intcnt >= PPS_INTCOUNT) {
 758                 pps_intcnt = PPS_INTCOUNT;
 759                 if (pps_shift < PPS_INTMAX) {
 760                         pps_shift++;
 761                         pps_intcnt = 0;
 762                 }
 763         }
 764 }
 765
 766 /* update clock frequency based on MONOTONIC_RAW clock PPS signal
 767  * timestamps
 768  *
 769  * At the end of the calibration interval the difference between the
 770  * first and last MONOTONIC_RAW clock timestamps divided by the length
 771  * of the interval becomes the frequency update. If the interval was
 772  * too long, the data are discarded.
 773  * Returns the difference between old and new frequency values.
 774  */
 775 static long hardpps_update_freq(struct pps_normtime freq_norm)
 776 {
 777         long delta, delta_mod;
 778         s64 ftemp;
 779
 780         /* check if the frequency interval was too long */
 781         if (freq_norm.sec > (2 << pps_shift)) {
 782                 time_status |= STA_PPSERROR;
 783                 pps_errcnt++;
 784                 pps_dec_freq_interval();
 785                 pr_err("hardpps: PPSERROR: interval too long - %ld s\n",
 786                                 freq_norm.sec);
 787                 return 0;
 788         }
 789
 790         /* here the raw frequency offset and wander (stability) is
 791          * calculated. If the wander is less than the wander threshold
 792          * the interval is increased; otherwise it is decreased.
 793          */
 794         ftemp = div_s64(((s64)(-freq_norm.nsec)) << NTP_SCALE_SHIFT,
 795                         freq_norm.sec);
 796         delta = shift_right(ftemp - pps_freq, NTP_SCALE_SHIFT);
 797         pps_freq = ftemp;
 798         if (delta > PPS_MAXWANDER || delta < -PPS_MAXWANDER) {
 799                 pr_warning("hardpps: PPSWANDER: change=%ld\n", delta);
 800                 time_status |= STA_PPSWANDER;
 801                 pps_stbcnt++;
 802                 pps_dec_freq_interval();
 803         } else {        /* good sample */
 804                 pps_inc_freq_interval();
 805         }
 806
 807         /* the stability metric is calculated as the average of recent
 808          * frequency changes, but is used only for performance
 809          * monitoring
 810          */
 811         delta_mod = delta;
 812         if (delta_mod < 0)
 813                 delta_mod = -delta_mod;
 814         pps_stabil += (div_s64(((s64)delta_mod) <<
 815                                 (NTP_SCALE_SHIFT - SHIFT_USEC),
 816                                 NSEC_PER_USEC) - pps_stabil) >> PPS_INTMIN;
 817
 818         /* if enabled, the system clock frequency is updated */
 819         if ((time_status & STA_PPSFREQ) != 0 &&
 820             (time_status & STA_FREQHOLD) == 0) {
 821                 time_freq = pps_freq;
 822                 ntp_update_frequency();
 823         }
 824
 825         return delta;
 826 }
 827
 828 /* correct REALTIME clock phase error against PPS signal */
 829 static void hardpps_update_phase(long error)
 830 {
 831         long correction = -error;
 832         long jitter;
 833
 834         /* add the sample to the median filter */
 835         pps_phase_filter_add(correction);
 836         correction = pps_phase_filter_get(&jitter);
 837
 838         /* Nominal jitter is due to PPS signal noise. If it exceeds the
 839          * threshold, the sample is discarded; otherwise, if so enabled,
 840          * the time offset is updated.
 841          */
 842         if (jitter > (pps_jitter << PPS_POPCORN)) {
 843                 pr_warning("hardpps: PPSJITTER: jitter=%ld, limit=%ld\n",
 844                        jitter, (pps_jitter << PPS_POPCORN));
 845                 time_status |= STA_PPSJITTER;
 846                 pps_jitcnt++;
 847         } else if (time_status & STA_PPSTIME) {
 848                 /* correct the time using the phase offset */
 849                 time_offset = div_s64(((s64)correction) << NTP_SCALE_SHIFT,
 850                                 NTP_INTERVAL_FREQ);
 851                 /* cancel running adjtime() */
 852                 time_adjust = 0;
 853         }
 854         /* update jitter */
 855         pps_jitter += (jitter - pps_jitter) >> PPS_INTMIN;
 856 }
 857
 858 /*
 859  * hardpps() - discipline CPU clock oscillator to external PPS signal
 860  *
 861  * This routine is called at each PPS signal arrival in order to
 862  * discipline the CPU clock oscillator to the PPS signal. It takes two
 863  * parameters: REALTIME and MONOTONIC_RAW clock timestamps. The former
 864  * is used to correct clock phase error and the latter is used to
 865  * correct the frequency.
 866  *
 867  * This code is based on David Mills's reference nanokernel
 868  * implementation. It was mostly rewritten but keeps the same idea.
 869  */
 870 void hardpps(const struct timespec *phase_ts, const struct timespec *raw_ts)
 871 {
 872         struct pps_normtime pts_norm, freq_norm;
 873         unsigned long flags;
 874
 875         pts_norm = pps_normalize_ts(*phase_ts);
 876
 877         write_seqlock_irqsave(&xtime_lock, flags);
 878
 879         /* clear the error bits, they will be set again if needed */
 880         time_status &= ~(STA_PPSJITTER | STA_PPSWANDER | STA_PPSERROR);
 881
 882         /* indicate signal presence */
 883         time_status |= STA_PPSSIGNAL;
 884         pps_valid = PPS_VALID;
 885
 886         /* when called for the first time,
 887          * just start the frequency interval */
 888         if (unlikely(pps_fbase.tv_sec == 0)) {
 889                 pps_fbase = *raw_ts;
 890                 write_sequnlock_irqrestore(&xtime_lock, flags);
 891                 return;
 892         }
 893
 894         /* ok, now we have a base for frequency calculation */
 895         freq_norm = pps_normalize_ts(timespec_sub(*raw_ts, pps_fbase));
 896
 897         /* check that the signal is in the range
 898          * [1s - MAXFREQ us, 1s + MAXFREQ us], otherwise reject it */
 899         if ((freq_norm.sec == 0) ||
 900                         (freq_norm.nsec > MAXFREQ * freq_norm.sec) ||
 901                         (freq_norm.nsec < -MAXFREQ * freq_norm.sec)) {
 902                 time_status |= STA_PPSJITTER;
 903                 /* restart the frequency calibration interval */
 904                 pps_fbase = *raw_ts;
 905                 write_sequnlock_irqrestore(&xtime_lock, flags);
 906                 pr_err("hardpps: PPSJITTER: bad pulse\n");
 907                 return;
 908         }
 909
 910         /* signal is ok */
 911
 912         /* check if the current frequency interval is finished */
 913         if (freq_norm.sec >= (1 << pps_shift)) {
 914                 pps_calcnt++;
 915                 /* restart the frequency calibration interval */
 916                 pps_fbase = *raw_ts;
 917                 hardpps_update_freq(freq_norm);
 918         }
 919
 920         hardpps_update_phase(pts_norm.nsec);
 921
 922         write_sequnlock_irqrestore(&xtime_lock, flags);
 923 }
 924 EXPORT_SYMBOL(hardpps);
 925
 926 #endif  /* CONFIG_NTP_PPS */
 927
 928 static int __init ntp_tick_adj_setup(char *str)
 929 {
 930         ntp_tick_adj = simple_strtol(str, NULL, 0);
 931         ntp_tick_adj <<= NTP_SCALE_SHIFT;
 932
 933         return 1;
 934 }
 935
 936 __setup("ntp_tick_adj=", ntp_tick_adj_setup);
 937
 938 void __init ntp_init(void)
 939 {
 940         ntp_clear();
 941 }