xref: /linux-6.15/kernel/power/main.c (revision cdb8c100)
155716d26SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only
21da177e4SLinus Torvalds /*
31da177e4SLinus Torvalds  * kernel/power/main.c - PM subsystem core functionality.
41da177e4SLinus Torvalds  *
51da177e4SLinus Torvalds  * Copyright (c) 2003 Patrick Mochel
61da177e4SLinus Torvalds  * Copyright (c) 2003 Open Source Development Lab
71da177e4SLinus Torvalds  */
81da177e4SLinus Torvalds 
9b52124a7SMario Limonciello #include <linux/acpi.h>
106e5fdeedSPaul Gortmaker #include <linux/export.h>
111da177e4SLinus Torvalds #include <linux/kobject.h>
121da177e4SLinus Torvalds #include <linux/string.h>
13431d452aSZhonghui Fu #include <linux/pm-trace.h>
145e928f77SRafael J. Wysocki #include <linux/workqueue.h>
152a77c46dSShuoX Liu #include <linux/debugfs.h>
162a77c46dSShuoX Liu #include <linux/seq_file.h>
1755f2503cSPingfan Liu #include <linux/suspend.h>
18b5dee313SHarry Pan #include <linux/syscalls.h>
19f49249d5SBen Dooks #include <linux/pm_runtime.h>
201da177e4SLinus Torvalds 
211da177e4SLinus Torvalds #include "power.h"
221da177e4SLinus Torvalds 
23cd51e61cSRafael J. Wysocki #ifdef CONFIG_PM_SLEEP
24cd51e61cSRafael J. Wysocki 
255950e5d5SPeter Zijlstra unsigned int lock_system_sleep(void)
264bf236a3SBart Van Assche {
275950e5d5SPeter Zijlstra 	unsigned int flags = current->flags;
28f5d39b02SPeter Zijlstra 	current->flags |= PF_NOFREEZE;
2955f2503cSPingfan Liu 	mutex_lock(&system_transition_mutex);
305950e5d5SPeter Zijlstra 	return flags;
314bf236a3SBart Van Assche }
324bf236a3SBart Van Assche EXPORT_SYMBOL_GPL(lock_system_sleep);
334bf236a3SBart Van Assche 
345950e5d5SPeter Zijlstra void unlock_system_sleep(unsigned int flags)
354bf236a3SBart Van Assche {
364bf236a3SBart Van Assche 	/*
374bf236a3SBart Van Assche 	 * Don't use freezer_count() because we don't want the call to
384bf236a3SBart Van Assche 	 * try_to_freeze() here.
394bf236a3SBart Van Assche 	 *
404bf236a3SBart Van Assche 	 * Reason:
414bf236a3SBart Van Assche 	 * Fundamentally, we just don't need it, because freezing condition
4255f2503cSPingfan Liu 	 * doesn't come into effect until we release the
4355f2503cSPingfan Liu 	 * system_transition_mutex lock, since the freezer always works with
4455f2503cSPingfan Liu 	 * system_transition_mutex held.
454bf236a3SBart Van Assche 	 *
464bf236a3SBart Van Assche 	 * More importantly, in the case of hibernation,
474bf236a3SBart Van Assche 	 * unlock_system_sleep() gets called in snapshot_read() and
484bf236a3SBart Van Assche 	 * snapshot_write() when the freezing condition is still in effect.
494bf236a3SBart Van Assche 	 * Which means, if we use try_to_freeze() here, it would make them
504bf236a3SBart Van Assche 	 * enter the refrigerator, thus causing hibernation to lockup.
514bf236a3SBart Van Assche 	 */
52f5d39b02SPeter Zijlstra 	if (!(flags & PF_NOFREEZE))
53f5d39b02SPeter Zijlstra 		current->flags &= ~PF_NOFREEZE;
5455f2503cSPingfan Liu 	mutex_unlock(&system_transition_mutex);
554bf236a3SBart Van Assche }
564bf236a3SBart Van Assche EXPORT_SYMBOL_GPL(unlock_system_sleep);
574bf236a3SBart Van Assche 
58b5dee313SHarry Pan void ksys_sync_helper(void)
59b5dee313SHarry Pan {
60c64546b1SHarry Pan 	ktime_t start;
61c64546b1SHarry Pan 	long elapsed_msecs;
62c64546b1SHarry Pan 
63c64546b1SHarry Pan 	start = ktime_get();
64b5dee313SHarry Pan 	ksys_sync();
65c64546b1SHarry Pan 	elapsed_msecs = ktime_to_ms(ktime_sub(ktime_get(), start));
66c64546b1SHarry Pan 	pr_info("Filesystems sync: %ld.%03ld seconds\n",
67c64546b1SHarry Pan 		elapsed_msecs / MSEC_PER_SEC, elapsed_msecs % MSEC_PER_SEC);
68b5dee313SHarry Pan }
69b5dee313SHarry Pan EXPORT_SYMBOL_GPL(ksys_sync_helper);
70b5dee313SHarry Pan 
7182525756SAlan Stern /* Routines for PM-transition notifications */
7282525756SAlan Stern 
7382525756SAlan Stern static BLOCKING_NOTIFIER_HEAD(pm_chain_head);
7482525756SAlan Stern 
7582525756SAlan Stern int register_pm_notifier(struct notifier_block *nb)
7682525756SAlan Stern {
7782525756SAlan Stern 	return blocking_notifier_chain_register(&pm_chain_head, nb);
7882525756SAlan Stern }
7982525756SAlan Stern EXPORT_SYMBOL_GPL(register_pm_notifier);
8082525756SAlan Stern 
8182525756SAlan Stern int unregister_pm_notifier(struct notifier_block *nb)
8282525756SAlan Stern {
8382525756SAlan Stern 	return blocking_notifier_chain_unregister(&pm_chain_head, nb);
8482525756SAlan Stern }
8582525756SAlan Stern EXPORT_SYMBOL_GPL(unregister_pm_notifier);
8682525756SAlan Stern 
87b52124a7SMario Limonciello void pm_report_hw_sleep_time(u64 t)
88b52124a7SMario Limonciello {
89b52124a7SMario Limonciello 	suspend_stats.last_hw_sleep = t;
90b52124a7SMario Limonciello 	suspend_stats.total_hw_sleep += t;
91b52124a7SMario Limonciello }
92b52124a7SMario Limonciello EXPORT_SYMBOL_GPL(pm_report_hw_sleep_time);
93b52124a7SMario Limonciello 
94b52124a7SMario Limonciello void pm_report_max_hw_sleep(u64 t)
95b52124a7SMario Limonciello {
96b52124a7SMario Limonciello 	suspend_stats.max_hw_sleep = t;
97b52124a7SMario Limonciello }
98b52124a7SMario Limonciello EXPORT_SYMBOL_GPL(pm_report_max_hw_sleep);
99b52124a7SMario Limonciello 
10070d93298SPeter Zijlstra int pm_notifier_call_chain_robust(unsigned long val_up, unsigned long val_down)
10182525756SAlan Stern {
102ea00f4f4SLianwei Wang 	int ret;
103ea00f4f4SLianwei Wang 
10470d93298SPeter Zijlstra 	ret = blocking_notifier_call_chain_robust(&pm_chain_head, val_up, val_down, NULL);
105f0c077a8SAkinobu Mita 
106f0c077a8SAkinobu Mita 	return notifier_to_errno(ret);
10782525756SAlan Stern }
10870d93298SPeter Zijlstra 
109ea00f4f4SLianwei Wang int pm_notifier_call_chain(unsigned long val)
110ea00f4f4SLianwei Wang {
11170d93298SPeter Zijlstra 	return blocking_notifier_call_chain(&pm_chain_head, val, NULL);
112ea00f4f4SLianwei Wang }
11382525756SAlan Stern 
1140e06b4a8SRafael J. Wysocki /* If set, devices may be suspended and resumed asynchronously. */
1150e06b4a8SRafael J. Wysocki int pm_async_enabled = 1;
1160e06b4a8SRafael J. Wysocki 
1170e06b4a8SRafael J. Wysocki static ssize_t pm_async_show(struct kobject *kobj, struct kobj_attribute *attr,
1180e06b4a8SRafael J. Wysocki 			     char *buf)
1190e06b4a8SRafael J. Wysocki {
1200e06b4a8SRafael J. Wysocki 	return sprintf(buf, "%d\n", pm_async_enabled);
1210e06b4a8SRafael J. Wysocki }
1220e06b4a8SRafael J. Wysocki 
1230e06b4a8SRafael J. Wysocki static ssize_t pm_async_store(struct kobject *kobj, struct kobj_attribute *attr,
1240e06b4a8SRafael J. Wysocki 			      const char *buf, size_t n)
1250e06b4a8SRafael J. Wysocki {
1260e06b4a8SRafael J. Wysocki 	unsigned long val;
1270e06b4a8SRafael J. Wysocki 
128883ee4f7SDaniel Walter 	if (kstrtoul(buf, 10, &val))
1290e06b4a8SRafael J. Wysocki 		return -EINVAL;
1300e06b4a8SRafael J. Wysocki 
1310e06b4a8SRafael J. Wysocki 	if (val > 1)
1320e06b4a8SRafael J. Wysocki 		return -EINVAL;
1330e06b4a8SRafael J. Wysocki 
1340e06b4a8SRafael J. Wysocki 	pm_async_enabled = val;
1350e06b4a8SRafael J. Wysocki 	return n;
1360e06b4a8SRafael J. Wysocki }
1370e06b4a8SRafael J. Wysocki 
1380e06b4a8SRafael J. Wysocki power_attr(pm_async);
1390e06b4a8SRafael J. Wysocki 
140406e7938SRafael J. Wysocki #ifdef CONFIG_SUSPEND
141406e7938SRafael J. Wysocki static ssize_t mem_sleep_show(struct kobject *kobj, struct kobj_attribute *attr,
142406e7938SRafael J. Wysocki 			      char *buf)
143406e7938SRafael J. Wysocki {
144406e7938SRafael J. Wysocki 	char *s = buf;
145406e7938SRafael J. Wysocki 	suspend_state_t i;
146406e7938SRafael J. Wysocki 
1479ea4dcf4SDan Williams 	for (i = PM_SUSPEND_MIN; i < PM_SUSPEND_MAX; i++) {
1489ea4dcf4SDan Williams 		if (i >= PM_SUSPEND_MEM && cxl_mem_active())
1499ea4dcf4SDan Williams 			continue;
150406e7938SRafael J. Wysocki 		if (mem_sleep_states[i]) {
151406e7938SRafael J. Wysocki 			const char *label = mem_sleep_states[i];
152406e7938SRafael J. Wysocki 
153406e7938SRafael J. Wysocki 			if (mem_sleep_current == i)
154406e7938SRafael J. Wysocki 				s += sprintf(s, "[%s] ", label);
155406e7938SRafael J. Wysocki 			else
156406e7938SRafael J. Wysocki 				s += sprintf(s, "%s ", label);
157406e7938SRafael J. Wysocki 		}
1589ea4dcf4SDan Williams 	}
159406e7938SRafael J. Wysocki 
160406e7938SRafael J. Wysocki 	/* Convert the last space to a newline if needed. */
161406e7938SRafael J. Wysocki 	if (s != buf)
162406e7938SRafael J. Wysocki 		*(s-1) = '\n';
163406e7938SRafael J. Wysocki 
164406e7938SRafael J. Wysocki 	return (s - buf);
165406e7938SRafael J. Wysocki }
166406e7938SRafael J. Wysocki 
167406e7938SRafael J. Wysocki static suspend_state_t decode_suspend_state(const char *buf, size_t n)
168406e7938SRafael J. Wysocki {
169406e7938SRafael J. Wysocki 	suspend_state_t state;
170406e7938SRafael J. Wysocki 	char *p;
171406e7938SRafael J. Wysocki 	int len;
172406e7938SRafael J. Wysocki 
173406e7938SRafael J. Wysocki 	p = memchr(buf, '\n', n);
174406e7938SRafael J. Wysocki 	len = p ? p - buf : n;
175406e7938SRafael J. Wysocki 
176406e7938SRafael J. Wysocki 	for (state = PM_SUSPEND_MIN; state < PM_SUSPEND_MAX; state++) {
177406e7938SRafael J. Wysocki 		const char *label = mem_sleep_states[state];
178406e7938SRafael J. Wysocki 
179406e7938SRafael J. Wysocki 		if (label && len == strlen(label) && !strncmp(buf, label, len))
180406e7938SRafael J. Wysocki 			return state;
181406e7938SRafael J. Wysocki 	}
182406e7938SRafael J. Wysocki 
183406e7938SRafael J. Wysocki 	return PM_SUSPEND_ON;
184406e7938SRafael J. Wysocki }
185406e7938SRafael J. Wysocki 
186406e7938SRafael J. Wysocki static ssize_t mem_sleep_store(struct kobject *kobj, struct kobj_attribute *attr,
187406e7938SRafael J. Wysocki 			       const char *buf, size_t n)
188406e7938SRafael J. Wysocki {
189406e7938SRafael J. Wysocki 	suspend_state_t state;
190406e7938SRafael J. Wysocki 	int error;
191406e7938SRafael J. Wysocki 
192406e7938SRafael J. Wysocki 	error = pm_autosleep_lock();
193406e7938SRafael J. Wysocki 	if (error)
194406e7938SRafael J. Wysocki 		return error;
195406e7938SRafael J. Wysocki 
196406e7938SRafael J. Wysocki 	if (pm_autosleep_state() > PM_SUSPEND_ON) {
197406e7938SRafael J. Wysocki 		error = -EBUSY;
198406e7938SRafael J. Wysocki 		goto out;
199406e7938SRafael J. Wysocki 	}
200406e7938SRafael J. Wysocki 
201406e7938SRafael J. Wysocki 	state = decode_suspend_state(buf, n);
202406e7938SRafael J. Wysocki 	if (state < PM_SUSPEND_MAX && state > PM_SUSPEND_ON)
203406e7938SRafael J. Wysocki 		mem_sleep_current = state;
204406e7938SRafael J. Wysocki 	else
205406e7938SRafael J. Wysocki 		error = -EINVAL;
206406e7938SRafael J. Wysocki 
207406e7938SRafael J. Wysocki  out:
208406e7938SRafael J. Wysocki 	pm_autosleep_unlock();
209406e7938SRafael J. Wysocki 	return error ? error : n;
210406e7938SRafael J. Wysocki }
211406e7938SRafael J. Wysocki 
212406e7938SRafael J. Wysocki power_attr(mem_sleep);
213c052bf82SJonas Meurer 
214c052bf82SJonas Meurer /*
215c052bf82SJonas Meurer  * sync_on_suspend: invoke ksys_sync_helper() before suspend.
216c052bf82SJonas Meurer  *
217c052bf82SJonas Meurer  * show() returns whether ksys_sync_helper() is invoked before suspend.
218c052bf82SJonas Meurer  * store() accepts 0 or 1.  0 disables ksys_sync_helper() and 1 enables it.
219c052bf82SJonas Meurer  */
220c052bf82SJonas Meurer bool sync_on_suspend_enabled = !IS_ENABLED(CONFIG_SUSPEND_SKIP_SYNC);
221c052bf82SJonas Meurer 
222c052bf82SJonas Meurer static ssize_t sync_on_suspend_show(struct kobject *kobj,
223c052bf82SJonas Meurer 				   struct kobj_attribute *attr, char *buf)
224c052bf82SJonas Meurer {
225c052bf82SJonas Meurer 	return sprintf(buf, "%d\n", sync_on_suspend_enabled);
226c052bf82SJonas Meurer }
227c052bf82SJonas Meurer 
228c052bf82SJonas Meurer static ssize_t sync_on_suspend_store(struct kobject *kobj,
229c052bf82SJonas Meurer 				    struct kobj_attribute *attr,
230c052bf82SJonas Meurer 				    const char *buf, size_t n)
231c052bf82SJonas Meurer {
232c052bf82SJonas Meurer 	unsigned long val;
233c052bf82SJonas Meurer 
234c052bf82SJonas Meurer 	if (kstrtoul(buf, 10, &val))
235c052bf82SJonas Meurer 		return -EINVAL;
236c052bf82SJonas Meurer 
237c052bf82SJonas Meurer 	if (val > 1)
238c052bf82SJonas Meurer 		return -EINVAL;
239c052bf82SJonas Meurer 
240c052bf82SJonas Meurer 	sync_on_suspend_enabled = !!val;
241c052bf82SJonas Meurer 	return n;
242c052bf82SJonas Meurer }
243c052bf82SJonas Meurer 
244c052bf82SJonas Meurer power_attr(sync_on_suspend);
245406e7938SRafael J. Wysocki #endif /* CONFIG_SUSPEND */
246406e7938SRafael J. Wysocki 
247e516a1dbSRafael J. Wysocki #ifdef CONFIG_PM_SLEEP_DEBUG
2480e7d56e3SRafael J. Wysocki int pm_test_level = TEST_NONE;
2490e7d56e3SRafael J. Wysocki 
2500e7d56e3SRafael J. Wysocki static const char * const pm_tests[__TEST_AFTER_LAST] = {
2510e7d56e3SRafael J. Wysocki 	[TEST_NONE] = "none",
2520e7d56e3SRafael J. Wysocki 	[TEST_CORE] = "core",
2530e7d56e3SRafael J. Wysocki 	[TEST_CPUS] = "processors",
2540e7d56e3SRafael J. Wysocki 	[TEST_PLATFORM] = "platform",
2550e7d56e3SRafael J. Wysocki 	[TEST_DEVICES] = "devices",
2560e7d56e3SRafael J. Wysocki 	[TEST_FREEZER] = "freezer",
2570e7d56e3SRafael J. Wysocki };
2580e7d56e3SRafael J. Wysocki 
259039a75c6SRafael J. Wysocki static ssize_t pm_test_show(struct kobject *kobj, struct kobj_attribute *attr,
260039a75c6SRafael J. Wysocki 				char *buf)
2610e7d56e3SRafael J. Wysocki {
2620e7d56e3SRafael J. Wysocki 	char *s = buf;
2630e7d56e3SRafael J. Wysocki 	int level;
2640e7d56e3SRafael J. Wysocki 
2650e7d56e3SRafael J. Wysocki 	for (level = TEST_FIRST; level <= TEST_MAX; level++)
2660e7d56e3SRafael J. Wysocki 		if (pm_tests[level]) {
2670e7d56e3SRafael J. Wysocki 			if (level == pm_test_level)
2680e7d56e3SRafael J. Wysocki 				s += sprintf(s, "[%s] ", pm_tests[level]);
2690e7d56e3SRafael J. Wysocki 			else
2700e7d56e3SRafael J. Wysocki 				s += sprintf(s, "%s ", pm_tests[level]);
2710e7d56e3SRafael J. Wysocki 		}
2720e7d56e3SRafael J. Wysocki 
2730e7d56e3SRafael J. Wysocki 	if (s != buf)
2740e7d56e3SRafael J. Wysocki 		/* convert the last space to a newline */
2750e7d56e3SRafael J. Wysocki 		*(s-1) = '\n';
2760e7d56e3SRafael J. Wysocki 
2770e7d56e3SRafael J. Wysocki 	return (s - buf);
2780e7d56e3SRafael J. Wysocki }
2790e7d56e3SRafael J. Wysocki 
280039a75c6SRafael J. Wysocki static ssize_t pm_test_store(struct kobject *kobj, struct kobj_attribute *attr,
281039a75c6SRafael J. Wysocki 				const char *buf, size_t n)
2820e7d56e3SRafael J. Wysocki {
2835950e5d5SPeter Zijlstra 	unsigned int sleep_flags;
2840e7d56e3SRafael J. Wysocki 	const char * const *s;
2855950e5d5SPeter Zijlstra 	int error = -EINVAL;
2860e7d56e3SRafael J. Wysocki 	int level;
2870e7d56e3SRafael J. Wysocki 	char *p;
2880e7d56e3SRafael J. Wysocki 	int len;
2890e7d56e3SRafael J. Wysocki 
2900e7d56e3SRafael J. Wysocki 	p = memchr(buf, '\n', n);
2910e7d56e3SRafael J. Wysocki 	len = p ? p - buf : n;
2920e7d56e3SRafael J. Wysocki 
2935950e5d5SPeter Zijlstra 	sleep_flags = lock_system_sleep();
2940e7d56e3SRafael J. Wysocki 
2950e7d56e3SRafael J. Wysocki 	level = TEST_FIRST;
2960e7d56e3SRafael J. Wysocki 	for (s = &pm_tests[level]; level <= TEST_MAX; s++, level++)
2970e7d56e3SRafael J. Wysocki 		if (*s && len == strlen(*s) && !strncmp(buf, *s, len)) {
2980e7d56e3SRafael J. Wysocki 			pm_test_level = level;
2990e7d56e3SRafael J. Wysocki 			error = 0;
3000e7d56e3SRafael J. Wysocki 			break;
3010e7d56e3SRafael J. Wysocki 		}
3020e7d56e3SRafael J. Wysocki 
3035950e5d5SPeter Zijlstra 	unlock_system_sleep(sleep_flags);
3040e7d56e3SRafael J. Wysocki 
3050e7d56e3SRafael J. Wysocki 	return error ? error : n;
3060e7d56e3SRafael J. Wysocki }
3070e7d56e3SRafael J. Wysocki 
3080e7d56e3SRafael J. Wysocki power_attr(pm_test);
309e516a1dbSRafael J. Wysocki #endif /* CONFIG_PM_SLEEP_DEBUG */
3100e7d56e3SRafael J. Wysocki 
3112a77c46dSShuoX Liu static char *suspend_step_name(enum suspend_stat_step step)
3122a77c46dSShuoX Liu {
3132a77c46dSShuoX Liu 	switch (step) {
3142a77c46dSShuoX Liu 	case SUSPEND_FREEZE:
3152a77c46dSShuoX Liu 		return "freeze";
3162a77c46dSShuoX Liu 	case SUSPEND_PREPARE:
3172a77c46dSShuoX Liu 		return "prepare";
3182a77c46dSShuoX Liu 	case SUSPEND_SUSPEND:
3192a77c46dSShuoX Liu 		return "suspend";
3202a77c46dSShuoX Liu 	case SUSPEND_SUSPEND_NOIRQ:
3212a77c46dSShuoX Liu 		return "suspend_noirq";
3222a77c46dSShuoX Liu 	case SUSPEND_RESUME_NOIRQ:
3232a77c46dSShuoX Liu 		return "resume_noirq";
3242a77c46dSShuoX Liu 	case SUSPEND_RESUME:
3252a77c46dSShuoX Liu 		return "resume";
3262a77c46dSShuoX Liu 	default:
3272a77c46dSShuoX Liu 		return "";
3282a77c46dSShuoX Liu 	}
3292a77c46dSShuoX Liu }
3302a77c46dSShuoX Liu 
331b52124a7SMario Limonciello #define suspend_attr(_name, format_str)				\
3322c8db5beSKalesh Singh static ssize_t _name##_show(struct kobject *kobj,		\
3332c8db5beSKalesh Singh 		struct kobj_attribute *attr, char *buf)		\
3342c8db5beSKalesh Singh {								\
335b52124a7SMario Limonciello 	return sprintf(buf, format_str, suspend_stats._name);	\
3362c8db5beSKalesh Singh }								\
3372c8db5beSKalesh Singh static struct kobj_attribute _name = __ATTR_RO(_name)
3382c8db5beSKalesh Singh 
339b52124a7SMario Limonciello suspend_attr(success, "%d\n");
340b52124a7SMario Limonciello suspend_attr(fail, "%d\n");
341b52124a7SMario Limonciello suspend_attr(failed_freeze, "%d\n");
342b52124a7SMario Limonciello suspend_attr(failed_prepare, "%d\n");
343b52124a7SMario Limonciello suspend_attr(failed_suspend, "%d\n");
344b52124a7SMario Limonciello suspend_attr(failed_suspend_late, "%d\n");
345b52124a7SMario Limonciello suspend_attr(failed_suspend_noirq, "%d\n");
346b52124a7SMario Limonciello suspend_attr(failed_resume, "%d\n");
347b52124a7SMario Limonciello suspend_attr(failed_resume_early, "%d\n");
348b52124a7SMario Limonciello suspend_attr(failed_resume_noirq, "%d\n");
349b52124a7SMario Limonciello suspend_attr(last_hw_sleep, "%llu\n");
350b52124a7SMario Limonciello suspend_attr(total_hw_sleep, "%llu\n");
351b52124a7SMario Limonciello suspend_attr(max_hw_sleep, "%llu\n");
3522c8db5beSKalesh Singh 
3532c8db5beSKalesh Singh static ssize_t last_failed_dev_show(struct kobject *kobj,
3542c8db5beSKalesh Singh 		struct kobj_attribute *attr, char *buf)
3552c8db5beSKalesh Singh {
3562c8db5beSKalesh Singh 	int index;
3572c8db5beSKalesh Singh 	char *last_failed_dev = NULL;
3582c8db5beSKalesh Singh 
3592c8db5beSKalesh Singh 	index = suspend_stats.last_failed_dev + REC_FAILED_NUM - 1;
3602c8db5beSKalesh Singh 	index %= REC_FAILED_NUM;
3612c8db5beSKalesh Singh 	last_failed_dev = suspend_stats.failed_devs[index];
3622c8db5beSKalesh Singh 
3632c8db5beSKalesh Singh 	return sprintf(buf, "%s\n", last_failed_dev);
3642c8db5beSKalesh Singh }
3652c8db5beSKalesh Singh static struct kobj_attribute last_failed_dev = __ATTR_RO(last_failed_dev);
3662c8db5beSKalesh Singh 
3672c8db5beSKalesh Singh static ssize_t last_failed_errno_show(struct kobject *kobj,
3682c8db5beSKalesh Singh 		struct kobj_attribute *attr, char *buf)
3692c8db5beSKalesh Singh {
3702c8db5beSKalesh Singh 	int index;
3712c8db5beSKalesh Singh 	int last_failed_errno;
3722c8db5beSKalesh Singh 
3732c8db5beSKalesh Singh 	index = suspend_stats.last_failed_errno + REC_FAILED_NUM - 1;
3742c8db5beSKalesh Singh 	index %= REC_FAILED_NUM;
3752c8db5beSKalesh Singh 	last_failed_errno = suspend_stats.errno[index];
3762c8db5beSKalesh Singh 
3772c8db5beSKalesh Singh 	return sprintf(buf, "%d\n", last_failed_errno);
3782c8db5beSKalesh Singh }
3792c8db5beSKalesh Singh static struct kobj_attribute last_failed_errno = __ATTR_RO(last_failed_errno);
3802c8db5beSKalesh Singh 
3812c8db5beSKalesh Singh static ssize_t last_failed_step_show(struct kobject *kobj,
3822c8db5beSKalesh Singh 		struct kobj_attribute *attr, char *buf)
3832c8db5beSKalesh Singh {
3842c8db5beSKalesh Singh 	int index;
3852c8db5beSKalesh Singh 	enum suspend_stat_step step;
3862c8db5beSKalesh Singh 	char *last_failed_step = NULL;
3872c8db5beSKalesh Singh 
3882c8db5beSKalesh Singh 	index = suspend_stats.last_failed_step + REC_FAILED_NUM - 1;
3892c8db5beSKalesh Singh 	index %= REC_FAILED_NUM;
3902c8db5beSKalesh Singh 	step = suspend_stats.failed_steps[index];
3912c8db5beSKalesh Singh 	last_failed_step = suspend_step_name(step);
3922c8db5beSKalesh Singh 
3932c8db5beSKalesh Singh 	return sprintf(buf, "%s\n", last_failed_step);
3942c8db5beSKalesh Singh }
3952c8db5beSKalesh Singh static struct kobj_attribute last_failed_step = __ATTR_RO(last_failed_step);
3962c8db5beSKalesh Singh 
3972c8db5beSKalesh Singh static struct attribute *suspend_attrs[] = {
3982c8db5beSKalesh Singh 	&success.attr,
3992c8db5beSKalesh Singh 	&fail.attr,
4002c8db5beSKalesh Singh 	&failed_freeze.attr,
4012c8db5beSKalesh Singh 	&failed_prepare.attr,
4022c8db5beSKalesh Singh 	&failed_suspend.attr,
4032c8db5beSKalesh Singh 	&failed_suspend_late.attr,
4042c8db5beSKalesh Singh 	&failed_suspend_noirq.attr,
4052c8db5beSKalesh Singh 	&failed_resume.attr,
4062c8db5beSKalesh Singh 	&failed_resume_early.attr,
4072c8db5beSKalesh Singh 	&failed_resume_noirq.attr,
4082c8db5beSKalesh Singh 	&last_failed_dev.attr,
4092c8db5beSKalesh Singh 	&last_failed_errno.attr,
4102c8db5beSKalesh Singh 	&last_failed_step.attr,
411b52124a7SMario Limonciello 	&last_hw_sleep.attr,
412b52124a7SMario Limonciello 	&total_hw_sleep.attr,
413b52124a7SMario Limonciello 	&max_hw_sleep.attr,
4142c8db5beSKalesh Singh 	NULL,
4152c8db5beSKalesh Singh };
4162c8db5beSKalesh Singh 
417b52124a7SMario Limonciello static umode_t suspend_attr_is_visible(struct kobject *kobj, struct attribute *attr, int idx)
418b52124a7SMario Limonciello {
419b52124a7SMario Limonciello 	if (attr != &last_hw_sleep.attr &&
420b52124a7SMario Limonciello 	    attr != &total_hw_sleep.attr &&
421b52124a7SMario Limonciello 	    attr != &max_hw_sleep.attr)
422b52124a7SMario Limonciello 		return 0444;
423b52124a7SMario Limonciello 
424b52124a7SMario Limonciello #ifdef CONFIG_ACPI
425b52124a7SMario Limonciello 	if (acpi_gbl_FADT.flags & ACPI_FADT_LOW_POWER_S0)
426b52124a7SMario Limonciello 		return 0444;
427b52124a7SMario Limonciello #endif
428b52124a7SMario Limonciello 	return 0;
429b52124a7SMario Limonciello }
430b52124a7SMario Limonciello 
43115560574SRikard Falkeborn static const struct attribute_group suspend_attr_group = {
4322c8db5beSKalesh Singh 	.name = "suspend_stats",
4332c8db5beSKalesh Singh 	.attrs = suspend_attrs,
434b52124a7SMario Limonciello 	.is_visible = suspend_attr_is_visible,
4352c8db5beSKalesh Singh };
4362c8db5beSKalesh Singh 
4372c8db5beSKalesh Singh #ifdef CONFIG_DEBUG_FS
4382a77c46dSShuoX Liu static int suspend_stats_show(struct seq_file *s, void *unused)
4392a77c46dSShuoX Liu {
4402a77c46dSShuoX Liu 	int i, index, last_dev, last_errno, last_step;
4412a77c46dSShuoX Liu 
4422a77c46dSShuoX Liu 	last_dev = suspend_stats.last_failed_dev + REC_FAILED_NUM - 1;
4432a77c46dSShuoX Liu 	last_dev %= REC_FAILED_NUM;
4442a77c46dSShuoX Liu 	last_errno = suspend_stats.last_failed_errno + REC_FAILED_NUM - 1;
4452a77c46dSShuoX Liu 	last_errno %= REC_FAILED_NUM;
4462a77c46dSShuoX Liu 	last_step = suspend_stats.last_failed_step + REC_FAILED_NUM - 1;
4472a77c46dSShuoX Liu 	last_step %= REC_FAILED_NUM;
448cf579dfbSRafael J. Wysocki 	seq_printf(s, "%s: %d\n%s: %d\n%s: %d\n%s: %d\n%s: %d\n"
449cf579dfbSRafael J. Wysocki 			"%s: %d\n%s: %d\n%s: %d\n%s: %d\n%s: %d\n",
4502a77c46dSShuoX Liu 			"success", suspend_stats.success,
4512a77c46dSShuoX Liu 			"fail", suspend_stats.fail,
4522a77c46dSShuoX Liu 			"failed_freeze", suspend_stats.failed_freeze,
4532a77c46dSShuoX Liu 			"failed_prepare", suspend_stats.failed_prepare,
4542a77c46dSShuoX Liu 			"failed_suspend", suspend_stats.failed_suspend,
455cf579dfbSRafael J. Wysocki 			"failed_suspend_late",
456cf579dfbSRafael J. Wysocki 				suspend_stats.failed_suspend_late,
4572a77c46dSShuoX Liu 			"failed_suspend_noirq",
4582a77c46dSShuoX Liu 				suspend_stats.failed_suspend_noirq,
4592a77c46dSShuoX Liu 			"failed_resume", suspend_stats.failed_resume,
460cf579dfbSRafael J. Wysocki 			"failed_resume_early",
461cf579dfbSRafael J. Wysocki 				suspend_stats.failed_resume_early,
4622a77c46dSShuoX Liu 			"failed_resume_noirq",
4632a77c46dSShuoX Liu 				suspend_stats.failed_resume_noirq);
4642a77c46dSShuoX Liu 	seq_printf(s,	"failures:\n  last_failed_dev:\t%-s\n",
4652a77c46dSShuoX Liu 			suspend_stats.failed_devs[last_dev]);
4662a77c46dSShuoX Liu 	for (i = 1; i < REC_FAILED_NUM; i++) {
4672a77c46dSShuoX Liu 		index = last_dev + REC_FAILED_NUM - i;
4682a77c46dSShuoX Liu 		index %= REC_FAILED_NUM;
4692a77c46dSShuoX Liu 		seq_printf(s, "\t\t\t%-s\n",
4702a77c46dSShuoX Liu 			suspend_stats.failed_devs[index]);
4712a77c46dSShuoX Liu 	}
4722a77c46dSShuoX Liu 	seq_printf(s,	"  last_failed_errno:\t%-d\n",
4732a77c46dSShuoX Liu 			suspend_stats.errno[last_errno]);
4742a77c46dSShuoX Liu 	for (i = 1; i < REC_FAILED_NUM; i++) {
4752a77c46dSShuoX Liu 		index = last_errno + REC_FAILED_NUM - i;
4762a77c46dSShuoX Liu 		index %= REC_FAILED_NUM;
4772a77c46dSShuoX Liu 		seq_printf(s, "\t\t\t%-d\n",
4782a77c46dSShuoX Liu 			suspend_stats.errno[index]);
4792a77c46dSShuoX Liu 	}
4802a77c46dSShuoX Liu 	seq_printf(s,	"  last_failed_step:\t%-s\n",
4812a77c46dSShuoX Liu 			suspend_step_name(
4822a77c46dSShuoX Liu 				suspend_stats.failed_steps[last_step]));
4832a77c46dSShuoX Liu 	for (i = 1; i < REC_FAILED_NUM; i++) {
4842a77c46dSShuoX Liu 		index = last_step + REC_FAILED_NUM - i;
4852a77c46dSShuoX Liu 		index %= REC_FAILED_NUM;
4862a77c46dSShuoX Liu 		seq_printf(s, "\t\t\t%-s\n",
4872a77c46dSShuoX Liu 			suspend_step_name(
4882a77c46dSShuoX Liu 				suspend_stats.failed_steps[index]));
4892a77c46dSShuoX Liu 	}
4902a77c46dSShuoX Liu 
4912a77c46dSShuoX Liu 	return 0;
4922a77c46dSShuoX Liu }
493943a10f8SYangtao Li DEFINE_SHOW_ATTRIBUTE(suspend_stats);
4942a77c46dSShuoX Liu 
4952a77c46dSShuoX Liu static int __init pm_debugfs_init(void)
4962a77c46dSShuoX Liu {
4972a77c46dSShuoX Liu 	debugfs_create_file("suspend_stats", S_IFREG | S_IRUGO,
498943a10f8SYangtao Li 			NULL, NULL, &suspend_stats_fops);
4992a77c46dSShuoX Liu 	return 0;
5002a77c46dSShuoX Liu }
5012a77c46dSShuoX Liu 
5022a77c46dSShuoX Liu late_initcall(pm_debugfs_init);
5032a77c46dSShuoX Liu #endif /* CONFIG_DEBUG_FS */
5042a77c46dSShuoX Liu 
505ca123102SRafael J. Wysocki #endif /* CONFIG_PM_SLEEP */
506ca123102SRafael J. Wysocki 
507b2df1d4fSRafael J. Wysocki #ifdef CONFIG_PM_SLEEP_DEBUG
508b2df1d4fSRafael J. Wysocki /*
509b2df1d4fSRafael J. Wysocki  * pm_print_times: print time taken by devices to suspend and resume.
510b2df1d4fSRafael J. Wysocki  *
511b2df1d4fSRafael J. Wysocki  * show() returns whether printing of suspend and resume times is enabled.
512b2df1d4fSRafael J. Wysocki  * store() accepts 0 or 1.  0 disables printing and 1 enables it.
513b2df1d4fSRafael J. Wysocki  */
514b2df1d4fSRafael J. Wysocki bool pm_print_times_enabled;
515b2df1d4fSRafael J. Wysocki 
516b2df1d4fSRafael J. Wysocki static ssize_t pm_print_times_show(struct kobject *kobj,
517b2df1d4fSRafael J. Wysocki 				   struct kobj_attribute *attr, char *buf)
518b2df1d4fSRafael J. Wysocki {
519b2df1d4fSRafael J. Wysocki 	return sprintf(buf, "%d\n", pm_print_times_enabled);
520b2df1d4fSRafael J. Wysocki }
521b2df1d4fSRafael J. Wysocki 
522b2df1d4fSRafael J. Wysocki static ssize_t pm_print_times_store(struct kobject *kobj,
523b2df1d4fSRafael J. Wysocki 				    struct kobj_attribute *attr,
524b2df1d4fSRafael J. Wysocki 				    const char *buf, size_t n)
525b2df1d4fSRafael J. Wysocki {
526b2df1d4fSRafael J. Wysocki 	unsigned long val;
527b2df1d4fSRafael J. Wysocki 
528b2df1d4fSRafael J. Wysocki 	if (kstrtoul(buf, 10, &val))
529b2df1d4fSRafael J. Wysocki 		return -EINVAL;
530b2df1d4fSRafael J. Wysocki 
531b2df1d4fSRafael J. Wysocki 	if (val > 1)
532b2df1d4fSRafael J. Wysocki 		return -EINVAL;
533b2df1d4fSRafael J. Wysocki 
534b2df1d4fSRafael J. Wysocki 	pm_print_times_enabled = !!val;
535b2df1d4fSRafael J. Wysocki 	return n;
536b2df1d4fSRafael J. Wysocki }
537b2df1d4fSRafael J. Wysocki 
538b2df1d4fSRafael J. Wysocki power_attr(pm_print_times);
539b2df1d4fSRafael J. Wysocki 
540b2df1d4fSRafael J. Wysocki static inline void pm_print_times_init(void)
541b2df1d4fSRafael J. Wysocki {
542b2df1d4fSRafael J. Wysocki 	pm_print_times_enabled = !!initcall_debug;
543b2df1d4fSRafael J. Wysocki }
544a6f5f0ddSAlexandra Yates 
545a6f5f0ddSAlexandra Yates static ssize_t pm_wakeup_irq_show(struct kobject *kobj,
546a6f5f0ddSAlexandra Yates 					struct kobj_attribute *attr,
547a6f5f0ddSAlexandra Yates 					char *buf)
548a6f5f0ddSAlexandra Yates {
549cb1f65c1SRafael J. Wysocki 	if (!pm_wakeup_irq())
550cb1f65c1SRafael J. Wysocki 		return -ENODATA;
551cb1f65c1SRafael J. Wysocki 
552cb1f65c1SRafael J. Wysocki 	return sprintf(buf, "%u\n", pm_wakeup_irq());
553a6f5f0ddSAlexandra Yates }
554a6f5f0ddSAlexandra Yates 
555a1e9ca69SRafael J. Wysocki power_attr_ro(pm_wakeup_irq);
556a6f5f0ddSAlexandra Yates 
557726fb6b4SSrinivas Pandruvada bool pm_debug_messages_on __read_mostly;
5588d8b2441SRafael J. Wysocki 
559*cdb8c100SMario Limonciello bool pm_debug_messages_should_print(void)
560*cdb8c100SMario Limonciello {
561*cdb8c100SMario Limonciello 	return pm_debug_messages_on && pm_suspend_target_state != PM_SUSPEND_ON;
562*cdb8c100SMario Limonciello }
563*cdb8c100SMario Limonciello EXPORT_SYMBOL_GPL(pm_debug_messages_should_print);
564*cdb8c100SMario Limonciello 
5658d8b2441SRafael J. Wysocki static ssize_t pm_debug_messages_show(struct kobject *kobj,
5668d8b2441SRafael J. Wysocki 				      struct kobj_attribute *attr, char *buf)
5678d8b2441SRafael J. Wysocki {
5688d8b2441SRafael J. Wysocki 	return sprintf(buf, "%d\n", pm_debug_messages_on);
5698d8b2441SRafael J. Wysocki }
5708d8b2441SRafael J. Wysocki 
5718d8b2441SRafael J. Wysocki static ssize_t pm_debug_messages_store(struct kobject *kobj,
5728d8b2441SRafael J. Wysocki 				       struct kobj_attribute *attr,
5738d8b2441SRafael J. Wysocki 				       const char *buf, size_t n)
5748d8b2441SRafael J. Wysocki {
5758d8b2441SRafael J. Wysocki 	unsigned long val;
5768d8b2441SRafael J. Wysocki 
5778d8b2441SRafael J. Wysocki 	if (kstrtoul(buf, 10, &val))
5788d8b2441SRafael J. Wysocki 		return -EINVAL;
5798d8b2441SRafael J. Wysocki 
5808d8b2441SRafael J. Wysocki 	if (val > 1)
5818d8b2441SRafael J. Wysocki 		return -EINVAL;
5828d8b2441SRafael J. Wysocki 
5838d8b2441SRafael J. Wysocki 	pm_debug_messages_on = !!val;
5848d8b2441SRafael J. Wysocki 	return n;
5858d8b2441SRafael J. Wysocki }
5868d8b2441SRafael J. Wysocki 
5878d8b2441SRafael J. Wysocki power_attr(pm_debug_messages);
5888d8b2441SRafael J. Wysocki 
589db96a759SChen Yu static int __init pm_debug_messages_setup(char *str)
590db96a759SChen Yu {
591db96a759SChen Yu 	pm_debug_messages_on = true;
592db96a759SChen Yu 	return 1;
593db96a759SChen Yu }
594db96a759SChen Yu __setup("pm_debug_messages", pm_debug_messages_setup);
595db96a759SChen Yu 
596819b1bb3SRafael J. Wysocki #else /* !CONFIG_PM_SLEEP_DEBUG */
597b2df1d4fSRafael J. Wysocki static inline void pm_print_times_init(void) {}
598b2df1d4fSRafael J. Wysocki #endif /* CONFIG_PM_SLEEP_DEBUG */
599b2df1d4fSRafael J. Wysocki 
600d76e15fbSGreg Kroah-Hartman struct kobject *power_kobj;
6011da177e4SLinus Torvalds 
602dbcfa715SRandy Dunlap /*
6030399d4dbSRafael J. Wysocki  * state - control system sleep states.
6041da177e4SLinus Torvalds  *
6050399d4dbSRafael J. Wysocki  * show() returns available sleep state labels, which may be "mem", "standby",
60644348e8aSMauro Carvalho Chehab  * "freeze" and "disk" (hibernation).
60744348e8aSMauro Carvalho Chehab  * See Documentation/admin-guide/pm/sleep-states.rst for a description of
60844348e8aSMauro Carvalho Chehab  * what they mean.
6091da177e4SLinus Torvalds  *
6100399d4dbSRafael J. Wysocki  * store() accepts one of those strings, translates it into the proper
6110399d4dbSRafael J. Wysocki  * enumerated value, and initiates a suspend transition.
6121da177e4SLinus Torvalds  */
613386f275fSKay Sievers static ssize_t state_show(struct kobject *kobj, struct kobj_attribute *attr,
614386f275fSKay Sievers 			  char *buf)
6151da177e4SLinus Torvalds {
6161da177e4SLinus Torvalds 	char *s = buf;
617296699deSRafael J. Wysocki #ifdef CONFIG_SUSPEND
61827ddcc65SRafael J. Wysocki 	suspend_state_t i;
6191da177e4SLinus Torvalds 
62027ddcc65SRafael J. Wysocki 	for (i = PM_SUSPEND_MIN; i < PM_SUSPEND_MAX; i++)
621d431cbc5SRafael J. Wysocki 		if (pm_states[i])
622d431cbc5SRafael J. Wysocki 			s += sprintf(s,"%s ", pm_states[i]);
62327ddcc65SRafael J. Wysocki 
624296699deSRafael J. Wysocki #endif
625a6e15a39SKees Cook 	if (hibernation_available())
626a6e15a39SKees Cook 		s += sprintf(s, "disk ");
627a3d25c27SRafael J. Wysocki 	if (s != buf)
628a3d25c27SRafael J. Wysocki 		/* convert the last space to a newline */
629a3d25c27SRafael J. Wysocki 		*(s-1) = '\n';
6301da177e4SLinus Torvalds 	return (s - buf);
6311da177e4SLinus Torvalds }
6321da177e4SLinus Torvalds 
6337483b4a4SRafael J. Wysocki static suspend_state_t decode_state(const char *buf, size_t n)
6341da177e4SLinus Torvalds {
635296699deSRafael J. Wysocki #ifdef CONFIG_SUSPEND
636d431cbc5SRafael J. Wysocki 	suspend_state_t state;
637296699deSRafael J. Wysocki #endif
6381da177e4SLinus Torvalds 	char *p;
6391da177e4SLinus Torvalds 	int len;
6401da177e4SLinus Torvalds 
6411da177e4SLinus Torvalds 	p = memchr(buf, '\n', n);
6421da177e4SLinus Torvalds 	len = p ? p - buf : n;
6431da177e4SLinus Torvalds 
6447483b4a4SRafael J. Wysocki 	/* Check hibernation first. */
645d30bdfc0SChuhong Yuan 	if (len == 4 && str_has_prefix(buf, "disk"))
6467483b4a4SRafael J. Wysocki 		return PM_SUSPEND_MAX;
647a3d25c27SRafael J. Wysocki 
648296699deSRafael J. Wysocki #ifdef CONFIG_SUSPEND
649d431cbc5SRafael J. Wysocki 	for (state = PM_SUSPEND_MIN; state < PM_SUSPEND_MAX; state++) {
650d431cbc5SRafael J. Wysocki 		const char *label = pm_states[state];
651d431cbc5SRafael J. Wysocki 
652d431cbc5SRafael J. Wysocki 		if (label && len == strlen(label) && !strncmp(buf, label, len))
653d431cbc5SRafael J. Wysocki 			return state;
654d431cbc5SRafael J. Wysocki 	}
655296699deSRafael J. Wysocki #endif
656296699deSRafael J. Wysocki 
6577483b4a4SRafael J. Wysocki 	return PM_SUSPEND_ON;
6587483b4a4SRafael J. Wysocki }
6597483b4a4SRafael J. Wysocki 
6607483b4a4SRafael J. Wysocki static ssize_t state_store(struct kobject *kobj, struct kobj_attribute *attr,
6617483b4a4SRafael J. Wysocki 			   const char *buf, size_t n)
6627483b4a4SRafael J. Wysocki {
6637483b4a4SRafael J. Wysocki 	suspend_state_t state;
6647483b4a4SRafael J. Wysocki 	int error;
6657483b4a4SRafael J. Wysocki 
6667483b4a4SRafael J. Wysocki 	error = pm_autosleep_lock();
6677483b4a4SRafael J. Wysocki 	if (error)
6687483b4a4SRafael J. Wysocki 		return error;
6697483b4a4SRafael J. Wysocki 
6707483b4a4SRafael J. Wysocki 	if (pm_autosleep_state() > PM_SUSPEND_ON) {
6717483b4a4SRafael J. Wysocki 		error = -EBUSY;
6727483b4a4SRafael J. Wysocki 		goto out;
6737483b4a4SRafael J. Wysocki 	}
6747483b4a4SRafael J. Wysocki 
6757483b4a4SRafael J. Wysocki 	state = decode_state(buf, n);
676406e7938SRafael J. Wysocki 	if (state < PM_SUSPEND_MAX) {
677406e7938SRafael J. Wysocki 		if (state == PM_SUSPEND_MEM)
678406e7938SRafael J. Wysocki 			state = mem_sleep_current;
679406e7938SRafael J. Wysocki 
6807483b4a4SRafael J. Wysocki 		error = pm_suspend(state);
681406e7938SRafael J. Wysocki 	} else if (state == PM_SUSPEND_MAX) {
6827483b4a4SRafael J. Wysocki 		error = hibernate();
683406e7938SRafael J. Wysocki 	} else {
6847483b4a4SRafael J. Wysocki 		error = -EINVAL;
685406e7938SRafael J. Wysocki 	}
6867483b4a4SRafael J. Wysocki 
6877483b4a4SRafael J. Wysocki  out:
6887483b4a4SRafael J. Wysocki 	pm_autosleep_unlock();
6891da177e4SLinus Torvalds 	return error ? error : n;
6901da177e4SLinus Torvalds }
6911da177e4SLinus Torvalds 
6921da177e4SLinus Torvalds power_attr(state);
6931da177e4SLinus Torvalds 
694c125e96fSRafael J. Wysocki #ifdef CONFIG_PM_SLEEP
695c125e96fSRafael J. Wysocki /*
696c125e96fSRafael J. Wysocki  * The 'wakeup_count' attribute, along with the functions defined in
697c125e96fSRafael J. Wysocki  * drivers/base/power/wakeup.c, provides a means by which wakeup events can be
698c125e96fSRafael J. Wysocki  * handled in a non-racy way.
699c125e96fSRafael J. Wysocki  *
700c125e96fSRafael J. Wysocki  * If a wakeup event occurs when the system is in a sleep state, it simply is
701c125e96fSRafael J. Wysocki  * woken up.  In turn, if an event that would wake the system up from a sleep
702c125e96fSRafael J. Wysocki  * state occurs when it is undergoing a transition to that sleep state, the
703c125e96fSRafael J. Wysocki  * transition should be aborted.  Moreover, if such an event occurs when the
704c125e96fSRafael J. Wysocki  * system is in the working state, an attempt to start a transition to the
705c125e96fSRafael J. Wysocki  * given sleep state should fail during certain period after the detection of
706c125e96fSRafael J. Wysocki  * the event.  Using the 'state' attribute alone is not sufficient to satisfy
707c125e96fSRafael J. Wysocki  * these requirements, because a wakeup event may occur exactly when 'state'
708c125e96fSRafael J. Wysocki  * is being written to and may be delivered to user space right before it is
709c125e96fSRafael J. Wysocki  * frozen, so the event will remain only partially processed until the system is
710c125e96fSRafael J. Wysocki  * woken up by another event.  In particular, it won't cause the transition to
711c125e96fSRafael J. Wysocki  * a sleep state to be aborted.
712c125e96fSRafael J. Wysocki  *
713c125e96fSRafael J. Wysocki  * This difficulty may be overcome if user space uses 'wakeup_count' before
714c125e96fSRafael J. Wysocki  * writing to 'state'.  It first should read from 'wakeup_count' and store
715c125e96fSRafael J. Wysocki  * the read value.  Then, after carrying out its own preparations for the system
716c125e96fSRafael J. Wysocki  * transition to a sleep state, it should write the stored value to
71725985edcSLucas De Marchi  * 'wakeup_count'.  If that fails, at least one wakeup event has occurred since
718c125e96fSRafael J. Wysocki  * 'wakeup_count' was read and 'state' should not be written to.  Otherwise, it
719c125e96fSRafael J. Wysocki  * is allowed to write to 'state', but the transition will be aborted if there
720c125e96fSRafael J. Wysocki  * are any wakeup events detected after 'wakeup_count' was written to.
721c125e96fSRafael J. Wysocki  */
722c125e96fSRafael J. Wysocki 
723c125e96fSRafael J. Wysocki static ssize_t wakeup_count_show(struct kobject *kobj,
724c125e96fSRafael J. Wysocki 				struct kobj_attribute *attr,
725c125e96fSRafael J. Wysocki 				char *buf)
726c125e96fSRafael J. Wysocki {
727074037ecSRafael J. Wysocki 	unsigned int val;
728c125e96fSRafael J. Wysocki 
7297483b4a4SRafael J. Wysocki 	return pm_get_wakeup_count(&val, true) ?
7307483b4a4SRafael J. Wysocki 		sprintf(buf, "%u\n", val) : -EINTR;
731c125e96fSRafael J. Wysocki }
732c125e96fSRafael J. Wysocki 
733c125e96fSRafael J. Wysocki static ssize_t wakeup_count_store(struct kobject *kobj,
734c125e96fSRafael J. Wysocki 				struct kobj_attribute *attr,
735c125e96fSRafael J. Wysocki 				const char *buf, size_t n)
736c125e96fSRafael J. Wysocki {
737074037ecSRafael J. Wysocki 	unsigned int val;
7387483b4a4SRafael J. Wysocki 	int error;
739c125e96fSRafael J. Wysocki 
7407483b4a4SRafael J. Wysocki 	error = pm_autosleep_lock();
7417483b4a4SRafael J. Wysocki 	if (error)
7427483b4a4SRafael J. Wysocki 		return error;
7437483b4a4SRafael J. Wysocki 
7447483b4a4SRafael J. Wysocki 	if (pm_autosleep_state() > PM_SUSPEND_ON) {
7457483b4a4SRafael J. Wysocki 		error = -EBUSY;
7467483b4a4SRafael J. Wysocki 		goto out;
7477483b4a4SRafael J. Wysocki 	}
7487483b4a4SRafael J. Wysocki 
7497483b4a4SRafael J. Wysocki 	error = -EINVAL;
750074037ecSRafael J. Wysocki 	if (sscanf(buf, "%u", &val) == 1) {
751c125e96fSRafael J. Wysocki 		if (pm_save_wakeup_count(val))
7527483b4a4SRafael J. Wysocki 			error = n;
753bb177fedSJulius Werner 		else
754bb177fedSJulius Werner 			pm_print_active_wakeup_sources();
755c125e96fSRafael J. Wysocki 	}
7567483b4a4SRafael J. Wysocki 
7577483b4a4SRafael J. Wysocki  out:
7587483b4a4SRafael J. Wysocki 	pm_autosleep_unlock();
7597483b4a4SRafael J. Wysocki 	return error;
760c125e96fSRafael J. Wysocki }
761c125e96fSRafael J. Wysocki 
762c125e96fSRafael J. Wysocki power_attr(wakeup_count);
7637483b4a4SRafael J. Wysocki 
7647483b4a4SRafael J. Wysocki #ifdef CONFIG_PM_AUTOSLEEP
7657483b4a4SRafael J. Wysocki static ssize_t autosleep_show(struct kobject *kobj,
7667483b4a4SRafael J. Wysocki 			      struct kobj_attribute *attr,
7677483b4a4SRafael J. Wysocki 			      char *buf)
7687483b4a4SRafael J. Wysocki {
7697483b4a4SRafael J. Wysocki 	suspend_state_t state = pm_autosleep_state();
7707483b4a4SRafael J. Wysocki 
7717483b4a4SRafael J. Wysocki 	if (state == PM_SUSPEND_ON)
7727483b4a4SRafael J. Wysocki 		return sprintf(buf, "off\n");
7737483b4a4SRafael J. Wysocki 
7747483b4a4SRafael J. Wysocki #ifdef CONFIG_SUSPEND
7757483b4a4SRafael J. Wysocki 	if (state < PM_SUSPEND_MAX)
776d431cbc5SRafael J. Wysocki 		return sprintf(buf, "%s\n", pm_states[state] ?
777d431cbc5SRafael J. Wysocki 					pm_states[state] : "error");
7787483b4a4SRafael J. Wysocki #endif
7797483b4a4SRafael J. Wysocki #ifdef CONFIG_HIBERNATION
7807483b4a4SRafael J. Wysocki 	return sprintf(buf, "disk\n");
7817483b4a4SRafael J. Wysocki #else
7827483b4a4SRafael J. Wysocki 	return sprintf(buf, "error");
7837483b4a4SRafael J. Wysocki #endif
7847483b4a4SRafael J. Wysocki }
7857483b4a4SRafael J. Wysocki 
7867483b4a4SRafael J. Wysocki static ssize_t autosleep_store(struct kobject *kobj,
7877483b4a4SRafael J. Wysocki 			       struct kobj_attribute *attr,
7887483b4a4SRafael J. Wysocki 			       const char *buf, size_t n)
7897483b4a4SRafael J. Wysocki {
7907483b4a4SRafael J. Wysocki 	suspend_state_t state = decode_state(buf, n);
7917483b4a4SRafael J. Wysocki 	int error;
7927483b4a4SRafael J. Wysocki 
7937483b4a4SRafael J. Wysocki 	if (state == PM_SUSPEND_ON
794040e5bf6SArve Hjønnevåg 	    && strcmp(buf, "off") && strcmp(buf, "off\n"))
7957483b4a4SRafael J. Wysocki 		return -EINVAL;
7967483b4a4SRafael J. Wysocki 
797406e7938SRafael J. Wysocki 	if (state == PM_SUSPEND_MEM)
798406e7938SRafael J. Wysocki 		state = mem_sleep_current;
799406e7938SRafael J. Wysocki 
8007483b4a4SRafael J. Wysocki 	error = pm_autosleep_set_state(state);
8017483b4a4SRafael J. Wysocki 	return error ? error : n;
8027483b4a4SRafael J. Wysocki }
8037483b4a4SRafael J. Wysocki 
8047483b4a4SRafael J. Wysocki power_attr(autosleep);
8057483b4a4SRafael J. Wysocki #endif /* CONFIG_PM_AUTOSLEEP */
806b86ff982SRafael J. Wysocki 
807b86ff982SRafael J. Wysocki #ifdef CONFIG_PM_WAKELOCKS
808b86ff982SRafael J. Wysocki static ssize_t wake_lock_show(struct kobject *kobj,
809b86ff982SRafael J. Wysocki 			      struct kobj_attribute *attr,
810b86ff982SRafael J. Wysocki 			      char *buf)
811b86ff982SRafael J. Wysocki {
812b86ff982SRafael J. Wysocki 	return pm_show_wakelocks(buf, true);
813b86ff982SRafael J. Wysocki }
814b86ff982SRafael J. Wysocki 
815b86ff982SRafael J. Wysocki static ssize_t wake_lock_store(struct kobject *kobj,
816b86ff982SRafael J. Wysocki 			       struct kobj_attribute *attr,
817b86ff982SRafael J. Wysocki 			       const char *buf, size_t n)
818b86ff982SRafael J. Wysocki {
819b86ff982SRafael J. Wysocki 	int error = pm_wake_lock(buf);
820b86ff982SRafael J. Wysocki 	return error ? error : n;
821b86ff982SRafael J. Wysocki }
822b86ff982SRafael J. Wysocki 
823b86ff982SRafael J. Wysocki power_attr(wake_lock);
824b86ff982SRafael J. Wysocki 
825b86ff982SRafael J. Wysocki static ssize_t wake_unlock_show(struct kobject *kobj,
826b86ff982SRafael J. Wysocki 				struct kobj_attribute *attr,
827b86ff982SRafael J. Wysocki 				char *buf)
828b86ff982SRafael J. Wysocki {
829b86ff982SRafael J. Wysocki 	return pm_show_wakelocks(buf, false);
830b86ff982SRafael J. Wysocki }
831b86ff982SRafael J. Wysocki 
832b86ff982SRafael J. Wysocki static ssize_t wake_unlock_store(struct kobject *kobj,
833b86ff982SRafael J. Wysocki 				 struct kobj_attribute *attr,
834b86ff982SRafael J. Wysocki 				 const char *buf, size_t n)
835b86ff982SRafael J. Wysocki {
836b86ff982SRafael J. Wysocki 	int error = pm_wake_unlock(buf);
837b86ff982SRafael J. Wysocki 	return error ? error : n;
838b86ff982SRafael J. Wysocki }
839b86ff982SRafael J. Wysocki 
840b86ff982SRafael J. Wysocki power_attr(wake_unlock);
841b86ff982SRafael J. Wysocki 
842b86ff982SRafael J. Wysocki #endif /* CONFIG_PM_WAKELOCKS */
843c125e96fSRafael J. Wysocki #endif /* CONFIG_PM_SLEEP */
844c125e96fSRafael J. Wysocki 
845c5c6ba4eSRafael J. Wysocki #ifdef CONFIG_PM_TRACE
846c5c6ba4eSRafael J. Wysocki int pm_trace_enabled;
847c5c6ba4eSRafael J. Wysocki 
848386f275fSKay Sievers static ssize_t pm_trace_show(struct kobject *kobj, struct kobj_attribute *attr,
849386f275fSKay Sievers 			     char *buf)
850c5c6ba4eSRafael J. Wysocki {
851c5c6ba4eSRafael J. Wysocki 	return sprintf(buf, "%d\n", pm_trace_enabled);
852c5c6ba4eSRafael J. Wysocki }
853c5c6ba4eSRafael J. Wysocki 
854c5c6ba4eSRafael J. Wysocki static ssize_t
855386f275fSKay Sievers pm_trace_store(struct kobject *kobj, struct kobj_attribute *attr,
856386f275fSKay Sievers 	       const char *buf, size_t n)
857c5c6ba4eSRafael J. Wysocki {
858c5c6ba4eSRafael J. Wysocki 	int val;
859c5c6ba4eSRafael J. Wysocki 
860c5c6ba4eSRafael J. Wysocki 	if (sscanf(buf, "%d", &val) == 1) {
861c5c6ba4eSRafael J. Wysocki 		pm_trace_enabled = !!val;
8629dceefe4SShuah Khan 		if (pm_trace_enabled) {
8639dceefe4SShuah Khan 			pr_warn("PM: Enabling pm_trace changes system date and time during resume.\n"
8649dceefe4SShuah Khan 				"PM: Correct system time has to be restored manually after resume.\n");
8659dceefe4SShuah Khan 		}
866c5c6ba4eSRafael J. Wysocki 		return n;
867c5c6ba4eSRafael J. Wysocki 	}
868c5c6ba4eSRafael J. Wysocki 	return -EINVAL;
869c5c6ba4eSRafael J. Wysocki }
870c5c6ba4eSRafael J. Wysocki 
871c5c6ba4eSRafael J. Wysocki power_attr(pm_trace);
872d33ac60bSJames Hogan 
873d33ac60bSJames Hogan static ssize_t pm_trace_dev_match_show(struct kobject *kobj,
874d33ac60bSJames Hogan 				       struct kobj_attribute *attr,
875d33ac60bSJames Hogan 				       char *buf)
876d33ac60bSJames Hogan {
877d33ac60bSJames Hogan 	return show_trace_dev_match(buf, PAGE_SIZE);
878d33ac60bSJames Hogan }
879d33ac60bSJames Hogan 
880a1e9ca69SRafael J. Wysocki power_attr_ro(pm_trace_dev_match);
881d33ac60bSJames Hogan 
8820e7d56e3SRafael J. Wysocki #endif /* CONFIG_PM_TRACE */
883c5c6ba4eSRafael J. Wysocki 
884957d1282SLi Fei #ifdef CONFIG_FREEZER
885957d1282SLi Fei static ssize_t pm_freeze_timeout_show(struct kobject *kobj,
886957d1282SLi Fei 				      struct kobj_attribute *attr, char *buf)
887957d1282SLi Fei {
888957d1282SLi Fei 	return sprintf(buf, "%u\n", freeze_timeout_msecs);
889957d1282SLi Fei }
890957d1282SLi Fei 
891957d1282SLi Fei static ssize_t pm_freeze_timeout_store(struct kobject *kobj,
892957d1282SLi Fei 				       struct kobj_attribute *attr,
893957d1282SLi Fei 				       const char *buf, size_t n)
894957d1282SLi Fei {
895957d1282SLi Fei 	unsigned long val;
896957d1282SLi Fei 
897957d1282SLi Fei 	if (kstrtoul(buf, 10, &val))
898957d1282SLi Fei 		return -EINVAL;
899957d1282SLi Fei 
900957d1282SLi Fei 	freeze_timeout_msecs = val;
901957d1282SLi Fei 	return n;
902957d1282SLi Fei }
903957d1282SLi Fei 
904957d1282SLi Fei power_attr(pm_freeze_timeout);
905957d1282SLi Fei 
906957d1282SLi Fei #endif	/* CONFIG_FREEZER*/
907957d1282SLi Fei 
908c5c6ba4eSRafael J. Wysocki static struct attribute * g[] = {
909c5c6ba4eSRafael J. Wysocki 	&state_attr.attr,
9100e7d56e3SRafael J. Wysocki #ifdef CONFIG_PM_TRACE
911c5c6ba4eSRafael J. Wysocki 	&pm_trace_attr.attr,
912d33ac60bSJames Hogan 	&pm_trace_dev_match_attr.attr,
9130e7d56e3SRafael J. Wysocki #endif
9140e06b4a8SRafael J. Wysocki #ifdef CONFIG_PM_SLEEP
9150e06b4a8SRafael J. Wysocki 	&pm_async_attr.attr,
916c125e96fSRafael J. Wysocki 	&wakeup_count_attr.attr,
917406e7938SRafael J. Wysocki #ifdef CONFIG_SUSPEND
918406e7938SRafael J. Wysocki 	&mem_sleep_attr.attr,
919c052bf82SJonas Meurer 	&sync_on_suspend_attr.attr,
920406e7938SRafael J. Wysocki #endif
9217483b4a4SRafael J. Wysocki #ifdef CONFIG_PM_AUTOSLEEP
9227483b4a4SRafael J. Wysocki 	&autosleep_attr.attr,
9237483b4a4SRafael J. Wysocki #endif
924b86ff982SRafael J. Wysocki #ifdef CONFIG_PM_WAKELOCKS
925b86ff982SRafael J. Wysocki 	&wake_lock_attr.attr,
926b86ff982SRafael J. Wysocki 	&wake_unlock_attr.attr,
927b86ff982SRafael J. Wysocki #endif
928b2df1d4fSRafael J. Wysocki #ifdef CONFIG_PM_SLEEP_DEBUG
929e516a1dbSRafael J. Wysocki 	&pm_test_attr.attr,
9304b7760baSSameer Nanda 	&pm_print_times_attr.attr,
931a6f5f0ddSAlexandra Yates 	&pm_wakeup_irq_attr.attr,
9328d8b2441SRafael J. Wysocki 	&pm_debug_messages_attr.attr,
9330e7d56e3SRafael J. Wysocki #endif
9340e06b4a8SRafael J. Wysocki #endif
935957d1282SLi Fei #ifdef CONFIG_FREEZER
936957d1282SLi Fei 	&pm_freeze_timeout_attr.attr,
937957d1282SLi Fei #endif
938c5c6ba4eSRafael J. Wysocki 	NULL,
939c5c6ba4eSRafael J. Wysocki };
9401da177e4SLinus Torvalds 
9411d0c6e59SArvind Yadav static const struct attribute_group attr_group = {
9421da177e4SLinus Torvalds 	.attrs = g,
9431da177e4SLinus Torvalds };
9441da177e4SLinus Torvalds 
9452c8db5beSKalesh Singh static const struct attribute_group *attr_groups[] = {
9462c8db5beSKalesh Singh 	&attr_group,
9472c8db5beSKalesh Singh #ifdef CONFIG_PM_SLEEP
9482c8db5beSKalesh Singh 	&suspend_attr_group,
9492c8db5beSKalesh Singh #endif
9502c8db5beSKalesh Singh 	NULL,
9512c8db5beSKalesh Singh };
9522c8db5beSKalesh Singh 
9535e928f77SRafael J. Wysocki struct workqueue_struct *pm_wq;
9547b199ca2SAlan Stern EXPORT_SYMBOL_GPL(pm_wq);
9555e928f77SRafael J. Wysocki 
9565e928f77SRafael J. Wysocki static int __init pm_start_workqueue(void)
9575e928f77SRafael J. Wysocki {
95858a69cb4STejun Heo 	pm_wq = alloc_workqueue("pm", WQ_FREEZABLE, 0);
9595e928f77SRafael J. Wysocki 
9605e928f77SRafael J. Wysocki 	return pm_wq ? 0 : -ENOMEM;
9615e928f77SRafael J. Wysocki }
9625e928f77SRafael J. Wysocki 
9631da177e4SLinus Torvalds static int __init pm_init(void)
9641da177e4SLinus Torvalds {
9655e928f77SRafael J. Wysocki 	int error = pm_start_workqueue();
9665e928f77SRafael J. Wysocki 	if (error)
9675e928f77SRafael J. Wysocki 		return error;
968ac5c24ecSRafael J. Wysocki 	hibernate_image_size_init();
969ddeb6487SRafael J. Wysocki 	hibernate_reserved_size_init();
970fa7fd6faSSudeep Holla 	pm_states_init();
971d76e15fbSGreg Kroah-Hartman 	power_kobj = kobject_create_and_add("power", NULL);
972d76e15fbSGreg Kroah-Hartman 	if (!power_kobj)
973039a5dcdSGreg Kroah-Hartman 		return -ENOMEM;
9742c8db5beSKalesh Singh 	error = sysfs_create_groups(power_kobj, attr_groups);
9757483b4a4SRafael J. Wysocki 	if (error)
9767483b4a4SRafael J. Wysocki 		return error;
977b2df1d4fSRafael J. Wysocki 	pm_print_times_init();
9787483b4a4SRafael J. Wysocki 	return pm_autosleep_init();
9791da177e4SLinus Torvalds }
9801da177e4SLinus Torvalds 
9811da177e4SLinus Torvalds core_initcall(pm_init);
982