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