Blame view

kernel/power/Kconfig 11.2 KB
ec8f24b7f   Thomas Gleixner   treewide: Add SPD...
1
  # SPDX-License-Identifier: GPL-2.0-only
296699de6   Rafael J. Wysocki   Introduce CONFIG_...
2
3
  config SUSPEND
  	bool "Suspend to RAM and standby"
1eb208aea   Rafael J. Wysocki   PM: Make CONFIG_P...
4
  	depends on ARCH_SUSPEND_POSSIBLE
296699de6   Rafael J. Wysocki   Introduce CONFIG_...
5
  	default y
a7f7f6248   Masahiro Yamada   treewide: replace...
6
  	help
296699de6   Rafael J. Wysocki   Introduce CONFIG_...
7
8
  	  Allow the system to enter sleep states in which main memory is
  	  powered and thus its contents are preserved, such as the
f4cb57007   Johannes Berg   Suspend: Clean up...
9
  	  suspend-to-RAM state (e.g. the ACPI S3 state).
296699de6   Rafael J. Wysocki   Introduce CONFIG_...
10

b28f50811   Johannes Berg   Suspend: Add conf...
11
12
13
14
15
16
17
18
19
20
  config SUSPEND_FREEZER
  	bool "Enable freezer for suspend to RAM/standby" \
  		if ARCH_WANTS_FREEZER_CONTROL || BROKEN
  	depends on SUSPEND
  	default y
  	help
  	  This allows you to turn off the freezer for suspend. If this is
  	  done, no tasks are frozen for suspend to RAM/standby.
  
  	  Turning OFF this setting is NOT recommended! If in doubt, say Y.
2fd77fff4   Len Brown   PM / suspend: mak...
21
22
23
24
25
26
27
28
  config SUSPEND_SKIP_SYNC
  	bool "Skip kernel's sys_sync() on suspend to RAM/standby"
  	depends on SUSPEND
  	depends on EXPERT
  	help
  	  Skip the kernel sys_sync() before freezing user processes.
  	  Some systems prefer not to pay this cost on every invocation
  	  of suspend, or they are content with invoking sync() from
c052bf82c   Jonas Meurer   PM: suspend: Add ...
29
30
31
32
  	  user-space before invoking suspend.  There's a run-time switch
  	  at '/sys/power/sync_on_suspend' to configure this behaviour.
  	  This setting changes the default for the run-tim switch. Say Y
  	  to change the default to disable the kernel sys_sync().
2fd77fff4   Len Brown   PM / suspend: mak...
33

1f112cee0   Rafael J. Wysocki   PM / Hibernate: I...
34
35
  config HIBERNATE_CALLBACKS
  	bool
b0cb1a19d   Rafael J. Wysocki   Replace CONFIG_SO...
36
  config HIBERNATION
296699de6   Rafael J. Wysocki   Introduce CONFIG_...
37
  	bool "Hibernation (aka 'suspend to disk')"
1eb208aea   Rafael J. Wysocki   PM: Make CONFIG_P...
38
  	depends on SWAP && ARCH_HIBERNATION_POSSIBLE
1f112cee0   Rafael J. Wysocki   PM / Hibernate: I...
39
  	select HIBERNATE_CALLBACKS
f996fc967   Bojan Smojver   PM / Hibernate: C...
40
41
  	select LZO_COMPRESS
  	select LZO_DECOMPRESS
081a9d043   Bojan Smojver   PM / Hibernate: I...
42
  	select CRC32
a7f7f6248   Masahiro Yamada   treewide: replace...
43
  	help
a7ee2e5f5   David Brownell   kconfig: mention ...
44
45
46
  	  Enable the suspend to disk (STD) functionality, which is usually
  	  called "hibernation" in user interfaces.  STD checkpoints the
  	  system and powers it off; and restores that checkpoint on reboot.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
47

23b168d42   Pavel Machek   PM: documentation...
48
49
50
  	  You can suspend your machine with 'echo disk > /sys/power/state'
  	  after placing resume=/dev/swappartition on the kernel command line
  	  in your bootloader's configuration file.
c7276fde2   Rafael J. Wysocki   [PATCH] kconfig: ...
51
52
53
54
  	  Alternatively, you can use the additional userland tools available
  	  from <http://suspend.sf.net>.
  
  	  In principle it does not require ACPI or APM, although for example
