blob: 5e781d824e6d1680466479bdd6d726195203c55a [file] [log] [blame]
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -07001#ifndef _LINUX_SUSPEND_H
2#define _LINUX_SUSPEND_H
Linus Torvalds1da177e2005-04-16 15:20:36 -07003
Linus Torvalds1da177e2005-04-16 15:20:36 -07004#include <linux/swap.h>
5#include <linux/notifier.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07006#include <linux/init.h>
7#include <linux/pm.h>
Rafael J. Wysocki7be98232007-05-06 14:50:42 -07008#include <linux/mm.h>
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -07009#include <asm/errno.h>
10
11#if defined(CONFIG_PM_SLEEP) && defined(CONFIG_VT) && defined(CONFIG_VT_CONSOLE)
Andres Salomonb6f448e2008-04-28 02:15:03 -070012extern void pm_set_vt_switch(int);
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -070013extern int pm_prepare_console(void);
14extern void pm_restore_console(void);
15#else
Andres Salomonb6f448e2008-04-28 02:15:03 -070016static inline void pm_set_vt_switch(int do_switch)
17{
18}
19
20static inline int pm_prepare_console(void)
21{
22 return 0;
23}
24
25static inline void pm_restore_console(void)
26{
27}
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -070028#endif
29
30typedef int __bitwise suspend_state_t;
31
32#define PM_SUSPEND_ON ((__force suspend_state_t) 0)
33#define PM_SUSPEND_STANDBY ((__force suspend_state_t) 1)
34#define PM_SUSPEND_MEM ((__force suspend_state_t) 3)
35#define PM_SUSPEND_MAX ((__force suspend_state_t) 4)
36
37/**
Rafael J. Wysocki26398a72007-10-18 03:04:40 -070038 * struct platform_suspend_ops - Callbacks for managing platform dependent
39 * system sleep states.
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -070040 *
41 * @valid: Callback to determine if given system sleep state is supported by
42 * the platform.
43 * Valid (ie. supported) states are advertised in /sys/power/state. Note
44 * that it still may be impossible to enter given system sleep state if the
45 * conditions aren't right.
Rafael J. Wysocki26398a72007-10-18 03:04:40 -070046 * There is the %suspend_valid_only_mem function available that can be
47 * assigned to this if the platform only supports mem sleep.
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -070048 *
Rafael J. Wysockic697eec2008-01-08 00:04:17 +010049 * @begin: Initialise a transition to given system sleep state.
50 * @begin() is executed right prior to suspending devices. The information
51 * conveyed to the platform code by @begin() should be disregarded by it as
52 * soon as @end() is executed. If @begin() fails (ie. returns nonzero),
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -070053 * @prepare(), @enter() and @finish() will not be called by the PM core.
54 * This callback is optional. However, if it is implemented, the argument
Rafael J. Wysockic697eec2008-01-08 00:04:17 +010055 * passed to @enter() is redundant and should be ignored.
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -070056 *
57 * @prepare: Prepare the platform for entering the system sleep state indicated
Rafael J. Wysockic697eec2008-01-08 00:04:17 +010058 * by @begin().
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -070059 * @prepare() is called right after devices have been suspended (ie. the
60 * appropriate .suspend() method has been executed for each device) and
Rafael J. Wysocki6a7c7ea2009-04-19 20:08:42 +020061 * before device drivers' late suspend callbacks are executed. It returns
62 * 0 on success or a negative error code otherwise, in which case the
63 * system cannot enter the desired sleep state (@prepare_late(), @enter(),
64 * @wake(), and @finish() will not be called in that case).
65 *
66 * @prepare_late: Finish preparing the platform for entering the system sleep
67 * state indicated by @begin().
68 * @prepare_late is called before disabling nonboot CPUs and after
69 * device drivers' late suspend callbacks have been executed. It returns
70 * 0 on success or a negative error code otherwise, in which case the
71 * system cannot enter the desired sleep state (@enter() and @wake()).
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -070072 *
Rafael J. Wysockic697eec2008-01-08 00:04:17 +010073 * @enter: Enter the system sleep state indicated by @begin() or represented by
74 * the argument if @begin() is not implemented.
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -070075 * This callback is mandatory. It returns 0 on success or a negative
76 * error code otherwise, in which case the system cannot enter the desired
77 * sleep state.
78 *
Rafael J. Wysocki6a7c7ea2009-04-19 20:08:42 +020079 * @wake: Called when the system has just left a sleep state, right after
80 * the nonboot CPUs have been enabled and before device drivers' early
81 * resume callbacks are executed.
82 * This callback is optional, but should be implemented by the platforms
83 * that implement @prepare_late(). If implemented, it is always called
84 * after @enter(), even if @enter() fails.
85 *
86 * @finish: Finish wake-up of the platform.
87 * @finish is called right prior to calling device drivers' regular suspend
88 * callbacks.
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -070089 * This callback is optional, but should be implemented by the platforms
90 * that implement @prepare(). If implemented, it is always called after
Rafael J. Wysocki6a7c7ea2009-04-19 20:08:42 +020091 * @enter() and @wake(), if implemented, even if any of them fails.
Rafael J. Wysockic697eec2008-01-08 00:04:17 +010092 *
93 * @end: Called by the PM core right after resuming devices, to indicate to
94 * the platform that the system has returned to the working state or
95 * the transition to the sleep state has been aborted.
96 * This callback is optional, but should be implemented by the platforms
Rafael J. Wysocki6a7c7ea2009-04-19 20:08:42 +020097 * that implement @begin(). Accordingly, platforms implementing @begin()
98 * should also provide a @end() which cleans up transitions aborted before
Rafael J. Wysockic697eec2008-01-08 00:04:17 +010099 * @enter().
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200100 *
101 * @recover: Recover the platform from a suspend failure.
102 * Called by the PM core if the suspending of devices fails.
103 * This callback is optional and should only be implemented by platforms
104 * which require special recovery actions in that situation.
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -0700105 */
Rafael J. Wysocki26398a72007-10-18 03:04:40 -0700106struct platform_suspend_ops {
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -0700107 int (*valid)(suspend_state_t state);
Rafael J. Wysockic697eec2008-01-08 00:04:17 +0100108 int (*begin)(suspend_state_t state);
Rafael J. Wysockie6c5eb92007-10-18 03:04:41 -0700109 int (*prepare)(void);
Rafael J. Wysocki6a7c7ea2009-04-19 20:08:42 +0200110 int (*prepare_late)(void);
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -0700111 int (*enter)(suspend_state_t state);
Rafael J. Wysocki6a7c7ea2009-04-19 20:08:42 +0200112 void (*wake)(void);
Rafael J. Wysockie6c5eb92007-10-18 03:04:41 -0700113 void (*finish)(void);
Rafael J. Wysockic697eec2008-01-08 00:04:17 +0100114 void (*end)(void);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200115 void (*recover)(void);
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -0700116};
117
118#ifdef CONFIG_SUSPEND
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -0700119/**
Rafael J. Wysocki26398a72007-10-18 03:04:40 -0700120 * suspend_set_ops - set platform dependent suspend operations
121 * @ops: The new suspend operations to set.
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -0700122 */
Rafael J. Wysocki26398a72007-10-18 03:04:40 -0700123extern void suspend_set_ops(struct platform_suspend_ops *ops);
124extern int suspend_valid_only_mem(suspend_state_t state);
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -0700125
126/**
127 * arch_suspend_disable_irqs - disable IRQs for suspend
128 *
129 * Disables IRQs (in the default case). This is a weak symbol in the common
130 * code and thus allows architectures to override it if more needs to be
131 * done. Not called for suspend to disk.
132 */
133extern void arch_suspend_disable_irqs(void);
134
135/**
136 * arch_suspend_enable_irqs - enable IRQs after suspend
137 *
138 * Enables IRQs (in the default case). This is a weak symbol in the common
139 * code and thus allows architectures to override it if more needs to be
140 * done. Not called for suspend to disk.
141 */
142extern void arch_suspend_enable_irqs(void);
143
144extern int pm_suspend(suspend_state_t state);
145#else /* !CONFIG_SUSPEND */
146#define suspend_valid_only_mem NULL
147
Rafael J. Wysocki26398a72007-10-18 03:04:40 -0700148static inline void suspend_set_ops(struct platform_suspend_ops *ops) {}
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -0700149static inline int pm_suspend(suspend_state_t state) { return -ENOSYS; }
150#endif /* !CONFIG_SUSPEND */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151
Rafael J. Wysocki83573762006-12-06 20:34:18 -0800152/* struct pbe is used for creating lists of pages that should be restored
153 * atomically during the resume from disk, because the page frames they have
154 * occupied before the suspend are in use.
155 */
Rafael J. Wysockidcbb5a52006-09-25 23:32:51 -0700156struct pbe {
Rafael J. Wysocki83573762006-12-06 20:34:18 -0800157 void *address; /* address of the copy */
158 void *orig_address; /* original address of a page */
Rafael J. Wysocki7088a5c2006-01-06 00:13:05 -0800159 struct pbe *next;
Rafael J. Wysockidcbb5a52006-09-25 23:32:51 -0700160};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162/* mm/page_alloc.c */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163extern void mark_free_pages(struct zone *zone);
164
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700165/**
Rafael J. Wysockib3dac3b2007-10-18 03:04:43 -0700166 * struct platform_hibernation_ops - hibernation platform support
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700167 *
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100168 * The methods in this structure allow a platform to carry out special
169 * operations required by it during a hibernation transition.
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700170 *
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200171 * All the methods below, except for @recover(), must be implemented.
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700172 *
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100173 * @begin: Tell the platform driver that we're starting hibernation.
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700174 * Called right after shrinking memory and before freezing devices.
175 *
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100176 * @end: Called by the PM core right after resuming devices, to indicate to
177 * the platform that the system has returned to the working state.
178 *
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700179 * @pre_snapshot: Prepare the platform for creating the hibernation image.
180 * Called right after devices have been frozen and before the nonboot
181 * CPUs are disabled (runs with IRQs on).
182 *
183 * @finish: Restore the previous state of the platform after the hibernation
184 * image has been created *or* put the platform into the normal operation
185 * mode after the hibernation (the same method is executed in both cases).
186 * Called right after the nonboot CPUs have been enabled and before
187 * thawing devices (runs with IRQs on).
188 *
189 * @prepare: Prepare the platform for entering the low power state.
190 * Called right after the hibernation image has been saved and before
191 * devices are prepared for entering the low power state.
192 *
193 * @enter: Put the system into the low power state after the hibernation image
194 * has been saved to disk.
195 * Called after the nonboot CPUs have been disabled and all of the low
196 * level devices have been shut down (runs with IRQs off).
197 *
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700198 * @leave: Perform the first stage of the cleanup after the system sleep state
199 * indicated by @set_target() has been left.
200 * Called right after the control has been passed from the boot kernel to
201 * the image kernel, before the nonboot CPUs are enabled and before devices
202 * are resumed. Executed with interrupts disabled.
203 *
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700204 * @pre_restore: Prepare system for the restoration from a hibernation image.
205 * Called right after devices have been frozen and before the nonboot
206 * CPUs are disabled (runs with IRQs on).
207 *
208 * @restore_cleanup: Clean up after a failing image restoration.
209 * Called right after the nonboot CPUs have been enabled and before
210 * thawing devices (runs with IRQs on).
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200211 *
212 * @recover: Recover the platform from a failure to suspend devices.
213 * Called by the PM core if the suspending of devices during hibernation
214 * fails. This callback is optional and should only be implemented by
215 * platforms which require special recovery actions in that situation.
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700216 */
Rafael J. Wysockib3dac3b2007-10-18 03:04:43 -0700217struct platform_hibernation_ops {
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100218 int (*begin)(void);
219 void (*end)(void);
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700220 int (*pre_snapshot)(void);
221 void (*finish)(void);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700222 int (*prepare)(void);
223 int (*enter)(void);
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700224 void (*leave)(void);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700225 int (*pre_restore)(void);
226 void (*restore_cleanup)(void);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200227 void (*recover)(void);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700228};
229
Rafael J. Wysockib0cb1a12007-07-29 23:24:36 +0200230#ifdef CONFIG_HIBERNATION
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700231/* kernel/power/snapshot.c */
Johannes Berg940d67f2007-05-08 19:23:49 +1000232extern void __register_nosave_region(unsigned long b, unsigned long e, int km);
Marcin Slusarzce289e82008-08-15 00:40:19 -0700233static inline void __init register_nosave_region(unsigned long b, unsigned long e)
Johannes Berg940d67f2007-05-08 19:23:49 +1000234{
235 __register_nosave_region(b, e, 0);
236}
Marcin Slusarzce289e82008-08-15 00:40:19 -0700237static inline void __init register_nosave_region_late(unsigned long b, unsigned long e)
Johannes Berg940d67f2007-05-08 19:23:49 +1000238{
239 __register_nosave_region(b, e, 1);
240}
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700241extern int swsusp_page_is_forbidden(struct page *);
242extern void swsusp_set_page_free(struct page *);
243extern void swsusp_unset_page_free(struct page *);
244extern unsigned long get_safe_page(gfp_t gfp_mask);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700245
Rafael J. Wysockib3dac3b2007-10-18 03:04:43 -0700246extern void hibernation_set_ops(struct platform_hibernation_ops *ops);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700247extern int hibernate(void);
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100248extern bool system_entering_hibernation(void);
Rafael J. Wysockib0cb1a12007-07-29 23:24:36 +0200249#else /* CONFIG_HIBERNATION */
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700250static inline int swsusp_page_is_forbidden(struct page *p) { return 0; }
251static inline void swsusp_set_page_free(struct page *p) {}
252static inline void swsusp_unset_page_free(struct page *p) {}
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700253
Rafael J. Wysockib3dac3b2007-10-18 03:04:43 -0700254static inline void hibernation_set_ops(struct platform_hibernation_ops *ops) {}
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700255static inline int hibernate(void) { return -ENOSYS; }
Cornelia Huckfce2b1112009-06-10 01:28:19 +0200256static inline bool system_entering_hibernation(void) { return false; }
257#endif /* CONFIG_HIBERNATION */
258
259#ifdef CONFIG_HIBERNATION_NVS
260extern int hibernate_nvs_register(unsigned long start, unsigned long size);
261extern int hibernate_nvs_alloc(void);
262extern void hibernate_nvs_free(void);
263extern void hibernate_nvs_save(void);
264extern void hibernate_nvs_restore(void);
265#else /* CONFIG_HIBERNATION_NVS */
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100266static inline int hibernate_nvs_register(unsigned long a, unsigned long b)
267{
268 return 0;
269}
270static inline int hibernate_nvs_alloc(void) { return 0; }
271static inline void hibernate_nvs_free(void) {}
272static inline void hibernate_nvs_save(void) {}
273static inline void hibernate_nvs_restore(void) {}
Cornelia Huckfce2b1112009-06-10 01:28:19 +0200274#endif /* CONFIG_HIBERNATION_NVS */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200276#ifdef CONFIG_PM_SLEEP
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277void save_processor_state(void);
278void restore_processor_state(void);
Rafael J. Wysocki25761b62005-10-30 14:59:56 -0800279
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700280/* kernel/power/main.c */
Alan Stern82525752007-11-19 23:49:18 +0100281extern int register_pm_notifier(struct notifier_block *nb);
282extern int unregister_pm_notifier(struct notifier_block *nb);
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700283
284#define pm_notifier(fn, pri) { \
285 static struct notifier_block fn##_nb = \
286 { .notifier_call = fn, .priority = pri }; \
287 register_pm_notifier(&fn##_nb); \
288}
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200289#else /* !CONFIG_PM_SLEEP */
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700290
291static inline int register_pm_notifier(struct notifier_block *nb)
292{
293 return 0;
294}
295
296static inline int unregister_pm_notifier(struct notifier_block *nb)
297{
298 return 0;
299}
300
301#define pm_notifier(fn, pri) do { (void)(fn); } while (0)
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200302#endif /* !CONFIG_PM_SLEEP */
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700303
Andi Kleen6ad696d2009-11-17 14:06:22 -0800304extern struct mutex pm_mutex;
305
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200306#ifndef CONFIG_HIBERNATION
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700307static inline void register_nosave_region(unsigned long b, unsigned long e)
308{
309}
Ryusuke Konishi70f38db2007-07-26 10:40:59 -0700310static inline void register_nosave_region_late(unsigned long b, unsigned long e)
311{
312}
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700313
Andi Kleen6ad696d2009-11-17 14:06:22 -0800314static inline void lock_system_sleep(void) {}
315static inline void unlock_system_sleep(void) {}
316
317#else
318
319/* Let some subsystems like memory hotadd exclude hibernation */
320
321static inline void lock_system_sleep(void)
322{
323 mutex_lock(&pm_mutex);
324}
325
326static inline void unlock_system_sleep(void)
327{
328 mutex_unlock(&pm_mutex);
329}
330#endif
Huang Ying89081d12008-07-25 19:45:10 -0700331
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -0700332#endif /* _LINUX_SUSPEND_H */