| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | config PM | 
 | 2 | 	bool "Power Management support" | 
| Len Brown | eb7b6b3 | 2005-08-25 12:08:25 -0400 | [diff] [blame] | 3 | 	depends on !IA64_HP_SIM | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 4 | 	---help--- | 
 | 5 | 	  "Power Management" means that parts of your computer are shut | 
 | 6 | 	  off or put into a power conserving "sleep" mode if they are not | 
 | 7 | 	  being used.  There are two competing standards for doing this: APM | 
 | 8 | 	  and ACPI.  If you want to use either one, say Y here and then also | 
 | 9 | 	  to the requisite support below. | 
 | 10 |  | 
 | 11 | 	  Power Management is most important for battery powered laptop | 
 | 12 | 	  computers; if you have a laptop, check out the Linux Laptop home | 
 | 13 | 	  page on the WWW at <http://www.linux-on-laptops.com/> or | 
 | 14 | 	  Tuxmobil - Linux on Mobile Computers at <http://www.tuxmobil.org/> | 
 | 15 | 	  and the Battery Powered Linux mini-HOWTO, available from | 
 | 16 | 	  <http://www.tldp.org/docs.html#howto>. | 
 | 17 |  | 
 | 18 | 	  Note that, even if you say N here, Linux on the x86 architecture | 
 | 19 | 	  will issue the hlt instruction if nothing is to be done, thereby | 
 | 20 | 	  sending the processor to sleep and saving power. | 
 | 21 |  | 
 | 22 | config PM_DEBUG | 
 | 23 | 	bool "Power Management Debug Support" | 
 | 24 | 	depends on PM | 
 | 25 | 	---help--- | 
| Ben Collins | a034982 | 2007-07-19 01:47:27 -0700 | [diff] [blame] | 26 | 	This option enables various debugging support in the Power Management | 
 | 27 | 	code. This is helpful when debugging and reporting PM bugs, like | 
 | 28 | 	suspend support. | 
 | 29 |  | 
| Rafael J. Wysocki | 5a2eb85 | 2010-01-23 22:25:23 +0100 | [diff] [blame] | 30 | config PM_ADVANCED_DEBUG | 
 | 31 | 	bool "Extra PM attributes in sysfs for low-level debugging/testing" | 
 | 32 | 	depends on PM_DEBUG | 
 | 33 | 	default n | 
 | 34 | 	---help--- | 
 | 35 | 	Add extra sysfs attributes allowing one to access some Power Management | 
 | 36 | 	fields of device objects from user space.  If you are not a kernel | 
 | 37 | 	developer interested in debugging/testing Power Management, say "no". | 
 | 38 |  | 
| Ben Collins | a034982 | 2007-07-19 01:47:27 -0700 | [diff] [blame] | 39 | config PM_VERBOSE | 
 | 40 | 	bool "Verbose Power Management debugging" | 
 | 41 | 	depends on PM_DEBUG | 
 | 42 | 	default n | 
 | 43 | 	---help--- | 
 | 44 | 	This option enables verbose messages from the Power Management code. | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 45 |  | 
| Johannes Berg | 90dda1c | 2007-11-19 23:46:16 +0100 | [diff] [blame] | 46 | config CAN_PM_TRACE | 
 | 47 | 	def_bool y | 
 | 48 | 	depends on PM_DEBUG && PM_SLEEP && EXPERIMENTAL | 
 | 49 |  | 
| Linus Torvalds | eb71c87 | 2006-06-24 14:27:42 -0700 | [diff] [blame] | 50 | config PM_TRACE | 
| Johannes Berg | 90dda1c | 2007-11-19 23:46:16 +0100 | [diff] [blame] | 51 | 	bool | 
 | 52 | 	help | 
 | 53 | 	  This enables code to save the last PM event point across | 
 | 54 | 	  reboot. The architecture needs to support this, x86 for | 
 | 55 | 	  example does by saving things in the RTC, see below. | 
 | 56 |  | 
 | 57 | 	  The architecture specific code must provide the extern | 
 | 58 | 	  functions from <linux/resume-trace.h> as well as the | 
 | 59 | 	  <asm/resume-trace.h> header with a TRACE_RESUME() macro. | 
 | 60 |  | 
 | 61 | 	  The way the information is presented is architecture- | 
 | 62 | 	  dependent, x86 will print the information during a | 
 | 63 | 	  late_initcall. | 
 | 64 |  | 
 | 65 | config PM_TRACE_RTC | 
