[mirror_ubuntu-artful-kernel.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
extern int pm_suspend_disk(void);

#else
static inline int pm_suspend_disk(void)
{
	return -EPERM;
}
#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 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

/**
 *	The bitmap is used for tracing allocated swap pages
 *
 *	The entire bitmap consists of a number of bitmap_page
 *	structures linked with the help of the .next member.
 *	Thus each page can be allocated individually, so we only
 *	need to make 0-order memory allocations to create
 *	the bitmap.
 */

#define BITMAP_PAGE_SIZE	(PAGE_SIZE - sizeof(void *))
#define BITMAP_PAGE_CHUNKS	(BITMAP_PAGE_SIZE / sizeof(long))
#define BITS_PER_CHUNK		(sizeof(long) * 8)
#define BITMAP_PAGE_BITS	(BITMAP_PAGE_CHUNKS * BITS_PER_CHUNK)

struct bitmap_page {
	unsigned long		chunks[BITMAP_PAGE_CHUNKS];
	struct bitmap_page	*next;
};

extern void free_bitmap(struct bitmap_page *bitmap);
extern struct bitmap_page *alloc_bitmap(unsigned int nr_bits);
extern sector_t alloc_swapdev_block(int swap, struct bitmap_page *bitmap);
extern void free_all_swap_pages(int swap, struct bitmap_page *bitmap);

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(void);
extern int swsusp_write(void);
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
	17	extern int pm_suspend_disk(void);
	18
	19	#else
	20	static inline int pm_suspend_disk(void)
	21	{
	22	return -EPERM;
	23	}
	24	#endif
a6d70980	25
49c3df6a VG	26	extern int pfn_is_nosave(unsigned long);
49c3df6a VG	27
a6d70980 SH	28	extern struct mutex pm_mutex;
a6d70980 SH	29
1da177e4 LT	30	#define power_attr(_name) \
	31	static struct subsys_attribute _name##_attr = { \
	32	.attr = { \
	33	.name = __stringify(_name), \
	34	.mode = 0644, \
	35	}, \
	36	.show = _name##_show, \
	37	.store = _name##_store, \
	38	}
	39
823bccfc	40	extern struct kset power_subsys;
1da177e4	41
853609b6 RW	42	/* Preferred image size in bytes (default 500 MB) */
853609b6 RW	43	extern unsigned long image_size;
f577eb30	44	extern int in_suspend;
61159a31	45	extern dev_t swsusp_resume_device;
9a154d9d	46	extern sector_t swsusp_resume_block;
f577eb30	47
25761b6e RW	48	extern asmlinkage int swsusp_arch_suspend(void);
	49	extern asmlinkage int swsusp_arch_resume(void);
	50
72a97e08	51	extern unsigned int count_data_pages(void);
f577eb30	52
fb13a28b RW	53	/**
	54	* Auxiliary structure used for reading the snapshot image data and
	55	* metadata from and writing them to the list of page backup entries
	56	* (PBEs) which is the main data structure of swsusp.
	57	*
	58	* Using struct snapshot_handle we can transfer the image, including its
	59	* metadata, as a continuous sequence of bytes with the help of
	60	* snapshot_read_next() and snapshot_write_next().
	61	*
	62	* The code that writes the image to a storage or transfers it to
	63	* the user land is required to use snapshot_read_next() for this
	64	* purpose and it should not make any assumptions regarding the internal
	65	* structure of the image. Similarly, the code that reads the image from
	66	* a storage or transfers it from the user land is required to use
	67	* snapshot_write_next().
	68	*
	69	* This may allow us to change the internal structure of the image
	70	* in the future with considerably less effort.
	71	*/
	72
f577eb30	73	struct snapshot_handle {
fb13a28b RW	74	loff_t offset; /* number of the last byte ready for reading
	75	* or writing in the sequence
	76	*/
	77	unsigned int cur; /* number of the block of PAGE_SIZE bytes the
	78	* next operation will refer to (ie. current)
	79	*/
	80	unsigned int cur_offset; /* offset with respect to the current
	81	* block (for the next operation)
	82	*/
	83	unsigned int prev; /* number of the block of PAGE_SIZE bytes that
	84	* was the current one previously
	85	*/
fb13a28b RW	86	void buffer; / address of the block to read from
	87	* or write to
	88	*/
	89	unsigned int buf_offset; /* location to read from or write to,
	90	* given as a displacement from 'buffer'
	91	*/
	92	int sync_read; /* Set to one to notify the caller of
	93	* snapshot_write_next() that it may
	94	* need to call wait_on_bio_chain()
	95	*/
f577eb30 RW	96	};
f577eb30 RW	97
fb13a28b RW	98	/* This macro returns the address from/to which the caller of
	99	* snapshot_read_next()/snapshot_write_next() is allowed to
	100	* read/write data after the function returns
	101	*/
