[mirror_ubuntu-hirsute-kernel.git] / kernel / power / power.h

/* SPDX-License-Identifier: GPL-2.0 */
#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 const char *check_image_kernel(struct swsusp_info *info)
{
	return arch_hibernation_header_restore(info) ?
			"architecture specific data" : NULL;
}
#endif /* CONFIG_ARCH_HIBERNATION_HEADER */

extern int hibernate_resume_nonboot_cpu_disable(void);

/*
 * 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_STRICT_KERNEL_RWX
/* kernel/power/snapshot.c */
extern void enable_restore_image_protection(void);
#else
static inline void enable_restore_image_protection(void) {}
#endif /* CONFIG_STRICT_KERNEL_RWX */

#else /* !CONFIG_HIBERNATION */

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

#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 int create_basic_memory_bitmaps(void);
extern void free_basic_memory_bitmaps(void);
extern int hibernate_preallocate_memory(void);

extern void clear_free_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 {
	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);

extern bool hibernate_acquire(void);
extern void hibernate_release(void);

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 __kernel_old_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 * const pm_labels[];
extern const char *pm_states[];
extern const char *mem_sleep_states[];

extern int suspend_devices_and_enter(suspend_state_t state);
#else /* !CONFIG_SUSPEND */
#define mem_sleep_current	PM_SUSPEND_ON

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_robust(unsigned long val_up, unsigned long val_down);
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)

#ifdef CONFIG_PM_SLEEP_DEBUG
extern int pm_test_level;
#else
#define pm_test_level	(TEST_NONE)
#endif

#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
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4	2	#include <linux/suspend.h>
3010f8ca	3	#include <linux/suspend_ioctls.h>
1da177e4	4	#include <linux/utsname.h>
b28f5081	5	#include <linux/freezer.h>
52f5684c	6	#include <linux/compiler.h>
1da177e4	7
1da177e4 LT	8	struct swsusp_info {
	9	struct new_utsname uts;
	10	u32 version_code;
	11	unsigned long num_physpages;
	12	int cpus;
	13	unsigned long image_pages;
7088a5c0	14	unsigned long pages;
6e1819d6	15	unsigned long size;
52f5684c	16	} __aligned(PAGE_SIZE);
1da177e4	17
d307c4a8	18	#ifdef CONFIG_HIBERNATION
ac5c24ec	19	/* kernel/power/snapshot.c */
ddeb6487	20	extern void __init hibernate_reserved_size_init(void);
ac5c24ec RW	21	extern void __init hibernate_image_size_init(void);
ac5c24ec RW	22
d307c4a8 RW	23	#ifdef CONFIG_ARCH_HIBERNATION_HEADER
	24	/* Maximum size of architecture specific data in a hibernation header */
	25	#define MAX_ARCH_HEADER_SIZE (sizeof(struct new_utsname) + 4)
1da177e4	26
d307c4a8 RW	27	extern int arch_hibernation_header_save(void *addr, unsigned int max_size);
	28	extern int arch_hibernation_header_restore(void *addr);
	29
	30	static inline int init_header_complete(struct swsusp_info *info)
	31	{
	32	return arch_hibernation_header_save(info, MAX_ARCH_HEADER_SIZE);
	33	}
	34
02d7f400	35	static inline const char check_image_kernel(struct swsusp_info info)
d307c4a8 RW	36	{
	37	return arch_hibernation_header_restore(info) ?
	38	"architecture specific data" : NULL;
	39	}
	40	#endif /* CONFIG_ARCH_HIBERNATION_HEADER */
1da177e4	41
406f992e RW	42	extern int hibernate_resume_nonboot_cpu_disable(void);
406f992e RW	43
56f99bcb RW	44	/*
	45	* Keep some memory free so that I/O operations can succeed without paging
	46	* [Might this be more than 4 MB?]
	47	*/
	48	#define PAGES_FOR_IO ((4096 * 1024) >> PAGE_SHIFT)
d307c4a8	49
56f99bcb RW	50	/*
	51	* Keep 1 MB of memory free so that device drivers can allocate some pages in
	52	* their .suspend() routines without breaking the suspend to disk.
	53	*/
	54	#define SPARE_PAGES ((1024 * 1024) >> PAGE_SHIFT)
