Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * kernel/power/main.c - PM subsystem core functionality. | |
3 | * | |
4 | * Copyright (c) 2003 Patrick Mochel | |
5 | * Copyright (c) 2003 Open Source Development Lab | |
6 | * | |
7 | * This file is released under the GPLv2 | |
8 | * | |
9 | */ | |
10 | ||
4cf30348 | 11 | #include <linux/module.h> |
1da177e4 LT |
12 | #include <linux/suspend.h> |
13 | #include <linux/kobject.h> | |
14 | #include <linux/string.h> | |
15 | #include <linux/delay.h> | |
16 | #include <linux/errno.h> | |
17 | #include <linux/init.h> | |
6cc07191 | 18 | #include <linux/console.h> |
e3920fb4 | 19 | #include <linux/cpu.h> |
c5c6ba4e | 20 | #include <linux/resume-trace.h> |
7dfb7103 | 21 | #include <linux/freezer.h> |
96177299 | 22 | #include <linux/vmstat.h> |
232b1432 | 23 | #include <linux/syscalls.h> |
1da177e4 LT |
24 | |
25 | #include "power.h" | |
26 | ||
a6d70980 | 27 | DEFINE_MUTEX(pm_mutex); |
1da177e4 | 28 | |
9f9adecd LB |
29 | unsigned int pm_flags; |
30 | EXPORT_SYMBOL(pm_flags); | |
31 | ||
82525756 AS |
32 | #ifdef CONFIG_PM_SLEEP |
33 | ||
34 | /* Routines for PM-transition notifications */ | |
35 | ||
36 | static BLOCKING_NOTIFIER_HEAD(pm_chain_head); | |
37 | ||
38 | int register_pm_notifier(struct notifier_block *nb) | |
39 | { | |
40 | return blocking_notifier_chain_register(&pm_chain_head, nb); | |
41 | } | |
42 | EXPORT_SYMBOL_GPL(register_pm_notifier); | |
43 | ||
44 | int unregister_pm_notifier(struct notifier_block *nb) | |
45 | { | |
46 | return blocking_notifier_chain_unregister(&pm_chain_head, nb); | |
47 | } | |
48 | EXPORT_SYMBOL_GPL(unregister_pm_notifier); | |
49 | ||
50 | int pm_notifier_call_chain(unsigned long val) | |
51 | { | |
52 | return (blocking_notifier_call_chain(&pm_chain_head, val, NULL) | |
53 | == NOTIFY_BAD) ? -EINVAL : 0; | |
54 | } | |
55 | ||
0e7d56e3 RW |
56 | #ifdef CONFIG_PM_DEBUG |
57 | int pm_test_level = TEST_NONE; | |
58 | ||
59 | static int suspend_test(int level) | |
60 | { | |
61 | if (pm_test_level == level) { | |
62 | printk(KERN_INFO "suspend debug: Waiting for 5 seconds.\n"); | |
63 | mdelay(5000); | |
64 | return 1; | |
65 | } | |
66 | return 0; | |
67 | } | |
68 | ||
69 | static const char * const pm_tests[__TEST_AFTER_LAST] = { | |
70 | [TEST_NONE] = "none", | |
71 | [TEST_CORE] = "core", | |
72 | [TEST_CPUS] = "processors", | |
73 | [TEST_PLATFORM] = "platform", | |
74 | [TEST_DEVICES] = "devices", | |
75 | [TEST_FREEZER] = "freezer", | |
76 | }; | |
77 | ||
039a75c6 RW |
78 | static ssize_t pm_test_show(struct kobject *kobj, struct kobj_attribute *attr, |
79 | char *buf) | |
0e7d56e3 RW |
80 | { |
81 | char *s = buf; | |
82 | int level; | |
83 | ||
84 | for (level = TEST_FIRST; level <= TEST_MAX; level++) | |
85 | if (pm_tests[level]) { | |
86 | if (level == pm_test_level) | |
87 | s += sprintf(s, "[%s] ", pm_tests[level]); | |
88 | else | |
89 | s += sprintf(s, "%s ", pm_tests[level]); | |
90 | } | |
91 | ||
92 | if (s != buf) | |
93 | /* convert the last space to a newline */ | |
94 | *(s-1) = '\n'; | |
95 | ||
96 | return (s - buf); | |
97 | } | |
98 | ||
039a75c6 RW |
99 | static ssize_t pm_test_store(struct kobject *kobj, struct kobj_attribute *attr, |
100 | const char *buf, size_t n) | |
0e7d56e3 RW |
101 | { |
102 | const char * const *s; | |
103 | int level; | |
104 | char *p; | |
105 | int len; | |
106 | int error = -EINVAL; | |
107 | ||
108 | p = memchr(buf, '\n', n); | |
109 | len = p ? p - buf : n; | |
110 | ||
111 | mutex_lock(&pm_mutex); | |
112 | ||
113 | level = TEST_FIRST; | |
114 | for (s = &pm_tests[level]; level <= TEST_MAX; s++, level++) | |
115 | if (*s && len == strlen(*s) && !strncmp(buf, *s, len)) { | |
116 | pm_test_level = level; | |
117 | error = 0; | |
118 | break; | |
119 | } | |
120 | ||
121 | mutex_unlock(&pm_mutex); | |
122 | ||
123 | return error ? error : n; | |
124 | } | |
125 | ||
126 | power_attr(pm_test); | |
127 | #else /* !CONFIG_PM_DEBUG */ | |
128 | static inline int suspend_test(int level) { return 0; } | |
129 | #endif /* !CONFIG_PM_DEBUG */ | |
130 | ||
7671b8ae | 131 | #endif /* CONFIG_PM_SLEEP */ |
039a75c6 | 132 | |
296699de RW |
133 | #ifdef CONFIG_SUSPEND |
134 | ||
135 | /* This is just an arbitrary number */ | |
136 | #define FREE_PAGE_NUMBER (100) | |
137 | ||
f242d919 | 138 | static struct platform_suspend_ops *suspend_ops; |
1da177e4 LT |
139 | |
140 | /** | |
26398a70 | 141 | * suspend_set_ops - Set the global suspend method table. |
1da177e4 LT |
142 | * @ops: Pointer to ops structure. |
143 | */ | |
144 | ||
26398a70 | 145 | void suspend_set_ops(struct platform_suspend_ops *ops) |
1da177e4 | 146 | { |
a6d70980 | 147 | mutex_lock(&pm_mutex); |
26398a70 | 148 | suspend_ops = ops; |
a6d70980 | 149 | mutex_unlock(&pm_mutex); |
1da177e4 LT |
150 | } |
151 | ||
e8c9c502 | 152 | /** |
26398a70 | 153 | * suspend_valid_only_mem - generic memory-only valid callback |
e8c9c502 | 154 | * |
26398a70 | 155 | * Platform drivers that implement mem suspend only and only need |
e8c9c502 JB |
156 | * to check for that in their .valid callback can use this instead |
157 | * of rolling their own .valid callback. | |
158 | */ | |
26398a70 | 159 | int suspend_valid_only_mem(suspend_state_t state) |
e8c9c502 JB |
160 | { |
161 | return state == PM_SUSPEND_MEM; | |
162 | } | |
163 | ||
1da177e4 LT |
164 | /** |
165 | * suspend_prepare - Do prep work before entering low-power state. | |
1da177e4 | 166 | * |
6c961dfb RW |
167 | * This is common code that is called for each state that we're entering. |
168 | * Run suspend notifiers, allocate a console and stop all processes. | |
1da177e4 | 169 | */ |
6c961dfb | 170 | static int suspend_prepare(void) |
1da177e4 | 171 | { |
e3920fb4 | 172 | int error; |
5ae947ec | 173 | unsigned int free_pages; |
1da177e4 | 174 | |
26398a70 | 175 | if (!suspend_ops || !suspend_ops->enter) |
1da177e4 LT |
176 | return -EPERM; |
177 | ||
af258f51 JB |
178 | pm_prepare_console(); |
179 | ||
b10d9117 RW |
180 | error = pm_notifier_call_chain(PM_SUSPEND_PREPARE); |
181 | if (error) | |
182 | goto Finish; | |
183 | ||
b28f5081 | 184 | if (suspend_freeze_processes()) { |
1da177e4 LT |
185 | error = -EAGAIN; |
186 | goto Thaw; | |
187 | } | |
188 | ||
6c961dfb RW |
189 | free_pages = global_page_state(NR_FREE_PAGES); |
190 | if (free_pages < FREE_PAGE_NUMBER) { | |
5ae947ec DSL |
191 | pr_debug("PM: free some memory\n"); |
192 | shrink_all_memory(FREE_PAGE_NUMBER - free_pages); | |
193 | if (nr_free_pages() < FREE_PAGE_NUMBER) { | |
194 | error = -ENOMEM; | |
195 | printk(KERN_ERR "PM: No enough memory\n"); | |
5ae947ec DSL |
196 | } |
197 | } | |
e3c7db62 RW |
198 | if (!error) |
199 | return 0; | |
200 | ||
1da177e4 | 201 | Thaw: |
b28f5081 | 202 | suspend_thaw_processes(); |
b10d9117 RW |
203 | Finish: |
204 | pm_notifier_call_chain(PM_POST_SUSPEND); | |
af258f51 | 205 | pm_restore_console(); |
1da177e4 LT |
206 | return error; |
207 | } | |
208 | ||
a53c46dc JB |
209 | /* default implementation */ |
210 | void __attribute__ ((weak)) arch_suspend_disable_irqs(void) | |
211 | { | |
212 | local_irq_disable(); | |
213 | } | |
214 | ||
215 | /* default implementation */ | |
216 | void __attribute__ ((weak)) arch_suspend_enable_irqs(void) | |
217 | { | |
218 | local_irq_enable(); | |
219 | } | |
1da177e4 | 220 | |
6c961dfb RW |
221 | /** |
222 | * suspend_enter - enter the desired system sleep state. | |
223 | * @state: state to enter | |
224 | * | |
225 | * This function should be called after devices have been suspended. | |
226 | */ | |
a065c86e | 227 | static int suspend_enter(suspend_state_t state) |
1da177e4 LT |
228 | { |
229 | int error = 0; | |
1da177e4 | 230 | |
1eede070 | 231 | device_pm_lock(); |
a53c46dc JB |
232 | arch_suspend_disable_irqs(); |
233 | BUG_ON(!irqs_disabled()); | |
1da177e4 LT |
234 | |
235 | if ((error = device_power_down(PMSG_SUSPEND))) { | |
465d2b47 | 236 | printk(KERN_ERR "PM: Some devices failed to power down\n"); |
1da177e4 LT |
237 | goto Done; |
238 | } | |
0e7d56e3 RW |
239 | |
240 | if (!suspend_test(TEST_CORE)) | |
241 | error = suspend_ops->enter(state); | |
242 | ||
1eede070 | 243 | device_power_up(PMSG_RESUME); |
1da177e4 | 244 | Done: |
a53c46dc JB |
245 | arch_suspend_enable_irqs(); |
246 | BUG_ON(irqs_disabled()); | |
1eede070 | 247 | device_pm_unlock(); |
1da177e4 LT |
248 | return error; |
249 | } | |
250 | ||
6c961dfb | 251 | /** |
9628c0ee RW |
252 | * suspend_devices_and_enter - suspend devices and enter the desired system |
253 | * sleep state. | |
6c961dfb RW |
254 | * @state: state to enter |
255 | */ | |
256 | int suspend_devices_and_enter(suspend_state_t state) | |
257 | { | |
258 | int error; | |
259 | ||
26398a70 | 260 | if (!suspend_ops) |
6c961dfb RW |
261 | return -ENOSYS; |
262 | ||
c697eece RW |
263 | if (suspend_ops->begin) { |
264 | error = suspend_ops->begin(state); | |
6c961dfb | 265 | if (error) |
c697eece | 266 | goto Close; |
6c961dfb RW |
267 | } |
268 | suspend_console(); | |
269 | error = device_suspend(PMSG_SUSPEND); | |
270 | if (error) { | |
465d2b47 | 271 | printk(KERN_ERR "PM: Some devices failed to suspend\n"); |
6c961dfb RW |
272 | goto Resume_console; |
273 | } | |
0e7d56e3 RW |
274 | |
275 | if (suspend_test(TEST_DEVICES)) | |
276 | goto Resume_devices; | |
277 | ||
26398a70 | 278 | if (suspend_ops->prepare) { |
e6c5eb95 | 279 | error = suspend_ops->prepare(); |
6c961dfb RW |
280 | if (error) |
281 | goto Resume_devices; | |
282 | } | |
0e7d56e3 RW |
283 | |
284 | if (suspend_test(TEST_PLATFORM)) | |
285 | goto Finish; | |
286 | ||
6c961dfb | 287 | error = disable_nonboot_cpus(); |
0e7d56e3 | 288 | if (!error && !suspend_test(TEST_CPUS)) |
6c961dfb RW |
289 | suspend_enter(state); |
290 | ||
291 | enable_nonboot_cpus(); | |
0e7d56e3 | 292 | Finish: |
e6c5eb95 RW |
293 | if (suspend_ops->finish) |
294 | suspend_ops->finish(); | |
6c961dfb | 295 | Resume_devices: |
1eede070 | 296 | device_resume(PMSG_RESUME); |
6c961dfb RW |
297 | Resume_console: |
298 | resume_console(); | |
c697eece RW |
299 | Close: |
300 | if (suspend_ops->end) | |
301 | suspend_ops->end(); | |
6c961dfb RW |
302 | return error; |
303 | } | |
1da177e4 LT |
304 | |
305 | /** | |
306 | * suspend_finish - Do final work before exiting suspend sequence. | |
1da177e4 LT |
307 | * |
308 | * Call platform code to clean up, restart processes, and free the | |
309 | * console that we've allocated. This is not called for suspend-to-disk. | |
310 | */ | |
6c961dfb | 311 | static void suspend_finish(void) |
1da177e4 | 312 | { |
b28f5081 | 313 | suspend_thaw_processes(); |
b10d9117 | 314 | pm_notifier_call_chain(PM_POST_SUSPEND); |
af258f51 | 315 | pm_restore_console(); |
1da177e4 LT |
316 | } |
317 | ||
318 | ||
319 | ||
320 | ||
3b364b8d | 321 | static const char * const pm_states[PM_SUSPEND_MAX] = { |
1da177e4 LT |
322 | [PM_SUSPEND_STANDBY] = "standby", |
323 | [PM_SUSPEND_MEM] = "mem", | |
1da177e4 LT |
324 | }; |
325 | ||
123d3c13 PM |
326 | static inline int valid_state(suspend_state_t state) |
327 | { | |
a3d25c27 RW |
328 | /* All states need lowlevel support and need to be valid |
329 | * to the lowlevel implementation, no valid callback | |
9684e51c | 330 | * implies that none are valid. */ |
26398a70 | 331 | if (!suspend_ops || !suspend_ops->valid || !suspend_ops->valid(state)) |
123d3c13 PM |
332 | return 0; |
333 | return 1; | |
334 | } | |
335 | ||
1da177e4 LT |
336 | |
337 | /** | |
338 | * enter_state - Do common work of entering low-power state. | |
339 | * @state: pm_state structure for state we're entering. | |
340 | * | |
341 | * Make sure we're the only ones trying to enter a sleep state. Fail | |
342 | * if someone has beat us to it, since we don't want anything weird to | |
343 | * happen when we wake up. | |
344 | * Then, do the setup for suspend, enter the state, and cleaup (after | |
345 | * we've woken up). | |
346 | */ | |
1da177e4 LT |
347 | static int enter_state(suspend_state_t state) |
348 | { | |
349 | int error; | |
350 | ||
123d3c13 | 351 | if (!valid_state(state)) |
eb9289eb | 352 | return -ENODEV; |
232b1432 | 353 | |
a6d70980 | 354 | if (!mutex_trylock(&pm_mutex)) |
1da177e4 LT |
355 | return -EBUSY; |
356 | ||
465d2b47 | 357 | printk(KERN_INFO "PM: Syncing filesystems ... "); |
232b1432 RW |
358 | sys_sync(); |
359 | printk("done.\n"); | |
360 | ||
82428b62 | 361 | pr_debug("PM: Preparing system for %s sleep\n", pm_states[state]); |
0e7d56e3 RW |
362 | error = suspend_prepare(); |
363 | if (error) | |
1da177e4 LT |
364 | goto Unlock; |
365 | ||
0e7d56e3 RW |
366 | if (suspend_test(TEST_FREEZER)) |
367 | goto Finish; | |
368 | ||
82428b62 | 369 | pr_debug("PM: Entering %s sleep\n", pm_states[state]); |
6c961dfb | 370 | error = suspend_devices_and_enter(state); |
1da177e4 | 371 | |
0e7d56e3 | 372 | Finish: |
82428b62 | 373 | pr_debug("PM: Finishing wakeup.\n"); |
6c961dfb | 374 | suspend_finish(); |
1da177e4 | 375 | Unlock: |
a6d70980 | 376 | mutex_unlock(&pm_mutex); |
1da177e4 LT |
377 | return error; |
378 | } | |
379 | ||
1da177e4 LT |
380 | |
381 | /** | |
382 | * pm_suspend - Externally visible function for suspending system. | |
a3d25c27 | 383 | * @state: Enumerated value of state to enter. |
1da177e4 LT |
384 | * |
385 | * Determine whether or not value is within range, get state | |
386 | * structure, and enter (above). | |
387 | */ | |
388 | ||
389 | int pm_suspend(suspend_state_t state) | |
390 | { | |
e2a5b420 | 391 | if (state > PM_SUSPEND_ON && state <= PM_SUSPEND_MAX) |
1da177e4 LT |
392 | return enter_state(state); |
393 | return -EINVAL; | |
394 | } | |
395 | ||
4cf30348 | 396 | EXPORT_SYMBOL(pm_suspend); |
1da177e4 | 397 | |
296699de RW |
398 | #endif /* CONFIG_SUSPEND */ |
399 | ||
d76e15fb | 400 | struct kobject *power_kobj; |
1da177e4 LT |
401 | |
402 | /** | |
403 | * state - control system power state. | |
404 | * | |
405 | * show() returns what states are supported, which is hard-coded to | |
406 | * 'standby' (Power-On Suspend), 'mem' (Suspend-to-RAM), and | |
407 | * 'disk' (Suspend-to-Disk). | |
408 | * | |
409 | * store() accepts one of those strings, translates it into the | |
410 | * proper enumerated value, and initiates a suspend transition. | |
411 | */ | |
412 | ||
386f275f KS |
413 | static ssize_t state_show(struct kobject *kobj, struct kobj_attribute *attr, |
414 | char *buf) | |
1da177e4 | 415 | { |
296699de RW |
416 | char *s = buf; |
417 | #ifdef CONFIG_SUSPEND | |
1da177e4 | 418 | int i; |
1da177e4 LT |
419 | |
420 | for (i = 0; i < PM_SUSPEND_MAX; i++) { | |
123d3c13 PM |
421 | if (pm_states[i] && valid_state(i)) |
422 | s += sprintf(s,"%s ", pm_states[i]); | |
1da177e4 | 423 | } |
296699de | 424 | #endif |
b0cb1a19 | 425 | #ifdef CONFIG_HIBERNATION |
a3d25c27 RW |
426 | s += sprintf(s, "%s\n", "disk"); |
427 | #else | |
428 | if (s != buf) | |
429 | /* convert the last space to a newline */ | |
430 | *(s-1) = '\n'; | |
431 | #endif | |
1da177e4 LT |
432 | return (s - buf); |
433 | } | |
434 | ||
386f275f KS |
435 | static ssize_t state_store(struct kobject *kobj, struct kobj_attribute *attr, |
436 | const char *buf, size_t n) | |
1da177e4 | 437 | { |
296699de | 438 | #ifdef CONFIG_SUSPEND |
1da177e4 | 439 | suspend_state_t state = PM_SUSPEND_STANDBY; |
3b364b8d | 440 | const char * const *s; |
296699de | 441 | #endif |
1da177e4 | 442 | char *p; |
1da177e4 | 443 | int len; |
296699de | 444 | int error = -EINVAL; |
1da177e4 LT |
445 | |
446 | p = memchr(buf, '\n', n); | |
447 | len = p ? p - buf : n; | |
448 | ||
a3d25c27 | 449 | /* First, check if we are requested to hibernate */ |
8d98a690 | 450 | if (len == 4 && !strncmp(buf, "disk", len)) { |
a3d25c27 | 451 | error = hibernate(); |
296699de | 452 | goto Exit; |
a3d25c27 RW |
453 | } |
454 | ||
296699de | 455 | #ifdef CONFIG_SUSPEND |
1da177e4 | 456 | for (s = &pm_states[state]; state < PM_SUSPEND_MAX; s++, state++) { |
8d98a690 | 457 | if (*s && len == strlen(*s) && !strncmp(buf, *s, len)) |
1da177e4 LT |
458 | break; |
459 | } | |
47bb7899 | 460 | if (state < PM_SUSPEND_MAX && *s) |
1da177e4 | 461 | error = enter_state(state); |
296699de RW |
462 | #endif |
463 | ||
464 | Exit: | |
1da177e4 LT |
465 | return error ? error : n; |
466 | } | |
467 | ||
468 | power_attr(state); | |
469 | ||
c5c6ba4e RW |
470 | #ifdef CONFIG_PM_TRACE |
471 | int pm_trace_enabled; | |
472 | ||
386f275f KS |
473 | static ssize_t pm_trace_show(struct kobject *kobj, struct kobj_attribute *attr, |
474 | char *buf) | |
c5c6ba4e RW |
475 | { |
476 | return sprintf(buf, "%d\n", pm_trace_enabled); | |
477 | } | |
478 | ||
479 | static ssize_t | |
386f275f KS |
480 | pm_trace_store(struct kobject *kobj, struct kobj_attribute *attr, |
481 | const char *buf, size_t n) | |
c5c6ba4e RW |
482 | { |
483 | int val; | |
484 | ||
485 | if (sscanf(buf, "%d", &val) == 1) { | |
486 | pm_trace_enabled = !!val; | |
487 | return n; | |
488 | } | |
489 | return -EINVAL; | |
490 | } | |
491 | ||
492 | power_attr(pm_trace); | |
0e7d56e3 | 493 | #endif /* CONFIG_PM_TRACE */ |
c5c6ba4e RW |
494 | |
495 | static struct attribute * g[] = { | |
496 | &state_attr.attr, | |
0e7d56e3 | 497 | #ifdef CONFIG_PM_TRACE |
c5c6ba4e | 498 | &pm_trace_attr.attr, |
0e7d56e3 | 499 | #endif |
7671b8ae | 500 | #if defined(CONFIG_PM_SLEEP) && defined(CONFIG_PM_DEBUG) |
0e7d56e3 RW |
501 | &pm_test_attr.attr, |
502 | #endif | |
c5c6ba4e RW |
503 | NULL, |
504 | }; | |
1da177e4 LT |
505 | |
506 | static struct attribute_group attr_group = { | |
507 | .attrs = g, | |
508 | }; | |
509 | ||
510 | ||
511 | static int __init pm_init(void) | |
512 | { | |
d76e15fb GKH |
513 | power_kobj = kobject_create_and_add("power", NULL); |
514 | if (!power_kobj) | |
039a5dcd | 515 | return -ENOMEM; |
d76e15fb | 516 | return sysfs_create_group(power_kobj, &attr_group); |
1da177e4 LT |
517 | } |
518 | ||
519 | core_initcall(pm_init); |