1 #ifndef _LINUX_SUSPEND_H
2 #define _LINUX_SUSPEND_H
4 #include <linux/swap.h>
5 #include <linux/notifier.h>
6 #include <linux/init.h>
9 #include <linux/freezer.h>
10 #include <asm/errno.h>
13 extern void pm_set_vt_switch(int);
15 static inline void pm_set_vt_switch(int do_switch
)
20 #ifdef CONFIG_VT_CONSOLE_SLEEP
21 extern void pm_prepare_console(void);
22 extern void pm_restore_console(void);
24 static inline void pm_prepare_console(void)
28 static inline void pm_restore_console(void)
33 typedef int __bitwise suspend_state_t
;
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)
42 enum suspend_stat_step
{
47 SUSPEND_SUSPEND_NOIRQ
,
53 struct suspend_stats
{
59 int failed_suspend_late
;
60 int failed_suspend_noirq
;
62 int failed_resume_early
;
63 int failed_resume_noirq
;
64 #define REC_FAILED_NUM 2
66 char failed_devs
[REC_FAILED_NUM
][40];
67 int last_failed_errno
;
68 int errno
[REC_FAILED_NUM
];
70 enum suspend_stat_step failed_steps
[REC_FAILED_NUM
];
73 extern struct suspend_stats suspend_stats
;
75 static inline void dpm_save_failed_dev(const char *name
)
77 strlcpy(suspend_stats
.failed_devs
[suspend_stats
.last_failed_dev
],
79 sizeof(suspend_stats
.failed_devs
[0]));
80 suspend_stats
.last_failed_dev
++;
81 suspend_stats
.last_failed_dev
%= REC_FAILED_NUM
;
84 static inline void dpm_save_failed_errno(int err
)
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
;
91 static inline void dpm_save_failed_step(enum suspend_stat_step step
)
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
;
99 * struct platform_suspend_ops - Callbacks for managing platform dependent
100 * system sleep states.
102 * @valid: Callback to determine if given system sleep state is supported by
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.
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.
118 * @prepare: Prepare the platform for entering the system sleep state indicated
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).
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
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
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.
148 * @finish: Finish wake-up of the platform.
149 * @finish is called right prior to calling device drivers' regular suspend
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.
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.
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
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.
176 struct 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
);
183 void (*finish
)(void);
184 bool (*suspend_again
)(void);
186 void (*recover
)(void);
189 struct platform_s2idle_ops
{
191 int (*prepare
)(void);
194 void (*restore
)(void);
198 #ifdef CONFIG_SUSPEND
199 extern suspend_state_t mem_sleep_current
;
200 extern suspend_state_t mem_sleep_default
;
203 * suspend_set_ops - set platform dependent suspend operations
204 * @ops: The new suspend operations to set.
206 extern void suspend_set_ops(const struct platform_suspend_ops
*ops
);
207 extern int suspend_valid_only_mem(suspend_state_t state
);
209 extern unsigned int pm_suspend_global_flags
;
211 #define PM_SUSPEND_FLAG_FW_SUSPEND (1 << 0)
212 #define PM_SUSPEND_FLAG_FW_RESUME (1 << 1)
214 static inline void pm_suspend_clear_flags(void)
216 pm_suspend_global_flags
= 0;
219 static inline void pm_set_suspend_via_firmware(void)
221 pm_suspend_global_flags
|= PM_SUSPEND_FLAG_FW_SUSPEND
;
224 static inline void pm_set_resume_via_firmware(void)
226 pm_suspend_global_flags
|= PM_SUSPEND_FLAG_FW_RESUME
;
229 static inline bool pm_suspend_via_firmware(void)
231 return !!(pm_suspend_global_flags
& PM_SUSPEND_FLAG_FW_SUSPEND
);
234 static inline bool pm_resume_via_firmware(void)
236 return !!(pm_suspend_global_flags
& PM_SUSPEND_FLAG_FW_RESUME
);
239 /* Suspend-to-idle state machnine. */
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. */
246 extern enum s2idle_states __read_mostly s2idle_state
;
248 static inline bool idle_should_enter_s2idle(void)
250 return unlikely(s2idle_state
== S2IDLE_STATE_ENTER
);
253 extern void __init
pm_states_init(void);
254 extern void s2idle_set_ops(const struct platform_s2idle_ops
*ops
);
255 extern void s2idle_wake(void);
258 * arch_suspend_disable_irqs - disable IRQs for suspend
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.
264 extern void arch_suspend_disable_irqs(void);
267 * arch_suspend_enable_irqs - enable IRQs after suspend
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.
273 extern void arch_suspend_enable_irqs(void);
275 extern int pm_suspend(suspend_state_t state
);
276 #else /* !CONFIG_SUSPEND */
277 #define suspend_valid_only_mem NULL
279 static inline void pm_suspend_clear_flags(void) {}
280 static inline void pm_set_suspend_via_firmware(void) {}
281 static inline void pm_set_resume_via_firmware(void) {}
282 static inline bool pm_suspend_via_firmware(void) { return false; }
283 static inline bool pm_resume_via_firmware(void) { return false; }
285 static inline void suspend_set_ops(const struct platform_suspend_ops
*ops
) {}
286 static inline int pm_suspend(suspend_state_t state
) { return -ENOSYS
; }
287 static inline bool idle_should_enter_s2idle(void) { return false; }
288 static inline void __init
pm_states_init(void) {}
289 static inline void s2idle_set_ops(const struct platform_s2idle_ops
*ops
) {}
290 static inline void s2idle_wake(void) {}
291 #endif /* !CONFIG_SUSPEND */
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.
298 void *address
; /* address of the copy */
299 void *orig_address
; /* original address of a page */
303 /* mm/page_alloc.c */
304 extern void mark_free_pages(struct zone
*zone
);
307 * struct platform_hibernation_ops - hibernation platform support
309 * The methods in this structure allow a platform to carry out special
310 * operations required by it during a hibernation transition.
312 * All the methods below, except for @recover(), must be implemented.
314 * @begin: Tell the platform driver that we're starting hibernation.
315 * Called right after shrinking memory and before freezing devices.
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.
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).
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).
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.
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).
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.
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).
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).
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.
358 struct platform_hibernation_ops
{
361 int (*pre_snapshot
)(void);
362 void (*finish
)(void);
363 int (*prepare
)(void);
366 int (*pre_restore
)(void);
367 void (*restore_cleanup
)(void);
368 void (*recover
)(void);
371 #ifdef CONFIG_HIBERNATION
372 /* kernel/power/snapshot.c */
373 extern void __register_nosave_region(unsigned long b
, unsigned long e
, int km
);
374 static inline void __init
register_nosave_region(unsigned long b
, unsigned long e
)
376 __register_nosave_region(b
, e
, 0);
378 static inline void __init
register_nosave_region_late(unsigned long b
, unsigned long e
)
380 __register_nosave_region(b
, e
, 1);
382 extern int swsusp_page_is_forbidden(struct page
*);
383 extern void swsusp_set_page_free(struct page
*);
384 extern void swsusp_unset_page_free(struct page
*);
385 extern unsigned long get_safe_page(gfp_t gfp_mask
);
387 extern void hibernation_set_ops(const struct platform_hibernation_ops
*ops
);
388 extern int hibernate(void);
389 extern bool system_entering_hibernation(void);
390 extern bool hibernation_available(void);
391 asmlinkage
int swsusp_save(void);
392 extern struct pbe
*restore_pblist
;
393 #else /* CONFIG_HIBERNATION */
394 static inline void register_nosave_region(unsigned long b
, unsigned long e
) {}
395 static inline void register_nosave_region_late(unsigned long b
, unsigned long e
) {}
396 static inline int swsusp_page_is_forbidden(struct page
*p
) { return 0; }
397 static inline void swsusp_set_page_free(struct page
*p
) {}
398 static inline void swsusp_unset_page_free(struct page
*p
) {}
400 static inline void hibernation_set_ops(const struct platform_hibernation_ops
*ops
) {}
401 static inline int hibernate(void) { return -ENOSYS
; }
402 static inline bool system_entering_hibernation(void) { return false; }
403 static inline bool hibernation_available(void) { return false; }
404 #endif /* CONFIG_HIBERNATION */
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 */
414 extern struct mutex pm_mutex
;
416 #ifdef CONFIG_PM_SLEEP
417 void save_processor_state(void);
418 void restore_processor_state(void);
420 /* kernel/power/main.c */
421 extern int register_pm_notifier(struct notifier_block
*nb
);
422 extern int unregister_pm_notifier(struct notifier_block
*nb
);
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); \
430 /* drivers/base/power/wakeup.c */
431 extern bool events_check_enabled
;
432 extern unsigned int pm_wakeup_irq
;
433 extern suspend_state_t pm_suspend_target_state
;
435 extern bool pm_wakeup_pending(void);
436 extern void pm_system_wakeup(void);
437 extern void pm_system_cancel_wakeup(void);
438 extern void pm_wakeup_clear(bool reset
);
439 extern void pm_system_irq_wakeup(unsigned int irq_number
);
440 extern bool pm_get_wakeup_count(unsigned int *count
, bool block
);
441 extern bool pm_save_wakeup_count(unsigned int count
);
442 extern void pm_wakep_autosleep_enabled(bool set
);
443 extern void pm_print_active_wakeup_sources(void);
445 static inline void lock_system_sleep(void)
447 current
->flags
|= PF_FREEZER_SKIP
;
448 mutex_lock(&pm_mutex
);
451 static inline void unlock_system_sleep(void)
454 * Don't use freezer_count() because we don't want the call to
455 * try_to_freeze() here.
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.
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.
468 current
->flags
&= ~PF_FREEZER_SKIP
;
469 mutex_unlock(&pm_mutex
);
472 #else /* !CONFIG_PM_SLEEP */
474 static inline int register_pm_notifier(struct notifier_block
*nb
)
479 static inline int unregister_pm_notifier(struct notifier_block
*nb
)
484 #define pm_notifier(fn, pri) do { (void)(fn); } while (0)
486 static inline bool pm_wakeup_pending(void) { return false; }
487 static inline void pm_system_wakeup(void) {}
488 static inline void pm_wakeup_clear(bool reset
) {}
489 static inline void pm_system_irq_wakeup(unsigned int irq_number
) {}
491 static inline void lock_system_sleep(void) {}
492 static inline void unlock_system_sleep(void) {}
494 #endif /* !CONFIG_PM_SLEEP */
496 #ifdef CONFIG_PM_SLEEP_DEBUG
497 extern bool pm_print_times_enabled
;
498 extern bool pm_debug_messages_on
;
499 extern __printf(2, 3) void __pm_pr_dbg(bool defer
, const char *fmt
, ...);
501 #define pm_print_times_enabled (false)
502 #define pm_debug_messages_on (false)
504 #include <linux/printk.h>
506 #define __pm_pr_dbg(defer, fmt, ...) \
507 no_printk(KERN_DEBUG fmt, ##__VA_ARGS__)
510 #define pm_pr_dbg(fmt, ...) \
511 __pm_pr_dbg(false, fmt, ##__VA_ARGS__)
513 #define pm_deferred_pr_dbg(fmt, ...) \
514 __pm_pr_dbg(true, fmt, ##__VA_ARGS__)
516 #ifdef CONFIG_PM_AUTOSLEEP
518 /* kernel/power/autosleep.c */
519 void queue_up_suspend_work(void);
521 #else /* !CONFIG_PM_AUTOSLEEP */
523 static inline void queue_up_suspend_work(void) {}
525 #endif /* !CONFIG_PM_AUTOSLEEP */
527 #ifdef CONFIG_ARCH_SAVE_PAGE_KEYS
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.
535 unsigned long page_key_additional_pages(unsigned long pages
);
536 int page_key_alloc(unsigned long pages
);
537 void page_key_free(void);
538 void page_key_read(unsigned long *pfn
);
539 void page_key_memorize(unsigned long *pfn
);
540 void page_key_write(void *address
);
542 #else /* !CONFIG_ARCH_SAVE_PAGE_KEYS */
544 static inline unsigned long page_key_additional_pages(unsigned long pages
)
549 static inline int page_key_alloc(unsigned long pages
)
554 static inline void page_key_free(void) {}
555 static inline void page_key_read(unsigned long *pfn
) {}
556 static inline void page_key_memorize(unsigned long *pfn
) {}
557 static inline void page_key_write(void *address
) {}
559 #endif /* !CONFIG_ARCH_SAVE_PAGE_KEYS */
561 #endif /* _LINUX_SUSPEND_H */