[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
/* kernel/power/snapshot.c */
extern void __init hibernate_reserved_size_init(void);
extern void __init hibernate_image_size_init(void);

#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);

#else /* !CONFIG_HIBERNATION */

static inline void hibernate_reserved_size_init(void) {}
static inline void hibernate_image_size_init(void) {}
#endif /* !CONFIG_HIBERNATION */

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;
/* Size of memory reserved for drivers (default SPARE_PAGES x PAGE_SIZE) */
extern unsigned long reserved_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 {
	unsigned int	cur;	/* number of the block of PAGE_SIZE bytes the
				 * next operation will refer to (ie. current)
				 */
	void		*buffer;	/* address of the block to read from
					 * or write to
					 */
	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)

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);
extern int snapshot_write_next(struct snapshot_handle *handle);
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
#define SF_NOCOMPRESS_MODE	2

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

/* kernel/power/block_io.c */
extern struct block_device *hib_resume_bdev;

extern int hib_bio_read_page(pgoff_t page_off, void *addr,
		struct bio **bio_chain);
extern int hib_bio_write_page(pgoff_t page_off, void *addr,
		struct bio **bio_chain);
extern int hib_wait_on_bio_chain(struct bio **bio_chain);

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)
{
	int error = freeze_processes();
	return error ? : freeze_kernel_threads();
}

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	16	#ifdef CONFIG_HIBERNATION
ac5c24ec	17	/* kernel/power/snapshot.c */
ddeb6487	18	extern void __init hibernate_reserved_size_init(void);
ac5c24ec RW	19	extern void __init hibernate_image_size_init(void);
ac5c24ec RW	20
d307c4a8 RW	21	#ifdef CONFIG_ARCH_HIBERNATION_HEADER
	22	/* Maximum size of architecture specific data in a hibernation header */
	23	#define MAX_ARCH_HEADER_SIZE (sizeof(struct new_utsname) + 4)
1da177e4	24
d307c4a8 RW	25	extern int arch_hibernation_header_save(void *addr, unsigned int max_size);
	26	extern int arch_hibernation_header_restore(void *addr);
	27
	28	static inline int init_header_complete(struct swsusp_info *info)
	29	{
	30	return arch_hibernation_header_save(info, MAX_ARCH_HEADER_SIZE);
	31	}
	32
	33	static inline char check_image_kernel(struct swsusp_info info)
	34	{
	35	return arch_hibernation_header_restore(info) ?
	36	"architecture specific data" : NULL;
	37	}
	38	#endif /* CONFIG_ARCH_HIBERNATION_HEADER */
1da177e4	39
56f99bcb RW	40	/*
	41	* Keep some memory free so that I/O operations can succeed without paging
	42	* [Might this be more than 4 MB?]
	43	*/
	44	#define PAGES_FOR_IO ((4096 * 1024) >> PAGE_SHIFT)
d307c4a8	45
56f99bcb RW	46	/*
	47	* Keep 1 MB of memory free so that device drivers can allocate some pages in
	48	* their .suspend() routines without breaking the suspend to disk.
	49	*/
	50	#define SPARE_PAGES ((1024 * 1024) >> PAGE_SHIFT)
1da177e4	51
8b759b84	52	/* kernel/power/hibernate.c */
7777fab9	53	extern int hibernation_snapshot(int platform_mode);
a634cc10	54	extern int hibernation_restore(int platform_mode);
7777fab9	55	extern int hibernation_platform_enter(void);
ac5c24ec RW	56
	57	#else /* !CONFIG_HIBERNATION */
	58
ddeb6487	59	static inline void hibernate_reserved_size_init(void) {}
ac5c24ec RW	60	static inline void hibernate_image_size_init(void) {}
ac5c24ec RW	61	#endif /* !CONFIG_HIBERNATION */
a6d70980	62
49c3df6a VG	63	extern int pfn_is_nosave(unsigned long);
49c3df6a VG	64
1da177e4	65	#define power_attr(_name) \
386f275f	66	static struct kobj_attribute _name##_attr = { \
1da177e4 LT	67	.attr = { \
	68	.name = __stringify(_name), \
	69	.mode = 0644, \
	70	}, \
	71	.show = _name##_show, \
	72	.store = _name##_store, \
	73	}
	74
