[mirror_ubuntu-hirsute-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_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);

/*
 * 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_RESTORE		_IO(SNAPSHOT_IOC_MAGIC, 4)
#define SNAPSHOT_FREE			_IO(SNAPSHOT_IOC_MAGIC, 5)
#define SNAPSHOT_FREE_SWAP_PAGES	_IO(SNAPSHOT_IOC_MAGIC, 9)
#define SNAPSHOT_S2RAM			_IO(SNAPSHOT_IOC_MAGIC, 11)
#define SNAPSHOT_SET_SWAP_AREA		_IOW(SNAPSHOT_IOC_MAGIC, 13, \
							struct resume_swap_area)
#define SNAPSHOT_GET_IMAGE_SIZE		_IOR(SNAPSHOT_IOC_MAGIC, 14, loff_t)
#define SNAPSHOT_PLATFORM_SUPPORT	_IO(SNAPSHOT_IOC_MAGIC, 15)
#define SNAPSHOT_POWER_OFF		_IO(SNAPSHOT_IOC_MAGIC, 16)
#define SNAPSHOT_CREATE_IMAGE		_IOW(SNAPSHOT_IOC_MAGIC, 17, int)
#define SNAPSHOT_PREF_IMAGE_SIZE	_IO(SNAPSHOT_IOC_MAGIC, 18)
#define SNAPSHOT_AVAIL_SWAP_SIZE	_IOR(SNAPSHOT_IOC_MAGIC, 19, loff_t)
#define SNAPSHOT_ALLOC_SWAP_PAGE	_IOR(SNAPSHOT_IOC_MAGIC, 20, loff_t)
#define SNAPSHOT_IOC_MAXNR	20

/* 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_resume(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 */

/* kernel/power/common.c */
extern struct blocking_notifier_head pm_chain_head;

static inline int pm_notifier_call_chain(unsigned long val)
{
	return (blocking_notifier_call_chain(&pm_chain_head, val, NULL)
			== NOTIFY_BAD) ? -EINVAL : 0;
}
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)));
1da177e4 LT	13
d307c4a8 RW	14	#ifdef CONFIG_HIBERNATION
	15	#ifdef CONFIG_ARCH_HIBERNATION_HEADER
	16	/* Maximum size of architecture specific data in a hibernation header */
	17	#define MAX_ARCH_HEADER_SIZE (sizeof(struct new_utsname) + 4)
1da177e4	18
d307c4a8 RW	19	extern int arch_hibernation_header_save(void *addr, unsigned int max_size);
	20	extern int arch_hibernation_header_restore(void *addr);
	21
	22	static inline int init_header_complete(struct swsusp_info *info)
	23	{
	24	return arch_hibernation_header_save(info, MAX_ARCH_HEADER_SIZE);
	25	}
	26
	27	static inline char check_image_kernel(struct swsusp_info info)
	28	{
	29	return arch_hibernation_header_restore(info) ?
	30	"architecture specific data" : NULL;
	31	}
	32	#endif /* CONFIG_ARCH_HIBERNATION_HEADER */
1da177e4	33
56f99bcb RW	34	/*
	35	* Keep some memory free so that I/O operations can succeed without paging
	36	* [Might this be more than 4 MB?]
	37	*/
	38	#define PAGES_FOR_IO ((4096 * 1024) >> PAGE_SHIFT)
d307c4a8	39
56f99bcb RW	40	/*
	41	* Keep 1 MB of memory free so that device drivers can allocate some pages in
	42	* their .suspend() routines without breaking the suspend to disk.
	43	*/
	44	#define SPARE_PAGES ((1024 * 1024) >> PAGE_SHIFT)
