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 | ||
37cce26b | 11 | #ifdef CONFIG_VT |
b6f448e9 | 12 | extern void pm_set_vt_switch(int); |
95d9ffbe | 13 | #else |
b6f448e9 AS |
14 | static inline void pm_set_vt_switch(int do_switch) |
15 | { | |
16 | } | |
37cce26b | 17 | #endif |
b6f448e9 | 18 | |
37cce26b HS |
19 | #ifdef CONFIG_VT_CONSOLE_SLEEP |
20 | extern int pm_prepare_console(void); | |
21 | extern void pm_restore_console(void); | |
22 | #else | |
b6f448e9 AS |
23 | static inline int pm_prepare_console(void) |
24 | { | |
25 | return 0; | |
26 | } | |
27 | ||
28 | static inline void pm_restore_console(void) | |
29 | { | |
30 | } | |
95d9ffbe RW |
31 | #endif |
32 | ||
33 | typedef int __bitwise suspend_state_t; | |
34 | ||
35 | #define PM_SUSPEND_ON ((__force suspend_state_t) 0) | |
36 | #define PM_SUSPEND_STANDBY ((__force suspend_state_t) 1) | |
37 | #define PM_SUSPEND_MEM ((__force suspend_state_t) 3) | |
38 | #define PM_SUSPEND_MAX ((__force suspend_state_t) 4) | |
39 | ||
2a77c46d SL |
40 | enum suspend_stat_step { |
41 | SUSPEND_FREEZE = 1, | |
42 | SUSPEND_PREPARE, | |
43 | SUSPEND_SUSPEND, | |
44 | SUSPEND_SUSPEND_NOIRQ, | |
45 | SUSPEND_RESUME_NOIRQ, | |
46 | SUSPEND_RESUME | |
47 | }; | |
48 | ||
49 | struct suspend_stats { | |
50 | int success; | |
51 | int fail; | |
52 | int failed_freeze; | |
53 | int failed_prepare; | |
54 | int failed_suspend; | |
55 | int failed_suspend_noirq; | |
56 | int failed_resume; | |
57 | int failed_resume_noirq; | |
58 | #define REC_FAILED_NUM 2 | |
59 | int last_failed_dev; | |
60 | char failed_devs[REC_FAILED_NUM][40]; | |
61 | int last_failed_errno; | |
62 | int errno[REC_FAILED_NUM]; | |
63 | int last_failed_step; | |
64 | enum suspend_stat_step failed_steps[REC_FAILED_NUM]; | |
65 | }; | |
66 | ||
67 | extern struct suspend_stats suspend_stats; | |
68 | ||
69 | static inline void dpm_save_failed_dev(const char *name) | |
70 | { | |
71 | strlcpy(suspend_stats.failed_devs[suspend_stats.last_failed_dev], | |
72 | name, | |
73 | sizeof(suspend_stats.failed_devs[0])); | |
74 | suspend_stats.last_failed_dev++; | |
75 | suspend_stats.last_failed_dev %= REC_FAILED_NUM; | |
76 | } | |
77 | ||
78 | static inline void dpm_save_failed_errno(int err) | |
79 | { | |
80 | suspend_stats.errno[suspend_stats.last_failed_errno] = err; | |
81 | suspend_stats.last_failed_errno++; | |
82 | suspend_stats.last_failed_errno %= REC_FAILED_NUM; | |
83 | } | |
84 | ||
85 | static inline void dpm_save_failed_step(enum suspend_stat_step step) | |
86 | { | |
87 | suspend_stats.failed_steps[suspend_stats.last_failed_step] = step; | |
88 | suspend_stats.last_failed_step++; | |
89 | suspend_stats.last_failed_step %= REC_FAILED_NUM; | |
90 | } | |
91 | ||
95d9ffbe | 92 | /** |
26398a70 RW |
93 | * struct platform_suspend_ops - Callbacks for managing platform dependent |
94 | * system sleep states. | |
95d9ffbe RW |
95 | * |
96 | * @valid: Callback to determine if given system sleep state is supported by | |
97 | * the platform. | |
98 | * Valid (ie. supported) states are advertised in /sys/power/state. Note | |
99 | * that it still may be impossible to enter given system sleep state if the | |
100 | * conditions aren't right. | |
26398a70 RW |
101 | * There is the %suspend_valid_only_mem function available that can be |
102 | * assigned to this if the platform only supports mem sleep. | |
95d9ffbe | 103 | * |
c697eece RW |
104 | * @begin: Initialise a transition to given system sleep state. |
105 | * @begin() is executed right prior to suspending devices. The information | |
106 | * conveyed to the platform code by @begin() should be disregarded by it as | |
107 | * soon as @end() is executed. If @begin() fails (ie. returns nonzero), | |
95d9ffbe RW |
108 | * @prepare(), @enter() and @finish() will not be called by the PM core. |
109 | * This callback is optional. However, if it is implemented, the argument | |
c697eece | 110 | * passed to @enter() is redundant and should be ignored. |
95d9ffbe RW |
111 | * |
112 | * @prepare: Prepare the platform for entering the system sleep state indicated | |
c697eece | 113 | * by @begin(). |
95d9ffbe RW |
114 | * @prepare() is called right after devices have been suspended (ie. the |
115 | * appropriate .suspend() method has been executed for each device) and | |
6a7c7eaf RW |
116 | * before device drivers' late suspend callbacks are executed. It returns |
117 | * 0 on success or a negative error code otherwise, in which case the | |
118 | * system cannot enter the desired sleep state (@prepare_late(), @enter(), | |
ce441011 | 119 | * and @wake() will not be called in that case). |
6a7c7eaf RW |
120 | * |
121 | * @prepare_late: Finish preparing the platform for entering the system sleep | |
122 | * state indicated by @begin(). | |
123 | * @prepare_late is called before disabling nonboot CPUs and after | |
124 | * device drivers' late suspend callbacks have been executed. It returns | |
125 | * 0 on success or a negative error code otherwise, in which case the | |
ce441011 RW |
126 | * system cannot enter the desired sleep state (@enter() will not be |
127 | * executed). | |
95d9ffbe | 128 | * |
c697eece RW |
129 | * @enter: Enter the system sleep state indicated by @begin() or represented by |
130 | * the argument if @begin() is not implemented. | |
95d9ffbe RW |
131 | * This callback is mandatory. It returns 0 on success or a negative |
132 | * error code otherwise, in which case the system cannot enter the desired | |
133 | * sleep state. | |
134 | * | |
6a7c7eaf RW |
135 | * @wake: Called when the system has just left a sleep state, right after |
136 | * the nonboot CPUs have been enabled and before device drivers' early | |
137 | * resume callbacks are executed. | |
138 | * This callback is optional, but should be implemented by the platforms | |
139 | * that implement @prepare_late(). If implemented, it is always called | |
ce441011 | 140 | * after @prepare_late and @enter(), even if one of them fails. |
6a7c7eaf RW |
141 | * |
142 | * @finish: Finish wake-up of the platform. | |
143 | * @finish is called right prior to calling device drivers' regular suspend | |
144 | * callbacks. | |
95d9ffbe RW |
145 | * This callback is optional, but should be implemented by the platforms |
146 | * that implement @prepare(). If implemented, it is always called after | |
ce441011 RW |
147 | * @enter() and @wake(), even if any of them fails. It is executed after |
148 | * a failing @prepare. | |
c697eece | 149 | * |
3b5fe852 MH |
150 | * @suspend_again: Returns whether the system should suspend again (true) or |
151 | * not (false). If the platform wants to poll sensors or execute some | |
152 | * code during suspended without invoking userspace and most of devices, | |
153 | * suspend_again callback is the place assuming that periodic-wakeup or | |
154 | * alarm-wakeup is already setup. This allows to execute some codes while | |
155 | * being kept suspended in the view of userland and devices. | |
156 | * | |
c697eece RW |
157 | * @end: Called by the PM core right after resuming devices, to indicate to |
158 | * the platform that the system has returned to the working state or | |
159 | * the transition to the sleep state has been aborted. | |
160 | * This callback is optional, but should be implemented by the platforms | |
6a7c7eaf RW |
161 | * that implement @begin(). Accordingly, platforms implementing @begin() |
162 | * should also provide a @end() which cleans up transitions aborted before | |
c697eece | 163 | * @enter(). |
d8f3de0d RW |
164 | * |
165 | * @recover: Recover the platform from a suspend failure. | |
166 | * Called by the PM core if the suspending of devices fails. | |
167 | * This callback is optional and should only be implemented by platforms | |
168 | * which require special recovery actions in that situation. | |
95d9ffbe | 169 | */ |
26398a70 | 170 | struct platform_suspend_ops { |
95d9ffbe | 171 | int (*valid)(suspend_state_t state); |
c697eece | 172 | int (*begin)(suspend_state_t state); |
e6c5eb95 | 173 | int (*prepare)(void); |
6a7c7eaf | 174 | int (*prepare_late)(void); |
95d9ffbe | 175 | int (*enter)(suspend_state_t state); |
6a7c7eaf | 176 | void (*wake)(void); |
e6c5eb95 | 177 | void (*finish)(void); |
3b5fe852 | 178 | bool (*suspend_again)(void); |
c697eece | 179 | void (*end)(void); |
d8f3de0d | 180 | void (*recover)(void); |
95d9ffbe RW |
181 | }; |
182 | ||
183 | #ifdef CONFIG_SUSPEND | |
95d9ffbe | 184 | /** |
26398a70 RW |
185 | * suspend_set_ops - set platform dependent suspend operations |
186 | * @ops: The new suspend operations to set. | |
95d9ffbe | 187 | */ |
2f55ac07 | 188 | extern void suspend_set_ops(const struct platform_suspend_ops *ops); |
26398a70 | 189 | extern int suspend_valid_only_mem(suspend_state_t state); |
95d9ffbe RW |
190 | |
191 | /** | |
192 | * arch_suspend_disable_irqs - disable IRQs for suspend | |
193 | * | |
194 | * Disables IRQs (in the default case). This is a weak symbol in the common | |
195 | * code and thus allows architectures to override it if more needs to be | |
196 | * done. Not called for suspend to disk. | |
197 | */ | |
198 | extern void arch_suspend_disable_irqs(void); | |
199 | ||
200 | /** | |
201 | * arch_suspend_enable_irqs - enable IRQs after suspend | |
202 | * | |
203 | * Enables IRQs (in the default case). This is a weak symbol in the common | |
204 | * code and thus allows architectures to override it if more needs to be | |
205 | * done. Not called for suspend to disk. | |
206 | */ | |
207 | extern void arch_suspend_enable_irqs(void); | |
208 | ||
209 | extern int pm_suspend(suspend_state_t state); | |
210 | #else /* !CONFIG_SUSPEND */ | |
211 | #define suspend_valid_only_mem NULL | |
212 | ||
2f55ac07 | 213 | static inline void suspend_set_ops(const struct platform_suspend_ops *ops) {} |
95d9ffbe RW |
214 | static inline int pm_suspend(suspend_state_t state) { return -ENOSYS; } |
215 | #endif /* !CONFIG_SUSPEND */ | |
1da177e4 | 216 | |
8357376d RW |
217 | /* struct pbe is used for creating lists of pages that should be restored |
218 | * atomically during the resume from disk, because the page frames they have | |
219 | * occupied before the suspend are in use. | |
220 | */ | |
dcbb5a54 | 221 | struct pbe { |
8357376d RW |
222 | void *address; /* address of the copy */ |
223 | void *orig_address; /* original address of a page */ | |
7088a5c0 | 224 | struct pbe *next; |
dcbb5a54 | 225 | }; |
1da177e4 | 226 | |
1da177e4 | 227 | /* mm/page_alloc.c */ |
1da177e4 LT |
228 | extern void mark_free_pages(struct zone *zone); |
229 | ||
a3d25c27 | 230 | /** |
b3dac3b3 | 231 | * struct platform_hibernation_ops - hibernation platform support |
a3d25c27 | 232 | * |
caea99ef RW |
233 | * The methods in this structure allow a platform to carry out special |
234 | * operations required by it during a hibernation transition. | |
a3d25c27 | 235 | * |
d8f3de0d | 236 | * All the methods below, except for @recover(), must be implemented. |
a3d25c27 | 237 | * |
caea99ef | 238 | * @begin: Tell the platform driver that we're starting hibernation. |
74f270af RW |
239 | * Called right after shrinking memory and before freezing devices. |
240 | * | |
caea99ef RW |
241 | * @end: Called by the PM core right after resuming devices, to indicate to |
242 | * the platform that the system has returned to the working state. | |
243 | * | |
74f270af RW |
244 | * @pre_snapshot: Prepare the platform for creating the hibernation image. |
245 | * Called right after devices have been frozen and before the nonboot | |
246 | * CPUs are disabled (runs with IRQs on). | |
247 | * | |
248 | * @finish: Restore the previous state of the platform after the hibernation | |
249 | * image has been created *or* put the platform into the normal operation | |
250 | * mode after the hibernation (the same method is executed in both cases). | |
251 | * Called right after the nonboot CPUs have been enabled and before | |
252 | * thawing devices (runs with IRQs on). | |
253 | * | |
254 | * @prepare: Prepare the platform for entering the low power state. | |
255 | * Called right after the hibernation image has been saved and before | |
256 | * devices are prepared for entering the low power state. | |
257 | * | |
258 | * @enter: Put the system into the low power state after the hibernation image | |
259 | * has been saved to disk. | |
260 | * Called after the nonboot CPUs have been disabled and all of the low | |
261 | * level devices have been shut down (runs with IRQs off). | |
262 | * | |
c7e0831d RW |
263 | * @leave: Perform the first stage of the cleanup after the system sleep state |
264 | * indicated by @set_target() has been left. | |
265 | * Called right after the control has been passed from the boot kernel to | |
266 | * the image kernel, before the nonboot CPUs are enabled and before devices | |
267 | * are resumed. Executed with interrupts disabled. | |
268 | * | |
74f270af RW |
269 | * @pre_restore: Prepare system for the restoration from a hibernation image. |
270 | * Called right after devices have been frozen and before the nonboot | |
271 | * CPUs are disabled (runs with IRQs on). | |
272 | * | |
273 | * @restore_cleanup: Clean up after a failing image restoration. | |
274 | * Called right after the nonboot CPUs have been enabled and before | |
275 | * thawing devices (runs with IRQs on). | |
d8f3de0d RW |
276 | * |
277 | * @recover: Recover the platform from a failure to suspend devices. | |
278 | * Called by the PM core if the suspending of devices during hibernation | |
279 | * fails. This callback is optional and should only be implemented by | |
280 | * platforms which require special recovery actions in that situation. | |
a3d25c27 | 281 | */ |
b3dac3b3 | 282 | struct platform_hibernation_ops { |
caea99ef RW |
283 | int (*begin)(void); |
284 | void (*end)(void); | |
74f270af RW |
285 | int (*pre_snapshot)(void); |
286 | void (*finish)(void); | |
a3d25c27 RW |
287 | int (*prepare)(void); |
288 | int (*enter)(void); | |
c7e0831d | 289 | void (*leave)(void); |
a634cc10 RW |
290 | int (*pre_restore)(void); |
291 | void (*restore_cleanup)(void); | |
d8f3de0d | 292 | void (*recover)(void); |
a3d25c27 RW |
293 | }; |
294 | ||
b0cb1a19 | 295 | #ifdef CONFIG_HIBERNATION |
74dfd666 | 296 | /* kernel/power/snapshot.c */ |
940d67f6 | 297 | extern void __register_nosave_region(unsigned long b, unsigned long e, int km); |
ce289e89 | 298 | static inline void __init register_nosave_region(unsigned long b, unsigned long e) |
940d67f6 JB |
299 | { |
300 | __register_nosave_region(b, e, 0); | |
301 | } | |
ce289e89 | 302 | static inline void __init register_nosave_region_late(unsigned long b, unsigned long e) |
940d67f6 JB |
303 | { |
304 | __register_nosave_region(b, e, 1); | |
305 | } | |
74dfd666 RW |
306 | extern int swsusp_page_is_forbidden(struct page *); |
307 | extern void swsusp_set_page_free(struct page *); | |
308 | extern void swsusp_unset_page_free(struct page *); | |
309 | extern unsigned long get_safe_page(gfp_t gfp_mask); | |
a3d25c27 | 310 | |
073ef1f6 | 311 | extern void hibernation_set_ops(const struct platform_hibernation_ops *ops); |
a3d25c27 | 312 | extern int hibernate(void); |
abfe2d7b | 313 | extern bool system_entering_hibernation(void); |
b0cb1a19 | 314 | #else /* CONFIG_HIBERNATION */ |
1f112cee RW |
315 | static inline void register_nosave_region(unsigned long b, unsigned long e) {} |
316 | static inline void register_nosave_region_late(unsigned long b, unsigned long e) {} | |
74dfd666 RW |
317 | static inline int swsusp_page_is_forbidden(struct page *p) { return 0; } |
318 | static inline void swsusp_set_page_free(struct page *p) {} | |
319 | static inline void swsusp_unset_page_free(struct page *p) {} | |
a3d25c27 | 320 | |
073ef1f6 | 321 | static inline void hibernation_set_ops(const struct platform_hibernation_ops *ops) {} |
a3d25c27 | 322 | static inline int hibernate(void) { return -ENOSYS; } |
fce2b111 CH |
323 | static inline bool system_entering_hibernation(void) { return false; } |
324 | #endif /* CONFIG_HIBERNATION */ | |
325 | ||
35eb6db1 AW |
326 | /* Hibernation and suspend events */ |
327 | #define PM_HIBERNATION_PREPARE 0x0001 /* Going to hibernate */ | |
328 | #define PM_POST_HIBERNATION 0x0002 /* Hibernation finished */ | |
329 | #define PM_SUSPEND_PREPARE 0x0003 /* Going to suspend the system */ | |
330 | #define PM_POST_SUSPEND 0x0004 /* Suspend finished */ | |
331 | #define PM_RESTORE_PREPARE 0x0005 /* Going to restore a saved image */ | |
332 | #define PM_POST_RESTORE 0x0006 /* Restore failed */ | |
333 | ||
296699de | 334 | #ifdef CONFIG_PM_SLEEP |
1da177e4 LT |
335 | void save_processor_state(void); |
336 | void restore_processor_state(void); | |
25761b6e | 337 | |
b10d9117 | 338 | /* kernel/power/main.c */ |
82525756 AS |
339 | extern int register_pm_notifier(struct notifier_block *nb); |
340 | extern int unregister_pm_notifier(struct notifier_block *nb); | |
b10d9117 RW |
341 | |
342 | #define pm_notifier(fn, pri) { \ | |
343 | static struct notifier_block fn##_nb = \ | |
344 | { .notifier_call = fn, .priority = pri }; \ | |
345 | register_pm_notifier(&fn##_nb); \ | |
346 | } | |
c125e96f RW |
347 | |
348 | /* drivers/base/power/wakeup.c */ | |
349 | extern bool events_check_enabled; | |
350 | ||
a2867e08 | 351 | extern bool pm_wakeup_pending(void); |
074037ec RW |
352 | extern bool pm_get_wakeup_count(unsigned int *count); |
353 | extern bool pm_save_wakeup_count(unsigned int count); | |
296699de | 354 | #else /* !CONFIG_PM_SLEEP */ |
b10d9117 RW |
355 | |
356 | static inline int register_pm_notifier(struct notifier_block *nb) | |
357 | { | |
358 | return 0; | |
359 | } | |
360 | ||
361 | static inline int unregister_pm_notifier(struct notifier_block *nb) | |
362 | { | |
363 | return 0; | |
364 | } | |
365 | ||
366 | #define pm_notifier(fn, pri) do { (void)(fn); } while (0) | |
dbeeec5f | 367 | |
a2867e08 | 368 | static inline bool pm_wakeup_pending(void) { return false; } |
296699de | 369 | #endif /* !CONFIG_PM_SLEEP */ |
b10d9117 | 370 | |
6ad696d2 AK |
371 | extern struct mutex pm_mutex; |
372 | ||
1f112cee | 373 | #ifndef CONFIG_HIBERNATE_CALLBACKS |
6ad696d2 AK |
374 | static inline void lock_system_sleep(void) {} |
375 | static inline void unlock_system_sleep(void) {} | |
376 | ||
377 | #else | |
378 | ||
379 | /* Let some subsystems like memory hotadd exclude hibernation */ | |
380 | ||
381 | static inline void lock_system_sleep(void) | |
382 | { | |
383 | mutex_lock(&pm_mutex); | |
384 | } | |
385 | ||
386 | static inline void unlock_system_sleep(void) | |
387 | { | |
388 | mutex_unlock(&pm_mutex); | |
389 | } | |
390 | #endif | |
89081d17 | 391 | |
85055dd8 MS |
392 | #ifdef CONFIG_ARCH_SAVE_PAGE_KEYS |
393 | /* | |
394 | * The ARCH_SAVE_PAGE_KEYS functions can be used by an architecture | |
395 | * to save/restore additional information to/from the array of page | |
396 | * frame numbers in the hibernation image. For s390 this is used to | |
397 | * save and restore the storage key for each page that is included | |
398 | * in the hibernation image. | |
399 | */ | |
400 | unsigned long page_key_additional_pages(unsigned long pages); | |
401 | int page_key_alloc(unsigned long pages); | |
402 | void page_key_free(void); | |
403 | void page_key_read(unsigned long *pfn); | |
404 | void page_key_memorize(unsigned long *pfn); | |
405 | void page_key_write(void *address); | |
406 | ||
407 | #else /* !CONFIG_ARCH_SAVE_PAGE_KEYS */ | |
408 | ||
409 | static inline unsigned long page_key_additional_pages(unsigned long pages) | |
410 | { | |
411 | return 0; | |
412 | } | |
413 | ||
414 | static inline int page_key_alloc(unsigned long pages) | |
415 | { | |
416 | return 0; | |
417 | } | |
418 | ||
419 | static inline void page_key_free(void) {} | |
420 | static inline void page_key_read(unsigned long *pfn) {} | |
421 | static inline void page_key_memorize(unsigned long *pfn) {} | |
422 | static inline void page_key_write(void *address) {} | |
423 | ||
424 | #endif /* !CONFIG_ARCH_SAVE_PAGE_KEYS */ | |
425 | ||
95d9ffbe | 426 | #endif /* _LINUX_SUSPEND_H */ |