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

#include <linux/suspend.h>
#include <linux/suspend_ioctls.h>
#include <linux/utsname.h>
#include <linux/freezer.h>
#include <linux/compiler.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;
} __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)

asmlinkage int swsusp_save(void);

/* kernel/power/hibernate.c */
extern bool freezer_test_done;

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
#define SF_CRC32_MODE	        4

/* 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);
#ifdef CONFIG_SUSPEND
extern int swsusp_unmark(void);
#endif

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

#ifdef CONFIG_SUSPEND
/* kernel/power/suspend.c */
extern const char *pm_labels[];
extern const char *pm_states[];

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_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;

	error = freeze_processes();
	/*
	 * freeze_processes() automatically thaws every task if freezing
	 * fails. So we need not do anything extra upon error.
	 */
	if (error)
		return error;

	error = freeze_kernel_threads();
	/*
	 * freeze_kernel_threads() thaws only kernel threads upon freezing
	 * failure. So we have to thaw the userspace tasks ourselves.
	 */
	if (error)
		thaw_processes();

	return error;
}

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

#ifdef CONFIG_PM_AUTOSLEEP

/* kernel/power/autosleep.c */
extern int pm_autosleep_init(void);
extern int pm_autosleep_lock(void);
extern void pm_autosleep_unlock(void);
extern suspend_state_t pm_autosleep_state(void);
extern int pm_autosleep_set_state(suspend_state_t state);

#else /* !CONFIG_PM_AUTOSLEEP */

static inline int pm_autosleep_init(void) { return 0; }
static inline int pm_autosleep_lock(void) { return 0; }
static inline void pm_autosleep_unlock(void) {}
static inline suspend_state_t pm_autosleep_state(void) { return PM_SUSPEND_ON; }

#endif /* !CONFIG_PM_AUTOSLEEP */

#ifdef CONFIG_PM_WAKELOCKS

/* kernel/power/wakelock.c */
extern ssize_t pm_show_wakelocks(char *buf, bool show_active);
extern int pm_wake_lock(const char *buf);
extern int pm_wake_unlock(const char *buf);

#endif /* !CONFIG_PM_WAKELOCKS */
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>
52f5684c	5	#include <linux/compiler.h>
1da177e4	6
1da177e4 LT	7	struct swsusp_info {
	8	struct new_utsname uts;
	9	u32 version_code;
	10	unsigned long num_physpages;
	11	int cpus;
	12	unsigned long image_pages;
7088a5c0	13	unsigned long pages;
6e1819d6	14	unsigned long size;
52f5684c	15	} __aligned(PAGE_SIZE);
1da177e4	16
d307c4a8	17	#ifdef CONFIG_HIBERNATION
ac5c24ec	18	/* kernel/power/snapshot.c */
ddeb6487	19	extern void __init hibernate_reserved_size_init(void);
ac5c24ec RW	20	extern void __init hibernate_image_size_init(void);
ac5c24ec RW	21
d307c4a8 RW	22	#ifdef CONFIG_ARCH_HIBERNATION_HEADER
	23	/* Maximum size of architecture specific data in a hibernation header */
	24	#define MAX_ARCH_HEADER_SIZE (sizeof(struct new_utsname) + 4)
1da177e4	25
d307c4a8 RW	26	extern int arch_hibernation_header_save(void *addr, unsigned int max_size);
	27	extern int arch_hibernation_header_restore(void *addr);
	28
	29	static inline int init_header_complete(struct swsusp_info *info)
	30	{
	31	return arch_hibernation_header_save(info, MAX_ARCH_HEADER_SIZE);
	32	}
	33
	34	static inline char check_image_kernel(struct swsusp_info info)
	35	{
	36	return arch_hibernation_header_restore(info) ?
	37	"architecture specific data" : NULL;
	38	}
	39	#endif /* CONFIG_ARCH_HIBERNATION_HEADER */
1da177e4	40
56f99bcb RW	41	/*
	42	* Keep some memory free so that I/O operations can succeed without paging
	43	* [Might this be more than 4 MB?]
	44	*/
	45	#define PAGES_FOR_IO ((4096 * 1024) >> PAGE_SHIFT)
d307c4a8	46
56f99bcb RW	47	/*
	48	* Keep 1 MB of memory free so that device drivers can allocate some pages in
	49	* their .suspend() routines without breaking the suspend to disk.
	50	*/
	51	#define SPARE_PAGES ((1024 * 1024) >> PAGE_SHIFT)
1da177e4	52
04b73469 RK	53	asmlinkage int swsusp_save(void);
04b73469 RK	54
8b759b84	55	/* kernel/power/hibernate.c */
97819a26 SB	56	extern bool freezer_test_done;
97819a26 SB	57
7777fab9	58	extern int hibernation_snapshot(int platform_mode);
a634cc10	59	extern int hibernation_restore(int platform_mode);
7777fab9	60	extern int hibernation_platform_enter(void);
ac5c24ec RW	61
	62	#else /* !CONFIG_HIBERNATION */
	63
