1 // SPDX-License-Identifier: GPL-2.0+
3 * This file contains the functions which manage clocksource drivers.
5 * Copyright (C) 2004, 2005 IBM, John Stultz (johnstul@us.ibm.com)
8 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
10 #include <linux/device.h>
11 #include <linux/clocksource.h>
12 #include <linux/init.h>
13 #include <linux/module.h>
14 #include <linux/sched.h> /* for spin_unlock_irq() using preempt_count() m68k */
15 #include <linux/tick.h>
16 #include <linux/kthread.h>
18 #include "tick-internal.h"
19 #include "timekeeping_internal.h"
22 * clocks_calc_mult_shift - calculate mult/shift factors for scaled math of clocks
23 * @mult: pointer to mult variable
24 * @shift: pointer to shift variable
25 * @from: frequency to convert from
26 * @to: frequency to convert to
27 * @maxsec: guaranteed runtime conversion range in seconds
29 * The function evaluates the shift/mult pair for the scaled math
30 * operations of clocksources and clockevents.
32 * @to and @from are frequency values in HZ. For clock sources @to is
33 * NSEC_PER_SEC == 1GHz and @from is the counter frequency. For clock
34 * event @to is the counter frequency and @from is NSEC_PER_SEC.
36 * The @maxsec conversion range argument controls the time frame in
37 * seconds which must be covered by the runtime conversion with the
38 * calculated mult and shift factors. This guarantees that no 64bit
39 * overflow happens when the input value of the conversion is
40 * multiplied with the calculated mult factor. Larger ranges may
41 * reduce the conversion accuracy by chosing smaller mult and shift
45 clocks_calc_mult_shift(u32
*mult
, u32
*shift
, u32 from
, u32 to
, u32 maxsec
)
51 * Calculate the shift factor which is limiting the conversion
54 tmp
= ((u64
)maxsec
* from
) >> 32;
61 * Find the conversion shift/mult pair which has the best
62 * accuracy and fits the maxsec conversion range:
64 for (sft
= 32; sft
> 0; sft
--) {
65 tmp
= (u64
) to
<< sft
;
68 if ((tmp
>> sftacc
) == 0)
74 EXPORT_SYMBOL_GPL(clocks_calc_mult_shift
);
76 /*[Clocksource internal variables]---------
78 * currently selected clocksource.
79 * suspend_clocksource:
80 * used to calculate the suspend time.
82 * linked list with the registered clocksources
84 * protects manipulations to curr_clocksource and the clocksource_list
86 * Name of the user-specified clocksource.
88 static struct clocksource
*curr_clocksource
;
89 static struct clocksource
*suspend_clocksource
;
90 static LIST_HEAD(clocksource_list
);
91 static DEFINE_MUTEX(clocksource_mutex
);
92 static char override_name
[CS_NAME_LEN
];
93 static int finished_booting
;
94 static u64 suspend_start
;
96 #ifdef CONFIG_CLOCKSOURCE_WATCHDOG
97 static void clocksource_watchdog_work(struct work_struct
*work
);
98 static void clocksource_select(void);
100 static LIST_HEAD(watchdog_list
);
101 static struct clocksource
*watchdog
;
102 static struct timer_list watchdog_timer
;
103 static DECLARE_WORK(watchdog_work
, clocksource_watchdog_work
);
104 static DEFINE_SPINLOCK(watchdog_lock
);
105 static int watchdog_running
;
106 static atomic_t watchdog_reset_pending
;
108 static void inline clocksource_watchdog_lock(unsigned long *flags
)
110 spin_lock_irqsave(&watchdog_lock
, *flags
);
113 static void inline clocksource_watchdog_unlock(unsigned long *flags
)
115 spin_unlock_irqrestore(&watchdog_lock
, *flags
);
118 static int clocksource_watchdog_kthread(void *data
);
119 static void __clocksource_change_rating(struct clocksource
*cs
, int rating
);
122 * Interval: 0.5sec Threshold: 0.0625s
124 #define WATCHDOG_INTERVAL (HZ >> 1)
125 #define WATCHDOG_THRESHOLD (NSEC_PER_SEC >> 4)
127 static void clocksource_watchdog_work(struct work_struct
*work
)
130 * We cannot directly run clocksource_watchdog_kthread() here, because
131 * clocksource_select() calls timekeeping_notify() which uses
132 * stop_machine(). One cannot use stop_machine() from a workqueue() due
133 * lock inversions wrt CPU hotplug.
135 * Also, we only ever run this work once or twice during the lifetime
136 * of the kernel, so there is no point in creating a more permanent
139 * If kthread_run fails the next watchdog scan over the
140 * watchdog_list will find the unstable clock again.
142 kthread_run(clocksource_watchdog_kthread
, NULL
, "kwatchdog");
145 static void __clocksource_unstable(struct clocksource
*cs
)
147 cs
->flags
&= ~(CLOCK_SOURCE_VALID_FOR_HRES
| CLOCK_SOURCE_WATCHDOG
);
148 cs
->flags
|= CLOCK_SOURCE_UNSTABLE
;
151 * If the clocksource is registered clocksource_watchdog_kthread() will
152 * re-rate and re-select.
154 if (list_empty(&cs
->list
)) {
159 if (cs
->mark_unstable
)
160 cs
->mark_unstable(cs
);
162 /* kick clocksource_watchdog_kthread() */
163 if (finished_booting
)
164 schedule_work(&watchdog_work
);
168 * clocksource_mark_unstable - mark clocksource unstable via watchdog
169 * @cs: clocksource to be marked unstable
171 * This function is called by the x86 TSC code to mark clocksources as unstable;
172 * it defers demotion and re-selection to a kthread.
174 void clocksource_mark_unstable(struct clocksource
*cs
)
178 spin_lock_irqsave(&watchdog_lock
, flags
);
179 if (!(cs
->flags
& CLOCK_SOURCE_UNSTABLE
)) {
180 if (!list_empty(&cs
->list
) && list_empty(&cs
->wd_list
))
181 list_add(&cs
->wd_list
, &watchdog_list
);
182 __clocksource_unstable(cs
);
184 spin_unlock_irqrestore(&watchdog_lock
, flags
);
187 static void clocksource_watchdog(struct timer_list
*unused
)
189 struct clocksource
*cs
;
190 u64 csnow
, wdnow
, cslast
, wdlast
, delta
;
191 int64_t wd_nsec
, cs_nsec
;
192 int next_cpu
, reset_pending
;
194 spin_lock(&watchdog_lock
);
195 if (!watchdog_running
)
198 reset_pending
= atomic_read(&watchdog_reset_pending
);
200 list_for_each_entry(cs
, &watchdog_list
, wd_list
) {
202 /* Clocksource already marked unstable? */
203 if (cs
->flags
& CLOCK_SOURCE_UNSTABLE
) {
204 if (finished_booting
)
205 schedule_work(&watchdog_work
);
210 csnow
= cs
->read(cs
);
211 wdnow
= watchdog
->read(watchdog
);
214 /* Clocksource initialized ? */
215 if (!(cs
->flags
& CLOCK_SOURCE_WATCHDOG
) ||
216 atomic_read(&watchdog_reset_pending
)) {
217 cs
->flags
|= CLOCK_SOURCE_WATCHDOG
;
223 delta
= clocksource_delta(wdnow
, cs
->wd_last
, watchdog
->mask
);
224 wd_nsec
= clocksource_cyc2ns(delta
, watchdog
->mult
,
227 delta
= clocksource_delta(csnow
, cs
->cs_last
, cs
->mask
);
228 cs_nsec
= clocksource_cyc2ns(delta
, cs
->mult
, cs
->shift
);
229 wdlast
= cs
->wd_last
; /* save these in case we print them */
230 cslast
= cs
->cs_last
;
234 if (atomic_read(&watchdog_reset_pending
))
237 /* Check the deviation from the watchdog clocksource. */
238 if (abs(cs_nsec
- wd_nsec
) > WATCHDOG_THRESHOLD
) {
239 pr_warn("timekeeping watchdog on CPU%d: Marking clocksource '%s' as unstable because the skew is too large:\n",
240 smp_processor_id(), cs
->name
);
241 pr_warn(" '%s' wd_now: %llx wd_last: %llx mask: %llx\n",
242 watchdog
->name
, wdnow
, wdlast
, watchdog
->mask
);
243 pr_warn(" '%s' cs_now: %llx cs_last: %llx mask: %llx\n",
244 cs
->name
, csnow
, cslast
, cs
->mask
);
245 __clocksource_unstable(cs
);
249 if (cs
== curr_clocksource
&& cs
->tick_stable
)
252 if (!(cs
->flags
& CLOCK_SOURCE_VALID_FOR_HRES
) &&
253 (cs
->flags
& CLOCK_SOURCE_IS_CONTINUOUS
) &&
254 (watchdog
->flags
& CLOCK_SOURCE_IS_CONTINUOUS
)) {
255 /* Mark it valid for high-res. */
256 cs
->flags
|= CLOCK_SOURCE_VALID_FOR_HRES
;
259 * clocksource_done_booting() will sort it if
260 * finished_booting is not set yet.
262 if (!finished_booting
)
266 * If this is not the current clocksource let
267 * the watchdog thread reselect it. Due to the
268 * change to high res this clocksource might
269 * be preferred now. If it is the current
270 * clocksource let the tick code know about
273 if (cs
!= curr_clocksource
) {
274 cs
->flags
|= CLOCK_SOURCE_RESELECT
;
275 schedule_work(&watchdog_work
);
283 * We only clear the watchdog_reset_pending, when we did a
284 * full cycle through all clocksources.
287 atomic_dec(&watchdog_reset_pending
);
290 * Cycle through CPUs to check if the CPUs stay synchronized
293 next_cpu
= cpumask_next(raw_smp_processor_id(), cpu_online_mask
);
294 if (next_cpu
>= nr_cpu_ids
)
295 next_cpu
= cpumask_first(cpu_online_mask
);
296 watchdog_timer
.expires
+= WATCHDOG_INTERVAL
;
297 add_timer_on(&watchdog_timer
, next_cpu
);
299 spin_unlock(&watchdog_lock
);
302 static inline void clocksource_start_watchdog(void)
304 if (watchdog_running
|| !watchdog
|| list_empty(&watchdog_list
))
306 timer_setup(&watchdog_timer
, clocksource_watchdog
, 0);
307 watchdog_timer
.expires
= jiffies
+ WATCHDOG_INTERVAL
;
308 add_timer_on(&watchdog_timer
, cpumask_first(cpu_online_mask
));
309 watchdog_running
= 1;
312 static inline void clocksource_stop_watchdog(void)
314 if (!watchdog_running
|| (watchdog
&& !list_empty(&watchdog_list
)))
316 del_timer(&watchdog_timer
);
317 watchdog_running
= 0;
320 static inline void clocksource_reset_watchdog(void)
322 struct clocksource
*cs
;
324 list_for_each_entry(cs
, &watchdog_list
, wd_list
)
325 cs
->flags
&= ~CLOCK_SOURCE_WATCHDOG
;
328 static void clocksource_resume_watchdog(void)
330 atomic_inc(&watchdog_reset_pending
);
333 static void clocksource_enqueue_watchdog(struct clocksource
*cs
)
335 INIT_LIST_HEAD(&cs
->wd_list
);
337 if (cs
->flags
& CLOCK_SOURCE_MUST_VERIFY
) {
338 /* cs is a clocksource to be watched. */
339 list_add(&cs
->wd_list
, &watchdog_list
);
340 cs
->flags
&= ~CLOCK_SOURCE_WATCHDOG
;
342 /* cs is a watchdog. */
343 if (cs
->flags
& CLOCK_SOURCE_IS_CONTINUOUS
)
344 cs
->flags
|= CLOCK_SOURCE_VALID_FOR_HRES
;
348 static void clocksource_select_watchdog(bool fallback
)
350 struct clocksource
*cs
, *old_wd
;
353 spin_lock_irqsave(&watchdog_lock
, flags
);
354 /* save current watchdog */
359 list_for_each_entry(cs
, &clocksource_list
, list
) {
360 /* cs is a clocksource to be watched. */
361 if (cs
->flags
& CLOCK_SOURCE_MUST_VERIFY
)
364 /* Skip current if we were requested for a fallback. */
365 if (fallback
&& cs
== old_wd
)
368 /* Pick the best watchdog. */
369 if (!watchdog
|| cs
->rating
> watchdog
->rating
)
372 /* If we failed to find a fallback restore the old one. */
376 /* If we changed the watchdog we need to reset cycles. */
377 if (watchdog
!= old_wd
)
378 clocksource_reset_watchdog();
380 /* Check if the watchdog timer needs to be started. */
381 clocksource_start_watchdog();
382 spin_unlock_irqrestore(&watchdog_lock
, flags
);
385 static void clocksource_dequeue_watchdog(struct clocksource
*cs
)
387 if (cs
!= watchdog
) {
388 if (cs
->flags
& CLOCK_SOURCE_MUST_VERIFY
) {
389 /* cs is a watched clocksource. */
390 list_del_init(&cs
->wd_list
);
391 /* Check if the watchdog timer needs to be stopped. */
392 clocksource_stop_watchdog();
397 static int __clocksource_watchdog_kthread(void)
399 struct clocksource
*cs
, *tmp
;
403 spin_lock_irqsave(&watchdog_lock
, flags
);
404 list_for_each_entry_safe(cs
, tmp
, &watchdog_list
, wd_list
) {
405 if (cs
->flags
& CLOCK_SOURCE_UNSTABLE
) {
406 list_del_init(&cs
->wd_list
);
407 __clocksource_change_rating(cs
, 0);
410 if (cs
->flags
& CLOCK_SOURCE_RESELECT
) {
411 cs
->flags
&= ~CLOCK_SOURCE_RESELECT
;
415 /* Check if the watchdog timer needs to be stopped. */
416 clocksource_stop_watchdog();
417 spin_unlock_irqrestore(&watchdog_lock
, flags
);
422 static int clocksource_watchdog_kthread(void *data
)
424 mutex_lock(&clocksource_mutex
);
425 if (__clocksource_watchdog_kthread())
426 clocksource_select();
427 mutex_unlock(&clocksource_mutex
);
431 static bool clocksource_is_watchdog(struct clocksource
*cs
)
433 return cs
== watchdog
;
436 #else /* CONFIG_CLOCKSOURCE_WATCHDOG */
438 static void clocksource_enqueue_watchdog(struct clocksource
*cs
)
440 if (cs
->flags
& CLOCK_SOURCE_IS_CONTINUOUS
)
441 cs
->flags
|= CLOCK_SOURCE_VALID_FOR_HRES
;
444 static void clocksource_select_watchdog(bool fallback
) { }
445 static inline void clocksource_dequeue_watchdog(struct clocksource
*cs
) { }
446 static inline void clocksource_resume_watchdog(void) { }
447 static inline int __clocksource_watchdog_kthread(void) { return 0; }
448 static bool clocksource_is_watchdog(struct clocksource
*cs
) { return false; }
449 void clocksource_mark_unstable(struct clocksource
*cs
) { }
451 static inline void clocksource_watchdog_lock(unsigned long *flags
) { }
452 static inline void clocksource_watchdog_unlock(unsigned long *flags
) { }
454 #endif /* CONFIG_CLOCKSOURCE_WATCHDOG */
456 static bool clocksource_is_suspend(struct clocksource
*cs
)
458 return cs
== suspend_clocksource
;
461 static void __clocksource_suspend_select(struct clocksource
*cs
)
464 * Skip the clocksource which will be stopped in suspend state.
466 if (!(cs
->flags
& CLOCK_SOURCE_SUSPEND_NONSTOP
))
470 * The nonstop clocksource can be selected as the suspend clocksource to
471 * calculate the suspend time, so it should not supply suspend/resume
472 * interfaces to suspend the nonstop clocksource when system suspends.
474 if (cs
->suspend
|| cs
->resume
) {
475 pr_warn("Nonstop clocksource %s should not supply suspend/resume interfaces\n",
479 /* Pick the best rating. */
480 if (!suspend_clocksource
|| cs
->rating
> suspend_clocksource
->rating
)
481 suspend_clocksource
= cs
;
485 * clocksource_suspend_select - Select the best clocksource for suspend timing
486 * @fallback: if select a fallback clocksource
488 static void clocksource_suspend_select(bool fallback
)
490 struct clocksource
*cs
, *old_suspend
;
492 old_suspend
= suspend_clocksource
;
494 suspend_clocksource
= NULL
;
496 list_for_each_entry(cs
, &clocksource_list
, list
) {
497 /* Skip current if we were requested for a fallback. */
498 if (fallback
&& cs
== old_suspend
)
501 __clocksource_suspend_select(cs
);
506 * clocksource_start_suspend_timing - Start measuring the suspend timing
507 * @cs: current clocksource from timekeeping
508 * @start_cycles: current cycles from timekeeping
510 * This function will save the start cycle values of suspend timer to calculate
511 * the suspend time when resuming system.
513 * This function is called late in the suspend process from timekeeping_suspend(),
514 * that means processes are freezed, non-boot cpus and interrupts are disabled
515 * now. It is therefore possible to start the suspend timer without taking the
518 void clocksource_start_suspend_timing(struct clocksource
*cs
, u64 start_cycles
)
520 if (!suspend_clocksource
)
524 * If current clocksource is the suspend timer, we should use the
525 * tkr_mono.cycle_last value as suspend_start to avoid same reading
526 * from suspend timer.
528 if (clocksource_is_suspend(cs
)) {
529 suspend_start
= start_cycles
;
533 if (suspend_clocksource
->enable
&&
534 suspend_clocksource
->enable(suspend_clocksource
)) {
535 pr_warn_once("Failed to enable the non-suspend-able clocksource.\n");
539 suspend_start
= suspend_clocksource
->read(suspend_clocksource
);
543 * clocksource_stop_suspend_timing - Stop measuring the suspend timing
544 * @cs: current clocksource from timekeeping
545 * @cycle_now: current cycles from timekeeping
547 * This function will calculate the suspend time from suspend timer.
549 * Returns nanoseconds since suspend started, 0 if no usable suspend clocksource.
551 * This function is called early in the resume process from timekeeping_resume(),
552 * that means there is only one cpu, no processes are running and the interrupts
553 * are disabled. It is therefore possible to stop the suspend timer without
554 * taking the clocksource mutex.
556 u64
clocksource_stop_suspend_timing(struct clocksource
*cs
, u64 cycle_now
)
558 u64 now
, delta
, nsec
= 0;
560 if (!suspend_clocksource
)
564 * If current clocksource is the suspend timer, we should use the
565 * tkr_mono.cycle_last value from timekeeping as current cycle to
566 * avoid same reading from suspend timer.
568 if (clocksource_is_suspend(cs
))
571 now
= suspend_clocksource
->read(suspend_clocksource
);
573 if (now
> suspend_start
) {
574 delta
= clocksource_delta(now
, suspend_start
,
575 suspend_clocksource
->mask
);
576 nsec
= mul_u64_u32_shr(delta
, suspend_clocksource
->mult
,
577 suspend_clocksource
->shift
);
581 * Disable the suspend timer to save power if current clocksource is
582 * not the suspend timer.
584 if (!clocksource_is_suspend(cs
) && suspend_clocksource
->disable
)
585 suspend_clocksource
->disable(suspend_clocksource
);
591 * clocksource_suspend - suspend the clocksource(s)
593 void clocksource_suspend(void)
595 struct clocksource
*cs
;
597 list_for_each_entry_reverse(cs
, &clocksource_list
, list
)
603 * clocksource_resume - resume the clocksource(s)
605 void clocksource_resume(void)
607 struct clocksource
*cs
;
609 list_for_each_entry(cs
, &clocksource_list
, list
)
613 clocksource_resume_watchdog();
617 * clocksource_touch_watchdog - Update watchdog
619 * Update the watchdog after exception contexts such as kgdb so as not
620 * to incorrectly trip the watchdog. This might fail when the kernel
621 * was stopped in code which holds watchdog_lock.
623 void clocksource_touch_watchdog(void)
625 clocksource_resume_watchdog();
629 * clocksource_max_adjustment- Returns max adjustment amount
630 * @cs: Pointer to clocksource
633 static u32
clocksource_max_adjustment(struct clocksource
*cs
)
637 * We won't try to correct for more than 11% adjustments (110,000 ppm),
639 ret
= (u64
)cs
->mult
* 11;
645 * clocks_calc_max_nsecs - Returns maximum nanoseconds that can be converted
646 * @mult: cycle to nanosecond multiplier
647 * @shift: cycle to nanosecond divisor (power of two)
648 * @maxadj: maximum adjustment value to mult (~11%)
649 * @mask: bitmask for two's complement subtraction of non 64 bit counters
650 * @max_cyc: maximum cycle value before potential overflow (does not include
653 * NOTE: This function includes a safety margin of 50%, in other words, we
654 * return half the number of nanoseconds the hardware counter can technically
655 * cover. This is done so that we can potentially detect problems caused by
656 * delayed timers or bad hardware, which might result in time intervals that
657 * are larger than what the math used can handle without overflows.
659 u64
clocks_calc_max_nsecs(u32 mult
, u32 shift
, u32 maxadj
, u64 mask
, u64
*max_cyc
)
661 u64 max_nsecs
, max_cycles
;
664 * Calculate the maximum number of cycles that we can pass to the
665 * cyc2ns() function without overflowing a 64-bit result.
667 max_cycles
= ULLONG_MAX
;
668 do_div(max_cycles
, mult
+maxadj
);
671 * The actual maximum number of cycles we can defer the clocksource is
672 * determined by the minimum of max_cycles and mask.
673 * Note: Here we subtract the maxadj to make sure we don't sleep for
674 * too long if there's a large negative adjustment.
676 max_cycles
= min(max_cycles
, mask
);
677 max_nsecs
= clocksource_cyc2ns(max_cycles
, mult
- maxadj
, shift
);
679 /* return the max_cycles value as well if requested */
681 *max_cyc
= max_cycles
;
683 /* Return 50% of the actual maximum, so we can detect bad values */
690 * clocksource_update_max_deferment - Updates the clocksource max_idle_ns & max_cycles
691 * @cs: Pointer to clocksource to be updated
694 static inline void clocksource_update_max_deferment(struct clocksource
*cs
)
696 cs
->max_idle_ns
= clocks_calc_max_nsecs(cs
->mult
, cs
->shift
,
697 cs
->maxadj
, cs
->mask
,
701 #ifndef CONFIG_ARCH_USES_GETTIMEOFFSET
703 static struct clocksource
*clocksource_find_best(bool oneshot
, bool skipcur
)
705 struct clocksource
*cs
;
707 if (!finished_booting
|| list_empty(&clocksource_list
))
711 * We pick the clocksource with the highest rating. If oneshot
712 * mode is active, we pick the highres valid clocksource with
715 list_for_each_entry(cs
, &clocksource_list
, list
) {
716 if (skipcur
&& cs
== curr_clocksource
)
718 if (oneshot
&& !(cs
->flags
& CLOCK_SOURCE_VALID_FOR_HRES
))
725 static void __clocksource_select(bool skipcur
)
727 bool oneshot
= tick_oneshot_mode_active();
728 struct clocksource
*best
, *cs
;
730 /* Find the best suitable clocksource */
731 best
= clocksource_find_best(oneshot
, skipcur
);
735 if (!strlen(override_name
))
738 /* Check for the override clocksource. */
739 list_for_each_entry(cs
, &clocksource_list
, list
) {
740 if (skipcur
&& cs
== curr_clocksource
)
742 if (strcmp(cs
->name
, override_name
) != 0)
745 * Check to make sure we don't switch to a non-highres
746 * capable clocksource if the tick code is in oneshot
747 * mode (highres or nohz)
749 if (!(cs
->flags
& CLOCK_SOURCE_VALID_FOR_HRES
) && oneshot
) {
750 /* Override clocksource cannot be used. */
751 if (cs
->flags
& CLOCK_SOURCE_UNSTABLE
) {
752 pr_warn("Override clocksource %s is unstable and not HRT compatible - cannot switch while in HRT/NOHZ mode\n",
754 override_name
[0] = 0;
757 * The override cannot be currently verified.
758 * Deferring to let the watchdog check.
760 pr_info("Override clocksource %s is not currently HRT compatible - deferring\n",
764 /* Override clocksource can be used. */
770 if (curr_clocksource
!= best
&& !timekeeping_notify(best
)) {
771 pr_info("Switched to clocksource %s\n", best
->name
);
772 curr_clocksource
= best
;
777 * clocksource_select - Select the best clocksource available
779 * Private function. Must hold clocksource_mutex when called.
781 * Select the clocksource with the best rating, or the clocksource,
782 * which is selected by userspace override.
784 static void clocksource_select(void)
786 __clocksource_select(false);
789 static void clocksource_select_fallback(void)
791 __clocksource_select(true);
794 #else /* !CONFIG_ARCH_USES_GETTIMEOFFSET */
795 static inline void clocksource_select(void) { }
796 static inline void clocksource_select_fallback(void) { }
801 * clocksource_done_booting - Called near the end of core bootup
803 * Hack to avoid lots of clocksource churn at boot time.
804 * We use fs_initcall because we want this to start before
805 * device_initcall but after subsys_initcall.
807 static int __init
clocksource_done_booting(void)
809 mutex_lock(&clocksource_mutex
);
810 curr_clocksource
= clocksource_default_clock();
811 finished_booting
= 1;
813 * Run the watchdog first to eliminate unstable clock sources
815 __clocksource_watchdog_kthread();
816 clocksource_select();
817 mutex_unlock(&clocksource_mutex
);
820 fs_initcall(clocksource_done_booting
);
823 * Enqueue the clocksource sorted by rating
825 static void clocksource_enqueue(struct clocksource
*cs
)
827 struct list_head
*entry
= &clocksource_list
;
828 struct clocksource
*tmp
;
830 list_for_each_entry(tmp
, &clocksource_list
, list
) {
831 /* Keep track of the place, where to insert */
832 if (tmp
->rating
< cs
->rating
)
836 list_add(&cs
->list
, entry
);
840 * __clocksource_update_freq_scale - Used update clocksource with new freq
841 * @cs: clocksource to be registered
842 * @scale: Scale factor multiplied against freq to get clocksource hz
843 * @freq: clocksource frequency (cycles per second) divided by scale
845 * This should only be called from the clocksource->enable() method.
847 * This *SHOULD NOT* be called directly! Please use the
848 * __clocksource_update_freq_hz() or __clocksource_update_freq_khz() helper
851 void __clocksource_update_freq_scale(struct clocksource
*cs
, u32 scale
, u32 freq
)
856 * Default clocksources are *special* and self-define their mult/shift.
857 * But, you're not special, so you should specify a freq value.
861 * Calc the maximum number of seconds which we can run before
862 * wrapping around. For clocksources which have a mask > 32-bit
863 * we need to limit the max sleep time to have a good
864 * conversion precision. 10 minutes is still a reasonable
865 * amount. That results in a shift value of 24 for a
866 * clocksource with mask >= 40-bit and f >= 4GHz. That maps to
867 * ~ 0.06ppm granularity for NTP.
874 else if (sec
> 600 && cs
->mask
> UINT_MAX
)
877 clocks_calc_mult_shift(&cs
->mult
, &cs
->shift
, freq
,
878 NSEC_PER_SEC
/ scale
, sec
* scale
);
881 * Ensure clocksources that have large 'mult' values don't overflow
884 cs
->maxadj
= clocksource_max_adjustment(cs
);
885 while (freq
&& ((cs
->mult
+ cs
->maxadj
< cs
->mult
)
886 || (cs
->mult
- cs
->maxadj
> cs
->mult
))) {
889 cs
->maxadj
= clocksource_max_adjustment(cs
);
893 * Only warn for *special* clocksources that self-define
894 * their mult/shift values and don't specify a freq.
896 WARN_ONCE(cs
->mult
+ cs
->maxadj
< cs
->mult
,
897 "timekeeping: Clocksource %s might overflow on 11%% adjustment\n",
900 clocksource_update_max_deferment(cs
);
902 pr_info("%s: mask: 0x%llx max_cycles: 0x%llx, max_idle_ns: %lld ns\n",
903 cs
->name
, cs
->mask
, cs
->max_cycles
, cs
->max_idle_ns
);
905 EXPORT_SYMBOL_GPL(__clocksource_update_freq_scale
);
908 * __clocksource_register_scale - Used to install new clocksources
909 * @cs: clocksource to be registered
910 * @scale: Scale factor multiplied against freq to get clocksource hz
911 * @freq: clocksource frequency (cycles per second) divided by scale
913 * Returns -EBUSY if registration fails, zero otherwise.
915 * This *SHOULD NOT* be called directly! Please use the
916 * clocksource_register_hz() or clocksource_register_khz helper functions.
918 int __clocksource_register_scale(struct clocksource
*cs
, u32 scale
, u32 freq
)
922 clocksource_arch_init(cs
);
924 /* Initialize mult/shift and max_idle_ns */
925 __clocksource_update_freq_scale(cs
, scale
, freq
);
927 /* Add clocksource to the clocksource list */
928 mutex_lock(&clocksource_mutex
);
930 clocksource_watchdog_lock(&flags
);
931 clocksource_enqueue(cs
);
932 clocksource_enqueue_watchdog(cs
);
933 clocksource_watchdog_unlock(&flags
);
935 clocksource_select();
936 clocksource_select_watchdog(false);
937 __clocksource_suspend_select(cs
);
938 mutex_unlock(&clocksource_mutex
);
941 EXPORT_SYMBOL_GPL(__clocksource_register_scale
);
943 static void __clocksource_change_rating(struct clocksource
*cs
, int rating
)
947 clocksource_enqueue(cs
);
951 * clocksource_change_rating - Change the rating of a registered clocksource
952 * @cs: clocksource to be changed
953 * @rating: new rating
955 void clocksource_change_rating(struct clocksource
*cs
, int rating
)
959 mutex_lock(&clocksource_mutex
);
960 clocksource_watchdog_lock(&flags
);
961 __clocksource_change_rating(cs
, rating
);
962 clocksource_watchdog_unlock(&flags
);
964 clocksource_select();
965 clocksource_select_watchdog(false);
966 clocksource_suspend_select(false);
967 mutex_unlock(&clocksource_mutex
);
969 EXPORT_SYMBOL(clocksource_change_rating
);
972 * Unbind clocksource @cs. Called with clocksource_mutex held
974 static int clocksource_unbind(struct clocksource
*cs
)
978 if (clocksource_is_watchdog(cs
)) {
979 /* Select and try to install a replacement watchdog. */
980 clocksource_select_watchdog(true);
981 if (clocksource_is_watchdog(cs
))
985 if (cs
== curr_clocksource
) {
986 /* Select and try to install a replacement clock source */
987 clocksource_select_fallback();
988 if (curr_clocksource
== cs
)
992 if (clocksource_is_suspend(cs
)) {
994 * Select and try to install a replacement suspend clocksource.
995 * If no replacement suspend clocksource, we will just let the
996 * clocksource go and have no suspend clocksource.
998 clocksource_suspend_select(true);
1001 clocksource_watchdog_lock(&flags
);
1002 clocksource_dequeue_watchdog(cs
);
1003 list_del_init(&cs
->list
);
1004 clocksource_watchdog_unlock(&flags
);
1010 * clocksource_unregister - remove a registered clocksource
1011 * @cs: clocksource to be unregistered
1013 int clocksource_unregister(struct clocksource
*cs
)
1017 mutex_lock(&clocksource_mutex
);
1018 if (!list_empty(&cs
->list
))
1019 ret
= clocksource_unbind(cs
);
1020 mutex_unlock(&clocksource_mutex
);
1023 EXPORT_SYMBOL(clocksource_unregister
);
1027 * current_clocksource_show - sysfs interface for current clocksource
1030 * @buf: char buffer to be filled with clocksource list
1032 * Provides sysfs interface for listing current clocksource.
1034 static ssize_t
current_clocksource_show(struct device
*dev
,
1035 struct device_attribute
*attr
,
1040 mutex_lock(&clocksource_mutex
);
1041 count
= snprintf(buf
, PAGE_SIZE
, "%s\n", curr_clocksource
->name
);
1042 mutex_unlock(&clocksource_mutex
);
1047 ssize_t
sysfs_get_uname(const char *buf
, char *dst
, size_t cnt
)
1051 /* strings from sysfs write are not 0 terminated! */
1052 if (!cnt
|| cnt
>= CS_NAME_LEN
)
1056 if (buf
[cnt
-1] == '\n')
1059 memcpy(dst
, buf
, cnt
);
1065 * current_clocksource_store - interface for manually overriding clocksource
1068 * @buf: name of override clocksource
1069 * @count: length of buffer
1071 * Takes input from sysfs interface for manually overriding the default
1072 * clocksource selection.
1074 static ssize_t
current_clocksource_store(struct device
*dev
,
1075 struct device_attribute
*attr
,
1076 const char *buf
, size_t count
)
1080 mutex_lock(&clocksource_mutex
);
1082 ret
= sysfs_get_uname(buf
, override_name
, count
);
1084 clocksource_select();
1086 mutex_unlock(&clocksource_mutex
);
1090 static DEVICE_ATTR_RW(current_clocksource
);
1093 * unbind_clocksource_store - interface for manually unbinding clocksource
1097 * @count: length of buffer
1099 * Takes input from sysfs interface for manually unbinding a clocksource.
1101 static ssize_t
unbind_clocksource_store(struct device
*dev
,
1102 struct device_attribute
*attr
,
1103 const char *buf
, size_t count
)
1105 struct clocksource
*cs
;
1106 char name
[CS_NAME_LEN
];
1109 ret
= sysfs_get_uname(buf
, name
, count
);
1114 mutex_lock(&clocksource_mutex
);
1115 list_for_each_entry(cs
, &clocksource_list
, list
) {
1116 if (strcmp(cs
->name
, name
))
1118 ret
= clocksource_unbind(cs
);
1121 mutex_unlock(&clocksource_mutex
);
1123 return ret
? ret
: count
;
1125 static DEVICE_ATTR_WO(unbind_clocksource
);
1128 * available_clocksource_show - sysfs interface for listing clocksource
1131 * @buf: char buffer to be filled with clocksource list
1133 * Provides sysfs interface for listing registered clocksources
1135 static ssize_t
available_clocksource_show(struct device
*dev
,
1136 struct device_attribute
*attr
,
1139 struct clocksource
*src
;
1142 mutex_lock(&clocksource_mutex
);
1143 list_for_each_entry(src
, &clocksource_list
, list
) {
1145 * Don't show non-HRES clocksource if the tick code is
1146 * in one shot mode (highres=on or nohz=on)
1148 if (!tick_oneshot_mode_active() ||
1149 (src
->flags
& CLOCK_SOURCE_VALID_FOR_HRES
))
1150 count
+= snprintf(buf
+ count
,
1151 max((ssize_t
)PAGE_SIZE
- count
, (ssize_t
)0),
1154 mutex_unlock(&clocksource_mutex
);
1156 count
+= snprintf(buf
+ count
,
1157 max((ssize_t
)PAGE_SIZE
- count
, (ssize_t
)0), "\n");
1161 static DEVICE_ATTR_RO(available_clocksource
);
1163 static struct attribute
*clocksource_attrs
[] = {
1164 &dev_attr_current_clocksource
.attr
,
1165 &dev_attr_unbind_clocksource
.attr
,
1166 &dev_attr_available_clocksource
.attr
,
1169 ATTRIBUTE_GROUPS(clocksource
);
1171 static struct bus_type clocksource_subsys
= {
1172 .name
= "clocksource",
1173 .dev_name
= "clocksource",
1176 static struct device device_clocksource
= {
1178 .bus
= &clocksource_subsys
,
1179 .groups
= clocksource_groups
,
1182 static int __init
init_clocksource_sysfs(void)
1184 int error
= subsys_system_register(&clocksource_subsys
, NULL
);
1187 error
= device_register(&device_clocksource
);
1192 device_initcall(init_clocksource_sysfs
);
1193 #endif /* CONFIG_SYSFS */
1196 * boot_override_clocksource - boot clock override
1197 * @str: override name
1199 * Takes a clocksource= boot argument and uses it
1200 * as the clocksource override name.
1202 static int __init
boot_override_clocksource(char* str
)
1204 mutex_lock(&clocksource_mutex
);
1206 strlcpy(override_name
, str
, sizeof(override_name
));
1207 mutex_unlock(&clocksource_mutex
);
1211 __setup("clocksource=", boot_override_clocksource
);
1214 * boot_override_clock - Compatibility layer for deprecated boot option
1215 * @str: override name
1217 * DEPRECATED! Takes a clock= boot argument and uses it
1218 * as the clocksource override name
1220 static int __init
boot_override_clock(char* str
)
1222 if (!strcmp(str
, "pmtmr")) {
1223 pr_warn("clock=pmtmr is deprecated - use clocksource=acpi_pm\n");
1224 return boot_override_clocksource("acpi_pm");
1226 pr_warn("clock= boot option is deprecated - use clocksource=xyz\n");
1227 return boot_override_clocksource(str
);
1230 __setup("clock=", boot_override_clock
);