[linux.git] / kernel / power / power.h

#include <linux/suspend.h>
#include <linux/suspend_ioctls.h>
#include <linux/utsname.h>
#include <linux/freezer.h>

struct swsusp_info {
	struct new_utsname	uts;
	u32			version_code;
	unsigned long		num_physpages;
	int			cpus;
	unsigned long		image_pages;
	unsigned long		pages;
	unsigned long		size;
} __attribute__((aligned(PAGE_SIZE)));

#ifdef CONFIG_HIBERNATION
#ifdef CONFIG_ARCH_HIBERNATION_HEADER
/* Maximum size of architecture specific data in a hibernation header */
#define MAX_ARCH_HEADER_SIZE	(sizeof(struct new_utsname) + 4)

extern int arch_hibernation_header_save(void *addr, unsigned int max_size);
extern int arch_hibernation_header_restore(void *addr);

static inline int init_header_complete(struct swsusp_info *info)
{
	return arch_hibernation_header_save(info, MAX_ARCH_HEADER_SIZE);
}

static inline char *check_image_kernel(struct swsusp_info *info)
{
	return arch_hibernation_header_restore(info) ?
			"architecture specific data" : NULL;
}
#endif /* CONFIG_ARCH_HIBERNATION_HEADER */

/*
 * Keep some memory free so that I/O operations can succeed without paging
 * [Might this be more than 4 MB?]
 */
#define PAGES_FOR_IO	((4096 * 1024) >> PAGE_SHIFT)

/*
 * Keep 1 MB of memory free so that device drivers can allocate some pages in
 * their .suspend() routines without breaking the suspend to disk.
 */
#define SPARE_PAGES	((1024 * 1024) >> PAGE_SHIFT)

/* kernel/power/hibernate.c */
extern int hibernation_snapshot(int platform_mode);
extern int hibernation_restore(int platform_mode);
extern int hibernation_platform_enter(void);
#endif

extern int pfn_is_nosave(unsigned long);

#define power_attr(_name) \
static struct kobj_attribute _name##_attr = {	\
	.attr	= {				\
		.name = __stringify(_name),	\
		.mode = 0644,			\
	},					\
	.show	= _name##_show,			\
	.store	= _name##_store,		\
}

/* Preferred image size in bytes (default 500 MB) */
extern unsigned long image_size;
extern int in_suspend;
extern dev_t swsusp_resume_device;
extern sector_t swsusp_resume_block;

extern asmlinkage int swsusp_arch_suspend(void);
extern asmlinkage int swsusp_arch_resume(void);

extern int create_basic_memory_bitmaps(void);
extern void free_basic_memory_bitmaps(void);
extern int hibernate_preallocate_memory(void);

/**
 *	Auxiliary structure used for reading the snapshot image data and
 *	metadata from and writing them to the list of page backup entries
 *	(PBEs) which is the main data structure of swsusp.
 *
 *	Using struct snapshot_handle we can transfer the image, including its
 *	metadata, as a continuous sequence of bytes with the help of
 *	snapshot_read_next() and snapshot_write_next().
 *
 *	The code that writes the image to a storage or transfers it to
 *	the user land is required to use snapshot_read_next() for this
 *	purpose and it should not make any assumptions regarding the internal
 *	structure of the image.  Similarly, the code that reads the image from
 *	a storage or transfers it from the user land is required to use
 *	snapshot_write_next().
 *
 *	This may allow us to change the internal structure of the image
 *	in the future with considerably less effort.
 */

struct snapshot_handle {
	loff_t		offset;	/* number of the last byte ready for reading
				 * or writing in the sequence
				 */
	unsigned int	cur;	/* number of the block of PAGE_SIZE bytes the
				 * next operation will refer to (ie. current)
				 */
	unsigned int	cur_offset;	/* offset with respect to the current
					 * block (for the next operation)
					 */
	unsigned int	prev;	/* number of the block of PAGE_SIZE bytes that
				 * was the current one previously
				 */
	void		*buffer;	/* address of the block to read from
					 * or write to
					 */
	unsigned int	buf_offset;	/* location to read from or write to,
					 * given as a displacement from 'buffer'
					 */
	int		sync_read;	/* Set to one to notify the caller of
					 * snapshot_write_next() that it may
					 * need to call wait_on_bio_chain()
					 */
};

/* This macro returns the address from/to which the caller of
 * snapshot_read_next()/snapshot_write_next() is allowed to
 * read/write data after the function returns
 */
#define data_of(handle)	((handle).buffer + (handle).buf_offset)

extern unsigned int snapshot_additional_pages(struct zone *zone);
extern unsigned long snapshot_get_image_size(void);
extern int snapshot_read_next(struct snapshot_handle *handle, size_t count);
extern int snapshot_write_next(struct snapshot_handle *handle, size_t count);
extern void snapshot_write_finalize(struct snapshot_handle *handle);
extern int snapshot_image_loaded(struct snapshot_handle *handle);

