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

#ifdef CONFIG_DEBUG_RODATA
/* kernel/power/snapshot.c */
extern void enable_restore_image_protection(void);
#else
static inline void enable_restore_image_protection(void) {}
#endif /* CONFIG_DEBUG_RODATA */

#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,		\
}

#define power_attr_ro(_name) \
static struct kobj_attribute _name##_attr = {	\
	.attr	= {				\
		.name = __stringify(_name),	\
		.mode = S_IRUGO,		\
	},					\
	.show	= _name##_show,			\
}

/* 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, int nr_to_call,
				    int *nr_calls);
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	61
4c0b6c10 RW	62	#ifdef CONFIG_DEBUG_RODATA
	63	/* kernel/power/snapshot.c */
	64	extern void enable_restore_image_protection(void);
	65	#else
	66	static inline void enable_restore_image_protection(void) {}
	67	#endif /* CONFIG_DEBUG_RODATA */
	68
ac5c24ec RW	69	#else /* !CONFIG_HIBERNATION */
ac5c24ec RW	70
ddeb6487	71	static inline void hibernate_reserved_size_init(void) {}
ac5c24ec RW	72	static inline void hibernate_image_size_init(void) {}
ac5c24ec RW	73	#endif /* !CONFIG_HIBERNATION */
a6d70980	74
49c3df6a VG	75	extern int pfn_is_nosave(unsigned long);
49c3df6a VG	76
1da177e4	77	#define power_attr(_name) \
386f275f	78	static struct kobj_attribute _name##_attr = { \
1da177e4 LT	79	.attr = { \
	80	.name = __stringify(_name), \
	81	.mode = 0644, \
	82	}, \
	83	.show = _name##_show, \
	84	.store = _name##_store, \
	85	}
	86
a1e9ca69 RW	87	#define power_attr_ro(_name) \
	88	static struct kobj_attribute _name##_attr = { \
	89	.attr = { \
	90	.name = __stringify(_name), \
	91	.mode = S_IRUGO, \
	92	}, \
	93	.show = _name##_show, \
	94	}
	95
853609b6 RW	96	/* Preferred image size in bytes (default 500 MB) */
853609b6 RW	97	extern unsigned long image_size;
ddeb6487 RW	98	/* Size of memory reserved for drivers (default SPARE_PAGES x PAGE_SIZE) */
ddeb6487 RW	99	extern unsigned long reserved_size;
f577eb30	100	extern int in_suspend;
61159a31	101	extern dev_t swsusp_resume_device;
9a154d9d	102	extern sector_t swsusp_resume_block;
f577eb30	103
25761b6e RW	104	extern asmlinkage int swsusp_arch_suspend(void);
	105	extern asmlinkage int swsusp_arch_resume(void);
	106
74dfd666 RW	107	extern int create_basic_memory_bitmaps(void);
74dfd666 RW	108	extern void free_basic_memory_bitmaps(void);
64a473cb	109	extern int hibernate_preallocate_memory(void);
f577eb30	110
fb13a28b RW	111	/**
	112	* Auxiliary structure used for reading the snapshot image data and
	113	* metadata from and writing them to the list of page backup entries
	114	* (PBEs) which is the main data structure of swsusp.
	115	*
	116	* Using struct snapshot_handle we can transfer the image, including its
	117	* metadata, as a continuous sequence of bytes with the help of
	118	* snapshot_read_next() and snapshot_write_next().
	119	*
	120	* The code that writes the image to a storage or transfers it to
	121	* the user land is required to use snapshot_read_next() for this
	122	* purpose and it should not make any assumptions regarding the internal
	123	* structure of the image. Similarly, the code that reads the image from
	124	* a storage or transfers it from the user land is required to use
	125	* snapshot_write_next().
	126	*
	127	* This may allow us to change the internal structure of the image
	128	* in the future with considerably less effort.
	129	*/
	130
