include/linux/suspend.h

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