853609b6 RW	75	/* Preferred image size in bytes (default 500 MB) */
853609b6 RW	76	extern unsigned long image_size;
ddeb6487 RW	77	/* Size of memory reserved for drivers (default SPARE_PAGES x PAGE_SIZE) */
ddeb6487 RW	78	extern unsigned long reserved_size;
f577eb30	79	extern int in_suspend;
61159a31	80	extern dev_t swsusp_resume_device;
9a154d9d	81	extern sector_t swsusp_resume_block;
f577eb30	82
25761b6e RW	83	extern asmlinkage int swsusp_arch_suspend(void);
	84	extern asmlinkage int swsusp_arch_resume(void);
	85
74dfd666 RW	86	extern int create_basic_memory_bitmaps(void);
74dfd666 RW	87	extern void free_basic_memory_bitmaps(void);
64a473cb	88	extern int hibernate_preallocate_memory(void);
f577eb30	89
fb13a28b RW	90	/**
	91	* Auxiliary structure used for reading the snapshot image data and
	92	* metadata from and writing them to the list of page backup entries
	93	* (PBEs) which is the main data structure of swsusp.
	94	*
	95	* Using struct snapshot_handle we can transfer the image, including its
	96	* metadata, as a continuous sequence of bytes with the help of
	97	* snapshot_read_next() and snapshot_write_next().
	98	*
	99	* The code that writes the image to a storage or transfers it to
	100	* the user land is required to use snapshot_read_next() for this
	101	* purpose and it should not make any assumptions regarding the internal
	102	* structure of the image. Similarly, the code that reads the image from
	103	* a storage or transfers it from the user land is required to use
	104	* snapshot_write_next().
	105	*
	106	* This may allow us to change the internal structure of the image
	107	* in the future with considerably less effort.
	108	*/
	109
f577eb30	110	struct snapshot_handle {
fb13a28b RW	111	unsigned int cur; /* number of the block of PAGE_SIZE bytes the
	112	* next operation will refer to (ie. current)
	113	*/
fb13a28b RW	114	void buffer; / address of the block to read from
	115	* or write to
	116	*/
fb13a28b RW	117	int sync_read; /* Set to one to notify the caller of
	118	* snapshot_write_next() that it may
	119	* need to call wait_on_bio_chain()
	120	*/
f577eb30 RW	121	};
f577eb30 RW	122
fb13a28b RW	123	/* This macro returns the address from/to which the caller of
	124	* snapshot_read_next()/snapshot_write_next() is allowed to
	125	* read/write data after the function returns
	126	*/
d3c1b24c	127	#define data_of(handle) ((handle).buffer)
f577eb30	128
b788db79	129	extern unsigned int snapshot_additional_pages(struct zone *zone);
af508b34	130	extern unsigned long snapshot_get_image_size(void);
d3c1b24c JS	131	extern int snapshot_read_next(struct snapshot_handle *handle);
d3c1b24c JS	132	extern int snapshot_write_next(struct snapshot_handle *handle);
8357376d	133	extern void snapshot_write_finalize(struct snapshot_handle *handle);
b788db79	134	extern int snapshot_image_loaded(struct snapshot_handle *handle);
61159a31	135
0709db60 RW	136	/* If unset, the snapshot device cannot be open. */
	137	extern atomic_t snapshot_device_available;
	138
d1d241cc RW	139	extern sector_t alloc_swapdev_block(int swap);
	140	extern void free_all_swap_pages(int swap);
	141	extern int swsusp_swap_in_use(void);
61159a31	142
a634cc10 RW	143	/*
	144	* Flags that can be passed from the hibernatig hernel to the "boot" kernel in
	145	* the image header.
	146	*/
	147	#define SF_PLATFORM_MODE 1
