Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
1da177e4 | 2 | #include <linux/suspend.h> |
3010f8ca | 3 | #include <linux/suspend_ioctls.h> |
1da177e4 | 4 | #include <linux/utsname.h> |
b28f5081 | 5 | #include <linux/freezer.h> |
52f5684c | 6 | #include <linux/compiler.h> |
23f62d7a RW |
7 | #include <linux/cpu.h> |
8 | #include <linux/cpuidle.h> | |
a06c6f5d | 9 | #include <linux/crypto.h> |
1da177e4 | 10 | |
1da177e4 LT |
11 | struct swsusp_info { |
12 | struct new_utsname uts; | |
13 | u32 version_code; | |
14 | unsigned long num_physpages; | |
15 | int cpus; | |
16 | unsigned long image_pages; | |
7088a5c0 | 17 | unsigned long pages; |
6e1819d6 | 18 | unsigned long size; |
52f5684c | 19 | } __aligned(PAGE_SIZE); |
1da177e4 | 20 | |
d307c4a8 | 21 | #ifdef CONFIG_HIBERNATION |
ac5c24ec | 22 | /* kernel/power/snapshot.c */ |
ddeb6487 | 23 | extern void __init hibernate_reserved_size_init(void); |
ac5c24ec RW |
24 | extern void __init hibernate_image_size_init(void); |
25 | ||
d307c4a8 RW |
26 | #ifdef CONFIG_ARCH_HIBERNATION_HEADER |
27 | /* Maximum size of architecture specific data in a hibernation header */ | |
28 | #define MAX_ARCH_HEADER_SIZE (sizeof(struct new_utsname) + 4) | |
1da177e4 | 29 | |
d307c4a8 RW |
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 | ||
02d7f400 | 35 | static inline const char *check_image_kernel(struct swsusp_info *info) |
d307c4a8 RW |
36 | { |
37 | return arch_hibernation_header_restore(info) ? | |
38 | "architecture specific data" : NULL; | |
39 | } | |
40 | #endif /* CONFIG_ARCH_HIBERNATION_HEADER */ | |
1da177e4 | 41 | |
56f99bcb RW |
42 | /* |
43 | * Keep some memory free so that I/O operations can succeed without paging | |
44 | * [Might this be more than 4 MB?] | |
45 | */ | |
46 | #define PAGES_FOR_IO ((4096 * 1024) >> PAGE_SHIFT) | |
d307c4a8 | 47 | |
56f99bcb RW |
48 | /* |
49 | * Keep 1 MB of memory free so that device drivers can allocate some pages in | |
50 | * their .suspend() routines without breaking the suspend to disk. | |
51 | */ | |
52 | #define SPARE_PAGES ((1024 * 1024) >> PAGE_SHIFT) | |
1da177e4 | 53 | |
04b73469 RK |
54 | asmlinkage int swsusp_save(void); |
55 | ||
8b759b84 | 56 | /* kernel/power/hibernate.c */ |
97819a26 | 57 | extern bool freezer_test_done; |
a06c6f5d N |
58 | extern char hib_comp_algo[CRYPTO_MAX_ALG_NAME]; |
59 | ||
60 | /* kernel/power/swap.c */ | |
61 | extern unsigned int swsusp_header_flags; | |
97819a26 | 62 | |
7777fab9 | 63 | extern int hibernation_snapshot(int platform_mode); |
a634cc10 | 64 | extern int hibernation_restore(int platform_mode); |
7777fab9 | 65 | extern int hibernation_platform_enter(void); |
ac5c24ec | 66 | |
0f5bf6d0 | 67 | #ifdef CONFIG_STRICT_KERNEL_RWX |
4c0b6c10 RW |
68 | /* kernel/power/snapshot.c */ |
69 | extern void enable_restore_image_protection(void); | |
70 | #else | |
71 | static inline void enable_restore_image_protection(void) {} | |
0f5bf6d0 | 72 | #endif /* CONFIG_STRICT_KERNEL_RWX */ |
4c0b6c10 | 73 | |
ac5c24ec RW |
74 | #else /* !CONFIG_HIBERNATION */ |
75 | ||
ddeb6487 | 76 | static inline void hibernate_reserved_size_init(void) {} |
ac5c24ec RW |
77 | static inline void hibernate_image_size_init(void) {} |
78 | #endif /* !CONFIG_HIBERNATION */ | |
a6d70980 | 79 | |
1da177e4 | 80 | #define power_attr(_name) \ |
386f275f | 81 | static struct kobj_attribute _name##_attr = { \ |
1da177e4 LT |
82 | .attr = { \ |
83 | .name = __stringify(_name), \ | |
84 | .mode = 0644, \ | |
85 | }, \ | |
86 | .show = _name##_show, \ | |
87 | .store = _name##_store, \ | |
88 | } | |
89 | ||
a1e9ca69 RW |
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 | ||
853609b6 RW |
99 | /* Preferred image size in bytes (default 500 MB) */ |
100 | extern unsigned long image_size; | |
ddeb6487 RW |
101 | /* Size of memory reserved for drivers (default SPARE_PAGES x PAGE_SIZE) */ |
102 | extern unsigned long reserved_size; | |
f577eb30 | 103 | extern int in_suspend; |
61159a31 | 104 | extern dev_t swsusp_resume_device; |
9a154d9d | 105 | extern sector_t swsusp_resume_block; |
f577eb30 | 106 | |
74dfd666 RW |
107 | extern int create_basic_memory_bitmaps(void); |
108 | extern void free_basic_memory_bitmaps(void); | |
64a473cb | 109 | extern int hibernate_preallocate_memory(void); |
f577eb30 | 110 | |
03b6c9a3 | 111 | extern void clear_or_poison_free_pages(void); |
1ad1410f | 112 | |
fb13a28b RW |
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 | ||
f577eb30 | 133 | struct snapshot_handle { |
fb13a28b RW |
134 | unsigned int cur; /* number of the block of PAGE_SIZE bytes the |
135 | * next operation will refer to (ie. current) | |
136 | */ | |
fb13a28b RW |
137 | void *buffer; /* address of the block to read from |
138 | * or write to | |
139 | */ | |
fb13a28b RW |
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 | */ | |
f577eb30 RW |
144 | }; |
145 | ||
fb13a28b RW |
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 | */ | |
d3c1b24c | 150 | #define data_of(handle) ((handle).buffer) |
f577eb30 | 151 | |
b788db79 | 152 | extern unsigned int snapshot_additional_pages(struct zone *zone); |
af508b34 | 153 | extern unsigned long snapshot_get_image_size(void); |
d3c1b24c JS |
154 | extern int snapshot_read_next(struct snapshot_handle *handle); |
155 | extern int snapshot_write_next(struct snapshot_handle *handle); | |
f4311756 | 156 | int snapshot_write_finalize(struct snapshot_handle *handle); |
b788db79 | 157 | extern int snapshot_image_loaded(struct snapshot_handle *handle); |
61159a31 | 158 | |
ab7e9b06 DA |
159 | extern bool hibernate_acquire(void); |
160 | extern void hibernate_release(void); | |
0709db60 | 161 | |
d1d241cc RW |
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); | |
61159a31 | 165 | |
a634cc10 RW |
166 | /* |
167 | * Flags that can be passed from the hibernatig hernel to the "boot" kernel in | |
168 | * the image header. | |
169 | */ | |
8bc29736 | 170 | #define SF_COMPRESSION_ALG_LZO 0 /* dummy, details given below */ |
a634cc10 | 171 | #define SF_PLATFORM_MODE 1 |
f996fc96 | 172 | #define SF_NOCOMPRESS_MODE 2 |
081a9d04 | 173 | #define SF_CRC32_MODE 4 |
74d95555 | 174 | #define SF_HW_SIG 8 |
a634cc10 | 175 | |
8bc29736 N |
176 | /* |
177 | * Bit to indicate the compression algorithm to be used(for LZ4). The same | |
178 | * could be checked while saving/loading image to/from disk to use the | |
179 | * corresponding algorithms. | |
180 | * | |
181 | * By default, LZO compression is enabled if SF_CRC32_MODE is set. Use | |
182 | * SF_COMPRESSION_ALG_LZ4 to override this behaviour and use LZ4. | |
183 | * | |
184 | * SF_CRC32_MODE, SF_COMPRESSION_ALG_LZO(dummy) -> Compression, LZO | |
185 | * SF_CRC32_MODE, SF_COMPRESSION_ALG_LZ4 -> Compression, LZ4 | |
186 | */ | |
187 | #define SF_COMPRESSION_ALG_LZ4 16 | |
188 | ||
8b759b84 | 189 | /* kernel/power/hibernate.c */ |
40d84e19 | 190 | int swsusp_check(bool exclusive); |
74c7e2ef | 191 | extern void swsusp_free(void); |
a634cc10 RW |
192 | extern int swsusp_read(unsigned int *flags_p); |
193 | extern int swsusp_write(unsigned int flags); | |
93745df1 | 194 | void swsusp_close(void); |
62c552cc BS |
195 | #ifdef CONFIG_SUSPEND |
196 | extern int swsusp_unmark(void); | |
0c4cae1b CF |
197 | #else |
198 | static inline int swsusp_unmark(void) { return 0; } | |
62c552cc | 199 | #endif |
0d3a9abe | 200 | |
75d319c0 | 201 | struct __kernel_old_timeval; |
b10d9117 | 202 | /* kernel/power/swsusp.c */ |
db597605 | 203 | extern void swsusp_show_speed(ktime_t, ktime_t, unsigned int, char *); |
b10d9117 | 204 | |
296699de | 205 | #ifdef CONFIG_SUSPEND |
a9d70523 | 206 | /* kernel/power/suspend.c */ |
406e7938 | 207 | extern const char * const pm_labels[]; |
d431cbc5 | 208 | extern const char *pm_states[]; |
406e7938 | 209 | extern const char *mem_sleep_states[]; |
a9d70523 | 210 | |
6c961dfb | 211 | extern int suspend_devices_and_enter(suspend_state_t state); |
296699de | 212 | #else /* !CONFIG_SUSPEND */ |
406e7938 RW |
213 | #define mem_sleep_current PM_SUSPEND_ON |
214 | ||
296699de RW |
215 | static inline int suspend_devices_and_enter(suspend_state_t state) |
216 | { | |
217 | return -ENOSYS; | |
218 | } | |
219 | #endif /* !CONFIG_SUSPEND */ | |
220 | ||
a9d70523 RW |
221 | #ifdef CONFIG_PM_TEST_SUSPEND |
222 | /* kernel/power/suspend_test.c */ | |
223 | extern void suspend_test_start(void); | |
224 | extern void suspend_test_finish(const char *label); | |
225 | #else /* !CONFIG_PM_TEST_SUSPEND */ | |
226 | static inline void suspend_test_start(void) {} | |
227 | static inline void suspend_test_finish(const char *label) {} | |
228 | #endif /* !CONFIG_PM_TEST_SUSPEND */ | |
229 | ||
82525756 AS |
230 | #ifdef CONFIG_PM_SLEEP |
231 | /* kernel/power/main.c */ | |
70d93298 | 232 | extern int pm_notifier_call_chain_robust(unsigned long val_up, unsigned long val_down); |
82525756 | 233 | extern int pm_notifier_call_chain(unsigned long val); |
07f44ac3 KW |
234 | void pm_restrict_gfp_mask(void); |
235 | void pm_restore_gfp_mask(void); | |
236 | #else | |
237 | static inline void pm_restrict_gfp_mask(void) {} | |
238 | static inline void pm_restore_gfp_mask(void) {} | |
82525756 | 239 | #endif |
2f8ed1c6 AB |
240 | |
241 | #ifdef CONFIG_HIGHMEM | |
2f8ed1c6 AB |
242 | int restore_highmem(void); |
243 | #else | |
244 | static inline unsigned int count_highmem_pages(void) { return 0; } | |
245 | static inline int restore_highmem(void) { return 0; } | |
246 | #endif | |
0e7d56e3 RW |
247 | |
248 | /* | |
249 | * Suspend test levels | |
250 | */ | |
251 | enum { | |
252 | /* keep first */ | |
253 | TEST_NONE, | |
254 | TEST_CORE, | |
255 | TEST_CPUS, | |
256 | TEST_PLATFORM, | |
257 | TEST_DEVICES, | |
258 | TEST_FREEZER, | |
259 | /* keep last */ | |
260 | __TEST_AFTER_LAST | |
261 | }; | |
262 | ||
263 | #define TEST_FIRST TEST_NONE | |
264 | #define TEST_MAX (__TEST_AFTER_LAST - 1) | |
4cc79776 | 265 | |
e516a1db | 266 | #ifdef CONFIG_PM_SLEEP_DEBUG |
4cc79776 | 267 | extern int pm_test_level; |
8e6bcd9f RW |
268 | #else |
269 | #define pm_test_level (TEST_NONE) | |
270 | #endif | |
b28f5081 JB |
271 | |
272 | #ifdef CONFIG_SUSPEND_FREEZER | |
273 | static inline int suspend_freeze_processes(void) | |
274 | { | |
379e0be8 SB |
275 | int error; |
276 | ||
277 | error = freeze_processes(); | |
379e0be8 SB |
278 | /* |
279 | * freeze_processes() automatically thaws every task if freezing | |
280 | * fails. So we need not do anything extra upon error. | |
281 | */ | |
282 | if (error) | |
6f585f75 | 283 | return error; |
379e0be8 SB |
284 | |
285 | error = freeze_kernel_threads(); | |
379e0be8 SB |
286 | /* |
287 | * freeze_kernel_threads() thaws only kernel threads upon freezing | |
288 | * failure. So we have to thaw the userspace tasks ourselves. | |
289 | */ | |
290 | if (error) | |
291 | thaw_processes(); | |
292 | ||
379e0be8 | 293 | return error; |
b28f5081 JB |
294 | } |
295 | ||
296 | static inline void suspend_thaw_processes(void) | |
297 | { | |
298 | thaw_processes(); | |
299 | } | |
300 | #else | |
301 | static inline int suspend_freeze_processes(void) | |
302 | { | |
303 | return 0; | |
304 | } | |
305 | ||
306 | static inline void suspend_thaw_processes(void) | |
307 | { | |
308 | } | |
309 | #endif | |
7483b4a4 RW |
310 | |
311 | #ifdef CONFIG_PM_AUTOSLEEP | |
312 | ||
313 | /* kernel/power/autosleep.c */ | |
314 | extern int pm_autosleep_init(void); | |
315 | extern int pm_autosleep_lock(void); | |
316 | extern void pm_autosleep_unlock(void); | |
317 | extern suspend_state_t pm_autosleep_state(void); | |
318 | extern int pm_autosleep_set_state(suspend_state_t state); | |
319 | ||
320 | #else /* !CONFIG_PM_AUTOSLEEP */ | |
321 | ||
322 | static inline int pm_autosleep_init(void) { return 0; } | |
323 | static inline int pm_autosleep_lock(void) { return 0; } | |
324 | static inline void pm_autosleep_unlock(void) {} | |
325 | static inline suspend_state_t pm_autosleep_state(void) { return PM_SUSPEND_ON; } | |
326 | ||
327 | #endif /* !CONFIG_PM_AUTOSLEEP */ | |
b86ff982 RW |
328 | |
329 | #ifdef CONFIG_PM_WAKELOCKS | |
330 | ||
331 | /* kernel/power/wakelock.c */ | |
332 | extern ssize_t pm_show_wakelocks(char *buf, bool show_active); | |
333 | extern int pm_wake_lock(const char *buf); | |
334 | extern int pm_wake_unlock(const char *buf); | |
335 | ||
336 | #endif /* !CONFIG_PM_WAKELOCKS */ | |
23f62d7a RW |
337 | |
338 | static inline int pm_sleep_disable_secondary_cpus(void) | |
339 | { | |
340 | cpuidle_pause(); | |
341 | return suspend_disable_secondary_cpus(); | |
342 | } | |
343 | ||
344 | static inline void pm_sleep_enable_secondary_cpus(void) | |
345 | { | |
346 | suspend_enable_secondary_cpus(); | |
347 | cpuidle_resume(); | |
348 | } | |
9ff544fa RW |
349 | |
350 | void dpm_save_errno(int err); |