kernel/power/power.h

   1 #include <linux/suspend.h>
   2 #include <linux/suspend_ioctls.h>
   3 #include <linux/utsname.h>
   4
   5 struct swsusp_info {
   6         struct new_utsname      uts;
   7         u32                     version_code;
   8         unsigned long           num_physpages;
   9         int                     cpus;
  10         unsigned long           image_pages;
  11         unsigned long           pages;
  12         unsigned long           size;
  13 } __attribute__((aligned(PAGE_SIZE)));
  14
  15 #ifdef CONFIG_HIBERNATION
  16 #ifdef CONFIG_ARCH_HIBERNATION_HEADER
  17 /* Maximum size of architecture specific data in a hibernation header */
  18 #define MAX_ARCH_HEADER_SIZE    (sizeof(struct new_utsname) + 4)
  19
  20 extern int arch_hibernation_header_save(void *addr, unsigned int max_size);
  21 extern int arch_hibernation_header_restore(void *addr);
  22
  23 static inline int init_header_complete(struct swsusp_info *info)
  24 {
  25         return arch_hibernation_header_save(info, MAX_ARCH_HEADER_SIZE);
  26 }
  27
  28 static inline char *check_image_kernel(struct swsusp_info *info)
  29 {
  30         return arch_hibernation_header_restore(info) ?
  31                         "architecture specific data" : NULL;
  32 }
  33 #endif /* CONFIG_ARCH_HIBERNATION_HEADER */
  34
  35 /*
  36  * Keep some memory free so that I/O operations can succeed without paging
  37  * [Might this be more than 4 MB?]
  38  */
  39 #define PAGES_FOR_IO    ((4096 * 1024) >> PAGE_SHIFT)
  40
  41 /*
  42  * Keep 1 MB of memory free so that device drivers can allocate some pages in
  43  * their .suspend() routines without breaking the suspend to disk.
  44  */
  45 #define SPARE_PAGES     ((1024 * 1024) >> PAGE_SHIFT)
  46
  47 /* kernel/power/disk.c */
  48 extern int hibernation_snapshot(int platform_mode);
  49 extern int hibernation_restore(int platform_mode);
  50 extern int hibernation_platform_enter(void);
  51 #endif
  52
  53 extern int pfn_is_nosave(unsigned long);
  54
  55 extern struct mutex pm_mutex;
  56
  57 #define power_attr(_name) \
  58 static struct kobj_attribute _name##_attr = {   \
  59         .attr   = {                             \
  60                 .name = __stringify(_name),     \
  61                 .mode = 0644,                   \
  62         },                                      \
  63         .show   = _name##_show,                 \
  64         .store  = _name##_store,                \
  65 }
  66
  67 /* Preferred image size in bytes (default 500 MB) */
  68 extern unsigned long image_size;
  69 extern int in_suspend;
  70 extern dev_t swsusp_resume_device;
  71 extern sector_t swsusp_resume_block;
  72
  73 extern asmlinkage int swsusp_arch_suspend(void);
  74 extern asmlinkage int swsusp_arch_resume(void);
  75
  76 extern int create_basic_memory_bitmaps(void);
  77 extern void free_basic_memory_bitmaps(void);
  78 extern unsigned int count_data_pages(void);
  79
  80 /**
  81  *      Auxiliary structure used for reading the snapshot image data and
  82  *      metadata from and writing them to the list of page backup entries
  83  *      (PBEs) which is the main data structure of swsusp.
  84  *
  85  *      Using struct snapshot_handle we can transfer the image, including its
  86  *      metadata, as a continuous sequence of bytes with the help of
  87  *      snapshot_read_next() and snapshot_write_next().
  88  *
  89  *      The code that writes the image to a storage or transfers it to
  90  *      the user land is required to use snapshot_read_next() for this
  91  *      purpose and it should not make any assumptions regarding the internal
  92  *      structure of the image.  Similarly, the code that reads the image from
  93  *      a storage or transfers it from the user land is required to use
  94  *      snapshot_write_next().
  95  *
  96  *      This may allow us to change the internal structure of the image
  97  *      in the future with considerably less effort.
  98  */
  99
 100 struct snapshot_handle {
 101         loff_t          offset; /* number of the last byte ready for reading
 102                                  * or writing in the sequence
 103                                  */
 104         unsigned int    cur;    /* number of the block of PAGE_SIZE bytes the
 105                                  * next operation will refer to (ie. current)
 106                                  */
 107         unsigned int    cur_offset;     /* offset with respect to the current
 108                                          * block (for the next operation)
 109                                          */
 110         unsigned int    prev;   /* number of the block of PAGE_SIZE bytes that
 111                                  * was the current one previously
 112                                  */
 113         void            *buffer;        /* address of the block to read from
 114                                          * or write to
 115                                          */
 116         unsigned int    buf_offset;     /* location to read from or write to,
 117                                          * given as a displacement from 'buffer'
 118                                          */
 119         int             sync_read;      /* Set to one to notify the caller of
 120                                          * snapshot_write_next() that it may
 121                                          * need to call wait_on_bio_chain()
 122                                          */
 123 };
 124
 125 /* This macro returns the address from/to which the caller of
 126  * snapshot_read_next()/snapshot_write_next() is allowed to
 127  * read/write data after the function returns
 128  */
 129 #define data_of(handle) ((handle).buffer + (handle).buf_offset)
 130
 131 extern unsigned int snapshot_additional_pages(struct zone *zone);
 132 extern unsigned long snapshot_get_image_size(void);
 133 extern int snapshot_read_next(struct snapshot_handle *handle, size_t count);
 134 extern int snapshot_write_next(struct snapshot_handle *handle, size_t count);
 135 extern void snapshot_write_finalize(struct snapshot_handle *handle);
 136 extern int snapshot_image_loaded(struct snapshot_handle *handle);
 137
 138 /* If unset, the snapshot device cannot be open. */
 139 extern atomic_t snapshot_device_available;
 140
 141 extern sector_t alloc_swapdev_block(int swap);
 142 extern void free_all_swap_pages(int swap);
 143 extern int swsusp_swap_in_use(void);
 144
 145 /*
 146  * Flags that can be passed from the hibernatig hernel to the "boot" kernel in
 147  * the image header.
 148  */
 149 #define SF_PLATFORM_MODE        1
 150
 151 /* kernel/power/disk.c */
 152 extern int swsusp_check(void);
 153 extern int swsusp_shrink_memory(void);
 154 extern void swsusp_free(void);
 155 extern int swsusp_read(unsigned int *flags_p);
 156 extern int swsusp_write(unsigned int flags);
 157 extern void swsusp_close(void);
 158
 159 struct timeval;
 160 /* kernel/power/swsusp.c */
 161 extern void swsusp_show_speed(struct timeval *, struct timeval *,
 162                                 unsigned int, char *);
 163
 164 #ifdef CONFIG_SUSPEND
 165 /* kernel/power/main.c */
 166 extern int suspend_devices_and_enter(suspend_state_t state);
 167 #else /* !CONFIG_SUSPEND */
 168 static inline int suspend_devices_and_enter(suspend_state_t state)
 169 {
 170         return -ENOSYS;
 171 }
 172 #endif /* !CONFIG_SUSPEND */
 173
 174 #ifdef CONFIG_PM_SLEEP
 175 /* kernel/power/main.c */
 176 extern int pm_notifier_call_chain(unsigned long val);
 177 #endif
 178
 179 #ifdef CONFIG_HIGHMEM
 180 unsigned int count_highmem_pages(void);
 181 int restore_highmem(void);
 182 #else
 183 static inline unsigned int count_highmem_pages(void) { return 0; }
 184 static inline int restore_highmem(void) { return 0; }
 185 #endif
 186
 187 /*
 188  * Suspend test levels
 189  */
 190 enum {
 191         /* keep first */
 192         TEST_NONE,
 193         TEST_CORE,
 194         TEST_CPUS,
 195         TEST_PLATFORM,
 196         TEST_DEVICES,
 197         TEST_FREEZER,
 198         /* keep last */
 199         __TEST_AFTER_LAST
 200 };
 201
 202 #define TEST_FIRST      TEST_NONE
 203 #define TEST_MAX        (__TEST_AFTER_LAST - 1)
 204
 205 extern int pm_test_level;