| Linus Torvalds | eb71c87 | 2006-06-24 14:27:42 -0700 | [diff] [blame] | 66 | 	bool "Suspend/resume event tracing" | 
| Johannes Berg | 90dda1c | 2007-11-19 23:46:16 +0100 | [diff] [blame] | 67 | 	depends on CAN_PM_TRACE | 
 | 68 | 	depends on X86 | 
 | 69 | 	select PM_TRACE | 
| Andrew Morton | 5c31f27 | 2006-06-27 02:53:26 -0700 | [diff] [blame] | 70 | 	default n | 
| Linus Torvalds | eb71c87 | 2006-06-24 14:27:42 -0700 | [diff] [blame] | 71 | 	---help--- | 
 | 72 | 	This enables some cheesy code to save the last PM event point in the | 
 | 73 | 	RTC across reboots, so that you can debug a machine that just hangs | 
 | 74 | 	during suspend (or more commonly, during resume). | 
 | 75 |  | 
| Pavel Machek | 23b168d | 2008-02-05 19:27:12 +0100 | [diff] [blame] | 76 | 	To use this debugging feature you should attempt to suspend the | 
 | 77 | 	machine, reboot it and then run | 
| Andrew Morton | 5c31f27 | 2006-06-27 02:53:26 -0700 | [diff] [blame] | 78 |  | 
 | 79 | 		dmesg -s 1000000 | grep 'hash matches' | 
 | 80 |  | 
 | 81 | 	CAUTION: this option will cause your machine's real-time clock to be | 
 | 82 | 	set to an invalid time after a resume. | 
 | 83 |  | 
| Rafael J. Wysocki | f3de4be | 2007-08-30 23:56:29 -0700 | [diff] [blame] | 84 | config PM_SLEEP_SMP | 
| Rafael J. Wysocki | 296699d | 2007-07-29 23:27:18 +0200 | [diff] [blame] | 85 | 	bool | 
| Johannes Berg | 801e406 | 2007-12-08 02:12:39 +0100 | [diff] [blame] | 86 | 	depends on SMP | 
| Johannes Berg | f4cb570 | 2007-12-08 02:14:00 +0100 | [diff] [blame] | 87 | 	depends on ARCH_SUSPEND_POSSIBLE || ARCH_HIBERNATION_POSSIBLE | 
| Rafael J. Wysocki | f3de4be | 2007-08-30 23:56:29 -0700 | [diff] [blame] | 88 | 	depends on PM_SLEEP | 
| Rafael J. Wysocki | 296699d | 2007-07-29 23:27:18 +0200 | [diff] [blame] | 89 | 	select HOTPLUG_CPU | 
 | 90 | 	default y | 
 | 91 |  | 
 | 92 | config PM_SLEEP | 
 | 93 | 	bool | 
| Jeremy Fitzhardinge | 93a0886 | 2008-07-15 13:43:42 -0700 | [diff] [blame] | 94 | 	depends on SUSPEND || HIBERNATION || XEN_SAVE_RESTORE | 
| Rafael J. Wysocki | 296699d | 2007-07-29 23:27:18 +0200 | [diff] [blame] | 95 | 	default y | 
 | 96 |  | 
| Rafael J. Wysocki | 5a2eb85 | 2010-01-23 22:25:23 +0100 | [diff] [blame] | 97 | config PM_SLEEP_ADVANCED_DEBUG | 
 | 98 | 	bool | 
 | 99 | 	depends on PM_ADVANCED_DEBUG | 
 | 100 | 	default n | 
 | 101 |  | 
