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
11 #include <linux/module.h>
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/kmod.h>
18 #include <linux/init.h>
19 #include <linux/console.h>
20 #include <linux/cpu.h>
21 #include <linux/resume-trace.h>
22 #include <linux/freezer.h>
23 #include <linux/vmstat.h>
24 #include <linux/syscalls.h>
25
26 #include "power.h"
27
28 DEFINE_MUTEX(pm_mutex);
29
30 unsigned int pm_flags;
31 EXPORT_SYMBOL(pm_flags);
32
33 #ifdef CONFIG_PM_SLEEP
34
35 /* Routines for PM-transition notifications */
36
37 static BLOCKING_NOTIFIER_HEAD(pm_chain_head);
38
register_pm_notifier(struct notifier_block * nb)39 int register_pm_notifier(struct notifier_block *nb)
40 {
41 return blocking_notifier_chain_register(&pm_chain_head, nb);
42 }
43 EXPORT_SYMBOL_GPL(register_pm_notifier);
44
unregister_pm_notifier(struct notifier_block * nb)45 int unregister_pm_notifier(struct notifier_block *nb)
46 {
47 return blocking_notifier_chain_unregister(&pm_chain_head, nb);
48 }
49 EXPORT_SYMBOL_GPL(unregister_pm_notifier);
50
pm_notifier_call_chain(unsigned long val)51 int pm_notifier_call_chain(unsigned long val)
52 {
53 return (blocking_notifier_call_chain(&pm_chain_head, val, NULL)
54 == NOTIFY_BAD) ? -EINVAL : 0;
55 }
56
57 #ifdef CONFIG_PM_DEBUG
58 int pm_test_level = TEST_NONE;
59
60 static const char * const pm_tests[__TEST_AFTER_LAST] = {
61 [TEST_NONE] = "none",
62 [TEST_CORE] = "core",
63 [TEST_CPUS] = "processors",
64 [TEST_PLATFORM] = "platform",
65 [TEST_DEVICES] = "devices",
66 [TEST_FREEZER] = "freezer",
67 };
68
pm_test_show(struct kobject * kobj,struct kobj_attribute * attr,char * buf)69 static ssize_t pm_test_show(struct kobject *kobj, struct kobj_attribute *attr,
70 char *buf)
71 {
72 char *s = buf;
73 int level;
74
75 for (level = TEST_FIRST; level <= TEST_MAX; level++)
76 if (pm_tests[level]) {
77 if (level == pm_test_level)
78 s += sprintf(s, "[%s] ", pm_tests[level]);
79 else
80 s += sprintf(s, "%s ", pm_tests[level]);
81 }
82
83 if (s != buf)
84 /* convert the last space to a newline */
85 *(s-1) = '\n';
86
87 return (s - buf);
88 }
89
pm_test_store(struct kobject * kobj,struct kobj_attribute * attr,const char * buf,size_t n)90 static ssize_t pm_test_store(struct kobject *kobj, struct kobj_attribute *attr,
91 const char *buf, size_t n)
92 {
93 const char * const *s;
94 int level;
95 char *p;
96 int len;
97 int error = -EINVAL;
98
99 p = memchr(buf, '\n', n);
100 len = p ? p - buf : n;
101
102 mutex_lock(&pm_mutex);
103
104 level = TEST_FIRST;
105 for (s = &pm_tests[level]; level <= TEST_MAX; s++, level++)
106 if (*s && len == strlen(*s) && !strncmp(buf, *s, len)) {
107 pm_test_level = level;
108 error = 0;
109 break;
110 }
111
112 mutex_unlock(&pm_mutex);
113
114 return error ? error : n;
115 }
116
117 power_attr(pm_test);
118 #endif /* CONFIG_PM_DEBUG */
119
120 #endif /* CONFIG_PM_SLEEP */
121
122 #ifdef CONFIG_SUSPEND
123
suspend_test(int level)124 static int suspend_test(int level)
125 {
126 #ifdef CONFIG_PM_DEBUG
127 if (pm_test_level == level) {
128 printk(KERN_INFO "suspend debug: Waiting for 5 seconds.\n");
129 mdelay(5000);
130 return 1;
131 }
132 #endif /* !CONFIG_PM_DEBUG */
133 return 0;
134 }
135
136 #ifdef CONFIG_PM_TEST_SUSPEND
137
138 /*
139 * We test the system suspend code by setting an RTC wakealarm a short
140 * time in the future, then suspending. Suspending the devices won't
141 * normally take long ... some systems only need a few milliseconds.
142 *
143 * The time it takes is system-specific though, so when we test this
144 * during system bootup we allow a LOT of time.
145 */
146 #define TEST_SUSPEND_SECONDS 5
147
148 static unsigned long suspend_test_start_time;
149
suspend_test_start(void)150 static void suspend_test_start(void)
151 {
152 /* FIXME Use better timebase than "jiffies", ideally a clocksource.
153 * What we want is a hardware counter that will work correctly even
154 * during the irqs-are-off stages of the suspend/resume cycle...
155 */
156 suspend_test_start_time = jiffies;
157 }
158
suspend_test_finish(const char * label)159 static void suspend_test_finish(const char *label)
160 {
161 long nj = jiffies - suspend_test_start_time;
162 unsigned msec;
163
164 msec = jiffies_to_msecs(abs(nj));
165 pr_info("PM: %s took %d.%03d seconds\n", label,
166 msec / 1000, msec % 1000);
167
168 /* Warning on suspend means the RTC alarm period needs to be
169 * larger -- the system was sooo slooowwww to suspend that the
170 * alarm (should have) fired before the system went to sleep!
171 *
172 * Warning on either suspend or resume also means the system
173 * has some performance issues. The stack dump of a WARN_ON
174 * is more likely to get the right attention than a printk...
175 */
176 WARN(msec > (TEST_SUSPEND_SECONDS * 1000), "Component: %s\n", label);
177 }
178
179 #else
180
suspend_test_start(void)181 static void suspend_test_start(void)
182 {
183 }
184
suspend_test_finish(const char * label)185 static void suspend_test_finish(const char *label)
186 {
187 }
188
189 #endif
190
191 /* This is just an arbitrary number */
192 #define FREE_PAGE_NUMBER (100)
193
194 static struct platform_suspend_ops *suspend_ops;
195
196 /**
197 * suspend_set_ops - Set the global suspend method table.
198 * @ops: Pointer to ops structure.
199 */
200
suspend_set_ops(struct platform_suspend_ops * ops)201 void suspend_set_ops(struct platform_suspend_ops *ops)
202 {
203 mutex_lock(&pm_mutex);
204 suspend_ops = ops;
205 mutex_unlock(&pm_mutex);
206 }
207
208 /**
209 * suspend_valid_only_mem - generic memory-only valid callback
210 *
211 * Platform drivers that implement mem suspend only and only need
212 * to check for that in their .valid callback can use this instead
213 * of rolling their own .valid callback.
214 */
suspend_valid_only_mem(suspend_state_t state)215 int suspend_valid_only_mem(suspend_state_t state)
216 {
217 return state == PM_SUSPEND_MEM;
218 }
219
220 /**
221 * suspend_prepare - Do prep work before entering low-power state.
222 *
223 * This is common code that is called for each state that we're entering.
224 * Run suspend notifiers, allocate a console and stop all processes.
225 */
suspend_prepare(void)226 static int suspend_prepare(void)
227 {
228 int error;
229 unsigned int free_pages;
230
231 if (!suspend_ops || !suspend_ops->enter)
232 return -EPERM;
233
234 pm_prepare_console();
235
236 error = pm_notifier_call_chain(PM_SUSPEND_PREPARE);
237 if (error)
238 goto Finish;
239
240 error = usermodehelper_disable();
241 if (error)
242 goto Finish;
243
244 if (suspend_freeze_processes()) {
245 error = -EAGAIN;
246 goto Thaw;
247 }
248
249 free_pages = global_page_state(NR_FREE_PAGES);
250 if (free_pages < FREE_PAGE_NUMBER) {
251 pr_debug("PM: free some memory\n");
252 shrink_all_memory(FREE_PAGE_NUMBER - free_pages);
253 if (nr_free_pages() < FREE_PAGE_NUMBER) {
254 error = -ENOMEM;
255 printk(KERN_ERR "PM: No enough memory\n");
256 }
257 }
258 if (!error)
259 return 0;
260
261 Thaw:
262 suspend_thaw_processes();
263 usermodehelper_enable();
264 Finish:
265 pm_notifier_call_chain(PM_POST_SUSPEND);
266 pm_restore_console();
267 return error;
268 }
269
270 /* default implementation */
arch_suspend_disable_irqs(void)271 void __attribute__ ((weak)) arch_suspend_disable_irqs(void)
272 {
273 local_irq_disable();
274 }
275
276 /* default implementation */
arch_suspend_enable_irqs(void)277 void __attribute__ ((weak)) arch_suspend_enable_irqs(void)
278 {
279 local_irq_enable();
280 }
281
282 /**
283 * suspend_enter - enter the desired system sleep state.
284 * @state: state to enter
285 *
286 * This function should be called after devices have been suspended.
287 */
suspend_enter(suspend_state_t state)288 static int suspend_enter(suspend_state_t state)
289 {
290 int error = 0;
291
292 device_pm_lock();
293 arch_suspend_disable_irqs();
294 BUG_ON(!irqs_disabled());
295
296 if ((error = device_power_down(PMSG_SUSPEND))) {
297 printk(KERN_ERR "PM: Some devices failed to power down\n");
298 goto Done;
299 }
300
301 error = sysdev_suspend(PMSG_SUSPEND);
302 if (!error) {
303 if (!suspend_test(TEST_CORE))
304 error = suspend_ops->enter(state);
305 sysdev_resume();
306 }
307
308 device_power_up(PMSG_RESUME);
309 Done:
310 arch_suspend_enable_irqs();
311 BUG_ON(irqs_disabled());
312 device_pm_unlock();
313 return error;
314 }
315
316 /**
317 * suspend_devices_and_enter - suspend devices and enter the desired system
318 * sleep state.
319 * @state: state to enter
320 */
suspend_devices_and_enter(suspend_state_t state)321 int suspend_devices_and_enter(suspend_state_t state)
322 {
323 int error;
324
325 if (!suspend_ops)
326 return -ENOSYS;
327
328 if (suspend_ops->begin) {
329 error = suspend_ops->begin(state);
330 if (error)
331 goto Close;
332 }
333 suspend_console();
334 suspend_test_start();
335 error = device_suspend(PMSG_SUSPEND);
336 if (error) {
337 printk(KERN_ERR "PM: Some devices failed to suspend\n");
338 goto Recover_platform;
339 }
340 suspend_test_finish("suspend devices");
341 if (suspend_test(TEST_DEVICES))
342 goto Recover_platform;
343
344 if (suspend_ops->prepare) {
345 error = suspend_ops->prepare();
346 if (error)
347 goto Resume_devices;
348 }
349
350 if (suspend_test(TEST_PLATFORM))
351 goto Finish;
352
353 error = disable_nonboot_cpus();
354 if (!error && !suspend_test(TEST_CPUS))
355 suspend_enter(state);
356
357 enable_nonboot_cpus();
358 Finish:
359 if (suspend_ops->finish)
360 suspend_ops->finish();
361 Resume_devices:
362 suspend_test_start();
363 device_resume(PMSG_RESUME);
364 suspend_test_finish("resume devices");
365 resume_console();
366 Close:
367 if (suspend_ops->end)
368 suspend_ops->end();
369 return error;
370
371 Recover_platform:
372 if (suspend_ops->recover)
373 suspend_ops->recover();
374 goto Resume_devices;
375 }
376
377 /**
378 * suspend_finish - Do final work before exiting suspend sequence.
379 *
380 * Call platform code to clean up, restart processes, and free the
381 * console that we've allocated. This is not called for suspend-to-disk.
382 */
suspend_finish(void)383 static void suspend_finish(void)
384 {
385 suspend_thaw_processes();
386 usermodehelper_enable();
387 pm_notifier_call_chain(PM_POST_SUSPEND);
388 pm_restore_console();
389 }
390
391
392
393
394 static const char * const pm_states[PM_SUSPEND_MAX] = {
395 #ifdef CONFIG_EARLYSUSPEND
396 [PM_SUSPEND_ON] = "on",
397 #endif
398 [PM_SUSPEND_STANDBY] = "standby",
399 [PM_SUSPEND_MEM] = "mem",
400 };
401
valid_state(suspend_state_t state)402 static inline int valid_state(suspend_state_t state)
403 {
404 /* All states need lowlevel support and need to be valid
405 * to the lowlevel implementation, no valid callback
406 * implies that none are valid. */
407 if (!suspend_ops || !suspend_ops->valid || !suspend_ops->valid(state))
408 return 0;
409 return 1;
410 }
411
412
413 /**
414 * enter_state - Do common work of entering low-power state.
415 * @state: pm_state structure for state we're entering.
416 *
417 * Make sure we're the only ones trying to enter a sleep state. Fail
418 * if someone has beat us to it, since we don't want anything weird to
419 * happen when we wake up.
420 * Then, do the setup for suspend, enter the state, and cleaup (after
421 * we've woken up).
422 */
enter_state(suspend_state_t state)423 static int enter_state(suspend_state_t state)
424 {
425 int error;
426
427 if (!valid_state(state))
428 return -ENODEV;
429
430 if (!mutex_trylock(&pm_mutex))
431 return -EBUSY;
432
433 printk(KERN_INFO "PM: Syncing filesystems ... ");
434 sys_sync();
435 printk("done.\n");
436
437 pr_debug("PM: Preparing system for %s sleep\n", pm_states[state]);
438 error = suspend_prepare();
439 if (error)
440 goto Unlock;
441
442 if (suspend_test(TEST_FREEZER))
443 goto Finish;
444
445 pr_debug("PM: Entering %s sleep\n", pm_states[state]);
446 error = suspend_devices_and_enter(state);
447
448 Finish:
449 pr_debug("PM: Finishing wakeup.\n");
450 suspend_finish();
451 Unlock:
452 mutex_unlock(&pm_mutex);
453 return error;
454 }
455
456
457 /**
458 * pm_suspend - Externally visible function for suspending system.
459 * @state: Enumerated value of state to enter.
460 *
461 * Determine whether or not value is within range, get state
462 * structure, and enter (above).
463 */
464
pm_suspend(suspend_state_t state)465 int pm_suspend(suspend_state_t state)
466 {
467 if (state > PM_SUSPEND_ON && state <= PM_SUSPEND_MAX)
468 return enter_state(state);
469 return -EINVAL;
470 }
471
472 EXPORT_SYMBOL(pm_suspend);
473
474 #endif /* CONFIG_SUSPEND */
475
476 struct kobject *power_kobj;
477
478 /**
479 * state - control system power state.
480 *
481 * show() returns what states are supported, which is hard-coded to
482 * 'standby' (Power-On Suspend), 'mem' (Suspend-to-RAM), and
483 * 'disk' (Suspend-to-Disk).
484 *
485 * store() accepts one of those strings, translates it into the
486 * proper enumerated value, and initiates a suspend transition.
487 */
488
state_show(struct kobject * kobj,struct kobj_attribute * attr,char * buf)489 static ssize_t state_show(struct kobject *kobj, struct kobj_attribute *attr,
490 char *buf)
491 {
492 char *s = buf;
493 #ifdef CONFIG_SUSPEND
494 int i;
495
496 for (i = 0; i < PM_SUSPEND_MAX; i++) {
497 if (pm_states[i] && valid_state(i))
498 s += sprintf(s,"%s ", pm_states[i]);
499 }
500 #endif
501 #ifdef CONFIG_HIBERNATION
502 s += sprintf(s, "%s\n", "disk");
503 #else
504 if (s != buf)
505 /* convert the last space to a newline */
506 *(s-1) = '\n';
507 #endif
508 return (s - buf);
509 }
510
state_store(struct kobject * kobj,struct kobj_attribute * attr,const char * buf,size_t n)511 static ssize_t state_store(struct kobject *kobj, struct kobj_attribute *attr,
512 const char *buf, size_t n)
513 {
514 #ifdef CONFIG_SUSPEND
515 #ifdef CONFIG_EARLYSUSPEND
516 suspend_state_t state = PM_SUSPEND_ON;
517 #else
518 suspend_state_t state = PM_SUSPEND_STANDBY;
519 #endif
520 const char * const *s;
521 #endif
522 char *p;
523 int len;
524 int error = -EINVAL;
525
526 p = memchr(buf, '\n', n);
527 len = p ? p - buf : n;
528
529 /* First, check if we are requested to hibernate */
530 if (len == 4 && !strncmp(buf, "disk", len)) {
531 error = hibernate();
532 goto Exit;
533 }
534
535 #ifdef CONFIG_SUSPEND
536 for (s = &pm_states[state]; state < PM_SUSPEND_MAX; s++, state++) {
537 if (*s && len == strlen(*s) && !strncmp(buf, *s, len))
538 break;
539 }
540 if (state < PM_SUSPEND_MAX && *s)
541 #ifdef CONFIG_EARLYSUSPEND
542 if (state == PM_SUSPEND_ON || valid_state(state)) {
543 error = 0;
544 request_suspend_state(state);
545 }
546 #else
547 error = enter_state(state);
548 #endif
549 #endif
550
551 Exit:
552 return error ? error : n;
553 }
554
555 power_attr(state);
556
557 #ifdef CONFIG_PM_TRACE
558 int pm_trace_enabled;
559
pm_trace_show(struct kobject * kobj,struct kobj_attribute * attr,char * buf)560 static ssize_t pm_trace_show(struct kobject *kobj, struct kobj_attribute *attr,
561 char *buf)
562 {
563 return sprintf(buf, "%d\n", pm_trace_enabled);
564 }
565
566 static ssize_t
pm_trace_store(struct kobject * kobj,struct kobj_attribute * attr,const char * buf,size_t n)567 pm_trace_store(struct kobject *kobj, struct kobj_attribute *attr,
568 const char *buf, size_t n)
569 {
570 int val;
571
572 if (sscanf(buf, "%d", &val) == 1) {
573 pm_trace_enabled = !!val;
574 return n;
575 }
576 return -EINVAL;
577 }
578
579 power_attr(pm_trace);
580 #endif /* CONFIG_PM_TRACE */
581
582 #ifdef CONFIG_USER_WAKELOCK
583 power_attr(wake_lock);
584 power_attr(wake_unlock);
585 #endif
586
587 static struct attribute * g[] = {
588 &state_attr.attr,
589 #ifdef CONFIG_PM_TRACE
590 &pm_trace_attr.attr,
591 #endif
592 #if defined(CONFIG_PM_SLEEP) && defined(CONFIG_PM_DEBUG)
593 &pm_test_attr.attr,
594 #endif
595 #ifdef CONFIG_USER_WAKELOCK
596 &wake_lock_attr.attr,
597 &wake_unlock_attr.attr,
598 #endif
599 NULL,
600 };
601
602 static struct attribute_group attr_group = {
603 .attrs = g,
604 };
605
606
pm_init(void)607 static int __init pm_init(void)
608 {
609 power_kobj = kobject_create_and_add("power", NULL);
610 if (!power_kobj)
611 return -ENOMEM;
612 return sysfs_create_group(power_kobj, &attr_group);
613 }
614
615 core_initcall(pm_init);
616
617
618 #ifdef CONFIG_PM_TEST_SUSPEND
619
620 #include <linux/rtc.h>
621
622 /*
623 * To test system suspend, we need a hands-off mechanism to resume the
624 * system. RTCs wake alarms are a common self-contained mechanism.
625 */
626
test_wakealarm(struct rtc_device * rtc,suspend_state_t state)627 static void __init test_wakealarm(struct rtc_device *rtc, suspend_state_t state)
628 {
629 static char err_readtime[] __initdata =
630 KERN_ERR "PM: can't read %s time, err %d\n";
631 static char err_wakealarm [] __initdata =
632 KERN_ERR "PM: can't set %s wakealarm, err %d\n";
633 static char err_suspend[] __initdata =
634 KERN_ERR "PM: suspend test failed, error %d\n";
635 static char info_test[] __initdata =
636 KERN_INFO "PM: test RTC wakeup from '%s' suspend\n";
637
638 unsigned long now;
639 struct rtc_wkalrm alm;
640 int status;
641
642 /* this may fail if the RTC hasn't been initialized */
643 status = rtc_read_time(rtc, &alm.time);
644 if (status < 0) {
645 printk(err_readtime, dev_name(&rtc->dev), status);
646 return;
647 }
648 rtc_tm_to_time(&alm.time, &now);
649
650 memset(&alm, 0, sizeof alm);
651 rtc_time_to_tm(now + TEST_SUSPEND_SECONDS, &alm.time);
652 alm.enabled = true;
653
654 status = rtc_set_alarm(rtc, &alm);
655 if (status < 0) {
656 printk(err_wakealarm, dev_name(&rtc->dev), status);
657 return;
658 }
659
660 if (state == PM_SUSPEND_MEM) {
661 printk(info_test, pm_states[state]);
662 status = pm_suspend(state);
663 if (status == -ENODEV)
664 state = PM_SUSPEND_STANDBY;
665 }
666 if (state == PM_SUSPEND_STANDBY) {
667 printk(info_test, pm_states[state]);
668 status = pm_suspend(state);
669 }
670 if (status < 0)
671 printk(err_suspend, status);
672
673 /* Some platforms can't detect that the alarm triggered the
674 * wakeup, or (accordingly) disable it after it afterwards.
675 * It's supposed to give oneshot behavior; cope.
676 */
677 alm.enabled = false;
678 rtc_set_alarm(rtc, &alm);
679 }
680
has_wakealarm(struct device * dev,void * name_ptr)681 static int __init has_wakealarm(struct device *dev, void *name_ptr)
682 {
683 struct rtc_device *candidate = to_rtc_device(dev);
684
685 if (!candidate->ops->set_alarm)
686 return 0;
687 if (!device_may_wakeup(candidate->dev.parent))
688 return 0;
689
690 *(const char **)name_ptr = dev_name(dev);
691 return 1;
692 }
693
694 /*
695 * Kernel options like "test_suspend=mem" force suspend/resume sanity tests
696 * at startup time. They're normally disabled, for faster boot and because
697 * we can't know which states really work on this particular system.
698 */
699 static suspend_state_t test_state __initdata = PM_SUSPEND_ON;
700
701 static char warn_bad_state[] __initdata =
702 KERN_WARNING "PM: can't test '%s' suspend state\n";
703
setup_test_suspend(char * value)704 static int __init setup_test_suspend(char *value)
705 {
706 unsigned i;
707
708 /* "=mem" ==> "mem" */
709 value++;
710 for (i = 0; i < PM_SUSPEND_MAX; i++) {
711 if (!pm_states[i])
712 continue;
713 if (strcmp(pm_states[i], value) != 0)
714 continue;
715 test_state = (__force suspend_state_t) i;
716 return 0;
717 }
718 printk(warn_bad_state, value);
719 return 0;
720 }
721 __setup("test_suspend", setup_test_suspend);
722
test_suspend(void)723 static int __init test_suspend(void)
724 {
725 static char warn_no_rtc[] __initdata =
726 KERN_WARNING "PM: no wakealarm-capable RTC driver is ready\n";
727
728 char *pony = NULL;
729 struct rtc_device *rtc = NULL;
730
731 /* PM is initialized by now; is that state testable? */
732 if (test_state == PM_SUSPEND_ON)
733 goto done;
734 if (!valid_state(test_state)) {
735 printk(warn_bad_state, pm_states[test_state]);
736 goto done;
737 }
738
739 /* RTCs have initialized by now too ... can we use one? */
740 class_find_device(rtc_class, NULL, &pony, has_wakealarm);
741 if (pony)
742 rtc = rtc_class_open(pony);
743 if (!rtc) {
744 printk(warn_no_rtc);
745 goto done;
746 }
747
748 /* go for it */
749 test_wakealarm(rtc, test_state);
750 rtc_class_close(rtc);
751 done:
752 return 0;
753 }
754 late_initcall(test_suspend);
755
756 #endif /* CONFIG_PM_TEST_SUSPEND */
757