a7ee2e5f5   David Brownell   kconfig: mention ...
55
56
57
58
  	  ACPI will be used for the final steps when it is available.  One
  	  of the reasons to use software suspend is that the firmware hooks
  	  for suspend states like suspend-to-RAM (STR) often don't work very
  	  well with Linux.
c7276fde2   Rafael J. Wysocki   [PATCH] kconfig: ...
59
60
  
  	  It creates an image which is saved in your active swap. Upon the next
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
61
62
63
  	  boot, pass the 'resume=/dev/swappartition' argument to the kernel to
  	  have it detect the saved image, restore memory state from it, and
  	  continue to run as before. If you do not want the previous state to
c7276fde2   Rafael J. Wysocki   [PATCH] kconfig: ...
64
65
66
  	  be reloaded, then use the 'noresume' kernel command line argument.
  	  Note, however, that fsck will be run on your filesystems and you will
  	  need to run mkswap against the swap partition used for the suspend.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
67

c7276fde2   Rafael J. Wysocki   [PATCH] kconfig: ...
68
  	  It also works with swap files to a limited extent (for details see
151f4e2bd   Mauro Carvalho Chehab   docs: power: conv...
69
  	  <file:Documentation/power/swsusp-and-swap-files.rst>).
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
70

c7276fde2   Rafael J. Wysocki   [PATCH] kconfig: ...
71
72
73
74
75
76
  	  Right now you may boot without resuming and resume later but in the
  	  meantime you cannot use the swap partition(s)/file(s) involved in
  	  suspending.  Also in this case you must not use the filesystems
  	  that were mounted before the suspend.  In particular, you MUST NOT
  	  MOUNT any journaled filesystems mounted before the suspend or they
  	  will get corrupted in a nasty way.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
77

151f4e2bd   Mauro Carvalho Chehab   docs: power: conv...
78
  	  For more information take a look at <file:Documentation/power/swsusp.rst>.
471b40d0d   Pavel Machek   [PATCH] prevent s...
79

c4f39a6c7   Domenico Andreoli   PM: hibernate: Sp...
80
81
82
83
  config HIBERNATION_SNAPSHOT_DEV
  	bool "Userspace snapshot device"
  	depends on HIBERNATION
  	default y
a7f7f6248   Masahiro Yamada   treewide: replace...
84
  	help
c4f39a6c7   Domenico Andreoli   PM: hibernate: Sp...
85
86
87
88
89
90
  	  Device used by the uswsusp tools.
  
  	  Say N if no snapshotting from userspace is needed, this also
  	  reduces the attack surface of the kernel.
  
  	  If in doubt, say Y.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
91
92
  config PM_STD_PARTITION
  	string "Default resume partition"
b0cb1a19d   Rafael J. Wysocki   Replace CONFIG_SO...
93
  	depends on HIBERNATION
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
94
  	default ""
a7f7f6248   Masahiro Yamada   treewide: replace...
95
  	help
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
  	  The default resume partition is the partition that the suspend-
  	  to-disk implementation will look for a suspended disk image. 
  
  	  The partition specified here will be different for almost every user. 
  	  It should be a valid swap partition (at least for now) that is turned
  	  on before suspending. 
  
  	  The partition specified can be overridden by specifying:
  
  		resume=/dev/<other device> 
  
  	  which will set the resume partition to the device specified. 
  
  	  Note there is currently not a way to specify which device to save the
  	  suspended image to. It will simply pick the first available swap 
  	  device.
196ec2432   Rafael J. Wysocki   PM: Reorder power...
112
  config PM_SLEEP
cf4fb80ca   Jan Beulich   PM: Simplify kern...
113
  	def_bool y
d419e4c0f   Shriram Rajagopalan   fix XEN_SAVE_REST...
114
  	depends on SUSPEND || HIBERNATE_CALLBACKS
464ed18eb   Rafael J. Wysocki   PM: Eliminate CON...
115
  	select PM
3df6f61ff   zhangyi (F)   PM / sleep: wakeu...
116
  	select SRCU
196ec2432   Rafael J. Wysocki   PM: Reorder power...
117
118
  
  config PM_SLEEP_SMP
cf4fb80ca   Jan Beulich   PM: Simplify kern...
119
  	def_bool y
