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