/* If unset, the snapshot device cannot be open. */
extern atomic_t snapshot_device_available;

extern sector_t alloc_swapdev_block(int swap);
extern void free_all_swap_pages(int swap);
extern int swsusp_swap_in_use(void);

/*
 * Flags that can be passed from the hibernatig hernel to the "boot" kernel in
 * the image header.
 */
#define SF_PLATFORM_MODE	1

/* kernel/power/hibernate.c */
extern int swsusp_check(void);
extern void swsusp_free(void);
extern int swsusp_read(unsigned int *flags_p);
extern int swsusp_write(unsigned int flags);
extern void swsusp_close(fmode_t);

struct timeval;
/* kernel/power/swsusp.c */
extern void swsusp_show_speed(struct timeval *, struct timeval *,
				unsigned int, char *);

#ifdef CONFIG_SUSPEND
/* kernel/power/suspend.c */
extern const char *const pm_states[];

extern bool valid_state(suspend_state_t state);
extern int suspend_devices_and_enter(suspend_state_t state);
extern int enter_state(suspend_state_t state);
#else /* !CONFIG_SUSPEND */
static inline int suspend_devices_and_enter(suspend_state_t state)
{
	return -ENOSYS;
}
static inline int enter_state(suspend_state_t state) { return -ENOSYS; }
static inline bool valid_state(suspend_state_t state) { return false; }
#endif /* !CONFIG_SUSPEND */

#ifdef CONFIG_PM_TEST_SUSPEND
/* kernel/power/suspend_test.c */
extern void suspend_test_start(void);
extern void suspend_test_finish(const char *label);
#else /* !CONFIG_PM_TEST_SUSPEND */
static inline void suspend_test_start(void) {}
static inline void suspend_test_finish(const char *label) {}
#endif /* !CONFIG_PM_TEST_SUSPEND */

#ifdef CONFIG_PM_SLEEP
/* kernel/power/main.c */
extern int pm_notifier_call_chain(unsigned long val);
#endif

#ifdef CONFIG_HIGHMEM
int restore_highmem(void);
#else
static inline unsigned int count_highmem_pages(void) { return 0; }
static inline int restore_highmem(void) { return 0; }
#endif

/*
 * Suspend test levels
 */
enum {
	/* keep first */
	TEST_NONE,
	TEST_CORE,
	TEST_CPUS,
	TEST_PLATFORM,
	TEST_DEVICES,
	TEST_FREEZER,
	/* keep last */
	__TEST_AFTER_LAST
};

#define TEST_FIRST	TEST_NONE
#define TEST_MAX	(__TEST_AFTER_LAST - 1)

extern int pm_test_level;

#ifdef CONFIG_SUSPEND_FREEZER
static inline int suspend_freeze_processes(void)
{
	return freeze_processes();
}

static inline void suspend_thaw_processes(void)
{
	thaw_processes();
}
#else
static inline int suspend_freeze_processes(void)
{
	return 0;
}

static inline void suspend_thaw_processes(void)
{
}
#endif
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)));
1da177e4 LT	15
d307c4a8 RW	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)
1da177e4	20
d307c4a8 RW	21	extern int arch_hibernation_header_save(void *addr, unsigned int max_size);
	22	extern int arch_hibernation_header_restore(void *addr);
	23
	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
	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 */
1da177e4	35
56f99bcb RW	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)
d307c4a8	41
56f99bcb RW	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)
1da177e4	47
8b759b84	48	/* kernel/power/hibernate.c */
7777fab9	49	extern int hibernation_snapshot(int platform_mode);
a634cc10	50	extern int hibernation_restore(int platform_mode);
7777fab9	51	extern int hibernation_platform_enter(void);
1da177e4	52	#endif
a6d70980	53
49c3df6a VG	54	extern int pfn_is_nosave(unsigned long);
49c3df6a VG	55
1da177e4	56	#define power_attr(_name) \
386f275f	57	static struct kobj_attribute _name##_attr = { \
1da177e4 LT	58	.attr = { \
	59	.name = __stringify(_name), \
	60	.mode = 0644, \
	61	}, \
	62	.show = _name##_show, \
	63	.store = _name##_store, \
	64	}
	65
853609b6 RW	66	/* Preferred image size in bytes (default 500 MB) */
853609b6 RW	67	extern unsigned long image_size;
f577eb30	68	extern int in_suspend;
61159a31	69	extern dev_t swsusp_resume_device;
9a154d9d	70	extern sector_t swsusp_resume_block;
f577eb30	71
25761b6e RW	72	extern asmlinkage int swsusp_arch_suspend(void);
	73	extern asmlinkage int swsusp_arch_resume(void);
	74
