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_STRICT_KERNEL_RWX 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_STRICT_KERNEL_RWX */ 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 extern void clear_free_pages(void); 114 115 /** 116 * Auxiliary structure used for reading the snapshot image data and 117 * metadata from and writing them to the list of page backup entries 118 * (PBEs) which is the main data structure of swsusp. 119 * 120 * Using struct snapshot_handle we can transfer the image, including its 121 * metadata, as a continuous sequence of bytes with the help of 122 * snapshot_read_next() and snapshot_write_next(). 123 * 124 * The code that writes the image to a storage or transfers it to 125 * the user land is required to use snapshot_read_next() for this 126 * purpose and it should not make any assumptions regarding the internal 127 * structure of the image. Similarly, the code that reads the image from 128 * a storage or transfers it from the user land is required to use 129 * snapshot_write_next(). 130 * 131 * This may allow us to change the internal structure of the image 132 * in the future with considerably less effort. 133 */ 134 135 struct snapshot_handle { 136 unsigned int cur; /* number of the block of PAGE_SIZE bytes the 137 * next operation will refer to (ie. current) 138 */ 139 void *buffer; /* address of the block to read from 140 * or write to 141 */ 142 int sync_read; /* Set to one to notify the caller of 143 * snapshot_write_next() that it may 144 * need to call wait_on_bio_chain() 145 */ 146 }; 147 148 /* This macro returns the address from/to which the caller of 149 * snapshot_read_next()/snapshot_write_next() is allowed to 150 * read/write data after the function returns 151 */ 152 #define data_of(handle) ((handle).buffer) 153 154 extern unsigned int snapshot_additional_pages(struct zone *zone); 155 extern unsigned long snapshot_get_image_size(void); 156 extern int snapshot_read_next(struct snapshot_handle *handle); 157 extern int snapshot_write_next(struct snapshot_handle *handle); 158 extern void snapshot_write_finalize(struct snapshot_handle *handle); 159 extern int snapshot_image_loaded(struct snapshot_handle *handle); 160 161 /* If unset, the snapshot device cannot be open. */ 162 extern atomic_t snapshot_device_available; 163 164 extern sector_t alloc_swapdev_block(int swap); 165 extern void free_all_swap_pages(int swap); 166 extern int swsusp_swap_in_use(void); 167 168 /* 169 * Flags that can be passed from the hibernatig hernel to the "boot" kernel in 170 * the image header. 171 */ 172 #define SF_PLATFORM_MODE 1 173 #define SF_NOCOMPRESS_MODE 2 174 #define SF_CRC32_MODE 4 175 176 /* kernel/power/hibernate.c */ 177 extern int swsusp_check(void); 178 extern void swsusp_free(void); 179 extern int swsusp_read(unsigned int *flags_p); 180 extern int swsusp_write(unsigned int flags); 181 extern void swsusp_close(fmode_t); 182 #ifdef CONFIG_SUSPEND 183 extern int swsusp_unmark(void); 184 #endif 185 186 struct timeval; 187 /* kernel/power/swsusp.c */ 188 extern void swsusp_show_speed(ktime_t, ktime_t, unsigned int, char *); 189 190 #ifdef CONFIG_SUSPEND 191 /* kernel/power/suspend.c */ 192 extern const char * const pm_labels[]; 193 extern const char *pm_states[]; 194 extern const char *mem_sleep_states[]; 195 196 extern int suspend_devices_and_enter(suspend_state_t state); 197 #else /* !CONFIG_SUSPEND */ 198 #define mem_sleep_current PM_SUSPEND_ON 199 200 static inline int suspend_devices_and_enter(suspend_state_t state) 201 { 202 return -ENOSYS; 203 } 204 #endif /* !CONFIG_SUSPEND */ 205 206 #ifdef CONFIG_PM_TEST_SUSPEND 207 /* kernel/power/suspend_test.c */ 208 extern void suspend_test_start(void); 209 extern void suspend_test_finish(const char *label); 210 #else /* !CONFIG_PM_TEST_SUSPEND */ 211 static inline void suspend_test_start(void) {} 212 static inline void suspend_test_finish(const char *label) {} 213 #endif /* !CONFIG_PM_TEST_SUSPEND */ 214 215 #ifdef CONFIG_PM_SLEEP 216 /* kernel/power/main.c */ 217 extern int __pm_notifier_call_chain(unsigned long val, int nr_to_call, 218 int *nr_calls); 219 extern int pm_notifier_call_chain(unsigned long val); 220 #endif 221 222 #ifdef CONFIG_HIGHMEM 223 int restore_highmem(void); 224 #else 225 static inline unsigned int count_highmem_pages(void) { return 0; } 226 static inline int restore_highmem(void) { return 0; } 227 #endif 228 229 /* 230 * Suspend test levels 231 */ 232 enum { 233 /* keep first */ 234 TEST_NONE, 235 TEST_CORE, 236 TEST_CPUS, 237 TEST_PLATFORM, 238 TEST_DEVICES, 239 TEST_FREEZER, 240 /* keep last */ 241 __TEST_AFTER_LAST 242 }; 243 244 #define TEST_FIRST TEST_NONE 245 #define TEST_MAX (__TEST_AFTER_LAST - 1) 246 247 #ifdef CONFIG_PM_SLEEP_DEBUG 248 extern int pm_test_level; 249 #else 250 #define pm_test_level (TEST_NONE) 251 #endif 252 253 #ifdef CONFIG_SUSPEND_FREEZER 254 static inline int suspend_freeze_processes(void) 255 { 256 int error; 257 258 error = freeze_processes(); 259 /* 260 * freeze_processes() automatically thaws every task if freezing 261 * fails. So we need not do anything extra upon error. 262 */ 263 if (error) 264 return error; 265 266 error = freeze_kernel_threads(); 267 /* 268 * freeze_kernel_threads() thaws only kernel threads upon freezing 269 * failure. So we have to thaw the userspace tasks ourselves. 270 */ 271 if (error) 272 thaw_processes(); 273 274 return error; 275 } 276 277 static inline void suspend_thaw_processes(void) 278 { 279 thaw_processes(); 280 } 281 #else 282 static inline int suspend_freeze_processes(void) 283 { 284 return 0; 285 } 286 287 static inline void suspend_thaw_processes(void) 288 { 289 } 290 #endif 291 292 #ifdef CONFIG_PM_AUTOSLEEP 293 294 /* kernel/power/autosleep.c */ 295 extern int pm_autosleep_init(void); 296 extern int pm_autosleep_lock(void); 297 extern void pm_autosleep_unlock(void); 298 extern suspend_state_t pm_autosleep_state(void); 299 extern int pm_autosleep_set_state(suspend_state_t state); 300 301 #else /* !CONFIG_PM_AUTOSLEEP */ 302 303 static inline int pm_autosleep_init(void) { return 0; } 304 static inline int pm_autosleep_lock(void) { return 0; } 305 static inline void pm_autosleep_unlock(void) {} 306 static inline suspend_state_t pm_autosleep_state(void) { return PM_SUSPEND_ON; } 307 308 #endif /* !CONFIG_PM_AUTOSLEEP */ 309 310 #ifdef CONFIG_PM_WAKELOCKS 311 312 /* kernel/power/wakelock.c */ 313 extern ssize_t pm_show_wakelocks(char *buf, bool show_active); 314 extern int pm_wake_lock(const char *buf); 315 extern int pm_wake_unlock(const char *buf); 316 317 #endif /* !CONFIG_PM_WAKELOCKS */ 318