1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_SUSPEND_H
3 #define _LINUX_SUSPEND_H
5 #include <linux/swap.h>
6 #include <linux/notifier.h>
7 #include <linux/init.h>
10 #include <linux/freezer.h>
11 #include <asm/errno.h>
14 extern void pm_set_vt_switch(int);
16 static inline void pm_set_vt_switch(int do_switch)
21 #ifdef CONFIG_VT_CONSOLE_SLEEP
22 extern void pm_prepare_console(void);
23 extern void pm_restore_console(void);
25 static inline void pm_prepare_console(void)
29 static inline void pm_restore_console(void)
34 typedef int __bitwise suspend_state_t;
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)
43 enum suspend_stat_step {
48 SUSPEND_SUSPEND_NOIRQ,
54 struct suspend_stats {
60 int failed_suspend_late;
61 int failed_suspend_noirq;
63 int failed_resume_early;
64 int failed_resume_noirq;
65 #define REC_FAILED_NUM 2
67 char failed_devs[REC_FAILED_NUM][40];
68 int last_failed_errno;
69 int errno[REC_FAILED_NUM];
71 enum suspend_stat_step failed_steps[REC_FAILED_NUM];
74 extern struct suspend_stats suspend_stats;
76 static inline void dpm_save_failed_dev(const char *name)
78 strlcpy(suspend_stats.failed_devs[suspend_stats.last_failed_dev],
80 sizeof(suspend_stats.failed_devs[0]));
81 suspend_stats.last_failed_dev++;
82 suspend_stats.last_failed_dev %= REC_FAILED_NUM;
85 static inline void dpm_save_failed_errno(int err)
87 suspend_stats.errno[suspend_stats.last_failed_errno] = err;
88 suspend_stats.last_failed_errno++;
89 suspend_stats.last_failed_errno %= REC_FAILED_NUM;
92 static inline void dpm_save_failed_step(enum suspend_stat_step step)
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;
100 * struct platform_suspend_ops - Callbacks for managing platform dependent
101 * system sleep states.
103 * @valid: Callback to determine if given system sleep state is supported by
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.
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.
119 * @prepare: Prepare the platform for entering the system sleep state indicated
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).
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
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
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.
149 * @finish: Finish wake-up of the platform.
150 * @finish is called right prior to calling device drivers' regular suspend
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.
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.
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
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.
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);
184 void (*finish)(void);
185 bool (*suspend_again)(void);
187 void (*recover)(void);
190 struct platform_s2idle_ops {
192 int (*prepare)(void);
195 void (*restore)(void);
199 #ifdef CONFIG_SUSPEND
200 extern suspend_state_t mem_sleep_current;
201 extern suspend_state_t mem_sleep_default;
204 * suspend_set_ops - set platform dependent suspend operations
205 * @ops: The new suspend operations to set.
207 extern void suspend_set_ops(const struct platform_suspend_ops *ops);
208 extern int suspend_valid_only_mem(suspend_state_t state);
210 extern unsigned int pm_suspend_global_flags;
212 #define PM_SUSPEND_FLAG_FW_SUSPEND (1 << 0)
213 #define PM_SUSPEND_FLAG_FW_RESUME (1 << 1)
215 static inline void pm_suspend_clear_flags(void)
217 pm_suspend_global_flags = 0;
220 static inline void pm_set_suspend_via_firmware(void)
222 pm_suspend_global_flags |= PM_SUSPEND_FLAG_FW_SUSPEND;
225 static inline void pm_set_resume_via_firmware(void)
227 pm_suspend_global_flags |= PM_SUSPEND_FLAG_FW_RESUME;
231 * pm_suspend_via_firmware - Check if platform firmware will suspend the system.
233 * To be called during system-wide power management transitions to sleep states
234 * or during the subsequent system-wide transitions back to the working state.
236 * Return 'true' if the platform firmware is going to be invoked at the end of
237 * the system-wide power management transition (to a sleep state) in progress in
238 * order to complete it, or if the platform firmware has been invoked in order
239 * to complete the last (or preceding) transition of the system to a sleep
242 * This matters if the caller needs or wants to carry out some special actions
243 * depending on whether or not control will be passed to the platform firmware
244 * subsequently (for example, the device may need to be reset before letting the
245 * platform firmware manipulate it, which is not necessary when the platform
246 * firmware is not going to be invoked) or when such special actions may have
247 * been carried out during the preceding transition of the system to a sleep
248 * state (as they may need to be taken into account).
250 static inline bool pm_suspend_via_firmware(void)
252 return !!(pm_suspend_global_flags & PM_SUSPEND_FLAG_FW_SUSPEND);
256 * pm_resume_via_firmware - Check if platform firmware has woken up the system.
258 * To be called during system-wide power management transitions from sleep
261 * Return 'true' if the platform firmware has passed control to the kernel at
262 * the beginning of the system-wide power management transition in progress, so
263 * the event that woke up the system from sleep has been handled by the platform
266 static inline bool pm_resume_via_firmware(void)
268 return !!(pm_suspend_global_flags & PM_SUSPEND_FLAG_FW_RESUME);
271 /* Suspend-to-idle state machnine. */
273 S2IDLE_STATE_NONE, /* Not suspended/suspending. */
274 S2IDLE_STATE_ENTER, /* Enter suspend-to-idle. */
275 S2IDLE_STATE_WAKE, /* Wake up from suspend-to-idle. */
278 extern enum s2idle_states __read_mostly s2idle_state;
280 static inline bool idle_should_enter_s2idle(void)
282 return unlikely(s2idle_state == S2IDLE_STATE_ENTER);
285 extern bool pm_suspend_via_s2idle(void);
286 extern void __init pm_states_init(void);
287 extern void s2idle_set_ops(const struct platform_s2idle_ops *ops);
288 extern void s2idle_wake(void);
291 * arch_suspend_disable_irqs - disable IRQs for suspend
293 * Disables IRQs (in the default case). This is a weak symbol in the common
294 * code and thus allows architectures to override it if more needs to be
295 * done. Not called for suspend to disk.
297 extern void arch_suspend_disable_irqs(void);
300 * arch_suspend_enable_irqs - enable IRQs after suspend
302 * Enables IRQs (in the default case). This is a weak symbol in the common
303 * code and thus allows architectures to override it if more needs to be
304 * done. Not called for suspend to disk.
306 extern void arch_suspend_enable_irqs(void);
308 extern int pm_suspend(suspend_state_t state);
309 #else /* !CONFIG_SUSPEND */
310 #define suspend_valid_only_mem NULL
312 static inline void pm_suspend_clear_flags(void) {}
313 static inline void pm_set_suspend_via_firmware(void) {}
314 static inline void pm_set_resume_via_firmware(void) {}
315 static inline bool pm_suspend_via_firmware(void) { return false; }
316 static inline bool pm_resume_via_firmware(void) { return false; }
317 static inline bool pm_suspend_via_s2idle(void) { return false; }
319 static inline void suspend_set_ops(const struct platform_suspend_ops *ops) {}
320 static inline int pm_suspend(suspend_state_t state) { return -ENOSYS; }
321 static inline bool idle_should_enter_s2idle(void) { return false; }
322 static inline void __init pm_states_init(void) {}
323 static inline void s2idle_set_ops(const struct platform_s2idle_ops *ops) {}
324 static inline void s2idle_wake(void) {}
325 #endif /* !CONFIG_SUSPEND */
327 /* struct pbe is used for creating lists of pages that should be restored
328 * atomically during the resume from disk, because the page frames they have
329 * occupied before the suspend are in use.
332 void *address; /* address of the copy */
333 void *orig_address; /* original address of a page */
337 /* mm/page_alloc.c */
338 extern void mark_free_pages(struct zone *zone);
341 * struct platform_hibernation_ops - hibernation platform support
343 * The methods in this structure allow a platform to carry out special
344 * operations required by it during a hibernation transition.
346 * All the methods below, except for @recover(), must be implemented.
348 * @begin: Tell the platform driver that we're starting hibernation.
349 * Called right after shrinking memory and before freezing devices.
351 * @end: Called by the PM core right after resuming devices, to indicate to
352 * the platform that the system has returned to the working state.
354 * @pre_snapshot: Prepare the platform for creating the hibernation image.
355 * Called right after devices have been frozen and before the nonboot
356 * CPUs are disabled (runs with IRQs on).
358 * @finish: Restore the previous state of the platform after the hibernation
359 * image has been created *or* put the platform into the normal operation
360 * mode after the hibernation (the same method is executed in both cases).
361 * Called right after the nonboot CPUs have been enabled and before
362 * thawing devices (runs with IRQs on).
364 * @prepare: Prepare the platform for entering the low power state.
365 * Called right after the hibernation image has been saved and before
366 * devices are prepared for entering the low power state.
368 * @enter: Put the system into the low power state after the hibernation image
369 * has been saved to disk.
370 * Called after the nonboot CPUs have been disabled and all of the low
371 * level devices have been shut down (runs with IRQs off).
373 * @leave: Perform the first stage of the cleanup after the system sleep state
374 * indicated by @set_target() has been left.
375 * Called right after the control has been passed from the boot kernel to
376 * the image kernel, before the nonboot CPUs are enabled and before devices
377 * are resumed. Executed with interrupts disabled.
379 * @pre_restore: Prepare system for the restoration from a hibernation image.
380 * Called right after devices have been frozen and before the nonboot
381 * CPUs are disabled (runs with IRQs on).
383 * @restore_cleanup: Clean up after a failing image restoration.
384 * Called right after the nonboot CPUs have been enabled and before
385 * thawing devices (runs with IRQs on).
387 * @recover: Recover the platform from a failure to suspend devices.
388 * Called by the PM core if the suspending of devices during hibernation
389 * fails. This callback is optional and should only be implemented by
390 * platforms which require special recovery actions in that situation.
392 struct platform_hibernation_ops {
393 int (*begin)(pm_message_t stage);
395 int (*pre_snapshot)(void);
396 void (*finish)(void);
397 int (*prepare)(void);
400 int (*pre_restore)(void);
401 void (*restore_cleanup)(void);
402 void (*recover)(void);
405 #ifdef CONFIG_HIBERNATION
406 /* kernel/power/snapshot.c */
407 extern void __register_nosave_region(unsigned long b, unsigned long e, int km);
408 static inline void __init register_nosave_region(unsigned long b, unsigned long e)
410 __register_nosave_region(b, e, 0);
412 static inline void __init register_nosave_region_late(unsigned long b, unsigned long e)
414 __register_nosave_region(b, e, 1);
416 extern int swsusp_page_is_forbidden(struct page *);
417 extern void swsusp_set_page_free(struct page *);
418 extern void swsusp_unset_page_free(struct page *);
419 extern unsigned long get_safe_page(gfp_t gfp_mask);
420 extern asmlinkage int swsusp_arch_suspend(void);
421 extern asmlinkage int swsusp_arch_resume(void);
423 extern void hibernation_set_ops(const struct platform_hibernation_ops *ops);
424 extern int hibernate(void);
425 extern bool system_entering_hibernation(void);
426 extern bool hibernation_available(void);
427 asmlinkage int swsusp_save(void);
428 extern struct pbe *restore_pblist;
429 #else /* CONFIG_HIBERNATION */
430 static inline void register_nosave_region(unsigned long b, unsigned long e) {}
431 static inline void register_nosave_region_late(unsigned long b, unsigned long e) {}
432 static inline int swsusp_page_is_forbidden(struct page *p) { return 0; }
433 static inline void swsusp_set_page_free(struct page *p) {}
434 static inline void swsusp_unset_page_free(struct page *p) {}
436 static inline void hibernation_set_ops(const struct platform_hibernation_ops *ops) {}
437 static inline int hibernate(void) { return -ENOSYS; }
438 static inline bool system_entering_hibernation(void) { return false; }
439 static inline bool hibernation_available(void) { return false; }
440 #endif /* CONFIG_HIBERNATION */
442 /* Hibernation and suspend events */
443 #define PM_HIBERNATION_PREPARE 0x0001 /* Going to hibernate */
444 #define PM_POST_HIBERNATION 0x0002 /* Hibernation finished */
445 #define PM_SUSPEND_PREPARE 0x0003 /* Going to suspend the system */
446 #define PM_POST_SUSPEND 0x0004 /* Suspend finished */
447 #define PM_RESTORE_PREPARE 0x0005 /* Going to restore a saved image */
448 #define PM_POST_RESTORE 0x0006 /* Restore failed */
450 extern struct mutex system_transition_mutex;
452 #ifdef CONFIG_PM_SLEEP
453 void save_processor_state(void);
454 void restore_processor_state(void);
456 /* kernel/power/main.c */
457 extern int register_pm_notifier(struct notifier_block *nb);
458 extern int unregister_pm_notifier(struct notifier_block *nb);
459 extern void ksys_sync_helper(void);
461 #define pm_notifier(fn, pri) { \
462 static struct notifier_block fn##_nb = \
463 { .notifier_call = fn, .priority = pri }; \
464 register_pm_notifier(&fn##_nb); \
467 /* drivers/base/power/wakeup.c */
468 extern bool events_check_enabled;
469 extern unsigned int pm_wakeup_irq;
470 extern suspend_state_t pm_suspend_target_state;
472 extern bool pm_wakeup_pending(void);
473 extern void pm_system_wakeup(void);
474 extern void pm_system_cancel_wakeup(void);
475 extern void pm_wakeup_clear(bool reset);
476 extern void pm_system_irq_wakeup(unsigned int irq_number);
477 extern bool pm_get_wakeup_count(unsigned int *count, bool block);
478 extern bool pm_save_wakeup_count(unsigned int count);
479 extern void pm_wakep_autosleep_enabled(bool set);
480 extern void pm_print_active_wakeup_sources(void);
482 extern void lock_system_sleep(void);
483 extern void unlock_system_sleep(void);
485 #else /* !CONFIG_PM_SLEEP */
487 static inline int register_pm_notifier(struct notifier_block *nb)
492 static inline int unregister_pm_notifier(struct notifier_block *nb)
497 static inline void ksys_sync_helper(void) {}
499 #define pm_notifier(fn, pri) do { (void)(fn); } while (0)
501 static inline bool pm_wakeup_pending(void) { return false; }
502 static inline void pm_system_wakeup(void) {}
503 static inline void pm_wakeup_clear(bool reset) {}
504 static inline void pm_system_irq_wakeup(unsigned int irq_number) {}
506 static inline void lock_system_sleep(void) {}
507 static inline void unlock_system_sleep(void) {}
509 #endif /* !CONFIG_PM_SLEEP */
511 #ifdef CONFIG_PM_SLEEP_DEBUG
512 extern bool pm_print_times_enabled;
513 extern bool pm_debug_messages_on;
514 extern __printf(2, 3) void __pm_pr_dbg(bool defer, const char *fmt, ...);
516 #define pm_print_times_enabled (false)
517 #define pm_debug_messages_on (false)
519 #include <linux/printk.h>
521 #define __pm_pr_dbg(defer, fmt, ...) \
522 no_printk(KERN_DEBUG fmt, ##__VA_ARGS__)
525 #define pm_pr_dbg(fmt, ...) \
526 __pm_pr_dbg(false, fmt, ##__VA_ARGS__)
528 #define pm_deferred_pr_dbg(fmt, ...) \
529 __pm_pr_dbg(true, fmt, ##__VA_ARGS__)
531 #ifdef CONFIG_PM_AUTOSLEEP
533 /* kernel/power/autosleep.c */
534 void queue_up_suspend_work(void);
536 #else /* !CONFIG_PM_AUTOSLEEP */
538 static inline void queue_up_suspend_work(void) {}
540 #endif /* !CONFIG_PM_AUTOSLEEP */
542 #ifdef CONFIG_ARCH_SAVE_PAGE_KEYS
544 * The ARCH_SAVE_PAGE_KEYS functions can be used by an architecture
545 * to save/restore additional information to/from the array of page
546 * frame numbers in the hibernation image. For s390 this is used to
547 * save and restore the storage key for each page that is included
548 * in the hibernation image.
550 unsigned long page_key_additional_pages(unsigned long pages);
551 int page_key_alloc(unsigned long pages);
552 void page_key_free(void);
553 void page_key_read(unsigned long *pfn);
554 void page_key_memorize(unsigned long *pfn);
555 void page_key_write(void *address);
557 #else /* !CONFIG_ARCH_SAVE_PAGE_KEYS */
559 static inline unsigned long page_key_additional_pages(unsigned long pages)
564 static inline int page_key_alloc(unsigned long pages)
569 static inline void page_key_free(void) {}
570 static inline void page_key_read(unsigned long *pfn) {}
571 static inline void page_key_memorize(unsigned long *pfn) {}
572 static inline void page_key_write(void *address) {}
574 #endif /* !CONFIG_ARCH_SAVE_PAGE_KEYS */
576 #endif /* _LINUX_SUSPEND_H */