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/export.h>
12 #include <linux/kobject.h>
13 #include <linux/string.h>
14 #include <linux/pm-trace.h>
15 #include <linux/workqueue.h>
16 #include <linux/debugfs.h>
17 #include <linux/seq_file.h>
18
19 #include "power.h"
20
21 DEFINE_MUTEX(pm_mutex);
22
23 #ifdef CONFIG_PM_SLEEP
24
25 /* Routines for PM-transition notifications */
26
27 static BLOCKING_NOTIFIER_HEAD(pm_chain_head);
28
register_pm_notifier(struct notifier_block * nb)29 int register_pm_notifier(struct notifier_block *nb)
30 {
31 return blocking_notifier_chain_register(&pm_chain_head, nb);
32 }
33 EXPORT_SYMBOL_GPL(register_pm_notifier);
34
unregister_pm_notifier(struct notifier_block * nb)35 int unregister_pm_notifier(struct notifier_block *nb)
36 {
37 return blocking_notifier_chain_unregister(&pm_chain_head, nb);
38 }
39 EXPORT_SYMBOL_GPL(unregister_pm_notifier);
40
__pm_notifier_call_chain(unsigned long val,int nr_to_call,int * nr_calls)41 int __pm_notifier_call_chain(unsigned long val, int nr_to_call, int *nr_calls)
42 {
43 int ret;
44
45 ret = __blocking_notifier_call_chain(&pm_chain_head, val, NULL,
46 nr_to_call, nr_calls);
47
48 return notifier_to_errno(ret);
49 }
pm_notifier_call_chain(unsigned long val)50 int pm_notifier_call_chain(unsigned long val)
51 {
52 return __pm_notifier_call_chain(val, -1, NULL);
53 }
54
55 /* If set, devices may be suspended and resumed asynchronously. */
56 int pm_async_enabled = 1;
57
pm_async_show(struct kobject * kobj,struct kobj_attribute * attr,char * buf)58 static ssize_t pm_async_show(struct kobject *kobj, struct kobj_attribute *attr,
59 char *buf)
60 {
61 return sprintf(buf, "%d\n", pm_async_enabled);
62 }
63
pm_async_store(struct kobject * kobj,struct kobj_attribute * attr,const char * buf,size_t n)64 static ssize_t pm_async_store(struct kobject *kobj, struct kobj_attribute *attr,
65 const char *buf, size_t n)
66 {
67 unsigned long val;
68
69 if (kstrtoul(buf, 10, &val))
70 return -EINVAL;
71
72 if (val > 1)
73 return -EINVAL;
74
75 pm_async_enabled = val;
76 return n;
77 }
78
79 power_attr(pm_async);
80
81 #ifdef CONFIG_PM_DEBUG
82 int pm_test_level = TEST_NONE;
83
84 static const char * const pm_tests[__TEST_AFTER_LAST] = {
85 [TEST_NONE] = "none",
86 [TEST_CORE] = "core",
87 [TEST_CPUS] = "processors",
88 [TEST_PLATFORM] = "platform",
89 [TEST_DEVICES] = "devices",
90 [TEST_FREEZER] = "freezer",
91 };
92
pm_test_show(struct kobject * kobj,struct kobj_attribute * attr,char * buf)93 static ssize_t pm_test_show(struct kobject *kobj, struct kobj_attribute *attr,
94 char *buf)
95 {
96 char *s = buf;
97 int level;
98
99 for (level = TEST_FIRST; level <= TEST_MAX; level++)
100 if (pm_tests[level]) {
101 if (level == pm_test_level)
102 s += sprintf(s, "[%s] ", pm_tests[level]);
103 else
104 s += sprintf(s, "%s ", pm_tests[level]);
105 }
106
107 if (s != buf)
108 /* convert the last space to a newline */
109 *(s-1) = '\n';
110
111 return (s - buf);
112 }
113
pm_test_store(struct kobject * kobj,struct kobj_attribute * attr,const char * buf,size_t n)114 static ssize_t pm_test_store(struct kobject *kobj, struct kobj_attribute *attr,
115 const char *buf, size_t n)
116 {
117 const char * const *s;
118 int level;
119 char *p;
120 int len;
121 int error = -EINVAL;
122
123 p = memchr(buf, '\n', n);
124 len = p ? p - buf : n;
125
126 lock_system_sleep();
127
128 level = TEST_FIRST;
129 for (s = &pm_tests[level]; level <= TEST_MAX; s++, level++)
130 if (*s && len == strlen(*s) && !strncmp(buf, *s, len)) {
131 pm_test_level = level;
132 error = 0;
133 break;
134 }
135
136 unlock_system_sleep();
137
138 return error ? error : n;
139 }
140
141 power_attr(pm_test);
142 #endif /* CONFIG_PM_DEBUG */
143
144 #ifdef CONFIG_DEBUG_FS
suspend_step_name(enum suspend_stat_step step)145 static char *suspend_step_name(enum suspend_stat_step step)
146 {
147 switch (step) {
148 case SUSPEND_FREEZE:
149 return "freeze";
150 case SUSPEND_PREPARE:
151 return "prepare";
152 case SUSPEND_SUSPEND:
153 return "suspend";
154 case SUSPEND_SUSPEND_NOIRQ:
155 return "suspend_noirq";
156 case SUSPEND_RESUME_NOIRQ:
157 return "resume_noirq";
158 case SUSPEND_RESUME:
159 return "resume";
160 default:
161 return "";
162 }
163 }
164
suspend_stats_show(struct seq_file * s,void * unused)165 static int suspend_stats_show(struct seq_file *s, void *unused)
166 {
167 int i, index, last_dev, last_errno, last_step;
168
169 last_dev = suspend_stats.last_failed_dev + REC_FAILED_NUM - 1;
170 last_dev %= REC_FAILED_NUM;
171 last_errno = suspend_stats.last_failed_errno + REC_FAILED_NUM - 1;
172 last_errno %= REC_FAILED_NUM;
173 last_step = suspend_stats.last_failed_step + REC_FAILED_NUM - 1;
174 last_step %= REC_FAILED_NUM;
175 seq_printf(s, "%s: %d\n%s: %d\n%s: %d\n%s: %d\n%s: %d\n"
176 "%s: %d\n%s: %d\n%s: %d\n%s: %d\n%s: %d\n",
177 "success", suspend_stats.success,
178 "fail", suspend_stats.fail,
179 "failed_freeze", suspend_stats.failed_freeze,
180 "failed_prepare", suspend_stats.failed_prepare,
181 "failed_suspend", suspend_stats.failed_suspend,
182 "failed_suspend_late",
183 suspend_stats.failed_suspend_late,
184 "failed_suspend_noirq",
185 suspend_stats.failed_suspend_noirq,
186 "failed_resume", suspend_stats.failed_resume,
187 "failed_resume_early",
188 suspend_stats.failed_resume_early,
189 "failed_resume_noirq",
190 suspend_stats.failed_resume_noirq);
191 seq_printf(s, "failures:\n last_failed_dev:\t%-s\n",
192 suspend_stats.failed_devs[last_dev]);
193 for (i = 1; i < REC_FAILED_NUM; i++) {
194 index = last_dev + REC_FAILED_NUM - i;
195 index %= REC_FAILED_NUM;
196 seq_printf(s, "\t\t\t%-s\n",
197 suspend_stats.failed_devs[index]);
198 }
199 seq_printf(s, " last_failed_errno:\t%-d\n",
200 suspend_stats.errno[last_errno]);
201 for (i = 1; i < REC_FAILED_NUM; i++) {
202 index = last_errno + REC_FAILED_NUM - i;
203 index %= REC_FAILED_NUM;
204 seq_printf(s, "\t\t\t%-d\n",
205 suspend_stats.errno[index]);
206 }
207 seq_printf(s, " last_failed_step:\t%-s\n",
208 suspend_step_name(
209 suspend_stats.failed_steps[last_step]));
210 for (i = 1; i < REC_FAILED_NUM; i++) {
211 index = last_step + REC_FAILED_NUM - i;
212 index %= REC_FAILED_NUM;
213 seq_printf(s, "\t\t\t%-s\n",
214 suspend_step_name(
215 suspend_stats.failed_steps[index]));
216 }
217
218 return 0;
219 }
220
suspend_stats_open(struct inode * inode,struct file * file)221 static int suspend_stats_open(struct inode *inode, struct file *file)
222 {
223 return single_open(file, suspend_stats_show, NULL);
224 }
225
226 static const struct file_operations suspend_stats_operations = {
227 .open = suspend_stats_open,
228 .read = seq_read,
229 .llseek = seq_lseek,
230 .release = single_release,
231 };
232
pm_debugfs_init(void)233 static int __init pm_debugfs_init(void)
234 {
235 debugfs_create_file("suspend_stats", S_IFREG | S_IRUGO,
236 NULL, NULL, &suspend_stats_operations);
237 return 0;
238 }
239
240 late_initcall(pm_debugfs_init);
241 #endif /* CONFIG_DEBUG_FS */
242
243 #endif /* CONFIG_PM_SLEEP */
244
245 #ifdef CONFIG_PM_SLEEP_DEBUG
246 /*
247 * pm_print_times: print time taken by devices to suspend and resume.
248 *
249 * show() returns whether printing of suspend and resume times is enabled.
250 * store() accepts 0 or 1. 0 disables printing and 1 enables it.
251 */
252 bool pm_print_times_enabled;
253
pm_print_times_show(struct kobject * kobj,struct kobj_attribute * attr,char * buf)254 static ssize_t pm_print_times_show(struct kobject *kobj,
255 struct kobj_attribute *attr, char *buf)
256 {
257 return sprintf(buf, "%d\n", pm_print_times_enabled);
258 }
259
pm_print_times_store(struct kobject * kobj,struct kobj_attribute * attr,const char * buf,size_t n)260 static ssize_t pm_print_times_store(struct kobject *kobj,
261 struct kobj_attribute *attr,
262 const char *buf, size_t n)
263 {
264 unsigned long val;
265
266 if (kstrtoul(buf, 10, &val))
267 return -EINVAL;
268
269 if (val > 1)
270 return -EINVAL;
271
272 pm_print_times_enabled = !!val;
273 return n;
274 }
275
276 power_attr(pm_print_times);
277
pm_print_times_init(void)278 static inline void pm_print_times_init(void)
279 {
280 pm_print_times_enabled = !!initcall_debug;
281 }
282
pm_wakeup_irq_show(struct kobject * kobj,struct kobj_attribute * attr,char * buf)283 static ssize_t pm_wakeup_irq_show(struct kobject *kobj,
284 struct kobj_attribute *attr,
285 char *buf)
286 {
287 return pm_wakeup_irq ? sprintf(buf, "%u\n", pm_wakeup_irq) : -ENODATA;
288 }
289
pm_wakeup_irq_store(struct kobject * kobj,struct kobj_attribute * attr,const char * buf,size_t n)290 static ssize_t pm_wakeup_irq_store(struct kobject *kobj,
291 struct kobj_attribute *attr,
292 const char *buf, size_t n)
293 {
294 return -EINVAL;
295 }
296 power_attr(pm_wakeup_irq);
297
298 #else /* !CONFIG_PM_SLEEP_DEBUG */
pm_print_times_init(void)299 static inline void pm_print_times_init(void) {}
300 #endif /* CONFIG_PM_SLEEP_DEBUG */
301
302 struct kobject *power_kobj;
303
304 /**
305 * state - control system sleep states.
306 *
307 * show() returns available sleep state labels, which may be "mem", "standby",
308 * "freeze" and "disk" (hibernation). See Documentation/power/states.txt for a
309 * description of what they mean.
310 *
311 * store() accepts one of those strings, translates it into the proper
312 * enumerated value, and initiates a suspend transition.
313 */
state_show(struct kobject * kobj,struct kobj_attribute * attr,char * buf)314 static ssize_t state_show(struct kobject *kobj, struct kobj_attribute *attr,
315 char *buf)
316 {
317 char *s = buf;
318 #ifdef CONFIG_SUSPEND
319 suspend_state_t i;
320
321 for (i = PM_SUSPEND_MIN; i < PM_SUSPEND_MAX; i++)
322 if (pm_states[i])
323 s += sprintf(s,"%s ", pm_states[i]);
324
325 #endif
326 if (hibernation_available())
327 s += sprintf(s, "disk ");
328 if (s != buf)
329 /* convert the last space to a newline */
330 *(s-1) = '\n';
331 return (s - buf);
332 }
333
decode_state(const char * buf,size_t n)334 static suspend_state_t decode_state(const char *buf, size_t n)
335 {
336 #ifdef CONFIG_SUSPEND
337 suspend_state_t state;
338 #endif
339 char *p;
340 int len;
341
342 p = memchr(buf, '\n', n);
343 len = p ? p - buf : n;
344
345 /* Check hibernation first. */
346 if (len == 4 && !strncmp(buf, "disk", len))
347 return PM_SUSPEND_MAX;
348
349 #ifdef CONFIG_SUSPEND
350 for (state = PM_SUSPEND_MIN; state < PM_SUSPEND_MAX; state++) {
351 const char *label = pm_states[state];
352
353 if (label && len == strlen(label) && !strncmp(buf, label, len))
354 return state;
355 }
356 #endif
357
358 return PM_SUSPEND_ON;
359 }
360
state_store(struct kobject * kobj,struct kobj_attribute * attr,const char * buf,size_t n)361 static ssize_t state_store(struct kobject *kobj, struct kobj_attribute *attr,
362 const char *buf, size_t n)
363 {
364 suspend_state_t state;
365 int error;
366
367 error = pm_autosleep_lock();
368 if (error)
369 return error;
370
371 if (pm_autosleep_state() > PM_SUSPEND_ON) {
372 error = -EBUSY;
373 goto out;
374 }
375
376 state = decode_state(buf, n);
377 if (state < PM_SUSPEND_MAX)
378 error = pm_suspend(state);
379 else if (state == PM_SUSPEND_MAX)
380 error = hibernate();
381 else
382 error = -EINVAL;
383
384 out:
385 pm_autosleep_unlock();
386 return error ? error : n;
387 }
388
389 power_attr(state);
390
391 #ifdef CONFIG_PM_SLEEP
392 /*
393 * The 'wakeup_count' attribute, along with the functions defined in
394 * drivers/base/power/wakeup.c, provides a means by which wakeup events can be
395 * handled in a non-racy way.
396 *
397 * If a wakeup event occurs when the system is in a sleep state, it simply is
398 * woken up. In turn, if an event that would wake the system up from a sleep
399 * state occurs when it is undergoing a transition to that sleep state, the
400 * transition should be aborted. Moreover, if such an event occurs when the
401 * system is in the working state, an attempt to start a transition to the
402 * given sleep state should fail during certain period after the detection of
403 * the event. Using the 'state' attribute alone is not sufficient to satisfy
404 * these requirements, because a wakeup event may occur exactly when 'state'
405 * is being written to and may be delivered to user space right before it is
406 * frozen, so the event will remain only partially processed until the system is
407 * woken up by another event. In particular, it won't cause the transition to
408 * a sleep state to be aborted.
409 *
410 * This difficulty may be overcome if user space uses 'wakeup_count' before
411 * writing to 'state'. It first should read from 'wakeup_count' and store
412 * the read value. Then, after carrying out its own preparations for the system
413 * transition to a sleep state, it should write the stored value to
414 * 'wakeup_count'. If that fails, at least one wakeup event has occurred since
415 * 'wakeup_count' was read and 'state' should not be written to. Otherwise, it
416 * is allowed to write to 'state', but the transition will be aborted if there
417 * are any wakeup events detected after 'wakeup_count' was written to.
418 */
419
wakeup_count_show(struct kobject * kobj,struct kobj_attribute * attr,char * buf)420 static ssize_t wakeup_count_show(struct kobject *kobj,
421 struct kobj_attribute *attr,
422 char *buf)
423 {
424 unsigned int val;
425
426 return pm_get_wakeup_count(&val, true) ?
427 sprintf(buf, "%u\n", val) : -EINTR;
428 }
429
wakeup_count_store(struct kobject * kobj,struct kobj_attribute * attr,const char * buf,size_t n)430 static ssize_t wakeup_count_store(struct kobject *kobj,
431 struct kobj_attribute *attr,
432 const char *buf, size_t n)
433 {
434 unsigned int val;
435 int error;
436
437 error = pm_autosleep_lock();
438 if (error)
439 return error;
440
441 if (pm_autosleep_state() > PM_SUSPEND_ON) {
442 error = -EBUSY;
443 goto out;
444 }
445
446 error = -EINVAL;
447 if (sscanf(buf, "%u", &val) == 1) {
448 if (pm_save_wakeup_count(val))
449 error = n;
450 else
451 pm_print_active_wakeup_sources();
452 }
453
454 out:
455 pm_autosleep_unlock();
456 return error;
457 }
458
459 power_attr(wakeup_count);
460
461 #ifdef CONFIG_PM_AUTOSLEEP
autosleep_show(struct kobject * kobj,struct kobj_attribute * attr,char * buf)462 static ssize_t autosleep_show(struct kobject *kobj,
463 struct kobj_attribute *attr,
464 char *buf)
465 {
466 suspend_state_t state = pm_autosleep_state();
467
468 if (state == PM_SUSPEND_ON)
469 return sprintf(buf, "off\n");
470
471 #ifdef CONFIG_SUSPEND
472 if (state < PM_SUSPEND_MAX)
473 return sprintf(buf, "%s\n", pm_states[state] ?
474 pm_states[state] : "error");
475 #endif
476 #ifdef CONFIG_HIBERNATION
477 return sprintf(buf, "disk\n");
478 #else
479 return sprintf(buf, "error");
480 #endif
481 }
482
autosleep_store(struct kobject * kobj,struct kobj_attribute * attr,const char * buf,size_t n)483 static ssize_t autosleep_store(struct kobject *kobj,
484 struct kobj_attribute *attr,
485 const char *buf, size_t n)
486 {
487 suspend_state_t state = decode_state(buf, n);
488 int error;
489
490 if (state == PM_SUSPEND_ON
491 && strcmp(buf, "off") && strcmp(buf, "off\n"))
492 return -EINVAL;
493
494 error = pm_autosleep_set_state(state);
495 return error ? error : n;
496 }
497
498 power_attr(autosleep);
499 #endif /* CONFIG_PM_AUTOSLEEP */
500
501 #ifdef CONFIG_PM_WAKELOCKS
wake_lock_show(struct kobject * kobj,struct kobj_attribute * attr,char * buf)502 static ssize_t wake_lock_show(struct kobject *kobj,
503 struct kobj_attribute *attr,
504 char *buf)
505 {
506 return pm_show_wakelocks(buf, true);
507 }
508
wake_lock_store(struct kobject * kobj,struct kobj_attribute * attr,const char * buf,size_t n)509 static ssize_t wake_lock_store(struct kobject *kobj,
510 struct kobj_attribute *attr,
511 const char *buf, size_t n)
512 {
513 int error = pm_wake_lock(buf);
514 return error ? error : n;
515 }
516
517 power_attr(wake_lock);
518
wake_unlock_show(struct kobject * kobj,struct kobj_attribute * attr,char * buf)519 static ssize_t wake_unlock_show(struct kobject *kobj,
520 struct kobj_attribute *attr,
521 char *buf)
522 {
523 return pm_show_wakelocks(buf, false);
524 }
525
wake_unlock_store(struct kobject * kobj,struct kobj_attribute * attr,const char * buf,size_t n)526 static ssize_t wake_unlock_store(struct kobject *kobj,
527 struct kobj_attribute *attr,
528 const char *buf, size_t n)
529 {
530 int error = pm_wake_unlock(buf);
531 return error ? error : n;
532 }
533
534 power_attr(wake_unlock);
535
536 #endif /* CONFIG_PM_WAKELOCKS */
537 #endif /* CONFIG_PM_SLEEP */
538
539 #ifdef CONFIG_PM_TRACE
540 int pm_trace_enabled;
541
pm_trace_show(struct kobject * kobj,struct kobj_attribute * attr,char * buf)542 static ssize_t pm_trace_show(struct kobject *kobj, struct kobj_attribute *attr,
543 char *buf)
544 {
545 return sprintf(buf, "%d\n", pm_trace_enabled);
546 }
547
548 static ssize_t
pm_trace_store(struct kobject * kobj,struct kobj_attribute * attr,const char * buf,size_t n)549 pm_trace_store(struct kobject *kobj, struct kobj_attribute *attr,
550 const char *buf, size_t n)
551 {
552 int val;
553
554 if (sscanf(buf, "%d", &val) == 1) {
555 pm_trace_enabled = !!val;
556 if (pm_trace_enabled) {
557 pr_warn("PM: Enabling pm_trace changes system date and time during resume.\n"
558 "PM: Correct system time has to be restored manually after resume.\n");
559 }
560 return n;
561 }
562 return -EINVAL;
563 }
564
565 power_attr(pm_trace);
566
pm_trace_dev_match_show(struct kobject * kobj,struct kobj_attribute * attr,char * buf)567 static ssize_t pm_trace_dev_match_show(struct kobject *kobj,
568 struct kobj_attribute *attr,
569 char *buf)
570 {
571 return show_trace_dev_match(buf, PAGE_SIZE);
572 }
573
574 static ssize_t
pm_trace_dev_match_store(struct kobject * kobj,struct kobj_attribute * attr,const char * buf,size_t n)575 pm_trace_dev_match_store(struct kobject *kobj, struct kobj_attribute *attr,
576 const char *buf, size_t n)
577 {
578 return -EINVAL;
579 }
580
581 power_attr(pm_trace_dev_match);
582
583 #endif /* CONFIG_PM_TRACE */
584
585 #ifdef CONFIG_FREEZER
pm_freeze_timeout_show(struct kobject * kobj,struct kobj_attribute * attr,char * buf)586 static ssize_t pm_freeze_timeout_show(struct kobject *kobj,
587 struct kobj_attribute *attr, char *buf)
588 {
589 return sprintf(buf, "%u\n", freeze_timeout_msecs);
590 }
591
pm_freeze_timeout_store(struct kobject * kobj,struct kobj_attribute * attr,const char * buf,size_t n)592 static ssize_t pm_freeze_timeout_store(struct kobject *kobj,
593 struct kobj_attribute *attr,
594 const char *buf, size_t n)
595 {
596 unsigned long val;
597
598 if (kstrtoul(buf, 10, &val))
599 return -EINVAL;
600
601 freeze_timeout_msecs = val;
602 return n;
603 }
604
605 power_attr(pm_freeze_timeout);
606
607 #endif /* CONFIG_FREEZER*/
608
609 static struct attribute * g[] = {
610 &state_attr.attr,
611 #ifdef CONFIG_PM_TRACE
612 &pm_trace_attr.attr,
613 &pm_trace_dev_match_attr.attr,
614 #endif
615 #ifdef CONFIG_PM_SLEEP
616 &pm_async_attr.attr,
617 &wakeup_count_attr.attr,
618 #ifdef CONFIG_PM_AUTOSLEEP
619 &autosleep_attr.attr,
620 #endif
621 #ifdef CONFIG_PM_WAKELOCKS
622 &wake_lock_attr.attr,
623 &wake_unlock_attr.attr,
624 #endif
625 #ifdef CONFIG_PM_DEBUG
626 &pm_test_attr.attr,
627 #endif
628 #ifdef CONFIG_PM_SLEEP_DEBUG
629 &pm_print_times_attr.attr,
630 &pm_wakeup_irq_attr.attr,
631 #endif
632 #endif
633 #ifdef CONFIG_FREEZER
634 &pm_freeze_timeout_attr.attr,
635 #endif
636 NULL,
637 };
638
639 static struct attribute_group attr_group = {
640 .attrs = g,
641 };
642
643 struct workqueue_struct *pm_wq;
644 EXPORT_SYMBOL_GPL(pm_wq);
645
pm_start_workqueue(void)646 static int __init pm_start_workqueue(void)
647 {
648 pm_wq = alloc_workqueue("pm", WQ_FREEZABLE, 0);
649
650 return pm_wq ? 0 : -ENOMEM;
651 }
652
pm_init(void)653 static int __init pm_init(void)
654 {
655 int error = pm_start_workqueue();
656 if (error)
657 return error;
658 hibernate_image_size_init();
659 hibernate_reserved_size_init();
660 power_kobj = kobject_create_and_add("power", NULL);
661 if (!power_kobj)
662 return -ENOMEM;
663 error = sysfs_create_group(power_kobj, &attr_group);
664 if (error)
665 return error;
666 pm_print_times_init();
667 return pm_autosleep_init();
668 }
669
670 core_initcall(pm_init);
671