Merge tag 'riscv-for-linus-6.16-rc5' of git://git.kernel.org/pub/scm/linux/kernel...
[linux-2.6-block.git] / kernel / power / main.c
CommitLineData
55716d26 1// SPDX-License-Identifier: GPL-2.0-only
1da177e4
LT
2/*
3 * kernel/power/main.c - PM subsystem core functionality.
4 *
5 * Copyright (c) 2003 Patrick Mochel
6 * Copyright (c) 2003 Open Source Development Lab
1da177e4
LT
7 */
8
b52124a7 9#include <linux/acpi.h>
6e5fdeed 10#include <linux/export.h>
1da177e4
LT
11#include <linux/kobject.h>
12#include <linux/string.h>
431d452a 13#include <linux/pm-trace.h>
5e928f77 14#include <linux/workqueue.h>
2a77c46d
SL
15#include <linux/debugfs.h>
16#include <linux/seq_file.h>
55f2503c 17#include <linux/suspend.h>
b5dee313 18#include <linux/syscalls.h>
f49249d5 19#include <linux/pm_runtime.h>
1da177e4
LT
20
21#include "power.h"
22
cd51e61c 23#ifdef CONFIG_PM_SLEEP
07f44ac3
KW
24/*
25 * The following functions are used by the suspend/hibernate code to temporarily
26 * change gfp_allowed_mask in order to avoid using I/O during memory allocations
27 * while devices are suspended. To avoid races with the suspend/hibernate code,
28 * they should always be called with system_transition_mutex held
29 * (gfp_allowed_mask also should only be modified with system_transition_mutex
30 * held, unless the suspend/hibernate code is guaranteed not to run in parallel
31 * with that modification).
32 */
33static gfp_t saved_gfp_mask;
34
35void pm_restore_gfp_mask(void)
36{
37 WARN_ON(!mutex_is_locked(&system_transition_mutex));
38 if (saved_gfp_mask) {
39 gfp_allowed_mask = saved_gfp_mask;
40 saved_gfp_mask = 0;
41 }
42}
43
44void pm_restrict_gfp_mask(void)
45{
46 WARN_ON(!mutex_is_locked(&system_transition_mutex));
47 WARN_ON(saved_gfp_mask);
48 saved_gfp_mask = gfp_allowed_mask;
49 gfp_allowed_mask &= ~(__GFP_IO | __GFP_FS);
50}
cd51e61c 51
5950e5d5 52unsigned int lock_system_sleep(void)
4bf236a3 53{
5950e5d5 54 unsigned int flags = current->flags;
f5d39b02 55 current->flags |= PF_NOFREEZE;
55f2503c 56 mutex_lock(&system_transition_mutex);
5950e5d5 57 return flags;
4bf236a3
BVA
58}
59EXPORT_SYMBOL_GPL(lock_system_sleep);
60
5950e5d5 61void unlock_system_sleep(unsigned int flags)
4bf236a3 62{
f5d39b02
PZ
63 if (!(flags & PF_NOFREEZE))
64 current->flags &= ~PF_NOFREEZE;
55f2503c 65 mutex_unlock(&system_transition_mutex);
4bf236a3
BVA
66}
67EXPORT_SYMBOL_GPL(unlock_system_sleep);
68
b5dee313
HP
69void ksys_sync_helper(void)
70{
c64546b1
HP
71 ktime_t start;
72 long elapsed_msecs;
73
74 start = ktime_get();
b5dee313 75 ksys_sync();
c64546b1
HP
76 elapsed_msecs = ktime_to_ms(ktime_sub(ktime_get(), start));
77 pr_info("Filesystems sync: %ld.%03ld seconds\n",
78 elapsed_msecs / MSEC_PER_SEC, elapsed_msecs % MSEC_PER_SEC);
b5dee313
HP
79}
80EXPORT_SYMBOL_GPL(ksys_sync_helper);
81
82525756
AS
82/* Routines for PM-transition notifications */
83
84static BLOCKING_NOTIFIER_HEAD(pm_chain_head);
85
86int register_pm_notifier(struct notifier_block *nb)
87{
88 return blocking_notifier_chain_register(&pm_chain_head, nb);
89}
90EXPORT_SYMBOL_GPL(register_pm_notifier);
91
92int unregister_pm_notifier(struct notifier_block *nb)
93{
94 return blocking_notifier_chain_unregister(&pm_chain_head, nb);
95}
96EXPORT_SYMBOL_GPL(unregister_pm_notifier);
97
70d93298 98int pm_notifier_call_chain_robust(unsigned long val_up, unsigned long val_down)
82525756 99{
ea00f4f4
LW
100 int ret;
101
70d93298 102 ret = blocking_notifier_call_chain_robust(&pm_chain_head, val_up, val_down, NULL);
f0c077a8
AM
103
104 return notifier_to_errno(ret);
82525756 105}
70d93298 106
ea00f4f4
LW
107int pm_notifier_call_chain(unsigned long val)
108{
70d93298 109 return blocking_notifier_call_chain(&pm_chain_head, val, NULL);
ea00f4f4 110}
82525756 111
0e06b4a8
RW
112/* If set, devices may be suspended and resumed asynchronously. */
113int pm_async_enabled = 1;
114
115static ssize_t pm_async_show(struct kobject *kobj, struct kobj_attribute *attr,
116 char *buf)
117{
a712f03f 118 return sysfs_emit(buf, "%d\n", pm_async_enabled);
0e06b4a8
RW
119}
120
121static ssize_t pm_async_store(struct kobject *kobj, struct kobj_attribute *attr,
122 const char *buf, size_t n)
123{
124 unsigned long val;
125
883ee4f7 126 if (kstrtoul(buf, 10, &val))
0e06b4a8
RW
127 return -EINVAL;
128
129 if (val > 1)
130 return -EINVAL;
131
132 pm_async_enabled = val;
133 return n;
134}
135
136power_attr(pm_async);
137
406e7938
RW
138#ifdef CONFIG_SUSPEND
139static ssize_t mem_sleep_show(struct kobject *kobj, struct kobj_attribute *attr,
140 char *buf)
141{
a712f03f 142 ssize_t count = 0;
406e7938
RW
143 suspend_state_t i;
144
9ea4dcf4
DW
145 for (i = PM_SUSPEND_MIN; i < PM_SUSPEND_MAX; i++) {
146 if (i >= PM_SUSPEND_MEM && cxl_mem_active())
147 continue;
406e7938
RW
148 if (mem_sleep_states[i]) {
149 const char *label = mem_sleep_states[i];
150
151 if (mem_sleep_current == i)
a712f03f 152 count += sysfs_emit_at(buf, count, "[%s] ", label);
406e7938 153 else
a712f03f 154 count += sysfs_emit_at(buf, count, "%s ", label);
406e7938 155 }
9ea4dcf4 156 }
406e7938
RW
157
158 /* Convert the last space to a newline if needed. */
a712f03f
XL
159 if (count > 0)
160 buf[count - 1] = '\n';
406e7938 161
a712f03f 162 return count;
406e7938
RW
163}
164
165static suspend_state_t decode_suspend_state(const char *buf, size_t n)
166{
167 suspend_state_t state;
168 char *p;
169 int len;
170
171 p = memchr(buf, '\n', n);
172 len = p ? p - buf : n;
173
174 for (state = PM_SUSPEND_MIN; state < PM_SUSPEND_MAX; state++) {
175 const char *label = mem_sleep_states[state];
176
177 if (label && len == strlen(label) && !strncmp(buf, label, len))
178 return state;
179 }
180
181 return PM_SUSPEND_ON;
182}
183
184static ssize_t mem_sleep_store(struct kobject *kobj, struct kobj_attribute *attr,
185 const char *buf, size_t n)
186{
187 suspend_state_t state;
188 int error;
189
190 error = pm_autosleep_lock();
191 if (error)
192 return error;
193
194 if (pm_autosleep_state() > PM_SUSPEND_ON) {
195 error = -EBUSY;
196 goto out;
197 }
198
199 state = decode_suspend_state(buf, n);
200 if (state < PM_SUSPEND_MAX && state > PM_SUSPEND_ON)
201 mem_sleep_current = state;
202 else
203 error = -EINVAL;
204
205 out:
206 pm_autosleep_unlock();
207 return error ? error : n;
208}
209
210power_attr(mem_sleep);
c052bf82
JM
211
212/*
213 * sync_on_suspend: invoke ksys_sync_helper() before suspend.
214 *
215 * show() returns whether ksys_sync_helper() is invoked before suspend.
216 * store() accepts 0 or 1. 0 disables ksys_sync_helper() and 1 enables it.
217 */
218bool sync_on_suspend_enabled = !IS_ENABLED(CONFIG_SUSPEND_SKIP_SYNC);
219
220static ssize_t sync_on_suspend_show(struct kobject *kobj,
221 struct kobj_attribute *attr, char *buf)
222{
a712f03f 223 return sysfs_emit(buf, "%d\n", sync_on_suspend_enabled);
c052bf82
JM
224}
225
226static ssize_t sync_on_suspend_store(struct kobject *kobj,
227 struct kobj_attribute *attr,
228 const char *buf, size_t n)
229{
230 unsigned long val;
231
232 if (kstrtoul(buf, 10, &val))
233 return -EINVAL;
234
235 if (val > 1)
236 return -EINVAL;
237
238 sync_on_suspend_enabled = !!val;
239 return n;
240}
241
242power_attr(sync_on_suspend);
406e7938
RW
243#endif /* CONFIG_SUSPEND */
244
e516a1db 245#ifdef CONFIG_PM_SLEEP_DEBUG
0e7d56e3
RW
246int pm_test_level = TEST_NONE;
247
0e7d56e3
RW
248static const char * const pm_tests[__TEST_AFTER_LAST] = {
249 [TEST_NONE] = "none",
250 [TEST_CORE] = "core",
251 [TEST_CPUS] = "processors",
252 [TEST_PLATFORM] = "platform",
253 [TEST_DEVICES] = "devices",
254 [TEST_FREEZER] = "freezer",
255};
256
039a75c6
RW
257static ssize_t pm_test_show(struct kobject *kobj, struct kobj_attribute *attr,
258 char *buf)
0e7d56e3 259{
a712f03f 260 ssize_t count = 0;
0e7d56e3
RW
261 int level;
262
263 for (level = TEST_FIRST; level <= TEST_MAX; level++)
264 if (pm_tests[level]) {
265 if (level == pm_test_level)
a712f03f 266 count += sysfs_emit_at(buf, count, "[%s] ", pm_tests[level]);
0e7d56e3 267 else
a712f03f 268 count += sysfs_emit_at(buf, count, "%s ", pm_tests[level]);
0e7d56e3
RW
269 }
270
a712f03f
XL
271 /* Convert the last space to a newline if needed. */
272 if (count > 0)
273 buf[count - 1] = '\n';
0e7d56e3 274
a712f03f 275 return count;
0e7d56e3
RW
276}
277
039a75c6
RW
278static ssize_t pm_test_store(struct kobject *kobj, struct kobj_attribute *attr,
279 const char *buf, size_t n)
0e7d56e3 280{
5950e5d5 281 unsigned int sleep_flags;
0e7d56e3 282 const char * const *s;
5950e5d5 283 int error = -EINVAL;
0e7d56e3
RW
284 int level;
285 char *p;
286 int len;
0e7d56e3
RW
287
288 p = memchr(buf, '\n', n);
289 len = p ? p - buf : n;
290
5950e5d5 291 sleep_flags = lock_system_sleep();
0e7d56e3
RW
292
293 level = TEST_FIRST;
294 for (s = &pm_tests[level]; level <= TEST_MAX; s++, level++)
295 if (*s && len == strlen(*s) && !strncmp(buf, *s, len)) {
296 pm_test_level = level;
297 error = 0;
298 break;
299 }
300
5950e5d5 301 unlock_system_sleep(sleep_flags);
0e7d56e3
RW
302
303 return error ? error : n;
304}
305
306power_attr(pm_test);
e516a1db 307#endif /* CONFIG_PM_SLEEP_DEBUG */
0e7d56e3 308
9ff544fa
RW
309#define SUSPEND_NR_STEPS SUSPEND_RESUME
310#define REC_FAILED_NUM 2
311
312struct suspend_stats {
313 unsigned int step_failures[SUSPEND_NR_STEPS];
314 unsigned int success;
315 unsigned int fail;
316 int last_failed_dev;
317 char failed_devs[REC_FAILED_NUM][40];
318 int last_failed_errno;
319 int errno[REC_FAILED_NUM];
320 int last_failed_step;
321 u64 last_hw_sleep;
322 u64 total_hw_sleep;
323 u64 max_hw_sleep;
324 enum suspend_stat_step failed_steps[REC_FAILED_NUM];
325};
326
327static struct suspend_stats suspend_stats;
a6d38e99 328static DEFINE_MUTEX(suspend_stats_lock);
9ff544fa
RW
329
330void dpm_save_failed_dev(const char *name)
331{
a6d38e99
RW
332 mutex_lock(&suspend_stats_lock);
333
9ff544fa
RW
334 strscpy(suspend_stats.failed_devs[suspend_stats.last_failed_dev],
335 name, sizeof(suspend_stats.failed_devs[0]));
336 suspend_stats.last_failed_dev++;
337 suspend_stats.last_failed_dev %= REC_FAILED_NUM;
a6d38e99
RW
338
339 mutex_unlock(&suspend_stats_lock);
9ff544fa
RW
340}
341
342void dpm_save_failed_step(enum suspend_stat_step step)
343{
344 suspend_stats.step_failures[step-1]++;
345 suspend_stats.failed_steps[suspend_stats.last_failed_step] = step;
346 suspend_stats.last_failed_step++;
347 suspend_stats.last_failed_step %= REC_FAILED_NUM;
348}
349
350void dpm_save_errno(int err)
351{
352 if (!err) {
353 suspend_stats.success++;
354 return;
355 }
356
357 suspend_stats.fail++;
358
359 suspend_stats.errno[suspend_stats.last_failed_errno] = err;
360 suspend_stats.last_failed_errno++;
361 suspend_stats.last_failed_errno %= REC_FAILED_NUM;
362}
363
364void pm_report_hw_sleep_time(u64 t)
365{
366 suspend_stats.last_hw_sleep = t;
367 suspend_stats.total_hw_sleep += t;
368}
369EXPORT_SYMBOL_GPL(pm_report_hw_sleep_time);
370
371void pm_report_max_hw_sleep(u64 t)
372{
373 suspend_stats.max_hw_sleep = t;
374}
375EXPORT_SYMBOL_GPL(pm_report_max_hw_sleep);
376
bc88528c
RW
377static const char * const suspend_step_names[] = {
378 [SUSPEND_WORKING] = "",
379 [SUSPEND_FREEZE] = "freeze",
380 [SUSPEND_PREPARE] = "prepare",
381 [SUSPEND_SUSPEND] = "suspend",
382 [SUSPEND_SUSPEND_LATE] = "suspend_late",
383 [SUSPEND_SUSPEND_NOIRQ] = "suspend_noirq",
384 [SUSPEND_RESUME_NOIRQ] = "resume_noirq",
385 [SUSPEND_RESUME_EARLY] = "resume_early",
386 [SUSPEND_RESUME] = "resume",
387};
2a77c46d 388
b52124a7 389#define suspend_attr(_name, format_str) \
2c8db5be
KS
390static ssize_t _name##_show(struct kobject *kobj, \
391 struct kobj_attribute *attr, char *buf) \
392{ \
a712f03f 393 return sysfs_emit(buf, format_str, suspend_stats._name);\
2c8db5be
KS
394} \
395static struct kobj_attribute _name = __ATTR_RO(_name)
396
2231f78d
RW
397suspend_attr(success, "%u\n");
398suspend_attr(fail, "%u\n");
b52124a7
ML
399suspend_attr(last_hw_sleep, "%llu\n");
400suspend_attr(total_hw_sleep, "%llu\n");
401suspend_attr(max_hw_sleep, "%llu\n");
2c8db5be 402
b730bab0
RW
403#define suspend_step_attr(_name, step) \
404static ssize_t _name##_show(struct kobject *kobj, \
405 struct kobj_attribute *attr, char *buf) \
406{ \
a712f03f 407 return sysfs_emit(buf, "%u\n", \
b730bab0
RW
408 suspend_stats.step_failures[step-1]); \
409} \
410static struct kobj_attribute _name = __ATTR_RO(_name)
411
412suspend_step_attr(failed_freeze, SUSPEND_FREEZE);
413suspend_step_attr(failed_prepare, SUSPEND_PREPARE);
414suspend_step_attr(failed_suspend, SUSPEND_SUSPEND);
415suspend_step_attr(failed_suspend_late, SUSPEND_SUSPEND_LATE);
416suspend_step_attr(failed_suspend_noirq, SUSPEND_SUSPEND_NOIRQ);
417suspend_step_attr(failed_resume, SUSPEND_RESUME);
418suspend_step_attr(failed_resume_early, SUSPEND_RESUME_EARLY);
419suspend_step_attr(failed_resume_noirq, SUSPEND_RESUME_NOIRQ);
420
2c8db5be
KS
421static ssize_t last_failed_dev_show(struct kobject *kobj,
422 struct kobj_attribute *attr, char *buf)
423{
424 int index;
425 char *last_failed_dev = NULL;
426
427 index = suspend_stats.last_failed_dev + REC_FAILED_NUM - 1;
428 index %= REC_FAILED_NUM;
429 last_failed_dev = suspend_stats.failed_devs[index];
430
a712f03f 431 return sysfs_emit(buf, "%s\n", last_failed_dev);
2c8db5be
KS
432}
433static struct kobj_attribute last_failed_dev = __ATTR_RO(last_failed_dev);
434
435static ssize_t last_failed_errno_show(struct kobject *kobj,
436 struct kobj_attribute *attr, char *buf)
437{
438 int index;
439 int last_failed_errno;
440
441 index = suspend_stats.last_failed_errno + REC_FAILED_NUM - 1;
442 index %= REC_FAILED_NUM;
443 last_failed_errno = suspend_stats.errno[index];
444
a712f03f 445 return sysfs_emit(buf, "%d\n", last_failed_errno);
2c8db5be
KS
446}
447static struct kobj_attribute last_failed_errno = __ATTR_RO(last_failed_errno);
448
449static ssize_t last_failed_step_show(struct kobject *kobj,
450 struct kobj_attribute *attr, char *buf)
451{
2c8db5be 452 enum suspend_stat_step step;
bc88528c 453 int index;
2c8db5be
KS
454
455 index = suspend_stats.last_failed_step + REC_FAILED_NUM - 1;
456 index %= REC_FAILED_NUM;
457 step = suspend_stats.failed_steps[index];
2c8db5be 458
a712f03f 459 return sysfs_emit(buf, "%s\n", suspend_step_names[step]);
2c8db5be
KS
460}
461static struct kobj_attribute last_failed_step = __ATTR_RO(last_failed_step);
462
463static struct attribute *suspend_attrs[] = {
464 &success.attr,
465 &fail.attr,
466 &failed_freeze.attr,
467 &failed_prepare.attr,
468 &failed_suspend.attr,
469 &failed_suspend_late.attr,
470 &failed_suspend_noirq.attr,
471 &failed_resume.attr,
472 &failed_resume_early.attr,
473 &failed_resume_noirq.attr,
474 &last_failed_dev.attr,
475 &last_failed_errno.attr,
476 &last_failed_step.attr,
b52124a7
ML
477 &last_hw_sleep.attr,
478 &total_hw_sleep.attr,
479 &max_hw_sleep.attr,
2c8db5be
KS
480 NULL,
481};
482
b52124a7
ML
483static umode_t suspend_attr_is_visible(struct kobject *kobj, struct attribute *attr, int idx)
484{
485 if (attr != &last_hw_sleep.attr &&
486 attr != &total_hw_sleep.attr &&
487 attr != &max_hw_sleep.attr)
488 return 0444;
489
490#ifdef CONFIG_ACPI
491 if (acpi_gbl_FADT.flags & ACPI_FADT_LOW_POWER_S0)
492 return 0444;
493#endif
494 return 0;
495}
496
15560574 497static const struct attribute_group suspend_attr_group = {
2c8db5be
KS
498 .name = "suspend_stats",
499 .attrs = suspend_attrs,
b52124a7 500 .is_visible = suspend_attr_is_visible,
2c8db5be
KS
501};
502
503#ifdef CONFIG_DEBUG_FS
2a77c46d
SL
504static int suspend_stats_show(struct seq_file *s, void *unused)
505{
506 int i, index, last_dev, last_errno, last_step;
b730bab0 507 enum suspend_stat_step step;
2a77c46d
SL
508
509 last_dev = suspend_stats.last_failed_dev + REC_FAILED_NUM - 1;
510 last_dev %= REC_FAILED_NUM;
511 last_errno = suspend_stats.last_failed_errno + REC_FAILED_NUM - 1;
512 last_errno %= REC_FAILED_NUM;
513 last_step = suspend_stats.last_failed_step + REC_FAILED_NUM - 1;
514 last_step %= REC_FAILED_NUM;
b730bab0 515
2231f78d 516 seq_printf(s, "success: %u\nfail: %u\n",
b730bab0
RW
517 suspend_stats.success, suspend_stats.fail);
518
519 for (step = SUSPEND_FREEZE; step <= SUSPEND_NR_STEPS; step++)
520 seq_printf(s, "failed_%s: %u\n", suspend_step_names[step],
521 suspend_stats.step_failures[step-1]);
522
2a77c46d 523 seq_printf(s, "failures:\n last_failed_dev:\t%-s\n",
bc88528c 524 suspend_stats.failed_devs[last_dev]);
2a77c46d
SL
525 for (i = 1; i < REC_FAILED_NUM; i++) {
526 index = last_dev + REC_FAILED_NUM - i;
527 index %= REC_FAILED_NUM;
bc88528c 528 seq_printf(s, "\t\t\t%-s\n", suspend_stats.failed_devs[index]);
2a77c46d
SL
529 }
530 seq_printf(s, " last_failed_errno:\t%-d\n",
531 suspend_stats.errno[last_errno]);
532 for (i = 1; i < REC_FAILED_NUM; i++) {
533 index = last_errno + REC_FAILED_NUM - i;
534 index %= REC_FAILED_NUM;
bc88528c 535 seq_printf(s, "\t\t\t%-d\n", suspend_stats.errno[index]);
2a77c46d
SL
536 }
537 seq_printf(s, " last_failed_step:\t%-s\n",
bc88528c 538 suspend_step_names[suspend_stats.failed_steps[last_step]]);
2a77c46d
SL
539 for (i = 1; i < REC_FAILED_NUM; i++) {
540 index = last_step + REC_FAILED_NUM - i;
541 index %= REC_FAILED_NUM;
542 seq_printf(s, "\t\t\t%-s\n",
bc88528c 543 suspend_step_names[suspend_stats.failed_steps[index]]);
2a77c46d
SL
544 }
545
546 return 0;
547}
943a10f8 548DEFINE_SHOW_ATTRIBUTE(suspend_stats);
2a77c46d
SL
549
550static int __init pm_debugfs_init(void)
551{
552 debugfs_create_file("suspend_stats", S_IFREG | S_IRUGO,
943a10f8 553 NULL, NULL, &suspend_stats_fops);
2a77c46d
SL
554 return 0;
555}
556
557late_initcall(pm_debugfs_init);
558#endif /* CONFIG_DEBUG_FS */
559
f5c0ecf1
RW
560bool pm_sleep_transition_in_progress(void)
561{
562 return pm_suspend_in_progress() || hibernation_in_progress();
563}
ca123102
RW
564#endif /* CONFIG_PM_SLEEP */
565
b2df1d4f
RW
566#ifdef CONFIG_PM_SLEEP_DEBUG
567/*
568 * pm_print_times: print time taken by devices to suspend and resume.
569 *
570 * show() returns whether printing of suspend and resume times is enabled.
571 * store() accepts 0 or 1. 0 disables printing and 1 enables it.
572 */
573bool pm_print_times_enabled;
574
575static ssize_t pm_print_times_show(struct kobject *kobj,
576 struct kobj_attribute *attr, char *buf)
577{
a712f03f 578 return sysfs_emit(buf, "%d\n", pm_print_times_enabled);
b2df1d4f
RW
579}
580
581static ssize_t pm_print_times_store(struct kobject *kobj,
582 struct kobj_attribute *attr,
583 const char *buf, size_t n)
584{
585 unsigned long val;
586
587 if (kstrtoul(buf, 10, &val))
588 return -EINVAL;
589
590 if (val > 1)
591 return -EINVAL;
592
593 pm_print_times_enabled = !!val;
594 return n;
595}
596
597power_attr(pm_print_times);
598
599static inline void pm_print_times_init(void)
600{
9cd9d3fd 601 pm_print_times_enabled = initcall_debug;
b2df1d4f 602}
a6f5f0dd
AY
603
604static ssize_t pm_wakeup_irq_show(struct kobject *kobj,
605 struct kobj_attribute *attr,
606 char *buf)
607{
cb1f65c1
RW
608 if (!pm_wakeup_irq())
609 return -ENODATA;
610
a712f03f 611 return sysfs_emit(buf, "%u\n", pm_wakeup_irq());
a6f5f0dd
AY
612}
613
a1e9ca69 614power_attr_ro(pm_wakeup_irq);
a6f5f0dd 615
726fb6b4 616bool pm_debug_messages_on __read_mostly;
8d8b2441 617
cdb8c100
ML
618bool pm_debug_messages_should_print(void)
619{
f5c0ecf1 620 return pm_debug_messages_on && pm_sleep_transition_in_progress();
cdb8c100
ML
621}
622EXPORT_SYMBOL_GPL(pm_debug_messages_should_print);
623
8d8b2441
RW
624static ssize_t pm_debug_messages_show(struct kobject *kobj,
625 struct kobj_attribute *attr, char *buf)
626{
a712f03f 627 return sysfs_emit(buf, "%d\n", pm_debug_messages_on);
8d8b2441
RW
628}
629
630static ssize_t pm_debug_messages_store(struct kobject *kobj,
631 struct kobj_attribute *attr,
632 const char *buf, size_t n)
633{
634 unsigned long val;
635
636 if (kstrtoul(buf, 10, &val))
637 return -EINVAL;
638
639 if (val > 1)
640 return -EINVAL;
641
642 pm_debug_messages_on = !!val;
643 return n;
644}
645
646power_attr(pm_debug_messages);
647
db96a759
CY
648static int __init pm_debug_messages_setup(char *str)
649{
650 pm_debug_messages_on = true;
651 return 1;
652}
653__setup("pm_debug_messages", pm_debug_messages_setup);
654
819b1bb3 655#else /* !CONFIG_PM_SLEEP_DEBUG */
b2df1d4f
RW
656static inline void pm_print_times_init(void) {}
657#endif /* CONFIG_PM_SLEEP_DEBUG */
658
d76e15fb 659struct kobject *power_kobj;
1da177e4 660
dbcfa715 661/*
0399d4db 662 * state - control system sleep states.
1da177e4 663 *
0399d4db 664 * show() returns available sleep state labels, which may be "mem", "standby",
44348e8a
MCC
665 * "freeze" and "disk" (hibernation).
666 * See Documentation/admin-guide/pm/sleep-states.rst for a description of
667 * what they mean.
1da177e4 668 *
0399d4db
RW
669 * store() accepts one of those strings, translates it into the proper
670 * enumerated value, and initiates a suspend transition.
1da177e4 671 */
386f275f
KS
672static ssize_t state_show(struct kobject *kobj, struct kobj_attribute *attr,
673 char *buf)
1da177e4 674{
a712f03f 675 ssize_t count = 0;
296699de 676#ifdef CONFIG_SUSPEND
27ddcc65
RW
677 suspend_state_t i;
678
679 for (i = PM_SUSPEND_MIN; i < PM_SUSPEND_MAX; i++)
d431cbc5 680 if (pm_states[i])
a712f03f 681 count += sysfs_emit_at(buf, count, "%s ", pm_states[i]);
1da177e4 682
296699de 683#endif
a6e15a39 684 if (hibernation_available())
a712f03f
XL
685 count += sysfs_emit_at(buf, count, "disk ");
686
687 /* Convert the last space to a newline if needed. */
688 if (count > 0)
689 buf[count - 1] = '\n';
690
691 return count;
1da177e4
LT
692}
693
7483b4a4 694static suspend_state_t decode_state(const char *buf, size_t n)
1da177e4 695{
296699de 696#ifdef CONFIG_SUSPEND
d431cbc5 697 suspend_state_t state;
296699de 698#endif
1da177e4 699 char *p;
1da177e4
LT
700 int len;
701
702 p = memchr(buf, '\n', n);
703 len = p ? p - buf : n;
704
7483b4a4 705 /* Check hibernation first. */
d30bdfc0 706 if (len == 4 && str_has_prefix(buf, "disk"))
7483b4a4 707 return PM_SUSPEND_MAX;
a3d25c27 708
296699de 709#ifdef CONFIG_SUSPEND
d431cbc5
RW
710 for (state = PM_SUSPEND_MIN; state < PM_SUSPEND_MAX; state++) {
711 const char *label = pm_states[state];
712
713 if (label && len == strlen(label) && !strncmp(buf, label, len))
714 return state;
715 }
296699de
RW
716#endif
717
7483b4a4
RW
718 return PM_SUSPEND_ON;
719}
720
721static ssize_t state_store(struct kobject *kobj, struct kobj_attribute *attr,
722 const char *buf, size_t n)
723{
724 suspend_state_t state;
725 int error;
726
727 error = pm_autosleep_lock();
728 if (error)
729 return error;
730
731 if (pm_autosleep_state() > PM_SUSPEND_ON) {
732 error = -EBUSY;
733 goto out;
734 }
735
736 state = decode_state(buf, n);
406e7938
RW
737 if (state < PM_SUSPEND_MAX) {
738 if (state == PM_SUSPEND_MEM)
739 state = mem_sleep_current;
740
7483b4a4 741 error = pm_suspend(state);
406e7938 742 } else if (state == PM_SUSPEND_MAX) {
7483b4a4 743 error = hibernate();
406e7938 744 } else {
7483b4a4 745 error = -EINVAL;
406e7938 746 }
7483b4a4
RW
747
748 out:
749 pm_autosleep_unlock();
1da177e4
LT
750 return error ? error : n;
751}
752
753power_attr(state);
754
c125e96f
RW
755#ifdef CONFIG_PM_SLEEP
756/*
757 * The 'wakeup_count' attribute, along with the functions defined in
758 * drivers/base/power/wakeup.c, provides a means by which wakeup events can be
759 * handled in a non-racy way.
760 *
761 * If a wakeup event occurs when the system is in a sleep state, it simply is
762 * woken up. In turn, if an event that would wake the system up from a sleep
763 * state occurs when it is undergoing a transition to that sleep state, the
764 * transition should be aborted. Moreover, if such an event occurs when the
765 * system is in the working state, an attempt to start a transition to the
766 * given sleep state should fail during certain period after the detection of
767 * the event. Using the 'state' attribute alone is not sufficient to satisfy
768 * these requirements, because a wakeup event may occur exactly when 'state'
769 * is being written to and may be delivered to user space right before it is
770 * frozen, so the event will remain only partially processed until the system is
771 * woken up by another event. In particular, it won't cause the transition to
772 * a sleep state to be aborted.
773 *
774 * This difficulty may be overcome if user space uses 'wakeup_count' before
775 * writing to 'state'. It first should read from 'wakeup_count' and store
776 * the read value. Then, after carrying out its own preparations for the system
777 * transition to a sleep state, it should write the stored value to
25985edc 778 * 'wakeup_count'. If that fails, at least one wakeup event has occurred since
c125e96f
RW
779 * 'wakeup_count' was read and 'state' should not be written to. Otherwise, it
780 * is allowed to write to 'state', but the transition will be aborted if there
781 * are any wakeup events detected after 'wakeup_count' was written to.
782 */
783
784static ssize_t wakeup_count_show(struct kobject *kobj,
785 struct kobj_attribute *attr,
786 char *buf)
787{
074037ec 788 unsigned int val;
c125e96f 789
7483b4a4 790 return pm_get_wakeup_count(&val, true) ?
a712f03f 791 sysfs_emit(buf, "%u\n", val) : -EINTR;
c125e96f
RW
792}
793
794static ssize_t wakeup_count_store(struct kobject *kobj,
795 struct kobj_attribute *attr,
796 const char *buf, size_t n)
797{
074037ec 798 unsigned int val;
7483b4a4
RW
799 int error;
800
801 error = pm_autosleep_lock();
802 if (error)
803 return error;
c125e96f 804
7483b4a4
RW
805 if (pm_autosleep_state() > PM_SUSPEND_ON) {
806 error = -EBUSY;
807 goto out;
808 }
809
810 error = -EINVAL;
074037ec 811 if (sscanf(buf, "%u", &val) == 1) {
c125e96f 812 if (pm_save_wakeup_count(val))
7483b4a4 813 error = n;
bb177fed
JW
814 else
815 pm_print_active_wakeup_sources();
c125e96f 816 }
7483b4a4
RW
817
818 out:
819 pm_autosleep_unlock();
820 return error;
c125e96f
RW
821}
822
823power_attr(wakeup_count);
7483b4a4
RW
824
825#ifdef CONFIG_PM_AUTOSLEEP
826static ssize_t autosleep_show(struct kobject *kobj,
827 struct kobj_attribute *attr,
828 char *buf)
829{
830 suspend_state_t state = pm_autosleep_state();
831
832 if (state == PM_SUSPEND_ON)
a712f03f 833 return sysfs_emit(buf, "off\n");
7483b4a4
RW
834
835#ifdef CONFIG_SUSPEND
836 if (state < PM_SUSPEND_MAX)
a712f03f 837 return sysfs_emit(buf, "%s\n", pm_states[state] ?
d431cbc5 838 pm_states[state] : "error");
7483b4a4
RW
839#endif
840#ifdef CONFIG_HIBERNATION
a712f03f 841 return sysfs_emit(buf, "disk\n");
7483b4a4 842#else
a712f03f 843 return sysfs_emit(buf, "error\n");
7483b4a4
RW
844#endif
845}
846
847static ssize_t autosleep_store(struct kobject *kobj,
848 struct kobj_attribute *attr,
849 const char *buf, size_t n)
850{
851 suspend_state_t state = decode_state(buf, n);
852 int error;
853
854 if (state == PM_SUSPEND_ON
040e5bf6 855 && strcmp(buf, "off") && strcmp(buf, "off\n"))
7483b4a4
RW
856 return -EINVAL;
857
406e7938
RW
858 if (state == PM_SUSPEND_MEM)
859 state = mem_sleep_current;
860
7483b4a4
RW
861 error = pm_autosleep_set_state(state);
862 return error ? error : n;
863}
864
865power_attr(autosleep);
866#endif /* CONFIG_PM_AUTOSLEEP */
b86ff982
RW
867
868#ifdef CONFIG_PM_WAKELOCKS
869static ssize_t wake_lock_show(struct kobject *kobj,
870 struct kobj_attribute *attr,
871 char *buf)
872{
873 return pm_show_wakelocks(buf, true);
874}
875
876static ssize_t wake_lock_store(struct kobject *kobj,
877 struct kobj_attribute *attr,
878 const char *buf, size_t n)
879{
880 int error = pm_wake_lock(buf);
881 return error ? error : n;
882}
883
884power_attr(wake_lock);
885
886static ssize_t wake_unlock_show(struct kobject *kobj,
887 struct kobj_attribute *attr,
888 char *buf)
889{
890 return pm_show_wakelocks(buf, false);
891}
892
893static ssize_t wake_unlock_store(struct kobject *kobj,
894 struct kobj_attribute *attr,
895 const char *buf, size_t n)
896{
897 int error = pm_wake_unlock(buf);
898 return error ? error : n;
899}
900
901power_attr(wake_unlock);
902
903#endif /* CONFIG_PM_WAKELOCKS */
c125e96f
RW
904#endif /* CONFIG_PM_SLEEP */
905
c5c6ba4e
RW
906#ifdef CONFIG_PM_TRACE
907int pm_trace_enabled;
908
386f275f
KS
909static ssize_t pm_trace_show(struct kobject *kobj, struct kobj_attribute *attr,
910 char *buf)
c5c6ba4e 911{
a712f03f 912 return sysfs_emit(buf, "%d\n", pm_trace_enabled);
c5c6ba4e
RW
913}
914
915static ssize_t
386f275f
KS
916pm_trace_store(struct kobject *kobj, struct kobj_attribute *attr,
917 const char *buf, size_t n)
c5c6ba4e
RW
918{
919 int val;
920
921 if (sscanf(buf, "%d", &val) == 1) {
922 pm_trace_enabled = !!val;
9dceefe4
SK
923 if (pm_trace_enabled) {
924 pr_warn("PM: Enabling pm_trace changes system date and time during resume.\n"
925 "PM: Correct system time has to be restored manually after resume.\n");
926 }
c5c6ba4e
RW
927 return n;
928 }
929 return -EINVAL;
930}
931
932power_attr(pm_trace);
d33ac60b
JH
933
934static ssize_t pm_trace_dev_match_show(struct kobject *kobj,
935 struct kobj_attribute *attr,
936 char *buf)
937{
938 return show_trace_dev_match(buf, PAGE_SIZE);
939}
940
a1e9ca69 941power_attr_ro(pm_trace_dev_match);
d33ac60b 942
0e7d56e3 943#endif /* CONFIG_PM_TRACE */
c5c6ba4e 944
957d1282
LF
945#ifdef CONFIG_FREEZER
946static ssize_t pm_freeze_timeout_show(struct kobject *kobj,
947 struct kobj_attribute *attr, char *buf)
948{
a712f03f 949 return sysfs_emit(buf, "%u\n", freeze_timeout_msecs);
957d1282
LF
950}
951
952static ssize_t pm_freeze_timeout_store(struct kobject *kobj,
953 struct kobj_attribute *attr,
954 const char *buf, size_t n)
955{
956 unsigned long val;
957
958 if (kstrtoul(buf, 10, &val))
959 return -EINVAL;
960
961 freeze_timeout_msecs = val;
962 return n;
963}
964
965power_attr(pm_freeze_timeout);
966
967#endif /* CONFIG_FREEZER*/
968
eacfbf74
CB
969#if defined(CONFIG_SUSPEND) || defined(CONFIG_HIBERNATION)
970bool filesystem_freeze_enabled = false;
971
972static ssize_t freeze_filesystems_show(struct kobject *kobj,
973 struct kobj_attribute *attr, char *buf)
974{
975 return sysfs_emit(buf, "%d\n", filesystem_freeze_enabled);
976}
977
978static ssize_t freeze_filesystems_store(struct kobject *kobj,
979 struct kobj_attribute *attr,
980 const char *buf, size_t n)
981{
982 unsigned long val;
983
984 if (kstrtoul(buf, 10, &val))
985 return -EINVAL;
986
987 if (val > 1)
988 return -EINVAL;
989
990 filesystem_freeze_enabled = !!val;
991 return n;
992}
993
994power_attr(freeze_filesystems);
995#endif /* CONFIG_SUSPEND || CONFIG_HIBERNATION */
996
c5c6ba4e
RW
997static struct attribute * g[] = {
998 &state_attr.attr,
0e7d56e3 999#ifdef CONFIG_PM_TRACE
c5c6ba4e 1000 &pm_trace_attr.attr,
d33ac60b 1001 &pm_trace_dev_match_attr.attr,
0e7d56e3 1002#endif
0e06b4a8
RW
1003#ifdef CONFIG_PM_SLEEP
1004 &pm_async_attr.attr,
c125e96f 1005 &wakeup_count_attr.attr,
406e7938
RW
1006#ifdef CONFIG_SUSPEND
1007 &mem_sleep_attr.attr,
c052bf82 1008 &sync_on_suspend_attr.attr,
406e7938 1009#endif
7483b4a4
RW
1010#ifdef CONFIG_PM_AUTOSLEEP
1011 &autosleep_attr.attr,
1012#endif
b86ff982
RW
1013#ifdef CONFIG_PM_WAKELOCKS
1014 &wake_lock_attr.attr,
1015 &wake_unlock_attr.attr,
1016#endif
b2df1d4f 1017#ifdef CONFIG_PM_SLEEP_DEBUG
e516a1db 1018 &pm_test_attr.attr,
4b7760ba 1019 &pm_print_times_attr.attr,
a6f5f0dd 1020 &pm_wakeup_irq_attr.attr,
8d8b2441 1021 &pm_debug_messages_attr.attr,
0e06b4a8 1022#endif
957d1282
LF
1023#endif
1024#ifdef CONFIG_FREEZER
1025 &pm_freeze_timeout_attr.attr,
eacfbf74
CB
1026#endif
1027#if defined(CONFIG_SUSPEND) || defined(CONFIG_HIBERNATION)
1028 &freeze_filesystems_attr.attr,
0e7d56e3 1029#endif
c5c6ba4e
RW
1030 NULL,
1031};
1da177e4 1032
1d0c6e59 1033static const struct attribute_group attr_group = {
1da177e4
LT
1034 .attrs = g,
1035};
1036
2c8db5be
KS
1037static const struct attribute_group *attr_groups[] = {
1038 &attr_group,
1039#ifdef CONFIG_PM_SLEEP
1040 &suspend_attr_group,
1041#endif
1042 NULL,
1043};
1044
5e928f77 1045struct workqueue_struct *pm_wq;
7b199ca2 1046EXPORT_SYMBOL_GPL(pm_wq);
5e928f77
RW
1047
1048static int __init pm_start_workqueue(void)
1049{
58a69cb4 1050 pm_wq = alloc_workqueue("pm", WQ_FREEZABLE, 0);
5e928f77
RW
1051
1052 return pm_wq ? 0 : -ENOMEM;
1053}
5e928f77 1054
1da177e4
LT
1055static int __init pm_init(void)
1056{
5e928f77
RW
1057 int error = pm_start_workqueue();
1058 if (error)
1059 return error;
ac5c24ec 1060 hibernate_image_size_init();
ddeb6487 1061 hibernate_reserved_size_init();
fa7fd6fa 1062 pm_states_init();
d76e15fb
GKH
1063 power_kobj = kobject_create_and_add("power", NULL);
1064 if (!power_kobj)
039a5dcd 1065 return -ENOMEM;
2c8db5be 1066 error = sysfs_create_groups(power_kobj, attr_groups);
7483b4a4
RW
1067 if (error)
1068 return error;
b2df1d4f 1069 pm_print_times_init();
7483b4a4 1070 return pm_autosleep_init();
1da177e4
LT
1071}
1072
1073core_initcall(pm_init);