1 # SPDX-License-Identifier: GPL-2.0-only 1 # SPDX-License-Identifier: GPL-2.0-only
2 config SUSPEND 2 config SUSPEND
3 bool "Suspend to RAM and standby" 3 bool "Suspend to RAM and standby"
4 depends on ARCH_SUSPEND_POSSIBLE 4 depends on ARCH_SUSPEND_POSSIBLE
5 default y 5 default y
6 help !! 6 ---help---
7 Allow the system to enter sleep stat 7 Allow the system to enter sleep states in which main memory is
8 powered and thus its contents are pr 8 powered and thus its contents are preserved, such as the
9 suspend-to-RAM state (e.g. the ACPI 9 suspend-to-RAM state (e.g. the ACPI S3 state).
10 10
11 config SUSPEND_FREEZER 11 config SUSPEND_FREEZER
12 bool "Enable freezer for suspend to RA 12 bool "Enable freezer for suspend to RAM/standby" \
13 if ARCH_WANTS_FREEZER_CONTROL 13 if ARCH_WANTS_FREEZER_CONTROL || BROKEN
14 depends on SUSPEND 14 depends on SUSPEND
15 default y 15 default y
16 help 16 help
17 This allows you to turn off the free 17 This allows you to turn off the freezer for suspend. If this is
18 done, no tasks are frozen for suspen 18 done, no tasks are frozen for suspend to RAM/standby.
19 19
20 Turning OFF this setting is NOT reco 20 Turning OFF this setting is NOT recommended! If in doubt, say Y.
21 21
22 config SUSPEND_SKIP_SYNC 22 config SUSPEND_SKIP_SYNC
23 bool "Skip kernel's sys_sync() on susp 23 bool "Skip kernel's sys_sync() on suspend to RAM/standby"
24 depends on SUSPEND 24 depends on SUSPEND
25 depends on EXPERT 25 depends on EXPERT
26 help 26 help
27 Skip the kernel sys_sync() before fr 27 Skip the kernel sys_sync() before freezing user processes.
28 Some systems prefer not to pay this 28 Some systems prefer not to pay this cost on every invocation
29 of suspend, or they are content with 29 of suspend, or they are content with invoking sync() from
30 user-space before invoking suspend. !! 30 user-space before invoking suspend. Say Y if that's your case.
31 at '/sys/power/sync_on_suspend' to c <<
32 This setting changes the default for <<
33 to change the default to disable the <<
34 31
35 config HIBERNATE_CALLBACKS 32 config HIBERNATE_CALLBACKS
36 bool 33 bool
37 34
38 config HIBERNATION 35 config HIBERNATION
39 bool "Hibernation (aka 'suspend to dis 36 bool "Hibernation (aka 'suspend to disk')"
40 depends on SWAP && ARCH_HIBERNATION_PO 37 depends on SWAP && ARCH_HIBERNATION_POSSIBLE
41 select HIBERNATE_CALLBACKS 38 select HIBERNATE_CALLBACKS
>> 39 select LZO_COMPRESS
>> 40 select LZO_DECOMPRESS
42 select CRC32 41 select CRC32
43 select CRYPTO !! 42 ---help---
44 select CRYPTO_LZO <<
45 help <<
46 Enable the suspend to disk (STD) fun 43 Enable the suspend to disk (STD) functionality, which is usually
47 called "hibernation" in user interfa 44 called "hibernation" in user interfaces. STD checkpoints the
48 system and powers it off; and restor 45 system and powers it off; and restores that checkpoint on reboot.
49 46
50 You can suspend your machine with 'e 47 You can suspend your machine with 'echo disk > /sys/power/state'
51 after placing resume=/dev/swappartit 48 after placing resume=/dev/swappartition on the kernel command line
52 in your bootloader's configuration f 49 in your bootloader's configuration file.
53 50
54 Alternatively, you can use the addit 51 Alternatively, you can use the additional userland tools available
55 from <http://suspend.sf.net>. 52 from <http://suspend.sf.net>.
56 53
57 In principle it does not require ACP 54 In principle it does not require ACPI or APM, although for example
58 ACPI will be used for the final step 55 ACPI will be used for the final steps when it is available. One
59 of the reasons to use software suspe 56 of the reasons to use software suspend is that the firmware hooks
60 for suspend states like suspend-to-R 57 for suspend states like suspend-to-RAM (STR) often don't work very
61 well with Linux. 58 well with Linux.
62 59
63 It creates an image which is saved i 60 It creates an image which is saved in your active swap. Upon the next
64 boot, pass the 'resume=/dev/swappart 61 boot, pass the 'resume=/dev/swappartition' argument to the kernel to
65 have it detect the saved image, rest 62 have it detect the saved image, restore memory state from it, and
66 continue to run as before. If you do 63 continue to run as before. If you do not want the previous state to
67 be reloaded, then use the 'noresume' 64 be reloaded, then use the 'noresume' kernel command line argument.
68 Note, however, that fsck will be run 65 Note, however, that fsck will be run on your filesystems and you will
69 need to run mkswap against the swap 66 need to run mkswap against the swap partition used for the suspend.
70 67
71 It also works with swap files to a l 68 It also works with swap files to a limited extent (for details see
72 <file:Documentation/power/swsusp-and 69 <file:Documentation/power/swsusp-and-swap-files.rst>).
73 70
74 Right now you may boot without resum 71 Right now you may boot without resuming and resume later but in the
75 meantime you cannot use the swap par 72 meantime you cannot use the swap partition(s)/file(s) involved in
76 suspending. Also in this case you m 73 suspending. Also in this case you must not use the filesystems
77 that were mounted before the suspend 74 that were mounted before the suspend. In particular, you MUST NOT
78 MOUNT any journaled filesystems moun 75 MOUNT any journaled filesystems mounted before the suspend or they
79 will get corrupted in a nasty way. 76 will get corrupted in a nasty way.
80 77
81 For more information take a look at 78 For more information take a look at <file:Documentation/power/swsusp.rst>.
82 79
83 config HIBERNATION_SNAPSHOT_DEV !! 80 config ARCH_SAVE_PAGE_KEYS
84 bool "Userspace snapshot device" !! 81 bool
85 depends on HIBERNATION <<
86 default y <<
87 help <<
88 Device used by the uswsusp tools. <<
89 <<
90 Say N if no snapshotting from usersp <<
91 reduces the attack surface of the ke <<
92 <<
93 If in doubt, say Y. <<
94 <<
95 choice <<
96 prompt "Default compressor" <<
97 default HIBERNATION_COMP_LZO <<
98 depends on HIBERNATION <<
99 <<
100 config HIBERNATION_COMP_LZO <<
101 bool "lzo" <<
102 depends on CRYPTO_LZO <<
103 <<
104 config HIBERNATION_COMP_LZ4 <<
105 bool "lz4" <<
106 depends on CRYPTO_LZ4 <<
107 <<
108 endchoice <<
109 <<
110 config HIBERNATION_DEF_COMP <<
111 string <<
112 default "lzo" if HIBERNATION_COMP_LZO <<
113 default "lz4" if HIBERNATION_COMP_LZ4 <<
114 help <<
115 Default compressor to be used for hi <<
116 82
117 config PM_STD_PARTITION 83 config PM_STD_PARTITION
118 string "Default resume partition" 84 string "Default resume partition"
119 depends on HIBERNATION 85 depends on HIBERNATION
120 default "" 86 default ""
121 help !! 87 ---help---
122 The default resume partition is the 88 The default resume partition is the partition that the suspend-
123 to-disk implementation will look for !! 89 to-disk implementation will look for a suspended disk image.
124 90
125 The partition specified here will be !! 91 The partition specified here will be different for almost every user.
126 It should be a valid swap partition 92 It should be a valid swap partition (at least for now) that is turned
127 on before suspending. !! 93 on before suspending.
128 94
129 The partition specified can be overr 95 The partition specified can be overridden by specifying:
130 96
131 resume=/dev/<other device> !! 97 resume=/dev/<other device>
132 98
133 which will set the resume partition !! 99 which will set the resume partition to the device specified.
134 100
135 Note there is currently not a way to 101 Note there is currently not a way to specify which device to save the
136 suspended image to. It will simply p !! 102 suspended image to. It will simply pick the first available swap
137 device. 103 device.
138 104
139 config PM_SLEEP 105 config PM_SLEEP
140 def_bool y 106 def_bool y
141 depends on SUSPEND || HIBERNATE_CALLBA 107 depends on SUSPEND || HIBERNATE_CALLBACKS
142 select PM 108 select PM
>> 109 select SRCU
143 110
144 config PM_SLEEP_SMP 111 config PM_SLEEP_SMP
145 def_bool y 112 def_bool y
146 depends on SMP 113 depends on SMP
147 depends on ARCH_SUSPEND_POSSIBLE || AR 114 depends on ARCH_SUSPEND_POSSIBLE || ARCH_HIBERNATION_POSSIBLE
148 depends on PM_SLEEP 115 depends on PM_SLEEP
149 select HOTPLUG_CPU 116 select HOTPLUG_CPU
150 117
151 config PM_SLEEP_SMP_NONZERO_CPU 118 config PM_SLEEP_SMP_NONZERO_CPU
152 def_bool y 119 def_bool y
153 depends on PM_SLEEP_SMP 120 depends on PM_SLEEP_SMP
154 depends on ARCH_SUSPEND_NONZERO_CPU 121 depends on ARCH_SUSPEND_NONZERO_CPU
155 help !! 122 ---help---
156 If an arch can suspend (for suspend, h 123 If an arch can suspend (for suspend, hibernate, kexec, etc) on a
157 non-zero numbered CPU, it may define A 124 non-zero numbered CPU, it may define ARCH_SUSPEND_NONZERO_CPU. This
158 will allow nohz_full mask to include C 125 will allow nohz_full mask to include CPU0.
159 126
160 config PM_AUTOSLEEP 127 config PM_AUTOSLEEP
161 bool "Opportunistic sleep" 128 bool "Opportunistic sleep"
162 depends on PM_SLEEP 129 depends on PM_SLEEP
163 help !! 130 default n
>> 131 ---help---
164 Allow the kernel to trigger a system t 132 Allow the kernel to trigger a system transition into a global sleep
165 state automatically whenever there are 133 state automatically whenever there are no active wakeup sources.
166 134
167 config PM_USERSPACE_AUTOSLEEP <<
168 bool "Userspace opportunistic sleep" <<
169 depends on PM_SLEEP <<
170 help <<
171 Notify kernel of aggressive userspace <<
172 <<
173 This option changes the behavior of va <<
174 with frequent userspace-initiated tran <<
175 <<
176 Saying Y here, disables code paths tha <<
177 enabled. In particular, only enable th <<
178 asleep/awake for very short periods of <<
179 <<
180 Only platforms, such as Android, that <<
181 a userspace power manager service shou <<
182 other machines. Therefore, you should <<
183 extremely certain that this is what yo <<
184 bad, undesirable effects, and should n <<
185 <<
186 <<
187 config PM_WAKELOCKS 135 config PM_WAKELOCKS
188 bool "User space wakeup sources interf 136 bool "User space wakeup sources interface"
189 depends on PM_SLEEP 137 depends on PM_SLEEP
190 help !! 138 default n
>> 139 ---help---
191 Allow user space to create, activate a 140 Allow user space to create, activate and deactivate wakeup source
192 objects with the help of a sysfs-based 141 objects with the help of a sysfs-based interface.
193 142
194 config PM_WAKELOCKS_LIMIT 143 config PM_WAKELOCKS_LIMIT
195 int "Maximum number of user space wake 144 int "Maximum number of user space wakeup sources (0 = no limit)"
196 range 0 100000 145 range 0 100000
197 default 100 146 default 100
198 depends on PM_WAKELOCKS 147 depends on PM_WAKELOCKS
199 148
200 config PM_WAKELOCKS_GC 149 config PM_WAKELOCKS_GC
201 bool "Garbage collector for user space 150 bool "Garbage collector for user space wakeup sources"
202 depends on PM_WAKELOCKS 151 depends on PM_WAKELOCKS
203 default y 152 default y
204 153
205 config PM 154 config PM
206 bool "Device power management core fun 155 bool "Device power management core functionality"
207 help !! 156 ---help---
208 Enable functionality allowing I/O de 157 Enable functionality allowing I/O devices to be put into energy-saving
209 (low power) states, for example afte 158 (low power) states, for example after a specified period of inactivity
210 (autosuspended), and woken up in res 159 (autosuspended), and woken up in response to a hardware-generated
211 wake-up event or a driver's request. 160 wake-up event or a driver's request.
212 161
213 Hardware support is generally requir 162 Hardware support is generally required for this functionality to work
214 and the bus type drivers of the buse 163 and the bus type drivers of the buses the devices are on are
215 responsible for the actual handling 164 responsible for the actual handling of device suspend requests and
216 wake-up events. 165 wake-up events.
217 166
218 config PM_DEBUG 167 config PM_DEBUG
219 bool "Power Management Debug Support" 168 bool "Power Management Debug Support"
220 depends on PM 169 depends on PM
221 help !! 170 ---help---
222 This option enables various debugging 171 This option enables various debugging support in the Power Management
223 code. This is helpful when debugging a 172 code. This is helpful when debugging and reporting PM bugs, like
224 suspend support. 173 suspend support.
225 174
226 config PM_ADVANCED_DEBUG 175 config PM_ADVANCED_DEBUG
227 bool "Extra PM attributes in sysfs for 176 bool "Extra PM attributes in sysfs for low-level debugging/testing"
228 depends on PM_DEBUG 177 depends on PM_DEBUG
229 help !! 178 ---help---
230 Add extra sysfs attributes allowing on 179 Add extra sysfs attributes allowing one to access some Power Management
231 fields of device objects from user spa 180 fields of device objects from user space. If you are not a kernel
232 developer interested in debugging/test 181 developer interested in debugging/testing Power Management, say "no".
233 182
234 config PM_TEST_SUSPEND 183 config PM_TEST_SUSPEND
235 bool "Test suspend/resume and wakealar 184 bool "Test suspend/resume and wakealarm during bootup"
236 depends on SUSPEND && PM_DEBUG && RTC_ 185 depends on SUSPEND && PM_DEBUG && RTC_CLASS=y
237 help !! 186 ---help---
238 This option will let you suspend your 187 This option will let you suspend your machine during bootup, and
239 make it wake up a few seconds later us 188 make it wake up a few seconds later using an RTC wakeup alarm.
240 Enable this with a kernel parameter li 189 Enable this with a kernel parameter like "test_suspend=mem".
241 190
242 You probably want to have your system' 191 You probably want to have your system's RTC driver statically
243 linked, ensuring that it's available w 192 linked, ensuring that it's available when this test runs.
244 193
245 config PM_SLEEP_DEBUG 194 config PM_SLEEP_DEBUG
246 def_bool y 195 def_bool y
247 depends on PM_DEBUG && PM_SLEEP 196 depends on PM_DEBUG && PM_SLEEP
248 197
249 config DPM_WATCHDOG 198 config DPM_WATCHDOG
250 bool "Device suspend/resume watchdog" 199 bool "Device suspend/resume watchdog"
251 depends on PM_DEBUG && PSTORE && EXPER 200 depends on PM_DEBUG && PSTORE && EXPERT
252 help !! 201 ---help---
253 Sets up a watchdog timer to capture 202 Sets up a watchdog timer to capture drivers that are
254 locked up attempting to suspend/resu 203 locked up attempting to suspend/resume a device.
255 A detected lockup causes system pani 204 A detected lockup causes system panic with message
256 captured in pstore device for inspec 205 captured in pstore device for inspection in subsequent
257 boot session. 206 boot session.
258 207
259 config DPM_WATCHDOG_TIMEOUT 208 config DPM_WATCHDOG_TIMEOUT
260 int "Watchdog timeout in seconds" 209 int "Watchdog timeout in seconds"
261 range 1 120 210 range 1 120
262 default 120 211 default 120
263 depends on DPM_WATCHDOG 212 depends on DPM_WATCHDOG
264 213
265 config PM_TRACE 214 config PM_TRACE
266 bool 215 bool
267 help 216 help
268 This enables code to save the last P 217 This enables code to save the last PM event point across
269 reboot. The architecture needs to su 218 reboot. The architecture needs to support this, x86 for
270 example does by saving things in the 219 example does by saving things in the RTC, see below.
271 220
272 The architecture specific code must 221 The architecture specific code must provide the extern
273 functions from <linux/resume-trace.h 222 functions from <linux/resume-trace.h> as well as the
274 <asm/resume-trace.h> header with a T 223 <asm/resume-trace.h> header with a TRACE_RESUME() macro.
275 224
276 The way the information is presented 225 The way the information is presented is architecture-
277 dependent, x86 will print the inform 226 dependent, x86 will print the information during a
278 late_initcall. 227 late_initcall.
279 228
280 config PM_TRACE_RTC 229 config PM_TRACE_RTC
281 bool "Suspend/resume event tracing" 230 bool "Suspend/resume event tracing"
282 depends on PM_SLEEP_DEBUG 231 depends on PM_SLEEP_DEBUG
283 depends on X86 232 depends on X86
284 select PM_TRACE 233 select PM_TRACE
285 help !! 234 ---help---
286 This enables some cheesy code to save 235 This enables some cheesy code to save the last PM event point in the
287 RTC across reboots, so that you can de 236 RTC across reboots, so that you can debug a machine that just hangs
288 during suspend (or more commonly, duri 237 during suspend (or more commonly, during resume).
289 238
290 To use this debugging feature you shou 239 To use this debugging feature you should attempt to suspend the
291 machine, reboot it and then run 240 machine, reboot it and then run
292 241
293 dmesg -s 1000000 | grep 'hash 242 dmesg -s 1000000 | grep 'hash matches'
294 243
295 CAUTION: this option will cause your m 244 CAUTION: this option will cause your machine's real-time clock to be
296 set to an invalid time after a resume. 245 set to an invalid time after a resume.
297 246
298 config APM_EMULATION 247 config APM_EMULATION
299 tristate "Advanced Power Management Em 248 tristate "Advanced Power Management Emulation"
300 depends on SYS_SUPPORTS_APM_EMULATION 249 depends on SYS_SUPPORTS_APM_EMULATION
301 help 250 help
302 APM is a BIOS specification for savi 251 APM is a BIOS specification for saving power using several different
303 techniques. This is mostly useful fo 252 techniques. This is mostly useful for battery powered laptops with
304 APM compliant BIOSes. If you say Y h 253 APM compliant BIOSes. If you say Y here, the system time will be
305 reset after a RESUME operation, the 254 reset after a RESUME operation, the /proc/apm device will provide
306 battery status information, and user 255 battery status information, and user-space programs will receive
307 notification of APM "events" (e.g. b 256 notification of APM "events" (e.g. battery status change).
308 257
309 In order to use APM, you will need s 258 In order to use APM, you will need supporting software. For location
310 and more information, read <file:Doc 259 and more information, read <file:Documentation/power/apm-acpi.rst>
311 and the Battery Powered Linux mini-H 260 and the Battery Powered Linux mini-HOWTO, available from
312 <http://www.tldp.org/docs.html#howto 261 <http://www.tldp.org/docs.html#howto>.
313 262
314 This driver does not spin down disk 263 This driver does not spin down disk drives (see the hdparm(8)
315 manpage ("man 8 hdparm") for that), 264 manpage ("man 8 hdparm") for that), and it doesn't turn off
316 VESA-compliant "green" monitors. 265 VESA-compliant "green" monitors.
317 266
318 Generally, if you don't have a batte 267 Generally, if you don't have a battery in your machine, there isn't
319 much point in using this driver and 268 much point in using this driver and you should say N. If you get
320 random kernel OOPSes or reboots that 269 random kernel OOPSes or reboots that don't seem to be related to
321 anything, try disabling/enabling thi 270 anything, try disabling/enabling this option (or disabling/enabling
322 APM in your BIOS). 271 APM in your BIOS).
323 272
324 config PM_CLK 273 config PM_CLK
325 def_bool y 274 def_bool y
326 depends on PM && HAVE_CLK 275 depends on PM && HAVE_CLK
327 276
328 config PM_GENERIC_DOMAINS 277 config PM_GENERIC_DOMAINS
329 bool 278 bool
330 depends on PM 279 depends on PM
331 280
332 config WQ_POWER_EFFICIENT_DEFAULT 281 config WQ_POWER_EFFICIENT_DEFAULT
333 bool "Enable workqueue power-efficient 282 bool "Enable workqueue power-efficient mode by default"
334 depends on PM 283 depends on PM
>> 284 default n
335 help 285 help
336 Per-cpu workqueues are generally pre 286 Per-cpu workqueues are generally preferred because they show
337 better performance thanks to cache l 287 better performance thanks to cache locality; unfortunately,
338 per-cpu workqueues tend to be more p 288 per-cpu workqueues tend to be more power hungry than unbound
339 workqueues. 289 workqueues.
340 290
341 Enabling workqueue.power_efficient k 291 Enabling workqueue.power_efficient kernel parameter makes the
342 per-cpu workqueues which were observ 292 per-cpu workqueues which were observed to contribute
343 significantly to power consumption u 293 significantly to power consumption unbound, leading to measurably
344 lower power usage at the cost of sma 294 lower power usage at the cost of small performance overhead.
345 295
346 This config option determines whethe 296 This config option determines whether workqueue.power_efficient
347 is enabled by default. 297 is enabled by default.
348 298
349 If in doubt, say N. 299 If in doubt, say N.
350 300
351 config PM_GENERIC_DOMAINS_SLEEP 301 config PM_GENERIC_DOMAINS_SLEEP
352 def_bool y 302 def_bool y
353 depends on PM_SLEEP && PM_GENERIC_DOMA 303 depends on PM_SLEEP && PM_GENERIC_DOMAINS
354 304
355 config PM_GENERIC_DOMAINS_OF 305 config PM_GENERIC_DOMAINS_OF
356 def_bool y 306 def_bool y
357 depends on PM_GENERIC_DOMAINS && OF 307 depends on PM_GENERIC_DOMAINS && OF
358 308
359 config CPU_PM 309 config CPU_PM
360 bool 310 bool
361 311
362 config ENERGY_MODEL 312 config ENERGY_MODEL
363 bool "Energy Model for devices with DV !! 313 bool "Energy Model for CPUs"
364 depends on SMP 314 depends on SMP
365 depends on CPU_FREQ 315 depends on CPU_FREQ
>> 316 default n
366 help 317 help
367 Several subsystems (thermal and/or t 318 Several subsystems (thermal and/or the task scheduler for example)
368 can leverage information about the e !! 319 can leverage information about the energy consumed by CPUs to make
369 make smarter decisions. This config !! 320 smarter decisions. This config option enables the framework from
370 from which subsystems can access the !! 321 which subsystems can access the energy models.
371 322
372 The exact usage of the energy model 323 The exact usage of the energy model is subsystem-dependent.
373 324
374 If in doubt, say N. 325 If in doubt, say N.
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.