| Matthew Garrett | dd4c4f1 | 2010-05-28 16:32:14 -0400 | [diff] [blame] | 102 | config SUSPEND_NVS | 
 | 103 |        bool | 
 | 104 |  | 
| Rafael J. Wysocki | 296699d | 2007-07-29 23:27:18 +0200 | [diff] [blame] | 105 | config SUSPEND | 
 | 106 | 	bool "Suspend to RAM and standby" | 
| Johannes Berg | f4cb570 | 2007-12-08 02:14:00 +0100 | [diff] [blame] | 107 | 	depends on PM && ARCH_SUSPEND_POSSIBLE | 
| Matthew Garrett | dd4c4f1 | 2010-05-28 16:32:14 -0400 | [diff] [blame] | 108 | 	select SUSPEND_NVS if HAS_IOMEM | 
| Rafael J. Wysocki | 296699d | 2007-07-29 23:27:18 +0200 | [diff] [blame] | 109 | 	default y | 
 | 110 | 	---help--- | 
 | 111 | 	  Allow the system to enter sleep states in which main memory is | 
 | 112 | 	  powered and thus its contents are preserved, such as the | 
| Johannes Berg | f4cb570 | 2007-12-08 02:14:00 +0100 | [diff] [blame] | 113 | 	  suspend-to-RAM state (e.g. the ACPI S3 state). | 
| Rafael J. Wysocki | 296699d | 2007-07-29 23:27:18 +0200 | [diff] [blame] | 114 |  | 
| David Brownell | 77437fd | 2008-07-23 21:28:33 -0700 | [diff] [blame] | 115 | config PM_TEST_SUSPEND | 
 | 116 | 	bool "Test suspend/resume and wakealarm during bootup" | 
| Al Viro | 2895974 | 2008-11-01 18:20:09 +0000 | [diff] [blame] | 117 | 	depends on SUSPEND && PM_DEBUG && RTC_CLASS=y | 
| David Brownell | 77437fd | 2008-07-23 21:28:33 -0700 | [diff] [blame] | 118 | 	---help--- | 
 | 119 | 	This option will let you suspend your machine during bootup, and | 
 | 120 | 	make it wake up a few seconds later using an RTC wakeup alarm. | 
 | 121 | 	Enable this with a kernel parameter like "test_suspend=mem". | 
 | 122 |  | 
 | 123 | 	You probably want to have your system's RTC driver statically | 
 | 124 | 	linked, ensuring that it's available when this test runs. | 
 | 125 |  | 
| Johannes Berg | b28f508 | 2008-01-15 23:17:00 -0500 | [diff] [blame] | 126 | config SUSPEND_FREEZER | 
 | 127 | 	bool "Enable freezer for suspend to RAM/standby" \ | 
 | 128 | 		if ARCH_WANTS_FREEZER_CONTROL || BROKEN | 
 | 129 | 	depends on SUSPEND | 
 | 130 | 	default y | 
 | 131 | 	help | 
 | 132 | 	  This allows you to turn off the freezer for suspend. If this is | 
 | 133 | 	  done, no tasks are frozen for suspend to RAM/standby. | 
 | 134 |  | 
 | 135 | 	  Turning OFF this setting is NOT recommended! If in doubt, say Y. | 
 | 136 |  | 
| Rafael J. Wysocki | b0cb1a1 | 2007-07-29 23:24:36 +0200 | [diff] [blame] | 137 | config HIBERNATION | 
| Rafael J. Wysocki | 296699d | 2007-07-29 23:27:18 +0200 | [diff] [blame] | 138 | 	bool "Hibernation (aka 'suspend to disk')" | 
| Johannes Berg | 801e406 | 2007-12-08 02:12:39 +0100 | [diff] [blame] | 139 | 	depends on PM && SWAP && ARCH_HIBERNATION_POSSIBLE | 
| Bojan Smojver | f996fc9 | 2010-09-09 23:06:23 +0200 | [diff] [blame^] | 140 | 	select LZO_COMPRESS | 
 | 141 | 	select LZO_DECOMPRESS | 
