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