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 <asm/errno.h> 10 11#if defined(CONFIG_PM_SLEEP) && defined(CONFIG_VT) && defined(CONFIG_VT_CONSOLE) 12extern void pm_set_vt_switch(int); 13extern int pm_prepare_console(void); 14extern void pm_restore_console(void); 15#else 16static inline void pm_set_vt_switch(int do_switch) 17{ 18} 19 20static inline int pm_prepare_console(void) 21{ 22 return 0; 23} 24 25static inline void pm_restore_console(void) 26{ 27} 28#endif 29 30typedef int __bitwise suspend_state_t; 31 32#define PM_SUSPEND_ON ((__force suspend_state_t) 0) 33#define PM_SUSPEND_STANDBY ((__force suspend_state_t) 1) 34#define PM_SUSPEND_MEM ((__force suspend_state_t) 3) 35#define PM_SUSPEND_MAX ((__force suspend_state_t) 4) 36 37/** 38 * struct platform_suspend_ops - Callbacks for managing platform dependent 39 * system sleep states. 40 * 41 * @valid: Callback to determine if given system sleep state is supported by 42 * the platform. 43 * Valid (ie. supported) states are advertised in /sys/power/state. Note 44 * that it still may be impossible to enter given system sleep state if the 45 * conditions aren't right. 46 * There is the %suspend_valid_only_mem function available that can be 47 * assigned to this if the platform only supports mem sleep. 48 * 49 * @begin: Initialise a transition to given system sleep state. 50 * @begin() is executed right prior to suspending devices. The information 51 * conveyed to the platform code by @begin() should be disregarded by it as 52 * soon as @end() is executed. If @begin() fails (ie. returns nonzero), 53 * @prepare(), @enter() and @finish() will not be called by the PM core. 54 * This callback is optional. However, if it is implemented, the argument 55 * passed to @enter() is redundant and should be ignored. 56 * 57 * @prepare: Prepare the platform for entering the system sleep state indicated 58 * by @begin(). 59 * @prepare() is called right after devices have been suspended (ie. the 60 * appropriate .suspend() method has been executed for each device) and 61 * before device drivers' late suspend callbacks are executed. It returns 62 * 0 on success or a negative error code otherwise, in which case the 63 * system cannot enter the desired sleep state (@prepare_late(), @enter(), 64 * and @wake() will not be called in that case). 65 * 66 * @prepare_late: Finish preparing the platform for entering the system sleep 67 * state indicated by @begin(). 68 * @prepare_late is called before disabling nonboot CPUs and after 69 * device drivers' late suspend callbacks have been executed. It returns 70 * 0 on success or a negative error code otherwise, in which case the 71 * system cannot enter the desired sleep state (@enter() will not be 72 * executed). 73 * 74 * @enter: Enter the system sleep state indicated by @begin() or represented by 75 * the argument if @begin() is not implemented. 76 * This callback is mandatory. It returns 0 on success or a negative 77 * error code otherwise, in which case the system cannot enter the desired 78 * sleep state. 79 * 80 * @wake: Called when the system has just left a sleep state, right after 81 * the nonboot CPUs have been enabled and before device drivers' early 82 * resume callbacks are executed. 83 * This callback is optional, but should be implemented by the platforms 84 * that implement @prepare_late(). If implemented, it is always called 85 * after @prepare_late and @enter(), even if one of them fails. 86 * 87 * @finish: Finish wake-up of the platform. 88 * @finish is called right prior to calling device drivers' regular suspend 89 * callbacks. 90 * This callback is optional, but should be implemented by the platforms 91 * that implement @prepare(). If implemented, it is always called after 92 * @enter() and @wake(), even if any of them fails. It is executed after 93 * a failing @prepare. 94 * 95 * @end: Called by the PM core right after resuming devices, to indicate to 96 * the platform that the system has returned to the working state or 97 * the transition to the sleep state has been aborted. 98 * This callback is optional, but should be implemented by the platforms 99 * that implement @begin(). Accordingly, platforms implementing @begin() 100 * should also provide a @end() which cleans up transitions aborted before 101 * @enter(). 102 * 103 * @recover: Recover the platform from a suspend failure. 104 * Called by the PM core if the suspending of devices fails. 105 * This callback is optional and should only be implemented by platforms 106 * which require special recovery actions in that situation. 107 */ 108struct platform_suspend_ops { 109 int (*valid)(suspend_state_t state); 110 int (*begin)(suspend_state_t state); 111 int (*prepare)(void); 112 int (*prepare_late)(void); 113 int (*enter)(suspend_state_t state); 114 void (*wake)(void); 115 void (*finish)(void); 116 void (*end)(void); 117 void (*recover)(void); 118}; 119 120#ifdef CONFIG_SUSPEND 121/** 122 * suspend_set_ops - set platform dependent suspend operations 123 * @ops: The new suspend operations to set. 124 */ 125extern void suspend_set_ops(const struct platform_suspend_ops *ops); 126extern int suspend_valid_only_mem(suspend_state_t state); 127 128/** 129 * arch_suspend_disable_irqs - disable IRQs for suspend 130 * 131 * Disables IRQs (in the default case). This is a weak symbol in the common 132 * code and thus allows architectures to override it if more needs to be 133 * done. Not called for suspend to disk. 134 */ 135extern void arch_suspend_disable_irqs(void); 136 137/** 138 * arch_suspend_enable_irqs - enable IRQs after suspend 139 * 140 * Enables IRQs (in the default case). This is a weak symbol in the common 141 * code and thus allows architectures to override it if more needs to be 142 * done. Not called for suspend to disk. 143 */ 144extern void arch_suspend_enable_irqs(void); 145 146extern int pm_suspend(suspend_state_t state); 147#else /* !CONFIG_SUSPEND */ 148#define suspend_valid_only_mem NULL 149 150static inline void suspend_set_ops(const struct platform_suspend_ops *ops) {} 151static inline int pm_suspend(suspend_state_t state) { return -ENOSYS; } 152#endif /* !CONFIG_SUSPEND */ 153 154/* struct pbe is used for creating lists of pages that should be restored 155 * atomically during the resume from disk, because the page frames they have 156 * occupied before the suspend are in use. 157 */ 158struct pbe { 159 void *address; /* address of the copy */ 160 void *orig_address; /* original address of a page */ 161 struct pbe *next; 162}; 163 164/* mm/page_alloc.c */ 165extern void mark_free_pages(struct zone *zone); 166 167/** 168 * struct platform_hibernation_ops - hibernation platform support 169 * 170 * The methods in this structure allow a platform to carry out special 171 * operations required by it during a hibernation transition. 172 * 173 * All the methods below, except for @recover(), must be implemented. 174 * 175 * @begin: Tell the platform driver that we're starting hibernation. 176 * Called right after shrinking memory and before freezing devices. 177 * 178 * @end: Called by the PM core right after resuming devices, to indicate to 179 * the platform that the system has returned to the working state. 180 * 181 * @pre_snapshot: Prepare the platform for creating the hibernation image. 182 * Called right after devices have been frozen and before the nonboot 183 * CPUs are disabled (runs with IRQs on). 184 * 185 * @finish: Restore the previous state of the platform after the hibernation 186 * image has been created *or* put the platform into the normal operation 187 * mode after the hibernation (the same method is executed in both cases). 188 * Called right after the nonboot CPUs have been enabled and before 189 * thawing devices (runs with IRQs on). 190 * 191 * @prepare: Prepare the platform for entering the low power state. 192 * Called right after the hibernation image has been saved and before 193 * devices are prepared for entering the low power state. 194 * 195 * @enter: Put the system into the low power state after the hibernation image 196 * has been saved to disk. 197 * Called after the nonboot CPUs have been disabled and all of the low 198 * level devices have been shut down (runs with IRQs off). 199 * 200 * @leave: Perform the first stage of the cleanup after the system sleep state 201 * indicated by @set_target() has been left. 202 * Called right after the control has been passed from the boot kernel to 203 * the image kernel, before the nonboot CPUs are enabled and before devices 204 * are resumed. Executed with interrupts disabled. 205 * 206 * @pre_restore: Prepare system for the restoration from a hibernation image. 207 * Called right after devices have been frozen and before the nonboot 208 * CPUs are disabled (runs with IRQs on). 209 * 210 * @restore_cleanup: Clean up after a failing image restoration. 211 * Called right after the nonboot CPUs have been enabled and before 212 * thawing devices (runs with IRQs on). 213 * 214 * @recover: Recover the platform from a failure to suspend devices. 215 * Called by the PM core if the suspending of devices during hibernation 216 * fails. This callback is optional and should only be implemented by 217 * platforms which require special recovery actions in that situation. 218 */ 219struct platform_hibernation_ops { 220 int (*begin)(void); 221 void (*end)(void); 222 int (*pre_snapshot)(void); 223 void (*finish)(void); 224 int (*prepare)(void); 225 int (*enter)(void); 226 void (*leave)(void); 227 int (*pre_restore)(void); 228 void (*restore_cleanup)(void); 229 void (*recover)(void); 230}; 231 232#ifdef CONFIG_HIBERNATION 233/* kernel/power/snapshot.c */ 234extern void __register_nosave_region(unsigned long b, unsigned long e, int km); 235static inline void __init register_nosave_region(unsigned long b, unsigned long e) 236{ 237 __register_nosave_region(b, e, 0); 238} 239static inline void __init register_nosave_region_late(unsigned long b, unsigned long e) 240{ 241 __register_nosave_region(b, e, 1); 242} 243extern int swsusp_page_is_forbidden(struct page *); 244extern void swsusp_set_page_free(struct page *); 245extern void swsusp_unset_page_free(struct page *); 246extern unsigned long get_safe_page(gfp_t gfp_mask); 247 248extern void hibernation_set_ops(const struct platform_hibernation_ops *ops); 249extern int hibernate(void); 250extern bool system_entering_hibernation(void); 251#else /* CONFIG_HIBERNATION */ 252static inline int swsusp_page_is_forbidden(struct page *p) { return 0; } 253static inline void swsusp_set_page_free(struct page *p) {} 254static inline void swsusp_unset_page_free(struct page *p) {} 255 256static inline void hibernation_set_ops(const struct platform_hibernation_ops *ops) {} 257static inline int hibernate(void) { return -ENOSYS; } 258static inline bool system_entering_hibernation(void) { return false; } 259#endif /* CONFIG_HIBERNATION */ 260 261#ifdef CONFIG_PM_SLEEP 262void save_processor_state(void); 263void restore_processor_state(void); 264 265/* kernel/power/main.c */ 266extern int register_pm_notifier(struct notifier_block *nb); 267extern int unregister_pm_notifier(struct notifier_block *nb); 268 269#define pm_notifier(fn, pri) { \ 270 static struct notifier_block fn##_nb = \ 271 { .notifier_call = fn, .priority = pri }; \ 272 register_pm_notifier(&fn##_nb); \ 273} 274 275/* drivers/base/power/wakeup.c */ 276extern bool events_check_enabled; 277 278extern bool pm_wakeup_pending(void); 279extern bool pm_get_wakeup_count(unsigned int *count); 280extern bool pm_save_wakeup_count(unsigned int count); 281#else /* !CONFIG_PM_SLEEP */ 282 283static inline int register_pm_notifier(struct notifier_block *nb) 284{ 285 return 0; 286} 287 288static inline int unregister_pm_notifier(struct notifier_block *nb) 289{ 290 return 0; 291} 292 293#define pm_notifier(fn, pri) do { (void)(fn); } while (0) 294 295static inline bool pm_wakeup_pending(void) { return false; } 296#endif /* !CONFIG_PM_SLEEP */ 297 298extern struct mutex pm_mutex; 299 300#ifndef CONFIG_HIBERNATION 301static inline void register_nosave_region(unsigned long b, unsigned long e) 302{ 303} 304static inline void register_nosave_region_late(unsigned long b, unsigned long e) 305{ 306} 307 308static inline void lock_system_sleep(void) {} 309static inline void unlock_system_sleep(void) {} 310 311#else 312 313/* Let some subsystems like memory hotadd exclude hibernation */ 314 315static inline void lock_system_sleep(void) 316{ 317 mutex_lock(&pm_mutex); 318} 319 320static inline void unlock_system_sleep(void) 321{ 322 mutex_unlock(&pm_mutex); 323} 324#endif 325 326#endif /* _LINUX_SUSPEND_H */ 327