ntp.c 23 KB

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