1#include <linux/suspend.h>
  2#include <linux/suspend_ioctls.h>
  3#include <linux/utsname.h>
  4#include <linux/freezer.h>
 
  5
  6struct 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/* kernel/power/snapshot.c */
 18extern void __init hibernate_reserved_size_init(void);
 19extern void __init hibernate_image_size_init(void);
 20
 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)
 24
 25extern int arch_hibernation_header_save(void *addr, unsigned int max_size);
 26extern int arch_hibernation_header_restore(void *addr);
 27
 28static inline int init_header_complete(struct swsusp_info *info)
 29{
 30	return arch_hibernation_header_save(info, MAX_ARCH_HEADER_SIZE);
 31}
 32
 33static 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 */
 39
 
 
 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)
 45
 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)
 51
 
 
 52/* kernel/power/hibernate.c */
 
 
 53extern int hibernation_snapshot(int platform_mode);
 54extern int hibernation_restore(int platform_mode);
 55extern int hibernation_platform_enter(void);
 56
 
 
 
 
 
 
 
 57#else /* !CONFIG_HIBERNATION */
 58
 59static inline void hibernate_reserved_size_init(void) {}
 60static inline void hibernate_image_size_init(void) {}
 61#endif /* !CONFIG_HIBERNATION */
 62
 63extern int pfn_is_nosave(unsigned long);
 64
 65#define power_attr(_name) \
 66static struct kobj_attribute _name##_attr = {	\
 67	.attr	= {				\
 68		.name = __stringify(_name),	\
 69		.mode = 0644,			\
 70	},					\
 71	.show	= _name##_show,			\
 72	.store	= _name##_store,		\
 73}
 74
 
 
 
 
 
 
 
 
 
 75/* Preferred image size in bytes (default 500 MB) */
 76extern unsigned long image_size;
 77/* Size of memory reserved for drivers (default SPARE_PAGES x PAGE_SIZE) */
 78extern unsigned long reserved_size;
 79extern int in_suspend;
 80extern dev_t swsusp_resume_device;
 81extern sector_t swsusp_resume_block;
 82
 83extern asmlinkage int swsusp_arch_suspend(void);
 84extern asmlinkage int swsusp_arch_resume(void);
 85
 86extern int create_basic_memory_bitmaps(void);
 87extern void free_basic_memory_bitmaps(void);
 88extern int hibernate_preallocate_memory(void);
 89
 
 
 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
110struct snapshot_handle {
111	unsigned int	cur;	/* number of the block of PAGE_SIZE bytes the
112				 * next operation will refer to (ie. current)
113				 */
114	void		*buffer;	/* address of the block to read from
115					 * or write to
116					 */
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					 */
121};
122
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 */
127#define data_of(handle)	((handle).buffer)
128
129extern unsigned int snapshot_additional_pages(struct zone *zone);
130extern unsigned long snapshot_get_image_size(void);
131extern int snapshot_read_next(struct snapshot_handle *handle);
132extern int snapshot_write_next(struct snapshot_handle *handle);
133extern void snapshot_write_finalize(struct snapshot_handle *handle);
134extern int snapshot_image_loaded(struct snapshot_handle *handle);
135
136/* If unset, the snapshot device cannot be open. */
137extern atomic_t snapshot_device_available;
138
139extern sector_t alloc_swapdev_block(int swap);
140extern void free_all_swap_pages(int swap);
141extern int swsusp_swap_in_use(void);
142
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
148#define SF_NOCOMPRESS_MODE	2
 
149
150/* kernel/power/hibernate.c */
151extern int swsusp_check(void);
152extern void swsusp_free(void);
153extern int swsusp_read(unsigned int *flags_p);
154extern int swsusp_write(unsigned int flags);
155extern void swsusp_close(fmode_t);
156
157/* kernel/power/block_io.c */
158extern struct block_device *hib_resume_bdev;
159
160extern int hib_bio_read_page(pgoff_t page_off, void *addr,
161		struct bio **bio_chain);
162extern int hib_bio_write_page(pgoff_t page_off, void *addr,
163		struct bio **bio_chain);
164extern int hib_wait_on_bio_chain(struct bio **bio_chain);
165
166struct timeval;
167/* kernel/power/swsusp.c */
168extern void swsusp_show_speed(struct timeval *, struct timeval *,
169				unsigned int, char *);
170
171#ifdef CONFIG_SUSPEND
172/* kernel/power/suspend.c */
173extern const char *const pm_states[];
 
 
 
174
175extern bool valid_state(suspend_state_t state);
176extern int suspend_devices_and_enter(suspend_state_t state);
177extern int enter_state(suspend_state_t state);
178#else /* !CONFIG_SUSPEND */
 
 
179static inline int suspend_devices_and_enter(suspend_state_t state)
180{
181	return -ENOSYS;
182}
183static inline int enter_state(suspend_state_t state) { return -ENOSYS; }
184static inline bool valid_state(suspend_state_t state) { return false; }
185#endif /* !CONFIG_SUSPEND */
186
187#ifdef CONFIG_PM_TEST_SUSPEND
188/* kernel/power/suspend_test.c */
189extern void suspend_test_start(void);
190extern void suspend_test_finish(const char *label);
191#else /* !CONFIG_PM_TEST_SUSPEND */
192static inline void suspend_test_start(void) {}
193static inline void suspend_test_finish(const char *label) {}
194#endif /* !CONFIG_PM_TEST_SUSPEND */
195
196#ifdef CONFIG_PM_SLEEP
197/* kernel/power/main.c */
 
 
198extern int pm_notifier_call_chain(unsigned long val);
199#endif
200
201#ifdef CONFIG_HIGHMEM
202int restore_highmem(void);
203#else
204static inline unsigned int count_highmem_pages(void) { return 0; }
205static inline int restore_highmem(void) { return 0; }
206#endif
207
208/*
209 * Suspend test levels
210 */
211enum {
212	/* keep first */
213	TEST_NONE,
214	TEST_CORE,
215	TEST_CPUS,
216	TEST_PLATFORM,
217	TEST_DEVICES,
218	TEST_FREEZER,
219	/* keep last */
220	__TEST_AFTER_LAST
221};
222
223#define TEST_FIRST	TEST_NONE
224#define TEST_MAX	(__TEST_AFTER_LAST - 1)
225
226extern int pm_test_level;
227
228#ifdef CONFIG_SUSPEND_FREEZER
229static inline int suspend_freeze_processes(void)
230{
231	return freeze_processes();
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
232}
233
234static inline void suspend_thaw_processes(void)
235{
236	thaw_processes();
237}
238#else
239static inline int suspend_freeze_processes(void)
240{
241	return 0;
242}
243
244static inline void suspend_thaw_processes(void)
245{
246}
247#endif

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