kernel/power/power.h

   1 #include <linux/suspend.h>
   2 #include <linux/suspend_ioctls.h>
   3 #include <linux/utsname.h>
   4 #include <linux/freezer.h>
   5 #include <linux/compiler.h>
   6
   7 struct swsusp_info {
   8         struct new_utsname      uts;
   9         u32                     version_code;
  10         unsigned long           num_physpages;
  11         int                     cpus;
  12         unsigned long           image_pages;
  13         unsigned long           pages;
  14         unsigned long           size;
  15 } __aligned(PAGE_SIZE);
  16
  17 #ifdef CONFIG_HIBERNATION
  18 /* kernel/power/snapshot.c */
  19 extern void __init hibernate_reserved_size_init(void);
  20 extern void __init hibernate_image_size_init(void);
  21
  22 #ifdef CONFIG_ARCH_HIBERNATION_HEADER
  23 /* Maximum size of architecture specific data in a hibernation header */
  24 #define MAX_ARCH_HEADER_SIZE    (sizeof(struct new_utsname) + 4)
  25
  26 extern int arch_hibernation_header_save(void *addr, unsigned int max_size);
  27 extern int arch_hibernation_header_restore(void *addr);
  28
  29 static inline int init_header_complete(struct swsusp_info *info)
  30 {
  31         return arch_hibernation_header_save(info, MAX_ARCH_HEADER_SIZE);
  32 }
  33
  34 static inline char *check_image_kernel(struct swsusp_info *info)
  35 {
  36         return arch_hibernation_header_restore(info) ?
  37                         "architecture specific data" : NULL;
  38 }
  39 #endif /* CONFIG_ARCH_HIBERNATION_HEADER */
  40
  41 /*
  42  * Keep some memory free so that I/O operations can succeed without paging
  43  * [Might this be more than 4 MB?]
  44  */
  45 #define PAGES_FOR_IO    ((4096 * 1024) >> PAGE_SHIFT)
  46
  47 /*
  48  * Keep 1 MB of memory free so that device drivers can allocate some pages in
  49  * their .suspend() routines without breaking the suspend to disk.
  50  */
  51 #define SPARE_PAGES     ((1024 * 1024) >> PAGE_SHIFT)
  52
  53 asmlinkage int swsusp_save(void);
  54
  55 /* kernel/power/hibernate.c */
  56 extern bool freezer_test_done;
  57
  58 extern int hibernation_snapshot(int platform_mode);
  59 extern int hibernation_restore(int platform_mode);
  60 extern int hibernation_platform_enter(void);
  61
  62 #ifdef CONFIG_DEBUG_RODATA
  63 /* kernel/power/snapshot.c */
  64 extern void enable_restore_image_protection(void);
  65 #else
  66 static inline void enable_restore_image_protection(void) {}
  67 #endif /* CONFIG_DEBUG_RODATA */
  68
  69 #else /* !CONFIG_HIBERNATION */
  70
  71 static inline void hibernate_reserved_size_init(void) {}
  72 static inline void hibernate_image_size_init(void) {}
  73 #endif /* !CONFIG_HIBERNATION */
  74
  75 extern int pfn_is_nosave(unsigned long);
  76
  77 #define power_attr(_name) \
  78 static struct kobj_attribute _name##_attr = {   \
  79         .attr   = {                             \
  80                 .name = __stringify(_name),     \
  81                 .mode = 0644,                   \
  82         },                                      \
  83         .show   = _name##_show,                 \
  84         .store  = _name##_store,                \
  85 }
  86
  87 #define power_attr_ro(_name) \
  88 static struct kobj_attribute _name##_attr = {   \
  89         .attr   = {                             \
  90                 .name = __stringify(_name),     \
  91                 .mode = S_IRUGO,                \
  92         },                                      \
  93         .show   = _name##_show,                 \
  94 }
  95
  96 /* Preferred image size in bytes (default 500 MB) */
  97 extern unsigned long image_size;
  98 /* Size of memory reserved for drivers (default SPARE_PAGES x PAGE_SIZE) */
  99 extern unsigned long reserved_size;
 100 extern int in_suspend;
 101 extern dev_t swsusp_resume_device;
 102 extern sector_t swsusp_resume_block;
 103
 104 extern asmlinkage int swsusp_arch_suspend(void);
 105 extern asmlinkage int swsusp_arch_resume(void);
 106
 107 extern int create_basic_memory_bitmaps(void);
 108 extern void free_basic_memory_bitmaps(void);
 109 extern int hibernate_preallocate_memory(void);
 110
 111 /**
 112  *      Auxiliary structure used for reading the snapshot image data and
 113  *      metadata from and writing them to the list of page backup entries
 114  *      (PBEs) which is the main data structure of swsusp.
 115  *
 116  *      Using struct snapshot_handle we can transfer the image, including its
 117  *      metadata, as a continuous sequence of bytes with the help of
 118  *      snapshot_read_next() and snapshot_write_next().
 119  *
 120  *      The code that writes the image to a storage or transfers it to
 121  *      the user land is required to use snapshot_read_next() for this
 122  *      purpose and it should not make any assumptions regarding the internal
 123  *      structure of the image.  Similarly, the code that reads the image from
 124  *      a storage or transfers it from the user land is required to use
 125  *      snapshot_write_next().
 126  *
 127  *      This may allow us to change the internal structure of the image
 128  *      in the future with considerably less effort.
 129  */
 130
 131 struct snapshot_handle {
 132         unsigned int    cur;    /* number of the block of PAGE_SIZE bytes the
 133                                  * next operation will refer to (ie. current)
 134                                  */
 135         void            *buffer;        /* address of the block to read from
 136                                          * or write to
 137                                          */
 138         int             sync_read;      /* Set to one to notify the caller of
 139                                          * snapshot_write_next() that it may
 140                                          * need to call wait_on_bio_chain()
 141                                          */
 142 };
 143
 144 /* This macro returns the address from/to which the caller of
 145  * snapshot_read_next()/snapshot_write_next() is allowed to
 146  * read/write data after the function returns
 147  */
 148 #define data_of(handle) ((handle).buffer)
 149
 150 extern unsigned int snapshot_additional_pages(struct zone *zone);
 151 extern unsigned long snapshot_get_image_size(void);
 152 extern int snapshot_read_next(struct snapshot_handle *handle);
 153 extern int snapshot_write_next(struct snapshot_handle *handle);
 154 extern void snapshot_write_finalize(struct snapshot_handle *handle);
 155 extern int snapshot_image_loaded(struct snapshot_handle *handle);
 156
 157 /* If unset, the snapshot device cannot be open. */
 158 extern atomic_t snapshot_device_available;
 159
 160 extern sector_t alloc_swapdev_block(int swap);
 161 extern void free_all_swap_pages(int swap);
 162 extern int swsusp_swap_in_use(void);
 163
 164 /*
 165  * Flags that can be passed from the hibernatig hernel to the "boot" kernel in
 166  * the image header.
 167  */
 168 #define SF_PLATFORM_MODE        1
 169 #define SF_NOCOMPRESS_MODE      2
 170 #define SF_CRC32_MODE           4
 171
 172 /* kernel/power/hibernate.c */
 173 extern int swsusp_check(void);
 174 extern void swsusp_free(void);
 175 extern int swsusp_read(unsigned int *flags_p);
 176 extern int swsusp_write(unsigned int flags);
 177 extern void swsusp_close(fmode_t);
 178 #ifdef CONFIG_SUSPEND
 179 extern int swsusp_unmark(void);
 180 #endif
 181
 182 struct timeval;
 183 /* kernel/power/swsusp.c */
 184 extern void swsusp_show_speed(ktime_t, ktime_t, unsigned int, char *);
 185
 186 #ifdef CONFIG_SUSPEND
 187 /* kernel/power/suspend.c */
 188 extern const char *pm_labels[];
 189 extern const char *pm_states[];
 190
 191 extern int suspend_devices_and_enter(suspend_state_t state);
 192 #else /* !CONFIG_SUSPEND */
 193 static inline int suspend_devices_and_enter(suspend_state_t state)
 194 {
 195         return -ENOSYS;
 196 }
 197 #endif /* !CONFIG_SUSPEND */
 198
 199 #ifdef CONFIG_PM_TEST_SUSPEND
 200 /* kernel/power/suspend_test.c */
 201 extern void suspend_test_start(void);
 202 extern void suspend_test_finish(const char *label);
 203 #else /* !CONFIG_PM_TEST_SUSPEND */
 204 static inline void suspend_test_start(void) {}
 205 static inline void suspend_test_finish(const char *label) {}
 206 #endif /* !CONFIG_PM_TEST_SUSPEND */
 207
 208 #ifdef CONFIG_PM_SLEEP
 209 /* kernel/power/main.c */
 210 extern int __pm_notifier_call_chain(unsigned long val, int nr_to_call,
 211                                     int *nr_calls);
 212 extern int pm_notifier_call_chain(unsigned long val);
 213 #endif
 214
 215 #ifdef CONFIG_HIGHMEM
 216 int restore_highmem(void);
 217 #else
 218 static inline unsigned int count_highmem_pages(void) { return 0; }
 219 static inline int restore_highmem(void) { return 0; }
 220 #endif
 221
 222 /*
 223  * Suspend test levels
 224  */
 225 enum {
 226         /* keep first */
 227         TEST_NONE,
 228         TEST_CORE,
 229         TEST_CPUS,
 230         TEST_PLATFORM,
 231         TEST_DEVICES,
 232         TEST_FREEZER,
 233         /* keep last */
 234         __TEST_AFTER_LAST
 235 };
 236
 237 #define TEST_FIRST      TEST_NONE
 238 #define TEST_MAX        (__TEST_AFTER_LAST - 1)
 239
 240 extern int pm_test_level;
 241
 242 #ifdef CONFIG_SUSPEND_FREEZER
 243 static inline int suspend_freeze_processes(void)
 244 {
 245         int error;
 246
 247         error = freeze_processes();
 248         /*
 249          * freeze_processes() automatically thaws every task if freezing
 250          * fails. So we need not do anything extra upon error.
 251          */
 252         if (error)
 253                 return error;
 254
 255         error = freeze_kernel_threads();
 256         /*
 257          * freeze_kernel_threads() thaws only kernel threads upon freezing
 258          * failure. So we have to thaw the userspace tasks ourselves.
 259          */
 260         if (error)
 261                 thaw_processes();
 262
 263         return error;
 264 }
 265
 266 static inline void suspend_thaw_processes(void)
 267 {
 268         thaw_processes();
 269 }
 270 #else
 271 static inline int suspend_freeze_processes(void)
 272 {
 273         return 0;
 274 }
 275
 276 static inline void suspend_thaw_processes(void)
 277 {
 278 }
 279 #endif
 280
 281 #ifdef CONFIG_PM_AUTOSLEEP
 282
 283 /* kernel/power/autosleep.c */
 284 extern int pm_autosleep_init(void);
 285 extern int pm_autosleep_lock(void);
 286 extern void pm_autosleep_unlock(void);
 287 extern suspend_state_t pm_autosleep_state(void);
 288 extern int pm_autosleep_set_state(suspend_state_t state);
 289
 290 #else /* !CONFIG_PM_AUTOSLEEP */
 291
 292 static inline int pm_autosleep_init(void) { return 0; }
 293 static inline int pm_autosleep_lock(void) { return 0; }
 294 static inline void pm_autosleep_unlock(void) {}
 295 static inline suspend_state_t pm_autosleep_state(void) { return PM_SUSPEND_ON; }
 296
 297 #endif /* !CONFIG_PM_AUTOSLEEP */
 298
 299 #ifdef CONFIG_PM_WAKELOCKS
 300
 301 /* kernel/power/wakelock.c */
 302 extern ssize_t pm_show_wakelocks(char *buf, bool show_active);
 303 extern int pm_wake_lock(const char *buf);
 304 extern int pm_wake_unlock(const char *buf);
 305
 306 #endif /* !CONFIG_PM_WAKELOCKS */