Commit | Line | Data |
---|---|---|
1da177e4 | 1 | #include <linux/suspend.h> |
3010f8ca | 2 | #include <linux/suspend_ioctls.h> |
1da177e4 | 3 | #include <linux/utsname.h> |
b28f5081 | 4 | #include <linux/freezer.h> |
1da177e4 | 5 | |
1da177e4 LT |
6 | struct swsusp_info { |
7 | struct new_utsname uts; | |
8 | u32 version_code; | |
9 | unsigned long num_physpages; | |
10 | int cpus; | |
11 | unsigned long image_pages; | |
7088a5c0 | 12 | unsigned long pages; |
6e1819d6 | 13 | unsigned long size; |
1da177e4 LT |
14 | } __attribute__((aligned(PAGE_SIZE))); |
15 | ||
d307c4a8 | 16 | #ifdef CONFIG_HIBERNATION |
ac5c24ec | 17 | /* kernel/power/snapshot.c */ |
ddeb6487 | 18 | extern void __init hibernate_reserved_size_init(void); |
ac5c24ec RW |
19 | extern void __init hibernate_image_size_init(void); |
20 | ||
d307c4a8 RW |
21 | #ifdef CONFIG_ARCH_HIBERNATION_HEADER |
22 | /* Maximum size of architecture specific data in a hibernation header */ | |
23 | #define MAX_ARCH_HEADER_SIZE (sizeof(struct new_utsname) + 4) | |
1da177e4 | 24 | |
d307c4a8 RW |
25 | extern int arch_hibernation_header_save(void *addr, unsigned int max_size); |
26 | extern int arch_hibernation_header_restore(void *addr); | |
27 | ||
28 | static inline int init_header_complete(struct swsusp_info *info) | |
29 | { | |
30 | return arch_hibernation_header_save(info, MAX_ARCH_HEADER_SIZE); | |
31 | } | |
32 | ||
33 | static inline char *check_image_kernel(struct swsusp_info *info) | |
34 | { | |
35 | return arch_hibernation_header_restore(info) ? | |
36 | "architecture specific data" : NULL; | |
37 | } | |
38 | #endif /* CONFIG_ARCH_HIBERNATION_HEADER */ | |
1da177e4 | 39 | |
56f99bcb RW |
40 | /* |
41 | * Keep some memory free so that I/O operations can succeed without paging | |
42 | * [Might this be more than 4 MB?] | |
43 | */ | |
44 | #define PAGES_FOR_IO ((4096 * 1024) >> PAGE_SHIFT) | |
d307c4a8 | 45 | |
56f99bcb RW |
46 | /* |
47 | * Keep 1 MB of memory free so that device drivers can allocate some pages in | |
48 | * their .suspend() routines without breaking the suspend to disk. | |
49 | */ | |
50 | #define SPARE_PAGES ((1024 * 1024) >> PAGE_SHIFT) | |
1da177e4 | 51 | |
8b759b84 | 52 | /* kernel/power/hibernate.c */ |
7777fab9 | 53 | extern int hibernation_snapshot(int platform_mode); |
a634cc10 | 54 | extern int hibernation_restore(int platform_mode); |
7777fab9 | 55 | extern int hibernation_platform_enter(void); |
ac5c24ec RW |
56 | |
57 | #else /* !CONFIG_HIBERNATION */ | |
58 | ||
ddeb6487 | 59 | static inline void hibernate_reserved_size_init(void) {} |
ac5c24ec RW |
60 | static inline void hibernate_image_size_init(void) {} |
61 | #endif /* !CONFIG_HIBERNATION */ | |
a6d70980 | 62 | |
49c3df6a VG |
63 | extern int pfn_is_nosave(unsigned long); |
64 | ||
1da177e4 | 65 | #define power_attr(_name) \ |
386f275f | 66 | static struct kobj_attribute _name##_attr = { \ |
1da177e4 LT |
67 | .attr = { \ |
68 | .name = __stringify(_name), \ | |
69 | .mode = 0644, \ | |
70 | }, \ | |
71 | .show = _name##_show, \ | |
72 | .store = _name##_store, \ | |
73 | } | |
74 | ||
853609b6 RW |
75 | /* Preferred image size in bytes (default 500 MB) */ |
76 | extern unsigned long image_size; | |
ddeb6487 RW |
77 | /* Size of memory reserved for drivers (default SPARE_PAGES x PAGE_SIZE) */ |
78 | extern unsigned long reserved_size; | |
f577eb30 | 79 | extern int in_suspend; |
61159a31 | 80 | extern dev_t swsusp_resume_device; |
9a154d9d | 81 | extern sector_t swsusp_resume_block; |
f577eb30 | 82 | |
25761b6e RW |
83 | extern asmlinkage int swsusp_arch_suspend(void); |
84 | extern asmlinkage int swsusp_arch_resume(void); | |
85 | ||
74dfd666 RW |
86 | extern int create_basic_memory_bitmaps(void); |
87 | extern void free_basic_memory_bitmaps(void); | |
64a473cb | 88 | extern int hibernate_preallocate_memory(void); |
f577eb30 | 89 | |
fb13a28b RW |
90 | /** |
91 | * Auxiliary structure used for reading the snapshot image data and | |
92 | * metadata from and writing them to the list of page backup entries | |
93 | * (PBEs) which is the main data structure of swsusp. | |
94 | * | |
95 | * Using struct snapshot_handle we can transfer the image, including its | |
96 | * metadata, as a continuous sequence of bytes with the help of | |
97 | * snapshot_read_next() and snapshot_write_next(). | |
98 | * | |
99 | * The code that writes the image to a storage or transfers it to | |
100 | * the user land is required to use snapshot_read_next() for this | |
101 | * purpose and it should not make any assumptions regarding the internal | |
102 | * structure of the image. Similarly, the code that reads the image from | |
103 | * a storage or transfers it from the user land is required to use | |
104 | * snapshot_write_next(). | |
105 | * | |
106 | * This may allow us to change the internal structure of the image | |
107 | * in the future with considerably less effort. | |
108 | */ | |
109 | ||
f577eb30 | 110 | struct snapshot_handle { |
fb13a28b RW |
111 | unsigned int cur; /* number of the block of PAGE_SIZE bytes the |
112 | * next operation will refer to (ie. current) | |
113 | */ | |
fb13a28b RW |
114 | void *buffer; /* address of the block to read from |
115 | * or write to | |
116 | */ | |
fb13a28b RW |
117 | int sync_read; /* Set to one to notify the caller of |
118 | * snapshot_write_next() that it may | |
119 | * need to call wait_on_bio_chain() | |
120 | */ | |
f577eb30 RW |
121 | }; |
122 | ||
fb13a28b RW |
123 | /* This macro returns the address from/to which the caller of |
124 | * snapshot_read_next()/snapshot_write_next() is allowed to | |
125 | * read/write data after the function returns | |
126 | */ | |
d3c1b24c | 127 | #define data_of(handle) ((handle).buffer) |
f577eb30 | 128 | |
b788db79 | 129 | extern unsigned int snapshot_additional_pages(struct zone *zone); |
af508b34 | 130 | extern unsigned long snapshot_get_image_size(void); |
d3c1b24c JS |
131 | extern int snapshot_read_next(struct snapshot_handle *handle); |
132 | extern int snapshot_write_next(struct snapshot_handle *handle); | |
8357376d | 133 | extern void snapshot_write_finalize(struct snapshot_handle *handle); |
b788db79 | 134 | extern int snapshot_image_loaded(struct snapshot_handle *handle); |
61159a31 | 135 | |
0709db60 RW |
136 | /* If unset, the snapshot device cannot be open. */ |
137 | extern atomic_t snapshot_device_available; | |
138 | ||
d1d241cc RW |
139 | extern sector_t alloc_swapdev_block(int swap); |
140 | extern void free_all_swap_pages(int swap); | |
141 | extern int swsusp_swap_in_use(void); | |
61159a31 | 142 | |
a634cc10 RW |
143 | /* |
144 | * Flags that can be passed from the hibernatig hernel to the "boot" kernel in | |
145 | * the image header. | |
146 | */ | |
147 | #define SF_PLATFORM_MODE 1 | |
f996fc96 | 148 | #define SF_NOCOMPRESS_MODE 2 |
081a9d04 | 149 | #define SF_CRC32_MODE 4 |
a634cc10 | 150 | |
8b759b84 | 151 | /* kernel/power/hibernate.c */ |
74c7e2ef | 152 | extern int swsusp_check(void); |
74c7e2ef | 153 | extern void swsusp_free(void); |
a634cc10 RW |
154 | extern int swsusp_read(unsigned int *flags_p); |
155 | extern int swsusp_write(unsigned int flags); | |
c2dd0dae | 156 | extern void swsusp_close(fmode_t); |
0d3a9abe | 157 | |
8a0d613f JS |
158 | /* kernel/power/block_io.c */ |
159 | extern struct block_device *hib_resume_bdev; | |
160 | ||
161 | extern int hib_bio_read_page(pgoff_t page_off, void *addr, | |
162 | struct bio **bio_chain); | |
163 | extern int hib_bio_write_page(pgoff_t page_off, void *addr, | |
164 | struct bio **bio_chain); | |
165 | extern int hib_wait_on_bio_chain(struct bio **bio_chain); | |
166 | ||
0d3a9abe | 167 | struct timeval; |
b10d9117 | 168 | /* kernel/power/swsusp.c */ |
0d3a9abe RW |
169 | extern void swsusp_show_speed(struct timeval *, struct timeval *, |
170 | unsigned int, char *); | |
b10d9117 | 171 | |
296699de | 172 | #ifdef CONFIG_SUSPEND |
a9d70523 RW |
173 | /* kernel/power/suspend.c */ |
174 | extern const char *const pm_states[]; | |
175 | ||
176 | extern bool valid_state(suspend_state_t state); | |
6c961dfb | 177 | extern int suspend_devices_and_enter(suspend_state_t state); |
a9d70523 | 178 | extern int enter_state(suspend_state_t state); |
296699de RW |
179 | #else /* !CONFIG_SUSPEND */ |
180 | static inline int suspend_devices_and_enter(suspend_state_t state) | |
181 | { | |
182 | return -ENOSYS; | |
183 | } | |
a9d70523 RW |
184 | static inline int enter_state(suspend_state_t state) { return -ENOSYS; } |
185 | static inline bool valid_state(suspend_state_t state) { return false; } | |
296699de RW |
186 | #endif /* !CONFIG_SUSPEND */ |
187 | ||
a9d70523 RW |
188 | #ifdef CONFIG_PM_TEST_SUSPEND |
189 | /* kernel/power/suspend_test.c */ | |
190 | extern void suspend_test_start(void); | |
191 | extern void suspend_test_finish(const char *label); | |
192 | #else /* !CONFIG_PM_TEST_SUSPEND */ | |
193 | static inline void suspend_test_start(void) {} | |
194 | static inline void suspend_test_finish(const char *label) {} | |
195 | #endif /* !CONFIG_PM_TEST_SUSPEND */ | |
196 | ||
82525756 AS |
197 | #ifdef CONFIG_PM_SLEEP |
198 | /* kernel/power/main.c */ | |
199 | extern int pm_notifier_call_chain(unsigned long val); | |
200 | #endif | |
2f8ed1c6 AB |
201 | |
202 | #ifdef CONFIG_HIGHMEM | |
2f8ed1c6 AB |
203 | int restore_highmem(void); |
204 | #else | |
205 | static inline unsigned int count_highmem_pages(void) { return 0; } | |
206 | static inline int restore_highmem(void) { return 0; } | |
207 | #endif | |
0e7d56e3 RW |
208 | |
209 | /* | |
210 | * Suspend test levels | |
211 | */ | |
212 | enum { | |
213 | /* keep first */ | |
214 | TEST_NONE, | |
215 | TEST_CORE, | |
216 | TEST_CPUS, | |
217 | TEST_PLATFORM, | |
218 | TEST_DEVICES, | |
219 | TEST_FREEZER, | |
220 | /* keep last */ | |
221 | __TEST_AFTER_LAST | |
222 | }; | |
223 | ||
224 | #define TEST_FIRST TEST_NONE | |
225 | #define TEST_MAX (__TEST_AFTER_LAST - 1) | |
4cc79776 RW |
226 | |
227 | extern int pm_test_level; | |
b28f5081 JB |
228 | |
229 | #ifdef CONFIG_SUSPEND_FREEZER | |
230 | static inline int suspend_freeze_processes(void) | |
231 | { | |
2aede851 RW |
232 | int error = freeze_processes(); |
233 | return error ? : freeze_kernel_threads(); | |
b28f5081 JB |
234 | } |
235 | ||
236 | static inline void suspend_thaw_processes(void) | |
237 | { | |
238 | thaw_processes(); | |
239 | } | |
240 | #else | |
241 | static inline int suspend_freeze_processes(void) | |
242 | { | |
243 | return 0; | |
244 | } | |
245 | ||
246 | static inline void suspend_thaw_processes(void) | |
247 | { | |
248 | } | |
249 | #endif |