diff options
author | Bjorn Helgaas <bjorn.helgaas@hp.com> | 2009-02-19 16:45:47 -0500 |
---|---|---|
committer | Len Brown <len.brown@intel.com> | 2009-03-17 02:06:04 -0400 |
commit | 1c48aa36ef301d7b07674313bae65ef2496801a7 (patch) | |
tree | 43da9826b1ea48e4d545cb6c3e2ad75a711da2ae /drivers | |
parent | c686d141c7c668ac186015841a1ccd285a1f3362 (diff) |
ACPI: update Kconfig help texts (no functional changes)
Use "help" (not "---help---") consistently throughout.
ACPI can't be a module, so if both ACPI & APM are configured,
we use ACPI.
Update pointers to ACPI CA and Linux ACPI projects.
Replace "Compaq" with "Hewlett-Packard" in the spec developer list.
Fix typo in /sys/module path.
The user-space daemon is "acpid", not "acpi".
Add standard "To compile this driver as a module ..." help text.
Signed-off-by: Bjorn Helgaas <bjorn.helgaas@hp.com>
Signed-off-by: Len Brown <len.brown@intel.com>
Diffstat (limited to 'drivers')
-rw-r--r-- | drivers/acpi/Kconfig | 150 |
1 files changed, 86 insertions, 64 deletions
diff --git a/drivers/acpi/Kconfig b/drivers/acpi/Kconfig index 8a851d0f4384..431f8b439553 100644 --- a/drivers/acpi/Kconfig +++ b/drivers/acpi/Kconfig | |||
@@ -11,9 +11,9 @@ menuconfig ACPI | |||
11 | select PNP | 11 | select PNP |
12 | select CPU_IDLE | 12 | select CPU_IDLE |
13 | default y | 13 | default y |
14 | ---help--- | 14 | help |
15 | Advanced Configuration and Power Interface (ACPI) support for | 15 | Advanced Configuration and Power Interface (ACPI) support for |
16 | Linux requires an ACPI compliant platform (hardware/firmware), | 16 | Linux requires an ACPI-compliant platform (hardware/firmware), |
17 | and assumes the presence of OS-directed configuration and power | 17 | and assumes the presence of OS-directed configuration and power |
18 | management (OSPM) software. This option will enlarge your | 18 | management (OSPM) software. This option will enlarge your |
19 | kernel by about 70K. | 19 | kernel by about 70K. |
@@ -23,20 +23,19 @@ menuconfig ACPI | |||
23 | the Plug-and-Play BIOS specification (PnP BIOS), the | 23 | the Plug-and-Play BIOS specification (PnP BIOS), the |
24 | MultiProcessor Specification (MPS), and the Advanced Power | 24 | MultiProcessor Specification (MPS), and the Advanced Power |
25 | Management (APM) specification. If both ACPI and APM support | 25 | Management (APM) specification. If both ACPI and APM support |
26 | are configured, whichever is loaded first shall be used. | 26 | are configured, ACPI is used. |
27 | 27 | ||
28 | The ACPI SourceForge project contains the latest source code, | 28 | The project home page for the Linux ACPI subsystem is here: |
29 | documentation, tools, mailing list subscription, and other | 29 | <http://www.lesswatts.org/projects/acpi/> |
30 | information. This project is available at: | ||
31 | <http://sourceforge.net/projects/acpi> | ||
32 | 30 | ||
33 | Linux support for ACPI is based on Intel Corporation's ACPI | 31 | Linux support for ACPI is based on Intel Corporation's ACPI |
34 | Component Architecture (ACPI CA). For more information see: | 32 | Component Architecture (ACPI CA). For more information on the |
35 | <http://developer.intel.com/technology/iapc/acpi> | 33 | ACPI CA, see: |
34 | <http://acpica.org/> | ||
36 | 35 | ||
37 | ACPI is an open industry specification co-developed by Compaq, | 36 | ACPI is an open industry specification co-developed by |
38 | Intel, Microsoft, Phoenix, and Toshiba. The specification is | 37 | Hewlett-Packard, Intel, Microsoft, Phoenix, and Toshiba. |
39 | available at: | 38 | The specification is available at: |
40 | <http://www.acpi.info> | 39 | <http://www.acpi.info> |
41 | 40 | ||
42 | if ACPI | 41 | if ACPI |
@@ -49,14 +48,14 @@ config ACPI_SLEEP | |||
49 | config ACPI_PROCFS | 48 | config ACPI_PROCFS |
50 | bool "Deprecated /proc/acpi files" | 49 | bool "Deprecated /proc/acpi files" |
51 | depends on PROC_FS | 50 | depends on PROC_FS |
52 | ---help--- | 51 | help |
53 | For backwards compatibility, this option allows | 52 | For backwards compatibility, this option allows |
54 | deprecated /proc/acpi/ files to exist, even when | 53 | deprecated /proc/acpi/ files to exist, even when |
55 | they have been replaced by functions in /sys. | 54 | they have been replaced by functions in /sys. |
56 | The deprecated files (and their replacements) include: | 55 | The deprecated files (and their replacements) include: |
57 | 56 | ||
58 | /proc/acpi/sleep (/sys/power/state) | 57 | /proc/acpi/sleep (/sys/power/state) |
59 | /proc/acpi/info (/sys/modules/acpi/parameters/acpica_version) | 58 | /proc/acpi/info (/sys/module/acpi/parameters/acpica_version) |
60 | /proc/acpi/dsdt (/sys/firmware/acpi/tables/DSDT) | 59 | /proc/acpi/dsdt (/sys/firmware/acpi/tables/DSDT) |
61 | /proc/acpi/fadt (/sys/firmware/acpi/tables/FACP) | 60 | /proc/acpi/fadt (/sys/firmware/acpi/tables/FACP) |
62 | /proc/acpi/debug_layer (/sys/module/acpi/parameters/debug_layer) | 61 | /proc/acpi/debug_layer (/sys/module/acpi/parameters/debug_layer) |
@@ -66,11 +65,12 @@ config ACPI_PROCFS | |||
66 | and functions which do not yet exist in /sys. | 65 | and functions which do not yet exist in /sys. |
67 | 66 | ||
68 | Say N to delete /proc/acpi/ files that have moved to /sys/ | 67 | Say N to delete /proc/acpi/ files that have moved to /sys/ |
68 | |||
69 | config ACPI_PROCFS_POWER | 69 | config ACPI_PROCFS_POWER |
70 | bool "Deprecated power /proc/acpi directories" | 70 | bool "Deprecated power /proc/acpi directories" |
71 | depends on PROC_FS | 71 | depends on PROC_FS |
72 | default y | 72 | default y |
73 | ---help--- | 73 | help |
74 | For backwards compatibility, this option allows | 74 | For backwards compatibility, this option allows |
75 | deprecated power /proc/acpi/ directories to exist, even when | 75 | deprecated power /proc/acpi/ directories to exist, even when |
76 | they have been replaced by functions in /sys. | 76 | they have been replaced by functions in /sys. |
@@ -86,19 +86,19 @@ config ACPI_SYSFS_POWER | |||
86 | bool "Future power /sys interface" | 86 | bool "Future power /sys interface" |
87 | select POWER_SUPPLY | 87 | select POWER_SUPPLY |
88 | default y | 88 | default y |
89 | ---help--- | 89 | help |
90 | Say N to disable power /sys interface | 90 | Say N to disable power /sys interface |
91 | 91 | ||
92 | config ACPI_PROC_EVENT | 92 | config ACPI_PROC_EVENT |
93 | bool "Deprecated /proc/acpi/event support" | 93 | bool "Deprecated /proc/acpi/event support" |
94 | depends on PROC_FS | 94 | depends on PROC_FS |
95 | default y | 95 | default y |
96 | ---help--- | 96 | help |
97 | A user-space daemon, acpi, typically read /proc/acpi/event | 97 | A user-space daemon, acpid, typically reads /proc/acpi/event |
98 | and handled all ACPI sub-system generated events. | 98 | and handles all ACPI-generated events. |
99 | 99 | ||
100 | These events are now delivered to user-space via | 100 | These events are now delivered to user-space either |
101 | either the input layer, or as netlink events. | 101 | via the input layer or as netlink events. |
102 | 102 | ||
103 | This build option enables the old code for legacy | 103 | This build option enables the old code for legacy |
104 | user-space implementation. After some time, this will | 104 | user-space implementation. After some time, this will |
@@ -112,10 +112,13 @@ config ACPI_AC | |||
112 | depends on X86 | 112 | depends on X86 |
113 | default y | 113 | default y |
114 | help | 114 | help |
115 | This driver adds support for the AC Adapter object, which indicates | 115 | This driver supports the AC Adapter object, which indicates |
116 | whether a system is on AC, or not. If you have a system that can | 116 | whether a system is on AC or not. If you have a system that can |
117 | switch between A/C and battery, say Y. | 117 | switch between A/C and battery, say Y. |
118 | 118 | ||
119 | To compile this driver as a module, choose M here: | ||
120 | the module will be called ac. | ||
121 | |||
119 | config ACPI_BATTERY | 122 | config ACPI_BATTERY |
120 | tristate "Battery" | 123 | tristate "Battery" |
121 | depends on X86 | 124 | depends on X86 |
@@ -125,15 +128,21 @@ config ACPI_BATTERY | |||
125 | /proc/acpi/battery. If you have a mobile system with a battery, | 128 | /proc/acpi/battery. If you have a mobile system with a battery, |
126 | say Y. | 129 | say Y. |
127 | 130 | ||
131 | To compile this driver as a module, choose M here: | ||
132 | the module will be called battery. | ||
133 | |||
128 | config ACPI_BUTTON | 134 | config ACPI_BUTTON |
129 | tristate "Button" | 135 | tristate "Button" |
130 | depends on INPUT | 136 | depends on INPUT |
131 | default y | 137 | default y |
132 | help | 138 | help |
133 | This driver handles events on the power, sleep and lid buttons. | 139 | This driver handles events on the power, sleep, and lid buttons. |
134 | A daemon reads /proc/acpi/event and perform user-defined actions | 140 | A daemon reads /proc/acpi/event and perform user-defined actions |
135 | such as shutting down the system. This is necessary for | 141 | such as shutting down the system. This is necessary for |
136 | software controlled poweroff. | 142 | software-controlled poweroff. |
143 | |||
144 | To compile this driver as a module, choose M here: | ||
145 | the module will be called button. | ||
137 | 146 | ||
138 | config ACPI_VIDEO | 147 | config ACPI_VIDEO |
139 | tristate "Video" | 148 | tristate "Video" |
@@ -141,38 +150,45 @@ config ACPI_VIDEO | |||
141 | depends on INPUT | 150 | depends on INPUT |
142 | select THERMAL | 151 | select THERMAL |
143 | help | 152 | help |
144 | This driver implement the ACPI Extensions For Display Adapters | 153 | This driver implements the ACPI Extensions For Display Adapters |
145 | for integrated graphics devices on motherboard, as specified in | 154 | for integrated graphics devices on motherboard, as specified in |
146 | ACPI 2.0 Specification, Appendix B, allowing to perform some basic | 155 | ACPI 2.0 Specification, Appendix B. This supports basic operations |
147 | control like defining the video POST device, retrieving EDID information | 156 | such as defining the video POST device, retrieving EDID information, |
148 | or to setup a video output, etc. | 157 | and setting up a video output. |
149 | Note that this is an ref. implementation only. It may or may not work | 158 | |
150 | for your integrated video device. | 159 | To compile this driver as a module, choose M here: |
160 | the module will be called video. | ||
151 | 161 | ||
152 | config ACPI_FAN | 162 | config ACPI_FAN |
153 | tristate "Fan" | 163 | tristate "Fan" |
154 | select THERMAL | 164 | select THERMAL |
155 | default y | 165 | default y |
156 | help | 166 | help |
157 | This driver adds support for ACPI fan devices, allowing user-mode | 167 | This driver supports ACPI fan devices, allowing user-mode |
158 | applications to perform basic fan control (on, off, status). | 168 | applications to perform basic fan control (on, off, status). |
159 | 169 | ||
170 | To compile this driver as a module, choose M here: | ||
171 | the module will be called fan. | ||
172 | |||
160 | config ACPI_DOCK | 173 | config ACPI_DOCK |
161 | bool "Dock" | 174 | bool "Dock" |
162 | depends on EXPERIMENTAL | 175 | depends on EXPERIMENTAL |
163 | help | 176 | help |
164 | This driver adds support for ACPI controlled docking stations and removable | 177 | This driver supports ACPI-controlled docking stations and removable |
165 | drive bays such as the IBM ultrabay or the Dell Module Bay. | 178 | drive bays such as the IBM Ultrabay and the Dell Module Bay. |
166 | 179 | ||
167 | config ACPI_PROCESSOR | 180 | config ACPI_PROCESSOR |
168 | tristate "Processor" | 181 | tristate "Processor" |
169 | select THERMAL | 182 | select THERMAL |
170 | default y | 183 | default y |
171 | help | 184 | help |
172 | This driver installs ACPI as the idle handler for Linux, and uses | 185 | This driver installs ACPI as the idle handler for Linux and uses |
173 | ACPI C2 and C3 processor states to save power, on systems that | 186 | ACPI C2 and C3 processor states to save power on systems that |
174 | support it. It is required by several flavors of cpufreq | 187 | support it. It is required by several flavors of cpufreq |
175 | Performance-state drivers. | 188 | performance-state drivers. |
189 | |||
190 | To compile this driver as a module, choose M here: | ||
191 | the module will be called processor. | ||
176 | 192 | ||
177 | config ACPI_HOTPLUG_CPU | 193 | config ACPI_HOTPLUG_CPU |
178 | bool | 194 | bool |
@@ -186,11 +202,14 @@ config ACPI_THERMAL | |||
186 | select THERMAL | 202 | select THERMAL |
187 | default y | 203 | default y |
188 | help | 204 | help |
189 | This driver adds support for ACPI thermal zones. Most mobile and | 205 | This driver supports ACPI thermal zones. Most mobile and |
190 | some desktop systems support ACPI thermal zones. It is HIGHLY | 206 | some desktop systems support ACPI thermal zones. It is HIGHLY |
191 | recommended that this option be enabled, as your processor(s) | 207 | recommended that this option be enabled, as your processor(s) |
192 | may be damaged without it. | 208 | may be damaged without it. |
193 | 209 | ||
210 | To compile this driver as a module, choose M here: | ||
211 | the module will be called thermal. | ||
212 | |||
194 | config ACPI_NUMA | 213 | config ACPI_NUMA |
195 | bool "NUMA support" | 214 | bool "NUMA support" |
196 | depends on NUMA | 215 | depends on NUMA |
@@ -218,7 +237,7 @@ config ACPI_BLACKLIST_YEAR | |||
218 | int "Disable ACPI for systems before Jan 1st this year" if X86_32 | 237 | int "Disable ACPI for systems before Jan 1st this year" if X86_32 |
219 | default 0 | 238 | default 0 |
220 | help | 239 | help |
221 | enter a 4-digit year, eg. 2001 to disable ACPI by default | 240 | Enter a 4-digit year, e.g., 2001, to disable ACPI by default |
222 | on platforms with DMI BIOS date before January 1st that year. | 241 | on platforms with DMI BIOS date before January 1st that year. |
223 | "acpi=force" can be used to override this mechanism. | 242 | "acpi=force" can be used to override this mechanism. |
224 | 243 | ||
@@ -249,10 +268,13 @@ config ACPI_PCI_SLOT | |||
249 | tristate "PCI slot detection driver" | 268 | tristate "PCI slot detection driver" |
250 | default n | 269 | default n |
251 | help | 270 | help |
252 | This driver will attempt to discover all PCI slots in your system, | 271 | This driver creates entries in /sys/bus/pci/slots/ for all PCI |
253 | and creates entries in /sys/bus/pci/slots/. This feature can | 272 | slots in the system. This can help correlate PCI bus addresses, |
254 | help you correlate PCI bus addresses with the physical geography | 273 | i.e., segment/bus/device/function tuples, with physical slots in |
255 | of your slots. If you are unsure, say N. | 274 | the system. If you are unsure, say N. |
275 | |||
276 | To compile this driver as a module, choose M here: | ||
277 | the module will be called pci_slot. | ||
256 | 278 | ||
257 | config X86_PM_TIMER | 279 | config X86_PM_TIMER |
258 | bool "Power Management Timer Support" if EMBEDDED | 280 | bool "Power Management Timer Support" if EMBEDDED |
@@ -271,43 +293,43 @@ config X86_PM_TIMER | |||
271 | systems require this timer. | 293 | systems require this timer. |
272 | 294 | ||
273 | config ACPI_CONTAINER | 295 | config ACPI_CONTAINER |
274 | tristate "ACPI0004,PNP0A05 and PNP0A06 Container Driver (EXPERIMENTAL)" | 296 | tristate "Container and Module Devices (EXPERIMENTAL)" |
275 | depends on EXPERIMENTAL | 297 | depends on EXPERIMENTAL |
276 | default (ACPI_HOTPLUG_MEMORY || ACPI_HOTPLUG_CPU || ACPI_HOTPLUG_IO) | 298 | default (ACPI_HOTPLUG_MEMORY || ACPI_HOTPLUG_CPU || ACPI_HOTPLUG_IO) |
277 | ---help--- | 299 | help |
278 | This allows _physical_ insertion and removal of CPUs and memory. | 300 | This driver supports ACPI Container and Module devices (IDs |
279 | This can be useful, for example, on NUMA machines that support | 301 | ACPI0004, PNP0A05, and PNP0A06). |
280 | ACPI based physical hotplug of nodes, or non-NUMA machines that | ||
281 | support physical cpu/memory hot-plug. | ||
282 | 302 | ||
283 | If one selects "m", this driver can be loaded with | 303 | This helps support hotplug of nodes, CPUs, and memory. |
284 | "modprobe container". | 304 | |
305 | To compile this driver as a module, choose M here: | ||
306 | the module will be called container. | ||
285 | 307 | ||
286 | config ACPI_HOTPLUG_MEMORY | 308 | config ACPI_HOTPLUG_MEMORY |
287 | tristate "Memory Hotplug" | 309 | tristate "Memory Hotplug" |
288 | depends on MEMORY_HOTPLUG | 310 | depends on MEMORY_HOTPLUG |
289 | default n | 311 | default n |
290 | help | 312 | help |
291 | This driver adds supports for ACPI Memory Hotplug. This driver | 313 | This driver supports ACPI memory hotplug. The driver |
292 | provides support for fielding notifications on ACPI memory | 314 | fields notifications on ACPI memory devices (PNP0C80), |
293 | devices (PNP0C80) which represent memory ranges that may be | 315 | which represent memory ranges that may be onlined or |
294 | onlined or offlined during runtime. | 316 | offlined during runtime. |
295 | 317 | ||
296 | Enabling this driver assumes that your platform hardware | 318 | If your hardware and firmware do not support adding or |
297 | and firmware have support for hot-plugging physical memory. If | 319 | removing memory devices at runtime, you need not enable |
298 | your system does not support physically adding or ripping out | 320 | this driver. |
299 | memory DIMMs at some platform defined granularity (individually | ||
300 | or as a bank) at runtime, then you need not enable this driver. | ||
301 | 321 | ||
302 | If one selects "m," this driver can be loaded using the following | 322 | To compile this driver as a module, choose M here: |
303 | command: | 323 | the module will be called acpi_memhotplug. |
304 | $>modprobe acpi_memhotplug | ||
305 | 324 | ||
306 | config ACPI_SBS | 325 | config ACPI_SBS |
307 | tristate "Smart Battery System" | 326 | tristate "Smart Battery System" |
308 | depends on X86 | 327 | depends on X86 |
309 | help | 328 | help |
310 | This driver adds support for the Smart Battery System, another | 329 | This driver supports the Smart Battery System, another |
311 | type of access to battery information, found on some laptops. | 330 | type of access to battery information, found on some laptops. |
312 | 331 | ||
332 | To compile this driver as a module, choose M here: | ||
333 | the modules will be called sbs and sbshc. | ||
334 | |||
313 | endif # ACPI | 335 | endif # ACPI |