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 extern struct platform_suspend_ops *suspend_ops;
  83
  84 /**
  85  * suspend_set_ops - set platform dependent suspend operations
  86  * @ops: The new suspend operations to set.
  87  */
  88 extern void suspend_set_ops(struct platform_suspend_ops *ops);
  89 extern int suspend_valid_only_mem(suspend_state_t state);
  90
  91 /**
  92  * arch_suspend_disable_irqs - disable IRQs for suspend
  93  *
  94  * Disables IRQs (in the default case). This is a weak symbol in the common
  95  * code and thus allows architectures to override it if more needs to be
  96  * done. Not called for suspend to disk.
  97  */
  98 extern void arch_suspend_disable_irqs(void);
  99
 100 /**
 101  * arch_suspend_enable_irqs - enable IRQs after suspend
 102  *
 103  * Enables IRQs (in the default case). This is a weak symbol in the common
 104  * code and thus allows architectures to override it if more needs to be
 105  * done. Not called for suspend to disk.
 106  */
 107 extern void arch_suspend_enable_irqs(void);
 108
 109 extern int pm_suspend(suspend_state_t state);
 110 #else /* !CONFIG_SUSPEND */
 111 #define suspend_valid_only_mem  NULL
 112
 113 static inline void suspend_set_ops(struct platform_suspend_ops *ops) {}
 114 static inline int pm_suspend(suspend_state_t state) { return -ENOSYS; }
 115 #endif /* !CONFIG_SUSPEND */
 116
 117 /* struct pbe is used for creating lists of pages that should be restored
 118  * atomically during the resume from disk, because the page frames they have
 119  * occupied before the suspend are in use.
 120  */
 121 struct pbe {
 122         void *address;          /* address of the copy */
 123         void *orig_address;     /* original address of a page */
 124         struct pbe *next;
 125 };
 126
 127 /* mm/page_alloc.c */
 128 extern void drain_local_pages(void);
 129 extern void mark_free_pages(struct zone *zone);
 130
 131 /**
 132  * struct hibernation_ops - hibernation platform support
 133  *
 134  * The methods in this structure allow a platform to override the default
 135  * mechanism of shutting down the machine during a hibernation transition.
 136  *
 137  * All three methods must be assigned.
 138  *
 139  * @prepare: prepare system for hibernation
 140  * @enter: shut down system after state has been saved to disk
 141  * @finish: finish/clean up after state has been reloaded
 142  * @pre_restore: prepare system for the restoration from a hibernation image
 143  * @restore_cleanup: clean up after a failing image restoration
 144  */
 145 struct hibernation_ops {
 146         int (*prepare)(void);
 147         int (*enter)(void);
 148         void (*finish)(void);
 149         int (*pre_restore)(void);
 150         void (*restore_cleanup)(void);
 151 };
 152
 153 #ifdef CONFIG_HIBERNATION
 154 /* kernel/power/snapshot.c */
 155 extern void __register_nosave_region(unsigned long b, unsigned long e, int km);
 156 static inline void register_nosave_region(unsigned long b, unsigned long e)
 157 {
 158         __register_nosave_region(b, e, 0);
 159 }
 160 static inline void register_nosave_region_late(unsigned long b, unsigned long e)
 161 {
 162         __register_nosave_region(b, e, 1);
 163 }
 164 extern int swsusp_page_is_forbidden(struct page *);
 165 extern void swsusp_set_page_free(struct page *);
 166 extern void swsusp_unset_page_free(struct page *);
 167 extern unsigned long get_safe_page(gfp_t gfp_mask);
 168
 169 extern void hibernation_set_ops(struct hibernation_ops *ops);
 170 extern int hibernate(void);
 171 #else /* CONFIG_HIBERNATION */
 172 static inline int swsusp_page_is_forbidden(struct page *p) { return 0; }
 173 static inline void swsusp_set_page_free(struct page *p) {}
 174 static inline void swsusp_unset_page_free(struct page *p) {}
 175
 176 static inline void hibernation_set_ops(struct hibernation_ops *ops) {}
 177 static inline int hibernate(void) { return -ENOSYS; }
 178 #endif /* CONFIG_HIBERNATION */
 179
 180 #ifdef CONFIG_PM_SLEEP
 181 void save_processor_state(void);
 182 void restore_processor_state(void);
 183 struct saved_context;
 184 void __save_processor_state(struct saved_context *ctxt);
 185 void __restore_processor_state(struct saved_context *ctxt);
 186
 187 /* kernel/power/main.c */
 188 extern struct blocking_notifier_head pm_chain_head;
 189
 190 static inline int register_pm_notifier(struct notifier_block *nb)
 191 {
 192         return blocking_notifier_chain_register(&pm_chain_head, nb);
 193 }
 194
 195 static inline int unregister_pm_notifier(struct notifier_block *nb)
 196 {
 197         return blocking_notifier_chain_unregister(&pm_chain_head, nb);
 198 }
 199
 200 #define pm_notifier(fn, pri) {                          \
 201         static struct notifier_block fn##_nb =                  \
 202                 { .notifier_call = fn, .priority = pri };       \
 203         register_pm_notifier(&fn##_nb);                 \
 204 }
 205 #else /* !CONFIG_PM_SLEEP */
 206
 207 static inline int register_pm_notifier(struct notifier_block *nb)
 208 {
 209         return 0;
 210 }
 211
 212 static inline int unregister_pm_notifier(struct notifier_block *nb)
 213 {
 214         return 0;
 215 }
 216
 217 #define pm_notifier(fn, pri)    do { (void)(fn); } while (0)
 218 #endif /* !CONFIG_PM_SLEEP */
 219
 220 #ifndef CONFIG_HIBERNATION
 221 static inline void register_nosave_region(unsigned long b, unsigned long e)
 222 {
 223 }
 224 static inline void register_nosave_region_late(unsigned long b, unsigned long e)
 225 {
 226 }
 227 #endif
 228
 229 #endif /* _LINUX_SUSPEND_H */