Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
95d9ffbe RW |
2 | #ifndef _LINUX_SUSPEND_H |
3 | #define _LINUX_SUSPEND_H | |
1da177e4 | 4 | |
1da177e4 LT |
5 | #include <linux/swap.h> |
6 | #include <linux/notifier.h> | |
1da177e4 LT |
7 | #include <linux/init.h> |
8 | #include <linux/pm.h> | |
7be98234 | 9 | #include <linux/mm.h> |
33e638b9 | 10 | #include <linux/freezer.h> |
95d9ffbe RW |
11 | #include <asm/errno.h> |
12 | ||
37cce26b | 13 | #ifdef CONFIG_VT |
b6f448e9 | 14 | extern void pm_set_vt_switch(int); |
95d9ffbe | 15 | #else |
b6f448e9 AS |
16 | static inline void pm_set_vt_switch(int do_switch) |
17 | { | |
18 | } | |
37cce26b | 19 | #endif |
b6f448e9 | 20 | |
37cce26b | 21 | #ifdef CONFIG_VT_CONSOLE_SLEEP |
ca5f2b4c | 22 | extern void pm_prepare_console(void); |
37cce26b HS |
23 | extern void pm_restore_console(void); |
24 | #else | |
ca5f2b4c | 25 | static inline void pm_prepare_console(void) |
b6f448e9 | 26 | { |
b6f448e9 AS |
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) | |
690cbb90 | 37 | #define PM_SUSPEND_TO_IDLE ((__force suspend_state_t) 1) |
7e73c5ae | 38 | #define PM_SUSPEND_STANDBY ((__force suspend_state_t) 2) |
95d9ffbe | 39 | #define PM_SUSPEND_MEM ((__force suspend_state_t) 3) |
690cbb90 | 40 | #define PM_SUSPEND_MIN PM_SUSPEND_TO_IDLE |
95d9ffbe RW |
41 | #define PM_SUSPEND_MAX ((__force suspend_state_t) 4) |
42 | ||
2a77c46d SL |
43 | enum suspend_stat_step { |
44 | SUSPEND_FREEZE = 1, | |
45 | SUSPEND_PREPARE, | |
46 | SUSPEND_SUSPEND, | |
cf579dfb | 47 | SUSPEND_SUSPEND_LATE, |
2a77c46d SL |
48 | SUSPEND_SUSPEND_NOIRQ, |
49 | SUSPEND_RESUME_NOIRQ, | |
cf579dfb | 50 | SUSPEND_RESUME_EARLY, |
2a77c46d SL |
51 | SUSPEND_RESUME |
52 | }; | |
53 | ||
54 | struct suspend_stats { | |
55 | int success; | |
56 | int fail; | |
57 | int failed_freeze; | |
58 | int failed_prepare; | |
59 | int failed_suspend; | |
cf579dfb | 60 | int failed_suspend_late; |
2a77c46d SL |
61 | int failed_suspend_noirq; |
62 | int failed_resume; | |
cf579dfb | 63 | int failed_resume_early; |
2a77c46d SL |
64 | int failed_resume_noirq; |
65 | #define REC_FAILED_NUM 2 | |
66 | int last_failed_dev; | |
67 | char failed_devs[REC_FAILED_NUM][40]; | |
68 | int last_failed_errno; | |
69 | int errno[REC_FAILED_NUM]; | |
70 | int last_failed_step; | |
71 | enum suspend_stat_step failed_steps[REC_FAILED_NUM]; | |
72 | }; | |
73 | ||
74 | extern struct suspend_stats suspend_stats; | |
75 | ||
76 | static inline void dpm_save_failed_dev(const char *name) | |
77 | { | |
78 | strlcpy(suspend_stats.failed_devs[suspend_stats.last_failed_dev], | |
79 | name, | |
80 | sizeof(suspend_stats.failed_devs[0])); | |
81 | suspend_stats.last_failed_dev++; | |
82 | suspend_stats.last_failed_dev %= REC_FAILED_NUM; | |
83 | } | |
84 | ||
85 | static inline void dpm_save_failed_errno(int err) | |
86 | { | |
87 | suspend_stats.errno[suspend_stats.last_failed_errno] = err; | |
88 | suspend_stats.last_failed_errno++; | |
89 | suspend_stats.last_failed_errno %= REC_FAILED_NUM; | |
90 | } | |
91 | ||
92 | static inline void dpm_save_failed_step(enum suspend_stat_step step) | |
93 | { | |
94 | suspend_stats.failed_steps[suspend_stats.last_failed_step] = step; | |
95 | suspend_stats.last_failed_step++; | |
96 | suspend_stats.last_failed_step %= REC_FAILED_NUM; | |
97 | } | |
98 | ||
95d9ffbe | 99 | /** |
26398a70 RW |
100 | * struct platform_suspend_ops - Callbacks for managing platform dependent |
101 | * system sleep states. | |
95d9ffbe RW |
102 | * |
103 | * @valid: Callback to determine if given system sleep state is supported by | |
104 | * the platform. | |
105 | * Valid (ie. supported) states are advertised in /sys/power/state. Note | |
106 | * that it still may be impossible to enter given system sleep state if the | |
107 | * conditions aren't right. | |
26398a70 RW |
108 | * There is the %suspend_valid_only_mem function available that can be |
109 | * assigned to this if the platform only supports mem sleep. | |
95d9ffbe | 110 | * |
c697eece RW |
111 | * @begin: Initialise a transition to given system sleep state. |
112 | * @begin() is executed right prior to suspending devices. The information | |
113 | * conveyed to the platform code by @begin() should be disregarded by it as | |
114 | * soon as @end() is executed. If @begin() fails (ie. returns nonzero), | |
95d9ffbe RW |
115 | * @prepare(), @enter() and @finish() will not be called by the PM core. |
116 | * This callback is optional. However, if it is implemented, the argument | |
c697eece | 117 | * passed to @enter() is redundant and should be ignored. |
95d9ffbe RW |
118 | * |
119 | * @prepare: Prepare the platform for entering the system sleep state indicated | |
c697eece | 120 | * by @begin(). |
95d9ffbe RW |
121 | * @prepare() is called right after devices have been suspended (ie. the |
122 | * appropriate .suspend() method has been executed for each device) and | |
6a7c7eaf RW |
123 | * before device drivers' late suspend callbacks are executed. It returns |
124 | * 0 on success or a negative error code otherwise, in which case the | |
125 | * system cannot enter the desired sleep state (@prepare_late(), @enter(), | |
ce441011 | 126 | * and @wake() will not be called in that case). |
6a7c7eaf RW |
127 | * |
128 | * @prepare_late: Finish preparing the platform for entering the system sleep | |
129 | * state indicated by @begin(). | |
130 | * @prepare_late is called before disabling nonboot CPUs and after | |
131 | * device drivers' late suspend callbacks have been executed. It returns | |
132 | * 0 on success or a negative error code otherwise, in which case the | |
ce441011 RW |
133 | * system cannot enter the desired sleep state (@enter() will not be |
134 | * executed). | |
95d9ffbe | 135 | * |
c697eece RW |
136 | * @enter: Enter the system sleep state indicated by @begin() or represented by |
137 | * the argument if @begin() is not implemented. | |
95d9ffbe RW |
138 | * This callback is mandatory. It returns 0 on success or a negative |
139 | * error code otherwise, in which case the system cannot enter the desired | |
140 | * sleep state. | |
141 | * | |
6a7c7eaf RW |
142 | * @wake: Called when the system has just left a sleep state, right after |
143 | * the nonboot CPUs have been enabled and before device drivers' early | |
144 | * resume callbacks are executed. | |
145 | * This callback is optional, but should be implemented by the platforms | |
146 | * that implement @prepare_late(). If implemented, it is always called | |
ce441011 | 147 | * after @prepare_late and @enter(), even if one of them fails. |
6a7c7eaf RW |
148 | * |
149 | * @finish: Finish wake-up of the platform. | |
150 | * @finish is called right prior to calling device drivers' regular suspend | |
151 | * callbacks. | |
95d9ffbe RW |
152 | * This callback is optional, but should be implemented by the platforms |
153 | * that implement @prepare(). If implemented, it is always called after | |
ce441011 RW |
154 | * @enter() and @wake(), even if any of them fails. It is executed after |
155 | * a failing @prepare. | |
c697eece | 156 | * |
3b5fe852 MH |
157 | * @suspend_again: Returns whether the system should suspend again (true) or |
158 | * not (false). If the platform wants to poll sensors or execute some | |
159 | * code during suspended without invoking userspace and most of devices, | |
160 | * suspend_again callback is the place assuming that periodic-wakeup or | |
161 | * alarm-wakeup is already setup. This allows to execute some codes while | |
162 | * being kept suspended in the view of userland and devices. | |
163 | * | |
c697eece RW |
164 | * @end: Called by the PM core right after resuming devices, to indicate to |
165 | * the platform that the system has returned to the working state or | |
166 | * the transition to the sleep state has been aborted. | |
167 | * This callback is optional, but should be implemented by the platforms | |
6a7c7eaf RW |
168 | * that implement @begin(). Accordingly, platforms implementing @begin() |
169 | * should also provide a @end() which cleans up transitions aborted before | |
c697eece | 170 | * @enter(). |
d8f3de0d RW |
171 | * |
172 | * @recover: Recover the platform from a suspend failure. | |
173 | * Called by the PM core if the suspending of devices fails. | |
174 | * This callback is optional and should only be implemented by platforms | |
175 | * which require special recovery actions in that situation. | |
95d9ffbe | 176 | */ |
26398a70 | 177 | struct platform_suspend_ops { |
95d9ffbe | 178 | int (*valid)(suspend_state_t state); |
c697eece | 179 | int (*begin)(suspend_state_t state); |
e6c5eb95 | 180 | int (*prepare)(void); |
6a7c7eaf | 181 | int (*prepare_late)(void); |
95d9ffbe | 182 | int (*enter)(suspend_state_t state); |
6a7c7eaf | 183 | void (*wake)(void); |
e6c5eb95 | 184 | void (*finish)(void); |
3b5fe852 | 185 | bool (*suspend_again)(void); |
c697eece | 186 | void (*end)(void); |
d8f3de0d | 187 | void (*recover)(void); |
95d9ffbe RW |
188 | }; |
189 | ||
23d5855f | 190 | struct platform_s2idle_ops { |
1f0b6386 | 191 | int (*begin)(void); |
a8d46b9e | 192 | int (*prepare)(void); |
33e4f80e RW |
193 | void (*wake)(void); |
194 | void (*sync)(void); | |
a8d46b9e | 195 | void (*restore)(void); |
1f0b6386 RW |
196 | void (*end)(void); |
197 | }; | |
198 | ||
95d9ffbe | 199 | #ifdef CONFIG_SUSPEND |
e870c6c8 RW |
200 | extern suspend_state_t mem_sleep_current; |
201 | extern suspend_state_t mem_sleep_default; | |
202 | ||
95d9ffbe | 203 | /** |
26398a70 RW |
204 | * suspend_set_ops - set platform dependent suspend operations |
205 | * @ops: The new suspend operations to set. | |
95d9ffbe | 206 | */ |
2f55ac07 | 207 | extern void suspend_set_ops(const struct platform_suspend_ops *ops); |
26398a70 | 208 | extern int suspend_valid_only_mem(suspend_state_t state); |
38106313 | 209 | |
ef25ba04 RW |
210 | extern unsigned int pm_suspend_global_flags; |
211 | ||
471a739a RW |
212 | #define PM_SUSPEND_FLAG_FW_SUSPEND BIT(0) |
213 | #define PM_SUSPEND_FLAG_FW_RESUME BIT(1) | |
214 | #define PM_SUSPEND_FLAG_NO_PLATFORM BIT(2) | |
ef25ba04 RW |
215 | |
216 | static inline void pm_suspend_clear_flags(void) | |
217 | { | |
218 | pm_suspend_global_flags = 0; | |
219 | } | |
220 | ||
221 | static inline void pm_set_suspend_via_firmware(void) | |
222 | { | |
223 | pm_suspend_global_flags |= PM_SUSPEND_FLAG_FW_SUSPEND; | |
224 | } | |
225 | ||
226 | static inline void pm_set_resume_via_firmware(void) | |
227 | { | |
228 | pm_suspend_global_flags |= PM_SUSPEND_FLAG_FW_RESUME; | |
229 | } | |
230 | ||
471a739a RW |
231 | static inline void pm_set_suspend_no_platform(void) |
232 | { | |
233 | pm_suspend_global_flags |= PM_SUSPEND_FLAG_NO_PLATFORM; | |
234 | } | |
235 | ||
a6137347 RW |
236 | /** |
237 | * pm_suspend_via_firmware - Check if platform firmware will suspend the system. | |
238 | * | |
239 | * To be called during system-wide power management transitions to sleep states | |
240 | * or during the subsequent system-wide transitions back to the working state. | |
241 | * | |
242 | * Return 'true' if the platform firmware is going to be invoked at the end of | |
243 | * the system-wide power management transition (to a sleep state) in progress in | |
244 | * order to complete it, or if the platform firmware has been invoked in order | |
245 | * to complete the last (or preceding) transition of the system to a sleep | |
246 | * state. | |
247 | * | |
248 | * This matters if the caller needs or wants to carry out some special actions | |
249 | * depending on whether or not control will be passed to the platform firmware | |
250 | * subsequently (for example, the device may need to be reset before letting the | |
251 | * platform firmware manipulate it, which is not necessary when the platform | |
252 | * firmware is not going to be invoked) or when such special actions may have | |
253 | * been carried out during the preceding transition of the system to a sleep | |
254 | * state (as they may need to be taken into account). | |
255 | */ | |
ef25ba04 RW |
256 | static inline bool pm_suspend_via_firmware(void) |
257 | { | |
258 | return !!(pm_suspend_global_flags & PM_SUSPEND_FLAG_FW_SUSPEND); | |
259 | } | |
260 | ||
a6137347 RW |
261 | /** |
262 | * pm_resume_via_firmware - Check if platform firmware has woken up the system. | |
263 | * | |
264 | * To be called during system-wide power management transitions from sleep | |
265 | * states. | |
266 | * | |
267 | * Return 'true' if the platform firmware has passed control to the kernel at | |
268 | * the beginning of the system-wide power management transition in progress, so | |
269 | * the event that woke up the system from sleep has been handled by the platform | |
270 | * firmware. | |
271 | */ | |
ef25ba04 RW |
272 | static inline bool pm_resume_via_firmware(void) |
273 | { | |
274 | return !!(pm_suspend_global_flags & PM_SUSPEND_FLAG_FW_RESUME); | |
275 | } | |
276 | ||
471a739a RW |
277 | /** |
278 | * pm_suspend_no_platform - Check if platform may change device power states. | |
279 | * | |
280 | * To be called during system-wide power management transitions to sleep states | |
281 | * or during the subsequent system-wide transitions back to the working state. | |
282 | * | |
283 | * Return 'true' if the power states of devices remain under full control of the | |
284 | * kernel throughout the system-wide suspend and resume cycle in progress (that | |
285 | * is, if a device is put into a certain power state during suspend, it can be | |
286 | * expected to remain in that state during resume). | |
287 | */ | |
288 | static inline bool pm_suspend_no_platform(void) | |
289 | { | |
290 | return !!(pm_suspend_global_flags & PM_SUSPEND_FLAG_NO_PLATFORM); | |
291 | } | |
292 | ||
38106313 | 293 | /* Suspend-to-idle state machnine. */ |
f02f4f9d RW |
294 | enum s2idle_states { |
295 | S2IDLE_STATE_NONE, /* Not suspended/suspending. */ | |
296 | S2IDLE_STATE_ENTER, /* Enter suspend-to-idle. */ | |
297 | S2IDLE_STATE_WAKE, /* Wake up from suspend-to-idle. */ | |
38106313 RW |
298 | }; |
299 | ||
f02f4f9d | 300 | extern enum s2idle_states __read_mostly s2idle_state; |
38106313 | 301 | |
f02f4f9d | 302 | static inline bool idle_should_enter_s2idle(void) |
38106313 | 303 | { |
f02f4f9d | 304 | return unlikely(s2idle_state == S2IDLE_STATE_ENTER); |
38106313 RW |
305 | } |
306 | ||
0b385a0c | 307 | extern bool pm_suspend_default_s2idle(void); |
fa7fd6fa | 308 | extern void __init pm_states_init(void); |
23d5855f | 309 | extern void s2idle_set_ops(const struct platform_s2idle_ops *ops); |
f02f4f9d | 310 | extern void s2idle_wake(void); |
95d9ffbe RW |
311 | |
312 | /** | |
313 | * arch_suspend_disable_irqs - disable IRQs for suspend | |
314 | * | |
315 | * Disables IRQs (in the default case). This is a weak symbol in the common | |
316 | * code and thus allows architectures to override it if more needs to be | |
317 | * done. Not called for suspend to disk. | |
318 | */ | |
319 | extern void arch_suspend_disable_irqs(void); | |
320 | ||
321 | /** | |
322 | * arch_suspend_enable_irqs - enable IRQs after suspend | |
323 | * | |
324 | * Enables IRQs (in the default case). This is a weak symbol in the common | |
325 | * code and thus allows architectures to override it if more needs to be | |
326 | * done. Not called for suspend to disk. | |
327 | */ | |
328 | extern void arch_suspend_enable_irqs(void); | |
329 | ||
330 | extern int pm_suspend(suspend_state_t state); | |
331 | #else /* !CONFIG_SUSPEND */ | |
332 | #define suspend_valid_only_mem NULL | |
333 | ||
ef25ba04 RW |
334 | static inline void pm_suspend_clear_flags(void) {} |
335 | static inline void pm_set_suspend_via_firmware(void) {} | |
336 | static inline void pm_set_resume_via_firmware(void) {} | |
337 | static inline bool pm_suspend_via_firmware(void) { return false; } | |
338 | static inline bool pm_resume_via_firmware(void) { return false; } | |
0b385a0c | 339 | static inline bool pm_suspend_default_s2idle(void) { return false; } |
ef25ba04 | 340 | |
2f55ac07 | 341 | static inline void suspend_set_ops(const struct platform_suspend_ops *ops) {} |
95d9ffbe | 342 | static inline int pm_suspend(suspend_state_t state) { return -ENOSYS; } |
f02f4f9d | 343 | static inline bool idle_should_enter_s2idle(void) { return false; } |
fa7fd6fa | 344 | static inline void __init pm_states_init(void) {} |
23d5855f | 345 | static inline void s2idle_set_ops(const struct platform_s2idle_ops *ops) {} |
f02f4f9d | 346 | static inline void s2idle_wake(void) {} |
95d9ffbe | 347 | #endif /* !CONFIG_SUSPEND */ |
1da177e4 | 348 | |
8357376d RW |
349 | /* struct pbe is used for creating lists of pages that should be restored |
350 | * atomically during the resume from disk, because the page frames they have | |
351 | * occupied before the suspend are in use. | |
352 | */ | |
dcbb5a54 | 353 | struct pbe { |
8357376d RW |
354 | void *address; /* address of the copy */ |
355 | void *orig_address; /* original address of a page */ | |
7088a5c0 | 356 | struct pbe *next; |
dcbb5a54 | 357 | }; |
1da177e4 | 358 | |
1da177e4 | 359 | /* mm/page_alloc.c */ |
1da177e4 LT |
360 | extern void mark_free_pages(struct zone *zone); |
361 | ||
a3d25c27 | 362 | /** |
b3dac3b3 | 363 | * struct platform_hibernation_ops - hibernation platform support |
a3d25c27 | 364 | * |
caea99ef RW |
365 | * The methods in this structure allow a platform to carry out special |
366 | * operations required by it during a hibernation transition. | |
a3d25c27 | 367 | * |
d8f3de0d | 368 | * All the methods below, except for @recover(), must be implemented. |
a3d25c27 | 369 | * |
caea99ef | 370 | * @begin: Tell the platform driver that we're starting hibernation. |
74f270af RW |
371 | * Called right after shrinking memory and before freezing devices. |
372 | * | |
caea99ef RW |
373 | * @end: Called by the PM core right after resuming devices, to indicate to |
374 | * the platform that the system has returned to the working state. | |
375 | * | |
74f270af RW |
376 | * @pre_snapshot: Prepare the platform for creating the hibernation image. |
377 | * Called right after devices have been frozen and before the nonboot | |
378 | * CPUs are disabled (runs with IRQs on). | |
379 | * | |
380 | * @finish: Restore the previous state of the platform after the hibernation | |
381 | * image has been created *or* put the platform into the normal operation | |
382 | * mode after the hibernation (the same method is executed in both cases). | |
383 | * Called right after the nonboot CPUs have been enabled and before | |
384 | * thawing devices (runs with IRQs on). | |
385 | * | |
386 | * @prepare: Prepare the platform for entering the low power state. | |
387 | * Called right after the hibernation image has been saved and before | |
388 | * devices are prepared for entering the low power state. | |
389 | * | |
390 | * @enter: Put the system into the low power state after the hibernation image | |
391 | * has been saved to disk. | |
392 | * Called after the nonboot CPUs have been disabled and all of the low | |
393 | * level devices have been shut down (runs with IRQs off). | |
394 | * | |
c7e0831d RW |
395 | * @leave: Perform the first stage of the cleanup after the system sleep state |
396 | * indicated by @set_target() has been left. | |
397 | * Called right after the control has been passed from the boot kernel to | |
398 | * the image kernel, before the nonboot CPUs are enabled and before devices | |
399 | * are resumed. Executed with interrupts disabled. | |
400 | * | |
74f270af RW |
401 | * @pre_restore: Prepare system for the restoration from a hibernation image. |
402 | * Called right after devices have been frozen and before the nonboot | |
403 | * CPUs are disabled (runs with IRQs on). | |
404 | * | |
405 | * @restore_cleanup: Clean up after a failing image restoration. | |
406 | * Called right after the nonboot CPUs have been enabled and before | |
407 | * thawing devices (runs with IRQs on). | |
d8f3de0d RW |
408 | * |
409 | * @recover: Recover the platform from a failure to suspend devices. | |
410 | * Called by the PM core if the suspending of devices during hibernation | |
411 | * fails. This callback is optional and should only be implemented by | |
412 | * platforms which require special recovery actions in that situation. | |
a3d25c27 | 413 | */ |
b3dac3b3 | 414 | struct platform_hibernation_ops { |
bb186901 | 415 | int (*begin)(pm_message_t stage); |
caea99ef | 416 | void (*end)(void); |
74f270af RW |
417 | int (*pre_snapshot)(void); |
418 | void (*finish)(void); | |
a3d25c27 RW |
419 | int (*prepare)(void); |
420 | int (*enter)(void); | |
c7e0831d | 421 | void (*leave)(void); |
a634cc10 RW |
422 | int (*pre_restore)(void); |
423 | void (*restore_cleanup)(void); | |
d8f3de0d | 424 | void (*recover)(void); |
a3d25c27 RW |
425 | }; |
426 | ||
b0cb1a19 | 427 | #ifdef CONFIG_HIBERNATION |
74dfd666 | 428 | /* kernel/power/snapshot.c */ |
940d67f6 | 429 | extern void __register_nosave_region(unsigned long b, unsigned long e, int km); |
ce289e89 | 430 | static inline void __init register_nosave_region(unsigned long b, unsigned long e) |
940d67f6 JB |
431 | { |
432 | __register_nosave_region(b, e, 0); | |
433 | } | |
ce289e89 | 434 | static inline void __init register_nosave_region_late(unsigned long b, unsigned long e) |
940d67f6 JB |
435 | { |
436 | __register_nosave_region(b, e, 1); | |
437 | } | |
74dfd666 RW |
438 | extern int swsusp_page_is_forbidden(struct page *); |
439 | extern void swsusp_set_page_free(struct page *); | |
440 | extern void swsusp_unset_page_free(struct page *); | |
441 | extern unsigned long get_safe_page(gfp_t gfp_mask); | |
328008a7 AB |
442 | extern asmlinkage int swsusp_arch_suspend(void); |
443 | extern asmlinkage int swsusp_arch_resume(void); | |
a3d25c27 | 444 | |
073ef1f6 | 445 | extern void hibernation_set_ops(const struct platform_hibernation_ops *ops); |
a3d25c27 | 446 | extern int hibernate(void); |
abfe2d7b | 447 | extern bool system_entering_hibernation(void); |
a6e15a39 | 448 | extern bool hibernation_available(void); |
603fb42a SC |
449 | asmlinkage int swsusp_save(void); |
450 | extern struct pbe *restore_pblist; | |
1ec0cd82 | 451 | int pfn_is_nosave(unsigned long pfn); |
b0cb1a19 | 452 | #else /* CONFIG_HIBERNATION */ |
1f112cee RW |
453 | static inline void register_nosave_region(unsigned long b, unsigned long e) {} |
454 | static inline void register_nosave_region_late(unsigned long b, unsigned long e) {} | |
74dfd666 RW |
455 | static inline int swsusp_page_is_forbidden(struct page *p) { return 0; } |
456 | static inline void swsusp_set_page_free(struct page *p) {} | |
457 | static inline void swsusp_unset_page_free(struct page *p) {} | |
a3d25c27 | 458 | |
073ef1f6 | 459 | static inline void hibernation_set_ops(const struct platform_hibernation_ops *ops) {} |
a3d25c27 | 460 | static inline int hibernate(void) { return -ENOSYS; } |
fce2b111 | 461 | static inline bool system_entering_hibernation(void) { return false; } |
a6e15a39 | 462 | static inline bool hibernation_available(void) { return false; } |
fce2b111 CH |
463 | #endif /* CONFIG_HIBERNATION */ |
464 | ||
35eb6db1 AW |
465 | /* Hibernation and suspend events */ |
466 | #define PM_HIBERNATION_PREPARE 0x0001 /* Going to hibernate */ | |
467 | #define PM_POST_HIBERNATION 0x0002 /* Hibernation finished */ | |
468 | #define PM_SUSPEND_PREPARE 0x0003 /* Going to suspend the system */ | |
469 | #define PM_POST_SUSPEND 0x0004 /* Suspend finished */ | |
470 | #define PM_RESTORE_PREPARE 0x0005 /* Going to restore a saved image */ | |
471 | #define PM_POST_RESTORE 0x0006 /* Restore failed */ | |
472 | ||
55f2503c | 473 | extern struct mutex system_transition_mutex; |
9b6fc5dc | 474 | |
296699de | 475 | #ifdef CONFIG_PM_SLEEP |
1da177e4 LT |
476 | void save_processor_state(void); |
477 | void restore_processor_state(void); | |
25761b6e | 478 | |
b10d9117 | 479 | /* kernel/power/main.c */ |
82525756 AS |
480 | extern int register_pm_notifier(struct notifier_block *nb); |
481 | extern int unregister_pm_notifier(struct notifier_block *nb); | |
b5dee313 | 482 | extern void ksys_sync_helper(void); |
b10d9117 RW |
483 | |
484 | #define pm_notifier(fn, pri) { \ | |
485 | static struct notifier_block fn##_nb = \ | |
486 | { .notifier_call = fn, .priority = pri }; \ | |
487 | register_pm_notifier(&fn##_nb); \ | |
488 | } | |
c125e96f RW |
489 | |
490 | /* drivers/base/power/wakeup.c */ | |
491 | extern bool events_check_enabled; | |
a6f5f0dd | 492 | extern unsigned int pm_wakeup_irq; |
bd8c9ba3 | 493 | extern suspend_state_t pm_suspend_target_state; |
c125e96f | 494 | |
a2867e08 | 495 | extern bool pm_wakeup_pending(void); |
068765ba | 496 | extern void pm_system_wakeup(void); |
33e4f80e RW |
497 | extern void pm_system_cancel_wakeup(void); |
498 | extern void pm_wakeup_clear(bool reset); | |
a6f5f0dd | 499 | extern void pm_system_irq_wakeup(unsigned int irq_number); |
7483b4a4 | 500 | extern bool pm_get_wakeup_count(unsigned int *count, bool block); |
074037ec | 501 | extern bool pm_save_wakeup_count(unsigned int count); |
55850945 | 502 | extern void pm_wakep_autosleep_enabled(bool set); |
bb177fed | 503 | extern void pm_print_active_wakeup_sources(void); |
9b6fc5dc | 504 | |
4bf236a3 BVA |
505 | extern void lock_system_sleep(void); |
506 | extern void unlock_system_sleep(void); | |
9b6fc5dc | 507 | |
296699de | 508 | #else /* !CONFIG_PM_SLEEP */ |
b10d9117 RW |
509 | |
510 | static inline int register_pm_notifier(struct notifier_block *nb) | |
511 | { | |
512 | return 0; | |
513 | } | |
514 | ||
515 | static inline int unregister_pm_notifier(struct notifier_block *nb) | |
516 | { | |
517 | return 0; | |
518 | } | |
519 | ||
b5dee313 HP |
520 | static inline void ksys_sync_helper(void) {} |
521 | ||
b10d9117 | 522 | #define pm_notifier(fn, pri) do { (void)(fn); } while (0) |
dbeeec5f | 523 | |
a2867e08 | 524 | static inline bool pm_wakeup_pending(void) { return false; } |
068765ba | 525 | static inline void pm_system_wakeup(void) {} |
33e4f80e | 526 | static inline void pm_wakeup_clear(bool reset) {} |
a6f5f0dd | 527 | static inline void pm_system_irq_wakeup(unsigned int irq_number) {} |
6ad696d2 | 528 | |
6ad696d2 AK |
529 | static inline void lock_system_sleep(void) {} |
530 | static inline void unlock_system_sleep(void) {} | |
531 | ||
9b6fc5dc | 532 | #endif /* !CONFIG_PM_SLEEP */ |
89081d17 | 533 | |
b2df1d4f RW |
534 | #ifdef CONFIG_PM_SLEEP_DEBUG |
535 | extern bool pm_print_times_enabled; | |
726fb6b4 | 536 | extern bool pm_debug_messages_on; |
cb08e035 | 537 | extern __printf(2, 3) void __pm_pr_dbg(bool defer, const char *fmt, ...); |
b2df1d4f RW |
538 | #else |
539 | #define pm_print_times_enabled (false) | |
726fb6b4 | 540 | #define pm_debug_messages_on (false) |
8d8b2441 RW |
541 | |
542 | #include <linux/printk.h> | |
543 | ||
cb08e035 | 544 | #define __pm_pr_dbg(defer, fmt, ...) \ |
8d8b2441 | 545 | no_printk(KERN_DEBUG fmt, ##__VA_ARGS__) |
b2df1d4f RW |
546 | #endif |
547 | ||
cb08e035 RW |
548 | #define pm_pr_dbg(fmt, ...) \ |
549 | __pm_pr_dbg(false, fmt, ##__VA_ARGS__) | |
550 | ||
551 | #define pm_deferred_pr_dbg(fmt, ...) \ | |
552 | __pm_pr_dbg(true, fmt, ##__VA_ARGS__) | |
553 | ||
7483b4a4 RW |
554 | #ifdef CONFIG_PM_AUTOSLEEP |
555 | ||
556 | /* kernel/power/autosleep.c */ | |
557 | void queue_up_suspend_work(void); | |
558 | ||
559 | #else /* !CONFIG_PM_AUTOSLEEP */ | |
560 | ||
561 | static inline void queue_up_suspend_work(void) {} | |
562 | ||
563 | #endif /* !CONFIG_PM_AUTOSLEEP */ | |
564 | ||
85055dd8 MS |
565 | #ifdef CONFIG_ARCH_SAVE_PAGE_KEYS |
566 | /* | |
567 | * The ARCH_SAVE_PAGE_KEYS functions can be used by an architecture | |
568 | * to save/restore additional information to/from the array of page | |
569 | * frame numbers in the hibernation image. For s390 this is used to | |
570 | * save and restore the storage key for each page that is included | |
571 | * in the hibernation image. | |
572 | */ | |
573 | unsigned long page_key_additional_pages(unsigned long pages); | |
574 | int page_key_alloc(unsigned long pages); | |
575 | void page_key_free(void); | |
576 | void page_key_read(unsigned long *pfn); | |
577 | void page_key_memorize(unsigned long *pfn); | |
578 | void page_key_write(void *address); | |
579 | ||
580 | #else /* !CONFIG_ARCH_SAVE_PAGE_KEYS */ | |
581 | ||
582 | static inline unsigned long page_key_additional_pages(unsigned long pages) | |
583 | { | |
584 | return 0; | |
585 | } | |
586 | ||
587 | static inline int page_key_alloc(unsigned long pages) | |
588 | { | |
589 | return 0; | |
590 | } | |
591 | ||
592 | static inline void page_key_free(void) {} | |
593 | static inline void page_key_read(unsigned long *pfn) {} | |
594 | static inline void page_key_memorize(unsigned long *pfn) {} | |
595 | static inline void page_key_write(void *address) {} | |
596 | ||
597 | #endif /* !CONFIG_ARCH_SAVE_PAGE_KEYS */ | |
598 | ||
95d9ffbe | 599 | #endif /* _LINUX_SUSPEND_H */ |