[deliverable/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/disk.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);

extern struct mutex pm_mutex;

#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 unsigned int count_data_pages(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/disk.c */
extern int swsusp_check(void);
extern int swsusp_shrink_memory(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(void);

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

#ifdef CONFIG_SUSPEND
/* kernel/power/main.c */
extern int suspend_devices_and_enter(suspend_state_t state);
#else /* !CONFIG_SUSPEND */
static inline int suspend_devices_and_enter(suspend_state_t state)
{
	return -ENOSYS;
}
#endif /* !CONFIG_SUSPEND */

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

#ifdef CONFIG_HIGHMEM
unsigned int count_highmem_pages(void);
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
7777fab9 RW	48	/* kernel/power/disk.c */
7777fab9 RW	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
a6d70980 SH	56	extern struct mutex pm_mutex;
a6d70980 SH	57
1da177e4	58	#define power_attr(_name) \
386f275f	59	static struct kobj_attribute _name##_attr = { \
1da177e4 LT	60	.attr = { \
	61	.name = __stringify(_name), \
	62	.mode = 0644, \
	63	}, \
	64	.show = _name##_show, \
	65	.store = _name##_store, \
	66	}
	67
853609b6 RW	68	/* Preferred image size in bytes (default 500 MB) */
853609b6 RW	69	extern unsigned long image_size;
f577eb30	70	extern int in_suspend;
61159a31	71	extern dev_t swsusp_resume_device;
9a154d9d	72	extern sector_t swsusp_resume_block;
f577eb30	73
25761b6e RW	74	extern asmlinkage int swsusp_arch_suspend(void);
	75	extern asmlinkage int swsusp_arch_resume(void);
	76
74dfd666 RW	77	extern int create_basic_memory_bitmaps(void);
74dfd666 RW	78	extern void free_basic_memory_bitmaps(void);
72a97e08	79	extern unsigned int count_data_pages(void);
f577eb30	80
fb13a28b RW	81	/**
	82	* Auxiliary structure used for reading the snapshot image data and
	83	* metadata from and writing them to the list of page backup entries
	84	* (PBEs) which is the main data structure of swsusp.
	85	*
	86	* Using struct snapshot_handle we can transfer the image, including its
	87	* metadata, as a continuous sequence of bytes with the help of
	88	* snapshot_read_next() and snapshot_write_next().
	89	*
	90	* The code that writes the image to a storage or transfers it to
	91	* the user land is required to use snapshot_read_next() for this
	92	* purpose and it should not make any assumptions regarding the internal
	93	* structure of the image. Similarly, the code that reads the image from
	94	* a storage or transfers it from the user land is required to use
	95	* snapshot_write_next().
	96	*
	97	* This may allow us to change the internal structure of the image
	98	* in the future with considerably less effort.
	99	*/
	100
f577eb30	101	struct snapshot_handle {
fb13a28b RW	102	loff_t offset; /* number of the last byte ready for reading
	103	* or writing in the sequence
	104	*/
	105	unsigned int cur; /* number of the block of PAGE_SIZE bytes the
	106	* next operation will refer to (ie. current)
	107	*/
	108	unsigned int cur_offset; /* offset with respect to the current
	109	* block (for the next operation)
	110	*/
	111	unsigned int prev; /* number of the block of PAGE_SIZE bytes that
	112	* was the current one previously
	113	*/
fb13a28b RW	114	void buffer; / address of the block to read from
	115	* or write to
	116	*/
	117	unsigned int buf_offset; /* location to read from or write to,
	118	* given as a displacement from 'buffer'
	119	*/
	120	int sync_read; /* Set to one to notify the caller of
	121	* snapshot_write_next() that it may
	122	* need to call wait_on_bio_chain()
	123	*/
f577eb30 RW	124	};
f577eb30 RW	125
fb13a28b RW	126	/* This macro returns the address from/to which the caller of
	127	* snapshot_read_next()/snapshot_write_next() is allowed to
	128	* read/write data after the function returns
	129	*/
