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