ddeb6487	64	static inline void hibernate_reserved_size_init(void) {}
ac5c24ec RW	65	static inline void hibernate_image_size_init(void) {}
ac5c24ec RW	66	#endif /* !CONFIG_HIBERNATION */
a6d70980	67
49c3df6a VG	68	extern int pfn_is_nosave(unsigned long);
49c3df6a VG	69
1da177e4	70	#define power_attr(_name) \
386f275f	71	static struct kobj_attribute _name##_attr = { \
1da177e4 LT	72	.attr = { \
	73	.name = __stringify(_name), \
	74	.mode = 0644, \
	75	}, \
	76	.show = _name##_show, \
	77	.store = _name##_store, \
	78	}
	79
853609b6 RW	80	/* Preferred image size in bytes (default 500 MB) */
853609b6 RW	81	extern unsigned long image_size;
ddeb6487 RW	82	/* Size of memory reserved for drivers (default SPARE_PAGES x PAGE_SIZE) */
ddeb6487 RW	83	extern unsigned long reserved_size;
f577eb30	84	extern int in_suspend;
61159a31	85	extern dev_t swsusp_resume_device;
9a154d9d	86	extern sector_t swsusp_resume_block;
f577eb30	87
25761b6e RW	88	extern asmlinkage int swsusp_arch_suspend(void);
	89	extern asmlinkage int swsusp_arch_resume(void);
	90
74dfd666 RW	91	extern int create_basic_memory_bitmaps(void);
74dfd666 RW	92	extern void free_basic_memory_bitmaps(void);
64a473cb	93	extern int hibernate_preallocate_memory(void);
f577eb30	94
fb13a28b RW	95	/**
	96	* Auxiliary structure used for reading the snapshot image data and
	97	* metadata from and writing them to the list of page backup entries
	98	* (PBEs) which is the main data structure of swsusp.
	99	*
	100	* Using struct snapshot_handle we can transfer the image, including its
	101	* metadata, as a continuous sequence of bytes with the help of
	102	* snapshot_read_next() and snapshot_write_next().
	103	*
	104	* The code that writes the image to a storage or transfers it to
	105	* the user land is required to use snapshot_read_next() for this
	106	* purpose and it should not make any assumptions regarding the internal
	107	* structure of the image. Similarly, the code that reads the image from
	108	* a storage or transfers it from the user land is required to use
	109	* snapshot_write_next().
	110	*
	111	* This may allow us to change the internal structure of the image
	112	* in the future with considerably less effort.
	113	*/
	114
f577eb30	115	struct snapshot_handle {
fb13a28b RW	116	unsigned int cur; /* number of the block of PAGE_SIZE bytes the
	117	* next operation will refer to (ie. current)
	118	*/
fb13a28b RW	119	void buffer; / address of the block to read from
	120	* or write to
	121	*/
fb13a28b RW	122	int sync_read; /* Set to one to notify the caller of
	123	* snapshot_write_next() that it may
	124	* need to call wait_on_bio_chain()
	125	*/
f577eb30 RW	126	};
f577eb30 RW	127
fb13a28b RW	128	/* This macro returns the address from/to which the caller of
	129	* snapshot_read_next()/snapshot_write_next() is allowed to
	130	* read/write data after the function returns
	131	*/
d3c1b24c	132	#define data_of(handle) ((handle).buffer)
f577eb30	133
b788db79	134	extern unsigned int snapshot_additional_pages(struct zone *zone);
af508b34	135	extern unsigned long snapshot_get_image_size(void);
d3c1b24c JS	136	extern int snapshot_read_next(struct snapshot_handle *handle);
d3c1b24c JS	137	extern int snapshot_write_next(struct snapshot_handle *handle);
8357376d	138	extern void snapshot_write_finalize(struct snapshot_handle *handle);
b788db79	139	extern int snapshot_image_loaded(struct snapshot_handle *handle);
61159a31	140
0709db60 RW	141	/* If unset, the snapshot device cannot be open. */
	142	extern atomic_t snapshot_device_available;
	143
d1d241cc RW	144	extern sector_t alloc_swapdev_block(int swap);
	145	extern void free_all_swap_pages(int swap);
	146	extern int swsusp_swap_in_use(void);
61159a31	147
a634cc10 RW	148	/*
	149	* Flags that can be passed from the hibernatig hernel to the "boot" kernel in
	150	* the image header.
	151	*/
	152	#define SF_PLATFORM_MODE 1
f996fc96	153	#define SF_NOCOMPRESS_MODE 2
081a9d04	154	#define SF_CRC32_MODE 4
a634cc10	155
8b759b84	156	/* kernel/power/hibernate.c */
74c7e2ef	157	extern int swsusp_check(void);
74c7e2ef	158	extern void swsusp_free(void);
a634cc10 RW	159	extern int swsusp_read(unsigned int *flags_p);
a634cc10 RW	160	extern int swsusp_write(unsigned int flags);
c2dd0dae	161	extern void swsusp_close(fmode_t);
62c552cc BS	162	#ifdef CONFIG_SUSPEND
	163	extern int swsusp_unmark(void);
	164	#endif
