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 | |
Johannes Berg | 543b9fd | 2007-05-03 22:31:38 +1000 | [diff] [blame] | 4 | #if defined(CONFIG_X86) || defined(CONFIG_FRV) || defined(CONFIG_PPC32) || defined(CONFIG_PPC64) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 5 | #include <asm/suspend.h> |
| 6 | #endif |
| 7 | #include <linux/swap.h> |
| 8 | #include <linux/notifier.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 9 | #include <linux/init.h> |
| 10 | #include <linux/pm.h> |
Rafael J. Wysocki | 7be9823 | 2007-05-06 14:50:42 -0700 | [diff] [blame] | 11 | #include <linux/mm.h> |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 12 | #include <asm/errno.h> |
| 13 | |
| 14 | #if defined(CONFIG_PM_SLEEP) && defined(CONFIG_VT) && defined(CONFIG_VT_CONSOLE) |
| 15 | extern int pm_prepare_console(void); |
| 16 | extern void pm_restore_console(void); |
| 17 | #else |
| 18 | static inline int pm_prepare_console(void) { return 0; } |
| 19 | static inline void pm_restore_console(void) {} |
| 20 | #endif |
| 21 | |
| 22 | typedef int __bitwise suspend_state_t; |
| 23 | |
| 24 | #define PM_SUSPEND_ON ((__force suspend_state_t) 0) |
| 25 | #define PM_SUSPEND_STANDBY ((__force suspend_state_t) 1) |
| 26 | #define PM_SUSPEND_MEM ((__force suspend_state_t) 3) |
| 27 | #define PM_SUSPEND_MAX ((__force suspend_state_t) 4) |
| 28 | |
| 29 | /** |
Rafael J. Wysocki | 26398a7 | 2007-10-18 03:04:40 -0700 | [diff] [blame] | 30 | * struct platform_suspend_ops - Callbacks for managing platform dependent |
| 31 | * system sleep states. |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 32 | * |
| 33 | * @valid: Callback to determine if given system sleep state is supported by |
| 34 | * the platform. |
| 35 | * Valid (ie. supported) states are advertised in /sys/power/state. Note |
| 36 | * that it still may be impossible to enter given system sleep state if the |
| 37 | * conditions aren't right. |
Rafael J. Wysocki | 26398a7 | 2007-10-18 03:04:40 -0700 | [diff] [blame] | 38 | * There is the %suspend_valid_only_mem function available that can be |
| 39 | * assigned to this if the platform only supports mem sleep. |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 40 | * |
Rafael J. Wysocki | c697eec | 2008-01-08 00:04:17 +0100 | [diff] [blame] | 41 | * @begin: Initialise a transition to given system sleep state. |
| 42 | * @begin() is executed right prior to suspending devices. The information |
| 43 | * conveyed to the platform code by @begin() should be disregarded by it as |
| 44 | * soon as @end() is executed. If @begin() fails (ie. returns nonzero), |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 45 | * @prepare(), @enter() and @finish() will not be called by the PM core. |
| 46 | * This callback is optional. However, if it is implemented, the argument |
Rafael J. Wysocki | c697eec | 2008-01-08 00:04:17 +0100 | [diff] [blame] | 47 | * passed to @enter() is redundant and should be ignored. |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 48 | * |
| 49 | * @prepare: Prepare the platform for entering the system sleep state indicated |
Rafael J. Wysocki | c697eec | 2008-01-08 00:04:17 +0100 | [diff] [blame] | 50 | * by @begin(). |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 51 | * @prepare() is called right after devices have been suspended (ie. the |
| 52 | * appropriate .suspend() method has been executed for each device) and |
| 53 | * before the nonboot CPUs are disabled (it is executed with IRQs enabled). |
| 54 | * This callback is optional. It returns 0 on success or a negative |
| 55 | * error code otherwise, in which case the system cannot enter the desired |
| 56 | * sleep state (@enter() and @finish() will not be called in that case). |
| 57 | * |
Rafael J. Wysocki | c697eec | 2008-01-08 00:04:17 +0100 | [diff] [blame] | 58 | * @enter: Enter the system sleep state indicated by @begin() or represented by |
| 59 | * the argument if @begin() is not implemented. |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 60 | * This callback is mandatory. It returns 0 on success or a negative |
| 61 | * error code otherwise, in which case the system cannot enter the desired |
| 62 | * sleep state. |
| 63 | * |
| 64 | * @finish: Called when the system has just left a sleep state, right after |
| 65 | * the nonboot CPUs have been enabled and before devices are resumed (it is |
Rafael J. Wysocki | e6c5eb9 | 2007-10-18 03:04:41 -0700 | [diff] [blame] | 66 | * executed with IRQs enabled). |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 67 | * This callback is optional, but should be implemented by the platforms |
| 68 | * that implement @prepare(). If implemented, it is always called after |
| 69 | * @enter() (even if @enter() fails). |
Rafael J. Wysocki | c697eec | 2008-01-08 00:04:17 +0100 | [diff] [blame] | 70 | * |
| 71 | * @end: Called by the PM core right after resuming devices, to indicate to |
| 72 | * the platform that the system has returned to the working state or |
| 73 | * the transition to the sleep state has been aborted. |
| 74 | * This callback is optional, but should be implemented by the platforms |
| 75 | * that implement @begin(), but platforms implementing @begin() should |
| 76 | * also provide a @end() which cleans up transitions aborted before |
| 77 | * @enter(). |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 78 | */ |
Rafael J. Wysocki | 26398a7 | 2007-10-18 03:04:40 -0700 | [diff] [blame] | 79 | struct platform_suspend_ops { |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 80 | int (*valid)(suspend_state_t state); |
Rafael J. Wysocki | c697eec | 2008-01-08 00:04:17 +0100 | [diff] [blame] | 81 | int (*begin)(suspend_state_t state); |
Rafael J. Wysocki | e6c5eb9 | 2007-10-18 03:04:41 -0700 | [diff] [blame] | 82 | int (*prepare)(void); |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 83 | int (*enter)(suspend_state_t state); |
Rafael J. Wysocki | e6c5eb9 | 2007-10-18 03:04:41 -0700 | [diff] [blame] | 84 | void (*finish)(void); |
Rafael J. Wysocki | c697eec | 2008-01-08 00:04:17 +0100 | [diff] [blame] | 85 | void (*end)(void); |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 86 | }; |
| 87 | |
| 88 | #ifdef CONFIG_SUSPEND |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 89 | /** |
Rafael J. Wysocki | 26398a7 | 2007-10-18 03:04:40 -0700 | [diff] [blame] | 90 | * suspend_set_ops - set platform dependent suspend operations |
| 91 | * @ops: The new suspend operations to set. |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 92 | */ |
Rafael J. Wysocki | 26398a7 | 2007-10-18 03:04:40 -0700 | [diff] [blame] | 93 | extern void suspend_set_ops(struct platform_suspend_ops *ops); |
| 94 | extern int suspend_valid_only_mem(suspend_state_t state); |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 95 | |
| 96 | /** |
| 97 | * arch_suspend_disable_irqs - disable IRQs for suspend |
| 98 | * |
| 99 | * Disables IRQs (in the default case). This is a weak symbol in the common |
| 100 | * code and thus allows architectures to override it if more needs to be |
| 101 | * done. Not called for suspend to disk. |
| 102 | */ |
| 103 | extern void arch_suspend_disable_irqs(void); |
| 104 | |
| 105 | /** |
| 106 | * arch_suspend_enable_irqs - enable IRQs after suspend |
| 107 | * |
| 108 | * Enables IRQs (in the default case). This is a weak symbol in the common |
| 109 | * code and thus allows architectures to override it if more needs to be |
| 110 | * done. Not called for suspend to disk. |
| 111 | */ |
| 112 | extern void arch_suspend_enable_irqs(void); |
| 113 | |
| 114 | extern int pm_suspend(suspend_state_t state); |
| 115 | #else /* !CONFIG_SUSPEND */ |
| 116 | #define suspend_valid_only_mem NULL |
| 117 | |
Rafael J. Wysocki | 26398a7 | 2007-10-18 03:04:40 -0700 | [diff] [blame] | 118 | static inline void suspend_set_ops(struct platform_suspend_ops *ops) {} |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 119 | static inline int pm_suspend(suspend_state_t state) { return -ENOSYS; } |
| 120 | #endif /* !CONFIG_SUSPEND */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 121 | |
Rafael J. Wysocki | 8357376 | 2006-12-06 20:34:18 -0800 | [diff] [blame] | 122 | /* struct pbe is used for creating lists of pages that should be restored |
| 123 | * atomically during the resume from disk, because the page frames they have |
| 124 | * occupied before the suspend are in use. |
| 125 | */ |
Rafael J. Wysocki | dcbb5a5 | 2006-09-25 23:32:51 -0700 | [diff] [blame] | 126 | struct pbe { |
Rafael J. Wysocki | 8357376 | 2006-12-06 20:34:18 -0800 | [diff] [blame] | 127 | void *address; /* address of the copy */ |
| 128 | void *orig_address; /* original address of a page */ |
Rafael J. Wysocki | 7088a5c | 2006-01-06 00:13:05 -0800 | [diff] [blame] | 129 | struct pbe *next; |
Rafael J. Wysocki | dcbb5a5 | 2006-09-25 23:32:51 -0700 | [diff] [blame] | 130 | }; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 131 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 132 | /* mm/page_alloc.c */ |
| 133 | extern void drain_local_pages(void); |
| 134 | extern void mark_free_pages(struct zone *zone); |
| 135 | |
Rafael J. Wysocki | a3d25c2 | 2007-05-09 02:33:18 -0700 | [diff] [blame] | 136 | /** |
Rafael J. Wysocki | b3dac3b | 2007-10-18 03:04:43 -0700 | [diff] [blame] | 137 | * struct platform_hibernation_ops - hibernation platform support |
Rafael J. Wysocki | a3d25c2 | 2007-05-09 02:33:18 -0700 | [diff] [blame] | 138 | * |
Rafael J. Wysocki | caea99e | 2008-01-08 00:08:44 +0100 | [diff] [blame] | 139 | * The methods in this structure allow a platform to carry out special |
| 140 | * operations required by it during a hibernation transition. |
Rafael J. Wysocki | a3d25c2 | 2007-05-09 02:33:18 -0700 | [diff] [blame] | 141 | * |
Rafael J. Wysocki | caea99e | 2008-01-08 00:08:44 +0100 | [diff] [blame] | 142 | * All the methods below must be implemented. |
Rafael J. Wysocki | a3d25c2 | 2007-05-09 02:33:18 -0700 | [diff] [blame] | 143 | * |
Rafael J. Wysocki | caea99e | 2008-01-08 00:08:44 +0100 | [diff] [blame] | 144 | * @begin: Tell the platform driver that we're starting hibernation. |
Rafael J. Wysocki | 74f270a | 2007-10-18 03:04:42 -0700 | [diff] [blame] | 145 | * Called right after shrinking memory and before freezing devices. |
| 146 | * |
Rafael J. Wysocki | caea99e | 2008-01-08 00:08:44 +0100 | [diff] [blame] | 147 | * @end: Called by the PM core right after resuming devices, to indicate to |
| 148 | * the platform that the system has returned to the working state. |
| 149 | * |
Rafael J. Wysocki | 74f270a | 2007-10-18 03:04:42 -0700 | [diff] [blame] | 150 | * @pre_snapshot: Prepare the platform for creating the hibernation image. |
| 151 | * Called right after devices have been frozen and before the nonboot |
| 152 | * CPUs are disabled (runs with IRQs on). |
| 153 | * |
| 154 | * @finish: Restore the previous state of the platform after the hibernation |
| 155 | * image has been created *or* put the platform into the normal operation |
| 156 | * mode after the hibernation (the same method is executed in both cases). |
| 157 | * Called right after the nonboot CPUs have been enabled and before |
| 158 | * thawing devices (runs with IRQs on). |
| 159 | * |
| 160 | * @prepare: Prepare the platform for entering the low power state. |
| 161 | * Called right after the hibernation image has been saved and before |
| 162 | * devices are prepared for entering the low power state. |
| 163 | * |
| 164 | * @enter: Put the system into the low power state after the hibernation image |
| 165 | * has been saved to disk. |
| 166 | * Called after the nonboot CPUs have been disabled and all of the low |
| 167 | * level devices have been shut down (runs with IRQs off). |
| 168 | * |
Rafael J. Wysocki | c7e0831 | 2007-10-18 03:04:55 -0700 | [diff] [blame] | 169 | * @leave: Perform the first stage of the cleanup after the system sleep state |
| 170 | * indicated by @set_target() has been left. |
| 171 | * Called right after the control has been passed from the boot kernel to |
| 172 | * the image kernel, before the nonboot CPUs are enabled and before devices |
| 173 | * are resumed. Executed with interrupts disabled. |
| 174 | * |
Rafael J. Wysocki | 74f270a | 2007-10-18 03:04:42 -0700 | [diff] [blame] | 175 | * @pre_restore: Prepare system for the restoration from a hibernation image. |
| 176 | * Called right after devices have been frozen and before the nonboot |
| 177 | * CPUs are disabled (runs with IRQs on). |
| 178 | * |
| 179 | * @restore_cleanup: Clean up after a failing image restoration. |
| 180 | * Called right after the nonboot CPUs have been enabled and before |
| 181 | * thawing devices (runs with IRQs on). |
Rafael J. Wysocki | a3d25c2 | 2007-05-09 02:33:18 -0700 | [diff] [blame] | 182 | */ |
Rafael J. Wysocki | b3dac3b | 2007-10-18 03:04:43 -0700 | [diff] [blame] | 183 | struct platform_hibernation_ops { |
Rafael J. Wysocki | caea99e | 2008-01-08 00:08:44 +0100 | [diff] [blame] | 184 | int (*begin)(void); |
| 185 | void (*end)(void); |
Rafael J. Wysocki | 74f270a | 2007-10-18 03:04:42 -0700 | [diff] [blame] | 186 | int (*pre_snapshot)(void); |
| 187 | void (*finish)(void); |
Rafael J. Wysocki | a3d25c2 | 2007-05-09 02:33:18 -0700 | [diff] [blame] | 188 | int (*prepare)(void); |
| 189 | int (*enter)(void); |
Rafael J. Wysocki | c7e0831 | 2007-10-18 03:04:55 -0700 | [diff] [blame] | 190 | void (*leave)(void); |
Rafael J. Wysocki | a634cc1 | 2007-07-19 01:47:30 -0700 | [diff] [blame] | 191 | int (*pre_restore)(void); |
| 192 | void (*restore_cleanup)(void); |
Rafael J. Wysocki | a3d25c2 | 2007-05-09 02:33:18 -0700 | [diff] [blame] | 193 | }; |
| 194 | |
Rafael J. Wysocki | b0cb1a1 | 2007-07-29 23:24:36 +0200 | [diff] [blame] | 195 | #ifdef CONFIG_HIBERNATION |
Rafael J. Wysocki | 74dfd66 | 2007-05-06 14:50:43 -0700 | [diff] [blame] | 196 | /* kernel/power/snapshot.c */ |
Johannes Berg | 940d67f | 2007-05-08 19:23:49 +1000 | [diff] [blame] | 197 | extern void __register_nosave_region(unsigned long b, unsigned long e, int km); |
| 198 | static inline void register_nosave_region(unsigned long b, unsigned long e) |
| 199 | { |
| 200 | __register_nosave_region(b, e, 0); |
| 201 | } |
| 202 | static inline void register_nosave_region_late(unsigned long b, unsigned long e) |
| 203 | { |
| 204 | __register_nosave_region(b, e, 1); |
| 205 | } |
Rafael J. Wysocki | 74dfd66 | 2007-05-06 14:50:43 -0700 | [diff] [blame] | 206 | extern int swsusp_page_is_forbidden(struct page *); |
| 207 | extern void swsusp_set_page_free(struct page *); |
| 208 | extern void swsusp_unset_page_free(struct page *); |
| 209 | extern unsigned long get_safe_page(gfp_t gfp_mask); |
Rafael J. Wysocki | a3d25c2 | 2007-05-09 02:33:18 -0700 | [diff] [blame] | 210 | |
Rafael J. Wysocki | b3dac3b | 2007-10-18 03:04:43 -0700 | [diff] [blame] | 211 | extern void hibernation_set_ops(struct platform_hibernation_ops *ops); |
Rafael J. Wysocki | a3d25c2 | 2007-05-09 02:33:18 -0700 | [diff] [blame] | 212 | extern int hibernate(void); |
Rafael J. Wysocki | b0cb1a1 | 2007-07-29 23:24:36 +0200 | [diff] [blame] | 213 | #else /* CONFIG_HIBERNATION */ |
Rafael J. Wysocki | 74dfd66 | 2007-05-06 14:50:43 -0700 | [diff] [blame] | 214 | static inline int swsusp_page_is_forbidden(struct page *p) { return 0; } |
| 215 | static inline void swsusp_set_page_free(struct page *p) {} |
| 216 | static inline void swsusp_unset_page_free(struct page *p) {} |
Rafael J. Wysocki | a3d25c2 | 2007-05-09 02:33:18 -0700 | [diff] [blame] | 217 | |
Rafael J. Wysocki | b3dac3b | 2007-10-18 03:04:43 -0700 | [diff] [blame] | 218 | static inline void hibernation_set_ops(struct platform_hibernation_ops *ops) {} |
Rafael J. Wysocki | a3d25c2 | 2007-05-09 02:33:18 -0700 | [diff] [blame] | 219 | static inline int hibernate(void) { return -ENOSYS; } |
Rafael J. Wysocki | b0cb1a1 | 2007-07-29 23:24:36 +0200 | [diff] [blame] | 220 | #endif /* CONFIG_HIBERNATION */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 221 | |
Rafael J. Wysocki | 296699d | 2007-07-29 23:27:18 +0200 | [diff] [blame] | 222 | #ifdef CONFIG_PM_SLEEP |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 223 | void save_processor_state(void); |
| 224 | void restore_processor_state(void); |
Rafael J. Wysocki | 25761b6 | 2005-10-30 14:59:56 -0800 | [diff] [blame] | 225 | |
Rafael J. Wysocki | b10d911 | 2007-07-19 01:47:36 -0700 | [diff] [blame] | 226 | /* kernel/power/main.c */ |
Alan Stern | 8252575 | 2007-11-19 23:49:18 +0100 | [diff] [blame] | 227 | extern int register_pm_notifier(struct notifier_block *nb); |
| 228 | extern int unregister_pm_notifier(struct notifier_block *nb); |
Rafael J. Wysocki | b10d911 | 2007-07-19 01:47:36 -0700 | [diff] [blame] | 229 | |
| 230 | #define pm_notifier(fn, pri) { \ |
| 231 | static struct notifier_block fn##_nb = \ |
| 232 | { .notifier_call = fn, .priority = pri }; \ |
| 233 | register_pm_notifier(&fn##_nb); \ |
| 234 | } |
Rafael J. Wysocki | 296699d | 2007-07-29 23:27:18 +0200 | [diff] [blame] | 235 | #else /* !CONFIG_PM_SLEEP */ |
Rafael J. Wysocki | b10d911 | 2007-07-19 01:47:36 -0700 | [diff] [blame] | 236 | |
| 237 | static inline int register_pm_notifier(struct notifier_block *nb) |
| 238 | { |
| 239 | return 0; |
| 240 | } |
| 241 | |
| 242 | static inline int unregister_pm_notifier(struct notifier_block *nb) |
| 243 | { |
| 244 | return 0; |
| 245 | } |
| 246 | |
| 247 | #define pm_notifier(fn, pri) do { (void)(fn); } while (0) |
Rafael J. Wysocki | 296699d | 2007-07-29 23:27:18 +0200 | [diff] [blame] | 248 | #endif /* !CONFIG_PM_SLEEP */ |
Rafael J. Wysocki | b10d911 | 2007-07-19 01:47:36 -0700 | [diff] [blame] | 249 | |
Rafael J. Wysocki | 296699d | 2007-07-29 23:27:18 +0200 | [diff] [blame] | 250 | #ifndef CONFIG_HIBERNATION |
Rafael J. Wysocki | b10d911 | 2007-07-19 01:47:36 -0700 | [diff] [blame] | 251 | static inline void register_nosave_region(unsigned long b, unsigned long e) |
| 252 | { |
| 253 | } |
Ryusuke Konishi | 70f38db | 2007-07-26 10:40:59 -0700 | [diff] [blame] | 254 | static inline void register_nosave_region_late(unsigned long b, unsigned long e) |
| 255 | { |
| 256 | } |
Rafael J. Wysocki | b10d911 | 2007-07-19 01:47:36 -0700 | [diff] [blame] | 257 | #endif |
| 258 | |
Rafael J. Wysocki | 95d9ffb | 2007-10-18 03:04:39 -0700 | [diff] [blame] | 259 | #endif /* _LINUX_SUSPEND_H */ |