xref: /linux/kernel/power/Kconfig (revision b28f508112c584cdfbb4d8a9489cc4b79dac68ee)
11da177e4SLinus Torvaldsconfig PM
21da177e4SLinus Torvalds	bool "Power Management support"
3eb7b6b32SLen Brown	depends on !IA64_HP_SIM
41da177e4SLinus Torvalds	---help---
51da177e4SLinus Torvalds	  "Power Management" means that parts of your computer are shut
61da177e4SLinus Torvalds	  off or put into a power conserving "sleep" mode if they are not
71da177e4SLinus Torvalds	  being used.  There are two competing standards for doing this: APM
81da177e4SLinus Torvalds	  and ACPI.  If you want to use either one, say Y here and then also
91da177e4SLinus Torvalds	  to the requisite support below.
101da177e4SLinus Torvalds
111da177e4SLinus Torvalds	  Power Management is most important for battery powered laptop
121da177e4SLinus Torvalds	  computers; if you have a laptop, check out the Linux Laptop home
131da177e4SLinus Torvalds	  page on the WWW at <http://www.linux-on-laptops.com/> or
141da177e4SLinus Torvalds	  Tuxmobil - Linux on Mobile Computers at <http://www.tuxmobil.org/>
151da177e4SLinus Torvalds	  and the Battery Powered Linux mini-HOWTO, available from
161da177e4SLinus Torvalds	  <http://www.tldp.org/docs.html#howto>.
171da177e4SLinus Torvalds
181da177e4SLinus Torvalds	  Note that, even if you say N here, Linux on the x86 architecture
191da177e4SLinus Torvalds	  will issue the hlt instruction if nothing is to be done, thereby
201da177e4SLinus Torvalds	  sending the processor to sleep and saving power.
211da177e4SLinus Torvalds
22bca73e4bSJeff Garzikconfig PM_LEGACY
23f89bce3dSDavid Brownell	bool "Legacy Power Management API (DEPRECATED)"
24bca73e4bSJeff Garzik	depends on PM
25f89bce3dSDavid Brownell	default n
26bca73e4bSJeff Garzik	---help---
27f89bce3dSDavid Brownell	   Support for pm_register() and friends.  This old API is obsoleted
28f89bce3dSDavid Brownell	   by the driver model.
29bca73e4bSJeff Garzik
30f89bce3dSDavid Brownell	   If unsure, say N.
31bca73e4bSJeff Garzik
321da177e4SLinus Torvaldsconfig PM_DEBUG
331da177e4SLinus Torvalds	bool "Power Management Debug Support"
341da177e4SLinus Torvalds	depends on PM
351da177e4SLinus Torvalds	---help---
36a0349828SBen Collins	This option enables various debugging support in the Power Management
37a0349828SBen Collins	code. This is helpful when debugging and reporting PM bugs, like
38a0349828SBen Collins	suspend support.
39a0349828SBen Collins
40a0349828SBen Collinsconfig PM_VERBOSE
41a0349828SBen Collins	bool "Verbose Power Management debugging"
42a0349828SBen Collins	depends on PM_DEBUG
43a0349828SBen Collins	default n
44a0349828SBen Collins	---help---
45a0349828SBen Collins	This option enables verbose messages from the Power Management code.
461da177e4SLinus Torvalds
4790dda1cbSJohannes Bergconfig CAN_PM_TRACE
4890dda1cbSJohannes Berg	def_bool y
4990dda1cbSJohannes Berg	depends on PM_DEBUG && PM_SLEEP && EXPERIMENTAL
5090dda1cbSJohannes Berg
51eb71c87aSLinus Torvaldsconfig PM_TRACE
5290dda1cbSJohannes Berg	bool
5390dda1cbSJohannes Berg	help
5490dda1cbSJohannes Berg	  This enables code to save the last PM event point across
5590dda1cbSJohannes Berg	  reboot. The architecture needs to support this, x86 for
5690dda1cbSJohannes Berg	  example does by saving things in the RTC, see below.
5790dda1cbSJohannes Berg
5890dda1cbSJohannes Berg	  The architecture specific code must provide the extern
5990dda1cbSJohannes Berg	  functions from <linux/resume-trace.h> as well as the
6090dda1cbSJohannes Berg	  <asm/resume-trace.h> header with a TRACE_RESUME() macro.
6190dda1cbSJohannes Berg
6290dda1cbSJohannes Berg	  The way the information is presented is architecture-
6390dda1cbSJohannes Berg	  dependent, x86 will print the information during a
6490dda1cbSJohannes Berg	  late_initcall.
6590dda1cbSJohannes Berg
6690dda1cbSJohannes Bergconfig PM_TRACE_RTC
67eb71c87aSLinus Torvalds	bool "Suspend/resume event tracing"
6890dda1cbSJohannes Berg	depends on CAN_PM_TRACE
6990dda1cbSJohannes Berg	depends on X86
7090dda1cbSJohannes Berg	select PM_TRACE
715c31f273SAndrew Morton	default n
72eb71c87aSLinus Torvalds	---help---
73eb71c87aSLinus Torvalds	This enables some cheesy code to save the last PM event point in the
74eb71c87aSLinus Torvalds	RTC across reboots, so that you can debug a machine that just hangs
75eb71c87aSLinus Torvalds	during suspend (or more commonly, during resume).
76eb71c87aSLinus Torvalds
775c31f273SAndrew Morton	To use this debugging feature you should attempt to suspend the machine,
785c31f273SAndrew Morton	then reboot it, then run
795c31f273SAndrew Morton
805c31f273SAndrew Morton		dmesg -s 1000000 | grep 'hash matches'
815c31f273SAndrew Morton
825c31f273SAndrew Morton	CAUTION: this option will cause your machine's real-time clock to be
835c31f273SAndrew Morton	set to an invalid time after a resume.
845c31f273SAndrew Morton
85f3de4be9SRafael J. Wysockiconfig PM_SLEEP_SMP
86296699deSRafael J. Wysocki	bool
87801e4062SJohannes Berg	depends on SMP
88f4cb5700SJohannes Berg	depends on ARCH_SUSPEND_POSSIBLE || ARCH_HIBERNATION_POSSIBLE
89f3de4be9SRafael J. Wysocki	depends on PM_SLEEP
90296699deSRafael J. Wysocki	select HOTPLUG_CPU
91296699deSRafael J. Wysocki	default y
92296699deSRafael J. Wysocki
93296699deSRafael J. Wysockiconfig PM_SLEEP
94296699deSRafael J. Wysocki	bool
95296699deSRafael J. Wysocki	depends on SUSPEND || HIBERNATION
96296699deSRafael J. Wysocki	default y
97296699deSRafael J. Wysocki
98296699deSRafael J. Wysockiconfig SUSPEND
99296699deSRafael J. Wysocki	bool "Suspend to RAM and standby"
100f4cb5700SJohannes Berg	depends on PM && ARCH_SUSPEND_POSSIBLE
101296699deSRafael J. Wysocki	default y
102296699deSRafael J. Wysocki	---help---
103296699deSRafael J. Wysocki	  Allow the system to enter sleep states in which main memory is
104296699deSRafael J. Wysocki	  powered and thus its contents are preserved, such as the
105f4cb5700SJohannes Berg	  suspend-to-RAM state (e.g. the ACPI S3 state).
106296699deSRafael J. Wysocki
107*b28f5081SJohannes Bergconfig SUSPEND_FREEZER
108*b28f5081SJohannes Berg	bool "Enable freezer for suspend to RAM/standby" \
109*b28f5081SJohannes Berg		if ARCH_WANTS_FREEZER_CONTROL || BROKEN
110*b28f5081SJohannes Berg	depends on SUSPEND
111*b28f5081SJohannes Berg	default y
112*b28f5081SJohannes Berg	help
113*b28f5081SJohannes Berg	  This allows you to turn off the freezer for suspend. If this is
114*b28f5081SJohannes Berg	  done, no tasks are frozen for suspend to RAM/standby.
115*b28f5081SJohannes Berg
116*b28f5081SJohannes Berg	  Turning OFF this setting is NOT recommended! If in doubt, say Y.
117*b28f5081SJohannes Berg
118b0cb1a19SRafael J. Wysockiconfig HIBERNATION
119296699deSRafael J. Wysocki	bool "Hibernation (aka 'suspend to disk')"
120801e4062SJohannes Berg	depends on PM && SWAP && ARCH_HIBERNATION_POSSIBLE
1211da177e4SLinus Torvalds	---help---
122a7ee2e5fSDavid Brownell	  Enable the suspend to disk (STD) functionality, which is usually
123a7ee2e5fSDavid Brownell	  called "hibernation" in user interfaces.  STD checkpoints the
124a7ee2e5fSDavid Brownell	  system and powers it off; and restores that checkpoint on reboot.
1251da177e4SLinus Torvalds
126c7276fdeSRafael J. Wysocki	  You can suspend your machine with 'echo disk > /sys/power/state'.
127c7276fdeSRafael J. Wysocki	  Alternatively, you can use the additional userland tools available
128c7276fdeSRafael J. Wysocki	  from <http://suspend.sf.net>.
129c7276fdeSRafael J. Wysocki
130c7276fdeSRafael J. Wysocki	  In principle it does not require ACPI or APM, although for example
131a7ee2e5fSDavid Brownell	  ACPI will be used for the final steps when it is available.  One
132a7ee2e5fSDavid Brownell	  of the reasons to use software suspend is that the firmware hooks
133a7ee2e5fSDavid Brownell	  for suspend states like suspend-to-RAM (STR) often don't work very
134a7ee2e5fSDavid Brownell	  well with Linux.
135c7276fdeSRafael J. Wysocki
136c7276fdeSRafael J. Wysocki	  It creates an image which is saved in your active swap. Upon the next
1371da177e4SLinus Torvalds	  boot, pass the 'resume=/dev/swappartition' argument to the kernel to
1381da177e4SLinus Torvalds	  have it detect the saved image, restore memory state from it, and
1391da177e4SLinus Torvalds	  continue to run as before. If you do not want the previous state to
140c7276fdeSRafael J. Wysocki	  be reloaded, then use the 'noresume' kernel command line argument.
141c7276fdeSRafael J. Wysocki	  Note, however, that fsck will be run on your filesystems and you will
142c7276fdeSRafael J. Wysocki	  need to run mkswap against the swap partition used for the suspend.
1431da177e4SLinus Torvalds
144c7276fdeSRafael J. Wysocki	  It also works with swap files to a limited extent (for details see
145c7276fdeSRafael J. Wysocki	  <file:Documentation/power/swsusp-and-swap-files.txt>).
146c7276fdeSRafael J. Wysocki
147c7276fdeSRafael J. Wysocki	  Right now you may boot without resuming and resume later but in the
148c7276fdeSRafael J. Wysocki	  meantime you cannot use the swap partition(s)/file(s) involved in
149c7276fdeSRafael J. Wysocki	  suspending.  Also in this case you must not use the filesystems
150c7276fdeSRafael J. Wysocki	  that were mounted before the suspend.  In particular, you MUST NOT
151c7276fdeSRafael J. Wysocki	  MOUNT any journaled filesystems mounted before the suspend or they
152c7276fdeSRafael J. Wysocki	  will get corrupted in a nasty way.
1531da177e4SLinus Torvalds
1541da177e4SLinus Torvalds	  For more information take a look at <file:Documentation/power/swsusp.txt>.
1551da177e4SLinus Torvalds
1561da177e4SLinus Torvaldsconfig PM_STD_PARTITION
1571da177e4SLinus Torvalds	string "Default resume partition"
158b0cb1a19SRafael J. Wysocki	depends on HIBERNATION
1591da177e4SLinus Torvalds	default ""
1601da177e4SLinus Torvalds	---help---
1611da177e4SLinus Torvalds	  The default resume partition is the partition that the suspend-
1621da177e4SLinus Torvalds	  to-disk implementation will look for a suspended disk image.
1631da177e4SLinus Torvalds
1641da177e4SLinus Torvalds	  The partition specified here will be different for almost every user.
1651da177e4SLinus Torvalds	  It should be a valid swap partition (at least for now) that is turned
1661da177e4SLinus Torvalds	  on before suspending.
1671da177e4SLinus Torvalds
1681da177e4SLinus Torvalds	  The partition specified can be overridden by specifying:
1691da177e4SLinus Torvalds
1701da177e4SLinus Torvalds		resume=/dev/<other device>
1711da177e4SLinus Torvalds
1721da177e4SLinus Torvalds	  which will set the resume partition to the device specified.
1731da177e4SLinus Torvalds
1741da177e4SLinus Torvalds	  Note there is currently not a way to specify which device to save the
1751da177e4SLinus Torvalds	  suspended image to. It will simply pick the first available swap
1761da177e4SLinus Torvalds	  device.
1771da177e4SLinus Torvalds
1787726942fSRalf Baechleconfig APM_EMULATION
1797726942fSRalf Baechle	tristate "Advanced Power Management Emulation"
1807726942fSRalf Baechle	depends on PM && SYS_SUPPORTS_APM_EMULATION
1817726942fSRalf Baechle	help
1827726942fSRalf Baechle	  APM is a BIOS specification for saving power using several different
1837726942fSRalf Baechle	  techniques. This is mostly useful for battery powered laptops with
1847726942fSRalf Baechle	  APM compliant BIOSes. If you say Y here, the system time will be
1857726942fSRalf Baechle	  reset after a RESUME operation, the /proc/apm device will provide
1867726942fSRalf Baechle	  battery status information, and user-space programs will receive
1877726942fSRalf Baechle	  notification of APM "events" (e.g. battery status change).
1887726942fSRalf Baechle
1897726942fSRalf Baechle	  In order to use APM, you will need supporting software. For location
1907726942fSRalf Baechle	  and more information, read <file:Documentation/pm.txt> and the
1917726942fSRalf Baechle	  Battery Powered Linux mini-HOWTO, available from
1927726942fSRalf Baechle	  <http://www.tldp.org/docs.html#howto>.
1937726942fSRalf Baechle
1947726942fSRalf Baechle	  This driver does not spin down disk drives (see the hdparm(8)
1957726942fSRalf Baechle	  manpage ("man 8 hdparm") for that), and it doesn't turn off
1967726942fSRalf Baechle	  VESA-compliant "green" monitors.
1977726942fSRalf Baechle
1987726942fSRalf Baechle	  Generally, if you don't have a battery in your machine, there isn't
1997726942fSRalf Baechle	  much point in using this driver and you should say N. If you get
2007726942fSRalf Baechle	  random kernel OOPSes or reboots that don't seem to be related to
2017726942fSRalf Baechle	  anything, try disabling/enabling this option (or disabling/enabling
2027726942fSRalf Baechle	  APM in your BIOS).
203