[GitHub/mt8127/android_kernel_alcatel_ttab.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_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_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;
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)
{
	return freeze_processes();
}

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