1*ec8f24b7SThomas Gleixner# SPDX-License-Identifier: GPL-2.0-only 2296699deSRafael J. Wysockiconfig SUSPEND 3296699deSRafael J. Wysocki bool "Suspend to RAM and standby" 41eb208aeSRafael J. Wysocki depends on ARCH_SUSPEND_POSSIBLE 5296699deSRafael J. Wysocki default y 6296699deSRafael J. Wysocki ---help--- 7296699deSRafael J. Wysocki Allow the system to enter sleep states in which main memory is 8296699deSRafael J. Wysocki powered and thus its contents are preserved, such as the 9f4cb5700SJohannes Berg suspend-to-RAM state (e.g. the ACPI S3 state). 10296699deSRafael J. Wysocki 11b28f5081SJohannes Bergconfig SUSPEND_FREEZER 12b28f5081SJohannes Berg bool "Enable freezer for suspend to RAM/standby" \ 13b28f5081SJohannes Berg if ARCH_WANTS_FREEZER_CONTROL || BROKEN 14b28f5081SJohannes Berg depends on SUSPEND 15b28f5081SJohannes Berg default y 16b28f5081SJohannes Berg help 17b28f5081SJohannes Berg This allows you to turn off the freezer for suspend. If this is 18b28f5081SJohannes Berg done, no tasks are frozen for suspend to RAM/standby. 19b28f5081SJohannes Berg 20b28f5081SJohannes Berg Turning OFF this setting is NOT recommended! If in doubt, say Y. 21b28f5081SJohannes Berg 222fd77fffSLen Brownconfig SUSPEND_SKIP_SYNC 232fd77fffSLen Brown bool "Skip kernel's sys_sync() on suspend to RAM/standby" 242fd77fffSLen Brown depends on SUSPEND 252fd77fffSLen Brown depends on EXPERT 262fd77fffSLen Brown help 272fd77fffSLen Brown Skip the kernel sys_sync() before freezing user processes. 282fd77fffSLen Brown Some systems prefer not to pay this cost on every invocation 292fd77fffSLen Brown of suspend, or they are content with invoking sync() from 302fd77fffSLen Brown user-space before invoking suspend. Say Y if that's your case. 312fd77fffSLen Brown 321f112ceeSRafael J. Wysockiconfig HIBERNATE_CALLBACKS 331f112ceeSRafael J. Wysocki bool 341f112ceeSRafael J. Wysocki 35b0cb1a19SRafael J. Wysockiconfig HIBERNATION 36296699deSRafael J. Wysocki bool "Hibernation (aka 'suspend to disk')" 371eb208aeSRafael J. Wysocki depends on SWAP && ARCH_HIBERNATION_POSSIBLE 381f112ceeSRafael J. Wysocki select HIBERNATE_CALLBACKS 39f996fc96SBojan Smojver select LZO_COMPRESS 40f996fc96SBojan Smojver select LZO_DECOMPRESS 41081a9d04SBojan Smojver select CRC32 421da177e4SLinus Torvalds ---help--- 43a7ee2e5fSDavid Brownell Enable the suspend to disk (STD) functionality, which is usually 44a7ee2e5fSDavid Brownell called "hibernation" in user interfaces. STD checkpoints the 45a7ee2e5fSDavid Brownell system and powers it off; and restores that checkpoint on reboot. 461da177e4SLinus Torvalds 4723b168d4SPavel Machek You can suspend your machine with 'echo disk > /sys/power/state' 4823b168d4SPavel Machek after placing resume=/dev/swappartition on the kernel command line 4923b168d4SPavel Machek in your bootloader's configuration file. 5023b168d4SPavel Machek 51c7276fdeSRafael J. Wysocki Alternatively, you can use the additional userland tools available 52c7276fdeSRafael J. Wysocki from <http://suspend.sf.net>. 53c7276fdeSRafael J. Wysocki 54c7276fdeSRafael J. Wysocki In principle it does not require ACPI or APM, although for example 55a7ee2e5fSDavid Brownell ACPI will be used for the final steps when it is available. One 56a7ee2e5fSDavid Brownell of the reasons to use software suspend is that the firmware hooks 57a7ee2e5fSDavid Brownell for suspend states like suspend-to-RAM (STR) often don't work very 58a7ee2e5fSDavid Brownell well with Linux. 59c7276fdeSRafael J. Wysocki 60c7276fdeSRafael J. Wysocki It creates an image which is saved in your active swap. Upon the next 611da177e4SLinus Torvalds boot, pass the 'resume=/dev/swappartition' argument to the kernel to 621da177e4SLinus Torvalds have it detect the saved image, restore memory state from it, and 631da177e4SLinus Torvalds continue to run as before. If you do not want the previous state to 64c7276fdeSRafael J. Wysocki be reloaded, then use the 'noresume' kernel command line argument. 65c7276fdeSRafael J. Wysocki Note, however, that fsck will be run on your filesystems and you will 66c7276fdeSRafael J. Wysocki need to run mkswap against the swap partition used for the suspend. 671da177e4SLinus Torvalds 68c7276fdeSRafael J. Wysocki It also works with swap files to a limited extent (for details see 69c7276fdeSRafael J. Wysocki <file:Documentation/power/swsusp-and-swap-files.txt>). 70c7276fdeSRafael J. Wysocki 71c7276fdeSRafael J. Wysocki Right now you may boot without resuming and resume later but in the 72c7276fdeSRafael J. Wysocki meantime you cannot use the swap partition(s)/file(s) involved in 73c7276fdeSRafael J. Wysocki suspending. Also in this case you must not use the filesystems 74c7276fdeSRafael J. Wysocki that were mounted before the suspend. In particular, you MUST NOT 75c7276fdeSRafael J. Wysocki MOUNT any journaled filesystems mounted before the suspend or they 76c7276fdeSRafael J. Wysocki will get corrupted in a nasty way. 771da177e4SLinus Torvalds 781da177e4SLinus Torvalds For more information take a look at <file:Documentation/power/swsusp.txt>. 791da177e4SLinus Torvalds 8085055dd8SMartin Schwidefskyconfig ARCH_SAVE_PAGE_KEYS 8185055dd8SMartin Schwidefsky bool 8285055dd8SMartin Schwidefsky 831da177e4SLinus Torvaldsconfig PM_STD_PARTITION 841da177e4SLinus Torvalds string "Default resume partition" 85b0cb1a19SRafael J. Wysocki depends on HIBERNATION 861da177e4SLinus Torvalds default "" 871da177e4SLinus Torvalds ---help--- 881da177e4SLinus Torvalds The default resume partition is the partition that the suspend- 891da177e4SLinus Torvalds to-disk implementation will look for a suspended disk image. 901da177e4SLinus Torvalds 911da177e4SLinus Torvalds The partition specified here will be different for almost every user. 921da177e4SLinus Torvalds It should be a valid swap partition (at least for now) that is turned 931da177e4SLinus Torvalds on before suspending. 941da177e4SLinus Torvalds 951da177e4SLinus Torvalds The partition specified can be overridden by specifying: 961da177e4SLinus Torvalds 971da177e4SLinus Torvalds resume=/dev/<other device> 981da177e4SLinus Torvalds 991da177e4SLinus Torvalds which will set the resume partition to the device specified. 1001da177e4SLinus Torvalds 1011da177e4SLinus Torvalds Note there is currently not a way to specify which device to save the 1021da177e4SLinus Torvalds suspended image to. It will simply pick the first available swap 1031da177e4SLinus Torvalds device. 1041da177e4SLinus Torvalds 105196ec243SRafael J. Wysockiconfig PM_SLEEP 106cf4fb80cSJan Beulich def_bool y 107d419e4c0SShriram Rajagopalan depends on SUSPEND || HIBERNATE_CALLBACKS 108464ed18eSRafael J. Wysocki select PM 1093df6f61fSzhangyi (F) select SRCU 110196ec243SRafael J. Wysocki 111196ec243SRafael J. Wysockiconfig PM_SLEEP_SMP 112cf4fb80cSJan Beulich def_bool y 113196ec243SRafael J. Wysocki depends on SMP 114196ec243SRafael J. Wysocki depends on ARCH_SUSPEND_POSSIBLE || ARCH_HIBERNATION_POSSIBLE 115196ec243SRafael J. Wysocki depends on PM_SLEEP 116196ec243SRafael J. Wysocki select HOTPLUG_CPU 117196ec243SRafael J. Wysocki 1189ca12ac0SNicholas Pigginconfig PM_SLEEP_SMP_NONZERO_CPU 1199ca12ac0SNicholas Piggin def_bool y 1209ca12ac0SNicholas Piggin depends on PM_SLEEP_SMP 1219ca12ac0SNicholas Piggin depends on ARCH_SUSPEND_NONZERO_CPU 1229ca12ac0SNicholas Piggin ---help--- 1239ca12ac0SNicholas Piggin If an arch can suspend (for suspend, hibernate, kexec, etc) on a 1249ca12ac0SNicholas Piggin non-zero numbered CPU, it may define ARCH_SUSPEND_NONZERO_CPU. This 1259ca12ac0SNicholas Piggin will allow nohz_full mask to include CPU0. 1269ca12ac0SNicholas Piggin 1277483b4a4SRafael J. Wysockiconfig PM_AUTOSLEEP 1287483b4a4SRafael J. Wysocki bool "Opportunistic sleep" 1297483b4a4SRafael J. Wysocki depends on PM_SLEEP 1307483b4a4SRafael J. Wysocki default n 1317483b4a4SRafael J. Wysocki ---help--- 1327483b4a4SRafael J. Wysocki Allow the kernel to trigger a system transition into a global sleep 1337483b4a4SRafael J. Wysocki state automatically whenever there are no active wakeup sources. 1347483b4a4SRafael J. Wysocki 135b86ff982SRafael J. Wysockiconfig PM_WAKELOCKS 136b86ff982SRafael J. Wysocki bool "User space wakeup sources interface" 137b86ff982SRafael J. Wysocki depends on PM_SLEEP 138b86ff982SRafael J. Wysocki default n 139b86ff982SRafael J. Wysocki ---help--- 140b86ff982SRafael J. Wysocki Allow user space to create, activate and deactivate wakeup source 141b86ff982SRafael J. Wysocki objects with the help of a sysfs-based interface. 142b86ff982SRafael J. Wysocki 143c73893e2SRafael J. Wysockiconfig PM_WAKELOCKS_LIMIT 144c73893e2SRafael J. Wysocki int "Maximum number of user space wakeup sources (0 = no limit)" 145c73893e2SRafael J. Wysocki range 0 100000 146c73893e2SRafael J. Wysocki default 100 147c73893e2SRafael J. Wysocki depends on PM_WAKELOCKS 148c73893e2SRafael J. Wysocki 1494e585d25SRafael J. Wysockiconfig PM_WAKELOCKS_GC 1504e585d25SRafael J. Wysocki bool "Garbage collector for user space wakeup sources" 1514e585d25SRafael J. Wysocki depends on PM_WAKELOCKS 1524e585d25SRafael J. Wysocki default y 1534e585d25SRafael J. Wysocki 154464ed18eSRafael J. Wysockiconfig PM 155464ed18eSRafael J. Wysocki bool "Device power management core functionality" 156196ec243SRafael J. Wysocki ---help--- 157196ec243SRafael J. Wysocki Enable functionality allowing I/O devices to be put into energy-saving 158464ed18eSRafael J. Wysocki (low power) states, for example after a specified period of inactivity 159464ed18eSRafael J. Wysocki (autosuspended), and woken up in response to a hardware-generated 160196ec243SRafael J. Wysocki wake-up event or a driver's request. 161196ec243SRafael J. Wysocki 162196ec243SRafael J. Wysocki Hardware support is generally required for this functionality to work 163196ec243SRafael J. Wysocki and the bus type drivers of the buses the devices are on are 164464ed18eSRafael J. Wysocki responsible for the actual handling of device suspend requests and 165196ec243SRafael J. Wysocki wake-up events. 166196ec243SRafael J. Wysocki 167196ec243SRafael J. Wysockiconfig PM_DEBUG 168196ec243SRafael J. Wysocki bool "Power Management Debug Support" 169196ec243SRafael J. Wysocki depends on PM 170196ec243SRafael J. Wysocki ---help--- 171196ec243SRafael J. Wysocki This option enables various debugging support in the Power Management 172196ec243SRafael J. Wysocki code. This is helpful when debugging and reporting PM bugs, like 173196ec243SRafael J. Wysocki suspend support. 174196ec243SRafael J. Wysocki 175196ec243SRafael J. Wysockiconfig PM_ADVANCED_DEBUG 176196ec243SRafael J. Wysocki bool "Extra PM attributes in sysfs for low-level debugging/testing" 177196ec243SRafael J. Wysocki depends on PM_DEBUG 178196ec243SRafael J. Wysocki ---help--- 179196ec243SRafael J. Wysocki Add extra sysfs attributes allowing one to access some Power Management 180196ec243SRafael J. Wysocki fields of device objects from user space. If you are not a kernel 181196ec243SRafael J. Wysocki developer interested in debugging/testing Power Management, say "no". 182196ec243SRafael J. Wysocki 183196ec243SRafael J. Wysockiconfig PM_TEST_SUSPEND 184196ec243SRafael J. Wysocki bool "Test suspend/resume and wakealarm during bootup" 185196ec243SRafael J. Wysocki depends on SUSPEND && PM_DEBUG && RTC_CLASS=y 186196ec243SRafael J. Wysocki ---help--- 187196ec243SRafael J. Wysocki This option will let you suspend your machine during bootup, and 188196ec243SRafael J. Wysocki make it wake up a few seconds later using an RTC wakeup alarm. 189196ec243SRafael J. Wysocki Enable this with a kernel parameter like "test_suspend=mem". 190196ec243SRafael J. Wysocki 191196ec243SRafael J. Wysocki You probably want to have your system's RTC driver statically 192196ec243SRafael J. Wysocki linked, ensuring that it's available when this test runs. 193196ec243SRafael J. Wysocki 194b2df1d4fSRafael J. Wysockiconfig PM_SLEEP_DEBUG 195196ec243SRafael J. Wysocki def_bool y 19688a6f33eSRafael J. Wysocki depends on PM_DEBUG && PM_SLEEP 197196ec243SRafael J. Wysocki 19870fea60dSBenoit Gobyconfig DPM_WATCHDOG 19970fea60dSBenoit Goby bool "Device suspend/resume watchdog" 2005b3f249cSChen Yu depends on PM_DEBUG && PSTORE && EXPERT 20170fea60dSBenoit Goby ---help--- 20270fea60dSBenoit Goby Sets up a watchdog timer to capture drivers that are 20370fea60dSBenoit Goby locked up attempting to suspend/resume a device. 20470fea60dSBenoit Goby A detected lockup causes system panic with message 20570fea60dSBenoit Goby captured in pstore device for inspection in subsequent 20670fea60dSBenoit Goby boot session. 20770fea60dSBenoit Goby 20870fea60dSBenoit Gobyconfig DPM_WATCHDOG_TIMEOUT 20970fea60dSBenoit Goby int "Watchdog timeout in seconds" 21070fea60dSBenoit Goby range 1 120 2115b3f249cSChen Yu default 120 21270fea60dSBenoit Goby depends on DPM_WATCHDOG 21370fea60dSBenoit Goby 214196ec243SRafael J. Wysockiconfig PM_TRACE 215196ec243SRafael J. Wysocki bool 216196ec243SRafael J. Wysocki help 217196ec243SRafael J. Wysocki This enables code to save the last PM event point across 218196ec243SRafael J. Wysocki reboot. The architecture needs to support this, x86 for 219196ec243SRafael J. Wysocki example does by saving things in the RTC, see below. 220196ec243SRafael J. Wysocki 221196ec243SRafael J. Wysocki The architecture specific code must provide the extern 222196ec243SRafael J. Wysocki functions from <linux/resume-trace.h> as well as the 223196ec243SRafael J. Wysocki <asm/resume-trace.h> header with a TRACE_RESUME() macro. 224196ec243SRafael J. Wysocki 225196ec243SRafael J. Wysocki The way the information is presented is architecture- 226196ec243SRafael J. Wysocki dependent, x86 will print the information during a 227196ec243SRafael J. Wysocki late_initcall. 228196ec243SRafael J. Wysocki 229196ec243SRafael J. Wysockiconfig PM_TRACE_RTC 230196ec243SRafael J. Wysocki bool "Suspend/resume event tracing" 231b2df1d4fSRafael J. Wysocki depends on PM_SLEEP_DEBUG 232196ec243SRafael J. Wysocki depends on X86 233196ec243SRafael J. Wysocki select PM_TRACE 234196ec243SRafael J. Wysocki ---help--- 235196ec243SRafael J. Wysocki This enables some cheesy code to save the last PM event point in the 236196ec243SRafael J. Wysocki RTC across reboots, so that you can debug a machine that just hangs 237196ec243SRafael J. Wysocki during suspend (or more commonly, during resume). 238196ec243SRafael J. Wysocki 239196ec243SRafael J. Wysocki To use this debugging feature you should attempt to suspend the 240196ec243SRafael J. Wysocki machine, reboot it and then run 241196ec243SRafael J. Wysocki 242196ec243SRafael J. Wysocki dmesg -s 1000000 | grep 'hash matches' 243196ec243SRafael J. Wysocki 244196ec243SRafael J. Wysocki CAUTION: this option will cause your machine's real-time clock to be 245196ec243SRafael J. Wysocki set to an invalid time after a resume. 246196ec243SRafael J. Wysocki 2477726942fSRalf Baechleconfig APM_EMULATION 2487726942fSRalf Baechle tristate "Advanced Power Management Emulation" 249993e9fe1SArnd Bergmann depends on SYS_SUPPORTS_APM_EMULATION 2507726942fSRalf Baechle help 2517726942fSRalf Baechle APM is a BIOS specification for saving power using several different 2527726942fSRalf Baechle techniques. This is mostly useful for battery powered laptops with 2537726942fSRalf Baechle APM compliant BIOSes. If you say Y here, the system time will be 2547726942fSRalf Baechle reset after a RESUME operation, the /proc/apm device will provide 2557726942fSRalf Baechle battery status information, and user-space programs will receive 2567726942fSRalf Baechle notification of APM "events" (e.g. battery status change). 2577726942fSRalf Baechle 2587726942fSRalf Baechle In order to use APM, you will need supporting software. For location 2592dc98fd3SMichael Witten and more information, read <file:Documentation/power/apm-acpi.txt> 2602dc98fd3SMichael Witten and the Battery Powered Linux mini-HOWTO, available from 2617726942fSRalf Baechle <http://www.tldp.org/docs.html#howto>. 2627726942fSRalf Baechle 2637726942fSRalf Baechle This driver does not spin down disk drives (see the hdparm(8) 2647726942fSRalf Baechle manpage ("man 8 hdparm") for that), and it doesn't turn off 2657726942fSRalf Baechle VESA-compliant "green" monitors. 2667726942fSRalf Baechle 2677726942fSRalf Baechle Generally, if you don't have a battery in your machine, there isn't 2687726942fSRalf Baechle much point in using this driver and you should say N. If you get 2697726942fSRalf Baechle random kernel OOPSes or reboots that don't seem to be related to 2707726942fSRalf Baechle anything, try disabling/enabling this option (or disabling/enabling 2717726942fSRalf Baechle APM in your BIOS). 2725e928f77SRafael J. Wysocki 273b7b95920SRafael J. Wysockiconfig PM_CLK 27485eb8c8dSRafael J. Wysocki def_bool y 275b7b95920SRafael J. Wysocki depends on PM && HAVE_CLK 276f721889fSRafael J. Wysocki 277f721889fSRafael J. Wysockiconfig PM_GENERIC_DOMAINS 278f721889fSRafael J. Wysocki bool 279f721889fSRafael J. Wysocki depends on PM 28017f2ae7fSRafael J. Wysocki 281cee22a15SViresh Kumarconfig WQ_POWER_EFFICIENT_DEFAULT 282cee22a15SViresh Kumar bool "Enable workqueue power-efficient mode by default" 283cee22a15SViresh Kumar depends on PM 284cee22a15SViresh Kumar default n 285cee22a15SViresh Kumar help 286cee22a15SViresh Kumar Per-cpu workqueues are generally preferred because they show 287cee22a15SViresh Kumar better performance thanks to cache locality; unfortunately, 288cee22a15SViresh Kumar per-cpu workqueues tend to be more power hungry than unbound 289cee22a15SViresh Kumar workqueues. 290cee22a15SViresh Kumar 291cee22a15SViresh Kumar Enabling workqueue.power_efficient kernel parameter makes the 292cee22a15SViresh Kumar per-cpu workqueues which were observed to contribute 293cee22a15SViresh Kumar significantly to power consumption unbound, leading to measurably 294cee22a15SViresh Kumar lower power usage at the cost of small performance overhead. 295cee22a15SViresh Kumar 296cee22a15SViresh Kumar This config option determines whether workqueue.power_efficient 297cee22a15SViresh Kumar is enabled by default. 298cee22a15SViresh Kumar 299cee22a15SViresh Kumar If in doubt, say N. 300cee22a15SViresh Kumar 30177f827deSRafael J. Wysockiconfig PM_GENERIC_DOMAINS_SLEEP 30277f827deSRafael J. Wysocki def_bool y 30377f827deSRafael J. Wysocki depends on PM_SLEEP && PM_GENERIC_DOMAINS 30477f827deSRafael J. Wysocki 305aa42240aSTomasz Figaconfig PM_GENERIC_DOMAINS_OF 306aa42240aSTomasz Figa def_bool y 307a4a8c2c4STomasz Figa depends on PM_GENERIC_DOMAINS && OF 308aa42240aSTomasz Figa 309ab10023eSColin Crossconfig CPU_PM 310ab10023eSColin Cross bool 31127871f7aSQuentin Perret 31227871f7aSQuentin Perretconfig ENERGY_MODEL 31327871f7aSQuentin Perret bool "Energy Model for CPUs" 31427871f7aSQuentin Perret depends on SMP 31527871f7aSQuentin Perret depends on CPU_FREQ 31627871f7aSQuentin Perret default n 31727871f7aSQuentin Perret help 31827871f7aSQuentin Perret Several subsystems (thermal and/or the task scheduler for example) 31927871f7aSQuentin Perret can leverage information about the energy consumed by CPUs to make 32027871f7aSQuentin Perret smarter decisions. This config option enables the framework from 32127871f7aSQuentin Perret which subsystems can access the energy models. 32227871f7aSQuentin Perret 32327871f7aSQuentin Perret The exact usage of the energy model is subsystem-dependent. 32427871f7aSQuentin Perret 32527871f7aSQuentin Perret If in doubt, say N. 326