| Matthew Garrett | dd4c4f1 | 2010-05-28 16:32:14 -0400 | [diff] [blame] | 142 | 	select SUSPEND_NVS if HAS_IOMEM | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 143 | 	---help--- | 
| David Brownell | a7ee2e5 | 2007-05-06 14:50:50 -0700 | [diff] [blame] | 144 | 	  Enable the suspend to disk (STD) functionality, which is usually | 
 | 145 | 	  called "hibernation" in user interfaces.  STD checkpoints the | 
 | 146 | 	  system and powers it off; and restores that checkpoint on reboot. | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 147 |  | 
| Pavel Machek | 23b168d | 2008-02-05 19:27:12 +0100 | [diff] [blame] | 148 | 	  You can suspend your machine with 'echo disk > /sys/power/state' | 
 | 149 | 	  after placing resume=/dev/swappartition on the kernel command line | 
 | 150 | 	  in your bootloader's configuration file. | 
 | 151 |  | 
| Rafael J. Wysocki | c7276fd | 2007-03-06 01:42:24 -0800 | [diff] [blame] | 152 | 	  Alternatively, you can use the additional userland tools available | 
 | 153 | 	  from <http://suspend.sf.net>. | 
 | 154 |  | 
 | 155 | 	  In principle it does not require ACPI or APM, although for example | 
| David Brownell | a7ee2e5 | 2007-05-06 14:50:50 -0700 | [diff] [blame] | 156 | 	  ACPI will be used for the final steps when it is available.  One | 
 | 157 | 	  of the reasons to use software suspend is that the firmware hooks | 
 | 158 | 	  for suspend states like suspend-to-RAM (STR) often don't work very | 
 | 159 | 	  well with Linux. | 
| Rafael J. Wysocki | c7276fd | 2007-03-06 01:42:24 -0800 | [diff] [blame] | 160 |  | 
 | 161 | 	  It creates an image which is saved in your active swap. Upon the next | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 162 | 	  boot, pass the 'resume=/dev/swappartition' argument to the kernel to | 
 | 163 | 	  have it detect the saved image, restore memory state from it, and | 
 | 164 | 	  continue to run as before. If you do not want the previous state to | 
| Rafael J. Wysocki | c7276fd | 2007-03-06 01:42:24 -0800 | [diff] [blame] | 165 | 	  be reloaded, then use the 'noresume' kernel command line argument. | 
 | 166 | 	  Note, however, that fsck will be run on your filesystems and you will | 
 | 167 | 	  need to run mkswap against the swap partition used for the suspend. | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 168 |  | 
| Rafael J. Wysocki | c7276fd | 2007-03-06 01:42:24 -0800 | [diff] [blame] | 169 | 	  It also works with swap files to a limited extent (for details see | 
 | 170 | 	  <file:Documentation/power/swsusp-and-swap-files.txt>). | 
 | 171 |  | 
 | 172 | 	  Right now you may boot without resuming and resume later but in the | 
 | 173 | 	  meantime you cannot use the swap partition(s)/file(s) involved in | 
 | 174 | 	  suspending.  Also in this case you must not use the filesystems | 
 | 175 | 	  that were mounted before the suspend.  In particular, you MUST NOT | 
 | 176 | 	  MOUNT any journaled filesystems mounted before the suspend or they | 
 | 177 | 	  will get corrupted in a nasty way. | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 178 |  | 
 | 179 | 	  For more information take a look at <file:Documentation/power/swsusp.txt>. | 
 | 180 |  | 
 | 181 | config PM_STD_PARTITION | 
 | 182 | 	string "Default resume partition" | 
