Merge remote-tracking branch 'tip/auto-latest'
[deliverable/linux.git] / kernel / time / clocksource.c
CommitLineData
734efb46 1/*
2 * linux/kernel/time/clocksource.c
3 *
4 * This file contains the functions which manage clocksource drivers.
5 *
6 * Copyright (C) 2004, 2005 IBM, John Stultz (johnstul@us.ibm.com)
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 *
22 * TODO WishList:
23 * o Allow clocksource drivers to be unregistered
734efb46 24 */
25
45bbfe64
JP
26#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
27
d369a5d8 28#include <linux/device.h>
734efb46 29#include <linux/clocksource.h>
734efb46 30#include <linux/init.h>
31#include <linux/module.h>
dc29a365 32#include <linux/sched.h> /* for spin_unlock_irq() using preempt_count() m68k */
79bf2bb3 33#include <linux/tick.h>
01548f4d 34#include <linux/kthread.h>
734efb46 35
c1797baf 36#include "tick-internal.h"
3a978377 37#include "timekeeping_internal.h"
03e13cf5 38
7d2f944a
TG
39/**
40 * clocks_calc_mult_shift - calculate mult/shift factors for scaled math of clocks
41 * @mult: pointer to mult variable
42 * @shift: pointer to shift variable
43 * @from: frequency to convert from
44 * @to: frequency to convert to
5fdade95 45 * @maxsec: guaranteed runtime conversion range in seconds
7d2f944a
TG
46 *
47 * The function evaluates the shift/mult pair for the scaled math
48 * operations of clocksources and clockevents.
49 *
50 * @to and @from are frequency values in HZ. For clock sources @to is
51 * NSEC_PER_SEC == 1GHz and @from is the counter frequency. For clock
52 * event @to is the counter frequency and @from is NSEC_PER_SEC.
53 *
5fdade95 54 * The @maxsec conversion range argument controls the time frame in
7d2f944a
TG
55 * seconds which must be covered by the runtime conversion with the
56 * calculated mult and shift factors. This guarantees that no 64bit
57 * overflow happens when the input value of the conversion is
58 * multiplied with the calculated mult factor. Larger ranges may
59 * reduce the conversion accuracy by chosing smaller mult and shift
60 * factors.
61 */
62void
5fdade95 63clocks_calc_mult_shift(u32 *mult, u32 *shift, u32 from, u32 to, u32 maxsec)
7d2f944a
TG
64{
65 u64 tmp;
66 u32 sft, sftacc= 32;
67
68 /*
69 * Calculate the shift factor which is limiting the conversion
70 * range:
71 */
5fdade95 72 tmp = ((u64)maxsec * from) >> 32;
7d2f944a
TG
73 while (tmp) {
74 tmp >>=1;
75 sftacc--;
76 }
77
78 /*
79 * Find the conversion shift/mult pair which has the best
80 * accuracy and fits the maxsec conversion range:
81 */
82 for (sft = 32; sft > 0; sft--) {
83 tmp = (u64) to << sft;
b5776c4a 84 tmp += from / 2;
7d2f944a
TG
85 do_div(tmp, from);
86 if ((tmp >> sftacc) == 0)
87 break;
88 }
89 *mult = tmp;
90 *shift = sft;
91}
92
734efb46 93/*[Clocksource internal variables]---------
94 * curr_clocksource:
f1b82746 95 * currently selected clocksource.
734efb46 96 * clocksource_list:
97 * linked list with the registered clocksources
75c5158f
MS
98 * clocksource_mutex:
99 * protects manipulations to curr_clocksource and the clocksource_list
734efb46 100 * override_name:
101 * Name of the user-specified clocksource.
102 */
f1b82746 103static struct clocksource *curr_clocksource;
734efb46 104static LIST_HEAD(clocksource_list);
75c5158f 105static DEFINE_MUTEX(clocksource_mutex);
29b54078 106static char override_name[CS_NAME_LEN];
54a6bc0b 107static int finished_booting;
734efb46 108
5d8b34fd 109#ifdef CONFIG_CLOCKSOURCE_WATCHDOG
f79e0258 110static void clocksource_watchdog_work(struct work_struct *work);
332962f2 111static void clocksource_select(void);
f79e0258 112
5d8b34fd
TG
113static LIST_HEAD(watchdog_list);
114static struct clocksource *watchdog;
115static struct timer_list watchdog_timer;
f79e0258 116static DECLARE_WORK(watchdog_work, clocksource_watchdog_work);
5d8b34fd 117static DEFINE_SPINLOCK(watchdog_lock);
fb63a0eb 118static int watchdog_running;
9fb60336 119static atomic_t watchdog_reset_pending;
b52f52a0 120
01548f4d 121static int clocksource_watchdog_kthread(void *data);
d0981a1b 122static void __clocksource_change_rating(struct clocksource *cs, int rating);
c55c87c8 123
5d8b34fd 124/*
35c35d1a 125 * Interval: 0.5sec Threshold: 0.0625s
5d8b34fd
TG
126 */
127#define WATCHDOG_INTERVAL (HZ >> 1)
35c35d1a 128#define WATCHDOG_THRESHOLD (NSEC_PER_SEC >> 4)
5d8b34fd 129
01548f4d
MS
130static void clocksource_watchdog_work(struct work_struct *work)
131{
132 /*
133 * If kthread_run fails the next watchdog scan over the
134 * watchdog_list will find the unstable clock again.
135 */
136 kthread_run(clocksource_watchdog_kthread, NULL, "kwatchdog");
137}
138
7285dd7f 139static void __clocksource_unstable(struct clocksource *cs)
5d8b34fd 140{
5d8b34fd 141 cs->flags &= ~(CLOCK_SOURCE_VALID_FOR_HRES | CLOCK_SOURCE_WATCHDOG);
c55c87c8 142 cs->flags |= CLOCK_SOURCE_UNSTABLE;
54a6bc0b
TG
143 if (finished_booting)
144 schedule_work(&watchdog_work);
5d8b34fd
TG
145}
146
7285dd7f
TG
147/**
148 * clocksource_mark_unstable - mark clocksource unstable via watchdog
149 * @cs: clocksource to be marked unstable
150 *
151 * This function is called instead of clocksource_change_rating from
152 * cpu hotplug code to avoid a deadlock between the clocksource mutex
153 * and the cpu hotplug mutex. It defers the update of the clocksource
154 * to the watchdog thread.
155 */
156void clocksource_mark_unstable(struct clocksource *cs)
157{
158 unsigned long flags;
159
160 spin_lock_irqsave(&watchdog_lock, flags);
161 if (!(cs->flags & CLOCK_SOURCE_UNSTABLE)) {
162 if (list_empty(&cs->wd_list))
163 list_add(&cs->wd_list, &watchdog_list);
164 __clocksource_unstable(cs);
165 }
166 spin_unlock_irqrestore(&watchdog_lock, flags);
167}
168
5d8b34fd
TG
169static void clocksource_watchdog(unsigned long data)
170{
c55c87c8 171 struct clocksource *cs;
0b046b21 172 cycle_t csnow, wdnow, cslast, wdlast, delta;
5d8b34fd 173 int64_t wd_nsec, cs_nsec;
9fb60336 174 int next_cpu, reset_pending;
5d8b34fd
TG
175
176 spin_lock(&watchdog_lock);
fb63a0eb
MS
177 if (!watchdog_running)
178 goto out;
5d8b34fd 179
9fb60336
TG
180 reset_pending = atomic_read(&watchdog_reset_pending);
181
c55c87c8
MS
182 list_for_each_entry(cs, &watchdog_list, wd_list) {
183
184 /* Clocksource already marked unstable? */
01548f4d 185 if (cs->flags & CLOCK_SOURCE_UNSTABLE) {
54a6bc0b
TG
186 if (finished_booting)
187 schedule_work(&watchdog_work);
c55c87c8 188 continue;
01548f4d 189 }
c55c87c8 190
b5199515 191 local_irq_disable();
8e19608e 192 csnow = cs->read(cs);
b5199515
TG
193 wdnow = watchdog->read(watchdog);
194 local_irq_enable();
b52f52a0 195
8cf4e750 196 /* Clocksource initialized ? */
9fb60336
TG
197 if (!(cs->flags & CLOCK_SOURCE_WATCHDOG) ||
198 atomic_read(&watchdog_reset_pending)) {
8cf4e750 199 cs->flags |= CLOCK_SOURCE_WATCHDOG;
b5199515
TG
200 cs->wd_last = wdnow;
201 cs->cs_last = csnow;
b52f52a0
TG
202 continue;
203 }
204
3a978377
TG
205 delta = clocksource_delta(wdnow, cs->wd_last, watchdog->mask);
206 wd_nsec = clocksource_cyc2ns(delta, watchdog->mult,
207 watchdog->shift);
b5199515 208
3a978377
TG
209 delta = clocksource_delta(csnow, cs->cs_last, cs->mask);
210 cs_nsec = clocksource_cyc2ns(delta, cs->mult, cs->shift);
0b046b21
JS
211 wdlast = cs->wd_last; /* save these in case we print them */
212 cslast = cs->cs_last;
b5199515
TG
213 cs->cs_last = csnow;
214 cs->wd_last = wdnow;
215
9fb60336
TG
216 if (atomic_read(&watchdog_reset_pending))
217 continue;
218
b5199515 219 /* Check the deviation from the watchdog clocksource. */
79211c8e 220 if (abs(cs_nsec - wd_nsec) > WATCHDOG_THRESHOLD) {
390dd67c
SI
221 pr_warn("timekeeping watchdog on CPU%d: Marking clocksource '%s' as unstable because the skew is too large:\n",
222 smp_processor_id(), cs->name);
45bbfe64 223 pr_warn(" '%s' wd_now: %llx wd_last: %llx mask: %llx\n",
0b046b21 224 watchdog->name, wdnow, wdlast, watchdog->mask);
45bbfe64 225 pr_warn(" '%s' cs_now: %llx cs_last: %llx mask: %llx\n",
0b046b21
JS
226 cs->name, csnow, cslast, cs->mask);
227 __clocksource_unstable(cs);
8cf4e750
MS
228 continue;
229 }
230
231 if (!(cs->flags & CLOCK_SOURCE_VALID_FOR_HRES) &&
232 (cs->flags & CLOCK_SOURCE_IS_CONTINUOUS) &&
233 (watchdog->flags & CLOCK_SOURCE_IS_CONTINUOUS)) {
332962f2 234 /* Mark it valid for high-res. */
8cf4e750 235 cs->flags |= CLOCK_SOURCE_VALID_FOR_HRES;
332962f2
TG
236
237 /*
238 * clocksource_done_booting() will sort it if
239 * finished_booting is not set yet.
240 */
241 if (!finished_booting)
242 continue;
243
8cf4e750 244 /*
332962f2
TG
245 * If this is not the current clocksource let
246 * the watchdog thread reselect it. Due to the
247 * change to high res this clocksource might
248 * be preferred now. If it is the current
249 * clocksource let the tick code know about
250 * that change.
8cf4e750 251 */
332962f2
TG
252 if (cs != curr_clocksource) {
253 cs->flags |= CLOCK_SOURCE_RESELECT;
254 schedule_work(&watchdog_work);
255 } else {
256 tick_clock_notify();
257 }
5d8b34fd
TG
258 }
259 }
260
9fb60336
TG
261 /*
262 * We only clear the watchdog_reset_pending, when we did a
263 * full cycle through all clocksources.
264 */
265 if (reset_pending)
266 atomic_dec(&watchdog_reset_pending);
267
c55c87c8
MS
268 /*
269 * Cycle through CPUs to check if the CPUs stay synchronized
270 * to each other.
271 */
272 next_cpu = cpumask_next(raw_smp_processor_id(), cpu_online_mask);
273 if (next_cpu >= nr_cpu_ids)
274 next_cpu = cpumask_first(cpu_online_mask);
275 watchdog_timer.expires += WATCHDOG_INTERVAL;
276 add_timer_on(&watchdog_timer, next_cpu);
fb63a0eb 277out:
5d8b34fd
TG
278 spin_unlock(&watchdog_lock);
279}
0f8e8ef7 280
fb63a0eb
MS
281static inline void clocksource_start_watchdog(void)
282{
283 if (watchdog_running || !watchdog || list_empty(&watchdog_list))
284 return;
285 init_timer(&watchdog_timer);
286 watchdog_timer.function = clocksource_watchdog;
fb63a0eb
MS
287 watchdog_timer.expires = jiffies + WATCHDOG_INTERVAL;
288 add_timer_on(&watchdog_timer, cpumask_first(cpu_online_mask));
289 watchdog_running = 1;
290}
291
292static inline void clocksource_stop_watchdog(void)
293{
294 if (!watchdog_running || (watchdog && !list_empty(&watchdog_list)))
295 return;
296 del_timer(&watchdog_timer);
297 watchdog_running = 0;
298}
299
0f8e8ef7
MS
300static inline void clocksource_reset_watchdog(void)
301{
302 struct clocksource *cs;
303
304 list_for_each_entry(cs, &watchdog_list, wd_list)
305 cs->flags &= ~CLOCK_SOURCE_WATCHDOG;
306}
307
b52f52a0
TG
308static void clocksource_resume_watchdog(void)
309{
9fb60336 310 atomic_inc(&watchdog_reset_pending);
b52f52a0
TG
311}
312
fb63a0eb 313static void clocksource_enqueue_watchdog(struct clocksource *cs)
5d8b34fd 314{
5d8b34fd
TG
315 unsigned long flags;
316
317 spin_lock_irqsave(&watchdog_lock, flags);
318 if (cs->flags & CLOCK_SOURCE_MUST_VERIFY) {
fb63a0eb 319 /* cs is a clocksource to be watched. */
5d8b34fd 320 list_add(&cs->wd_list, &watchdog_list);
fb63a0eb 321 cs->flags &= ~CLOCK_SOURCE_WATCHDOG;
948ac6d7 322 } else {
fb63a0eb 323 /* cs is a watchdog. */
948ac6d7 324 if (cs->flags & CLOCK_SOURCE_IS_CONTINUOUS)
5d8b34fd 325 cs->flags |= CLOCK_SOURCE_VALID_FOR_HRES;
bbf66d89
VK
326 }
327 spin_unlock_irqrestore(&watchdog_lock, flags);
328}
329
330static void clocksource_select_watchdog(bool fallback)
331{
332 struct clocksource *cs, *old_wd;
333 unsigned long flags;
334
335 spin_lock_irqsave(&watchdog_lock, flags);
336 /* save current watchdog */
337 old_wd = watchdog;
338 if (fallback)
339 watchdog = NULL;
340
341 list_for_each_entry(cs, &clocksource_list, list) {
342 /* cs is a clocksource to be watched. */
343 if (cs->flags & CLOCK_SOURCE_MUST_VERIFY)
344 continue;
345
346 /* Skip current if we were requested for a fallback. */
347 if (fallback && cs == old_wd)
348 continue;
349
fb63a0eb 350 /* Pick the best watchdog. */
bbf66d89 351 if (!watchdog || cs->rating > watchdog->rating)
5d8b34fd 352 watchdog = cs;
5d8b34fd 353 }
bbf66d89
VK
354 /* If we failed to find a fallback restore the old one. */
355 if (!watchdog)
356 watchdog = old_wd;
357
358 /* If we changed the watchdog we need to reset cycles. */
359 if (watchdog != old_wd)
360 clocksource_reset_watchdog();
361
fb63a0eb
MS
362 /* Check if the watchdog timer needs to be started. */
363 clocksource_start_watchdog();
5d8b34fd
TG
364 spin_unlock_irqrestore(&watchdog_lock, flags);
365}
fb63a0eb
MS
366
367static void clocksource_dequeue_watchdog(struct clocksource *cs)
368{
fb63a0eb
MS
369 unsigned long flags;
370
371 spin_lock_irqsave(&watchdog_lock, flags);
a89c7edb
TG
372 if (cs != watchdog) {
373 if (cs->flags & CLOCK_SOURCE_MUST_VERIFY) {
374 /* cs is a watched clocksource. */
375 list_del_init(&cs->wd_list);
376 /* Check if the watchdog timer needs to be stopped. */
377 clocksource_stop_watchdog();
fb63a0eb
MS
378 }
379 }
fb63a0eb
MS
380 spin_unlock_irqrestore(&watchdog_lock, flags);
381}
382
332962f2 383static int __clocksource_watchdog_kthread(void)
c55c87c8
MS
384{
385 struct clocksource *cs, *tmp;
386 unsigned long flags;
6ea41d25 387 LIST_HEAD(unstable);
332962f2 388 int select = 0;
c55c87c8
MS
389
390 spin_lock_irqsave(&watchdog_lock, flags);
332962f2 391 list_for_each_entry_safe(cs, tmp, &watchdog_list, wd_list) {
c55c87c8
MS
392 if (cs->flags & CLOCK_SOURCE_UNSTABLE) {
393 list_del_init(&cs->wd_list);
6ea41d25 394 list_add(&cs->wd_list, &unstable);
332962f2
TG
395 select = 1;
396 }
397 if (cs->flags & CLOCK_SOURCE_RESELECT) {
398 cs->flags &= ~CLOCK_SOURCE_RESELECT;
399 select = 1;
c55c87c8 400 }
332962f2 401 }
c55c87c8
MS
402 /* Check if the watchdog timer needs to be stopped. */
403 clocksource_stop_watchdog();
6ea41d25
TG
404 spin_unlock_irqrestore(&watchdog_lock, flags);
405
406 /* Needs to be done outside of watchdog lock */
407 list_for_each_entry_safe(cs, tmp, &unstable, wd_list) {
408 list_del_init(&cs->wd_list);
d0981a1b 409 __clocksource_change_rating(cs, 0);
6ea41d25 410 }
332962f2
TG
411 return select;
412}
413
414static int clocksource_watchdog_kthread(void *data)
415{
416 mutex_lock(&clocksource_mutex);
417 if (__clocksource_watchdog_kthread())
418 clocksource_select();
d0981a1b 419 mutex_unlock(&clocksource_mutex);
01548f4d 420 return 0;
c55c87c8
MS
421}
422
7eaeb343
TG
423static bool clocksource_is_watchdog(struct clocksource *cs)
424{
425 return cs == watchdog;
426}
427
fb63a0eb
MS
428#else /* CONFIG_CLOCKSOURCE_WATCHDOG */
429
430static void clocksource_enqueue_watchdog(struct clocksource *cs)
5d8b34fd
TG
431{
432 if (cs->flags & CLOCK_SOURCE_IS_CONTINUOUS)
433 cs->flags |= CLOCK_SOURCE_VALID_FOR_HRES;
434}
b52f52a0 435
bbf66d89 436static void clocksource_select_watchdog(bool fallback) { }
fb63a0eb 437static inline void clocksource_dequeue_watchdog(struct clocksource *cs) { }
b52f52a0 438static inline void clocksource_resume_watchdog(void) { }
332962f2 439static inline int __clocksource_watchdog_kthread(void) { return 0; }
7eaeb343 440static bool clocksource_is_watchdog(struct clocksource *cs) { return false; }
397bbf6d 441void clocksource_mark_unstable(struct clocksource *cs) { }
fb63a0eb
MS
442
443#endif /* CONFIG_CLOCKSOURCE_WATCHDOG */
5d8b34fd 444
c54a42b1
MD
445/**
446 * clocksource_suspend - suspend the clocksource(s)
447 */
448void clocksource_suspend(void)
449{
450 struct clocksource *cs;
451
452 list_for_each_entry_reverse(cs, &clocksource_list, list)
453 if (cs->suspend)
454 cs->suspend(cs);
455}
456
b52f52a0
TG
457/**
458 * clocksource_resume - resume the clocksource(s)
459 */
460void clocksource_resume(void)
461{
2e197586 462 struct clocksource *cs;
b52f52a0 463
75c5158f 464 list_for_each_entry(cs, &clocksource_list, list)
b52f52a0 465 if (cs->resume)
17622339 466 cs->resume(cs);
b52f52a0
TG
467
468 clocksource_resume_watchdog();
b52f52a0
TG
469}
470
7c3078b6
JW
471/**
472 * clocksource_touch_watchdog - Update watchdog
473 *
474 * Update the watchdog after exception contexts such as kgdb so as not
7b7422a5
TG
475 * to incorrectly trip the watchdog. This might fail when the kernel
476 * was stopped in code which holds watchdog_lock.
7c3078b6
JW
477 */
478void clocksource_touch_watchdog(void)
479{
480 clocksource_resume_watchdog();
481}
482
d65670a7
JS
483/**
484 * clocksource_max_adjustment- Returns max adjustment amount
485 * @cs: Pointer to clocksource
486 *
487 */
488static u32 clocksource_max_adjustment(struct clocksource *cs)
489{
490 u64 ret;
491 /*
88b28adf 492 * We won't try to correct for more than 11% adjustments (110,000 ppm),
d65670a7
JS
493 */
494 ret = (u64)cs->mult * 11;
495 do_div(ret,100);
496 return (u32)ret;
497}
498
98962465 499/**
87d8b9eb
SB
500 * clocks_calc_max_nsecs - Returns maximum nanoseconds that can be converted
501 * @mult: cycle to nanosecond multiplier
502 * @shift: cycle to nanosecond divisor (power of two)
503 * @maxadj: maximum adjustment value to mult (~11%)
504 * @mask: bitmask for two's complement subtraction of non 64 bit counters
fb82fe2f
JS
505 * @max_cyc: maximum cycle value before potential overflow (does not include
506 * any safety margin)
362fde04 507 *
8e56f33f
JS
508 * NOTE: This function includes a safety margin of 50%, in other words, we
509 * return half the number of nanoseconds the hardware counter can technically
510 * cover. This is done so that we can potentially detect problems caused by
511 * delayed timers or bad hardware, which might result in time intervals that
571af55a 512 * are larger than what the math used can handle without overflows.
98962465 513 */
fb82fe2f 514u64 clocks_calc_max_nsecs(u32 mult, u32 shift, u32 maxadj, u64 mask, u64 *max_cyc)
98962465
JH
515{
516 u64 max_nsecs, max_cycles;
517
518 /*
519 * Calculate the maximum number of cycles that we can pass to the
6086e346 520 * cyc2ns() function without overflowing a 64-bit result.
98962465 521 */
6086e346
JS
522 max_cycles = ULLONG_MAX;
523 do_div(max_cycles, mult+maxadj);
98962465
JH
524
525 /*
526 * The actual maximum number of cycles we can defer the clocksource is
87d8b9eb 527 * determined by the minimum of max_cycles and mask.
d65670a7
JS
528 * Note: Here we subtract the maxadj to make sure we don't sleep for
529 * too long if there's a large negative adjustment.
98962465 530 */
87d8b9eb
SB
531 max_cycles = min(max_cycles, mask);
532 max_nsecs = clocksource_cyc2ns(max_cycles, mult - maxadj, shift);
533
fb82fe2f
JS
534 /* return the max_cycles value as well if requested */
535 if (max_cyc)
536 *max_cyc = max_cycles;
537
362fde04
JS
538 /* Return 50% of the actual maximum, so we can detect bad values */
539 max_nsecs >>= 1;
540
87d8b9eb
SB
541 return max_nsecs;
542}
543
544/**
fb82fe2f
JS
545 * clocksource_update_max_deferment - Updates the clocksource max_idle_ns & max_cycles
546 * @cs: Pointer to clocksource to be updated
87d8b9eb
SB
547 *
548 */
fb82fe2f 549static inline void clocksource_update_max_deferment(struct clocksource *cs)
87d8b9eb 550{
fb82fe2f
JS
551 cs->max_idle_ns = clocks_calc_max_nsecs(cs->mult, cs->shift,
552 cs->maxadj, cs->mask,
553 &cs->max_cycles);
98962465
JH
554}
555
592913ec 556#ifndef CONFIG_ARCH_USES_GETTIMEOFFSET
734efb46 557
f5a2e343 558static struct clocksource *clocksource_find_best(bool oneshot, bool skipcur)
5d33b883
TG
559{
560 struct clocksource *cs;
561
562 if (!finished_booting || list_empty(&clocksource_list))
563 return NULL;
564
565 /*
566 * We pick the clocksource with the highest rating. If oneshot
567 * mode is active, we pick the highres valid clocksource with
568 * the best rating.
569 */
570 list_for_each_entry(cs, &clocksource_list, list) {
f5a2e343
TG
571 if (skipcur && cs == curr_clocksource)
572 continue;
5d33b883
TG
573 if (oneshot && !(cs->flags & CLOCK_SOURCE_VALID_FOR_HRES))
574 continue;
575 return cs;
576 }
577 return NULL;
578}
579
f5a2e343 580static void __clocksource_select(bool skipcur)
734efb46 581{
5d33b883 582 bool oneshot = tick_oneshot_mode_active();
f1b82746 583 struct clocksource *best, *cs;
5d8b34fd 584
5d33b883 585 /* Find the best suitable clocksource */
f5a2e343 586 best = clocksource_find_best(oneshot, skipcur);
5d33b883 587 if (!best)
f1b82746 588 return;
5d33b883 589
f1b82746
MS
590 /* Check for the override clocksource. */
591 list_for_each_entry(cs, &clocksource_list, list) {
f5a2e343
TG
592 if (skipcur && cs == curr_clocksource)
593 continue;
f1b82746
MS
594 if (strcmp(cs->name, override_name) != 0)
595 continue;
596 /*
597 * Check to make sure we don't switch to a non-highres
598 * capable clocksource if the tick code is in oneshot
599 * mode (highres or nohz)
600 */
5d33b883 601 if (!(cs->flags & CLOCK_SOURCE_VALID_FOR_HRES) && oneshot) {
f1b82746 602 /* Override clocksource cannot be used. */
36374583
KW
603 if (cs->flags & CLOCK_SOURCE_UNSTABLE) {
604 pr_warn("Override clocksource %s is unstable and not HRT compatible - cannot switch while in HRT/NOHZ mode\n",
605 cs->name);
606 override_name[0] = 0;
607 } else {
608 /*
609 * The override cannot be currently verified.
610 * Deferring to let the watchdog check.
611 */
612 pr_info("Override clocksource %s is not currently HRT compatible - deferring\n",
613 cs->name);
614 }
f1b82746
MS
615 } else
616 /* Override clocksource can be used. */
617 best = cs;
618 break;
619 }
ba919d1c
TG
620
621 if (curr_clocksource != best && !timekeeping_notify(best)) {
622 pr_info("Switched to clocksource %s\n", best->name);
75c5158f 623 curr_clocksource = best;
75c5158f 624 }
f1b82746 625}
734efb46 626
f5a2e343
TG
627/**
628 * clocksource_select - Select the best clocksource available
629 *
630 * Private function. Must hold clocksource_mutex when called.
631 *
632 * Select the clocksource with the best rating, or the clocksource,
633 * which is selected by userspace override.
634 */
635static void clocksource_select(void)
636{
cfed432d 637 __clocksource_select(false);
f5a2e343
TG
638}
639
7eaeb343
TG
640static void clocksource_select_fallback(void)
641{
cfed432d 642 __clocksource_select(true);
7eaeb343
TG
643}
644
592913ec 645#else /* !CONFIG_ARCH_USES_GETTIMEOFFSET */
54a6bc0b 646static inline void clocksource_select(void) { }
1eaff672 647static inline void clocksource_select_fallback(void) { }
54a6bc0b
TG
648
649#endif
650
75c5158f
MS
651/*
652 * clocksource_done_booting - Called near the end of core bootup
653 *
654 * Hack to avoid lots of clocksource churn at boot time.
655 * We use fs_initcall because we want this to start before
656 * device_initcall but after subsys_initcall.
657 */
658static int __init clocksource_done_booting(void)
659{
ad6759fb 660 mutex_lock(&clocksource_mutex);
661 curr_clocksource = clocksource_default_clock();
75c5158f 662 finished_booting = 1;
54a6bc0b
TG
663 /*
664 * Run the watchdog first to eliminate unstable clock sources
665 */
332962f2 666 __clocksource_watchdog_kthread();
75c5158f 667 clocksource_select();
e6c73305 668 mutex_unlock(&clocksource_mutex);
75c5158f
MS
669 return 0;
670}
671fs_initcall(clocksource_done_booting);
672
92c7e002
TG
673/*
674 * Enqueue the clocksource sorted by rating
734efb46 675 */
f1b82746 676static void clocksource_enqueue(struct clocksource *cs)
734efb46 677{
f1b82746
MS
678 struct list_head *entry = &clocksource_list;
679 struct clocksource *tmp;
92c7e002 680
0fb71d34 681 list_for_each_entry(tmp, &clocksource_list, list) {
92c7e002 682 /* Keep track of the place, where to insert */
0fb71d34
MH
683 if (tmp->rating < cs->rating)
684 break;
685 entry = &tmp->list;
686 }
f1b82746 687 list_add(&cs->list, entry);
734efb46 688}
689
d7e81c26 690/**
fba9e072 691 * __clocksource_update_freq_scale - Used update clocksource with new freq
b1b73d09 692 * @cs: clocksource to be registered
d7e81c26
JS
693 * @scale: Scale factor multiplied against freq to get clocksource hz
694 * @freq: clocksource frequency (cycles per second) divided by scale
695 *
852db46d 696 * This should only be called from the clocksource->enable() method.
d7e81c26
JS
697 *
698 * This *SHOULD NOT* be called directly! Please use the
fba9e072
JS
699 * __clocksource_update_freq_hz() or __clocksource_update_freq_khz() helper
700 * functions.
d7e81c26 701 */
fba9e072 702void __clocksource_update_freq_scale(struct clocksource *cs, u32 scale, u32 freq)
d7e81c26 703{
c0e299b1 704 u64 sec;
f8935983 705
d7e81c26 706 /*
f8935983
JS
707 * Default clocksources are *special* and self-define their mult/shift.
708 * But, you're not special, so you should specify a freq value.
d7e81c26 709 */
f8935983
JS
710 if (freq) {
711 /*
712 * Calc the maximum number of seconds which we can run before
713 * wrapping around. For clocksources which have a mask > 32-bit
714 * we need to limit the max sleep time to have a good
715 * conversion precision. 10 minutes is still a reasonable
716 * amount. That results in a shift value of 24 for a
717 * clocksource with mask >= 40-bit and f >= 4GHz. That maps to
718 * ~ 0.06ppm granularity for NTP.
719 */
720 sec = cs->mask;
721 do_div(sec, freq);
722 do_div(sec, scale);
723 if (!sec)
724 sec = 1;
725 else if (sec > 600 && cs->mask > UINT_MAX)
726 sec = 600;
727
728 clocks_calc_mult_shift(&cs->mult, &cs->shift, freq,
729 NSEC_PER_SEC / scale, sec * scale);
730 }
d65670a7 731 /*
362fde04
JS
732 * Ensure clocksources that have large 'mult' values don't overflow
733 * when adjusted.
d65670a7
JS
734 */
735 cs->maxadj = clocksource_max_adjustment(cs);
f8935983
JS
736 while (freq && ((cs->mult + cs->maxadj < cs->mult)
737 || (cs->mult - cs->maxadj > cs->mult))) {
d65670a7
JS
738 cs->mult >>= 1;
739 cs->shift--;
740 cs->maxadj = clocksource_max_adjustment(cs);
741 }
742
f8935983
JS
743 /*
744 * Only warn for *special* clocksources that self-define
745 * their mult/shift values and don't specify a freq.
746 */
747 WARN_ONCE(cs->mult + cs->maxadj < cs->mult,
748 "timekeeping: Clocksource %s might overflow on 11%% adjustment\n",
749 cs->name);
750
fb82fe2f 751 clocksource_update_max_deferment(cs);
8cc8c525 752
45bbfe64
JP
753 pr_info("%s: mask: 0x%llx max_cycles: 0x%llx, max_idle_ns: %lld ns\n",
754 cs->name, cs->mask, cs->max_cycles, cs->max_idle_ns);
852db46d 755}
fba9e072 756EXPORT_SYMBOL_GPL(__clocksource_update_freq_scale);
852db46d
JS
757
758/**
759 * __clocksource_register_scale - Used to install new clocksources
b1b73d09 760 * @cs: clocksource to be registered
852db46d
JS
761 * @scale: Scale factor multiplied against freq to get clocksource hz
762 * @freq: clocksource frequency (cycles per second) divided by scale
763 *
764 * Returns -EBUSY if registration fails, zero otherwise.
765 *
766 * This *SHOULD NOT* be called directly! Please use the
767 * clocksource_register_hz() or clocksource_register_khz helper functions.
768 */
769int __clocksource_register_scale(struct clocksource *cs, u32 scale, u32 freq)
770{
771
b595076a 772 /* Initialize mult/shift and max_idle_ns */
fba9e072 773 __clocksource_update_freq_scale(cs, scale, freq);
d7e81c26 774
be278e98 775 /* Add clocksource to the clocksource list */
d7e81c26
JS
776 mutex_lock(&clocksource_mutex);
777 clocksource_enqueue(cs);
d7e81c26 778 clocksource_enqueue_watchdog(cs);
e05b2efb 779 clocksource_select();
bbf66d89 780 clocksource_select_watchdog(false);
d7e81c26
JS
781 mutex_unlock(&clocksource_mutex);
782 return 0;
783}
784EXPORT_SYMBOL_GPL(__clocksource_register_scale);
785
d0981a1b
TG
786static void __clocksource_change_rating(struct clocksource *cs, int rating)
787{
788 list_del(&cs->list);
789 cs->rating = rating;
790 clocksource_enqueue(cs);
d0981a1b
TG
791}
792
734efb46 793/**
92c7e002 794 * clocksource_change_rating - Change the rating of a registered clocksource
b1b73d09
KK
795 * @cs: clocksource to be changed
796 * @rating: new rating
734efb46 797 */
92c7e002 798void clocksource_change_rating(struct clocksource *cs, int rating)
734efb46 799{
75c5158f 800 mutex_lock(&clocksource_mutex);
d0981a1b 801 __clocksource_change_rating(cs, rating);
332962f2 802 clocksource_select();
bbf66d89 803 clocksource_select_watchdog(false);
75c5158f 804 mutex_unlock(&clocksource_mutex);
734efb46 805}
fb63a0eb 806EXPORT_SYMBOL(clocksource_change_rating);
734efb46 807
7eaeb343
TG
808/*
809 * Unbind clocksource @cs. Called with clocksource_mutex held
810 */
811static int clocksource_unbind(struct clocksource *cs)
812{
bbf66d89
VK
813 if (clocksource_is_watchdog(cs)) {
814 /* Select and try to install a replacement watchdog. */
815 clocksource_select_watchdog(true);
816 if (clocksource_is_watchdog(cs))
817 return -EBUSY;
818 }
7eaeb343
TG
819
820 if (cs == curr_clocksource) {
821 /* Select and try to install a replacement clock source */
822 clocksource_select_fallback();
823 if (curr_clocksource == cs)
824 return -EBUSY;
825 }
826 clocksource_dequeue_watchdog(cs);
827 list_del_init(&cs->list);
828 return 0;
829}
830
4713e22c
TG
831/**
832 * clocksource_unregister - remove a registered clocksource
b1b73d09 833 * @cs: clocksource to be unregistered
4713e22c 834 */
a89c7edb 835int clocksource_unregister(struct clocksource *cs)
4713e22c 836{
a89c7edb
TG
837 int ret = 0;
838
75c5158f 839 mutex_lock(&clocksource_mutex);
a89c7edb
TG
840 if (!list_empty(&cs->list))
841 ret = clocksource_unbind(cs);
75c5158f 842 mutex_unlock(&clocksource_mutex);
a89c7edb 843 return ret;
4713e22c 844}
fb63a0eb 845EXPORT_SYMBOL(clocksource_unregister);
4713e22c 846
2b013700 847#ifdef CONFIG_SYSFS
734efb46 848/**
849 * sysfs_show_current_clocksources - sysfs interface for current clocksource
850 * @dev: unused
b1b73d09 851 * @attr: unused
734efb46 852 * @buf: char buffer to be filled with clocksource list
853 *
854 * Provides sysfs interface for listing current clocksource.
855 */
856static ssize_t
d369a5d8
KS
857sysfs_show_current_clocksources(struct device *dev,
858 struct device_attribute *attr, char *buf)
734efb46 859{
5e2cb101 860 ssize_t count = 0;
734efb46 861
75c5158f 862 mutex_lock(&clocksource_mutex);
5e2cb101 863 count = snprintf(buf, PAGE_SIZE, "%s\n", curr_clocksource->name);
75c5158f 864 mutex_unlock(&clocksource_mutex);
734efb46 865
5e2cb101 866 return count;
734efb46 867}
868
891292a7 869ssize_t sysfs_get_uname(const char *buf, char *dst, size_t cnt)
29b54078
TG
870{
871 size_t ret = cnt;
872
873 /* strings from sysfs write are not 0 terminated! */
874 if (!cnt || cnt >= CS_NAME_LEN)
875 return -EINVAL;
876
877 /* strip of \n: */
878 if (buf[cnt-1] == '\n')
879 cnt--;
880 if (cnt > 0)
881 memcpy(dst, buf, cnt);
882 dst[cnt] = 0;
883 return ret;
884}
885
734efb46 886/**
887 * sysfs_override_clocksource - interface for manually overriding clocksource
888 * @dev: unused
b1b73d09 889 * @attr: unused
734efb46 890 * @buf: name of override clocksource
891 * @count: length of buffer
892 *
893 * Takes input from sysfs interface for manually overriding the default
b71a8eb0 894 * clocksource selection.
734efb46 895 */
d369a5d8
KS
896static ssize_t sysfs_override_clocksource(struct device *dev,
897 struct device_attribute *attr,
734efb46 898 const char *buf, size_t count)
899{
233bcb41 900 ssize_t ret;
734efb46 901
75c5158f 902 mutex_lock(&clocksource_mutex);
734efb46 903
03e13cf5 904 ret = sysfs_get_uname(buf, override_name, count);
29b54078
TG
905 if (ret >= 0)
906 clocksource_select();
734efb46 907
75c5158f 908 mutex_unlock(&clocksource_mutex);
734efb46 909
910 return ret;
911}
912
7eaeb343
TG
913/**
914 * sysfs_unbind_current_clocksource - interface for manually unbinding clocksource
915 * @dev: unused
916 * @attr: unused
917 * @buf: unused
918 * @count: length of buffer
919 *
920 * Takes input from sysfs interface for manually unbinding a clocksource.
921 */
922static ssize_t sysfs_unbind_clocksource(struct device *dev,
923 struct device_attribute *attr,
924 const char *buf, size_t count)
925{
926 struct clocksource *cs;
927 char name[CS_NAME_LEN];
233bcb41 928 ssize_t ret;
7eaeb343 929
03e13cf5 930 ret = sysfs_get_uname(buf, name, count);
7eaeb343
TG
931 if (ret < 0)
932 return ret;
933
934 ret = -ENODEV;
935 mutex_lock(&clocksource_mutex);
936 list_for_each_entry(cs, &clocksource_list, list) {
937 if (strcmp(cs->name, name))
938 continue;
939 ret = clocksource_unbind(cs);
940 break;
941 }
942 mutex_unlock(&clocksource_mutex);
943
944 return ret ? ret : count;
945}
946
734efb46 947/**
948 * sysfs_show_available_clocksources - sysfs interface for listing clocksource
949 * @dev: unused
b1b73d09 950 * @attr: unused
734efb46 951 * @buf: char buffer to be filled with clocksource list
952 *
953 * Provides sysfs interface for listing registered clocksources
954 */
955static ssize_t
d369a5d8
KS
956sysfs_show_available_clocksources(struct device *dev,
957 struct device_attribute *attr,
4a0b2b4d 958 char *buf)
734efb46 959{
2e197586 960 struct clocksource *src;
5e2cb101 961 ssize_t count = 0;
734efb46 962
75c5158f 963 mutex_lock(&clocksource_mutex);
2e197586 964 list_for_each_entry(src, &clocksource_list, list) {
cd6d95d8
TG
965 /*
966 * Don't show non-HRES clocksource if the tick code is
967 * in one shot mode (highres=on or nohz=on)
968 */
969 if (!tick_oneshot_mode_active() ||
970 (src->flags & CLOCK_SOURCE_VALID_FOR_HRES))
3f68535a 971 count += snprintf(buf + count,
5e2cb101
MX
972 max((ssize_t)PAGE_SIZE - count, (ssize_t)0),
973 "%s ", src->name);
734efb46 974 }
75c5158f 975 mutex_unlock(&clocksource_mutex);
734efb46 976
5e2cb101
MX
977 count += snprintf(buf + count,
978 max((ssize_t)PAGE_SIZE - count, (ssize_t)0), "\n");
734efb46 979
5e2cb101 980 return count;
734efb46 981}
982
983/*
984 * Sysfs setup bits:
985 */
d369a5d8 986static DEVICE_ATTR(current_clocksource, 0644, sysfs_show_current_clocksources,
f5f1a24a 987 sysfs_override_clocksource);
734efb46 988
7eaeb343
TG
989static DEVICE_ATTR(unbind_clocksource, 0200, NULL, sysfs_unbind_clocksource);
990
d369a5d8 991static DEVICE_ATTR(available_clocksource, 0444,
f5f1a24a 992 sysfs_show_available_clocksources, NULL);
734efb46 993
d369a5d8 994static struct bus_type clocksource_subsys = {
af5ca3f4 995 .name = "clocksource",
d369a5d8 996 .dev_name = "clocksource",
734efb46 997};
998
d369a5d8 999static struct device device_clocksource = {
734efb46 1000 .id = 0,
d369a5d8 1001 .bus = &clocksource_subsys,
734efb46 1002};
1003
ad596171 1004static int __init init_clocksource_sysfs(void)
734efb46 1005{
d369a5d8 1006 int error = subsys_system_register(&clocksource_subsys, NULL);
734efb46 1007
1008 if (!error)
d369a5d8 1009 error = device_register(&device_clocksource);
734efb46 1010 if (!error)
d369a5d8 1011 error = device_create_file(
734efb46 1012 &device_clocksource,
d369a5d8 1013 &dev_attr_current_clocksource);
7eaeb343
TG
1014 if (!error)
1015 error = device_create_file(&device_clocksource,
1016 &dev_attr_unbind_clocksource);
734efb46 1017 if (!error)
d369a5d8 1018 error = device_create_file(
734efb46 1019 &device_clocksource,
d369a5d8 1020 &dev_attr_available_clocksource);
734efb46 1021 return error;
1022}
1023
1024device_initcall(init_clocksource_sysfs);
2b013700 1025#endif /* CONFIG_SYSFS */
734efb46 1026
1027/**
1028 * boot_override_clocksource - boot clock override
1029 * @str: override name
1030 *
1031 * Takes a clocksource= boot argument and uses it
1032 * as the clocksource override name.
1033 */
1034static int __init boot_override_clocksource(char* str)
1035{
75c5158f 1036 mutex_lock(&clocksource_mutex);
734efb46 1037 if (str)
1038 strlcpy(override_name, str, sizeof(override_name));
75c5158f 1039 mutex_unlock(&clocksource_mutex);
734efb46 1040 return 1;
1041}
1042
1043__setup("clocksource=", boot_override_clocksource);
1044
1045/**
1046 * boot_override_clock - Compatibility layer for deprecated boot option
1047 * @str: override name
1048 *
1049 * DEPRECATED! Takes a clock= boot argument and uses it
1050 * as the clocksource override name
1051 */
1052static int __init boot_override_clock(char* str)
1053{
5d0cf410 1054 if (!strcmp(str, "pmtmr")) {
45bbfe64 1055 pr_warn("clock=pmtmr is deprecated - use clocksource=acpi_pm\n");
5d0cf410 1056 return boot_override_clocksource("acpi_pm");
1057 }
45bbfe64 1058 pr_warn("clock= boot option is deprecated - use clocksource=xyz\n");
734efb46 1059 return boot_override_clocksource(str);
1060}
1061
1062__setup("clock=", boot_override_clock);
This page took 0.810683 seconds and 5 git commands to generate.