196ec2432   Rafael J. Wysocki   PM: Reorder power...
120
121
122
  	depends on SMP
  	depends on ARCH_SUSPEND_POSSIBLE || ARCH_HIBERNATION_POSSIBLE
  	depends on PM_SLEEP
196ec2432   Rafael J. Wysocki   PM: Reorder power...
123
  	select HOTPLUG_CPU
196ec2432   Rafael J. Wysocki   PM: Reorder power...
124

9ca12ac04   Nicholas Piggin   kernel/cpu: Allow...
125
126
127
128
  config PM_SLEEP_SMP_NONZERO_CPU
  	def_bool y
  	depends on PM_SLEEP_SMP
  	depends on ARCH_SUSPEND_NONZERO_CPU
a7f7f6248   Masahiro Yamada   treewide: replace...
129
  	help
9ca12ac04   Nicholas Piggin   kernel/cpu: Allow...
130
131
132
  	If an arch can suspend (for suspend, hibernate, kexec, etc) on a
  	non-zero numbered CPU, it may define ARCH_SUSPEND_NONZERO_CPU. This
  	will allow nohz_full mask to include CPU0.
7483b4a4d   Rafael J. Wysocki   PM / Sleep: Imple...
133
134
135
136
  config PM_AUTOSLEEP
  	bool "Opportunistic sleep"
  	depends on PM_SLEEP
  	default n
a7f7f6248   Masahiro Yamada   treewide: replace...
137
  	help
7483b4a4d   Rafael J. Wysocki   PM / Sleep: Imple...
138
139
  	Allow the kernel to trigger a system transition into a global sleep
  	state automatically whenever there are no active wakeup sources.
b86ff9820   Rafael J. Wysocki   PM / Sleep: Add u...
140
141
142
143
  config PM_WAKELOCKS
  	bool "User space wakeup sources interface"
  	depends on PM_SLEEP
  	default n
a7f7f6248   Masahiro Yamada   treewide: replace...
144
  	help
b86ff9820   Rafael J. Wysocki   PM / Sleep: Add u...
145
146
  	Allow user space to create, activate and deactivate wakeup source
  	objects with the help of a sysfs-based interface.
c73893e2c   Rafael J. Wysocki   PM / Sleep: Make ...
147
148
149
150
151
  config PM_WAKELOCKS_LIMIT
  	int "Maximum number of user space wakeup sources (0 = no limit)"
  	range 0 100000
  	default 100
  	depends on PM_WAKELOCKS
4e585d25e   Rafael J. Wysocki   PM / Sleep: User ...
152
153
154
155
  config PM_WAKELOCKS_GC
  	bool "Garbage collector for user space wakeup sources"
  	depends on PM_WAKELOCKS
  	default y
464ed18eb   Rafael J. Wysocki   PM: Eliminate CON...
156
157
  config PM
  	bool "Device power management core functionality"
a7f7f6248   Masahiro Yamada   treewide: replace...
158
  	help
196ec2432   Rafael J. Wysocki   PM: Reorder power...
159
  	  Enable functionality allowing I/O devices to be put into energy-saving
464ed18eb   Rafael J. Wysocki   PM: Eliminate CON...
160
161
  	  (low power) states, for example after a specified period of inactivity
  	  (autosuspended), and woken up in response to a hardware-generated
196ec2432   Rafael J. Wysocki   PM: Reorder power...
162
163
164
165
  	  wake-up event or a driver's request.
  
  	  Hardware support is generally required for this functionality to work
  	  and the bus type drivers of the buses the devices are on are
464ed18eb   Rafael J. Wysocki   PM: Eliminate CON...
166
  	  responsible for the actual handling of device suspend requests and
196ec2432   Rafael J. Wysocki   PM: Reorder power...
167
  	  wake-up events.
196ec2432   Rafael J. Wysocki   PM: Reorder power...
168
169
170
  config PM_DEBUG
  	bool "Power Management Debug Support"
  	depends on PM
a7f7f6248   Masahiro Yamada   treewide: replace...
171
  	help
196ec2432   Rafael J. Wysocki   PM: Reorder power...
172
173
174
  	This option enables various debugging support in the Power Management
  	code. This is helpful when debugging and reporting PM bugs, like
  	suspend support.
196ec2432   Rafael J. Wysocki   PM: Reorder power...
175
176
177
  config PM_ADVANCED_DEBUG
  	bool "Extra PM attributes in sysfs for low-level debugging/testing"
  	depends on PM_DEBUG