0d3a9abe RW	165
0d3a9abe RW	166	struct timeval;
b10d9117	167	/* kernel/power/swsusp.c */
db597605	168	extern void swsusp_show_speed(ktime_t, ktime_t, unsigned int, char *);
b10d9117	169
296699de	170	#ifdef CONFIG_SUSPEND
a9d70523	171	/* kernel/power/suspend.c */
62109b43	172	extern const char *pm_labels[];
d431cbc5	173	extern const char *pm_states[];
a9d70523	174
6c961dfb	175	extern int suspend_devices_and_enter(suspend_state_t state);
296699de RW	176	#else /* !CONFIG_SUSPEND */
	177	static inline int suspend_devices_and_enter(suspend_state_t state)
	178	{
	179	return -ENOSYS;
	180	}
	181	#endif /* !CONFIG_SUSPEND */
	182
a9d70523 RW	183	#ifdef CONFIG_PM_TEST_SUSPEND
	184	/* kernel/power/suspend_test.c */
	185	extern void suspend_test_start(void);
	186	extern void suspend_test_finish(const char *label);
	187	#else /* !CONFIG_PM_TEST_SUSPEND */
	188	static inline void suspend_test_start(void) {}
	189	static inline void suspend_test_finish(const char *label) {}
	190	#endif /* !CONFIG_PM_TEST_SUSPEND */
	191
82525756 AS	192	#ifdef CONFIG_PM_SLEEP
	193	/* kernel/power/main.c */
	194	extern int pm_notifier_call_chain(unsigned long val);
	195	#endif
2f8ed1c6 AB	196
2f8ed1c6 AB	197	#ifdef CONFIG_HIGHMEM
2f8ed1c6 AB	198	int restore_highmem(void);
	199	#else
	200	static inline unsigned int count_highmem_pages(void) { return 0; }
	201	static inline int restore_highmem(void) { return 0; }
	202	#endif
0e7d56e3 RW	203
	204	/*
	205	* Suspend test levels
	206	*/
	207	enum {
	208	/* keep first */
	209	TEST_NONE,
	210	TEST_CORE,
	211	TEST_CPUS,
	212	TEST_PLATFORM,
	213	TEST_DEVICES,
	214	TEST_FREEZER,
	215	/* keep last */
	216	__TEST_AFTER_LAST
	217	};
	218
	219	#define TEST_FIRST TEST_NONE
	220	#define TEST_MAX (__TEST_AFTER_LAST - 1)
4cc79776 RW	221
4cc79776 RW	222	extern int pm_test_level;
b28f5081 JB	223
	224	#ifdef CONFIG_SUSPEND_FREEZER
	225	static inline int suspend_freeze_processes(void)
	226	{
379e0be8 SB	227	int error;
	228
	229	error = freeze_processes();
379e0be8 SB	230	/*
	231	* freeze_processes() automatically thaws every task if freezing
	232	* fails. So we need not do anything extra upon error.
	233	*/
	234	if (error)
6f585f75	235	return error;
379e0be8 SB	236
379e0be8 SB	237	error = freeze_kernel_threads();
379e0be8 SB	238	/*
	239	* freeze_kernel_threads() thaws only kernel threads upon freezing
	240	* failure. So we have to thaw the userspace tasks ourselves.
	241	*/
	242	if (error)
	243	thaw_processes();
	244
379e0be8	245	return error;
b28f5081 JB	246	}
	247
	248	static inline void suspend_thaw_processes(void)
	249	{
	250	thaw_processes();
	251	}
	252	#else
	253	static inline int suspend_freeze_processes(void)
	254	{
	255	return 0;
	256	}
	257
	258	static inline void suspend_thaw_processes(void)
	259	{
	260	}
	261	#endif
7483b4a4 RW	262
	263	#ifdef CONFIG_PM_AUTOSLEEP
	264
	265	/* kernel/power/autosleep.c */
	266	extern int pm_autosleep_init(void);
	267	extern int pm_autosleep_lock(void);
	268	extern void pm_autosleep_unlock(void);
	269	extern suspend_state_t pm_autosleep_state(void);
	270	extern int pm_autosleep_set_state(suspend_state_t state);
	271
	272	#else /* !CONFIG_PM_AUTOSLEEP */
	273
	274	static inline int pm_autosleep_init(void) { return 0; }
	275	static inline int pm_autosleep_lock(void) { return 0; }
	276	static inline void pm_autosleep_unlock(void) {}
	277	static inline suspend_state_t pm_autosleep_state(void) { return PM_SUSPEND_ON; }
	278
	279	#endif /* !CONFIG_PM_AUTOSLEEP */
b86ff982 RW	280
	281	#ifdef CONFIG_PM_WAKELOCKS
	282
	283	/* kernel/power/wakelock.c */
	284	extern ssize_t pm_show_wakelocks(char *buf, bool show_active);
	285	extern int pm_wake_lock(const char *buf);
	286	extern int pm_wake_unlock(const char *buf);
	287
	288	#endif /* !CONFIG_PM_WAKELOCKS */