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