a7f7f6248   Masahiro Yamada   treewide: replace...
178
  	help
196ec2432   Rafael J. Wysocki   PM: Reorder power...
179
180
181
  	Add extra sysfs attributes allowing one to access some Power Management
  	fields of device objects from user space.  If you are not a kernel
  	developer interested in debugging/testing Power Management, say "no".
196ec2432   Rafael J. Wysocki   PM: Reorder power...
182
183
184
  config PM_TEST_SUSPEND
  	bool "Test suspend/resume and wakealarm during bootup"
  	depends on SUSPEND && PM_DEBUG && RTC_CLASS=y
a7f7f6248   Masahiro Yamada   treewide: replace...
185
  	help
196ec2432   Rafael J. Wysocki   PM: Reorder power...
186
187
188
189
190
191
  	This option will let you suspend your machine during bootup, and
  	make it wake up a few seconds later using an RTC wakeup alarm.
  	Enable this with a kernel parameter like "test_suspend=mem".
  
  	You probably want to have your system's RTC driver statically
  	linked, ensuring that it's available when this test runs.
b2df1d4f8   Rafael J. Wysocki   PM / Sleep: Separ...
192
  config PM_SLEEP_DEBUG
196ec2432   Rafael J. Wysocki   PM: Reorder power...
193
  	def_bool y
88a6f33e4   Rafael J. Wysocki   PM: Clean up PM_T...
194
  	depends on PM_DEBUG && PM_SLEEP
196ec2432   Rafael J. Wysocki   PM: Reorder power...
195

70fea60d8   Benoit Goby   PM / Sleep: Detec...
196
197
  config DPM_WATCHDOG
  	bool "Device suspend/resume watchdog"
5b3f249c9   Chen Yu   PM / sleep: Incre...
198
  	depends on PM_DEBUG && PSTORE && EXPERT
a7f7f6248   Masahiro Yamada   treewide: replace...
199
  	help
70fea60d8   Benoit Goby   PM / Sleep: Detec...
200
201
202
203
204
205
206
207
208
  	  Sets up a watchdog timer to capture drivers that are
  	  locked up attempting to suspend/resume a device.
  	  A detected lockup causes system panic with message
  	  captured in pstore device for inspection in subsequent
  	  boot session.
  
  config DPM_WATCHDOG_TIMEOUT
  	int "Watchdog timeout in seconds"
  	range 1 120
5b3f249c9   Chen Yu   PM / sleep: Incre...
209
  	default 120
70fea60d8   Benoit Goby   PM / Sleep: Detec...
210
  	depends on DPM_WATCHDOG
196ec2432   Rafael J. Wysocki   PM: Reorder power...
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
  config PM_TRACE
  	bool
  	help
  	  This enables code to save the last PM event point across
  	  reboot. The architecture needs to support this, x86 for
  	  example does by saving things in the RTC, see below.
  
  	  The architecture specific code must provide the extern
  	  functions from <linux/resume-trace.h> as well as the
  	  <asm/resume-trace.h> header with a TRACE_RESUME() macro.
  
  	  The way the information is presented is architecture-
  	  dependent, x86 will print the information during a
  	  late_initcall.
  
  config PM_TRACE_RTC
  	bool "Suspend/resume event tracing"
b2df1d4f8   Rafael J. Wysocki   PM / Sleep: Separ...
228
  	depends on PM_SLEEP_DEBUG
196ec2432   Rafael J. Wysocki   PM: Reorder power...
229
230
  	depends on X86
  	select PM_TRACE
a7f7f6248   Masahiro Yamada   treewide: replace...
231
  	help
196ec2432   Rafael J. Wysocki   PM: Reorder power...
232
233
234
235
236
237
238
239
240
241
242
  	This enables some cheesy code to save the last PM event point in the
  	RTC across reboots, so that you can debug a machine that just hangs
  	during suspend (or more commonly, during resume).
  
  	To use this debugging feature you should attempt to suspend the
  	machine, reboot it and then run
  
  		dmesg -s 1000000 | grep 'hash matches'
  
  	CAUTION: this option will cause your machine's real-time clock to be
  	set to an invalid time after a resume.
7726942fb   Ralf Baechle   [APM] Add shared ...
243
244
  config APM_EMULATION
  	tristate "Advanced Power Management Emulation"
