blob: 4af270ec2204424db83ee330a74e891adb99959b [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(),
Rafael J. Wysockice441012010-07-07 23:43:45 +020064 * and @wake() will not be called in that case).
Rafael J. Wysocki6a7c7ea2009-04-19 20:08:42 +020065 *
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
Rafael J. Wysockice441012010-07-07 23:43:45 +020071 * system cannot enter the desired sleep state (@enter() will not be
72 * executed).
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -070073 *
Rafael J. Wysockic697eec2008-01-08 00:04:17 +010074 * @enter: Enter the system sleep state indicated by @begin() or represented by
75 * the argument if @begin() is not implemented.
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -070076 * This callback is mandatory. It returns 0 on success or a negative
77 * error code otherwise, in which case the system cannot enter the desired
78 * sleep state.
79 *
Rafael J. Wysocki6a7c7ea2009-04-19 20:08:42 +020080 * @wake: Called when the system has just left a sleep state, right after
81 * the nonboot CPUs have been enabled and before device drivers' early
82 * resume callbacks are executed.
83 * This callback is optional, but should be implemented by the platforms
84 * that implement @prepare_late(). If implemented, it is always called
Rafael J. Wysockice441012010-07-07 23:43:45 +020085 * after @prepare_late and @enter(), even if one of them fails.
Rafael J. Wysocki6a7c7ea2009-04-19 20:08:42 +020086 *
87 * @finish: Finish wake-up of the platform.
88 * @finish is called right prior to calling device drivers' regular suspend
89 * callbacks.
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -070090 * This callback is optional, but should be implemented by the platforms
91 * that implement @prepare(). If implemented, it is always called after
Rafael J. Wysockice441012010-07-07 23:43:45 +020092 * @enter() and @wake(), even if any of them fails. It is executed after
93 * a failing @prepare.
Rafael J. Wysockic697eec2008-01-08 00:04:17 +010094 *
95 * @end: Called by the PM core right after resuming devices, to indicate to
96 * the platform that the system has returned to the working state or
97 * the transition to the sleep state has been aborted.
98 * This callback is optional, but should be implemented by the platforms
Rafael J. Wysocki6a7c7ea2009-04-19 20:08:42 +020099 * that implement @begin(). Accordingly, platforms implementing @begin()
100 * should also provide a @end() which cleans up transitions aborted before
Rafael J. Wysockic697eec2008-01-08 00:04:17 +0100101 * @enter().
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200102 *
103 * @recover: Recover the platform from a suspend failure.
104 * Called by the PM core if the suspending of devices fails.
105 * This callback is optional and should only be implemented by platforms
106 * which require special recovery actions in that situation.
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -0700107 */
Rafael J. Wysocki26398a72007-10-18 03:04:40 -0700108struct platform_suspend_ops {
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -0700109 int (*valid)(suspend_state_t state);
Rafael J. Wysockic697eec2008-01-08 00:04:17 +0100110 int (*begin)(suspend_state_t state);
Rafael J. Wysockie6c5eb92007-10-18 03:04:41 -0700111 int (*prepare)(void);
Rafael J. Wysocki6a7c7ea2009-04-19 20:08:42 +0200112 int (*prepare_late)(void);
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -0700113 int (*enter)(suspend_state_t state);
Rafael J. Wysocki6a7c7ea2009-04-19 20:08:42 +0200114 void (*wake)(void);
Rafael J. Wysockie6c5eb92007-10-18 03:04:41 -0700115 void (*finish)(void);
Rafael J. Wysockic697eec2008-01-08 00:04:17 +0100116 void (*end)(void);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200117 void (*recover)(void);
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -0700118};
119
120#ifdef CONFIG_SUSPEND
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -0700121/**
Rafael J. Wysocki26398a72007-10-18 03:04:40 -0700122 * suspend_set_ops - set platform dependent suspend operations
123 * @ops: The new suspend operations to set.
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -0700124 */
Rafael J. Wysocki26398a72007-10-18 03:04:40 -0700125extern void suspend_set_ops(struct platform_suspend_ops *ops);
126extern int suspend_valid_only_mem(suspend_state_t state);
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -0700127
128/**
129 * arch_suspend_disable_irqs - disable IRQs for suspend
130 *
131 * Disables IRQs (in the default case). This is a weak symbol in the common
132 * code and thus allows architectures to override it if more needs to be
133 * done. Not called for suspend to disk.
134 */
135extern void arch_suspend_disable_irqs(void);
136
137/**
138 * arch_suspend_enable_irqs - enable IRQs after suspend
139 *
140 * Enables IRQs (in the default case). This is a weak symbol in the common
141 * code and thus allows architectures to override it if more needs to be
142 * done. Not called for suspend to disk.
143 */
144extern void arch_suspend_enable_irqs(void);
145
146extern int pm_suspend(suspend_state_t state);
147#else /* !CONFIG_SUSPEND */
148#define suspend_valid_only_mem NULL
149
Rafael J. Wysocki26398a72007-10-18 03:04:40 -0700150static inline void suspend_set_ops(struct platform_suspend_ops *ops) {}
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -0700151static inline int pm_suspend(suspend_state_t state) { return -ENOSYS; }
152#endif /* !CONFIG_SUSPEND */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153
Rafael J. Wysocki83573762006-12-06 20:34:18 -0800154/* struct pbe is used for creating lists of pages that should be restored
155 * atomically during the resume from disk, because the page frames they have
156 * occupied before the suspend are in use.
157 */
Rafael J. Wysockidcbb5a52006-09-25 23:32:51 -0700158struct pbe {
Rafael J. Wysocki83573762006-12-06 20:34:18 -0800159 void *address; /* address of the copy */
160 void *orig_address; /* original address of a page */
Rafael J. Wysocki7088a5c2006-01-06 00:13:05 -0800161 struct pbe *next;
Rafael J. Wysockidcbb5a52006-09-25 23:32:51 -0700162};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164/* mm/page_alloc.c */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165extern void mark_free_pages(struct zone *zone);
166
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700167/**
Rafael J. Wysockib3dac3b2007-10-18 03:04:43 -0700168 * struct platform_hibernation_ops - hibernation platform support
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700169 *
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100170 * The methods in this structure allow a platform to carry out special
171 * operations required by it during a hibernation transition.
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700172 *
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200173 * All the methods below, except for @recover(), must be implemented.
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700174 *
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100175 * @begin: Tell the platform driver that we're starting hibernation.
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700176 * Called right after shrinking memory and before freezing devices.
177 *
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100178 * @end: Called by the PM core right after resuming devices, to indicate to
179 * the platform that the system has returned to the working state.
180 *
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700181 * @pre_snapshot: Prepare the platform for creating the hibernation image.
182 * Called right after devices have been frozen and before the nonboot
183 * CPUs are disabled (runs with IRQs on).
184 *
185 * @finish: Restore the previous state of the platform after the hibernation
186 * image has been created *or* put the platform into the normal operation
187 * mode after the hibernation (the same method is executed in both cases).
188 * Called right after the nonboot CPUs have been enabled and before
189 * thawing devices (runs with IRQs on).
190 *
191 * @prepare: Prepare the platform for entering the low power state.
192 * Called right after the hibernation image has been saved and before
193 * devices are prepared for entering the low power state.
194 *
195 * @enter: Put the system into the low power state after the hibernation image
196 * has been saved to disk.
197 * Called after the nonboot CPUs have been disabled and all of the low
198 * level devices have been shut down (runs with IRQs off).
199 *
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700200 * @leave: Perform the first stage of the cleanup after the system sleep state
201 * indicated by @set_target() has been left.
202 * Called right after the control has been passed from the boot kernel to
203 * the image kernel, before the nonboot CPUs are enabled and before devices
204 * are resumed. Executed with interrupts disabled.
205 *
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700206 * @pre_restore: Prepare system for the restoration from a hibernation image.
207 * Called right after devices have been frozen and before the nonboot
208 * CPUs are disabled (runs with IRQs on).
209 *
210 * @restore_cleanup: Clean up after a failing image restoration.
211 * Called right after the nonboot CPUs have been enabled and before
212 * thawing devices (runs with IRQs on).
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200213 *
214 * @recover: Recover the platform from a failure to suspend devices.
215 * Called by the PM core if the suspending of devices during hibernation
216 * fails. This callback is optional and should only be implemented by
217 * platforms which require special recovery actions in that situation.
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700218 */
Rafael J. Wysockib3dac3b2007-10-18 03:04:43 -0700219struct platform_hibernation_ops {
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100220 int (*begin)(void);
221 void (*end)(void);
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700222 int (*pre_snapshot)(void);
223 void (*finish)(void);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700224 int (*prepare)(void);
225 int (*enter)(void);
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700226 void (*leave)(void);
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700227 int (*pre_restore)(void);
228 void (*restore_cleanup)(void);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200229 void (*recover)(void);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700230};
231
Rafael J. Wysockib0cb1a12007-07-29 23:24:36 +0200232#ifdef CONFIG_HIBERNATION
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700233/* kernel/power/snapshot.c */
Johannes Berg940d67f2007-05-08 19:23:49 +1000234extern void __register_nosave_region(unsigned long b, unsigned long e, int km);
Marcin Slusarzce289e82008-08-15 00:40:19 -0700235static inline void __init register_nosave_region(unsigned long b, unsigned long e)
Johannes Berg940d67f2007-05-08 19:23:49 +1000236{
237 __register_nosave_region(b, e, 0);
238}
Marcin Slusarzce289e82008-08-15 00:40:19 -0700239static inline void __init register_nosave_region_late(unsigned long b, unsigned long e)
Johannes Berg940d67f2007-05-08 19:23:49 +1000240{
241 __register_nosave_region(b, e, 1);
242}
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700243extern int swsusp_page_is_forbidden(struct page *);
244extern void swsusp_set_page_free(struct page *);
245extern void swsusp_unset_page_free(struct page *);
246extern unsigned long get_safe_page(gfp_t gfp_mask);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700247
Rafael J. Wysockib3dac3b2007-10-18 03:04:43 -0700248extern void hibernation_set_ops(struct platform_hibernation_ops *ops);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700249extern int hibernate(void);
Rafael J. Wysockiabfe2d72009-01-19 20:54:54 +0100250extern bool system_entering_hibernation(void);
Rafael J. Wysockib0cb1a12007-07-29 23:24:36 +0200251#else /* CONFIG_HIBERNATION */
Rafael J. Wysocki74dfd662007-05-06 14:50:43 -0700252static inline int swsusp_page_is_forbidden(struct page *p) { return 0; }
253static inline void swsusp_set_page_free(struct page *p) {}
254static inline void swsusp_unset_page_free(struct page *p) {}
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700255
Rafael J. Wysockib3dac3b2007-10-18 03:04:43 -0700256static inline void hibernation_set_ops(struct platform_hibernation_ops *ops) {}
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700257static inline int hibernate(void) { return -ENOSYS; }
Cornelia Huckfce2b1112009-06-10 01:28:19 +0200258static inline bool system_entering_hibernation(void) { return false; }
259#endif /* CONFIG_HIBERNATION */
260
Matthew Garrettdd4c4f12010-05-28 16:32:14 -0400261#ifdef CONFIG_SUSPEND_NVS
262extern int suspend_nvs_register(unsigned long start, unsigned long size);
263extern int suspend_nvs_alloc(void);
264extern void suspend_nvs_free(void);
265extern void suspend_nvs_save(void);
266extern void suspend_nvs_restore(void);
267#else /* CONFIG_SUSPEND_NVS */
268static inline int suspend_nvs_register(unsigned long a, unsigned long b)
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100269{
270 return 0;
271}
Matthew Garrettdd4c4f12010-05-28 16:32:14 -0400272static inline int suspend_nvs_alloc(void) { return 0; }
273static inline void suspend_nvs_free(void) {}
274static inline void suspend_nvs_save(void) {}
275static inline void suspend_nvs_restore(void) {}
276#endif /* CONFIG_SUSPEND_NVS */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200278#ifdef CONFIG_PM_SLEEP
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279void save_processor_state(void);
280void restore_processor_state(void);
Rafael J. Wysocki25761b62005-10-30 14:59:56 -0800281
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700282/* kernel/power/main.c */
Alan Stern82525752007-11-19 23:49:18 +0100283extern int register_pm_notifier(struct notifier_block *nb);
284extern int unregister_pm_notifier(struct notifier_block *nb);
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700285
286#define pm_notifier(fn, pri) { \
287 static struct notifier_block fn##_nb = \
288 { .notifier_call = fn, .priority = pri }; \
289 register_pm_notifier(&fn##_nb); \
290}
Rafael J. Wysockic125e962010-07-05 22:43:53 +0200291
292/* drivers/base/power/wakeup.c */
293extern bool events_check_enabled;
294
295extern bool pm_check_wakeup_events(void);
296extern bool pm_get_wakeup_count(unsigned long *count);
297extern bool pm_save_wakeup_count(unsigned long count);
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200298#else /* !CONFIG_PM_SLEEP */
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700299
300static inline int register_pm_notifier(struct notifier_block *nb)
301{
302 return 0;
303}
304
305static inline int unregister_pm_notifier(struct notifier_block *nb)
306{
307 return 0;
308}
309
310#define pm_notifier(fn, pri) do { (void)(fn); } while (0)
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200311#endif /* !CONFIG_PM_SLEEP */
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700312
Andi Kleen6ad696d2009-11-17 14:06:22 -0800313extern struct mutex pm_mutex;
314
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200315#ifndef CONFIG_HIBERNATION
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700316static inline void register_nosave_region(unsigned long b, unsigned long e)
317{
318}
Ryusuke Konishi70f38db2007-07-26 10:40:59 -0700319static inline void register_nosave_region_late(unsigned long b, unsigned long e)
320{
321}
Rafael J. Wysockib10d9112007-07-19 01:47:36 -0700322
Andi Kleen6ad696d2009-11-17 14:06:22 -0800323static inline void lock_system_sleep(void) {}
324static inline void unlock_system_sleep(void) {}
325
326#else
327
328/* Let some subsystems like memory hotadd exclude hibernation */
329
330static inline void lock_system_sleep(void)
331{
332 mutex_lock(&pm_mutex);
333}
334
335static inline void unlock_system_sleep(void)
336{
337 mutex_unlock(&pm_mutex);
338}
339#endif
Huang Ying89081d12008-07-25 19:45:10 -0700340
Rafael J. Wysocki95d9ffb2007-10-18 03:04:39 -0700341#endif /* _LINUX_SUSPEND_H */