f577eb30	131	struct snapshot_handle {
fb13a28b RW	132	unsigned int cur; /* number of the block of PAGE_SIZE bytes the
	133	* next operation will refer to (ie. current)
	134	*/
fb13a28b RW	135	void buffer; / address of the block to read from
	136	* or write to
	137	*/
fb13a28b RW	138	int sync_read; /* Set to one to notify the caller of
	139	* snapshot_write_next() that it may
	140	* need to call wait_on_bio_chain()
	141	*/
f577eb30 RW	142	};
f577eb30 RW	143
fb13a28b RW	144	/* This macro returns the address from/to which the caller of
	145	* snapshot_read_next()/snapshot_write_next() is allowed to
	146	* read/write data after the function returns
	147	*/
d3c1b24c	148	#define data_of(handle) ((handle).buffer)
f577eb30	149
b788db79	150	extern unsigned int snapshot_additional_pages(struct zone *zone);
af508b34	151	extern unsigned long snapshot_get_image_size(void);
d3c1b24c JS	152	extern int snapshot_read_next(struct snapshot_handle *handle);
d3c1b24c JS	153	extern int snapshot_write_next(struct snapshot_handle *handle);
8357376d	154	extern void snapshot_write_finalize(struct snapshot_handle *handle);
b788db79	155	extern int snapshot_image_loaded(struct snapshot_handle *handle);
61159a31	156
0709db60 RW	157	/* If unset, the snapshot device cannot be open. */
	158	extern atomic_t snapshot_device_available;
	159
d1d241cc RW	160	extern sector_t alloc_swapdev_block(int swap);
	161	extern void free_all_swap_pages(int swap);
	162	extern int swsusp_swap_in_use(void);
61159a31	163
a634cc10 RW	164	/*
	165	* Flags that can be passed from the hibernatig hernel to the "boot" kernel in
	166	* the image header.
	167	*/
	168	#define SF_PLATFORM_MODE 1
f996fc96	169	#define SF_NOCOMPRESS_MODE 2
081a9d04	170	#define SF_CRC32_MODE 4
a634cc10	171
8b759b84	172	/* kernel/power/hibernate.c */
74c7e2ef	173	extern int swsusp_check(void);
74c7e2ef	174	extern void swsusp_free(void);
a634cc10 RW	175	extern int swsusp_read(unsigned int *flags_p);
a634cc10 RW	176	extern int swsusp_write(unsigned int flags);
c2dd0dae	177	extern void swsusp_close(fmode_t);
62c552cc BS	178	#ifdef CONFIG_SUSPEND
	179	extern int swsusp_unmark(void);
	180	#endif
0d3a9abe RW	181
0d3a9abe RW	182	struct timeval;
b10d9117	183	/* kernel/power/swsusp.c */
db597605	184	extern void swsusp_show_speed(ktime_t, ktime_t, unsigned int, char *);
b10d9117	185
296699de	186	#ifdef CONFIG_SUSPEND
a9d70523	187	/* kernel/power/suspend.c */
62109b43	188	extern const char *pm_labels[];
d431cbc5	189	extern const char *pm_states[];
a9d70523	190
6c961dfb	191	extern int suspend_devices_and_enter(suspend_state_t state);
296699de RW	192	#else /* !CONFIG_SUSPEND */
	193	static inline int suspend_devices_and_enter(suspend_state_t state)
	194	{
	195	return -ENOSYS;
	196	}
	197	#endif /* !CONFIG_SUSPEND */
	198
a9d70523 RW	199	#ifdef CONFIG_PM_TEST_SUSPEND
	200	/* kernel/power/suspend_test.c */
	201	extern void suspend_test_start(void);
	202	extern void suspend_test_finish(const char *label);
	203	#else /* !CONFIG_PM_TEST_SUSPEND */
	204	static inline void suspend_test_start(void) {}
	205	static inline void suspend_test_finish(const char *label) {}
	206	#endif /* !CONFIG_PM_TEST_SUSPEND */
	207
