xref: /linux/kernel/power/Kconfig (revision f3de4be9d5f8551d7880a1f1f5231a30e0161b1f)
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
47c8eb8b40SRafael J. Wysockiconfig DISABLE_CONSOLE_SUSPEND
48c8eb8b40SRafael J. Wysocki	bool "Keep console(s) enabled during suspend/resume (DANGEROUS)"
49296699deSRafael J. Wysocki	depends on PM_DEBUG && PM_SLEEP
50c8eb8b40SRafael J. Wysocki	default n
51c8eb8b40SRafael J. Wysocki	---help---
52c8eb8b40SRafael J. Wysocki	This option turns off the console suspend mechanism that prevents
53c8eb8b40SRafael J. Wysocki	debug messages from reaching the console during the suspend/resume
54c8eb8b40SRafael J. Wysocki	operations.  This may be helpful when debugging device drivers'
55c8eb8b40SRafael J. Wysocki	suspend/resume routines, but may itself lead to problems, for example
56c8eb8b40SRafael J. Wysocki	if netconsole is used.
57c8eb8b40SRafael J. Wysocki
58eb71c87aSLinus Torvaldsconfig PM_TRACE
59eb71c87aSLinus Torvalds	bool "Suspend/resume event tracing"
60296699deSRafael J. Wysocki	depends on PM_DEBUG && X86 && PM_SLEEP && EXPERIMENTAL
615c31f273SAndrew Morton	default n
62eb71c87aSLinus Torvalds	---help---
63eb71c87aSLinus Torvalds	This enables some cheesy code to save the last PM event point in the
64eb71c87aSLinus Torvalds	RTC across reboots, so that you can debug a machine that just hangs
65eb71c87aSLinus Torvalds	during suspend (or more commonly, during resume).
66eb71c87aSLinus Torvalds
675c31f273SAndrew Morton	To use this debugging feature you should attempt to suspend the machine,
685c31f273SAndrew Morton	then reboot it, then run
695c31f273SAndrew Morton
705c31f273SAndrew Morton		dmesg -s 1000000 | grep 'hash matches'
715c31f273SAndrew Morton
725c31f273SAndrew Morton	CAUTION: this option will cause your machine's real-time clock to be
735c31f273SAndrew Morton	set to an invalid time after a resume.
745c31f273SAndrew Morton
75*f3de4be9SRafael J. Wysockiconfig PM_SLEEP_SMP
76296699deSRafael J. Wysocki	bool
77*f3de4be9SRafael J. Wysocki	depends on SUSPEND_SMP_POSSIBLE || HIBERNATION_SMP_POSSIBLE
78*f3de4be9SRafael J. Wysocki	depends on PM_SLEEP
79296699deSRafael J. Wysocki	select HOTPLUG_CPU
80296699deSRafael J. Wysocki	default y
81296699deSRafael J. Wysocki
82296699deSRafael J. Wysockiconfig PM_SLEEP
83296699deSRafael J. Wysocki	bool
84296699deSRafael J. Wysocki	depends on SUSPEND || HIBERNATION
85296699deSRafael J. Wysocki	default y
86296699deSRafael J. Wysocki
87*f3de4be9SRafael J. Wysockiconfig SUSPEND_UP_POSSIBLE
88*f3de4be9SRafael J. Wysocki	bool
89*f3de4be9SRafael J. Wysocki	depends on (X86 && !X86_VOYAGER) || PPC || ARM || BLACKFIN || MIPS \
90*f3de4be9SRafael J. Wysocki		   || SUPERH || FRV
91*f3de4be9SRafael J. Wysocki	depends on !SMP
92*f3de4be9SRafael J. Wysocki	default y
93*f3de4be9SRafael J. Wysocki
94*f3de4be9SRafael J. Wysockiconfig SUSPEND_SMP_POSSIBLE
95*f3de4be9SRafael J. Wysocki	bool
96*f3de4be9SRafael J. Wysocki	depends on (X86 && !X86_VOYAGER) \
97*f3de4be9SRafael J. Wysocki		   || (PPC && (PPC_PSERIES || PPC_PMAC)) || ARM
98*f3de4be9SRafael J. Wysocki	depends on SMP
99*f3de4be9SRafael J. Wysocki	default y
100*f3de4be9SRafael J. Wysocki
101296699deSRafael J. Wysockiconfig SUSPEND
102296699deSRafael J. Wysocki	bool "Suspend to RAM and standby"
103296699deSRafael J. Wysocki	depends on PM
104*f3de4be9SRafael J. Wysocki	depends on SUSPEND_UP_POSSIBLE || SUSPEND_SMP_POSSIBLE
105296699deSRafael J. Wysocki	default y
106296699deSRafael J. Wysocki	---help---
107296699deSRafael J. Wysocki	  Allow the system to enter sleep states in which main memory is
108296699deSRafael J. Wysocki	  powered and thus its contents are preserved, such as the
109296699deSRafael J. Wysocki	  suspend-to-RAM state (i.e. the ACPI S3 state).
110296699deSRafael J. Wysocki
111*f3de4be9SRafael J. Wysockiconfig HIBERNATION_UP_POSSIBLE
112*f3de4be9SRafael J. Wysocki	bool
113*f3de4be9SRafael J. Wysocki	depends on X86 || PPC64_SWSUSP || FRV || PPC32
114*f3de4be9SRafael J. Wysocki	depends on !SMP
115*f3de4be9SRafael J. Wysocki	default y
116*f3de4be9SRafael J. Wysocki
117*f3de4be9SRafael J. Wysockiconfig HIBERNATION_SMP_POSSIBLE
118*f3de4be9SRafael J. Wysocki	bool
119*f3de4be9SRafael J. Wysocki	depends on (X86 && !X86_VOYAGER) || PPC64_SWSUSP
120*f3de4be9SRafael J. Wysocki	depends on SMP
121*f3de4be9SRafael J. Wysocki	default y
122*f3de4be9SRafael J. Wysocki
123b0cb1a19SRafael J. Wysockiconfig HIBERNATION
124296699deSRafael J. Wysocki	bool "Hibernation (aka 'suspend to disk')"
125296699deSRafael J. Wysocki	depends on PM && SWAP
126*f3de4be9SRafael J. Wysocki	depends on HIBERNATION_UP_POSSIBLE || HIBERNATION_SMP_POSSIBLE
1271da177e4SLinus Torvalds	---help---
128a7ee2e5fSDavid Brownell	  Enable the suspend to disk (STD) functionality, which is usually
129a7ee2e5fSDavid Brownell	  called "hibernation" in user interfaces.  STD checkpoints the
130a7ee2e5fSDavid Brownell	  system and powers it off; and restores that checkpoint on reboot.
1311da177e4SLinus Torvalds
132c7276fdeSRafael J. Wysocki	  You can suspend your machine with 'echo disk > /sys/power/state'.
133c7276fdeSRafael J. Wysocki	  Alternatively, you can use the additional userland tools available
134c7276fdeSRafael J. Wysocki	  from <http://suspend.sf.net>.
135c7276fdeSRafael J. Wysocki
136c7276fdeSRafael J. Wysocki	  In principle it does not require ACPI or APM, although for example
137a7ee2e5fSDavid Brownell	  ACPI will be used for the final steps when it is available.  One
138a7ee2e5fSDavid Brownell	  of the reasons to use software suspend is that the firmware hooks
139a7ee2e5fSDavid Brownell	  for suspend states like suspend-to-RAM (STR) often don't work very
140a7ee2e5fSDavid Brownell	  well with Linux.
141c7276fdeSRafael J. Wysocki
142c7276fdeSRafael J. Wysocki	  It creates an image which is saved in your active swap. Upon the next
1431da177e4SLinus Torvalds	  boot, pass the 'resume=/dev/swappartition' argument to the kernel to
1441da177e4SLinus Torvalds	  have it detect the saved image, restore memory state from it, and
1451da177e4SLinus Torvalds	  continue to run as before. If you do not want the previous state to
146c7276fdeSRafael J. Wysocki	  be reloaded, then use the 'noresume' kernel command line argument.
147c7276fdeSRafael J. Wysocki	  Note, however, that fsck will be run on your filesystems and you will
148c7276fdeSRafael J. Wysocki	  need to run mkswap against the swap partition used for the suspend.
1491da177e4SLinus Torvalds
150c7276fdeSRafael J. Wysocki	  It also works with swap files to a limited extent (for details see
151c7276fdeSRafael J. Wysocki	  <file:Documentation/power/swsusp-and-swap-files.txt>).
152c7276fdeSRafael J. Wysocki
153c7276fdeSRafael J. Wysocki	  Right now you may boot without resuming and resume later but in the
154c7276fdeSRafael J. Wysocki	  meantime you cannot use the swap partition(s)/file(s) involved in
155c7276fdeSRafael J. Wysocki	  suspending.  Also in this case you must not use the filesystems
156c7276fdeSRafael J. Wysocki	  that were mounted before the suspend.  In particular, you MUST NOT
157c7276fdeSRafael J. Wysocki	  MOUNT any journaled filesystems mounted before the suspend or they
158c7276fdeSRafael J. Wysocki	  will get corrupted in a nasty way.
1591da177e4SLinus Torvalds
1601da177e4SLinus Torvalds	  For more information take a look at <file:Documentation/power/swsusp.txt>.
1611da177e4SLinus Torvalds
1621da177e4SLinus Torvaldsconfig PM_STD_PARTITION
1631da177e4SLinus Torvalds	string "Default resume partition"
164b0cb1a19SRafael J. Wysocki	depends on HIBERNATION
1651da177e4SLinus Torvalds	default ""
1661da177e4SLinus Torvalds	---help---
1671da177e4SLinus Torvalds	  The default resume partition is the partition that the suspend-
1681da177e4SLinus Torvalds	  to-disk implementation will look for a suspended disk image.
1691da177e4SLinus Torvalds
1701da177e4SLinus Torvalds	  The partition specified here will be different for almost every user.
1711da177e4SLinus Torvalds	  It should be a valid swap partition (at least for now) that is turned
1721da177e4SLinus Torvalds	  on before suspending.
1731da177e4SLinus Torvalds
1741da177e4SLinus Torvalds	  The partition specified can be overridden by specifying:
1751da177e4SLinus Torvalds
1761da177e4SLinus Torvalds		resume=/dev/<other device>
1771da177e4SLinus Torvalds
1781da177e4SLinus Torvalds	  which will set the resume partition to the device specified.
1791da177e4SLinus Torvalds
1801da177e4SLinus Torvalds	  Note there is currently not a way to specify which device to save the
1811da177e4SLinus Torvalds	  suspended image to. It will simply pick the first available swap
1821da177e4SLinus Torvalds	  device.
1831da177e4SLinus Torvalds
1847726942fSRalf Baechleconfig APM_EMULATION
1857726942fSRalf Baechle	tristate "Advanced Power Management Emulation"
1867726942fSRalf Baechle	depends on PM && SYS_SUPPORTS_APM_EMULATION
1877726942fSRalf Baechle	help
1887726942fSRalf Baechle	  APM is a BIOS specification for saving power using several different
1897726942fSRalf Baechle	  techniques. This is mostly useful for battery powered laptops with
1907726942fSRalf Baechle	  APM compliant BIOSes. If you say Y here, the system time will be
1917726942fSRalf Baechle	  reset after a RESUME operation, the /proc/apm device will provide
1927726942fSRalf Baechle	  battery status information, and user-space programs will receive
1937726942fSRalf Baechle	  notification of APM "events" (e.g. battery status change).
1947726942fSRalf Baechle
1957726942fSRalf Baechle	  In order to use APM, you will need supporting software. For location
1967726942fSRalf Baechle	  and more information, read <file:Documentation/pm.txt> and the
1977726942fSRalf Baechle	  Battery Powered Linux mini-HOWTO, available from
1987726942fSRalf Baechle	  <http://www.tldp.org/docs.html#howto>.
1997726942fSRalf Baechle
2007726942fSRalf Baechle	  This driver does not spin down disk drives (see the hdparm(8)
2017726942fSRalf Baechle	  manpage ("man 8 hdparm") for that), and it doesn't turn off
2027726942fSRalf Baechle	  VESA-compliant "green" monitors.
2037726942fSRalf Baechle
2047726942fSRalf Baechle	  Generally, if you don't have a battery in your machine, there isn't
2057726942fSRalf Baechle	  much point in using this driver and you should say N. If you get
2067726942fSRalf Baechle	  random kernel OOPSes or reboots that don't seem to be related to
2077726942fSRalf Baechle	  anything, try disabling/enabling this option (or disabling/enabling
2087726942fSRalf Baechle	  APM in your BIOS).
209