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