82525756 AS	208	#ifdef CONFIG_PM_SLEEP
82525756 AS	209	/* kernel/power/main.c */
ea00f4f4 LW	210	extern int __pm_notifier_call_chain(unsigned long val, int nr_to_call,
ea00f4f4 LW	211	int *nr_calls);
82525756 AS	212	extern int pm_notifier_call_chain(unsigned long val);
82525756 AS	213	#endif
2f8ed1c6 AB	214
2f8ed1c6 AB	215	#ifdef CONFIG_HIGHMEM
2f8ed1c6 AB	216	int restore_highmem(void);
	217	#else
	218	static inline unsigned int count_highmem_pages(void) { return 0; }
	219	static inline int restore_highmem(void) { return 0; }
	220	#endif
0e7d56e3 RW	221
	222	/*
	223	* Suspend test levels
	224	*/
	225	enum {
	226	/* keep first */
	227	TEST_NONE,
	228	TEST_CORE,
	229	TEST_CPUS,
	230	TEST_PLATFORM,
	231	TEST_DEVICES,
	232	TEST_FREEZER,
	233	/* keep last */
	234	__TEST_AFTER_LAST
	235	};
	236
	237	#define TEST_FIRST TEST_NONE
	238	#define TEST_MAX (__TEST_AFTER_LAST - 1)
4cc79776 RW	239
4cc79776 RW	240	extern int pm_test_level;
b28f5081 JB	241
	242	#ifdef CONFIG_SUSPEND_FREEZER
	243	static inline int suspend_freeze_processes(void)
	244	{
379e0be8 SB	245	int error;
	246
	247	error = freeze_processes();
379e0be8 SB	248	/*
	249	* freeze_processes() automatically thaws every task if freezing
	250	* fails. So we need not do anything extra upon error.
	251	*/
	252	if (error)
6f585f75	253	return error;
379e0be8 SB	254
379e0be8 SB	255	error = freeze_kernel_threads();
379e0be8 SB	256	/*
	257	* freeze_kernel_threads() thaws only kernel threads upon freezing
	258	* failure. So we have to thaw the userspace tasks ourselves.
	259	*/
	260	if (error)
	261	thaw_processes();
	262
379e0be8	263	return error;
b28f5081 JB	264	}
	265
	266	static inline void suspend_thaw_processes(void)
	267	{
	268	thaw_processes();
	269	}
	270	#else
	271	static inline int suspend_freeze_processes(void)
	272	{
	273	return 0;
	274	}
	275
	276	static inline void suspend_thaw_processes(void)
	277	{
	278	}
	279	#endif
7483b4a4 RW	280
	281	#ifdef CONFIG_PM_AUTOSLEEP
	282
	283	/* kernel/power/autosleep.c */
	284	extern int pm_autosleep_init(void);
	285	extern int pm_autosleep_lock(void);
	286	extern void pm_autosleep_unlock(void);
	287	extern suspend_state_t pm_autosleep_state(void);
	288	extern int pm_autosleep_set_state(suspend_state_t state);
	289
	290	#else /* !CONFIG_PM_AUTOSLEEP */
	291
	292	static inline int pm_autosleep_init(void) { return 0; }
	293	static inline int pm_autosleep_lock(void) { return 0; }
	294	static inline void pm_autosleep_unlock(void) {}
	295	static inline suspend_state_t pm_autosleep_state(void) { return PM_SUSPEND_ON; }
	296
	297	#endif /* !CONFIG_PM_AUTOSLEEP */
b86ff982 RW	298
	299	#ifdef CONFIG_PM_WAKELOCKS
	300
	301	/* kernel/power/wakelock.c */
	302	extern ssize_t pm_show_wakelocks(char *buf, bool show_active);
	303	extern int pm_wake_lock(const char *buf);
	304	extern int pm_wake_unlock(const char *buf);
	305
	306	#endif /* !CONFIG_PM_WAKELOCKS */