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

#include <linux/suspend.h>
#include <linux/utsname.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_SOFTWARE_SUSPEND
/*
 * 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 subsys_attribute _name##_attr = {	\
	.attr	= {				\
		.name = __stringify(_name),	\
		.mode = 0644,			\
	},					\
	.show	= _name##_show,			\
	.store	= _name##_store,		\
}

extern struct kset power_subsys;

/* 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 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);

/*
 * This structure is used to pass the values needed for the identification
 * of the resume swap area from a user space to the kernel via the
 * SNAPSHOT_SET_SWAP_AREA ioctl
 */
struct resume_swap_area {
	loff_t offset;
	u_int32_t dev;
} __attribute__((packed));

#define SNAPSHOT_IOC_MAGIC	'3'
#define SNAPSHOT_FREEZE			_IO(SNAPSHOT_IOC_MAGIC, 1)
#define SNAPSHOT_UNFREEZE		_IO(SNAPSHOT_IOC_MAGIC, 2)
#define SNAPSHOT_ATOMIC_SNAPSHOT	_IOW(SNAPSHOT_IOC_MAGIC, 3, void *)
#define SNAPSHOT_ATOMIC_RESTORE		_IO(SNAPSHOT_IOC_MAGIC, 4)
#define SNAPSHOT_FREE			_IO(SNAPSHOT_IOC_MAGIC, 5)
#define SNAPSHOT_SET_IMAGE_SIZE		_IOW(SNAPSHOT_IOC_MAGIC, 6, unsigned long)
#define SNAPSHOT_AVAIL_SWAP		_IOR(SNAPSHOT_IOC_MAGIC, 7, void *)
#define SNAPSHOT_GET_SWAP_PAGE		_IOR(SNAPSHOT_IOC_MAGIC, 8, void *)
#define SNAPSHOT_FREE_SWAP_PAGES	_IO(SNAPSHOT_IOC_MAGIC, 9)
#define SNAPSHOT_SET_SWAP_FILE		_IOW(SNAPSHOT_IOC_MAGIC, 10, unsigned int)
#define SNAPSHOT_S2RAM			_IO(SNAPSHOT_IOC_MAGIC, 11)
#define SNAPSHOT_PMOPS			_IOW(SNAPSHOT_IOC_MAGIC, 12, unsigned int)
#define SNAPSHOT_SET_SWAP_AREA		_IOW(SNAPSHOT_IOC_MAGIC, 13, \
							struct resume_swap_area)
#define SNAPSHOT_IOC_MAXNR	13

#define PMOPS_PREPARE	1
#define PMOPS_ENTER	2
#define PMOPS_FINISH	3

/* 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_suspend(void);
extern int swsusp_resume(void);
extern int swsusp_read(unsigned int *flags_p);
extern int swsusp_write(unsigned int flags);
extern void swsusp_close(void);
extern int suspend_enter(suspend_state_t state);

struct timeval;
extern void swsusp_show_speed(struct timeval *, struct timeval *,
				unsigned int, char *);
Commit	Line	Data
1da177e4 LT	1	#include <linux/suspend.h>
	2	#include <linux/utsname.h>
	3
1da177e4 LT	4	struct swsusp_info {
	5	struct new_utsname uts;
	6	u32 version_code;
	7	unsigned long num_physpages;
	8	int cpus;
	9	unsigned long image_pages;
7088a5c0	10	unsigned long pages;
6e1819d6	11	unsigned long size;
1da177e4 LT	12	} __attribute__((aligned(PAGE_SIZE)));
	13
	14
	15
	16	#ifdef CONFIG_SOFTWARE_SUSPEND
56f99bcb RW	17	/*
	18	* Keep some memory free so that I/O operations can succeed without paging
	19	* [Might this be more than 4 MB?]
	20	*/
	21	#define PAGES_FOR_IO ((4096 * 1024) >> PAGE_SHIFT)
	22	/*
	23	* Keep 1 MB of memory free so that device drivers can allocate some pages in
	24	* their .suspend() routines without breaking the suspend to disk.
	25	*/
	26	#define SPARE_PAGES ((1024 * 1024) >> PAGE_SHIFT)
