1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_SUSPEND_H
3 #define _LINUX_SUSPEND_H
4 
5 #include <linux/swap.h>
6 #include <linux/notifier.h>
7 #include <linux/init.h>
8 #include <linux/pm.h>
9 #include <linux/mm.h>
10 #include <linux/freezer.h>
11 #include <asm/errno.h>
12 
13 #ifdef CONFIG_VT
14 extern void pm_set_vt_switch(int);
15 #else
pm_set_vt_switch(int do_switch)16 static inline void pm_set_vt_switch(int do_switch)
17 {
18 }
19 #endif
20 
21 #ifdef CONFIG_VT_CONSOLE_SLEEP
22 extern void pm_prepare_console(void);
23 extern void pm_restore_console(void);
24 #else
pm_prepare_console(void)25 static inline void pm_prepare_console(void)
26 {
27 }
28 
pm_restore_console(void)29 static inline void pm_restore_console(void)
30 {
31 }
32 #endif
33 
34 typedef int __bitwise suspend_state_t;
35 
36 #define PM_SUSPEND_ON		((__force suspend_state_t) 0)
37 #define PM_SUSPEND_TO_IDLE	((__force suspend_state_t) 1)
38 #define PM_SUSPEND_STANDBY	((__force suspend_state_t) 2)
39 #define PM_SUSPEND_MEM		((__force suspend_state_t) 3)
40 #define PM_SUSPEND_MIN		PM_SUSPEND_TO_IDLE
41 #define PM_SUSPEND_MAX		((__force suspend_state_t) 4)
42 
43 enum suspend_stat_step {
44 	SUSPEND_FREEZE = 1,
45 	SUSPEND_PREPARE,
46 	SUSPEND_SUSPEND,
47 	SUSPEND_SUSPEND_LATE,
48 	SUSPEND_SUSPEND_NOIRQ,
49 	SUSPEND_RESUME_NOIRQ,
50 	SUSPEND_RESUME_EARLY,
51 	SUSPEND_RESUME
52 };
53 
54 struct suspend_stats {
55 	int	success;
56 	int	fail;
57 	int	failed_freeze;
58 	int	failed_prepare;
59 	int	failed_suspend;
60 	int	failed_suspend_late;
61 	int	failed_suspend_noirq;
62 	int	failed_resume;
63 	int	failed_resume_early;
64 	int	failed_resume_noirq;
65 #define	REC_FAILED_NUM	2
66 	int	last_failed_dev;
67 	char	failed_devs[REC_FAILED_NUM][40];
68 	int	last_failed_errno;
69 	int	errno[REC_FAILED_NUM];
70 	int	last_failed_step;
71 	u64	last_hw_sleep;
72 	u64	total_hw_sleep;
73 	u64	max_hw_sleep;
74 	enum suspend_stat_step	failed_steps[REC_FAILED_NUM];
75 };
76 
77 extern struct suspend_stats suspend_stats;
78 
dpm_save_failed_dev(const char * name)79 static inline void dpm_save_failed_dev(const char *name)
80 {
81 	strscpy(suspend_stats.failed_devs[suspend_stats.last_failed_dev],
82 		name,
83 		sizeof(suspend_stats.failed_devs[0]));
84 	suspend_stats.last_failed_dev++;
85 	suspend_stats.last_failed_dev %= REC_FAILED_NUM;
86 }
87 
dpm_save_failed_errno(int err)88 static inline void dpm_save_failed_errno(int err)
89 {
90 	suspend_stats.errno[suspend_stats.last_failed_errno] = err;
91 	suspend_stats.last_failed_errno++;
92 	suspend_stats.last_failed_errno %= REC_FAILED_NUM;
93 }
94 
dpm_save_failed_step(enum suspend_stat_step step)95 static inline void dpm_save_failed_step(enum suspend_stat_step step)
96 {
97 	suspend_stats.failed_steps[suspend_stats.last_failed_step] = step;
98 	suspend_stats.last_failed_step++;
99 	suspend_stats.last_failed_step %= REC_FAILED_NUM;
100 }
101 
102 /**
103  * struct platform_suspend_ops - Callbacks for managing platform dependent
104  *	system sleep states.
105  *
106  * @valid: Callback to determine if given system sleep state is supported by
107  *	the platform.
108  *	Valid (ie. supported) states are advertised in /sys/power/state.  Note
109  *	that it still may be impossible to enter given system sleep state if the
110  *	conditions aren't right.
111  *	There is the %suspend_valid_only_mem function available that can be
112  *	assigned to this if the platform only supports mem sleep.
113  *
114  * @begin: Initialise a transition to given system sleep state.
115  *	@begin() is executed right prior to suspending devices.  The information
116  *	conveyed to the platform code by @begin() should be disregarded by it as
117  *	soon as @end() is executed.  If @begin() fails (ie. returns nonzero),
118  *	@prepare(), @enter() and @finish() will not be called by the PM core.
119  *	This callback is optional.  However, if it is implemented, the argument
120  *	passed to @enter() is redundant and should be ignored.
121  *
122  * @prepare: Prepare the platform for entering the system sleep state indicated
123  *	by @begin().
124  *	@prepare() is called right after devices have been suspended (ie. the
125  *	appropriate .suspend() method has been executed for each device) and
126  *	before device drivers' late suspend callbacks are executed.  It returns
127  *	0 on success or a negative error code otherwise, in which case the
128  *	system cannot enter the desired sleep state (@prepare_late(), @enter(),
129  *	and @wake() will not be called in that case).
130  *
131  * @prepare_late: Finish preparing the platform for entering the system sleep
132  *	state indicated by @begin().
133  *	@prepare_late is called before disabling nonboot CPUs and after
134  *	device drivers' late suspend callbacks have been executed.  It returns
135  *	0 on success or a negative error code otherwise, in which case the
136  *	system cannot enter the desired sleep state (@enter() will not be
137  *	executed).
138  *
139  * @enter: Enter the system sleep state indicated by @begin() or represented by
140  *	the argument if @begin() is not implemented.
141  *	This callback is mandatory.  It returns 0 on success or a negative
142  *	error code otherwise, in which case the system cannot enter the desired
143  *	sleep state.
144  *
145  * @wake: Called when the system has just left a sleep state, right after
146  *	the nonboot CPUs have been enabled and before device drivers' early
147  *	resume callbacks are executed.
148  *	This callback is optional, but should be implemented by the platforms
149  *	that implement @prepare_late().  If implemented, it is always called
150  *	after @prepare_late and @enter(), even if one of them fails.
151  *
152  * @finish: Finish wake-up of the platform.
153  *	@finish is called right prior to calling device drivers' regular suspend
154  *	callbacks.
155  *	This callback is optional, but should be implemented by the platforms
156  *	that implement @prepare().  If implemented, it is always called after
157  *	@enter() and @wake(), even if any of them fails.  It is executed after
158  *	a failing @prepare.
159  *
160  * @suspend_again: Returns whether the system should suspend again (true) or
161  *	not (false). If the platform wants to poll sensors or execute some
162  *	code during suspended without invoking userspace and most of devices,
163  *	suspend_again callback is the place assuming that periodic-wakeup or
164  *	alarm-wakeup is already setup. This allows to execute some codes while
165  *	being kept suspended in the view of userland and devices.
166  *
167  * @end: Called by the PM core right after resuming devices, to indicate to
168  *	the platform that the system has returned to the working state or
169  *	the transition to the sleep state has been aborted.
170  *	This callback is optional, but should be implemented by the platforms
171  *	that implement @begin().  Accordingly, platforms implementing @begin()
172  *	should also provide a @end() which cleans up transitions aborted before
173  *	@enter().
174  *
175  * @recover: Recover the platform from a suspend failure.
176  *	Called by the PM core if the suspending of devices fails.
177  *	This callback is optional and should only be implemented by platforms
178  *	which require special recovery actions in that situation.
179  */
180 struct platform_suspend_ops {
181 	int (*valid)(suspend_state_t state);
182 	int (*begin)(suspend_state_t state);
183 	int (*prepare)(void);
184 	int (*prepare_late)(void);
185 	int (*enter)(suspend_state_t state);
186 	void (*wake)(void);
187 	void (*finish)(void);
188 	bool (*suspend_again)(void);
189 	void (*end)(void);
190 	void (*recover)(void);
191 };
192 
193 struct platform_s2idle_ops {
194 	int (*begin)(void);
195 	int (*prepare)(void);
196 	int (*prepare_late)(void);
197 	void (*check)(void);
198 	bool (*wake)(void);
199 	void (*restore_early)(void);
200 	void (*restore)(void);
201 	void (*end)(void);
202 };
203 
204 #ifdef CONFIG_SUSPEND
205 extern suspend_state_t pm_suspend_target_state;
206 extern suspend_state_t mem_sleep_current;
207 extern suspend_state_t mem_sleep_default;
208 
209 /**
210  * suspend_set_ops - set platform dependent suspend operations
211  * @ops: The new suspend operations to set.
212  */
213 extern void suspend_set_ops(const struct platform_suspend_ops *ops);
214 extern int suspend_valid_only_mem(suspend_state_t state);
215 
216 extern unsigned int pm_suspend_global_flags;
217 
218 #define PM_SUSPEND_FLAG_FW_SUSPEND	BIT(0)
219 #define PM_SUSPEND_FLAG_FW_RESUME	BIT(1)
220 #define PM_SUSPEND_FLAG_NO_PLATFORM	BIT(2)
221 
pm_suspend_clear_flags(void)222 static inline void pm_suspend_clear_flags(void)
223 {
224 	pm_suspend_global_flags = 0;
225 }
226 
pm_set_suspend_via_firmware(void)227 static inline void pm_set_suspend_via_firmware(void)
228 {
229 	pm_suspend_global_flags |= PM_SUSPEND_FLAG_FW_SUSPEND;
230 }
231 
pm_set_resume_via_firmware(void)232 static inline void pm_set_resume_via_firmware(void)
233 {
234 	pm_suspend_global_flags |= PM_SUSPEND_FLAG_FW_RESUME;
235 }
236 
pm_set_suspend_no_platform(void)237 static inline void pm_set_suspend_no_platform(void)
238 {
239 	pm_suspend_global_flags |= PM_SUSPEND_FLAG_NO_PLATFORM;
240 }
241 
242 /**
243  * pm_suspend_via_firmware - Check if platform firmware will suspend the system.
244  *
245  * To be called during system-wide power management transitions to sleep states
246  * or during the subsequent system-wide transitions back to the working state.
247  *
248  * Return 'true' if the platform firmware is going to be invoked at the end of
249  * the system-wide power management transition (to a sleep state) in progress in
250  * order to complete it, or if the platform firmware has been invoked in order
251  * to complete the last (or preceding) transition of the system to a sleep
252  * state.
253  *
254  * This matters if the caller needs or wants to carry out some special actions
255  * depending on whether or not control will be passed to the platform firmware
256  * subsequently (for example, the device may need to be reset before letting the
257  * platform firmware manipulate it, which is not necessary when the platform
258  * firmware is not going to be invoked) or when such special actions may have
259  * been carried out during the preceding transition of the system to a sleep
260  * state (as they may need to be taken into account).
261  */
pm_suspend_via_firmware(void)262 static inline bool pm_suspend_via_firmware(void)
263 {
264 	return !!(pm_suspend_global_flags & PM_SUSPEND_FLAG_FW_SUSPEND);
265 }
266 
267 /**
268  * pm_resume_via_firmware - Check if platform firmware has woken up the system.
269  *
270  * To be called during system-wide power management transitions from sleep
271  * states.
272  *
273  * Return 'true' if the platform firmware has passed control to the kernel at
274  * the beginning of the system-wide power management transition in progress, so
275  * the event that woke up the system from sleep has been handled by the platform
276  * firmware.
277  */
pm_resume_via_firmware(void)278 static inline bool pm_resume_via_firmware(void)
279 {
280 	return !!(pm_suspend_global_flags & PM_SUSPEND_FLAG_FW_RESUME);
281 }
282 
283 /**
284  * pm_suspend_no_platform - Check if platform may change device power states.
285  *
286  * To be called during system-wide power management transitions to sleep states
287  * or during the subsequent system-wide transitions back to the working state.
288  *
289  * Return 'true' if the power states of devices remain under full control of the
290  * kernel throughout the system-wide suspend and resume cycle in progress (that
291  * is, if a device is put into a certain power state during suspend, it can be
292  * expected to remain in that state during resume).
293  */
pm_suspend_no_platform(void)294 static inline bool pm_suspend_no_platform(void)
295 {
296 	return !!(pm_suspend_global_flags & PM_SUSPEND_FLAG_NO_PLATFORM);
297 }
298 
299 /* Suspend-to-idle state machnine. */
300 enum s2idle_states {
301 	S2IDLE_STATE_NONE,      /* Not suspended/suspending. */
302 	S2IDLE_STATE_ENTER,     /* Enter suspend-to-idle. */
303 	S2IDLE_STATE_WAKE,      /* Wake up from suspend-to-idle. */
304 };
305 
306 extern enum s2idle_states __read_mostly s2idle_state;
307 
idle_should_enter_s2idle(void)308 static inline bool idle_should_enter_s2idle(void)
309 {
310 	return unlikely(s2idle_state == S2IDLE_STATE_ENTER);
311 }
312 
313 extern bool pm_suspend_default_s2idle(void);
314 extern void __init pm_states_init(void);
315 extern void s2idle_set_ops(const struct platform_s2idle_ops *ops);
316 extern void s2idle_wake(void);
317 
318 /**
319  * arch_suspend_disable_irqs - disable IRQs for suspend
320  *
321  * Disables IRQs (in the default case). This is a weak symbol in the common
322  * code and thus allows architectures to override it if more needs to be
323  * done. Not called for suspend to disk.
324  */
325 extern void arch_suspend_disable_irqs(void);
326 
327 /**
328  * arch_suspend_enable_irqs - enable IRQs after suspend
329  *
330  * Enables IRQs (in the default case). This is a weak symbol in the common
331  * code and thus allows architectures to override it if more needs to be
332  * done. Not called for suspend to disk.
333  */
334 extern void arch_suspend_enable_irqs(void);
335 
336 extern int pm_suspend(suspend_state_t state);
337 extern bool sync_on_suspend_enabled;
338 #else /* !CONFIG_SUSPEND */
339 #define suspend_valid_only_mem	NULL
340 
341 #define pm_suspend_target_state	(PM_SUSPEND_ON)
342 
pm_suspend_clear_flags(void)343 static inline void pm_suspend_clear_flags(void) {}
pm_set_suspend_via_firmware(void)344 static inline void pm_set_suspend_via_firmware(void) {}
pm_set_resume_via_firmware(void)345 static inline void pm_set_resume_via_firmware(void) {}
pm_suspend_via_firmware(void)346 static inline bool pm_suspend_via_firmware(void) { return false; }
pm_resume_via_firmware(void)347 static inline bool pm_resume_via_firmware(void) { return false; }
pm_suspend_no_platform(void)348 static inline bool pm_suspend_no_platform(void) { return false; }
pm_suspend_default_s2idle(void)349 static inline bool pm_suspend_default_s2idle(void) { return false; }
350 
suspend_set_ops(const struct platform_suspend_ops * ops)351 static inline void suspend_set_ops(const struct platform_suspend_ops *ops) {}
pm_suspend(suspend_state_t state)352 static inline int pm_suspend(suspend_state_t state) { return -ENOSYS; }
sync_on_suspend_enabled(void)353 static inline bool sync_on_suspend_enabled(void) { return true; }
idle_should_enter_s2idle(void)354 static inline bool idle_should_enter_s2idle(void) { return false; }
pm_states_init(void)355 static inline void __init pm_states_init(void) {}
s2idle_set_ops(const struct platform_s2idle_ops * ops)356 static inline void s2idle_set_ops(const struct platform_s2idle_ops *ops) {}
s2idle_wake(void)357 static inline void s2idle_wake(void) {}
358 #endif /* !CONFIG_SUSPEND */
359 
360 /* struct pbe is used for creating lists of pages that should be restored
361  * atomically during the resume from disk, because the page frames they have
362  * occupied before the suspend are in use.
363  */
364 struct pbe {
365 	void *address;		/* address of the copy */
366 	void *orig_address;	/* original address of a page */
367 	struct pbe *next;
368 };
369 
370 /**
371  * struct platform_hibernation_ops - hibernation platform support
372  *
373  * The methods in this structure allow a platform to carry out special
374  * operations required by it during a hibernation transition.
375  *
376  * All the methods below, except for @recover(), must be implemented.
377  *
378  * @begin: Tell the platform driver that we're starting hibernation.
379  *	Called right after shrinking memory and before freezing devices.
380  *
381  * @end: Called by the PM core right after resuming devices, to indicate to
382  *	the platform that the system has returned to the working state.
383  *
384  * @pre_snapshot: Prepare the platform for creating the hibernation image.
385  *	Called right after devices have been frozen and before the nonboot
386  *	CPUs are disabled (runs with IRQs on).
387  *
388  * @finish: Restore the previous state of the platform after the hibernation
389  *	image has been created *or* put the platform into the normal operation
390  *	mode after the hibernation (the same method is executed in both cases).
391  *	Called right after the nonboot CPUs have been enabled and before
392  *	thawing devices (runs with IRQs on).
393  *
394  * @prepare: Prepare the platform for entering the low power state.
395  *	Called right after the hibernation image has been saved and before
396  *	devices are prepared for entering the low power state.
397  *
398  * @enter: Put the system into the low power state after the hibernation image
399  *	has been saved to disk.
400  *	Called after the nonboot CPUs have been disabled and all of the low
401  *	level devices have been shut down (runs with IRQs off).
402  *
403  * @leave: Perform the first stage of the cleanup after the system sleep state
404  *	indicated by @set_target() has been left.
405  *	Called right after the control has been passed from the boot kernel to
406  *	the image kernel, before the nonboot CPUs are enabled and before devices
407  *	are resumed.  Executed with interrupts disabled.
408  *
409  * @pre_restore: Prepare system for the restoration from a hibernation image.
410  *	Called right after devices have been frozen and before the nonboot
411  *	CPUs are disabled (runs with IRQs on).
412  *
413  * @restore_cleanup: Clean up after a failing image restoration.
414  *	Called right after the nonboot CPUs have been enabled and before
415  *	thawing devices (runs with IRQs on).
416  *
417  * @recover: Recover the platform from a failure to suspend devices.
418  *	Called by the PM core if the suspending of devices during hibernation
419  *	fails.  This callback is optional and should only be implemented by
420  *	platforms which require special recovery actions in that situation.
421  */
422 struct platform_hibernation_ops {
423 	int (*begin)(pm_message_t stage);
424 	void (*end)(void);
425 	int (*pre_snapshot)(void);
426 	void (*finish)(void);
427 	int (*prepare)(void);
428 	int (*enter)(void);
429 	void (*leave)(void);
430 	int (*pre_restore)(void);
431 	void (*restore_cleanup)(void);
432 	void (*recover)(void);
433 };
434 
435 #ifdef CONFIG_HIBERNATION
436 /* kernel/power/snapshot.c */
437 extern void register_nosave_region(unsigned long b, unsigned long e);
438 extern int swsusp_page_is_forbidden(struct page *);
439 extern void swsusp_set_page_free(struct page *);
440 extern void swsusp_unset_page_free(struct page *);
441 extern unsigned long get_safe_page(gfp_t gfp_mask);
442 extern asmlinkage int swsusp_arch_suspend(void);
443 extern asmlinkage int swsusp_arch_resume(void);
444 
445 extern u32 swsusp_hardware_signature;
446 extern void hibernation_set_ops(const struct platform_hibernation_ops *ops);
447 extern int hibernate(void);
448 extern bool system_entering_hibernation(void);
449 extern bool hibernation_available(void);
450 asmlinkage int swsusp_save(void);
451 extern struct pbe *restore_pblist;
452 int pfn_is_nosave(unsigned long pfn);
453 
454 int hibernate_quiet_exec(int (*func)(void *data), void *data);
455 int hibernate_resume_nonboot_cpu_disable(void);
456 int arch_hibernation_header_save(void *addr, unsigned int max_size);
457 int arch_hibernation_header_restore(void *addr);
458 
459 #else /* CONFIG_HIBERNATION */
register_nosave_region(unsigned long b,unsigned long e)460 static inline void register_nosave_region(unsigned long b, unsigned long e) {}
swsusp_page_is_forbidden(struct page * p)461 static inline int swsusp_page_is_forbidden(struct page *p) { return 0; }
swsusp_set_page_free(struct page * p)462 static inline void swsusp_set_page_free(struct page *p) {}
swsusp_unset_page_free(struct page * p)463 static inline void swsusp_unset_page_free(struct page *p) {}
464 
hibernation_set_ops(const struct platform_hibernation_ops * ops)465 static inline void hibernation_set_ops(const struct platform_hibernation_ops *ops) {}
hibernate(void)466 static inline int hibernate(void) { return -ENOSYS; }
system_entering_hibernation(void)467 static inline bool system_entering_hibernation(void) { return false; }
hibernation_available(void)468 static inline bool hibernation_available(void) { return false; }
469 
hibernate_quiet_exec(int (* func)(void * data),void * data)470 static inline int hibernate_quiet_exec(int (*func)(void *data), void *data) {
471 	return -ENOTSUPP;
472 }
473 #endif /* CONFIG_HIBERNATION */
474 
475 int arch_resume_nosmt(void);
476 
477 #ifdef CONFIG_HIBERNATION_SNAPSHOT_DEV
478 int is_hibernate_resume_dev(dev_t dev);
479 #else
is_hibernate_resume_dev(dev_t dev)480 static inline int is_hibernate_resume_dev(dev_t dev) { return 0; }
481 #endif
482 
483 /* Hibernation and suspend events */
484 #define PM_HIBERNATION_PREPARE	0x0001 /* Going to hibernate */
485 #define PM_POST_HIBERNATION	0x0002 /* Hibernation finished */
486 #define PM_SUSPEND_PREPARE	0x0003 /* Going to suspend the system */
487 #define PM_POST_SUSPEND		0x0004 /* Suspend finished */
488 #define PM_RESTORE_PREPARE	0x0005 /* Going to restore a saved image */
489 #define PM_POST_RESTORE		0x0006 /* Restore failed */
490 
491 extern struct mutex system_transition_mutex;
492 
493 #ifdef CONFIG_PM_SLEEP
494 void save_processor_state(void);
495 void restore_processor_state(void);
496 
497 /* kernel/power/main.c */
498 extern int register_pm_notifier(struct notifier_block *nb);
499 extern int unregister_pm_notifier(struct notifier_block *nb);
500 extern void ksys_sync_helper(void);
501 extern void pm_report_hw_sleep_time(u64 t);
502 extern void pm_report_max_hw_sleep(u64 t);
503 
504 #define pm_notifier(fn, pri) {				\
505 	static struct notifier_block fn##_nb =			\
506 		{ .notifier_call = fn, .priority = pri };	\
507 	register_pm_notifier(&fn##_nb);			\
508 }
509 
510 /* drivers/base/power/wakeup.c */
511 extern bool events_check_enabled;
512 
pm_suspended_storage(void)513 static inline bool pm_suspended_storage(void)
514 {
515 	return !gfp_has_io_fs(gfp_allowed_mask);
516 }
517 
518 extern bool pm_wakeup_pending(void);
519 extern void pm_system_wakeup(void);
520 extern void pm_system_cancel_wakeup(void);
521 extern void pm_wakeup_clear(unsigned int irq_number);
522 extern void pm_system_irq_wakeup(unsigned int irq_number);
523 extern unsigned int pm_wakeup_irq(void);
524 extern bool pm_get_wakeup_count(unsigned int *count, bool block);
525 extern bool pm_save_wakeup_count(unsigned int count);
526 extern void pm_wakep_autosleep_enabled(bool set);
527 extern void pm_print_active_wakeup_sources(void);
528 
529 extern unsigned int lock_system_sleep(void);
530 extern void unlock_system_sleep(unsigned int);
531 
532 #else /* !CONFIG_PM_SLEEP */
533 
register_pm_notifier(struct notifier_block * nb)534 static inline int register_pm_notifier(struct notifier_block *nb)
535 {
536 	return 0;
537 }
538 
unregister_pm_notifier(struct notifier_block * nb)539 static inline int unregister_pm_notifier(struct notifier_block *nb)
540 {
541 	return 0;
542 }
543 
pm_report_hw_sleep_time(u64 t)544 static inline void pm_report_hw_sleep_time(u64 t) {};
pm_report_max_hw_sleep(u64 t)545 static inline void pm_report_max_hw_sleep(u64 t) {};
546 
ksys_sync_helper(void)547 static inline void ksys_sync_helper(void) {}
548 
549 #define pm_notifier(fn, pri)	do { (void)(fn); } while (0)
550 
pm_suspended_storage(void)551 static inline bool pm_suspended_storage(void) { return false; }
pm_wakeup_pending(void)552 static inline bool pm_wakeup_pending(void) { return false; }
pm_system_wakeup(void)553 static inline void pm_system_wakeup(void) {}
pm_wakeup_clear(bool reset)554 static inline void pm_wakeup_clear(bool reset) {}
pm_system_irq_wakeup(unsigned int irq_number)555 static inline void pm_system_irq_wakeup(unsigned int irq_number) {}
556 
lock_system_sleep(void)557 static inline unsigned int lock_system_sleep(void) { return 0; }
unlock_system_sleep(unsigned int flags)558 static inline void unlock_system_sleep(unsigned int flags) {}
559 
560 #endif /* !CONFIG_PM_SLEEP */
561 
562 #ifdef CONFIG_PM_SLEEP_DEBUG
563 extern bool pm_print_times_enabled;
564 extern bool pm_debug_messages_on;
565 extern bool pm_debug_messages_should_print(void);
pm_dyn_debug_messages_on(void)566 static inline int pm_dyn_debug_messages_on(void)
567 {
568 #ifdef CONFIG_DYNAMIC_DEBUG
569 	return 1;
570 #else
571 	return 0;
572 #endif
573 }
574 #ifndef pr_fmt
575 #define pr_fmt(fmt) "PM: " fmt
576 #endif
577 #define __pm_pr_dbg(fmt, ...)					\
578 	do {							\
579 		if (pm_debug_messages_should_print())		\
580 			printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__);	\
581 		else if (pm_dyn_debug_messages_on())		\
582 			pr_debug(fmt, ##__VA_ARGS__);	\
583 	} while (0)
584 #define __pm_deferred_pr_dbg(fmt, ...)				\
585 	do {							\
586 		if (pm_debug_messages_should_print())		\
587 			printk_deferred(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__);	\
588 	} while (0)
589 #else
590 #define pm_print_times_enabled	(false)
591 #define pm_debug_messages_on	(false)
592 
593 #include <linux/printk.h>
594 
595 #define __pm_pr_dbg(fmt, ...) \
596 	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
597 #define __pm_deferred_pr_dbg(fmt, ...) \
598 	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
599 #endif
600 
601 /**
602  * pm_pr_dbg - print pm sleep debug messages
603  *
604  * If pm_debug_messages_on is enabled and the system is entering/leaving
605  *      suspend, print message.
606  * If pm_debug_messages_on is disabled and CONFIG_DYNAMIC_DEBUG is enabled,
607  *	print message only from instances explicitly enabled on dynamic debug's
608  *	control.
609  * If pm_debug_messages_on is disabled and CONFIG_DYNAMIC_DEBUG is disabled,
610  *	don't print message.
611  */
612 #define pm_pr_dbg(fmt, ...) \
613 	__pm_pr_dbg(fmt, ##__VA_ARGS__)
614 
615 #define pm_deferred_pr_dbg(fmt, ...) \
616 	__pm_deferred_pr_dbg(fmt, ##__VA_ARGS__)
617 
618 #ifdef CONFIG_PM_AUTOSLEEP
619 
620 /* kernel/power/autosleep.c */
621 void queue_up_suspend_work(void);
622 
623 #else /* !CONFIG_PM_AUTOSLEEP */
624 
queue_up_suspend_work(void)625 static inline void queue_up_suspend_work(void) {}
626 
627 #endif /* !CONFIG_PM_AUTOSLEEP */
628 
629 #endif /* _LINUX_SUSPEND_H */
630