Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 1 | #ifndef _LINUX_SUSPEND_H |
| 2 | #define _LINUX_SUSPEND_H |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 3 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 4 | #include <linux/swap.h> |
| 5 | #include <linux/notifier.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 6 | #include <linux/init.h> |
| 7 | #include <linux/pm.h> |
Rafael J. Wysocki | 7be9823 | 2007-05-06 14:50:42 -0700 | [diff] [blame] | 8 | #include <linux/mm.h> |
Srivatsa S. Bhat | 33e638b | 2011-12-06 23:18:12 +0100 | [diff] [blame] | 9 | #include <linux/freezer.h> |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 10 | #include <asm/errno.h> |
| 11 | |
H Hartley Sweeten | 37cce26 | 2011-09-21 22:47:55 +0200 | [diff] [blame] | 12 | #ifdef CONFIG_VT |
Andres Salomon | b6f448e | 2008-04-28 02:15:03 -0700 | [diff] [blame] | 13 | extern void pm_set_vt_switch(int); |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 14 | #else |
Andres Salomon | b6f448e | 2008-04-28 02:15:03 -0700 | [diff] [blame] | 15 | static inline void pm_set_vt_switch(int do_switch) |
| 16 | { |
| 17 | } |
H Hartley Sweeten | 37cce26 | 2011-09-21 22:47:55 +0200 | [diff] [blame] | 18 | #endif |
Andres Salomon | b6f448e | 2008-04-28 02:15:03 -0700 | [diff] [blame] | 19 | |
H Hartley Sweeten | 37cce26 | 2011-09-21 22:47:55 +0200 | [diff] [blame] | 20 | #ifdef CONFIG_VT_CONSOLE_SLEEP |
| 21 | extern int pm_prepare_console(void); |
| 22 | extern void pm_restore_console(void); |
| 23 | #else |
Andres Salomon | b6f448e | 2008-04-28 02:15:03 -0700 | [diff] [blame] | 24 | static inline int pm_prepare_console(void) |
| 25 | { |
| 26 | return 0; |
| 27 | } |
| 28 | |
| 29 | static inline void pm_restore_console(void) |
| 30 | { |
| 31 | } |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 32 | #endif |
| 33 | |
| 34 | typedef int __bitwise suspend_state_t; |
| 35 | |
| 36 | #define PM_SUSPEND_ON ((__force suspend_state_t) 0) |
Zhang Rui | 7e73c5a | 2013-02-06 13:00:36 +0100 | [diff] [blame] | 37 | #define PM_SUSPEND_FREEZE ((__force suspend_state_t) 1) |
| 38 | #define PM_SUSPEND_STANDBY ((__force suspend_state_t) 2) |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 39 | #define PM_SUSPEND_MEM ((__force suspend_state_t) 3) |
Zhang Rui | 7e73c5a | 2013-02-06 13:00:36 +0100 | [diff] [blame] | 40 | #define PM_SUSPEND_MIN PM_SUSPEND_FREEZE |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 41 | #define PM_SUSPEND_MAX ((__force suspend_state_t) 4) |
| 42 | |
ShuoX Liu | 2a77c46 | 2011-08-10 23:01:26 +0200 | [diff] [blame] | 43 | enum suspend_stat_step { |
| 44 | SUSPEND_FREEZE = 1, |
| 45 | SUSPEND_PREPARE, |
| 46 | SUSPEND_SUSPEND, |
Rafael J. Wysocki | cf579df | 2012-01-29 20:38:29 +0100 | [diff] [blame] | 47 | SUSPEND_SUSPEND_LATE, |
ShuoX Liu | 2a77c46 | 2011-08-10 23:01:26 +0200 | [diff] [blame] | 48 | SUSPEND_SUSPEND_NOIRQ, |
| 49 | SUSPEND_RESUME_NOIRQ, |
Rafael J. Wysocki | cf579df | 2012-01-29 20:38:29 +0100 | [diff] [blame] | 50 | SUSPEND_RESUME_EARLY, |
ShuoX Liu | 2a77c46 | 2011-08-10 23:01:26 +0200 | [diff] [blame] | 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; |
Rafael J. Wysocki | cf579df | 2012-01-29 20:38:29 +0100 | [diff] [blame] | 60 | int failed_suspend_late; |
ShuoX Liu | 2a77c46 | 2011-08-10 23:01:26 +0200 | [diff] [blame] | 61 | int failed_suspend_noirq; |
| 62 | int failed_resume; |
Rafael J. Wysocki | cf579df | 2012-01-29 20:38:29 +0100 | [diff] [blame] | 63 | int failed_resume_early; |
ShuoX Liu | 2a77c46 | 2011-08-10 23:01:26 +0200 | [diff] [blame] | 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 | |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 99 | /** |
Rafael J. Wysocki | 26398a7 | 2007-10-18 03:04:40 -0700 | [diff] [blame] | 100 | * struct platform_suspend_ops - Callbacks for managing platform dependent |
| 101 | * system sleep states. |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 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. |
Rafael J. Wysocki | 26398a7 | 2007-10-18 03:04:40 -0700 | [diff] [blame] | 108 | * There is the %suspend_valid_only_mem function available that can be |
| 109 | * assigned to this if the platform only supports mem sleep. |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 110 | * |
Rafael J. Wysocki | c697eec | 2008-01-08 00:04:17 +0100 | [diff] [blame] | 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), |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 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 |
Rafael J. Wysocki | c697eec | 2008-01-08 00:04:17 +0100 | [diff] [blame] | 117 | * passed to @enter() is redundant and should be ignored. |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 118 | * |
| 119 | * @prepare: Prepare the platform for entering the system sleep state indicated |
Rafael J. Wysocki | c697eec | 2008-01-08 00:04:17 +0100 | [diff] [blame] | 120 | * by @begin(). |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 121 | * @prepare() is called right after devices have been suspended (ie. the |
| 122 | * appropriate .suspend() method has been executed for each device) and |
Rafael J. Wysocki | 6a7c7ea | 2009-04-19 20:08:42 +0200 | [diff] [blame] | 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(), |
Rafael J. Wysocki | ce44101 | 2010-07-07 23:43:45 +0200 | [diff] [blame] | 126 | * and @wake() will not be called in that case). |
Rafael J. Wysocki | 6a7c7ea | 2009-04-19 20:08:42 +0200 | [diff] [blame] | 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 |
Rafael J. Wysocki | ce44101 | 2010-07-07 23:43:45 +0200 | [diff] [blame] | 133 | * system cannot enter the desired sleep state (@enter() will not be |
| 134 | * executed). |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 135 | * |
Rafael J. Wysocki | c697eec | 2008-01-08 00:04:17 +0100 | [diff] [blame] | 136 | * @enter: Enter the system sleep state indicated by @begin() or represented by |
| 137 | * the argument if @begin() is not implemented. |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 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 | * |
Rafael J. Wysocki | 6a7c7ea | 2009-04-19 20:08:42 +0200 | [diff] [blame] | 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 |
Rafael J. Wysocki | ce44101 | 2010-07-07 23:43:45 +0200 | [diff] [blame] | 147 | * after @prepare_late and @enter(), even if one of them fails. |
Rafael J. Wysocki | 6a7c7ea | 2009-04-19 20:08:42 +0200 | [diff] [blame] | 148 | * |
| 149 | * @finish: Finish wake-up of the platform. |
| 150 | * @finish is called right prior to calling device drivers' regular suspend |
| 151 | * callbacks. |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 152 | * This callback is optional, but should be implemented by the platforms |
| 153 | * that implement @prepare(). If implemented, it is always called after |
Rafael J. Wysocki | ce44101 | 2010-07-07 23:43:45 +0200 | [diff] [blame] | 154 | * @enter() and @wake(), even if any of them fails. It is executed after |
| 155 | * a failing @prepare. |
Rafael J. Wysocki | c697eec | 2008-01-08 00:04:17 +0100 | [diff] [blame] | 156 | * |
MyungJoo Ham | 3b5fe85 | 2011-06-12 15:57:05 +0200 | [diff] [blame] | 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 | * |
Rafael J. Wysocki | c697eec | 2008-01-08 00:04:17 +0100 | [diff] [blame] | 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 |
Rafael J. Wysocki | 6a7c7ea | 2009-04-19 20:08:42 +0200 | [diff] [blame] | 168 | * that implement @begin(). Accordingly, platforms implementing @begin() |
| 169 | * should also provide a @end() which cleans up transitions aborted before |
Rafael J. Wysocki | c697eec | 2008-01-08 00:04:17 +0100 | [diff] [blame] | 170 | * @enter(). |
Rafael J. Wysocki | d8f3de0 | 2008-06-12 23:24:06 +0200 | [diff] [blame] | 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. |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 176 | */ |
Rafael J. Wysocki | 26398a7 | 2007-10-18 03:04:40 -0700 | [diff] [blame] | 177 | struct platform_suspend_ops { |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 178 | int (*valid)(suspend_state_t state); |
Rafael J. Wysocki | c697eec | 2008-01-08 00:04:17 +0100 | [diff] [blame] | 179 | int (*begin)(suspend_state_t state); |
Rafael J. Wysocki | e6c5eb9 | 2007-10-18 03:04:41 -0700 | [diff] [blame] | 180 | int (*prepare)(void); |
Rafael J. Wysocki | 6a7c7ea | 2009-04-19 20:08:42 +0200 | [diff] [blame] | 181 | int (*prepare_late)(void); |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 182 | int (*enter)(suspend_state_t state); |
Rafael J. Wysocki | 6a7c7ea | 2009-04-19 20:08:42 +0200 | [diff] [blame] | 183 | void (*wake)(void); |
Rafael J. Wysocki | e6c5eb9 | 2007-10-18 03:04:41 -0700 | [diff] [blame] | 184 | void (*finish)(void); |
MyungJoo Ham | 3b5fe85 | 2011-06-12 15:57:05 +0200 | [diff] [blame] | 185 | bool (*suspend_again)(void); |
Rafael J. Wysocki | c697eec | 2008-01-08 00:04:17 +0100 | [diff] [blame] | 186 | void (*end)(void); |
Rafael J. Wysocki | d8f3de0 | 2008-06-12 23:24:06 +0200 | [diff] [blame] | 187 | void (*recover)(void); |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 188 | }; |
| 189 | |
Rafael J. Wysocki | 1f0b638 | 2014-05-15 23:29:57 +0200 | [diff] [blame] | 190 | struct platform_freeze_ops { |
| 191 | int (*begin)(void); |
| 192 | void (*end)(void); |
| 193 | }; |
| 194 | |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 195 | #ifdef CONFIG_SUSPEND |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 196 | /** |
Rafael J. Wysocki | 26398a7 | 2007-10-18 03:04:40 -0700 | [diff] [blame] | 197 | * suspend_set_ops - set platform dependent suspend operations |
| 198 | * @ops: The new suspend operations to set. |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 199 | */ |
Lionel Debroux | 2f55ac0 | 2010-11-16 14:14:02 +0100 | [diff] [blame] | 200 | extern void suspend_set_ops(const struct platform_suspend_ops *ops); |
Rafael J. Wysocki | 26398a7 | 2007-10-18 03:04:40 -0700 | [diff] [blame] | 201 | extern int suspend_valid_only_mem(suspend_state_t state); |
Rafael J. Wysocki | 1f0b638 | 2014-05-15 23:29:57 +0200 | [diff] [blame] | 202 | extern void freeze_set_ops(const struct platform_freeze_ops *ops); |
Zhang Rui | 7e73c5a | 2013-02-06 13:00:36 +0100 | [diff] [blame] | 203 | extern void freeze_wake(void); |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 204 | |
| 205 | /** |
| 206 | * arch_suspend_disable_irqs - disable IRQs for suspend |
| 207 | * |
| 208 | * Disables 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_disable_irqs(void); |
| 213 | |
| 214 | /** |
| 215 | * arch_suspend_enable_irqs - enable IRQs after suspend |
| 216 | * |
| 217 | * Enables IRQs (in the default case). This is a weak symbol in the common |
| 218 | * code and thus allows architectures to override it if more needs to be |
| 219 | * done. Not called for suspend to disk. |
| 220 | */ |
| 221 | extern void arch_suspend_enable_irqs(void); |
| 222 | |
| 223 | extern int pm_suspend(suspend_state_t state); |
| 224 | #else /* !CONFIG_SUSPEND */ |
| 225 | #define suspend_valid_only_mem NULL |
| 226 | |
Lionel Debroux | 2f55ac0 | 2010-11-16 14:14:02 +0100 | [diff] [blame] | 227 | static inline void suspend_set_ops(const struct platform_suspend_ops *ops) {} |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 228 | static inline int pm_suspend(suspend_state_t state) { return -ENOSYS; } |
Rafael J. Wysocki | 1f0b638 | 2014-05-15 23:29:57 +0200 | [diff] [blame] | 229 | static inline void freeze_set_ops(const struct platform_freeze_ops *ops) {} |
Zhang Rui | 7e73c5a | 2013-02-06 13:00:36 +0100 | [diff] [blame] | 230 | static inline void freeze_wake(void) {} |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 231 | #endif /* !CONFIG_SUSPEND */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 232 | |
Rafael J. Wysocki | 8357376 | 2006-12-06 20:34:18 -0800 | [diff] [blame] | 233 | /* struct pbe is used for creating lists of pages that should be restored |
| 234 | * atomically during the resume from disk, because the page frames they have |
| 235 | * occupied before the suspend are in use. |
| 236 | */ |
Rafael J. Wysocki | dcbb5a5 | 2006-09-25 23:32:51 -0700 | [diff] [blame] | 237 | struct pbe { |
Rafael J. Wysocki | 8357376 | 2006-12-06 20:34:18 -0800 | [diff] [blame] | 238 | void *address; /* address of the copy */ |
| 239 | void *orig_address; /* original address of a page */ |
Rafael J. Wysocki | 7088a5c | 2006-01-06 00:13:05 -0800 | [diff] [blame] | 240 | struct pbe *next; |
Rafael J. Wysocki | dcbb5a5 | 2006-09-25 23:32:51 -0700 | [diff] [blame] | 241 | }; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 242 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 243 | /* mm/page_alloc.c */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 244 | extern void mark_free_pages(struct zone *zone); |
| 245 | |
Rafael J. Wysocki | a3d25c2 | 2007-05-09 02:33:18 -0700 | [diff] [blame] | 246 | /** |
Rafael J. Wysocki | b3dac3b | 2007-10-18 03:04:43 -0700 | [diff] [blame] | 247 | * struct platform_hibernation_ops - hibernation platform support |
Rafael J. Wysocki | a3d25c2 | 2007-05-09 02:33:18 -0700 | [diff] [blame] | 248 | * |
Rafael J. Wysocki | caea99e | 2008-01-08 00:08:44 +0100 | [diff] [blame] | 249 | * The methods in this structure allow a platform to carry out special |
| 250 | * operations required by it during a hibernation transition. |
Rafael J. Wysocki | a3d25c2 | 2007-05-09 02:33:18 -0700 | [diff] [blame] | 251 | * |
Rafael J. Wysocki | d8f3de0 | 2008-06-12 23:24:06 +0200 | [diff] [blame] | 252 | * All the methods below, except for @recover(), must be implemented. |
Rafael J. Wysocki | a3d25c2 | 2007-05-09 02:33:18 -0700 | [diff] [blame] | 253 | * |
Rafael J. Wysocki | caea99e | 2008-01-08 00:08:44 +0100 | [diff] [blame] | 254 | * @begin: Tell the platform driver that we're starting hibernation. |
Rafael J. Wysocki | 74f270a | 2007-10-18 03:04:42 -0700 | [diff] [blame] | 255 | * Called right after shrinking memory and before freezing devices. |
| 256 | * |
Rafael J. Wysocki | caea99e | 2008-01-08 00:08:44 +0100 | [diff] [blame] | 257 | * @end: Called by the PM core right after resuming devices, to indicate to |
| 258 | * the platform that the system has returned to the working state. |
| 259 | * |
Rafael J. Wysocki | 74f270a | 2007-10-18 03:04:42 -0700 | [diff] [blame] | 260 | * @pre_snapshot: Prepare the platform for creating the hibernation image. |
| 261 | * Called right after devices have been frozen and before the nonboot |
| 262 | * CPUs are disabled (runs with IRQs on). |
| 263 | * |
| 264 | * @finish: Restore the previous state of the platform after the hibernation |
| 265 | * image has been created *or* put the platform into the normal operation |
| 266 | * mode after the hibernation (the same method is executed in both cases). |
| 267 | * Called right after the nonboot CPUs have been enabled and before |
| 268 | * thawing devices (runs with IRQs on). |
| 269 | * |
| 270 | * @prepare: Prepare the platform for entering the low power state. |
| 271 | * Called right after the hibernation image has been saved and before |
| 272 | * devices are prepared for entering the low power state. |
| 273 | * |
| 274 | * @enter: Put the system into the low power state after the hibernation image |
| 275 | * has been saved to disk. |
| 276 | * Called after the nonboot CPUs have been disabled and all of the low |
| 277 | * level devices have been shut down (runs with IRQs off). |
| 278 | * |
Rafael J. Wysocki | c7e0831 | 2007-10-18 03:04:55 -0700 | [diff] [blame] | 279 | * @leave: Perform the first stage of the cleanup after the system sleep state |
| 280 | * indicated by @set_target() has been left. |
| 281 | * Called right after the control has been passed from the boot kernel to |
| 282 | * the image kernel, before the nonboot CPUs are enabled and before devices |
| 283 | * are resumed. Executed with interrupts disabled. |
| 284 | * |
Rafael J. Wysocki | 74f270a | 2007-10-18 03:04:42 -0700 | [diff] [blame] | 285 | * @pre_restore: Prepare system for the restoration from a hibernation image. |
| 286 | * Called right after devices have been frozen and before the nonboot |
| 287 | * CPUs are disabled (runs with IRQs on). |
| 288 | * |
| 289 | * @restore_cleanup: Clean up after a failing image restoration. |
| 290 | * Called right after the nonboot CPUs have been enabled and before |
| 291 | * thawing devices (runs with IRQs on). |
Rafael J. Wysocki | d8f3de0 | 2008-06-12 23:24:06 +0200 | [diff] [blame] | 292 | * |
| 293 | * @recover: Recover the platform from a failure to suspend devices. |
| 294 | * Called by the PM core if the suspending of devices during hibernation |
| 295 | * fails. This callback is optional and should only be implemented by |
| 296 | * platforms which require special recovery actions in that situation. |
Rafael J. Wysocki | a3d25c2 | 2007-05-09 02:33:18 -0700 | [diff] [blame] | 297 | */ |
Rafael J. Wysocki | b3dac3b | 2007-10-18 03:04:43 -0700 | [diff] [blame] | 298 | struct platform_hibernation_ops { |
Rafael J. Wysocki | caea99e | 2008-01-08 00:08:44 +0100 | [diff] [blame] | 299 | int (*begin)(void); |
| 300 | void (*end)(void); |
Rafael J. Wysocki | 74f270a | 2007-10-18 03:04:42 -0700 | [diff] [blame] | 301 | int (*pre_snapshot)(void); |
| 302 | void (*finish)(void); |
Rafael J. Wysocki | a3d25c2 | 2007-05-09 02:33:18 -0700 | [diff] [blame] | 303 | int (*prepare)(void); |
| 304 | int (*enter)(void); |
Rafael J. Wysocki | c7e0831 | 2007-10-18 03:04:55 -0700 | [diff] [blame] | 305 | void (*leave)(void); |
Rafael J. Wysocki | a634cc1 | 2007-07-19 01:47:30 -0700 | [diff] [blame] | 306 | int (*pre_restore)(void); |
| 307 | void (*restore_cleanup)(void); |
Rafael J. Wysocki | d8f3de0 | 2008-06-12 23:24:06 +0200 | [diff] [blame] | 308 | void (*recover)(void); |
Rafael J. Wysocki | a3d25c2 | 2007-05-09 02:33:18 -0700 | [diff] [blame] | 309 | }; |
| 310 | |
Rafael J. Wysocki | b0cb1a1 | 2007-07-29 23:24:36 +0200 | [diff] [blame] | 311 | #ifdef CONFIG_HIBERNATION |
Rafael J. Wysocki | 74dfd66 | 2007-05-06 14:50:43 -0700 | [diff] [blame] | 312 | /* kernel/power/snapshot.c */ |
Johannes Berg | 940d67f | 2007-05-08 19:23:49 +1000 | [diff] [blame] | 313 | extern void __register_nosave_region(unsigned long b, unsigned long e, int km); |
Marcin Slusarz | ce289e8 | 2008-08-15 00:40:19 -0700 | [diff] [blame] | 314 | static inline void __init register_nosave_region(unsigned long b, unsigned long e) |
Johannes Berg | 940d67f | 2007-05-08 19:23:49 +1000 | [diff] [blame] | 315 | { |
| 316 | __register_nosave_region(b, e, 0); |
| 317 | } |
Marcin Slusarz | ce289e8 | 2008-08-15 00:40:19 -0700 | [diff] [blame] | 318 | static inline void __init register_nosave_region_late(unsigned long b, unsigned long e) |
Johannes Berg | 940d67f | 2007-05-08 19:23:49 +1000 | [diff] [blame] | 319 | { |
| 320 | __register_nosave_region(b, e, 1); |
| 321 | } |
Rafael J. Wysocki | 74dfd66 | 2007-05-06 14:50:43 -0700 | [diff] [blame] | 322 | extern int swsusp_page_is_forbidden(struct page *); |
| 323 | extern void swsusp_set_page_free(struct page *); |
| 324 | extern void swsusp_unset_page_free(struct page *); |
| 325 | extern unsigned long get_safe_page(gfp_t gfp_mask); |
Rafael J. Wysocki | a3d25c2 | 2007-05-09 02:33:18 -0700 | [diff] [blame] | 326 | |
Lionel Debroux | 073ef1f | 2010-11-09 21:48:49 +0100 | [diff] [blame] | 327 | extern void hibernation_set_ops(const struct platform_hibernation_ops *ops); |
Rafael J. Wysocki | a3d25c2 | 2007-05-09 02:33:18 -0700 | [diff] [blame] | 328 | extern int hibernate(void); |
Rafael J. Wysocki | abfe2d7 | 2009-01-19 20:54:54 +0100 | [diff] [blame] | 329 | extern bool system_entering_hibernation(void); |
Kees Cook | a6e15a3 | 2014-06-13 13:30:35 -0700 | [diff] [blame] | 330 | extern bool hibernation_available(void); |
Sebastian Capella | 603fb42 | 2014-03-25 01:20:29 +0100 | [diff] [blame] | 331 | asmlinkage int swsusp_save(void); |
| 332 | extern struct pbe *restore_pblist; |
Rafael J. Wysocki | b0cb1a1 | 2007-07-29 23:24:36 +0200 | [diff] [blame] | 333 | #else /* CONFIG_HIBERNATION */ |
Rafael J. Wysocki | 1f112ce | 2011-04-11 22:54:42 +0200 | [diff] [blame] | 334 | static inline void register_nosave_region(unsigned long b, unsigned long e) {} |
| 335 | static inline void register_nosave_region_late(unsigned long b, unsigned long e) {} |
Rafael J. Wysocki | 74dfd66 | 2007-05-06 14:50:43 -0700 | [diff] [blame] | 336 | static inline int swsusp_page_is_forbidden(struct page *p) { return 0; } |
| 337 | static inline void swsusp_set_page_free(struct page *p) {} |
| 338 | static inline void swsusp_unset_page_free(struct page *p) {} |
Rafael J. Wysocki | a3d25c2 | 2007-05-09 02:33:18 -0700 | [diff] [blame] | 339 | |
Lionel Debroux | 073ef1f | 2010-11-09 21:48:49 +0100 | [diff] [blame] | 340 | static inline void hibernation_set_ops(const struct platform_hibernation_ops *ops) {} |
Rafael J. Wysocki | a3d25c2 | 2007-05-09 02:33:18 -0700 | [diff] [blame] | 341 | static inline int hibernate(void) { return -ENOSYS; } |
Cornelia Huck | fce2b111 | 2009-06-10 01:28:19 +0200 | [diff] [blame] | 342 | static inline bool system_entering_hibernation(void) { return false; } |
Kees Cook | a6e15a3 | 2014-06-13 13:30:35 -0700 | [diff] [blame] | 343 | static inline bool hibernation_available(void) { return false; } |
Cornelia Huck | fce2b111 | 2009-06-10 01:28:19 +0200 | [diff] [blame] | 344 | #endif /* CONFIG_HIBERNATION */ |
| 345 | |
Amerigo Wang | 35eb6db | 2011-07-25 17:13:11 -0700 | [diff] [blame] | 346 | /* Hibernation and suspend events */ |
| 347 | #define PM_HIBERNATION_PREPARE 0x0001 /* Going to hibernate */ |
| 348 | #define PM_POST_HIBERNATION 0x0002 /* Hibernation finished */ |
| 349 | #define PM_SUSPEND_PREPARE 0x0003 /* Going to suspend the system */ |
| 350 | #define PM_POST_SUSPEND 0x0004 /* Suspend finished */ |
| 351 | #define PM_RESTORE_PREPARE 0x0005 /* Going to restore a saved image */ |
| 352 | #define PM_POST_RESTORE 0x0006 /* Restore failed */ |
| 353 | |
Srivatsa S. Bhat | 9b6fc5d | 2011-12-06 23:24:38 +0100 | [diff] [blame] | 354 | extern struct mutex pm_mutex; |
| 355 | |
Rafael J. Wysocki | 296699d | 2007-07-29 23:27:18 +0200 | [diff] [blame] | 356 | #ifdef CONFIG_PM_SLEEP |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 357 | void save_processor_state(void); |
| 358 | void restore_processor_state(void); |
Rafael J. Wysocki | 25761b6 | 2005-10-30 14:59:56 -0800 | [diff] [blame] | 359 | |
Rafael J. Wysocki | b10d911 | 2007-07-19 01:47:36 -0700 | [diff] [blame] | 360 | /* kernel/power/main.c */ |
Alan Stern | 8252575 | 2007-11-19 23:49:18 +0100 | [diff] [blame] | 361 | extern int register_pm_notifier(struct notifier_block *nb); |
| 362 | extern int unregister_pm_notifier(struct notifier_block *nb); |
Rafael J. Wysocki | b10d911 | 2007-07-19 01:47:36 -0700 | [diff] [blame] | 363 | |
| 364 | #define pm_notifier(fn, pri) { \ |
| 365 | static struct notifier_block fn##_nb = \ |
| 366 | { .notifier_call = fn, .priority = pri }; \ |
| 367 | register_pm_notifier(&fn##_nb); \ |
| 368 | } |
Rafael J. Wysocki | c125e96 | 2010-07-05 22:43:53 +0200 | [diff] [blame] | 369 | |
| 370 | /* drivers/base/power/wakeup.c */ |
| 371 | extern bool events_check_enabled; |
| 372 | |
Rafael J. Wysocki | a2867e0 | 2010-12-03 22:58:31 +0100 | [diff] [blame] | 373 | extern bool pm_wakeup_pending(void); |
Rafael J. Wysocki | 7483b4a | 2012-04-29 22:53:22 +0200 | [diff] [blame] | 374 | extern bool pm_get_wakeup_count(unsigned int *count, bool block); |
Rafael J. Wysocki | 074037e | 2010-09-22 22:09:10 +0200 | [diff] [blame] | 375 | extern bool pm_save_wakeup_count(unsigned int count); |
Rafael J. Wysocki | 5585094 | 2012-04-29 22:53:32 +0200 | [diff] [blame] | 376 | extern void pm_wakep_autosleep_enabled(bool set); |
Julius Werner | bb177fe | 2013-06-12 12:55:22 -0700 | [diff] [blame] | 377 | extern void pm_print_active_wakeup_sources(void); |
Srivatsa S. Bhat | 9b6fc5d | 2011-12-06 23:24:38 +0100 | [diff] [blame] | 378 | |
| 379 | static inline void lock_system_sleep(void) |
| 380 | { |
Srivatsa S. Bhat | 7208162 | 2012-01-19 23:25:33 +0100 | [diff] [blame] | 381 | current->flags |= PF_FREEZER_SKIP; |
Srivatsa S. Bhat | 9b6fc5d | 2011-12-06 23:24:38 +0100 | [diff] [blame] | 382 | mutex_lock(&pm_mutex); |
| 383 | } |
| 384 | |
| 385 | static inline void unlock_system_sleep(void) |
| 386 | { |
Srivatsa S. Bhat | 7208162 | 2012-01-19 23:25:33 +0100 | [diff] [blame] | 387 | /* |
| 388 | * Don't use freezer_count() because we don't want the call to |
| 389 | * try_to_freeze() here. |
| 390 | * |
| 391 | * Reason: |
| 392 | * Fundamentally, we just don't need it, because freezing condition |
| 393 | * doesn't come into effect until we release the pm_mutex lock, |
| 394 | * since the freezer always works with pm_mutex held. |
| 395 | * |
| 396 | * More importantly, in the case of hibernation, |
| 397 | * unlock_system_sleep() gets called in snapshot_read() and |
| 398 | * snapshot_write() when the freezing condition is still in effect. |
| 399 | * Which means, if we use try_to_freeze() here, it would make them |
| 400 | * enter the refrigerator, thus causing hibernation to lockup. |
| 401 | */ |
| 402 | current->flags &= ~PF_FREEZER_SKIP; |
Srivatsa S. Bhat | 9b6fc5d | 2011-12-06 23:24:38 +0100 | [diff] [blame] | 403 | mutex_unlock(&pm_mutex); |
Srivatsa S. Bhat | 9b6fc5d | 2011-12-06 23:24:38 +0100 | [diff] [blame] | 404 | } |
| 405 | |
Rafael J. Wysocki | 296699d | 2007-07-29 23:27:18 +0200 | [diff] [blame] | 406 | #else /* !CONFIG_PM_SLEEP */ |
Rafael J. Wysocki | b10d911 | 2007-07-19 01:47:36 -0700 | [diff] [blame] | 407 | |
| 408 | static inline int register_pm_notifier(struct notifier_block *nb) |
| 409 | { |
| 410 | return 0; |
| 411 | } |
| 412 | |
| 413 | static inline int unregister_pm_notifier(struct notifier_block *nb) |
| 414 | { |
| 415 | return 0; |
| 416 | } |
| 417 | |
| 418 | #define pm_notifier(fn, pri) do { (void)(fn); } while (0) |
Rafael J. Wysocki | dbeeec5 | 2010-10-04 22:07:32 +0200 | [diff] [blame] | 419 | |
Rafael J. Wysocki | a2867e0 | 2010-12-03 22:58:31 +0100 | [diff] [blame] | 420 | static inline bool pm_wakeup_pending(void) { return false; } |
Rafael J. Wysocki | b10d911 | 2007-07-19 01:47:36 -0700 | [diff] [blame] | 421 | |
Andi Kleen | 6ad696d | 2009-11-17 14:06:22 -0800 | [diff] [blame] | 422 | static inline void lock_system_sleep(void) {} |
| 423 | static inline void unlock_system_sleep(void) {} |
| 424 | |
Srivatsa S. Bhat | 9b6fc5d | 2011-12-06 23:24:38 +0100 | [diff] [blame] | 425 | #endif /* !CONFIG_PM_SLEEP */ |
Huang Ying | 89081d1 | 2008-07-25 19:45:10 -0700 | [diff] [blame] | 426 | |
Rafael J. Wysocki | b2df1d4 | 2012-06-21 00:19:33 +0200 | [diff] [blame] | 427 | #ifdef CONFIG_PM_SLEEP_DEBUG |
| 428 | extern bool pm_print_times_enabled; |
| 429 | #else |
| 430 | #define pm_print_times_enabled (false) |
| 431 | #endif |
| 432 | |
Rafael J. Wysocki | 7483b4a | 2012-04-29 22:53:22 +0200 | [diff] [blame] | 433 | #ifdef CONFIG_PM_AUTOSLEEP |
| 434 | |
| 435 | /* kernel/power/autosleep.c */ |
| 436 | void queue_up_suspend_work(void); |
| 437 | |
| 438 | #else /* !CONFIG_PM_AUTOSLEEP */ |
| 439 | |
| 440 | static inline void queue_up_suspend_work(void) {} |
| 441 | |
| 442 | #endif /* !CONFIG_PM_AUTOSLEEP */ |
| 443 | |
Martin Schwidefsky | 85055dd | 2011-08-17 20:42:24 +0200 | [diff] [blame] | 444 | #ifdef CONFIG_ARCH_SAVE_PAGE_KEYS |
| 445 | /* |
| 446 | * The ARCH_SAVE_PAGE_KEYS functions can be used by an architecture |
| 447 | * to save/restore additional information to/from the array of page |
| 448 | * frame numbers in the hibernation image. For s390 this is used to |
| 449 | * save and restore the storage key for each page that is included |
| 450 | * in the hibernation image. |
| 451 | */ |
| 452 | unsigned long page_key_additional_pages(unsigned long pages); |
| 453 | int page_key_alloc(unsigned long pages); |
| 454 | void page_key_free(void); |
| 455 | void page_key_read(unsigned long *pfn); |
| 456 | void page_key_memorize(unsigned long *pfn); |
| 457 | void page_key_write(void *address); |
| 458 | |
| 459 | #else /* !CONFIG_ARCH_SAVE_PAGE_KEYS */ |
| 460 | |
| 461 | static inline unsigned long page_key_additional_pages(unsigned long pages) |
| 462 | { |
| 463 | return 0; |
| 464 | } |
| 465 | |
| 466 | static inline int page_key_alloc(unsigned long pages) |
| 467 | { |
| 468 | return 0; |
| 469 | } |
| 470 | |
| 471 | static inline void page_key_free(void) {} |
| 472 | static inline void page_key_read(unsigned long *pfn) {} |
| 473 | static inline void page_key_memorize(unsigned long *pfn) {} |
| 474 | static inline void page_key_write(void *address) {} |
| 475 | |
| 476 | #endif /* !CONFIG_ARCH_SAVE_PAGE_KEYS */ |
| 477 | |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 478 | #endif /* _LINUX_SUSPEND_H */ |