f996fc96	148	#define SF_NOCOMPRESS_MODE 2
a634cc10	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	156
8a0d613f JS	157	/* kernel/power/block_io.c */
	158	extern struct block_device *hib_resume_bdev;
	159
	160	extern int hib_bio_read_page(pgoff_t page_off, void *addr,
	161	struct bio **bio_chain);
	162	extern int hib_bio_write_page(pgoff_t page_off, void *addr,
	163	struct bio **bio_chain);
	164	extern int hib_wait_on_bio_chain(struct bio **bio_chain);
	165
0d3a9abe	166	struct timeval;
b10d9117	167	/* kernel/power/swsusp.c */
0d3a9abe RW	168	extern void swsusp_show_speed(struct timeval , struct timeval ,
0d3a9abe RW	169	unsigned int, char *);
b10d9117	170
296699de	171	#ifdef CONFIG_SUSPEND
a9d70523 RW	172	/* kernel/power/suspend.c */
	173	extern const char *const pm_states[];
	174
	175	extern bool valid_state(suspend_state_t state);
6c961dfb	176	extern int suspend_devices_and_enter(suspend_state_t state);
a9d70523	177	extern int enter_state(suspend_state_t state);
296699de RW	178	#else /* !CONFIG_SUSPEND */
	179	static inline int suspend_devices_and_enter(suspend_state_t state)
	180	{
	181	return -ENOSYS;
	182	}
a9d70523 RW	183	static inline int enter_state(suspend_state_t state) { return -ENOSYS; }
a9d70523 RW	184	static inline bool valid_state(suspend_state_t state) { return false; }
296699de RW	185	#endif /* !CONFIG_SUSPEND */
296699de RW	186
a9d70523 RW	187	#ifdef CONFIG_PM_TEST_SUSPEND
	188	/* kernel/power/suspend_test.c */
	189	extern void suspend_test_start(void);
	190	extern void suspend_test_finish(const char *label);
	191	#else /* !CONFIG_PM_TEST_SUSPEND */
	192	static inline void suspend_test_start(void) {}
	193	static inline void suspend_test_finish(const char *label) {}
	194	#endif /* !CONFIG_PM_TEST_SUSPEND */
	195
82525756 AS	196	#ifdef CONFIG_PM_SLEEP
	197	/* kernel/power/main.c */
	198	extern int pm_notifier_call_chain(unsigned long val);
	199	#endif
2f8ed1c6 AB	200
2f8ed1c6 AB	201	#ifdef CONFIG_HIGHMEM
2f8ed1c6 AB	202	int restore_highmem(void);
	203	#else
	204	static inline unsigned int count_highmem_pages(void) { return 0; }
	205	static inline int restore_highmem(void) { return 0; }
	206	#endif
0e7d56e3 RW	207
	208	/*
	209	* Suspend test levels
	210	*/
	211	enum {
	212	/* keep first */
	213	TEST_NONE,
	214	TEST_CORE,
	215	TEST_CPUS,
	216	TEST_PLATFORM,
	217	TEST_DEVICES,
	218	TEST_FREEZER,
	219	/* keep last */
	220	__TEST_AFTER_LAST
	221	};
	222
	223	#define TEST_FIRST TEST_NONE
	224	#define TEST_MAX (__TEST_AFTER_LAST - 1)
4cc79776 RW	225
4cc79776 RW	226	extern int pm_test_level;
b28f5081 JB	227
	228	#ifdef CONFIG_SUSPEND_FREEZER
	229	static inline int suspend_freeze_processes(void)
	230	{
2aede851 RW	231	int error = freeze_processes();
2aede851 RW	232	return error ? : freeze_kernel_threads();
b28f5081 JB	233	}
	234
	235	static inline void suspend_thaw_processes(void)
	236	{
	237	thaw_processes();
	238	}
	239	#else
	240	static inline int suspend_freeze_processes(void)
	241	{
	242	return 0;
	243	}
	244
	245	static inline void suspend_thaw_processes(void)
	246	{
	247	}
	248	#endif