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