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