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