1 #include <linux/suspend.h>
2 #include <linux/suspend_ioctls.h>
3 #include <linux/utsname.h>
4 #include <linux/freezer.h>
5
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;
12 unsigned long pages;
13 unsigned long size;
14 } __attribute__((aligned(PAGE_SIZE)));
15
16 #ifdef CONFIG_HIBERNATION
17 #ifdef CONFIG_ARCH_HIBERNATION_HEADER
18 /* Maximum size of architecture specific data in a hibernation header */
19 #define MAX_ARCH_HEADER_SIZE (sizeof(struct new_utsname) + 4)
20
21 extern int arch_hibernation_header_save(void *addr, unsigned int max_size);
22 extern int arch_hibernation_header_restore(void *addr);
23
init_header_complete(struct swsusp_info * info)24 static inline int init_header_complete(struct swsusp_info *info)
25 {
26 return arch_hibernation_header_save(info, MAX_ARCH_HEADER_SIZE);
27 }
28
check_image_kernel(struct swsusp_info * info)29 static inline char *check_image_kernel(struct swsusp_info *info)
30 {
31 return arch_hibernation_header_restore(info) ?
32 "architecture specific data" : NULL;
33 }
34 #endif /* CONFIG_ARCH_HIBERNATION_HEADER */
35
36 /*
37 * Keep some memory free so that I/O operations can succeed without paging
38 * [Might this be more than 4 MB?]
39 */
40 #define PAGES_FOR_IO ((4096 * 1024) >> PAGE_SHIFT)
41
42 /*
43 * Keep 1 MB of memory free so that device drivers can allocate some pages in
44 * their .suspend() routines without breaking the suspend to disk.
45 */
46 #define SPARE_PAGES ((1024 * 1024) >> PAGE_SHIFT)
47
48 /* kernel/power/disk.c */
49 extern int hibernation_snapshot(int platform_mode);
50 extern int hibernation_restore(int platform_mode);
51 extern int hibernation_platform_enter(void);
52 #endif
53
54 extern int pfn_is_nosave(unsigned long);
55
56 #define power_attr(_name) \
57 static struct kobj_attribute _name##_attr = { \
58 .attr = { \
59 .name = __stringify(_name), \
60 .mode = 0644, \
61 }, \
62 .show = _name##_show, \
63 .store = _name##_store, \
64 }
65
66 /* Preferred image size in bytes (default 500 MB) */
67 extern unsigned long image_size;
68 extern int in_suspend;
69 extern dev_t swsusp_resume_device;
70 extern sector_t swsusp_resume_block;
71
72 extern asmlinkage int swsusp_arch_suspend(void);
73 extern asmlinkage int swsusp_arch_resume(void);
74
75 extern int create_basic_memory_bitmaps(void);
76 extern void free_basic_memory_bitmaps(void);
77 extern unsigned int count_data_pages(void);
78
79 /**
80 * Auxiliary structure used for reading the snapshot image data and
81 * metadata from and writing them to the list of page backup entries
82 * (PBEs) which is the main data structure of swsusp.
83 *
84 * Using struct snapshot_handle we can transfer the image, including its
85 * metadata, as a continuous sequence of bytes with the help of
86 * snapshot_read_next() and snapshot_write_next().
87 *
88 * The code that writes the image to a storage or transfers it to
89 * the user land is required to use snapshot_read_next() for this
90 * purpose and it should not make any assumptions regarding the internal
91 * structure of the image. Similarly, the code that reads the image from
92 * a storage or transfers it from the user land is required to use
93 * snapshot_write_next().
94 *
95 * This may allow us to change the internal structure of the image
96 * in the future with considerably less effort.
97 */
98
99 struct snapshot_handle {
100 loff_t offset; /* number of the last byte ready for reading
101 * or writing in the sequence
102 */
103 unsigned int cur; /* number of the block of PAGE_SIZE bytes the
104 * next operation will refer to (ie. current)
105 */
106 unsigned int cur_offset; /* offset with respect to the current
107 * block (for the next operation)
108 */
109 unsigned int prev; /* number of the block of PAGE_SIZE bytes that
110 * was the current one previously
111 */
112 void *buffer; /* address of the block to read from
113 * or write to
114 */
115 unsigned int buf_offset; /* location to read from or write to,
116 * given as a displacement from 'buffer'
117 */
118 int sync_read; /* Set to one to notify the caller of
119 * snapshot_write_next() that it may
120 * need to call wait_on_bio_chain()
121 */
122 };
123
124 /* This macro returns the address from/to which the caller of
125 * snapshot_read_next()/snapshot_write_next() is allowed to
126 * read/write data after the function returns
127 */
128 #define data_of(handle) ((handle).buffer + (handle).buf_offset)
129
130 extern unsigned int snapshot_additional_pages(struct zone *zone);
131 extern unsigned long snapshot_get_image_size(void);
132 extern int snapshot_read_next(struct snapshot_handle *handle, size_t count);
133 extern int snapshot_write_next(struct snapshot_handle *handle, size_t count);
134 extern void snapshot_write_finalize(struct snapshot_handle *handle);
135 extern int snapshot_image_loaded(struct snapshot_handle *handle);
136
137 /* If unset, the snapshot device cannot be open. */
138 extern atomic_t snapshot_device_available;
139
140 extern sector_t alloc_swapdev_block(int swap);
141 extern void free_all_swap_pages(int swap);
142 extern int swsusp_swap_in_use(void);
143
144 /*
145 * Flags that can be passed from the hibernatig hernel to the "boot" kernel in
146 * the image header.
147 */
148 #define SF_PLATFORM_MODE 1
149
150 /* kernel/power/disk.c */
151 extern int swsusp_check(void);
152 extern int swsusp_shrink_memory(void);
153 extern void swsusp_free(void);
154 extern int swsusp_read(unsigned int *flags_p);
155 extern int swsusp_write(unsigned int flags);
156 extern void swsusp_close(fmode_t);
157
158 struct timeval;
159 /* kernel/power/swsusp.c */
160 extern void swsusp_show_speed(struct timeval *, struct timeval *,
161 unsigned int, char *);
162
163 #ifdef CONFIG_SUSPEND
164 /* kernel/power/main.c */
165 extern int suspend_devices_and_enter(suspend_state_t state);
166 #else /* !CONFIG_SUSPEND */
suspend_devices_and_enter(suspend_state_t state)167 static inline int suspend_devices_and_enter(suspend_state_t state)
168 {
169 return -ENOSYS;
170 }
171 #endif /* !CONFIG_SUSPEND */
172
173 #ifdef CONFIG_PM_SLEEP
174 /* kernel/power/main.c */
175 extern int pm_notifier_call_chain(unsigned long val);
176 #endif
177
178 #ifdef CONFIG_HIGHMEM
179 unsigned int count_highmem_pages(void);
180 int restore_highmem(void);
181 #else
count_highmem_pages(void)182 static inline unsigned int count_highmem_pages(void) { return 0; }
restore_highmem(void)183 static inline int restore_highmem(void) { return 0; }
184 #endif
185
186 /*
187 * Suspend test levels
188 */
189 enum {
190 /* keep first */
191 TEST_NONE,
192 TEST_CORE,
193 TEST_CPUS,
194 TEST_PLATFORM,
195 TEST_DEVICES,
196 TEST_FREEZER,
197 /* keep last */
198 __TEST_AFTER_LAST
199 };
200
201 #define TEST_FIRST TEST_NONE
202 #define TEST_MAX (__TEST_AFTER_LAST - 1)
203
204 extern int pm_test_level;
205
206 #ifdef CONFIG_SUSPEND_FREEZER
suspend_freeze_processes(void)207 static inline int suspend_freeze_processes(void)
208 {
209 return freeze_processes();
210 }
211
suspend_thaw_processes(void)212 static inline void suspend_thaw_processes(void)
213 {
214 thaw_processes();
215 }
216 #else
suspend_freeze_processes(void)217 static inline int suspend_freeze_processes(void)
218 {
219 return 0;
220 }
221
suspend_thaw_processes(void)222 static inline void suspend_thaw_processes(void)
223 {
224 }
225 #endif
226
227 #ifdef CONFIG_WAKELOCK
228 /* kernel/power/wakelock.c */
229 extern struct workqueue_struct *suspend_work_queue;
230 extern struct wake_lock main_wake_lock;
231 extern suspend_state_t requested_suspend_state;
232 #endif
233
234 #ifdef CONFIG_USER_WAKELOCK
235 ssize_t wake_lock_show(struct kobject *kobj, struct kobj_attribute *attr,
236 char *buf);
237 ssize_t wake_lock_store(struct kobject *kobj, struct kobj_attribute *attr,
238 const char *buf, size_t n);
239 ssize_t wake_unlock_show(struct kobject *kobj, struct kobj_attribute *attr,
240 char *buf);
241 ssize_t wake_unlock_store(struct kobject *kobj, struct kobj_attribute *attr,
242 const char *buf, size_t n);
243 #endif
244
245 #ifdef CONFIG_EARLYSUSPEND
246 /* kernel/power/earlysuspend.c */
247 void request_suspend_state(suspend_state_t state);
248 suspend_state_t get_suspend_state(void);
249 #endif
250