Merge tag 'for-linus-20160523' of git://git.infradead.org/linux-mtd
[linux-2.6-block.git] / include / linux / suspend.h
1 #ifndef _LINUX_SUSPEND_H
2 #define _LINUX_SUSPEND_H
3
4 #include <linux/swap.h>
5 #include <linux/notifier.h>
6 #include <linux/init.h>
7 #include <linux/pm.h>
8 #include <linux/mm.h>
9 #include <linux/freezer.h>
10 #include <asm/errno.h>
11
12 #ifdef CONFIG_VT
13 extern void pm_set_vt_switch(int);
14 #else
15 static inline void pm_set_vt_switch(int do_switch)
16 {
17 }
18 #endif
19
20 #ifdef CONFIG_VT_CONSOLE_SLEEP
21 extern int pm_prepare_console(void);
22 extern void pm_restore_console(void);
23 #else
24 static inline int pm_prepare_console(void)
25 {
26         return 0;
27 }
28
29 static inline void pm_restore_console(void)
30 {
31 }
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_FREEZE       ((__force suspend_state_t) 1)
38 #define PM_SUSPEND_STANDBY      ((__force suspend_state_t) 2)
39 #define PM_SUSPEND_MEM          ((__force suspend_state_t) 3)
40 #define PM_SUSPEND_MIN          PM_SUSPEND_FREEZE
41 #define PM_SUSPEND_MAX          ((__force suspend_state_t) 4)
42
43 enum suspend_stat_step {
44         SUSPEND_FREEZE = 1,
45         SUSPEND_PREPARE,
46         SUSPEND_SUSPEND,
47         SUSPEND_SUSPEND_LATE,
48         SUSPEND_SUSPEND_NOIRQ,
49         SUSPEND_RESUME_NOIRQ,
50         SUSPEND_RESUME_EARLY,
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;
60         int     failed_suspend_late;
61         int     failed_suspend_noirq;
62         int     failed_resume;
63         int     failed_resume_early;
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
99 /**
100  * struct platform_suspend_ops - Callbacks for managing platform dependent
101  *      system sleep states.
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.
108  *      There is the %suspend_valid_only_mem function available that can be
109  *      assigned to this if the platform only supports mem sleep.
110  *
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),
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
117  *      passed to @enter() is redundant and should be ignored.
118  *
119  * @prepare: Prepare the platform for entering the system sleep state indicated
120  *      by @begin().
121  *      @prepare() is called right after devices have been suspended (ie. the
122  *      appropriate .suspend() method has been executed for each device) and
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(),
126  *      and @wake() will not be called in that case).
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
133  *      system cannot enter the desired sleep state (@enter() will not be
134  *      executed).
135  *
136  * @enter: Enter the system sleep state indicated by @begin() or represented by
137  *      the argument if @begin() is not implemented.
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  *
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
147  *      after @prepare_late and @enter(), even if one of them fails.
148  *
149  * @finish: Finish wake-up of the platform.
150  *      @finish is called right prior to calling device drivers' regular suspend
151  *      callbacks.
152  *      This callback is optional, but should be implemented by the platforms
153  *      that implement @prepare().  If implemented, it is always called after
154  *      @enter() and @wake(), even if any of them fails.  It is executed after
155  *      a failing @prepare.
156  *
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  *
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
168  *      that implement @begin().  Accordingly, platforms implementing @begin()
169  *      should also provide a @end() which cleans up transitions aborted before
170  *      @enter().
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.
176  */
177 struct platform_suspend_ops {
178         int (*valid)(suspend_state_t state);
179         int (*begin)(suspend_state_t state);
180         int (*prepare)(void);
181         int (*prepare_late)(void);
182         int (*enter)(suspend_state_t state);
183         void (*wake)(void);
184         void (*finish)(void);
185         bool (*suspend_again)(void);
186         void (*end)(void);
187         void (*recover)(void);
188 };
189
190 struct platform_freeze_ops {
191         int (*begin)(void);
192         int (*prepare)(void);
193         void (*restore)(void);
194         void (*end)(void);
195 };
196
197 #ifdef CONFIG_SUSPEND
198 /**
199  * suspend_set_ops - set platform dependent suspend operations
200  * @ops: The new suspend operations to set.
201  */
202 extern void suspend_set_ops(const struct platform_suspend_ops *ops);
203 extern int suspend_valid_only_mem(suspend_state_t state);
204
205 extern unsigned int pm_suspend_global_flags;
206
207 #define PM_SUSPEND_FLAG_FW_SUSPEND      (1 << 0)
208 #define PM_SUSPEND_FLAG_FW_RESUME       (1 << 1)
209
210 static inline void pm_suspend_clear_flags(void)
211 {
212         pm_suspend_global_flags = 0;
213 }
214
215 static inline void pm_set_suspend_via_firmware(void)
216 {
217         pm_suspend_global_flags |= PM_SUSPEND_FLAG_FW_SUSPEND;
218 }
219
220 static inline void pm_set_resume_via_firmware(void)
221 {
222         pm_suspend_global_flags |= PM_SUSPEND_FLAG_FW_RESUME;
223 }
224
225 static inline bool pm_suspend_via_firmware(void)
226 {
227         return !!(pm_suspend_global_flags & PM_SUSPEND_FLAG_FW_SUSPEND);
228 }
229
230 static inline bool pm_resume_via_firmware(void)
231 {
232         return !!(pm_suspend_global_flags & PM_SUSPEND_FLAG_FW_RESUME);
233 }
234
235 /* Suspend-to-idle state machnine. */
236 enum freeze_state {
237         FREEZE_STATE_NONE,      /* Not suspended/suspending. */
238         FREEZE_STATE_ENTER,     /* Enter suspend-to-idle. */
239         FREEZE_STATE_WAKE,      /* Wake up from suspend-to-idle. */
240 };
241
242 extern enum freeze_state __read_mostly suspend_freeze_state;
243
244 static inline bool idle_should_freeze(void)
245 {
246         return unlikely(suspend_freeze_state == FREEZE_STATE_ENTER);
247 }
248
249 extern void freeze_set_ops(const struct platform_freeze_ops *ops);
250 extern void freeze_wake(void);
251
252 /**
253  * arch_suspend_disable_irqs - disable IRQs for suspend
254  *
255  * Disables IRQs (in the default case). This is a weak symbol in the common
256  * code and thus allows architectures to override it if more needs to be
257  * done. Not called for suspend to disk.
258  */
259 extern void arch_suspend_disable_irqs(void);
260
261 /**
262  * arch_suspend_enable_irqs - enable IRQs after suspend
263  *
264  * Enables IRQs (in the default case). This is a weak symbol in the common
265  * code and thus allows architectures to override it if more needs to be
266  * done. Not called for suspend to disk.
267  */
268 extern void arch_suspend_enable_irqs(void);
269
270 extern int pm_suspend(suspend_state_t state);
271 #else /* !CONFIG_SUSPEND */
272 #define suspend_valid_only_mem  NULL
273
274 static inline void pm_suspend_clear_flags(void) {}
275 static inline void pm_set_suspend_via_firmware(void) {}
276 static inline void pm_set_resume_via_firmware(void) {}
277 static inline bool pm_suspend_via_firmware(void) { return false; }
278 static inline bool pm_resume_via_firmware(void) { return false; }
279
280 static inline void suspend_set_ops(const struct platform_suspend_ops *ops) {}
281 static inline int pm_suspend(suspend_state_t state) { return -ENOSYS; }
282 static inline bool idle_should_freeze(void) { return false; }
283 static inline void freeze_set_ops(const struct platform_freeze_ops *ops) {}
284 static inline void freeze_wake(void) {}
285 #endif /* !CONFIG_SUSPEND */
286
287 /* struct pbe is used for creating lists of pages that should be restored
288  * atomically during the resume from disk, because the page frames they have
289  * occupied before the suspend are in use.
290  */
291 struct pbe {
292         void *address;          /* address of the copy */
293         void *orig_address;     /* original address of a page */
294         struct pbe *next;
295 };
296
297 /* mm/page_alloc.c */
298 extern void mark_free_pages(struct zone *zone);
299
300 /**
301  * struct platform_hibernation_ops - hibernation platform support
302  *
303  * The methods in this structure allow a platform to carry out special
304  * operations required by it during a hibernation transition.
305  *
306  * All the methods below, except for @recover(), must be implemented.
307  *
308  * @begin: Tell the platform driver that we're starting hibernation.
309  *      Called right after shrinking memory and before freezing devices.
310  *
311  * @end: Called by the PM core right after resuming devices, to indicate to
312  *      the platform that the system has returned to the working state.
313  *
314  * @pre_snapshot: Prepare the platform for creating the hibernation image.
315  *      Called right after devices have been frozen and before the nonboot
316  *      CPUs are disabled (runs with IRQs on).
317  *
318  * @finish: Restore the previous state of the platform after the hibernation
319  *      image has been created *or* put the platform into the normal operation
320  *      mode after the hibernation (the same method is executed in both cases).
321  *      Called right after the nonboot CPUs have been enabled and before
322  *      thawing devices (runs with IRQs on).
323  *
324  * @prepare: Prepare the platform for entering the low power state.
325  *      Called right after the hibernation image has been saved and before
326  *      devices are prepared for entering the low power state.
327  *
328  * @enter: Put the system into the low power state after the hibernation image
329  *      has been saved to disk.
330  *      Called after the nonboot CPUs have been disabled and all of the low
331  *      level devices have been shut down (runs with IRQs off).
332  *
333  * @leave: Perform the first stage of the cleanup after the system sleep state
334  *      indicated by @set_target() has been left.
335  *      Called right after the control has been passed from the boot kernel to
336  *      the image kernel, before the nonboot CPUs are enabled and before devices
337  *      are resumed.  Executed with interrupts disabled.
338  *
339  * @pre_restore: Prepare system for the restoration from a hibernation image.
340  *      Called right after devices have been frozen and before the nonboot
341  *      CPUs are disabled (runs with IRQs on).
342  *
343  * @restore_cleanup: Clean up after a failing image restoration.
344  *      Called right after the nonboot CPUs have been enabled and before
345  *      thawing devices (runs with IRQs on).
346  *
347  * @recover: Recover the platform from a failure to suspend devices.
348  *      Called by the PM core if the suspending of devices during hibernation
349  *      fails.  This callback is optional and should only be implemented by
350  *      platforms which require special recovery actions in that situation.
351  */
352 struct platform_hibernation_ops {
353         int (*begin)(void);
354         void (*end)(void);
355         int (*pre_snapshot)(void);
356         void (*finish)(void);
357         int (*prepare)(void);
358         int (*enter)(void);
359         void (*leave)(void);
360         int (*pre_restore)(void);
361         void (*restore_cleanup)(void);
362         void (*recover)(void);
363 };
364
365 #ifdef CONFIG_HIBERNATION
366 /* kernel/power/snapshot.c */
367 extern void __register_nosave_region(unsigned long b, unsigned long e, int km);
368 static inline void __init register_nosave_region(unsigned long b, unsigned long e)
369 {
370         __register_nosave_region(b, e, 0);
371 }
372 static inline void __init register_nosave_region_late(unsigned long b, unsigned long e)
373 {
374         __register_nosave_region(b, e, 1);
375 }
376 extern int swsusp_page_is_forbidden(struct page *);
377 extern void swsusp_set_page_free(struct page *);
378 extern void swsusp_unset_page_free(struct page *);
379 extern unsigned long get_safe_page(gfp_t gfp_mask);
380
381 extern void hibernation_set_ops(const struct platform_hibernation_ops *ops);
382 extern int hibernate(void);
383 extern bool system_entering_hibernation(void);
384 extern bool hibernation_available(void);
385 asmlinkage int swsusp_save(void);
386 extern struct pbe *restore_pblist;
387 #else /* CONFIG_HIBERNATION */
388 static inline void register_nosave_region(unsigned long b, unsigned long e) {}
389 static inline void register_nosave_region_late(unsigned long b, unsigned long e) {}
390 static inline int swsusp_page_is_forbidden(struct page *p) { return 0; }
391 static inline void swsusp_set_page_free(struct page *p) {}
392 static inline void swsusp_unset_page_free(struct page *p) {}
393
394 static inline void hibernation_set_ops(const struct platform_hibernation_ops *ops) {}
395 static inline int hibernate(void) { return -ENOSYS; }
396 static inline bool system_entering_hibernation(void) { return false; }
397 static inline bool hibernation_available(void) { return false; }
398 #endif /* CONFIG_HIBERNATION */
399
400 /* Hibernation and suspend events */
401 #define PM_HIBERNATION_PREPARE  0x0001 /* Going to hibernate */
402 #define PM_POST_HIBERNATION     0x0002 /* Hibernation finished */
403 #define PM_SUSPEND_PREPARE      0x0003 /* Going to suspend the system */
404 #define PM_POST_SUSPEND         0x0004 /* Suspend finished */
405 #define PM_RESTORE_PREPARE      0x0005 /* Going to restore a saved image */
406 #define PM_POST_RESTORE         0x0006 /* Restore failed */
407
408 extern struct mutex pm_mutex;
409
410 #ifdef CONFIG_PM_SLEEP
411 void save_processor_state(void);
412 void restore_processor_state(void);
413
414 /* kernel/power/main.c */
415 extern int register_pm_notifier(struct notifier_block *nb);
416 extern int unregister_pm_notifier(struct notifier_block *nb);
417
418 #define pm_notifier(fn, pri) {                          \
419         static struct notifier_block fn##_nb =                  \
420                 { .notifier_call = fn, .priority = pri };       \
421         register_pm_notifier(&fn##_nb);                 \
422 }
423
424 /* drivers/base/power/wakeup.c */
425 extern bool events_check_enabled;
426 extern unsigned int pm_wakeup_irq;
427
428 extern bool pm_wakeup_pending(void);
429 extern void pm_system_wakeup(void);
430 extern void pm_wakeup_clear(void);
431 extern void pm_system_irq_wakeup(unsigned int irq_number);
432 extern bool pm_get_wakeup_count(unsigned int *count, bool block);
433 extern bool pm_save_wakeup_count(unsigned int count);
434 extern void pm_wakep_autosleep_enabled(bool set);
435 extern void pm_print_active_wakeup_sources(void);
436
437 static inline void lock_system_sleep(void)
438 {
439         current->flags |= PF_FREEZER_SKIP;
440         mutex_lock(&pm_mutex);
441 }
442
443 static inline void unlock_system_sleep(void)
444 {
445         /*
446          * Don't use freezer_count() because we don't want the call to
447          * try_to_freeze() here.
448          *
449          * Reason:
450          * Fundamentally, we just don't need it, because freezing condition
451          * doesn't come into effect until we release the pm_mutex lock,
452          * since the freezer always works with pm_mutex held.
453          *
454          * More importantly, in the case of hibernation,
455          * unlock_system_sleep() gets called in snapshot_read() and
456          * snapshot_write() when the freezing condition is still in effect.
457          * Which means, if we use try_to_freeze() here, it would make them
458          * enter the refrigerator, thus causing hibernation to lockup.
459          */
460         current->flags &= ~PF_FREEZER_SKIP;
461         mutex_unlock(&pm_mutex);
462 }
463
464 #else /* !CONFIG_PM_SLEEP */
465
466 static inline int register_pm_notifier(struct notifier_block *nb)
467 {
468         return 0;
469 }
470
471 static inline int unregister_pm_notifier(struct notifier_block *nb)
472 {
473         return 0;
474 }
475
476 #define pm_notifier(fn, pri)    do { (void)(fn); } while (0)
477
478 static inline bool pm_wakeup_pending(void) { return false; }
479 static inline void pm_system_wakeup(void) {}
480 static inline void pm_wakeup_clear(void) {}
481 static inline void pm_system_irq_wakeup(unsigned int irq_number) {}
482
483 static inline void lock_system_sleep(void) {}
484 static inline void unlock_system_sleep(void) {}
485
486 #endif /* !CONFIG_PM_SLEEP */
487
488 #ifdef CONFIG_PM_SLEEP_DEBUG
489 extern bool pm_print_times_enabled;
490 #else
491 #define pm_print_times_enabled  (false)
492 #endif
493
494 #ifdef CONFIG_PM_AUTOSLEEP
495
496 /* kernel/power/autosleep.c */
497 void queue_up_suspend_work(void);
498
499 #else /* !CONFIG_PM_AUTOSLEEP */
500
501 static inline void queue_up_suspend_work(void) {}
502
503 #endif /* !CONFIG_PM_AUTOSLEEP */
504
505 #ifdef CONFIG_ARCH_SAVE_PAGE_KEYS
506 /*
507  * The ARCH_SAVE_PAGE_KEYS functions can be used by an architecture
508  * to save/restore additional information to/from the array of page
509  * frame numbers in the hibernation image. For s390 this is used to
510  * save and restore the storage key for each page that is included
511  * in the hibernation image.
512  */
513 unsigned long page_key_additional_pages(unsigned long pages);
514 int page_key_alloc(unsigned long pages);
515 void page_key_free(void);
516 void page_key_read(unsigned long *pfn);
517 void page_key_memorize(unsigned long *pfn);
518 void page_key_write(void *address);
519
520 #else /* !CONFIG_ARCH_SAVE_PAGE_KEYS */
521
522 static inline unsigned long page_key_additional_pages(unsigned long pages)
523 {
524         return 0;
525 }
526
527 static inline int  page_key_alloc(unsigned long pages)
528 {
529         return 0;
530 }
531
532 static inline void page_key_free(void) {}
533 static inline void page_key_read(unsigned long *pfn) {}
534 static inline void page_key_memorize(unsigned long *pfn) {}
535 static inline void page_key_write(void *address) {}
536
537 #endif /* !CONFIG_ARCH_SAVE_PAGE_KEYS */
538
539 #endif /* _LINUX_SUSPEND_H */