2 * cpuidle.c - core cpuidle infrastructure
4 * (C) 2006-2007 Venkatesh Pallipadi <venkatesh.pallipadi@intel.com>
5 * Shaohua Li <shaohua.li@intel.com>
6 * Adam Belay <abelay@novell.com>
8 * This code is licenced under the GPL.
11 #include <linux/clockchips.h>
12 #include <linux/kernel.h>
13 #include <linux/mutex.h>
14 #include <linux/sched.h>
15 #include <linux/sched/clock.h>
16 #include <linux/notifier.h>
17 #include <linux/pm_qos.h>
18 #include <linux/cpu.h>
19 #include <linux/cpuidle.h>
20 #include <linux/ktime.h>
21 #include <linux/hrtimer.h>
22 #include <linux/module.h>
23 #include <linux/suspend.h>
24 #include <linux/tick.h>
25 #include <trace/events/power.h>
29 DEFINE_PER_CPU(struct cpuidle_device
*, cpuidle_devices
);
30 DEFINE_PER_CPU(struct cpuidle_device
, cpuidle_dev
);
32 DEFINE_MUTEX(cpuidle_lock
);
33 LIST_HEAD(cpuidle_detected_devices
);
35 static int enabled_devices
;
36 static int off __read_mostly
;
37 static int initialized __read_mostly
;
39 int cpuidle_disabled(void)
43 void disable_cpuidle(void)
48 bool cpuidle_not_available(struct cpuidle_driver
*drv
,
49 struct cpuidle_device
*dev
)
51 return off
|| !initialized
|| !drv
|| !dev
|| !dev
->enabled
;
55 * cpuidle_play_dead - cpu off-lining
57 * Returns in case of an error or no driver
59 int cpuidle_play_dead(void)
61 struct cpuidle_device
*dev
= __this_cpu_read(cpuidle_devices
);
62 struct cpuidle_driver
*drv
= cpuidle_get_cpu_driver(dev
);
68 /* Find lowest-power state that supports long-term idle */
69 for (i
= drv
->state_count
- 1; i
>= 0; i
--)
70 if (drv
->states
[i
].enter_dead
)
71 return drv
->states
[i
].enter_dead(dev
, i
);
76 static int find_deepest_state(struct cpuidle_driver
*drv
,
77 struct cpuidle_device
*dev
,
78 unsigned int max_latency
,
79 unsigned int forbidden_flags
,
82 unsigned int latency_req
= 0;
85 for (i
= 1; i
< drv
->state_count
; i
++) {
86 struct cpuidle_state
*s
= &drv
->states
[i
];
87 struct cpuidle_state_usage
*su
= &dev
->states_usage
[i
];
89 if (s
->disabled
|| su
->disable
|| s
->exit_latency
<= latency_req
90 || s
->exit_latency
> max_latency
91 || (s
->flags
& forbidden_flags
)
92 || (freeze
&& !s
->enter_freeze
))
95 latency_req
= s
->exit_latency
;
102 * cpuidle_use_deepest_state - Set/clear governor override flag.
103 * @enable: New value of the flag.
105 * Set/unset the current CPU to use the deepest idle state (override governors
106 * going forward if set).
108 void cpuidle_use_deepest_state(bool enable
)
110 struct cpuidle_device
*dev
;
113 dev
= cpuidle_get_device();
114 dev
->use_deepest_state
= enable
;
119 * cpuidle_find_deepest_state - Find the deepest available idle state.
120 * @drv: cpuidle driver for the given CPU.
121 * @dev: cpuidle device for the given CPU.
123 int cpuidle_find_deepest_state(struct cpuidle_driver
*drv
,
124 struct cpuidle_device
*dev
)
126 return find_deepest_state(drv
, dev
, UINT_MAX
, 0, false);
129 #ifdef CONFIG_SUSPEND
130 static void enter_freeze_proper(struct cpuidle_driver
*drv
,
131 struct cpuidle_device
*dev
, int index
)
134 * trace_suspend_resume() called by tick_freeze() for the last CPU
135 * executing it contains RCU usage regarded as invalid in the idle
136 * context, so tell RCU about that.
138 RCU_NONIDLE(tick_freeze());
140 * The state used here cannot be a "coupled" one, because the "coupled"
141 * cpuidle mechanism enables interrupts and doing that with timekeeping
142 * suspended is generally unsafe.
144 stop_critical_timings();
145 drv
->states
[index
].enter_freeze(dev
, drv
, index
);
146 WARN_ON(!irqs_disabled());
148 * timekeeping_resume() that will be called by tick_unfreeze() for the
149 * first CPU executing it calls functions containing RCU read-side
150 * critical sections, so tell RCU about that.
152 RCU_NONIDLE(tick_unfreeze());
153 start_critical_timings();
157 * cpuidle_enter_freeze - Enter an idle state suitable for suspend-to-idle.
158 * @drv: cpuidle driver for the given CPU.
159 * @dev: cpuidle device for the given CPU.
161 * If there are states with the ->enter_freeze callback, find the deepest of
162 * them and enter it with frozen tick.
164 int cpuidle_enter_freeze(struct cpuidle_driver
*drv
, struct cpuidle_device
*dev
)
169 * Find the deepest state with ->enter_freeze present, which guarantees
170 * that interrupts won't be enabled when it exits and allows the tick to
173 index
= find_deepest_state(drv
, dev
, UINT_MAX
, 0, true);
175 enter_freeze_proper(drv
, dev
, index
);
179 #endif /* CONFIG_SUSPEND */
182 * cpuidle_enter_state - enter the state and update stats
183 * @dev: cpuidle device for this cpu
184 * @drv: cpuidle driver for this cpu
185 * @index: index into the states table in @drv of the state to enter
187 int cpuidle_enter_state(struct cpuidle_device
*dev
, struct cpuidle_driver
*drv
,
192 struct cpuidle_state
*target_state
= &drv
->states
[index
];
193 bool broadcast
= !!(target_state
->flags
& CPUIDLE_FLAG_TIMER_STOP
);
194 ktime_t time_start
, time_end
;
198 * Tell the time framework to switch to a broadcast timer because our
199 * local timer will be shut down. If a local timer is used from another
200 * CPU as a broadcast timer, this call may fail if it is not available.
202 if (broadcast
&& tick_broadcast_enter()) {
203 index
= find_deepest_state(drv
, dev
, target_state
->exit_latency
,
204 CPUIDLE_FLAG_TIMER_STOP
, false);
209 target_state
= &drv
->states
[index
];
212 /* Take note of the planned idle state. */
213 sched_idle_set_state(target_state
);
215 trace_cpu_idle_rcuidle(index
, dev
->cpu
);
216 time_start
= ns_to_ktime(local_clock());
218 stop_critical_timings();
219 entered_state
= target_state
->enter(dev
, drv
, index
);
220 start_critical_timings();
222 time_end
= ns_to_ktime(local_clock());
223 trace_cpu_idle_rcuidle(PWR_EVENT_EXIT
, dev
->cpu
);
225 /* The cpu is no longer idle or about to enter idle. */
226 sched_idle_set_state(NULL
);
229 if (WARN_ON_ONCE(!irqs_disabled()))
232 tick_broadcast_exit();
235 if (!cpuidle_state_is_coupled(drv
, index
))
238 diff
= ktime_us_delta(time_end
, time_start
);
242 dev
->last_residency
= (int) diff
;
244 if (entered_state
>= 0) {
245 /* Update cpuidle counters */
246 /* This can be moved to within driver enter routine
247 * but that results in multiple copies of same code.
249 dev
->states_usage
[entered_state
].time
+= dev
->last_residency
;
250 dev
->states_usage
[entered_state
].usage
++;
252 dev
->last_residency
= 0;
255 return entered_state
;
259 * cpuidle_select - ask the cpuidle framework to choose an idle state
261 * @drv: the cpuidle driver
262 * @dev: the cpuidle device
264 * Returns the index of the idle state. The return value must not be negative.
266 int cpuidle_select(struct cpuidle_driver
*drv
, struct cpuidle_device
*dev
)
268 return cpuidle_curr_governor
->select(drv
, dev
);
272 * cpuidle_enter - enter into the specified idle state
274 * @drv: the cpuidle driver tied with the cpu
275 * @dev: the cpuidle device
276 * @index: the index in the idle state table
278 * Returns the index in the idle state, < 0 in case of error.
279 * The error code depends on the backend driver
281 int cpuidle_enter(struct cpuidle_driver
*drv
, struct cpuidle_device
*dev
,
284 if (cpuidle_state_is_coupled(drv
, index
))
285 return cpuidle_enter_state_coupled(dev
, drv
, index
);
286 return cpuidle_enter_state(dev
, drv
, index
);
290 * cpuidle_reflect - tell the underlying governor what was the state
293 * @dev : the cpuidle device
294 * @index: the index in the idle state table
297 void cpuidle_reflect(struct cpuidle_device
*dev
, int index
)
299 if (cpuidle_curr_governor
->reflect
&& index
>= 0)
300 cpuidle_curr_governor
->reflect(dev
, index
);
304 * cpuidle_install_idle_handler - installs the cpuidle idle loop handler
306 void cpuidle_install_idle_handler(void)
308 if (enabled_devices
) {
309 /* Make sure all changes finished before we switch to new idle */
316 * cpuidle_uninstall_idle_handler - uninstalls the cpuidle idle loop handler
318 void cpuidle_uninstall_idle_handler(void)
320 if (enabled_devices
) {
322 wake_up_all_idle_cpus();
326 * Make sure external observers (such as the scheduler)
327 * are done looking at pointed idle states.
333 * cpuidle_pause_and_lock - temporarily disables CPUIDLE
335 void cpuidle_pause_and_lock(void)
337 mutex_lock(&cpuidle_lock
);
338 cpuidle_uninstall_idle_handler();
341 EXPORT_SYMBOL_GPL(cpuidle_pause_and_lock
);
344 * cpuidle_resume_and_unlock - resumes CPUIDLE operation
346 void cpuidle_resume_and_unlock(void)
348 cpuidle_install_idle_handler();
349 mutex_unlock(&cpuidle_lock
);
352 EXPORT_SYMBOL_GPL(cpuidle_resume_and_unlock
);
354 /* Currently used in suspend/resume path to suspend cpuidle */
355 void cpuidle_pause(void)
357 mutex_lock(&cpuidle_lock
);
358 cpuidle_uninstall_idle_handler();
359 mutex_unlock(&cpuidle_lock
);
362 /* Currently used in suspend/resume path to resume cpuidle */
363 void cpuidle_resume(void)
365 mutex_lock(&cpuidle_lock
);
366 cpuidle_install_idle_handler();
367 mutex_unlock(&cpuidle_lock
);
371 * cpuidle_enable_device - enables idle PM for a CPU
374 * This function must be called between cpuidle_pause_and_lock and
375 * cpuidle_resume_and_unlock when used externally.
377 int cpuidle_enable_device(struct cpuidle_device
*dev
)
380 struct cpuidle_driver
*drv
;
388 drv
= cpuidle_get_cpu_driver(dev
);
390 if (!drv
|| !cpuidle_curr_governor
)
393 if (!dev
->registered
)
396 ret
= cpuidle_add_device_sysfs(dev
);
400 if (cpuidle_curr_governor
->enable
&&
401 (ret
= cpuidle_curr_governor
->enable(drv
, dev
)))
412 cpuidle_remove_device_sysfs(dev
);
417 EXPORT_SYMBOL_GPL(cpuidle_enable_device
);
420 * cpuidle_disable_device - disables idle PM for a CPU
423 * This function must be called between cpuidle_pause_and_lock and
424 * cpuidle_resume_and_unlock when used externally.
426 void cpuidle_disable_device(struct cpuidle_device
*dev
)
428 struct cpuidle_driver
*drv
= cpuidle_get_cpu_driver(dev
);
430 if (!dev
|| !dev
->enabled
)
433 if (!drv
|| !cpuidle_curr_governor
)
438 if (cpuidle_curr_governor
->disable
)
439 cpuidle_curr_governor
->disable(drv
, dev
);
441 cpuidle_remove_device_sysfs(dev
);
445 EXPORT_SYMBOL_GPL(cpuidle_disable_device
);
447 static void __cpuidle_unregister_device(struct cpuidle_device
*dev
)
449 struct cpuidle_driver
*drv
= cpuidle_get_cpu_driver(dev
);
451 list_del(&dev
->device_list
);
452 per_cpu(cpuidle_devices
, dev
->cpu
) = NULL
;
453 module_put(drv
->owner
);
458 static void __cpuidle_device_init(struct cpuidle_device
*dev
)
460 memset(dev
->states_usage
, 0, sizeof(dev
->states_usage
));
461 dev
->last_residency
= 0;
465 * __cpuidle_register_device - internal register function called before register
466 * and enable routines
469 * cpuidle_lock mutex must be held before this is called
471 static int __cpuidle_register_device(struct cpuidle_device
*dev
)
474 struct cpuidle_driver
*drv
= cpuidle_get_cpu_driver(dev
);
476 if (!try_module_get(drv
->owner
))
479 per_cpu(cpuidle_devices
, dev
->cpu
) = dev
;
480 list_add(&dev
->device_list
, &cpuidle_detected_devices
);
482 ret
= cpuidle_coupled_register_device(dev
);
484 __cpuidle_unregister_device(dev
);
492 * cpuidle_register_device - registers a CPU's idle PM feature
495 int cpuidle_register_device(struct cpuidle_device
*dev
)
502 mutex_lock(&cpuidle_lock
);
507 __cpuidle_device_init(dev
);
509 ret
= __cpuidle_register_device(dev
);
513 ret
= cpuidle_add_sysfs(dev
);
517 ret
= cpuidle_enable_device(dev
);
521 cpuidle_install_idle_handler();
524 mutex_unlock(&cpuidle_lock
);
529 cpuidle_remove_sysfs(dev
);
531 __cpuidle_unregister_device(dev
);
535 EXPORT_SYMBOL_GPL(cpuidle_register_device
);
538 * cpuidle_unregister_device - unregisters a CPU's idle PM feature
541 void cpuidle_unregister_device(struct cpuidle_device
*dev
)
543 if (!dev
|| dev
->registered
== 0)
546 cpuidle_pause_and_lock();
548 cpuidle_disable_device(dev
);
550 cpuidle_remove_sysfs(dev
);
552 __cpuidle_unregister_device(dev
);
554 cpuidle_coupled_unregister_device(dev
);
556 cpuidle_resume_and_unlock();
559 EXPORT_SYMBOL_GPL(cpuidle_unregister_device
);
562 * cpuidle_unregister: unregister a driver and the devices. This function
563 * can be used only if the driver has been previously registered through
564 * the cpuidle_register function.
566 * @drv: a valid pointer to a struct cpuidle_driver
568 void cpuidle_unregister(struct cpuidle_driver
*drv
)
571 struct cpuidle_device
*device
;
573 for_each_cpu(cpu
, drv
->cpumask
) {
574 device
= &per_cpu(cpuidle_dev
, cpu
);
575 cpuidle_unregister_device(device
);
578 cpuidle_unregister_driver(drv
);
580 EXPORT_SYMBOL_GPL(cpuidle_unregister
);
583 * cpuidle_register: registers the driver and the cpu devices with the
584 * coupled_cpus passed as parameter. This function is used for all common
585 * initialization pattern there are in the arch specific drivers. The
586 * devices is globally defined in this file.
588 * @drv : a valid pointer to a struct cpuidle_driver
589 * @coupled_cpus: a cpumask for the coupled states
591 * Returns 0 on success, < 0 otherwise
593 int cpuidle_register(struct cpuidle_driver
*drv
,
594 const struct cpumask
*const coupled_cpus
)
597 struct cpuidle_device
*device
;
599 ret
= cpuidle_register_driver(drv
);
601 pr_err("failed to register cpuidle driver\n");
605 for_each_cpu(cpu
, drv
->cpumask
) {
606 device
= &per_cpu(cpuidle_dev
, cpu
);
609 #ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
611 * On multiplatform for ARM, the coupled idle states could be
612 * enabled in the kernel even if the cpuidle driver does not
613 * use it. Note, coupled_cpus is a struct copy.
616 device
->coupled_cpus
= *coupled_cpus
;
618 ret
= cpuidle_register_device(device
);
622 pr_err("Failed to register cpuidle device for cpu%d\n", cpu
);
624 cpuidle_unregister(drv
);
630 EXPORT_SYMBOL_GPL(cpuidle_register
);
635 * This function gets called when a part of the kernel has a new latency
636 * requirement. This means we need to get all processors out of their C-state,
637 * and then recalculate a new suitable C-state. Just do a cross-cpu IPI; that
638 * wakes them all right up.
640 static int cpuidle_latency_notify(struct notifier_block
*b
,
641 unsigned long l
, void *v
)
643 wake_up_all_idle_cpus();
647 static struct notifier_block cpuidle_latency_notifier
= {
648 .notifier_call
= cpuidle_latency_notify
,
651 static inline void latency_notifier_init(struct notifier_block
*n
)
653 pm_qos_add_notifier(PM_QOS_CPU_DMA_LATENCY
, n
);
656 #else /* CONFIG_SMP */
658 #define latency_notifier_init(x) do { } while (0)
660 #endif /* CONFIG_SMP */
663 * cpuidle_init - core initializer
665 static int __init
cpuidle_init(void)
669 if (cpuidle_disabled())
672 ret
= cpuidle_add_interface(cpu_subsys
.dev_root
);
676 latency_notifier_init(&cpuidle_latency_notifier
);
681 module_param(off
, int, 0444);
682 core_initcall(cpuidle_init
);