1da177e4	45
7777fab9 RW	46	/* kernel/power/disk.c */
7777fab9 RW	47	extern int hibernation_snapshot(int platform_mode);
a634cc10	48	extern int hibernation_restore(int platform_mode);
7777fab9	49	extern int hibernation_platform_enter(void);
1da177e4	50	#endif
a6d70980	51
49c3df6a VG	52	extern int pfn_is_nosave(unsigned long);
49c3df6a VG	53
a6d70980 SH	54	extern struct mutex pm_mutex;
a6d70980 SH	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);
72a97e08	77	extern unsigned int count_data_pages(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
37b2ba12 RW	137	/*
	138	* This structure is used to pass the values needed for the identification
	139	* of the resume swap area from a user space to the kernel via the
	140	* SNAPSHOT_SET_SWAP_AREA ioctl
	141	*/
	142	struct resume_swap_area {
	143	loff_t offset;
	144	u_int32_t dev;
	145	} __attribute__((packed));
	146
6e1819d6 RW	147	#define SNAPSHOT_IOC_MAGIC '3'
	148	#define SNAPSHOT_FREEZE _IO(SNAPSHOT_IOC_MAGIC, 1)
	149	#define SNAPSHOT_UNFREEZE _IO(SNAPSHOT_IOC_MAGIC, 2)
6e1819d6 RW	150	#define SNAPSHOT_ATOMIC_RESTORE _IO(SNAPSHOT_IOC_MAGIC, 4)
6e1819d6 RW	151	#define SNAPSHOT_FREE _IO(SNAPSHOT_IOC_MAGIC, 5)
6e1819d6	152	#define SNAPSHOT_FREE_SWAP_PAGES _IO(SNAPSHOT_IOC_MAGIC, 9)
9b238205	153	#define SNAPSHOT_S2RAM _IO(SNAPSHOT_IOC_MAGIC, 11)
37b2ba12 RW	154	#define SNAPSHOT_SET_SWAP_AREA _IOW(SNAPSHOT_IOC_MAGIC, 13, \
37b2ba12 RW	155	struct resume_swap_area)
af508b34	156	#define SNAPSHOT_GET_IMAGE_SIZE _IOR(SNAPSHOT_IOC_MAGIC, 14, loff_t)
eb57c1cf RW	157	#define SNAPSHOT_PLATFORM_SUPPORT _IO(SNAPSHOT_IOC_MAGIC, 15)
eb57c1cf RW	158	#define SNAPSHOT_POWER_OFF _IO(SNAPSHOT_IOC_MAGIC, 16)
cc5d207c RW	159	#define SNAPSHOT_CREATE_IMAGE _IOW(SNAPSHOT_IOC_MAGIC, 17, int)
	160	#define SNAPSHOT_PREF_IMAGE_SIZE _IO(SNAPSHOT_IOC_MAGIC, 18)
	161	#define SNAPSHOT_AVAIL_SWAP_SIZE _IOR(SNAPSHOT_IOC_MAGIC, 19, loff_t)
	162	#define SNAPSHOT_ALLOC_SWAP_PAGE _IOR(SNAPSHOT_IOC_MAGIC, 20, loff_t)
	163	#define SNAPSHOT_IOC_MAXNR 20
6e1819d6	164
0709db60 RW	165	/* If unset, the snapshot device cannot be open. */
	166	extern atomic_t snapshot_device_available;
	167
d1d241cc RW	168	extern sector_t alloc_swapdev_block(int swap);
	169	extern void free_all_swap_pages(int swap);
	170	extern int swsusp_swap_in_use(void);
61159a31	171
a634cc10 RW	172	/*
	173	* Flags that can be passed from the hibernatig hernel to the "boot" kernel in
	174	* the image header.
	175	*/
	176	#define SF_PLATFORM_MODE 1
	177
	178	/* kernel/power/disk.c */
74c7e2ef	179	extern int swsusp_check(void);
61159a31	180	extern int swsusp_shrink_memory(void);
74c7e2ef	181	extern void swsusp_free(void);
61159a31	182	extern int swsusp_resume(void);
a634cc10 RW	183	extern int swsusp_read(unsigned int *flags_p);
a634cc10 RW	184	extern int swsusp_write(unsigned int flags);
74c7e2ef	185	extern void swsusp_close(void);
0d3a9abe RW	186
0d3a9abe RW	187	struct timeval;
b10d9117	188	/* kernel/power/swsusp.c */
0d3a9abe RW	189	extern void swsusp_show_speed(struct timeval , struct timeval ,
0d3a9abe RW	190	unsigned int, char *);
b10d9117	191
296699de	192	#ifdef CONFIG_SUSPEND
b10d9117	193	/* kernel/power/main.c */
6c961dfb	194	extern int suspend_devices_and_enter(suspend_state_t state);
296699de RW	195	#else /* !CONFIG_SUSPEND */
	196	static inline int suspend_devices_and_enter(suspend_state_t state)
	197	{
	198	return -ENOSYS;
	199	}
	200	#endif /* !CONFIG_SUSPEND */
	201
	202	/* kernel/power/common.c */
b10d9117 RW	203	extern struct blocking_notifier_head pm_chain_head;
	204
	205	static inline int pm_notifier_call_chain(unsigned long val)
	206	{
	207	return (blocking_notifier_call_chain(&pm_chain_head, val, NULL)
	208	== NOTIFY_BAD) ? -EINVAL : 0;
	209	}