[GitHub/mt8127/android_kernel_alcatel_ttab.git] / kernel / power / power.h

#include <linux/suspend.h>
#include <linux/suspend_ioctls.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);

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

#ifdef CONFIG_HIGHMEM
unsigned int count_highmem_pages(void);
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;
Commit	Line	Data
1da177e4	1	#include <linux/suspend.h>
3010f8ca	2	#include <linux/suspend_ioctls.h>
1da177e4 LT	3	#include <linux/utsname.h>
1da177e4 LT	4
1da177e4 LT	5	struct swsusp_info {
	6	struct new_utsname uts;
	7	u32 version_code;
	8	unsigned long num_physpages;
	9	int cpus;
	10	unsigned long image_pages;
7088a5c0	11	unsigned long pages;
6e1819d6	12	unsigned long size;
1da177e4 LT	13	} __attribute__((aligned(PAGE_SIZE)));
1da177e4 LT	14
d307c4a8 RW	15	#ifdef CONFIG_HIBERNATION
	16	#ifdef CONFIG_ARCH_HIBERNATION_HEADER
	17	/* Maximum size of architecture specific data in a hibernation header */
	18	#define MAX_ARCH_HEADER_SIZE (sizeof(struct new_utsname) + 4)
1da177e4	19
d307c4a8 RW	20	extern int arch_hibernation_header_save(void *addr, unsigned int max_size);
	21	extern int arch_hibernation_header_restore(void *addr);
	22
	23	static inline int init_header_complete(struct swsusp_info *info)
	24	{
	25	return arch_hibernation_header_save(info, MAX_ARCH_HEADER_SIZE);
	26	}
	27
	28	static inline char check_image_kernel(struct swsusp_info info)
	29	{
	30	return arch_hibernation_header_restore(info) ?
	31	"architecture specific data" : NULL;
	32	}
	33	#endif /* CONFIG_ARCH_HIBERNATION_HEADER */
1da177e4	34
56f99bcb RW	35	/*
	36	* Keep some memory free so that I/O operations can succeed without paging
	37	* [Might this be more than 4 MB?]
	38	*/
	39	#define PAGES_FOR_IO ((4096 * 1024) >> PAGE_SHIFT)
d307c4a8	40
56f99bcb RW	41	/*
	42	* Keep 1 MB of memory free so that device drivers can allocate some pages in
	43	* their .suspend() routines without breaking the suspend to disk.
	44	*/
	45	#define SPARE_PAGES ((1024 * 1024) >> PAGE_SHIFT)
1da177e4	46
7777fab9 RW	47	/* kernel/power/disk.c */
7777fab9 RW	48	extern int hibernation_snapshot(int platform_mode);
a634cc10	49	extern int hibernation_restore(int platform_mode);
7777fab9	50	extern int hibernation_platform_enter(void);
1da177e4	51	#endif
a6d70980	52
49c3df6a VG	53	extern int pfn_is_nosave(unsigned long);
49c3df6a VG	54
a6d70980 SH	55	extern struct mutex pm_mutex;
a6d70980 SH	56
1da177e4	57	#define power_attr(_name) \
386f275f	58	static struct kobj_attribute _name##_attr = { \
1da177e4 LT	59	.attr = { \
	60	.name = __stringify(_name), \
	61	.mode = 0644, \
	62	}, \
	63	.show = _name##_show, \
	64	.store = _name##_store, \
	65	}
	66
853609b6 RW	67	/* Preferred image size in bytes (default 500 MB) */
853609b6 RW	68	extern unsigned long image_size;
f577eb30	69	extern int in_suspend;
61159a31	70	extern dev_t swsusp_resume_device;
9a154d9d	71	extern sector_t swsusp_resume_block;
f577eb30	72
25761b6e RW	73	extern asmlinkage int swsusp_arch_suspend(void);
	74	extern asmlinkage int swsusp_arch_resume(void);
	75
74dfd666 RW	76	extern int create_basic_memory_bitmaps(void);
74dfd666 RW	77	extern void free_basic_memory_bitmaps(void);
72a97e08	78	extern unsigned int count_data_pages(void);
f577eb30	79
fb13a28b RW	80	/**
	81	* Auxiliary structure used for reading the snapshot image data and
	82	* metadata from and writing them to the list of page backup entries
	83	* (PBEs) which is the main data structure of swsusp.
	84	*
	85	* Using struct snapshot_handle we can transfer the image, including its
	86	* metadata, as a continuous sequence of bytes with the help of
	87	* snapshot_read_next() and snapshot_write_next().
	88	*
	89	* The code that writes the image to a storage or transfers it to
	90	* the user land is required to use snapshot_read_next() for this
	91	* purpose and it should not make any assumptions regarding the internal
	92	* structure of the image. Similarly, the code that reads the image from
	93	* a storage or transfers it from the user land is required to use
	94	* snapshot_write_next().
	95	*
	96	* This may allow us to change the internal structure of the image
	97	* in the future with considerably less effort.
	98	*/
	99
