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 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 /**
  30  * struct platform_suspend_ops - Callbacks for managing platform dependent
  31  *      system sleep states.
  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.
  38  *      There is the %suspend_valid_only_mem function available that can be
  39  *      assigned to this if the platform only supports mem sleep.
  40  *
  41  * @set_target: Tell the platform which system sleep state is going to be
  42  *      entered.
  43  *      @set_target() is executed right prior to suspending devices.  The
  44  *      information conveyed to the platform code by @set_target() should be
  45  *      disregarded by the platform as soon as @finish() is executed and if
  46  *      @prepare() fails.  If @set_target() fails (ie. returns nonzero),
  47  *      @prepare(), @enter() and @finish() will not be called by the PM core.
  48  *      This callback is optional.  However, if it is implemented, the argument
  49  *      passed to @enter() is meaningless and should be ignored.
  50  *
  51  * @prepare: Prepare the platform for entering the system sleep state indicated
  52  *      by @set_target().
  53  *      @prepare() is called right after devices have been suspended (ie. the
  54  *      appropriate .suspend() method has been executed for each device) and
  55  *      before the nonboot CPUs are disabled (it is executed with IRQs enabled).
  56  *      This callback is optional.  It returns 0 on success or a negative
  57  *      error code otherwise, in which case the system cannot enter the desired
  58  *      sleep state (@enter() and @finish() will not be called in that case).
  59  *
  60  * @enter: Enter the system sleep state indicated by @set_target() or
  61  *      represented by the argument if @set_target() is not implemented.
  62  *      This callback is mandatory.  It returns 0 on success or a negative
  63  *      error code otherwise, in which case the system cannot enter the desired
  64  *      sleep state.
  65  *
  66  * @finish: Called when the system has just left a sleep state, right after
  67  *      the nonboot CPUs have been enabled and before devices are resumed (it is
  68  *      executed with IRQs enabled).
  69  *      This callback is optional, but should be implemented by the platforms
  70  *      that implement @prepare().  If implemented, it is always called after
  71  *      @enter() (even if @enter() fails).
  72  */
  73 struct platform_suspend_ops {
  74         int (*valid)(suspend_state_t state);
  75         int (*set_target)(suspend_state_t state);
  76         int (*prepare)(void);
  77         int (*enter)(suspend_state_t state);
  78         void (*finish)(void);
  79 };
  80
  81 #ifdef CONFIG_SUSPEND
  82 /**
  83  * suspend_set_ops - set platform dependent suspend operations
  84  * @ops: The new suspend operations to set.
  85  */
  86 extern void suspend_set_ops(struct platform_suspend_ops *ops);
  87 extern int suspend_valid_only_mem(suspend_state_t state);
  88
  89 /**
  90  * arch_suspend_disable_irqs - disable IRQs for suspend
  91  *
  92  * Disables IRQs (in the default case). This is a weak symbol in the common
  93  * code and thus allows architectures to override it if more needs to be
  94  * done. Not called for suspend to disk.
  95  */
  96 extern void arch_suspend_disable_irqs(void);
  97
  98 /**
  99  * arch_suspend_enable_irqs - enable IRQs after suspend
 100  *
 101  * Enables IRQs (in the default case). This is a weak symbol in the common
 102  * code and thus allows architectures to override it if more needs to be
 103  * done. Not called for suspend to disk.
 104  */
 105 extern void arch_suspend_enable_irqs(void);
 106
 107 extern int pm_suspend(suspend_state_t state);
 108 #else /* !CONFIG_SUSPEND */
 109 #define suspend_valid_only_mem  NULL
 110
 111 static inline void suspend_set_ops(struct platform_suspend_ops *ops) {}
 112 static inline int pm_suspend(suspend_state_t state) { return -ENOSYS; }
 113 #endif /* !CONFIG_SUSPEND */
 114
 115 /* struct pbe is used for creating lists of pages that should be restored
 116  * atomically during the resume from disk, because the page frames they have
 117  * occupied before the suspend are in use.
 118  */
 119 struct pbe {
 120         void *address;          /* address of the copy */
 121         void *orig_address;     /* original address of a page */
 122         struct pbe *next;
 123 };
 124
 125 /* mm/page_alloc.c */
 126 extern void drain_local_pages(void);
 127 extern void mark_free_pages(struct zone *zone);
 128
 129 /**
 130  * struct hibernation_ops - hibernation platform support
 131  *
 132  * The methods in this structure allow a platform to override the default
 133  * mechanism of shutting down the machine during a hibernation transition.
 134  *
 135  * All three methods must be assigned.
 136  *
 137  * @prepare: prepare system for hibernation
 138  * @enter: shut down system after state has been saved to disk
 139  * @finish: finish/clean up after state has been reloaded
 140  * @pre_restore: prepare system for the restoration from a hibernation image
 141  * @restore_cleanup: clean up after a failing image restoration
 142  */
 143 struct hibernation_ops {
 144         int (*prepare)(void);
 145         int (*enter)(void);
 146         void (*finish)(void);
 147         int (*pre_restore)(void);
 148         void (*restore_cleanup)(void);
 149 };
 150
 151 #ifdef CONFIG_HIBERNATION
 152 /* kernel/power/snapshot.c */
 153 extern void __register_nosave_region(unsigned long b, unsigned long e, int km);
 154 static inline void register_nosave_region(unsigned long b, unsigned long e)
 155 {
 156         __register_nosave_region(b, e, 0);
 157 }
 158 static inline void register_nosave_region_late(unsigned long b, unsigned long e)
 159 {
 160         __register_nosave_region(b, e, 1);
 161 }
 162 extern int swsusp_page_is_forbidden(struct page *);
 163 extern void swsusp_set_page_free(struct page *);
 164 extern void swsusp_unset_page_free(struct page *);
 165 extern unsigned long get_safe_page(gfp_t gfp_mask);
 166
 167 extern void hibernation_set_ops(struct hibernation_ops *ops);
 168 extern int hibernate(void);
 169 #else /* CONFIG_HIBERNATION */
 170 static inline int swsusp_page_is_forbidden(struct page *p) { return 0; }
 171 static inline void swsusp_set_page_free(struct page *p) {}
 172 static inline void swsusp_unset_page_free(struct page *p) {}
 173
 174 static inline void hibernation_set_ops(struct hibernation_ops *ops) {}
 175 static inline int hibernate(void) { return -ENOSYS; }
 176 #endif /* CONFIG_HIBERNATION */
 177
 178 #ifdef CONFIG_PM_SLEEP
 179 void save_processor_state(void);
 180 void restore_processor_state(void);
 181 struct saved_context;
 182 void __save_processor_state(struct saved_context *ctxt);
 183 void __restore_processor_state(struct saved_context *ctxt);
 184
 185 /* kernel/power/main.c */
 186 extern struct blocking_notifier_head pm_chain_head;
 187
 188 static inline int register_pm_notifier(struct notifier_block *nb)
 189 {
 190         return blocking_notifier_chain_register(&pm_chain_head, nb);
 191 }
 192
 193 static inline int unregister_pm_notifier(struct notifier_block *nb)
 194 {
 195         return blocking_notifier_chain_unregister(&pm_chain_head, nb);
 196 }
 197
 198 #define pm_notifier(fn, pri) {                          \
 199         static struct notifier_block fn##_nb =                  \
 200                 { .notifier_call = fn, .priority = pri };       \
 201         register_pm_notifier(&fn##_nb);                 \
 202 }
 203 #else /* !CONFIG_PM_SLEEP */
 204
 205 static inline int register_pm_notifier(struct notifier_block *nb)
 206 {
 207         return 0;
 208 }
 209
 210 static inline int unregister_pm_notifier(struct notifier_block *nb)
 211 {
 212         return 0;
 213 }
 214
 215 #define pm_notifier(fn, pri)    do { (void)(fn); } while (0)
 216 #endif /* !CONFIG_PM_SLEEP */
 217
 218 #ifndef CONFIG_HIBERNATION
 219 static inline void register_nosave_region(unsigned long b, unsigned long e)
 220 {
 221 }
 222 static inline void register_nosave_region_late(unsigned long b, unsigned long e)
 223 {
 224 }
 225 #endif
 226
 227 #endif /* _LINUX_SUSPEND_H */