f577eb30 RW	102	#define data_of(handle) ((handle).buffer + (handle).buf_offset)
f577eb30 RW	103
b788db79	104	extern unsigned int snapshot_additional_pages(struct zone *zone);
f577eb30 RW	105	extern int snapshot_read_next(struct snapshot_handle *handle, size_t count);
f577eb30 RW	106	extern int snapshot_write_next(struct snapshot_handle *handle, size_t count);
8357376d	107	extern void snapshot_write_finalize(struct snapshot_handle *handle);
b788db79	108	extern int snapshot_image_loaded(struct snapshot_handle *handle);
61159a31	109
37b2ba12 RW	110	/*
	111	* This structure is used to pass the values needed for the identification
	112	* of the resume swap area from a user space to the kernel via the
	113	* SNAPSHOT_SET_SWAP_AREA ioctl
	114	*/
	115	struct resume_swap_area {
	116	loff_t offset;
	117	u_int32_t dev;
	118	} __attribute__((packed));
	119
6e1819d6 RW	120	#define SNAPSHOT_IOC_MAGIC '3'
	121	#define SNAPSHOT_FREEZE _IO(SNAPSHOT_IOC_MAGIC, 1)
	122	#define SNAPSHOT_UNFREEZE _IO(SNAPSHOT_IOC_MAGIC, 2)
	123	#define SNAPSHOT_ATOMIC_SNAPSHOT _IOW(SNAPSHOT_IOC_MAGIC, 3, void *)
	124	#define SNAPSHOT_ATOMIC_RESTORE _IO(SNAPSHOT_IOC_MAGIC, 4)
	125	#define SNAPSHOT_FREE _IO(SNAPSHOT_IOC_MAGIC, 5)
	126	#define SNAPSHOT_SET_IMAGE_SIZE _IOW(SNAPSHOT_IOC_MAGIC, 6, unsigned long)
	127	#define SNAPSHOT_AVAIL_SWAP _IOR(SNAPSHOT_IOC_MAGIC, 7, void *)
	128	#define SNAPSHOT_GET_SWAP_PAGE _IOR(SNAPSHOT_IOC_MAGIC, 8, void *)
	129	#define SNAPSHOT_FREE_SWAP_PAGES _IO(SNAPSHOT_IOC_MAGIC, 9)
	130	#define SNAPSHOT_SET_SWAP_FILE _IOW(SNAPSHOT_IOC_MAGIC, 10, unsigned int)
9b238205	131	#define SNAPSHOT_S2RAM _IO(SNAPSHOT_IOC_MAGIC, 11)
3592695c	132	#define SNAPSHOT_PMOPS _IOW(SNAPSHOT_IOC_MAGIC, 12, unsigned int)
37b2ba12 RW	133	#define SNAPSHOT_SET_SWAP_AREA _IOW(SNAPSHOT_IOC_MAGIC, 13, \
	134	struct resume_swap_area)
	135	#define SNAPSHOT_IOC_MAXNR 13
3592695c SS	136
	137	#define PMOPS_PREPARE 1
	138	#define PMOPS_ENTER 2
	139	#define PMOPS_FINISH 3
6e1819d6	140
61159a31 RW	141	/**
	142	* The bitmap is used for tracing allocated swap pages
	143	*
	144	* The entire bitmap consists of a number of bitmap_page
	145	* structures linked with the help of the .next member.
	146	* Thus each page can be allocated individually, so we only
	147	* need to make 0-order memory allocations to create
	148	* the bitmap.
	149	*/
	150
	151	#define BITMAP_PAGE_SIZE (PAGE_SIZE - sizeof(void *))
	152	#define BITMAP_PAGE_CHUNKS (BITMAP_PAGE_SIZE / sizeof(long))
	153	#define BITS_PER_CHUNK (sizeof(long) * 8)
	154	#define BITMAP_PAGE_BITS (BITMAP_PAGE_CHUNKS * BITS_PER_CHUNK)
	155
	156	struct bitmap_page {
	157	unsigned long chunks[BITMAP_PAGE_CHUNKS];
	158	struct bitmap_page *next;
	159	};
	160
	161	extern void free_bitmap(struct bitmap_page *bitmap);
	162	extern struct bitmap_page *alloc_bitmap(unsigned int nr_bits);
3aef83e0	163	extern sector_t alloc_swapdev_block(int swap, struct bitmap_page *bitmap);
61159a31 RW	164	extern void free_all_swap_pages(int swap, struct bitmap_page *bitmap);
61159a31 RW	165
74c7e2ef	166	extern int swsusp_check(void);
61159a31	167	extern int swsusp_shrink_memory(void);
74c7e2ef	168	extern void swsusp_free(void);
61159a31 RW	169	extern int swsusp_suspend(void);
61159a31 RW	170	extern int swsusp_resume(void);
74c7e2ef RD	171	extern int swsusp_read(void);
	172	extern int swsusp_write(void);
	173	extern void swsusp_close(void);
9b238205	174	extern int suspend_enter(suspend_state_t state);
0d3a9abe RW	175
	176	struct timeval;
	177	extern void swsusp_show_speed(struct timeval , struct timeval ,
	178	unsigned int, char *);