ntp.c 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970
  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. /* USER_HZ period (usecs): */
  23. unsigned long tick_usec = TICK_USEC;
  24. /* ACTHZ period (nsecs): */
  25. unsigned long tick_nsec;
  26. u64 tick_length;
  27. static u64 tick_length_base;
  28. static struct hrtimer leap_timer;
  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. 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 xtime_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 xtime_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 methods:
  200. */
  201. /*
  202. * Update (tick_length, tick_length_base, tick_nsec), based
  203. * on (tick_usec, ntp_tick_adj, time_freq):
  204. */
  205. static void ntp_update_frequency(void)
  206. {
  207. u64 second_length;
  208. u64 new_base;
  209. second_length = (u64)(tick_usec * NSEC_PER_USEC * USER_HZ)
  210. << NTP_SCALE_SHIFT;
  211. second_length += ntp_tick_adj;
  212. second_length += time_freq;
  213. tick_nsec = div_u64(second_length, HZ) >> NTP_SCALE_SHIFT;
  214. new_base = div_u64(second_length, NTP_INTERVAL_FREQ);
  215. /*
  216. * Don't wait for the next second_overflow, apply
  217. * the change to the tick length immediately:
  218. */
  219. tick_length += new_base - tick_length_base;
  220. tick_length_base = new_base;
  221. }
  222. static inline s64 ntp_update_offset_fll(s64 offset64, long secs)
  223. {
  224. time_status &= ~STA_MODE;
  225. if (secs < MINSEC)
  226. return 0;
  227. if (!(time_status & STA_FLL) && (secs <= MAXSEC))
  228. return 0;
  229. time_status |= STA_MODE;
  230. return div_s64(offset64 << (NTP_SCALE_SHIFT - SHIFT_FLL), secs);
  231. }
  232. static void ntp_update_offset(long offset)
  233. {
  234. s64 freq_adj;
  235. s64 offset64;
  236. long secs;
  237. if (!(time_status & STA_PLL))
  238. return;
  239. if (!(time_status & STA_NANO))
  240. offset *= NSEC_PER_USEC;
  241. /*
  242. * Scale the phase adjustment and
  243. * clamp to the operating range.
  244. */
  245. offset = min(offset, MAXPHASE);
  246. offset = max(offset, -MAXPHASE);
  247. /*
  248. * Select how the frequency is to be controlled
  249. * and in which mode (PLL or FLL).
  250. */
  251. secs = get_seconds() - time_reftime;
  252. if (unlikely(time_status & STA_FREQHOLD))
  253. secs = 0;
  254. time_reftime = get_seconds();
  255. offset64 = offset;
  256. freq_adj = ntp_update_offset_fll(offset64, secs);
  257. /*
  258. * Clamp update interval to reduce PLL gain with low
  259. * sampling rate (e.g. intermittent network connection)
  260. * to avoid instability.
  261. */
  262. if (unlikely(secs > 1 << (SHIFT_PLL + 1 + time_constant)))
  263. secs = 1 << (SHIFT_PLL + 1 + time_constant);
  264. freq_adj += (offset64 * secs) <<
  265. (NTP_SCALE_SHIFT - 2 * (SHIFT_PLL + 2 + time_constant));
  266. freq_adj = min(freq_adj + time_freq, MAXFREQ_SCALED);
  267. time_freq = max(freq_adj, -MAXFREQ_SCALED);
  268. time_offset = div_s64(offset64 << NTP_SCALE_SHIFT, NTP_INTERVAL_FREQ);
  269. }
  270. /**
  271. * ntp_clear - Clears the NTP state variables
  272. *
  273. * Must be called while holding a write on the xtime_lock
  274. */
  275. void ntp_clear(void)
  276. {
  277. time_adjust = 0; /* stop active adjtime() */
  278. time_status |= STA_UNSYNC;
  279. time_maxerror = NTP_PHASE_LIMIT;
  280. time_esterror = NTP_PHASE_LIMIT;
  281. ntp_update_frequency();
  282. tick_length = tick_length_base;
  283. time_offset = 0;
  284. /* Clear PPS state variables */
  285. pps_clear();
  286. }
  287. /*
  288. * Leap second processing. If in leap-insert state at the end of the
  289. * day, the system clock is set back one second; if in leap-delete
  290. * state, the system clock is set ahead one second.
  291. */
  292. static enum hrtimer_restart ntp_leap_second(struct hrtimer *timer)
  293. {
  294. enum hrtimer_restart res = HRTIMER_NORESTART;
  295. write_seqlock(&xtime_lock);
  296. switch (time_state) {
  297. case TIME_OK:
  298. break;
  299. case TIME_INS:
  300. timekeeping_leap_insert(-1);
  301. time_state = TIME_OOP;
  302. printk(KERN_NOTICE
  303. "Clock: inserting leap second 23:59:60 UTC\n");
  304. hrtimer_add_expires_ns(&leap_timer, NSEC_PER_SEC);
  305. res = HRTIMER_RESTART;
  306. break;
  307. case TIME_DEL:
  308. timekeeping_leap_insert(1);
  309. time_tai--;
  310. time_state = TIME_WAIT;
  311. printk(KERN_NOTICE
  312. "Clock: deleting leap second 23:59:59 UTC\n");
  313. break;
  314. case TIME_OOP:
  315. time_tai++;
  316. time_state = TIME_WAIT;
  317. /* fall through */
  318. case TIME_WAIT:
  319. if (!(time_status & (STA_INS | STA_DEL)))
  320. time_state = TIME_OK;
  321. break;
  322. }
  323. write_sequnlock(&xtime_lock);
  324. return res;
  325. }
  326. /*
  327. * this routine handles the overflow of the microsecond field
  328. *
  329. * The tricky bits of code to handle the accurate clock support
  330. * were provided by Dave Mills (Mills@UDEL.EDU) of NTP fame.
  331. * They were originally developed for SUN and DEC kernels.
  332. * All the kudos should go to Dave for this stuff.
  333. */
  334. void second_overflow(void)
  335. {
  336. s64 delta;
  337. /* Bump the maxerror field */
  338. time_maxerror += MAXFREQ / NSEC_PER_USEC;
  339. if (time_maxerror > NTP_PHASE_LIMIT) {
  340. time_maxerror = NTP_PHASE_LIMIT;
  341. time_status |= STA_UNSYNC;
  342. }
  343. /* Compute the phase adjustment for the next second */
  344. tick_length = tick_length_base;
  345. delta = ntp_offset_chunk(time_offset);
  346. time_offset -= delta;
  347. tick_length += delta;
  348. /* Check PPS signal */
  349. pps_dec_valid();
  350. if (!time_adjust)
  351. return;
  352. if (time_adjust > MAX_TICKADJ) {
  353. time_adjust -= MAX_TICKADJ;
  354. tick_length += MAX_TICKADJ_SCALED;
  355. return;
  356. }
  357. if (time_adjust < -MAX_TICKADJ) {
  358. time_adjust += MAX_TICKADJ;
  359. tick_length -= MAX_TICKADJ_SCALED;
  360. return;
  361. }
  362. tick_length += (s64)(time_adjust * NSEC_PER_USEC / NTP_INTERVAL_FREQ)
  363. << NTP_SCALE_SHIFT;
  364. time_adjust = 0;
  365. }
  366. #ifdef CONFIG_GENERIC_CMOS_UPDATE
  367. /* Disable the cmos update - used by virtualization and embedded */
  368. int no_sync_cmos_clock __read_mostly;
  369. static void sync_cmos_clock(struct work_struct *work);
  370. static DECLARE_DELAYED_WORK(sync_cmos_work, sync_cmos_clock);
  371. static void sync_cmos_clock(struct work_struct *work)
  372. {
  373. struct timespec now, next;
  374. int fail = 1;
  375. /*
  376. * If we have an externally synchronized Linux clock, then update
  377. * CMOS clock accordingly every ~11 minutes. Set_rtc_mmss() has to be
  378. * called as close as possible to 500 ms before the new second starts.
  379. * This code is run on a timer. If the clock is set, that timer
  380. * may not expire at the correct time. Thus, we adjust...
  381. */
  382. if (!ntp_synced()) {
  383. /*
  384. * Not synced, exit, do not restart a timer (if one is
  385. * running, let it run out).
  386. */
  387. return;
  388. }
  389. getnstimeofday(&now);
  390. if (abs(now.tv_nsec - (NSEC_PER_SEC / 2)) <= tick_nsec / 2)
  391. fail = update_persistent_clock(now);
  392. next.tv_nsec = (NSEC_PER_SEC / 2) - now.tv_nsec - (TICK_NSEC / 2);
  393. if (next.tv_nsec <= 0)
  394. next.tv_nsec += NSEC_PER_SEC;
  395. if (!fail)
  396. next.tv_sec = 659;
  397. else
  398. next.tv_sec = 0;
  399. if (next.tv_nsec >= NSEC_PER_SEC) {
  400. next.tv_sec++;
  401. next.tv_nsec -= NSEC_PER_SEC;
  402. }
  403. schedule_delayed_work(&sync_cmos_work, timespec_to_jiffies(&next));
  404. }
  405. static void notify_cmos_timer(void)
  406. {
  407. if (!no_sync_cmos_clock)
  408. schedule_delayed_work(&sync_cmos_work, 0);
  409. }
  410. #else
  411. static inline void notify_cmos_timer(void) { }
  412. #endif
  413. /*
  414. * Start the leap seconds timer:
  415. */
  416. static inline void ntp_start_leap_timer(struct timespec *ts)
  417. {
  418. long now = ts->tv_sec;
  419. if (time_status & STA_INS) {
  420. time_state = TIME_INS;
  421. now += 86400 - now % 86400;
  422. hrtimer_start(&leap_timer, ktime_set(now, 0), HRTIMER_MODE_ABS);
  423. return;
  424. }
  425. if (time_status & STA_DEL) {
  426. time_state = TIME_DEL;
  427. now += 86400 - (now + 1) % 86400;
  428. hrtimer_start(&leap_timer, ktime_set(now, 0), HRTIMER_MODE_ABS);
  429. }
  430. }
  431. /*
  432. * Propagate a new txc->status value into the NTP state:
  433. */
  434. static inline void process_adj_status(struct timex *txc, struct timespec *ts)
  435. {
  436. if ((time_status & STA_PLL) && !(txc->status & STA_PLL)) {
  437. time_state = TIME_OK;
  438. time_status = STA_UNSYNC;
  439. /* restart PPS frequency calibration */
  440. pps_reset_freq_interval();
  441. }
  442. /*
  443. * If we turn on PLL adjustments then reset the
  444. * reference time to current time.
  445. */
  446. if (!(time_status & STA_PLL) && (txc->status & STA_PLL))
  447. time_reftime = get_seconds();
  448. /* only set allowed bits */
  449. time_status &= STA_RONLY;
  450. time_status |= txc->status & ~STA_RONLY;
  451. switch (time_state) {
  452. case TIME_OK:
  453. ntp_start_leap_timer(ts);
  454. break;
  455. case TIME_INS:
  456. case TIME_DEL:
  457. time_state = TIME_OK;
  458. ntp_start_leap_timer(ts);
  459. case TIME_WAIT:
  460. if (!(time_status & (STA_INS | STA_DEL)))
  461. time_state = TIME_OK;
  462. break;
  463. case TIME_OOP:
  464. hrtimer_restart(&leap_timer);
  465. break;
  466. }
  467. }
  468. /*
  469. * Called with the xtime lock held, so we can access and modify
  470. * all the global NTP state:
  471. */
  472. static inline void process_adjtimex_modes(struct timex *txc, struct timespec *ts)
  473. {
  474. if (txc->modes & ADJ_STATUS)
  475. process_adj_status(txc, ts);
  476. if (txc->modes & ADJ_NANO)
  477. time_status |= STA_NANO;
  478. if (txc->modes & ADJ_MICRO)
  479. time_status &= ~STA_NANO;
  480. if (txc->modes & ADJ_FREQUENCY) {
  481. time_freq = txc->freq * PPM_SCALE;
  482. time_freq = min(time_freq, MAXFREQ_SCALED);
  483. time_freq = max(time_freq, -MAXFREQ_SCALED);
  484. /* update pps_freq */
  485. pps_set_freq(time_freq);
  486. }
  487. if (txc->modes & ADJ_MAXERROR)
  488. time_maxerror = txc->maxerror;
  489. if (txc->modes & ADJ_ESTERROR)
  490. time_esterror = txc->esterror;
  491. if (txc->modes & ADJ_TIMECONST) {
  492. time_constant = txc->constant;
  493. if (!(time_status & STA_NANO))
  494. time_constant += 4;
  495. time_constant = min(time_constant, (long)MAXTC);
  496. time_constant = max(time_constant, 0l);
  497. }
  498. if (txc->modes & ADJ_TAI && txc->constant > 0)
  499. time_tai = txc->constant;
  500. if (txc->modes & ADJ_OFFSET)
  501. ntp_update_offset(txc->offset);
  502. if (txc->modes & ADJ_TICK)
  503. tick_usec = txc->tick;
  504. if (txc->modes & (ADJ_TICK|ADJ_FREQUENCY|ADJ_OFFSET))
  505. ntp_update_frequency();
  506. }
  507. /*
  508. * adjtimex mainly allows reading (and writing, if superuser) of
  509. * kernel time-keeping variables. used by xntpd.
  510. */
  511. int do_adjtimex(struct timex *txc)
  512. {
  513. struct timespec ts;
  514. int result;
  515. /* Validate the data before disabling interrupts */
  516. if (txc->modes & ADJ_ADJTIME) {
  517. /* singleshot must not be used with any other mode bits */
  518. if (!(txc->modes & ADJ_OFFSET_SINGLESHOT))
  519. return -EINVAL;
  520. if (!(txc->modes & ADJ_OFFSET_READONLY) &&
  521. !capable(CAP_SYS_TIME))
  522. return -EPERM;
  523. } else {
  524. /* In order to modify anything, you gotta be super-user! */
  525. if (txc->modes && !capable(CAP_SYS_TIME))
  526. return -EPERM;
  527. /*
  528. * if the quartz is off by more than 10% then
  529. * something is VERY wrong!
  530. */
  531. if (txc->modes & ADJ_TICK &&
  532. (txc->tick < 900000/USER_HZ ||
  533. txc->tick > 1100000/USER_HZ))
  534. return -EINVAL;
  535. if (txc->modes & ADJ_STATUS && time_state != TIME_OK)
  536. hrtimer_cancel(&leap_timer);
  537. }
  538. if (txc->modes & ADJ_SETOFFSET) {
  539. struct timespec delta;
  540. delta.tv_sec = txc->time.tv_sec;
  541. delta.tv_nsec = txc->time.tv_usec;
  542. if (!(txc->modes & ADJ_NANO))
  543. delta.tv_nsec *= 1000;
  544. result = timekeeping_inject_offset(&delta);
  545. if (result)
  546. return result;
  547. }
  548. getnstimeofday(&ts);
  549. write_seqlock_irq(&xtime_lock);
  550. if (txc->modes & ADJ_ADJTIME) {
  551. long save_adjust = time_adjust;
  552. if (!(txc->modes & ADJ_OFFSET_READONLY)) {
  553. /* adjtime() is independent from ntp_adjtime() */
  554. time_adjust = txc->offset;
  555. ntp_update_frequency();
  556. }
  557. txc->offset = save_adjust;
  558. } else {
  559. /* If there are input parameters, then process them: */
  560. if (txc->modes)
  561. process_adjtimex_modes(txc, &ts);
  562. txc->offset = shift_right(time_offset * NTP_INTERVAL_FREQ,
  563. NTP_SCALE_SHIFT);
  564. if (!(time_status & STA_NANO))
  565. txc->offset /= NSEC_PER_USEC;
  566. }
  567. result = time_state; /* mostly `TIME_OK' */
  568. /* check for errors */
  569. if (is_error_status(time_status))
  570. result = TIME_ERROR;
  571. txc->freq = shift_right((time_freq >> PPM_SCALE_INV_SHIFT) *
  572. PPM_SCALE_INV, NTP_SCALE_SHIFT);
  573. txc->maxerror = time_maxerror;
  574. txc->esterror = time_esterror;
  575. txc->status = time_status;
  576. txc->constant = time_constant;
  577. txc->precision = 1;
  578. txc->tolerance = MAXFREQ_SCALED / PPM_SCALE;
  579. txc->tick = tick_usec;
  580. txc->tai = time_tai;
  581. /* fill PPS status fields */
  582. pps_fill_timex(txc);
  583. write_sequnlock_irq(&xtime_lock);
  584. txc->time.tv_sec = ts.tv_sec;
  585. txc->time.tv_usec = ts.tv_nsec;
  586. if (!(time_status & STA_NANO))
  587. txc->time.tv_usec /= NSEC_PER_USEC;
  588. notify_cmos_timer();
  589. return result;
  590. }
  591. #ifdef CONFIG_NTP_PPS
  592. /* actually struct pps_normtime is good old struct timespec, but it is
  593. * semantically different (and it is the reason why it was invented):
  594. * pps_normtime.nsec has a range of ( -NSEC_PER_SEC / 2, NSEC_PER_SEC / 2 ]
  595. * while timespec.tv_nsec has a range of [0, NSEC_PER_SEC) */
  596. struct pps_normtime {
  597. __kernel_time_t sec; /* seconds */
  598. long nsec; /* nanoseconds */
  599. };
  600. /* normalize the timestamp so that nsec is in the
  601. ( -NSEC_PER_SEC / 2, NSEC_PER_SEC / 2 ] interval */
  602. static inline struct pps_normtime pps_normalize_ts(struct timespec ts)
  603. {
  604. struct pps_normtime norm = {
  605. .sec = ts.tv_sec,
  606. .nsec = ts.tv_nsec
  607. };
  608. if (norm.nsec > (NSEC_PER_SEC >> 1)) {
  609. norm.nsec -= NSEC_PER_SEC;
  610. norm.sec++;
  611. }
  612. return norm;
  613. }
  614. /* get current phase correction and jitter */
  615. static inline long pps_phase_filter_get(long *jitter)
  616. {
  617. *jitter = pps_tf[0] - pps_tf[1];
  618. if (*jitter < 0)
  619. *jitter = -*jitter;
  620. /* TODO: test various filters */
  621. return pps_tf[0];
  622. }
  623. /* add the sample to the phase filter */
  624. static inline void pps_phase_filter_add(long err)
  625. {
  626. pps_tf[2] = pps_tf[1];
  627. pps_tf[1] = pps_tf[0];
  628. pps_tf[0] = err;
  629. }
  630. /* decrease frequency calibration interval length.
  631. * It is halved after four consecutive unstable intervals.
  632. */
  633. static inline void pps_dec_freq_interval(void)
  634. {
  635. if (--pps_intcnt <= -PPS_INTCOUNT) {
  636. pps_intcnt = -PPS_INTCOUNT;
  637. if (pps_shift > PPS_INTMIN) {
  638. pps_shift--;
  639. pps_intcnt = 0;
  640. }
  641. }
  642. }
  643. /* increase frequency calibration interval length.
  644. * It is doubled after four consecutive stable intervals.
  645. */
  646. static inline void pps_inc_freq_interval(void)
  647. {
  648. if (++pps_intcnt >= PPS_INTCOUNT) {
  649. pps_intcnt = PPS_INTCOUNT;
  650. if (pps_shift < PPS_INTMAX) {
  651. pps_shift++;
  652. pps_intcnt = 0;
  653. }
  654. }
  655. }
  656. /* update clock frequency based on MONOTONIC_RAW clock PPS signal
  657. * timestamps
  658. *
  659. * At the end of the calibration interval the difference between the
  660. * first and last MONOTONIC_RAW clock timestamps divided by the length
  661. * of the interval becomes the frequency update. If the interval was
  662. * too long, the data are discarded.
  663. * Returns the difference between old and new frequency values.
  664. */
  665. static long hardpps_update_freq(struct pps_normtime freq_norm)
  666. {
  667. long delta, delta_mod;
  668. s64 ftemp;
  669. /* check if the frequency interval was too long */
  670. if (freq_norm.sec > (2 << pps_shift)) {
  671. time_status |= STA_PPSERROR;
  672. pps_errcnt++;
  673. pps_dec_freq_interval();
  674. pr_err("hardpps: PPSERROR: interval too long - %ld s\n",
  675. freq_norm.sec);
  676. return 0;
  677. }
  678. /* here the raw frequency offset and wander (stability) is
  679. * calculated. If the wander is less than the wander threshold
  680. * the interval is increased; otherwise it is decreased.
  681. */
  682. ftemp = div_s64(((s64)(-freq_norm.nsec)) << NTP_SCALE_SHIFT,
  683. freq_norm.sec);
  684. delta = shift_right(ftemp - pps_freq, NTP_SCALE_SHIFT);
  685. pps_freq = ftemp;
  686. if (delta > PPS_MAXWANDER || delta < -PPS_MAXWANDER) {
  687. pr_warning("hardpps: PPSWANDER: change=%ld\n", delta);
  688. time_status |= STA_PPSWANDER;
  689. pps_stbcnt++;
  690. pps_dec_freq_interval();
  691. } else { /* good sample */
  692. pps_inc_freq_interval();
  693. }
  694. /* the stability metric is calculated as the average of recent
  695. * frequency changes, but is used only for performance
  696. * monitoring
  697. */
  698. delta_mod = delta;
  699. if (delta_mod < 0)
  700. delta_mod = -delta_mod;
  701. pps_stabil += (div_s64(((s64)delta_mod) <<
  702. (NTP_SCALE_SHIFT - SHIFT_USEC),
  703. NSEC_PER_USEC) - pps_stabil) >> PPS_INTMIN;
  704. /* if enabled, the system clock frequency is updated */
  705. if ((time_status & STA_PPSFREQ) != 0 &&
  706. (time_status & STA_FREQHOLD) == 0) {
  707. time_freq = pps_freq;
  708. ntp_update_frequency();
  709. }
  710. return delta;
  711. }
  712. /* correct REALTIME clock phase error against PPS signal */
  713. static void hardpps_update_phase(long error)
  714. {
  715. long correction = -error;
  716. long jitter;
  717. /* add the sample to the median filter */
  718. pps_phase_filter_add(correction);
  719. correction = pps_phase_filter_get(&jitter);
  720. /* Nominal jitter is due to PPS signal noise. If it exceeds the
  721. * threshold, the sample is discarded; otherwise, if so enabled,
  722. * the time offset is updated.
  723. */
  724. if (jitter > (pps_jitter << PPS_POPCORN)) {
  725. pr_warning("hardpps: PPSJITTER: jitter=%ld, limit=%ld\n",
  726. jitter, (pps_jitter << PPS_POPCORN));
  727. time_status |= STA_PPSJITTER;
  728. pps_jitcnt++;
  729. } else if (time_status & STA_PPSTIME) {
  730. /* correct the time using the phase offset */
  731. time_offset = div_s64(((s64)correction) << NTP_SCALE_SHIFT,
  732. NTP_INTERVAL_FREQ);
  733. /* cancel running adjtime() */
  734. time_adjust = 0;
  735. }
  736. /* update jitter */
  737. pps_jitter += (jitter - pps_jitter) >> PPS_INTMIN;
  738. }
  739. /*
  740. * hardpps() - discipline CPU clock oscillator to external PPS signal
  741. *
  742. * This routine is called at each PPS signal arrival in order to
  743. * discipline the CPU clock oscillator to the PPS signal. It takes two
  744. * parameters: REALTIME and MONOTONIC_RAW clock timestamps. The former
  745. * is used to correct clock phase error and the latter is used to
  746. * correct the frequency.
  747. *
  748. * This code is based on David Mills's reference nanokernel
  749. * implementation. It was mostly rewritten but keeps the same idea.
  750. */
  751. void hardpps(const struct timespec *phase_ts, const struct timespec *raw_ts)
  752. {
  753. struct pps_normtime pts_norm, freq_norm;
  754. unsigned long flags;
  755. pts_norm = pps_normalize_ts(*phase_ts);
  756. write_seqlock_irqsave(&xtime_lock, flags);
  757. /* clear the error bits, they will be set again if needed */
  758. time_status &= ~(STA_PPSJITTER | STA_PPSWANDER | STA_PPSERROR);
  759. /* indicate signal presence */
  760. time_status |= STA_PPSSIGNAL;
  761. pps_valid = PPS_VALID;
  762. /* when called for the first time,
  763. * just start the frequency interval */
  764. if (unlikely(pps_fbase.tv_sec == 0)) {
  765. pps_fbase = *raw_ts;
  766. write_sequnlock_irqrestore(&xtime_lock, flags);
  767. return;
  768. }
  769. /* ok, now we have a base for frequency calculation */
  770. freq_norm = pps_normalize_ts(timespec_sub(*raw_ts, pps_fbase));
  771. /* check that the signal is in the range
  772. * [1s - MAXFREQ us, 1s + MAXFREQ us], otherwise reject it */
  773. if ((freq_norm.sec == 0) ||
  774. (freq_norm.nsec > MAXFREQ * freq_norm.sec) ||
  775. (freq_norm.nsec < -MAXFREQ * freq_norm.sec)) {
  776. time_status |= STA_PPSJITTER;
  777. /* restart the frequency calibration interval */
  778. pps_fbase = *raw_ts;
  779. write_sequnlock_irqrestore(&xtime_lock, flags);
  780. pr_err("hardpps: PPSJITTER: bad pulse\n");
  781. return;
  782. }
  783. /* signal is ok */
  784. /* check if the current frequency interval is finished */
  785. if (freq_norm.sec >= (1 << pps_shift)) {
  786. pps_calcnt++;
  787. /* restart the frequency calibration interval */
  788. pps_fbase = *raw_ts;
  789. hardpps_update_freq(freq_norm);
  790. }
  791. hardpps_update_phase(pts_norm.nsec);
  792. write_sequnlock_irqrestore(&xtime_lock, flags);
  793. }
  794. EXPORT_SYMBOL(hardpps);
  795. #endif /* CONFIG_NTP_PPS */
  796. static int __init ntp_tick_adj_setup(char *str)
  797. {
  798. ntp_tick_adj = simple_strtol(str, NULL, 0);
  799. ntp_tick_adj <<= NTP_SCALE_SHIFT;
  800. return 1;
  801. }
  802. __setup("ntp_tick_adj=", ntp_tick_adj_setup);
  803. void __init ntp_init(void)
  804. {
  805. ntp_clear();
  806. hrtimer_init(&leap_timer, CLOCK_REALTIME, HRTIMER_MODE_ABS);
  807. leap_timer.function = ntp_leap_second;
  808. }