1da177e4	55
04b73469 RK	56	asmlinkage int swsusp_save(void);
04b73469 RK	57
8b759b84	58	/* kernel/power/hibernate.c */
97819a26 SB	59	extern bool freezer_test_done;
97819a26 SB	60
7777fab9	61	extern int hibernation_snapshot(int platform_mode);
a634cc10	62	extern int hibernation_restore(int platform_mode);
7777fab9	63	extern int hibernation_platform_enter(void);
ac5c24ec	64
0f5bf6d0	65	#ifdef CONFIG_STRICT_KERNEL_RWX
4c0b6c10 RW	66	/* kernel/power/snapshot.c */
	67	extern void enable_restore_image_protection(void);
	68	#else
	69	static inline void enable_restore_image_protection(void) {}
0f5bf6d0	70	#endif /* CONFIG_STRICT_KERNEL_RWX */
4c0b6c10	71
ac5c24ec RW	72	#else /* !CONFIG_HIBERNATION */
ac5c24ec RW	73
ddeb6487	74	static inline void hibernate_reserved_size_init(void) {}
ac5c24ec RW	75	static inline void hibernate_image_size_init(void) {}
ac5c24ec RW	76	#endif /* !CONFIG_HIBERNATION */
a6d70980	77
1da177e4	78	#define power_attr(_name) \
386f275f	79	static struct kobj_attribute _name##_attr = { \
1da177e4 LT	80	.attr = { \
	81	.name = __stringify(_name), \
	82	.mode = 0644, \
	83	}, \
	84	.show = _name##_show, \
	85	.store = _name##_store, \
	86	}
	87
a1e9ca69 RW	88	#define power_attr_ro(_name) \
	89	static struct kobj_attribute _name##_attr = { \
	90	.attr = { \
	91	.name = __stringify(_name), \
	92	.mode = S_IRUGO, \
	93	}, \
	94	.show = _name##_show, \
	95	}
	96
853609b6 RW	97	/* Preferred image size in bytes (default 500 MB) */
853609b6 RW	98	extern unsigned long image_size;
ddeb6487 RW	99	/* Size of memory reserved for drivers (default SPARE_PAGES x PAGE_SIZE) */
ddeb6487 RW	100	extern unsigned long reserved_size;
f577eb30	101	extern int in_suspend;
61159a31	102	extern dev_t swsusp_resume_device;
9a154d9d	103	extern sector_t swsusp_resume_block;
f577eb30	104
74dfd666 RW	105	extern int create_basic_memory_bitmaps(void);
74dfd666 RW	106	extern void free_basic_memory_bitmaps(void);
64a473cb	107	extern int hibernate_preallocate_memory(void);
f577eb30	108
1ad1410f AA	109	extern void clear_free_pages(void);
1ad1410f AA	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
ab7e9b06 DA	157	extern bool hibernate_acquire(void);
ab7e9b06 DA	158	extern void hibernate_release(void);
0709db60	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	181
75d319c0	182	struct __kernel_old_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 */
406e7938	188	extern const char * const pm_labels[];
d431cbc5	189	extern const char *pm_states[];
406e7938	190	extern const char *mem_sleep_states[];
a9d70523	191
6c961dfb	192	extern int suspend_devices_and_enter(suspend_state_t state);
296699de	193	#else /* !CONFIG_SUSPEND */
406e7938 RW	194	#define mem_sleep_current PM_SUSPEND_ON
406e7938 RW	195
296699de RW	196	static inline int suspend_devices_and_enter(suspend_state_t state)
	197	{
	198	return -ENOSYS;
	199	}
	200	#endif /* !CONFIG_SUSPEND */
	201
a9d70523 RW	202	#ifdef CONFIG_PM_TEST_SUSPEND
	203	/* kernel/power/suspend_test.c */
	204	extern void suspend_test_start(void);
	205	extern void suspend_test_finish(const char *label);
	206	#else /* !CONFIG_PM_TEST_SUSPEND */
	207	static inline void suspend_test_start(void) {}
	208	static inline void suspend_test_finish(const char *label) {}
	209	#endif /* !CONFIG_PM_TEST_SUSPEND */
	210