1da177e4	27
7777fab9 RW	28	/* kernel/power/disk.c */
7777fab9 RW	29	extern int hibernation_snapshot(int platform_mode);
a634cc10	30	extern int hibernation_restore(int platform_mode);
7777fab9	31	extern int hibernation_platform_enter(void);
1da177e4	32	#endif
a6d70980	33
49c3df6a VG	34	extern int pfn_is_nosave(unsigned long);
49c3df6a VG	35
a6d70980 SH	36	extern struct mutex pm_mutex;
a6d70980 SH	37
1da177e4 LT	38	#define power_attr(_name) \
	39	static struct subsys_attribute _name##_attr = { \
	40	.attr = { \
	41	.name = __stringify(_name), \
	42	.mode = 0644, \
	43	}, \
	44	.show = _name##_show, \
	45	.store = _name##_store, \
	46	}
	47
823bccfc	48	extern struct kset power_subsys;
1da177e4	49
853609b6 RW	50	/* Preferred image size in bytes (default 500 MB) */
853609b6 RW	51	extern unsigned long image_size;
f577eb30	52	extern int in_suspend;
61159a31	53	extern dev_t swsusp_resume_device;
9a154d9d	54	extern sector_t swsusp_resume_block;
f577eb30	55
25761b6e RW	56	extern asmlinkage int swsusp_arch_suspend(void);
	57	extern asmlinkage int swsusp_arch_resume(void);
	58
74dfd666 RW	59	extern int create_basic_memory_bitmaps(void);
74dfd666 RW	60	extern void free_basic_memory_bitmaps(void);
72a97e08	61	extern unsigned int count_data_pages(void);
f577eb30	62
fb13a28b RW	63	/**
	64	* Auxiliary structure used for reading the snapshot image data and
	65	* metadata from and writing them to the list of page backup entries
	66	* (PBEs) which is the main data structure of swsusp.
	67	*
	68	* Using struct snapshot_handle we can transfer the image, including its
	69	* metadata, as a continuous sequence of bytes with the help of
	70	* snapshot_read_next() and snapshot_write_next().
	71	*
	72	* The code that writes the image to a storage or transfers it to
	73	* the user land is required to use snapshot_read_next() for this
	74	* purpose and it should not make any assumptions regarding the internal
	75	* structure of the image. Similarly, the code that reads the image from
	76	* a storage or transfers it from the user land is required to use
	77	* snapshot_write_next().
	78	*
	79	* This may allow us to change the internal structure of the image
	80	* in the future with considerably less effort.
	81	*/
	82
f577eb30	83	struct snapshot_handle {
fb13a28b RW	84	loff_t offset; /* number of the last byte ready for reading
	85	* or writing in the sequence
	86	*/
	87	unsigned int cur; /* number of the block of PAGE_SIZE bytes the
	88	* next operation will refer to (ie. current)
	89	*/
	90	unsigned int cur_offset; /* offset with respect to the current
	91	* block (for the next operation)
	92	*/
	93	unsigned int prev; /* number of the block of PAGE_SIZE bytes that
	94	* was the current one previously
	95	*/
fb13a28b RW	96	void buffer; / address of the block to read from
	97	* or write to
	98	*/
	99	unsigned int buf_offset; /* location to read from or write to,
	100	* given as a displacement from 'buffer'
	101	*/
	102	int sync_read; /* Set to one to notify the caller of
	103	* snapshot_write_next() that it may
	104	* need to call wait_on_bio_chain()
	105	*/
f577eb30 RW	106	};
f577eb30 RW	107
fb13a28b RW	108	/* This macro returns the address from/to which the caller of
	109	* snapshot_read_next()/snapshot_write_next() is allowed to
	110	* read/write data after the function returns
	111	*/
