cpuidle: prepare the cpuidle core to handle multiple drivers
[deliverable/linux.git] / drivers / cpuidle / cpuidle.c
CommitLineData
4f86d3a8
LB
1/*
2 * cpuidle.c - core cpuidle infrastructure
3 *
4 * (C) 2006-2007 Venkatesh Pallipadi <venkatesh.pallipadi@intel.com>
5 * Shaohua Li <shaohua.li@intel.com>
6 * Adam Belay <abelay@novell.com>
7 *
8 * This code is licenced under the GPL.
9 */
10
11#include <linux/kernel.h>
12#include <linux/mutex.h>
13#include <linux/sched.h>
14#include <linux/notifier.h>
e8db0be1 15#include <linux/pm_qos.h>
4f86d3a8
LB
16#include <linux/cpu.h>
17#include <linux/cpuidle.h>
9a0b8415 18#include <linux/ktime.h>
2e94d1f7 19#include <linux/hrtimer.h>
884b17e1 20#include <linux/module.h>
288f023e 21#include <trace/events/power.h>
4f86d3a8
LB
22
23#include "cpuidle.h"
24
25DEFINE_PER_CPU(struct cpuidle_device *, cpuidle_devices);
4f86d3a8
LB
26
27DEFINE_MUTEX(cpuidle_lock);
28LIST_HEAD(cpuidle_detected_devices);
4f86d3a8
LB
29
30static int enabled_devices;
62027aea 31static int off __read_mostly;
a0bfa137 32static int initialized __read_mostly;
62027aea
LB
33
34int cpuidle_disabled(void)
35{
36 return off;
37}
d91ee586
LB
38void disable_cpuidle(void)
39{
40 off = 1;
41}
4f86d3a8 42
dcb84f33
VP
43static int __cpuidle_register_device(struct cpuidle_device *dev);
44
e1689795
RL
45static inline int cpuidle_enter(struct cpuidle_device *dev,
46 struct cpuidle_driver *drv, int index)
47{
48 struct cpuidle_state *target_state = &drv->states[index];
49 return target_state->enter(dev, drv, index);
50}
51
52static inline int cpuidle_enter_tk(struct cpuidle_device *dev,
53 struct cpuidle_driver *drv, int index)
54{
55 return cpuidle_wrap_enter(dev, drv, index, cpuidle_enter);
56}
57
58typedef int (*cpuidle_enter_t)(struct cpuidle_device *dev,
59 struct cpuidle_driver *drv, int index);
60
61static cpuidle_enter_t cpuidle_enter_ops;
62
1a022e3f
BO
63/**
64 * cpuidle_play_dead - cpu off-lining
65 *
ee01e663 66 * Returns in case of an error or no driver
1a022e3f
BO
67 */
68int cpuidle_play_dead(void)
69{
70 struct cpuidle_device *dev = __this_cpu_read(cpuidle_devices);
71 struct cpuidle_driver *drv = cpuidle_get_driver();
72 int i, dead_state = -1;
73 int power_usage = -1;
74
ee01e663
TK
75 if (!drv)
76 return -ENODEV;
77
1a022e3f
BO
78 /* Find lowest-power state that supports long-term idle */
79 for (i = CPUIDLE_DRIVER_STATE_START; i < drv->state_count; i++) {
80 struct cpuidle_state *s = &drv->states[i];
81
82 if (s->power_usage < power_usage && s->enter_dead) {
83 power_usage = s->power_usage;
84 dead_state = i;
85 }
86 }
87
88 if (dead_state != -1)
89 return drv->states[dead_state].enter_dead(dev, dead_state);
90
91 return -ENODEV;
92}
93
56cfbf74
CC
94/**
95 * cpuidle_enter_state - enter the state and update stats
96 * @dev: cpuidle device for this cpu
97 * @drv: cpuidle driver for this cpu
98 * @next_state: index into drv->states of the state to enter
99 */
100int cpuidle_enter_state(struct cpuidle_device *dev, struct cpuidle_driver *drv,
101 int next_state)
102{
103 int entered_state;
104
105 entered_state = cpuidle_enter_ops(dev, drv, next_state);
106
107 if (entered_state >= 0) {
108 /* Update cpuidle counters */
109 /* This can be moved to within driver enter routine
110 * but that results in multiple copies of same code.
111 */
112 dev->states_usage[entered_state].time +=
113 (unsigned long long)dev->last_residency;
114 dev->states_usage[entered_state].usage++;
115 } else {
116 dev->last_residency = 0;
117 }
118
119 return entered_state;
120}
121
4f86d3a8
LB
122/**
123 * cpuidle_idle_call - the main idle loop
124 *
125 * NOTE: no locks or semaphores should be used here
a0bfa137 126 * return non-zero on failure
4f86d3a8 127 */
a0bfa137 128int cpuidle_idle_call(void)
4f86d3a8 129{
4a6f4fe8 130 struct cpuidle_device *dev = __this_cpu_read(cpuidle_devices);
46bcfad7 131 struct cpuidle_driver *drv = cpuidle_get_driver();
e978aa7d 132 int next_state, entered_state;
4f86d3a8 133
a0bfa137
LB
134 if (off)
135 return -ENODEV;
136
137 if (!initialized)
138 return -ENODEV;
139
4f86d3a8 140 /* check if the device is ready */
a0bfa137
LB
141 if (!dev || !dev->enabled)
142 return -EBUSY;
4f86d3a8
LB
143
144 /* ask the governor for the next state */
46bcfad7 145 next_state = cpuidle_curr_governor->select(drv, dev);
246eb7f0 146 if (need_resched()) {
d73d68dc
YS
147 dev->last_residency = 0;
148 /* give the governor an opportunity to reflect on the outcome */
149 if (cpuidle_curr_governor->reflect)
150 cpuidle_curr_governor->reflect(dev, next_state);
246eb7f0 151 local_irq_enable();
a0bfa137 152 return 0;
246eb7f0
KH
153 }
154
76027ea8
SR
155 trace_power_start_rcuidle(POWER_CSTATE, next_state, dev->cpu);
156 trace_cpu_idle_rcuidle(next_state, dev->cpu);
f77cfe4e 157
4126c019
CC
158 if (cpuidle_state_is_coupled(dev, drv, next_state))
159 entered_state = cpuidle_enter_state_coupled(dev, drv,
160 next_state);
161 else
162 entered_state = cpuidle_enter_state(dev, drv, next_state);
f77cfe4e 163
76027ea8
SR
164 trace_power_end_rcuidle(dev->cpu);
165 trace_cpu_idle_rcuidle(PWR_EVENT_EXIT, dev->cpu);
f77cfe4e 166
4f86d3a8
LB
167 /* give the governor an opportunity to reflect on the outcome */
168 if (cpuidle_curr_governor->reflect)
e978aa7d 169 cpuidle_curr_governor->reflect(dev, entered_state);
a0bfa137
LB
170
171 return 0;
4f86d3a8
LB
172}
173
174/**
175 * cpuidle_install_idle_handler - installs the cpuidle idle loop handler
176 */
177void cpuidle_install_idle_handler(void)
178{
a0bfa137 179 if (enabled_devices) {
4f86d3a8
LB
180 /* Make sure all changes finished before we switch to new idle */
181 smp_wmb();
a0bfa137 182 initialized = 1;
4f86d3a8
LB
183 }
184}
185
186/**
187 * cpuidle_uninstall_idle_handler - uninstalls the cpuidle idle loop handler
188 */
189void cpuidle_uninstall_idle_handler(void)
190{
a0bfa137
LB
191 if (enabled_devices) {
192 initialized = 0;
4a162513 193 kick_all_cpus_sync();
4f86d3a8
LB
194 }
195}
196
197/**
198 * cpuidle_pause_and_lock - temporarily disables CPUIDLE
199 */
200void cpuidle_pause_and_lock(void)
201{
202 mutex_lock(&cpuidle_lock);
203 cpuidle_uninstall_idle_handler();
204}
205
206EXPORT_SYMBOL_GPL(cpuidle_pause_and_lock);
207
208/**
209 * cpuidle_resume_and_unlock - resumes CPUIDLE operation
210 */
211void cpuidle_resume_and_unlock(void)
212{
213 cpuidle_install_idle_handler();
214 mutex_unlock(&cpuidle_lock);
215}
216
217EXPORT_SYMBOL_GPL(cpuidle_resume_and_unlock);
218
8651f97b
PM
219/* Currently used in suspend/resume path to suspend cpuidle */
220void cpuidle_pause(void)
221{
222 mutex_lock(&cpuidle_lock);
223 cpuidle_uninstall_idle_handler();
224 mutex_unlock(&cpuidle_lock);
225}
226
227/* Currently used in suspend/resume path to resume cpuidle */
228void cpuidle_resume(void)
229{
230 mutex_lock(&cpuidle_lock);
231 cpuidle_install_idle_handler();
232 mutex_unlock(&cpuidle_lock);
233}
234
e1689795
RL
235/**
236 * cpuidle_wrap_enter - performs timekeeping and irqen around enter function
237 * @dev: pointer to a valid cpuidle_device object
238 * @drv: pointer to a valid cpuidle_driver object
239 * @index: index of the target cpuidle state.
240 */
241int cpuidle_wrap_enter(struct cpuidle_device *dev,
242 struct cpuidle_driver *drv, int index,
243 int (*enter)(struct cpuidle_device *dev,
244 struct cpuidle_driver *drv, int index))
245{
246 ktime_t time_start, time_end;
247 s64 diff;
248
249 time_start = ktime_get();
250
251 index = enter(dev, drv, index);
252
253 time_end = ktime_get();
254
255 local_irq_enable();
256
257 diff = ktime_to_us(ktime_sub(time_end, time_start));
258 if (diff > INT_MAX)
259 diff = INT_MAX;
260
261 dev->last_residency = (int) diff;
262
263 return index;
264}
265
d8c216cf 266#ifdef CONFIG_ARCH_HAS_CPU_RELAX
46bcfad7
DD
267static int poll_idle(struct cpuidle_device *dev,
268 struct cpuidle_driver *drv, int index)
d8c216cf
RW
269{
270 ktime_t t1, t2;
271 s64 diff;
d8c216cf
RW
272
273 t1 = ktime_get();
274 local_irq_enable();
275 while (!need_resched())
276 cpu_relax();
277
278 t2 = ktime_get();
279 diff = ktime_to_us(ktime_sub(t2, t1));
280 if (diff > INT_MAX)
281 diff = INT_MAX;
282
e978aa7d
DD
283 dev->last_residency = (int) diff;
284
285 return index;
d8c216cf
RW
286}
287
46bcfad7 288static void poll_idle_init(struct cpuidle_driver *drv)
d8c216cf 289{
46bcfad7 290 struct cpuidle_state *state = &drv->states[0];
d8c216cf 291
720f1c30 292 snprintf(state->name, CPUIDLE_NAME_LEN, "POLL");
d8c216cf
RW
293 snprintf(state->desc, CPUIDLE_DESC_LEN, "CPUIDLE CORE POLL IDLE");
294 state->exit_latency = 0;
295 state->target_residency = 0;
296 state->power_usage = -1;
d247632c 297 state->flags = 0;
d8c216cf 298 state->enter = poll_idle;
cbc9ef02 299 state->disabled = false;
d8c216cf
RW
300}
301#else
46bcfad7 302static void poll_idle_init(struct cpuidle_driver *drv) {}
d8c216cf
RW
303#endif /* CONFIG_ARCH_HAS_CPU_RELAX */
304
4f86d3a8
LB
305/**
306 * cpuidle_enable_device - enables idle PM for a CPU
307 * @dev: the CPU
308 *
309 * This function must be called between cpuidle_pause_and_lock and
310 * cpuidle_resume_and_unlock when used externally.
311 */
312int cpuidle_enable_device(struct cpuidle_device *dev)
313{
314 int ret, i;
e1689795 315 struct cpuidle_driver *drv = cpuidle_get_driver();
4f86d3a8 316
1b0a0e9a
SB
317 if (!dev)
318 return -EINVAL;
319
4f86d3a8
LB
320 if (dev->enabled)
321 return 0;
e1689795 322 if (!drv || !cpuidle_curr_governor)
4f86d3a8
LB
323 return -EIO;
324 if (!dev->state_count)
fc850f39 325 dev->state_count = drv->state_count;
4f86d3a8 326
dcb84f33
VP
327 if (dev->registered == 0) {
328 ret = __cpuidle_register_device(dev);
329 if (ret)
330 return ret;
331 }
332
e1689795
RL
333 cpuidle_enter_ops = drv->en_core_tk_irqen ?
334 cpuidle_enter_tk : cpuidle_enter;
335
336 poll_idle_init(drv);
d8c216cf 337
4f86d3a8
LB
338 if ((ret = cpuidle_add_state_sysfs(dev)))
339 return ret;
340
341 if (cpuidle_curr_governor->enable &&
e1689795 342 (ret = cpuidle_curr_governor->enable(drv, dev)))
4f86d3a8
LB
343 goto fail_sysfs;
344
345 for (i = 0; i < dev->state_count; i++) {
4202735e
DD
346 dev->states_usage[i].usage = 0;
347 dev->states_usage[i].time = 0;
4f86d3a8
LB
348 }
349 dev->last_residency = 0;
4f86d3a8
LB
350
351 smp_wmb();
352
353 dev->enabled = 1;
354
355 enabled_devices++;
356 return 0;
357
358fail_sysfs:
359 cpuidle_remove_state_sysfs(dev);
360
361 return ret;
362}
363
364EXPORT_SYMBOL_GPL(cpuidle_enable_device);
365
366/**
367 * cpuidle_disable_device - disables idle PM for a CPU
368 * @dev: the CPU
369 *
370 * This function must be called between cpuidle_pause_and_lock and
371 * cpuidle_resume_and_unlock when used externally.
372 */
373void cpuidle_disable_device(struct cpuidle_device *dev)
374{
cf31cd1a 375 if (!dev || !dev->enabled)
4f86d3a8 376 return;
752138df 377 if (!cpuidle_get_driver() || !cpuidle_curr_governor)
4f86d3a8
LB
378 return;
379
380 dev->enabled = 0;
381
382 if (cpuidle_curr_governor->disable)
46bcfad7 383 cpuidle_curr_governor->disable(cpuidle_get_driver(), dev);
4f86d3a8
LB
384
385 cpuidle_remove_state_sysfs(dev);
386 enabled_devices--;
387}
388
389EXPORT_SYMBOL_GPL(cpuidle_disable_device);
390
391/**
dcb84f33
VP
392 * __cpuidle_register_device - internal register function called before register
393 * and enable routines
4f86d3a8 394 * @dev: the cpu
dcb84f33
VP
395 *
396 * cpuidle_lock mutex must be held before this is called
4f86d3a8 397 */
dcb84f33 398static int __cpuidle_register_device(struct cpuidle_device *dev)
4f86d3a8
LB
399{
400 int ret;
752138df 401 struct cpuidle_driver *cpuidle_driver = cpuidle_get_driver();
4f86d3a8 402
752138df 403 if (!try_module_get(cpuidle_driver->owner))
4f86d3a8
LB
404 return -EINVAL;
405
4f86d3a8
LB
406 per_cpu(cpuidle_devices, dev->cpu) = dev;
407 list_add(&dev->device_list, &cpuidle_detected_devices);
1aef40e2 408 ret = cpuidle_add_sysfs(dev);
3af272ab
CC
409 if (ret)
410 goto err_sysfs;
4f86d3a8 411
4126c019
CC
412 ret = cpuidle_coupled_register_device(dev);
413 if (ret)
414 goto err_coupled;
4f86d3a8 415
dcb84f33
VP
416 dev->registered = 1;
417 return 0;
3af272ab 418
4126c019 419err_coupled:
1aef40e2 420 cpuidle_remove_sysfs(dev);
3af272ab
CC
421err_sysfs:
422 list_del(&dev->device_list);
423 per_cpu(cpuidle_devices, dev->cpu) = NULL;
424 module_put(cpuidle_driver->owner);
425 return ret;
dcb84f33
VP
426}
427
428/**
429 * cpuidle_register_device - registers a CPU's idle PM feature
430 * @dev: the cpu
431 */
432int cpuidle_register_device(struct cpuidle_device *dev)
433{
434 int ret;
435
1b0a0e9a
SB
436 if (!dev)
437 return -EINVAL;
438
dcb84f33
VP
439 mutex_lock(&cpuidle_lock);
440
441 if ((ret = __cpuidle_register_device(dev))) {
442 mutex_unlock(&cpuidle_lock);
443 return ret;
444 }
445
4f86d3a8
LB
446 cpuidle_enable_device(dev);
447 cpuidle_install_idle_handler();
448
449 mutex_unlock(&cpuidle_lock);
450
451 return 0;
452
453}
454
455EXPORT_SYMBOL_GPL(cpuidle_register_device);
456
457/**
458 * cpuidle_unregister_device - unregisters a CPU's idle PM feature
459 * @dev: the cpu
460 */
461void cpuidle_unregister_device(struct cpuidle_device *dev)
462{
752138df 463 struct cpuidle_driver *cpuidle_driver = cpuidle_get_driver();
4f86d3a8 464
dcb84f33
VP
465 if (dev->registered == 0)
466 return;
467
4f86d3a8
LB
468 cpuidle_pause_and_lock();
469
470 cpuidle_disable_device(dev);
471
1aef40e2 472 cpuidle_remove_sysfs(dev);
4f86d3a8 473 list_del(&dev->device_list);
4f86d3a8
LB
474 per_cpu(cpuidle_devices, dev->cpu) = NULL;
475
4126c019
CC
476 cpuidle_coupled_unregister_device(dev);
477
4f86d3a8
LB
478 cpuidle_resume_and_unlock();
479
752138df 480 module_put(cpuidle_driver->owner);
4f86d3a8
LB
481}
482
483EXPORT_SYMBOL_GPL(cpuidle_unregister_device);
484
485#ifdef CONFIG_SMP
486
487static void smp_callback(void *v)
488{
489 /* we already woke the CPU up, nothing more to do */
490}
491
492/*
493 * This function gets called when a part of the kernel has a new latency
494 * requirement. This means we need to get all processors out of their C-state,
495 * and then recalculate a new suitable C-state. Just do a cross-cpu IPI; that
496 * wakes them all right up.
497 */
498static int cpuidle_latency_notify(struct notifier_block *b,
499 unsigned long l, void *v)
500{
8691e5a8 501 smp_call_function(smp_callback, NULL, 1);
4f86d3a8
LB
502 return NOTIFY_OK;
503}
504
505static struct notifier_block cpuidle_latency_notifier = {
506 .notifier_call = cpuidle_latency_notify,
507};
508
d82b3518
MG
509static inline void latency_notifier_init(struct notifier_block *n)
510{
511 pm_qos_add_notifier(PM_QOS_CPU_DMA_LATENCY, n);
512}
4f86d3a8
LB
513
514#else /* CONFIG_SMP */
515
516#define latency_notifier_init(x) do { } while (0)
517
518#endif /* CONFIG_SMP */
519
520/**
521 * cpuidle_init - core initializer
522 */
523static int __init cpuidle_init(void)
524{
525 int ret;
526
62027aea
LB
527 if (cpuidle_disabled())
528 return -ENODEV;
529
8a25a2fd 530 ret = cpuidle_add_interface(cpu_subsys.dev_root);
4f86d3a8
LB
531 if (ret)
532 return ret;
533
534 latency_notifier_init(&cpuidle_latency_notifier);
535
536 return 0;
537}
538
62027aea 539module_param(off, int, 0444);
4f86d3a8 540core_initcall(cpuidle_init);
This page took 0.662453 seconds and 5 git commands to generate.