74dfd666 RW	75	extern int create_basic_memory_bitmaps(void);
74dfd666 RW	76	extern void free_basic_memory_bitmaps(void);
64a473cb	77	extern int hibernate_preallocate_memory(void);
f577eb30	78
fb13a28b RW	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
f577eb30	99	struct snapshot_handle {
fb13a28b RW	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	*/
fb13a28b RW	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	*/
f577eb30 RW	122	};
f577eb30 RW	123
fb13a28b RW	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	*/
f577eb30 RW	128	#define data_of(handle) ((handle).buffer + (handle).buf_offset)
f577eb30 RW	129
b788db79	130	extern unsigned int snapshot_additional_pages(struct zone *zone);
af508b34	131	extern unsigned long snapshot_get_image_size(void);
f577eb30 RW	132	extern int snapshot_read_next(struct snapshot_handle *handle, size_t count);
f577eb30 RW	133	extern int snapshot_write_next(struct snapshot_handle *handle, size_t count);
8357376d	134	extern void snapshot_write_finalize(struct snapshot_handle *handle);
b788db79	135	extern int snapshot_image_loaded(struct snapshot_handle *handle);
61159a31	136
0709db60 RW	137	/* If unset, the snapshot device cannot be open. */
	138	extern atomic_t snapshot_device_available;
	139
d1d241cc RW	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);
61159a31	143
a634cc10 RW	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
8b759b84	150	/* kernel/power/hibernate.c */
74c7e2ef	151	extern int swsusp_check(void);
74c7e2ef	152	extern void swsusp_free(void);
a634cc10 RW	153	extern int swsusp_read(unsigned int *flags_p);
a634cc10 RW	154	extern int swsusp_write(unsigned int flags);
c2dd0dae	155	extern void swsusp_close(fmode_t);
0d3a9abe RW	156
0d3a9abe RW	157	struct timeval;
b10d9117	158	/* kernel/power/swsusp.c */
0d3a9abe RW	159	extern void swsusp_show_speed(struct timeval , struct timeval ,
0d3a9abe RW	160	unsigned int, char *);
b10d9117	161
296699de	162	#ifdef CONFIG_SUSPEND
a9d70523 RW	163	/* kernel/power/suspend.c */
	164	extern const char *const pm_states[];
	165
	166	extern bool valid_state(suspend_state_t state);
6c961dfb	167	extern int suspend_devices_and_enter(suspend_state_t state);
a9d70523	168	extern int enter_state(suspend_state_t state);
296699de RW	169	#else /* !CONFIG_SUSPEND */
	170	static inline int suspend_devices_and_enter(suspend_state_t state)
	171	{
	172	return -ENOSYS;
	173	}
a9d70523 RW	174	static inline int enter_state(suspend_state_t state) { return -ENOSYS; }
a9d70523 RW	175	static inline bool valid_state(suspend_state_t state) { return false; }
296699de RW	176	#endif /* !CONFIG_SUSPEND */
296699de RW	177
a9d70523 RW	178	#ifdef CONFIG_PM_TEST_SUSPEND
	179	/* kernel/power/suspend_test.c */
	180	extern void suspend_test_start(void);
	181	extern void suspend_test_finish(const char *label);
	182	#else /* !CONFIG_PM_TEST_SUSPEND */
	183	static inline void suspend_test_start(void) {}
	184	static inline void suspend_test_finish(const char *label) {}
	185	#endif /* !CONFIG_PM_TEST_SUSPEND */
	186
82525756 AS	187	#ifdef CONFIG_PM_SLEEP
	188	/* kernel/power/main.c */
	189	extern int pm_notifier_call_chain(unsigned long val);
	190	#endif
2f8ed1c6 AB	191
2f8ed1c6 AB	192	#ifdef CONFIG_HIGHMEM
2f8ed1c6 AB	193	int restore_highmem(void);
	194	#else
	195	static inline unsigned int count_highmem_pages(void) { return 0; }
	196	static inline int restore_highmem(void) { return 0; }
	197	#endif
0e7d56e3 RW	198
	199	/*
	200	* Suspend test levels
	201	*/
	202	enum {
	203	/* keep first */
	204	TEST_NONE,
	205	TEST_CORE,
	206	TEST_CPUS,
	207	TEST_PLATFORM,
	208	TEST_DEVICES,
	209	TEST_FREEZER,
	210	/* keep last */
	211	__TEST_AFTER_LAST
	212	};
	213
	214	#define TEST_FIRST TEST_NONE
	215	#define TEST_MAX (__TEST_AFTER_LAST - 1)
4cc79776 RW	216
4cc79776 RW	217	extern int pm_test_level;
b28f5081 JB	218
	219	#ifdef CONFIG_SUSPEND_FREEZER
	220	static inline int suspend_freeze_processes(void)
	221	{
	222	return freeze_processes();
	223	}
	224
	225	static inline void suspend_thaw_processes(void)
	226	{
	227	thaw_processes();
	228	}
	229	#else
	230	static inline int suspend_freeze_processes(void)
	231	{
	232	return 0;
	233	}
	234
	235	static inline void suspend_thaw_processes(void)
	236	{
	237	}
	238	#endif