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/notifier.h>
16 #include <linux/pm_qos.h>
17 #include <linux/cpu.h>
18 #include <linux/cpuidle.h>
19 #include <linux/ktime.h>
20 #include <linux/hrtimer.h>
21 #include <linux/module.h>
22 #include <trace/events/power.h>
26 DEFINE_PER_CPU(struct cpuidle_device *, cpuidle_devices);
27 DEFINE_PER_CPU(struct cpuidle_device, cpuidle_dev);
29 DEFINE_MUTEX(cpuidle_lock);
30 LIST_HEAD(cpuidle_detected_devices);
32 static int enabled_devices;
33 static int off __read_mostly;
34 static int initialized __read_mostly;
36 int cpuidle_disabled(void)
40 void disable_cpuidle(void)
46 * cpuidle_play_dead - cpu off-lining
48 * Returns in case of an error or no driver
50 int cpuidle_play_dead(void)
52 struct cpuidle_device *dev = __this_cpu_read(cpuidle_devices);
53 struct cpuidle_driver *drv = cpuidle_get_cpu_driver(dev);
59 /* Find lowest-power state that supports long-term idle */
60 for (i = drv->state_count - 1; i >= CPUIDLE_DRIVER_STATE_START; i--)
61 if (drv->states[i].enter_dead)
62 return drv->states[i].enter_dead(dev, i);
68 * cpuidle_enter_state - enter the state and update stats
69 * @dev: cpuidle device for this cpu
70 * @drv: cpuidle driver for this cpu
71 * @next_state: index into drv->states of the state to enter
73 int cpuidle_enter_state(struct cpuidle_device *dev, struct cpuidle_driver *drv,
78 struct cpuidle_state *target_state = &drv->states[index];
79 ktime_t time_start, time_end;
82 time_start = ktime_get();
84 entered_state = target_state->enter(dev, drv, index);
86 time_end = ktime_get();
90 diff = ktime_to_us(ktime_sub(time_end, time_start));
94 dev->last_residency = (int) diff;
96 if (entered_state >= 0) {
97 /* Update cpuidle counters */
98 /* This can be moved to within driver enter routine
99 * but that results in multiple copies of same code.
101 dev->states_usage[entered_state].time += dev->last_residency;
102 dev->states_usage[entered_state].usage++;
104 dev->last_residency = 0;
107 return entered_state;
111 * cpuidle_idle_call - the main idle loop
113 * NOTE: no locks or semaphores should be used here
114 * return non-zero on failure
116 int cpuidle_idle_call(void)
118 struct cpuidle_device *dev = __this_cpu_read(cpuidle_devices);
119 struct cpuidle_driver *drv;
120 int next_state, entered_state;
128 /* check if the device is ready */
129 if (!dev || !dev->enabled)
132 drv = cpuidle_get_cpu_driver(dev);
134 /* ask the governor for the next state */
135 next_state = cpuidle_curr_governor->select(drv, dev);
136 if (need_resched()) {
137 dev->last_residency = 0;
138 /* give the governor an opportunity to reflect on the outcome */
139 if (cpuidle_curr_governor->reflect)
140 cpuidle_curr_governor->reflect(dev, next_state);
145 trace_cpu_idle_rcuidle(next_state, dev->cpu);
147 if (drv->states[next_state].flags & CPUIDLE_FLAG_TIMER_STOP)
148 clockevents_notify(CLOCK_EVT_NOTIFY_BROADCAST_ENTER,
151 if (cpuidle_state_is_coupled(dev, drv, next_state))
152 entered_state = cpuidle_enter_state_coupled(dev, drv,
155 entered_state = cpuidle_enter_state(dev, drv, next_state);
157 if (drv->states[next_state].flags & CPUIDLE_FLAG_TIMER_STOP)
158 clockevents_notify(CLOCK_EVT_NOTIFY_BROADCAST_EXIT,
161 trace_cpu_idle_rcuidle(PWR_EVENT_EXIT, dev->cpu);
163 /* give the governor an opportunity to reflect on the outcome */
164 if (cpuidle_curr_governor->reflect)
165 cpuidle_curr_governor->reflect(dev, entered_state);
171 * cpuidle_install_idle_handler - installs the cpuidle idle loop handler
173 void cpuidle_install_idle_handler(void)
175 if (enabled_devices) {
176 /* Make sure all changes finished before we switch to new idle */
183 * cpuidle_uninstall_idle_handler - uninstalls the cpuidle idle loop handler
185 void cpuidle_uninstall_idle_handler(void)
187 if (enabled_devices) {
189 kick_all_cpus_sync();
194 * cpuidle_pause_and_lock - temporarily disables CPUIDLE
196 void cpuidle_pause_and_lock(void)
198 mutex_lock(&cpuidle_lock);
199 cpuidle_uninstall_idle_handler();
202 EXPORT_SYMBOL_GPL(cpuidle_pause_and_lock);
205 * cpuidle_resume_and_unlock - resumes CPUIDLE operation
207 void cpuidle_resume_and_unlock(void)
209 cpuidle_install_idle_handler();
210 mutex_unlock(&cpuidle_lock);
213 EXPORT_SYMBOL_GPL(cpuidle_resume_and_unlock);
215 /* Currently used in suspend/resume path to suspend cpuidle */
216 void cpuidle_pause(void)
218 mutex_lock(&cpuidle_lock);
219 cpuidle_uninstall_idle_handler();
220 mutex_unlock(&cpuidle_lock);
223 /* Currently used in suspend/resume path to resume cpuidle */
224 void cpuidle_resume(void)
226 mutex_lock(&cpuidle_lock);
227 cpuidle_install_idle_handler();
228 mutex_unlock(&cpuidle_lock);
231 #ifdef CONFIG_ARCH_HAS_CPU_RELAX
232 static int poll_idle(struct cpuidle_device *dev,
233 struct cpuidle_driver *drv, int index)
240 while (!need_resched())
244 diff = ktime_to_us(ktime_sub(t2, t1));
248 dev->last_residency = (int) diff;
253 static void poll_idle_init(struct cpuidle_driver *drv)
255 struct cpuidle_state *state = &drv->states[0];
257 snprintf(state->name, CPUIDLE_NAME_LEN, "POLL");
258 snprintf(state->desc, CPUIDLE_DESC_LEN, "CPUIDLE CORE POLL IDLE");
259 state->exit_latency = 0;
260 state->target_residency = 0;
261 state->power_usage = -1;
263 state->enter = poll_idle;
264 state->disabled = false;
267 static void poll_idle_init(struct cpuidle_driver *drv) {}
268 #endif /* CONFIG_ARCH_HAS_CPU_RELAX */
271 * cpuidle_enable_device - enables idle PM for a CPU
274 * This function must be called between cpuidle_pause_and_lock and
275 * cpuidle_resume_and_unlock when used externally.
277 int cpuidle_enable_device(struct cpuidle_device *dev)
280 struct cpuidle_driver *drv;
288 drv = cpuidle_get_cpu_driver(dev);
290 if (!drv || !cpuidle_curr_governor)
293 if (!dev->registered)
296 if (!dev->state_count)
297 dev->state_count = drv->state_count;
301 ret = cpuidle_add_device_sysfs(dev);
305 if (cpuidle_curr_governor->enable &&
306 (ret = cpuidle_curr_governor->enable(drv, dev)))
309 for (i = 0; i < dev->state_count; i++) {
310 dev->states_usage[i].usage = 0;
311 dev->states_usage[i].time = 0;
313 dev->last_residency = 0;
323 cpuidle_remove_device_sysfs(dev);
328 EXPORT_SYMBOL_GPL(cpuidle_enable_device);
331 * cpuidle_disable_device - disables idle PM for a CPU
334 * This function must be called between cpuidle_pause_and_lock and
335 * cpuidle_resume_and_unlock when used externally.
337 void cpuidle_disable_device(struct cpuidle_device *dev)
339 struct cpuidle_driver *drv = cpuidle_get_cpu_driver(dev);
341 if (!dev || !dev->enabled)
344 if (!drv || !cpuidle_curr_governor)
349 if (cpuidle_curr_governor->disable)
350 cpuidle_curr_governor->disable(drv, dev);
352 cpuidle_remove_device_sysfs(dev);
356 EXPORT_SYMBOL_GPL(cpuidle_disable_device);
358 static void __cpuidle_unregister_device(struct cpuidle_device *dev)
360 struct cpuidle_driver *drv = cpuidle_get_cpu_driver(dev);
362 list_del(&dev->device_list);
363 per_cpu(cpuidle_devices, dev->cpu) = NULL;
364 module_put(drv->owner);
368 * __cpuidle_register_device - internal register function called before register
369 * and enable routines
372 * cpuidle_lock mutex must be held before this is called
374 static int __cpuidle_register_device(struct cpuidle_device *dev)
377 struct cpuidle_driver *drv = cpuidle_get_cpu_driver(dev);
379 if (!try_module_get(drv->owner))
382 per_cpu(cpuidle_devices, dev->cpu) = dev;
383 list_add(&dev->device_list, &cpuidle_detected_devices);
385 ret = cpuidle_coupled_register_device(dev);
387 __cpuidle_unregister_device(dev);
396 * cpuidle_register_device - registers a CPU's idle PM feature
399 int cpuidle_register_device(struct cpuidle_device *dev)
406 mutex_lock(&cpuidle_lock);
408 ret = __cpuidle_register_device(dev);
412 ret = cpuidle_add_sysfs(dev);
416 ret = cpuidle_enable_device(dev);
420 cpuidle_install_idle_handler();
423 mutex_unlock(&cpuidle_lock);
428 cpuidle_remove_sysfs(dev);
430 __cpuidle_unregister_device(dev);
434 EXPORT_SYMBOL_GPL(cpuidle_register_device);
437 * cpuidle_unregister_device - unregisters a CPU's idle PM feature
440 void cpuidle_unregister_device(struct cpuidle_device *dev)
442 if (dev->registered == 0)
445 cpuidle_pause_and_lock();
447 cpuidle_disable_device(dev);
449 cpuidle_remove_sysfs(dev);
451 __cpuidle_unregister_device(dev);
453 cpuidle_coupled_unregister_device(dev);
455 cpuidle_resume_and_unlock();
458 EXPORT_SYMBOL_GPL(cpuidle_unregister_device);
461 * cpuidle_unregister: unregister a driver and the devices. This function
462 * can be used only if the driver has been previously registered through
463 * the cpuidle_register function.
465 * @drv: a valid pointer to a struct cpuidle_driver
467 void cpuidle_unregister(struct cpuidle_driver *drv)
470 struct cpuidle_device *device;
472 for_each_cpu(cpu, drv->cpumask) {
473 device = &per_cpu(cpuidle_dev, cpu);
474 cpuidle_unregister_device(device);
477 cpuidle_unregister_driver(drv);
479 EXPORT_SYMBOL_GPL(cpuidle_unregister);
482 * cpuidle_register: registers the driver and the cpu devices with the
483 * coupled_cpus passed as parameter. This function is used for all common
484 * initialization pattern there are in the arch specific drivers. The
485 * devices is globally defined in this file.
487 * @drv : a valid pointer to a struct cpuidle_driver
488 * @coupled_cpus: a cpumask for the coupled states
490 * Returns 0 on success, < 0 otherwise
492 int cpuidle_register(struct cpuidle_driver *drv,
493 const struct cpumask *const coupled_cpus)
496 struct cpuidle_device *device;
498 ret = cpuidle_register_driver(drv);
500 pr_err("failed to register cpuidle driver\n");
504 for_each_cpu(cpu, drv->cpumask) {
505 device = &per_cpu(cpuidle_dev, cpu);
508 #ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
510 * On multiplatform for ARM, the coupled idle states could
511 * enabled in the kernel even if the cpuidle driver does not
512 * use it. Note, coupled_cpus is a struct copy.
515 device->coupled_cpus = *coupled_cpus;
517 ret = cpuidle_register_device(device);
521 pr_err("Failed to register cpuidle device for cpu%d\n", cpu);
523 cpuidle_unregister(drv);
529 EXPORT_SYMBOL_GPL(cpuidle_register);
533 static void smp_callback(void *v)
535 /* we already woke the CPU up, nothing more to do */
539 * This function gets called when a part of the kernel has a new latency
540 * requirement. This means we need to get all processors out of their C-state,
541 * and then recalculate a new suitable C-state. Just do a cross-cpu IPI; that
542 * wakes them all right up.
544 static int cpuidle_latency_notify(struct notifier_block *b,
545 unsigned long l, void *v)
547 smp_call_function(smp_callback, NULL, 1);
551 static struct notifier_block cpuidle_latency_notifier = {
552 .notifier_call = cpuidle_latency_notify,
555 static inline void latency_notifier_init(struct notifier_block *n)
557 pm_qos_add_notifier(PM_QOS_CPU_DMA_LATENCY, n);
560 #else /* CONFIG_SMP */
562 #define latency_notifier_init(x) do { } while (0)
564 #endif /* CONFIG_SMP */
567 * cpuidle_init - core initializer
569 static int __init cpuidle_init(void)
573 if (cpuidle_disabled())
576 ret = cpuidle_add_interface(cpu_subsys.dev_root);
580 latency_notifier_init(&cpuidle_latency_notifier);
585 module_param(off, int, 0444);
586 core_initcall(cpuidle_init);