993e9fe1e   Arnd Bergmann   PM: APM_EMULATION...
245
  	depends on SYS_SUPPORTS_APM_EMULATION
7726942fb   Ralf Baechle   [APM] Add shared ...
246
247
248
249
250
251
252
253
254
  	help
  	  APM is a BIOS specification for saving power using several different
  	  techniques. This is mostly useful for battery powered laptops with
  	  APM compliant BIOSes. If you say Y here, the system time will be
  	  reset after a RESUME operation, the /proc/apm device will provide
  	  battery status information, and user-space programs will receive
  	  notification of APM "events" (e.g. battery status change).
  
  	  In order to use APM, you will need supporting software. For location
151f4e2bd   Mauro Carvalho Chehab   docs: power: conv...
255
  	  and more information, read <file:Documentation/power/apm-acpi.rst>
2dc98fd32   Michael Witten   doc: Konfig: Docu...
256
  	  and the Battery Powered Linux mini-HOWTO, available from
7726942fb   Ralf Baechle   [APM] Add shared ...
257
258
259
260
261
262
263
264
265
266
267
  	  <http://www.tldp.org/docs.html#howto>.
  
  	  This driver does not spin down disk drives (see the hdparm(8)
  	  manpage ("man 8 hdparm") for that), and it doesn't turn off
  	  VESA-compliant "green" monitors.
  
  	  Generally, if you don't have a battery in your machine, there isn't
  	  much point in using this driver and you should say N. If you get
  	  random kernel OOPSes or reboots that don't seem to be related to
  	  anything, try disabling/enabling this option (or disabling/enabling
  	  APM in your BIOS).
5e928f77a   Rafael J. Wysocki   PM: Introduce cor...
268

b7b95920a   Rafael J. Wysocki   PM: Allow the clo...
269
  config PM_CLK
85eb8c8d0   Rafael J. Wysocki   PM / Runtime: Gen...
270
  	def_bool y
b7b95920a   Rafael J. Wysocki   PM: Allow the clo...
271
  	depends on PM && HAVE_CLK
f721889ff   Rafael J. Wysocki   PM / Domains: Sup...
272
273
274
275
  
  config PM_GENERIC_DOMAINS
  	bool
  	depends on PM
17f2ae7f6   Rafael J. Wysocki   PM / Domains: Fix...
276

cee22a150   Viresh Kumar   workqueues: Intro...
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
  config WQ_POWER_EFFICIENT_DEFAULT
  	bool "Enable workqueue power-efficient mode by default"
  	depends on PM
  	default n
  	help
  	  Per-cpu workqueues are generally preferred because they show
  	  better performance thanks to cache locality; unfortunately,
  	  per-cpu workqueues tend to be more power hungry than unbound
  	  workqueues.
  
  	  Enabling workqueue.power_efficient kernel parameter makes the
  	  per-cpu workqueues which were observed to contribute
  	  significantly to power consumption unbound, leading to measurably
  	  lower power usage at the cost of small performance overhead.
  
  	  This config option determines whether workqueue.power_efficient
  	  is enabled by default.
  
  	  If in doubt, say N.
77f827de0   Rafael J. Wysocki   PM / Domains: Add...
296
297
298
  config PM_GENERIC_DOMAINS_SLEEP
  	def_bool y
  	depends on PM_SLEEP && PM_GENERIC_DOMAINS
aa42240ab   Tomasz Figa   PM / Domains: Add...
299
300
  config PM_GENERIC_DOMAINS_OF
  	def_bool y
a4a8c2c49   Tomasz Figa   ARM: exynos: Move...
301
  	depends on PM_GENERIC_DOMAINS && OF
aa42240ab   Tomasz Figa   PM / Domains: Add...
302

ab10023e0   Colin Cross   cpu_pm: Add cpu p...
303
304
  config CPU_PM
  	bool
27871f7a8   Quentin Perret   PM: Introduce an ...
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
  
  config ENERGY_MODEL
  	bool "Energy Model for CPUs"
  	depends on SMP
  	depends on CPU_FREQ
  	default n
  	help
  	  Several subsystems (thermal and/or the task scheduler for example)
  	  can leverage information about the energy consumed by CPUs to make
  	  smarter decisions. This config option enables the framework from
  	  which subsystems can access the energy models.
  
  	  The exact usage of the energy model is subsystem-dependent.
  
  	  If in doubt, say N.