f577eb30 RW	112	#define data_of(handle) ((handle).buffer + (handle).buf_offset)
f577eb30 RW	113
b788db79	114	extern unsigned int snapshot_additional_pages(struct zone *zone);
f577eb30 RW	115	extern int snapshot_read_next(struct snapshot_handle *handle, size_t count);
f577eb30 RW	116	extern int snapshot_write_next(struct snapshot_handle *handle, size_t count);
8357376d	117	extern void snapshot_write_finalize(struct snapshot_handle *handle);
b788db79	118	extern int snapshot_image_loaded(struct snapshot_handle *handle);
61159a31	119
37b2ba12 RW	120	/*
	121	* This structure is used to pass the values needed for the identification
	122	* of the resume swap area from a user space to the kernel via the
	123	* SNAPSHOT_SET_SWAP_AREA ioctl
	124	*/
	125	struct resume_swap_area {
	126	loff_t offset;
	127	u_int32_t dev;
	128	} __attribute__((packed));
	129
6e1819d6 RW	130	#define SNAPSHOT_IOC_MAGIC '3'
	131	#define SNAPSHOT_FREEZE _IO(SNAPSHOT_IOC_MAGIC, 1)
	132	#define SNAPSHOT_UNFREEZE _IO(SNAPSHOT_IOC_MAGIC, 2)
	133	#define SNAPSHOT_ATOMIC_SNAPSHOT _IOW(SNAPSHOT_IOC_MAGIC, 3, void *)
	134	#define SNAPSHOT_ATOMIC_RESTORE _IO(SNAPSHOT_IOC_MAGIC, 4)
	135	#define SNAPSHOT_FREE _IO(SNAPSHOT_IOC_MAGIC, 5)
	136	#define SNAPSHOT_SET_IMAGE_SIZE _IOW(SNAPSHOT_IOC_MAGIC, 6, unsigned long)
	137	#define SNAPSHOT_AVAIL_SWAP _IOR(SNAPSHOT_IOC_MAGIC, 7, void *)
	138	#define SNAPSHOT_GET_SWAP_PAGE _IOR(SNAPSHOT_IOC_MAGIC, 8, void *)
	139	#define SNAPSHOT_FREE_SWAP_PAGES _IO(SNAPSHOT_IOC_MAGIC, 9)
	140	#define SNAPSHOT_SET_SWAP_FILE _IOW(SNAPSHOT_IOC_MAGIC, 10, unsigned int)
9b238205	141	#define SNAPSHOT_S2RAM _IO(SNAPSHOT_IOC_MAGIC, 11)
3592695c	142	#define SNAPSHOT_PMOPS _IOW(SNAPSHOT_IOC_MAGIC, 12, unsigned int)
37b2ba12 RW	143	#define SNAPSHOT_SET_SWAP_AREA _IOW(SNAPSHOT_IOC_MAGIC, 13, \
	144	struct resume_swap_area)
	145	#define SNAPSHOT_IOC_MAXNR 13
3592695c SS	146
	147	#define PMOPS_PREPARE 1
	148	#define PMOPS_ENTER 2
	149	#define PMOPS_FINISH 3
6e1819d6	150
0709db60 RW	151	/* If unset, the snapshot device cannot be open. */
	152	extern atomic_t snapshot_device_available;
	153
d1d241cc RW	154	extern sector_t alloc_swapdev_block(int swap);
	155	extern void free_all_swap_pages(int swap);
	156	extern int swsusp_swap_in_use(void);
61159a31	157
a634cc10 RW	158	/*
	159	* Flags that can be passed from the hibernatig hernel to the "boot" kernel in
	160	* the image header.
	161	*/
	162	#define SF_PLATFORM_MODE 1
	163
	164	/* kernel/power/disk.c */
74c7e2ef	165	extern int swsusp_check(void);
61159a31	166	extern int swsusp_shrink_memory(void);
74c7e2ef	167	extern void swsusp_free(void);
61159a31 RW	168	extern int swsusp_suspend(void);
61159a31 RW	169	extern int swsusp_resume(void);
a634cc10 RW	170	extern int swsusp_read(unsigned int *flags_p);
a634cc10 RW	171	extern int swsusp_write(unsigned int flags);
74c7e2ef	172	extern void swsusp_close(void);
9b238205	173	extern int suspend_enter(suspend_state_t state);
0d3a9abe RW	174
	175	struct timeval;
	176	extern void swsusp_show_speed(struct timeval , struct timeval ,
	177	unsigned int, char *);