| Rafael J. Wysocki | b0cb1a1 | 2007-07-29 23:24:36 +0200 | [diff] [blame] | 183 | 	depends on HIBERNATION | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 184 | 	default "" | 
 | 185 | 	---help--- | 
 | 186 | 	  The default resume partition is the partition that the suspend- | 
 | 187 | 	  to-disk implementation will look for a suspended disk image.  | 
 | 188 |  | 
 | 189 | 	  The partition specified here will be different for almost every user.  | 
 | 190 | 	  It should be a valid swap partition (at least for now) that is turned | 
 | 191 | 	  on before suspending.  | 
 | 192 |  | 
 | 193 | 	  The partition specified can be overridden by specifying: | 
 | 194 |  | 
 | 195 | 		resume=/dev/<other device>  | 
 | 196 |  | 
 | 197 | 	  which will set the resume partition to the device specified.  | 
 | 198 |  | 
 | 199 | 	  Note there is currently not a way to specify which device to save the | 
 | 200 | 	  suspended image to. It will simply pick the first available swap  | 
 | 201 | 	  device. | 
 | 202 |  | 
| Ralf Baechle | 7726942 | 2007-02-09 17:08:57 +0000 | [diff] [blame] | 203 | config APM_EMULATION | 
 | 204 | 	tristate "Advanced Power Management Emulation" | 
 | 205 | 	depends on PM && SYS_SUPPORTS_APM_EMULATION | 
 | 206 | 	help | 
 | 207 | 	  APM is a BIOS specification for saving power using several different | 
 | 208 | 	  techniques. This is mostly useful for battery powered laptops with | 
 | 209 | 	  APM compliant BIOSes. If you say Y here, the system time will be | 
 | 210 | 	  reset after a RESUME operation, the /proc/apm device will provide | 
 | 211 | 	  battery status information, and user-space programs will receive | 
 | 212 | 	  notification of APM "events" (e.g. battery status change). | 
 | 213 |  | 
 | 214 | 	  In order to use APM, you will need supporting software. For location | 
| Randy Dunlap | 5347112 | 2008-03-12 18:10:51 -0400 | [diff] [blame] | 215 | 	  and more information, read <file:Documentation/power/pm.txt> and the | 
| Ralf Baechle | 7726942 | 2007-02-09 17:08:57 +0000 | [diff] [blame] | 216 | 	  Battery Powered Linux mini-HOWTO, available from | 
 | 217 | 	  <http://www.tldp.org/docs.html#howto>. | 
 | 218 |  | 
 | 219 | 	  This driver does not spin down disk drives (see the hdparm(8) | 
 | 220 | 	  manpage ("man 8 hdparm") for that), and it doesn't turn off | 
 | 221 | 	  VESA-compliant "green" monitors. | 
 | 222 |  | 
 | 223 | 	  Generally, if you don't have a battery in your machine, there isn't | 
 | 224 | 	  much point in using this driver and you should say N. If you get | 
 | 225 | 	  random kernel OOPSes or reboots that don't seem to be related to | 
 | 226 | 	  anything, try disabling/enabling this option (or disabling/enabling | 
 | 227 | 	  APM in your BIOS). | 
| Rafael J. Wysocki | 5e928f7 | 2009-08-18 23:38:32 +0200 | [diff] [blame] | 228 |  | 
 | 229 | config PM_RUNTIME | 
 | 230 | 	bool "Run-time PM core functionality" | 
 | 231 | 	depends on PM | 
 | 232 | 	---help--- | 
 | 233 | 	  Enable functionality allowing I/O devices to be put into energy-saving | 
 | 234 | 	  (low power) states at run time (or autosuspended) after a specified | 
 | 235 | 	  period of inactivity and woken up in response to a hardware-generated | 
 | 236 | 	  wake-up event or a driver's request. | 
 | 237 |  | 
 | 238 | 	  Hardware support is generally required for this functionality to work | 
 | 239 | 	  and the bus type drivers of the buses the devices are on are | 
 | 240 | 	  responsible for the actual handling of the autosuspend requests and | 
 | 241 | 	  wake-up events. | 
| Rafael J. Wysocki | 6cbf821 | 2010-02-17 23:44:58 +0100 | [diff] [blame] | 242 |  | 
 | 243 | config PM_OPS | 
 | 244 | 	bool | 
 | 245 | 	depends on PM_SLEEP || PM_RUNTIME | 
 | 246 | 	default y |