f577eb30 RW	130	#define data_of(handle) ((handle).buffer + (handle).buf_offset)
f577eb30 RW	131
b788db79	132	extern unsigned int snapshot_additional_pages(struct zone *zone);
af508b34	133	extern unsigned long snapshot_get_image_size(void);
f577eb30 RW	134	extern int snapshot_read_next(struct snapshot_handle *handle, size_t count);
f577eb30 RW	135	extern int snapshot_write_next(struct snapshot_handle *handle, size_t count);
8357376d	136	extern void snapshot_write_finalize(struct snapshot_handle *handle);
b788db79	137	extern int snapshot_image_loaded(struct snapshot_handle *handle);
61159a31	138
0709db60 RW	139	/* If unset, the snapshot device cannot be open. */
	140	extern atomic_t snapshot_device_available;
	141
d1d241cc RW	142	extern sector_t alloc_swapdev_block(int swap);
	143	extern void free_all_swap_pages(int swap);
	144	extern int swsusp_swap_in_use(void);
61159a31	145
a634cc10 RW	146	/*
	147	* Flags that can be passed from the hibernatig hernel to the "boot" kernel in
	148	* the image header.
	149	*/
	150	#define SF_PLATFORM_MODE 1
	151
	152	/* kernel/power/disk.c */
74c7e2ef	153	extern int swsusp_check(void);
61159a31	154	extern int swsusp_shrink_memory(void);
74c7e2ef	155	extern void swsusp_free(void);
a634cc10 RW	156	extern int swsusp_read(unsigned int *flags_p);
a634cc10 RW	157	extern int swsusp_write(unsigned int flags);
74c7e2ef	158	extern void swsusp_close(void);
0d3a9abe RW	159
0d3a9abe RW	160	struct timeval;
b10d9117	161	/* kernel/power/swsusp.c */
0d3a9abe RW	162	extern void swsusp_show_speed(struct timeval , struct timeval ,
0d3a9abe RW	163	unsigned int, char *);
b10d9117	164
296699de	165	#ifdef CONFIG_SUSPEND
b10d9117	166	/* kernel/power/main.c */
6c961dfb	167	extern int suspend_devices_and_enter(suspend_state_t state);
296699de RW	168	#else /* !CONFIG_SUSPEND */
	169	static inline int suspend_devices_and_enter(suspend_state_t state)
	170	{
	171	return -ENOSYS;
	172	}
	173	#endif /* !CONFIG_SUSPEND */
	174
82525756 AS	175	#ifdef CONFIG_PM_SLEEP
	176	/* kernel/power/main.c */
	177	extern int pm_notifier_call_chain(unsigned long val);
	178	#endif
2f8ed1c6 AB	179
	180	#ifdef CONFIG_HIGHMEM
	181	unsigned int count_highmem_pages(void);
	182	int restore_highmem(void);
	183	#else
	184	static inline unsigned int count_highmem_pages(void) { return 0; }
	185	static inline int restore_highmem(void) { return 0; }
	186	#endif
0e7d56e3 RW	187
	188	/*
	189	* Suspend test levels
	190	*/
	191	enum {
	192	/* keep first */
	193	TEST_NONE,
	194	TEST_CORE,
	195	TEST_CPUS,
	196	TEST_PLATFORM,
	197	TEST_DEVICES,
	198	TEST_FREEZER,
	199	/* keep last */
	200	__TEST_AFTER_LAST
	201	};
	202
	203	#define TEST_FIRST TEST_NONE
	204	#define TEST_MAX (__TEST_AFTER_LAST - 1)
4cc79776 RW	205
4cc79776 RW	206	extern int pm_test_level;
b28f5081 JB	207
	208	#ifdef CONFIG_SUSPEND_FREEZER
	209	static inline int suspend_freeze_processes(void)
	210	{
	211	return freeze_processes();
	212	}
	213
	214	static inline void suspend_thaw_processes(void)
	215	{
	216	thaw_processes();
	217	}
	218	#else
	219	static inline int suspend_freeze_processes(void)
	220	{
	221	return 0;
	222	}
	223
	224	static inline void suspend_thaw_processes(void)
	225	{
	226	}
	227	#endif