Commit | Line | Data |
---|---|---|
95d9ffbe RW |
1 | #ifndef _LINUX_SUSPEND_H |
2 | #define _LINUX_SUSPEND_H | |
1da177e4 | 3 | |
1da177e4 LT |
4 | #include <linux/swap.h> |
5 | #include <linux/notifier.h> | |
1da177e4 LT |
6 | #include <linux/init.h> |
7 | #include <linux/pm.h> | |
7be98234 | 8 | #include <linux/mm.h> |
95d9ffbe RW |
9 | #include <asm/errno.h> |
10 | ||
11 | #if defined(CONFIG_PM_SLEEP) && defined(CONFIG_VT) && defined(CONFIG_VT_CONSOLE) | |
b6f448e9 | 12 | extern void pm_set_vt_switch(int); |
95d9ffbe RW |
13 | extern int pm_prepare_console(void); |
14 | extern void pm_restore_console(void); | |
15 | #else | |
b6f448e9 AS |
16 | static inline void pm_set_vt_switch(int do_switch) |
17 | { | |
18 | } | |
19 | ||
20 | static inline int pm_prepare_console(void) | |
21 | { | |
22 | return 0; | |
23 | } | |
24 | ||
25 | static inline void pm_restore_console(void) | |
26 | { | |
27 | } | |
95d9ffbe RW |
28 | #endif |
29 | ||
30 | typedef 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 | /** | |
26398a70 RW |
38 | * struct platform_suspend_ops - Callbacks for managing platform dependent |
39 | * system sleep states. | |
95d9ffbe RW |
40 | * |
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. | |
26398a70 RW |
46 | * There is the %suspend_valid_only_mem function available that can be |
47 | * assigned to this if the platform only supports mem sleep. | |
95d9ffbe | 48 | * |
c697eece RW |
49 | * @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), | |
95d9ffbe RW |
53 | * @prepare(), @enter() and @finish() will not be called by the PM core. |
54 | * This callback is optional. However, if it is implemented, the argument | |
c697eece | 55 | * passed to @enter() is redundant and should be ignored. |
95d9ffbe RW |
56 | * |
57 | * @prepare: Prepare the platform for entering the system sleep state indicated | |
c697eece | 58 | * by @begin(). |
95d9ffbe RW |
59 | * @prepare() is called right after devices have been suspended (ie. the |
60 | * appropriate .suspend() method has been executed for each device) and | |
6a7c7eaf RW |
61 | * 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(), | |
ce441011 | 64 | * and @wake() will not be called in that case). |
6a7c7eaf RW |
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 | |
ce441011 RW |
71 | * system cannot enter the desired sleep state (@enter() will not be |
72 | * executed). | |
95d9ffbe | 73 | * |
c697eece RW |
74 | * @enter: Enter the system sleep state indicated by @begin() or represented by |
75 | * the argument if @begin() is not implemented. | |
95d9ffbe RW |
76 | * 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 | * | |
6a7c7eaf RW |
80 | * @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 | |
ce441011 | 85 | * after @prepare_late and @enter(), even if one of them fails. |
6a7c7eaf RW |
86 | * |
87 | * @finish: Finish wake-up of the platform. | |
88 | * @finish is called right prior to calling device drivers' regular suspend | |
89 | * callbacks. | |
95d9ffbe RW |
90 | * This callback is optional, but should be implemented by the platforms |
91 | * that implement @prepare(). If implemented, it is always called after | |
ce441011 RW |
92 | * @enter() and @wake(), even if any of them fails. It is executed after |
93 | * a failing @prepare. | |
c697eece RW |
94 | * |
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 | |
6a7c7eaf RW |
99 | * that implement @begin(). Accordingly, platforms implementing @begin() |
100 | * should also provide a @end() which cleans up transitions aborted before | |
c697eece | 101 | * @enter(). |
d8f3de0d RW |
102 | * |
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. | |
95d9ffbe | 107 | */ |
26398a70 | 108 | struct platform_suspend_ops { |
95d9ffbe | 109 | int (*valid)(suspend_state_t state); |
c697eece | 110 | int (*begin)(suspend_state_t state); |
e6c5eb95 | 111 | int (*prepare)(void); |
6a7c7eaf | 112 | int (*prepare_late)(void); |
95d9ffbe | 113 | int (*enter)(suspend_state_t state); |
6a7c7eaf | 114 | void (*wake)(void); |
e6c5eb95 | 115 | void (*finish)(void); |
c697eece | 116 | void (*end)(void); |
d8f3de0d | 117 | void (*recover)(void); |
95d9ffbe RW |
118 | }; |
119 | ||
120 | #ifdef CONFIG_SUSPEND | |
95d9ffbe | 121 | /** |
26398a70 RW |
122 | * suspend_set_ops - set platform dependent suspend operations |
123 | * @ops: The new suspend operations to set. | |
95d9ffbe | 124 | */ |
2f55ac07 | 125 | extern void suspend_set_ops(const struct platform_suspend_ops *ops); |
26398a70 | 126 | extern int suspend_valid_only_mem(suspend_state_t state); |
95d9ffbe RW |
127 | |
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 | */ | |
135 | extern 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 | */ | |
144 | extern void arch_suspend_enable_irqs(void); | |
145 | ||
146 | extern int pm_suspend(suspend_state_t state); | |
147 | #else /* !CONFIG_SUSPEND */ | |
148 | #define suspend_valid_only_mem NULL | |
149 | ||
2f55ac07 | 150 | static inline void suspend_set_ops(const struct platform_suspend_ops *ops) {} |
95d9ffbe RW |
151 | static inline int pm_suspend(suspend_state_t state) { return -ENOSYS; } |
152 | #endif /* !CONFIG_SUSPEND */ | |
1da177e4 | 153 | |
8357376d RW |
154 | /* 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 | */ | |
dcbb5a54 | 158 | struct pbe { |
8357376d RW |
159 | void *address; /* address of the copy */ |
160 | void *orig_address; /* original address of a page */ | |
7088a5c0 | 161 | struct pbe *next; |
dcbb5a54 | 162 | }; |
1da177e4 | 163 | |
1da177e4 | 164 | /* mm/page_alloc.c */ |
1da177e4 LT |
165 | extern void mark_free_pages(struct zone *zone); |
166 | ||
a3d25c27 | 167 | /** |
b3dac3b3 | 168 | * struct platform_hibernation_ops - hibernation platform support |
a3d25c27 | 169 | * |
caea99ef RW |
170 | * The methods in this structure allow a platform to carry out special |
171 | * operations required by it during a hibernation transition. | |
a3d25c27 | 172 | * |
d8f3de0d | 173 | * All the methods below, except for @recover(), must be implemented. |
a3d25c27 | 174 | * |
caea99ef | 175 | * @begin: Tell the platform driver that we're starting hibernation. |
74f270af RW |
176 | * Called right after shrinking memory and before freezing devices. |
177 | * | |
caea99ef RW |
178 | * @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 | * | |
74f270af RW |
181 | * @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 | * | |
c7e0831d RW |
200 | * @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 | * | |
74f270af RW |
206 | * @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). | |
d8f3de0d RW |
213 | * |
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. | |
a3d25c27 | 218 | */ |
b3dac3b3 | 219 | struct platform_hibernation_ops { |
caea99ef RW |
220 | int (*begin)(void); |
221 | void (*end)(void); | |
74f270af RW |
222 | int (*pre_snapshot)(void); |
223 | void (*finish)(void); | |
a3d25c27 RW |
224 | int (*prepare)(void); |
225 | int (*enter)(void); | |
c7e0831d | 226 | void (*leave)(void); |
a634cc10 RW |
227 | int (*pre_restore)(void); |
228 | void (*restore_cleanup)(void); | |
d8f3de0d | 229 | void (*recover)(void); |
a3d25c27 RW |
230 | }; |
231 | ||
b0cb1a19 | 232 | #ifdef CONFIG_HIBERNATION |
74dfd666 | 233 | /* kernel/power/snapshot.c */ |
940d67f6 | 234 | extern void __register_nosave_region(unsigned long b, unsigned long e, int km); |
ce289e89 | 235 | static inline void __init register_nosave_region(unsigned long b, unsigned long e) |
940d67f6 JB |
236 | { |
237 | __register_nosave_region(b, e, 0); | |
238 | } | |
ce289e89 | 239 | static inline void __init register_nosave_region_late(unsigned long b, unsigned long e) |
940d67f6 JB |
240 | { |
241 | __register_nosave_region(b, e, 1); | |
242 | } | |
74dfd666 RW |
243 | extern int swsusp_page_is_forbidden(struct page *); |
244 | extern void swsusp_set_page_free(struct page *); | |
245 | extern void swsusp_unset_page_free(struct page *); | |
246 | extern unsigned long get_safe_page(gfp_t gfp_mask); | |
a3d25c27 | 247 | |
073ef1f6 | 248 | extern void hibernation_set_ops(const struct platform_hibernation_ops *ops); |
a3d25c27 | 249 | extern int hibernate(void); |
abfe2d7b | 250 | extern bool system_entering_hibernation(void); |
b0cb1a19 | 251 | #else /* CONFIG_HIBERNATION */ |
1f112cee RW |
252 | static inline void register_nosave_region(unsigned long b, unsigned long e) {} |
253 | static inline void register_nosave_region_late(unsigned long b, unsigned long e) {} | |
74dfd666 RW |
254 | static inline int swsusp_page_is_forbidden(struct page *p) { return 0; } |
255 | static inline void swsusp_set_page_free(struct page *p) {} | |
256 | static inline void swsusp_unset_page_free(struct page *p) {} | |
a3d25c27 | 257 | |
073ef1f6 | 258 | static inline void hibernation_set_ops(const struct platform_hibernation_ops *ops) {} |
a3d25c27 | 259 | static inline int hibernate(void) { return -ENOSYS; } |
fce2b111 CH |
260 | static inline bool system_entering_hibernation(void) { return false; } |
261 | #endif /* CONFIG_HIBERNATION */ | |
262 | ||
296699de | 263 | #ifdef CONFIG_PM_SLEEP |
1da177e4 LT |
264 | void save_processor_state(void); |
265 | void restore_processor_state(void); | |
25761b6e | 266 | |
b10d9117 | 267 | /* kernel/power/main.c */ |
82525756 AS |
268 | extern int register_pm_notifier(struct notifier_block *nb); |
269 | extern int unregister_pm_notifier(struct notifier_block *nb); | |
b10d9117 RW |
270 | |
271 | #define pm_notifier(fn, pri) { \ | |
272 | static struct notifier_block fn##_nb = \ | |
273 | { .notifier_call = fn, .priority = pri }; \ | |
274 | register_pm_notifier(&fn##_nb); \ | |
275 | } | |
c125e96f RW |
276 | |
277 | /* drivers/base/power/wakeup.c */ | |
278 | extern bool events_check_enabled; | |
279 | ||
a2867e08 | 280 | extern bool pm_wakeup_pending(void); |
074037ec RW |
281 | extern bool pm_get_wakeup_count(unsigned int *count); |
282 | extern bool pm_save_wakeup_count(unsigned int count); | |
296699de | 283 | #else /* !CONFIG_PM_SLEEP */ |
b10d9117 RW |
284 | |
285 | static inline int register_pm_notifier(struct notifier_block *nb) | |
286 | { | |
287 | return 0; | |
288 | } | |
289 | ||
290 | static inline int unregister_pm_notifier(struct notifier_block *nb) | |
291 | { | |
292 | return 0; | |
293 | } | |
294 | ||
295 | #define pm_notifier(fn, pri) do { (void)(fn); } while (0) | |
dbeeec5f | 296 | |
a2867e08 | 297 | static inline bool pm_wakeup_pending(void) { return false; } |
296699de | 298 | #endif /* !CONFIG_PM_SLEEP */ |
b10d9117 | 299 | |
6ad696d2 AK |
300 | extern struct mutex pm_mutex; |
301 | ||
1f112cee | 302 | #ifndef CONFIG_HIBERNATE_CALLBACKS |
6ad696d2 AK |
303 | static inline void lock_system_sleep(void) {} |
304 | static inline void unlock_system_sleep(void) {} | |
305 | ||
306 | #else | |
307 | ||
308 | /* Let some subsystems like memory hotadd exclude hibernation */ | |
309 | ||
310 | static inline void lock_system_sleep(void) | |
311 | { | |
312 | mutex_lock(&pm_mutex); | |
313 | } | |
314 | ||
315 | static inline void unlock_system_sleep(void) | |
316 | { | |
317 | mutex_unlock(&pm_mutex); | |
318 | } | |
319 | #endif | |
89081d17 | 320 | |
95d9ffbe | 321 | #endif /* _LINUX_SUSPEND_H */ |