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