f577eb30	100	struct snapshot_handle {
fb13a28b RW	101	loff_t offset; /* number of the last byte ready for reading
	102	* or writing in the sequence
	103	*/
	104	unsigned int cur; /* number of the block of PAGE_SIZE bytes the
	105	* next operation will refer to (ie. current)
	106	*/
	107	unsigned int cur_offset; /* offset with respect to the current
	108	* block (for the next operation)
	109	*/
	110	unsigned int prev; /* number of the block of PAGE_SIZE bytes that
	111	* was the current one previously
	112	*/
fb13a28b RW	113	void buffer; / address of the block to read from
	114	* or write to
	115	*/
	116	unsigned int buf_offset; /* location to read from or write to,
	117	* given as a displacement from 'buffer'
	118	*/
	119	int sync_read; /* Set to one to notify the caller of
	120	* snapshot_write_next() that it may
	121	* need to call wait_on_bio_chain()
	122	*/
f577eb30 RW	123	};
f577eb30 RW	124
fb13a28b RW	125	/* This macro returns the address from/to which the caller of
	126	* snapshot_read_next()/snapshot_write_next() is allowed to
	127	* read/write data after the function returns
	128	*/
f577eb30 RW	129	#define data_of(handle) ((handle).buffer + (handle).buf_offset)
f577eb30 RW	130
b788db79	131	extern unsigned int snapshot_additional_pages(struct zone *zone);
af508b34	132	extern unsigned long snapshot_get_image_size(void);
f577eb30 RW	133	extern int snapshot_read_next(struct snapshot_handle *handle, size_t count);
f577eb30 RW	134	extern int snapshot_write_next(struct snapshot_handle *handle, size_t count);
8357376d	135	extern void snapshot_write_finalize(struct snapshot_handle *handle);
b788db79	136	extern int snapshot_image_loaded(struct snapshot_handle *handle);
61159a31	137
0709db60 RW	138	/* If unset, the snapshot device cannot be open. */
	139	extern atomic_t snapshot_device_available;
	140
d1d241cc RW	141	extern sector_t alloc_swapdev_block(int swap);
	142	extern void free_all_swap_pages(int swap);
	143	extern int swsusp_swap_in_use(void);
61159a31	144
a634cc10 RW	145	/*
	146	* Flags that can be passed from the hibernatig hernel to the "boot" kernel in
	147	* the image header.
	148	*/
	149	#define SF_PLATFORM_MODE 1
	150
	151	/* kernel/power/disk.c */
74c7e2ef	152	extern int swsusp_check(void);
61159a31	153	extern int swsusp_shrink_memory(void);
74c7e2ef	154	extern void swsusp_free(void);
61159a31	155	extern int swsusp_resume(void);
a634cc10 RW	156	extern int swsusp_read(unsigned int *flags_p);
a634cc10 RW	157	extern int swsusp_write(unsigned int flags);
74c7e2ef	158	extern void swsusp_close(void);
0d3a9abe RW	159
0d3a9abe RW	160	struct timeval;
b10d9117	161	/* kernel/power/swsusp.c */
0d3a9abe RW	162	extern void swsusp_show_speed(struct timeval , struct timeval ,
0d3a9abe RW	163	unsigned int, char *);
b10d9117	164
296699de	165	#ifdef CONFIG_SUSPEND
b10d9117	166	/* kernel/power/main.c */
6c961dfb	167	extern int suspend_devices_and_enter(suspend_state_t state);
296699de RW	168	#else /* !CONFIG_SUSPEND */
	169	static inline int suspend_devices_and_enter(suspend_state_t state)
	170	{
	171	return -ENOSYS;
	172	}
	173	#endif /* !CONFIG_SUSPEND */
	174
	175	/* kernel/power/common.c */
b10d9117 RW	176	extern struct blocking_notifier_head pm_chain_head;
	177
	178	static inline int pm_notifier_call_chain(unsigned long val)
	179	{
	180	return (blocking_notifier_call_chain(&pm_chain_head, val, NULL)
	181	== NOTIFY_BAD) ? -EINVAL : 0;
	182	}
2f8ed1c6 AB	183
	184	#ifdef CONFIG_HIGHMEM
	185	unsigned int count_highmem_pages(void);
	186	int restore_highmem(void);
	187	#else
	188	static inline unsigned int count_highmem_pages(void) { return 0; }
	189	static inline int restore_highmem(void) { return 0; }
	190	#endif
0e7d56e3 RW	191
	192	/*
	193	* Suspend test levels
	194	*/
	195	enum {
	196	/* keep first */
	197	TEST_NONE,
	198	TEST_CORE,
	199	TEST_CPUS,
	200	TEST_PLATFORM,
	201	TEST_DEVICES,
	202	TEST_FREEZER,
	203	/* keep last */
	204	__TEST_AFTER_LAST
	205	};
	206
	207	#define TEST_FIRST TEST_NONE
	208	#define TEST_MAX (__TEST_AFTER_LAST - 1)
4cc79776 RW	209
4cc79776 RW	210	extern int pm_test_level;