82525756 AS	211	#ifdef CONFIG_PM_SLEEP
82525756 AS	212	/* kernel/power/main.c */
70d93298	213	extern int pm_notifier_call_chain_robust(unsigned long val_up, unsigned long val_down);
82525756 AS	214	extern int pm_notifier_call_chain(unsigned long val);
82525756 AS	215	#endif
2f8ed1c6 AB	216
2f8ed1c6 AB	217	#ifdef CONFIG_HIGHMEM
2f8ed1c6 AB	218	int restore_highmem(void);
	219	#else
	220	static inline unsigned int count_highmem_pages(void) { return 0; }
	221	static inline int restore_highmem(void) { return 0; }
	222	#endif
0e7d56e3 RW	223
	224	/*
	225	* Suspend test levels
	226	*/
	227	enum {
	228	/* keep first */
	229	TEST_NONE,
	230	TEST_CORE,
	231	TEST_CPUS,
	232	TEST_PLATFORM,
	233	TEST_DEVICES,
	234	TEST_FREEZER,
	235	/* keep last */
	236	__TEST_AFTER_LAST
	237	};
	238
	239	#define TEST_FIRST TEST_NONE
	240	#define TEST_MAX (__TEST_AFTER_LAST - 1)
4cc79776	241
e516a1db	242	#ifdef CONFIG_PM_SLEEP_DEBUG
4cc79776	243	extern int pm_test_level;
8e6bcd9f RW	244	#else
	245	#define pm_test_level (TEST_NONE)
	246	#endif
b28f5081 JB	247
	248	#ifdef CONFIG_SUSPEND_FREEZER
	249	static inline int suspend_freeze_processes(void)
	250	{
379e0be8 SB	251	int error;
	252
	253	error = freeze_processes();
379e0be8 SB	254	/*
	255	* freeze_processes() automatically thaws every task if freezing
	256	* fails. So we need not do anything extra upon error.
	257	*/
	258	if (error)
6f585f75	259	return error;
379e0be8 SB	260
379e0be8 SB	261	error = freeze_kernel_threads();
379e0be8 SB	262	/*
	263	* freeze_kernel_threads() thaws only kernel threads upon freezing
	264	* failure. So we have to thaw the userspace tasks ourselves.
	265	*/
	266	if (error)
	267	thaw_processes();
	268
379e0be8	269	return error;
b28f5081 JB	270	}
	271
	272	static inline void suspend_thaw_processes(void)
	273	{
	274	thaw_processes();
	275	}
	276	#else
	277	static inline int suspend_freeze_processes(void)
	278	{
	279	return 0;
	280	}
	281
	282	static inline void suspend_thaw_processes(void)
	283	{
	284	}
	285	#endif
7483b4a4 RW	286
	287	#ifdef CONFIG_PM_AUTOSLEEP
	288
	289	/* kernel/power/autosleep.c */
	290	extern int pm_autosleep_init(void);
	291	extern int pm_autosleep_lock(void);
	292	extern void pm_autosleep_unlock(void);
	293	extern suspend_state_t pm_autosleep_state(void);
	294	extern int pm_autosleep_set_state(suspend_state_t state);
	295
	296	#else /* !CONFIG_PM_AUTOSLEEP */
	297
	298	static inline int pm_autosleep_init(void) { return 0; }
	299	static inline int pm_autosleep_lock(void) { return 0; }
	300	static inline void pm_autosleep_unlock(void) {}
	301	static inline suspend_state_t pm_autosleep_state(void) { return PM_SUSPEND_ON; }
	302
	303	#endif /* !CONFIG_PM_AUTOSLEEP */
b86ff982 RW	304
	305	#ifdef CONFIG_PM_WAKELOCKS
	306
	307	/* kernel/power/wakelock.c */
	308	extern ssize_t pm_show_wakelocks(char *buf, bool show_active);
	309	extern int pm_wake_lock(const char *buf);
	310	extern int pm_wake_unlock(const char *buf);
	311
	312	#endif /* !CONFIG_PM_WAKELOCKS */