]> CyberLeo.Net >> Repos - FreeBSD/releng/9.0.git/blob - share/man/man4/acpi.4
Copy stable/9 to releng/9.0 as part of the FreeBSD 9.0-RELEASE release
[FreeBSD/releng/9.0.git] / share / man / man4 / acpi.4
1 .\"
2 .\" Copyright (c) 2001 Michael Smith
3 .\" All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\"
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 .\" SUCH DAMAGE.
25 .\"
26 .\" $FreeBSD$
27 .\"
28 .Dd October 26, 2010
29 .Dt ACPI 4
30 .Os
31 .Sh NAME
32 .Nm acpi
33 .Nd Advanced Configuration and Power Management support
34 .Sh SYNOPSIS
35 .Cd "device acpi"
36 .Pp
37 .Cd "options ACPI_DEBUG"
38 .Cd "options DDB"
39 .Sh DESCRIPTION
40 The
41 .Nm
42 driver provides support for the Intel/Microsoft/Compaq/Toshiba ACPI
43 standard.
44 This support includes platform hardware discovery (superseding the
45 PnP and PCI BIOS), as well as power management (superseding APM) and
46 other features.
47 ACPI core support is provided by the ACPI CA reference implementation
48 from Intel.
49 .Pp
50 Note that the
51 .Nm
52 driver is automatically loaded by the
53 .Xr loader 8 ,
54 and should only be
55 compiled into the kernel on platforms where ACPI is mandatory.
56 .Sh SYSCTL VARIABLES
57 The
58 .Nm
59 driver is intended to provide power management without user intervention.
60 If the default settings are not optimal, the following sysctls can be
61 used to modify or monitor
62 .Nm
63 behavior.
64 .Bl -tag -width indent
65 .It Va debug.acpi.enable_debug_objects
66 Enable dumping Debug objects without
67 .Cd "options ACPI_DEBUG" .
68 Default is 0, ignore Debug objects.
69 .It Va hw.acpi.acline
70 AC line state (1 means online, 0 means on battery power).
71 .It Va hw.acpi.cpu.cx_usage
72 Debugging information listing the percent of total usage for each sleep state.
73 The values are reset when
74 .Va hw.acpi.cpu.cx_lowest
75 is modified.
76 .It Va hw.acpi.cpu.cx_lowest
77 Lowest Cx state to use for idling the CPU.
78 A scheduling algorithm will select states between
79 .Li C1
80 and this setting
81 as system load dictates.
82 To enable ACPI CPU idling control,
83 .Va machdep.cpu_idle_hlt
84 must be set to 1.
85 .It Va hw.acpi.cpu.cx_supported
86 List of supported CPU idle states and their transition latency
87 in microseconds.
88 Each state has a type (e.g.,
89 .Li C2 ) .
90 .Li C1
91 is equivalent to the ia32
92 .Li HLT
93 instruction,
94 .Li C2
95 provides a deeper
96 sleep with the same semantics, and
97 .Li C3
98 provides the deepest sleep
99 but additionally requires bus mastering to be disabled.
100 States greater than
101 .Li C3
102 provide even more power savings with the same
103 semantics as the
104 .Li C3
105 state.
106 Deeper sleeps provide more power savings but increased transition
107 latency when an interrupt occurs.
108 .It Va hw.acpi.disable_on_reboot
109 Disable ACPI during the reboot process.
110 Most systems reboot fine with ACPI still enabled, but some require
111 exiting to legacy mode first.
112 Default is 0, leave ACPI enabled.
113 .It Va hw.acpi.handle_reboot
114 Use the ACPI Reset Register capability to reboot the system.
115 Some newer systems require use of this register, while some only work
116 with legacy rebooting support.
117 .It Va hw.acpi.lid_switch_state
118 Suspend state
119 .Pq Li S1 Ns \[en] Ns Li S5
120 to enter when the lid switch (i.e., a notebook screen) is closed.
121 Default is
122 .Dq Li NONE
123 (do nothing).
124 .It Va hw.acpi.power_button_state
125 Suspend state
126 .Pq Li S1 Ns \[en] Ns Li S5
127 to enter when the power button is pressed.
128 Default is
129 .Li S5
130 (power-off nicely).
131 .It Va hw.acpi.reset_video
132 Reset the video adapter from real mode during the resume path.
133 Some systems need this help, others have display problems if it is enabled.
134 Default is 0 (disabled).
135 .It Va hw.acpi.s4bios
136 Indicate whether the system supports
137 .Li S4BIOS .
138 This means that the BIOS can handle all the functions of suspending the
139 system to disk.
140 Otherwise, the OS is responsible for suspending to disk
141 .Pq Li S4OS .
142 Most current systems do not support
143 .Li S4BIOS .
144 .It Va hw.acpi.sleep_button_state
145 Suspend state
146 .Pq Li S1 Ns \[en] Ns Li S5
147 to enter when the sleep button is pressed.
148 This is usually a special function button on the keyboard.
149 Default is
150 .Li S3
151 (suspend-to-RAM).
152 .It Va hw.acpi.sleep_delay
153 Wait this number of seconds between preparing the system to suspend and
154 actually entering the suspend state.
155 Default is 1 second.
156 .It Va hw.acpi.supported_sleep_state
157 Suspend states
158 .Pq Li S1 Ns \[en] Ns Li S5
159 supported by the BIOS.
160 .Bl -tag -width indent
161 .It Li S1
162 Quick suspend to RAM.
163 The CPU enters a lower power state, but most peripherals are left running.
164 .It Li S2
165 Lower power state than
166 .Li S1 ,
167 but with the same basic characteristics.
168 Not supported by many systems.
169 .It Li S3
170 Suspend to RAM.
171 Most devices are powered off, and the system stops running except for
172 memory refresh.
173 .It Li S4
174 Suspend to disk.
175 All devices are powered off, and the system stops running.
176 When resuming, the system starts as if from a cold power on.
177 Not yet supported by
178 .Fx
179 unless
180 .Li S4BIOS
181 is available.
182 .It Li S5
183 System shuts down cleanly and powers off.
184 .El
185 .It Va hw.acpi.verbose
186 Enable verbose printing from the various ACPI subsystems.
187 .El
188 .Sh LOADER TUNABLES
189 Tunables can be set at the
190 .Xr loader 8
191 prompt before booting the kernel or stored in
192 .Pa /boot/loader.conf .
193 Many of these tunables also have a matching
194 .Xr sysctl 8
195 entry for access after boot.
196 .Bl -tag -width indent
197 .It Va acpi_dsdt_load
198 Enables loading of a custom ACPI DSDT.
199 .It Va acpi_dsdt_name
200 Name of the DSDT table to load, if loading is enabled.
201 .It Va debug.acpi.disabled
202 Selectively disables portions of ACPI for debugging purposes.
203 .It Va debug.acpi.interpreter_slack
204 Enable less strict ACPI implementations.
205 Default is 1, ignore common BIOS mistakes.
206 .It Va debug.acpi.max_threads
207 Specify the number of task threads that are started on boot.
208 Limiting this to 1 may help work around various BIOSes that cannot
209 handle parallel requests.
210 The default value is 3.
211 .It Va debug.acpi.quirks
212 Override any automatic quirks completely.
213 .It Va debug.acpi.resume_beep
214 Beep the PC speaker on resume.
215 This can help diagnose suspend/resume problems.
216 Default is 0 (disabled).
217 .It Va hint.acpi.0.disabled
218 Set this to 1 to disable all of ACPI.
219 If ACPI has been disabled on your system due to a blacklist entry for your
220 BIOS, you can set this to 0 to re-enable ACPI for testing.
221 .It Va hw.acpi.ec.poll_timeout
222 Delay in milliseconds to wait for the EC to respond.
223 Try increasing this number if you get the error
224 .Qq Li AE_NO_HARDWARE_RESPONSE .
225 .It Va hw.acpi.host_mem_start
226 Override the assumed memory starting address for PCI host bridges.
227 .It Va hw.acpi.install_interface , hw.acpi.remove_interface
228 Install or remove OS interface(s) to control return value of
229 .Ql _OSI
230 query method.  When an OS interface is specified in
231 .Va hw.acpi.install_interface ,
232 .Li _OSI
233 query for the interface returns it is
234 .Em supported .
235 Conversely, when an OS interface is specified in
236 .Va hw.acpi.remove_interface ,
237 .Li _OSI
238 query returns it is
239 .Em not supported .
240 Multiple interfaces can be specified in a comma-separated list and
241 any leading white spaces will be ignored.  For example,
242 .Qq Li FreeBSD, Linux
243 is a valid list of two interfaces
244 .Qq Li FreeBSD
245 and
246 .Qq Li Linux .
247 .It Va hw.acpi.reset_video
248 Enables calling the VESA reset BIOS vector on the resume path.
249 This can fix some graphics cards that have problems such as LCD white-out
250 after resume.
251 Default is 0 (disabled).
252 .It Va hw.acpi.serialize_methods
253 Allow override of whether methods execute in parallel or not.
254 Enable this for serial behavior, which fixes
255 .Qq Li AE_ALREADY_EXISTS
256 errors for
257 AML that really cannot handle parallel method execution.
258 It is off by default since this breaks recursive methods and some IBMs use
259 such code.
260 .It Va hw.acpi.verbose
261 Turn on verbose debugging information about what ACPI is doing.
262 .It Va hw.pci.link.%s.%d.irq
263 Override the interrupt to use for this link and index.
264 This capability should be used carefully, and only if a device is not
265 working with
266 .Nm
267 enabled.
268 .Qq %s
269 is the name of the link (e.g., LNKA).
270 .Qq %d
271 is the resource index when the link supports multiple IRQs.
272 Most PCI links only have one IRQ resource, so the below form should be used.
273 .It Va hw.pci.link.%s.irq
274 Override the interrupt to use.
275 This capability should be used carefully, and only if a device is not
276 working with
277 .Nm
278 enabled.
279 .Qq %s
280 is the name of the link (e.g., LNKA).
281 .El
282 .Sh DISABLING ACPI
283 Since ACPI support on different platforms varies greatly, there are many
284 debugging and tuning options available.
285 .Pp
286 For machines known not to work with
287 .Nm
288 enabled, there is a BIOS blacklist.
289 Currently, the blacklist only controls whether
290 .Nm
291 should be disabled or not.
292 In the future, it will have more granularity to control features (the
293 infrastructure for that is already there).
294 .Pp
295 To enable
296 .Nm
297 (for debugging purposes, etc.) on machines that are on the blacklist, set the
298 kernel environment variable
299 .Va hint.acpi.0.disabled
300 to 0.
301 Before trying this, consider updating your BIOS to a more recent version that
302 may be compatible with ACPI.
303 .Pp
304 To disable the
305 .Nm
306 driver completely, set the kernel environment variable
307 .Va hint.acpi.0.disabled
308 to 1.
309 .Pp
310 Some i386 machines totally fail to operate with some or all of ACPI disabled.
311 Other i386 machines fail with ACPI enabled.
312 Disabling all or part of ACPI on non-i386 platforms (i.e., platforms where
313 ACPI support is mandatory) may result in a non-functional system.
314 .Pp
315 The
316 .Nm
317 driver comprises a set of drivers, which may be selectively disabled
318 in case of problems.
319 To disable a sub-driver, list it in the kernel
320 environment variable
321 .Va debug.acpi.disabled .
322 Multiple entries can be listed, separated by a space.
323 .Pp
324 ACPI sub-devices and features that can be disabled:
325 .Bl -tag -width ".Li sysresource"
326 .It Li all
327 Disable all ACPI features and devices.
328 .It Li acad
329 .Pq Vt device
330 Supports AC adapter.
331 .It Li bus
332 .Pq Vt feature
333 Probes and attaches subdevices.
334 Disabling will avoid scanning the ACPI namespace entirely.
335 .It Li children
336 .Pq Vt feature
337 Attaches standard ACPI sub-drivers and devices enumerated in the
338 ACPI namespace.
339 Disabling this has a similar effect to disabling
340 .Dq Li bus ,
341 except that the
342 ACPI namespace will still be scanned.
343 .It Li button
344 .Pq Vt device
345 Supports ACPI button devices (typically power and sleep buttons).
346 .It Li cmbat
347 .Pq Vt device
348 Control-method batteries device.
349 .It Li cpu
350 .Pq Vt device
351 Supports CPU power-saving and speed-setting functions.
352 .It Li ec
353 .Pq Vt device
354 Supports the ACPI Embedded Controller interface, used to communicate
355 with embedded platform controllers.
356 .It Li isa
357 .Pq Vt device
358 Supports an ISA bus bridge defined in the ACPI namespace,
359 typically as a child of a PCI bus.
360 .It Li lid
361 .Pq Vt device
362 Supports an ACPI laptop lid switch, which typically puts a
363 system to sleep.
364 .It Li quirks
365 .Pq Vt feature
366 Do not honor quirks.
367 Quirks automatically disable ACPI functionality based on the XSDT table's
368 OEM vendor name and revision date.
369 .It Li pci
370 .Pq Vt device
371 Supports Host to PCI bridges.
372 .It Li pci_link
373 .Pq Vt feature
374 Performs PCI interrupt routing.
375 .It Li sysresource
376 .Pq Vt device
377 Pseudo-devices containing resources which ACPI claims.
378 .It Li thermal
379 .Pq Vt device
380 Supports system cooling and heat management.
381 .It Li timer
382 .Pq Vt device
383 Implements a timecounter using the ACPI fixed-frequency timer.
384 .It Li video
385 .Pq Vt device
386 Supports
387 .Xr acpi_video 4
388 which may conflict with
389 .Xr agp 4
390 device.
391 .El
392 .Pp
393 It is also possible to avoid portions of the ACPI namespace which
394 may be causing problems, by listing the full path of the root of
395 the region to be avoided in the kernel environment variable
396 .Va debug.acpi.avoid .
397 The object and all of its children will be ignored during the
398 bus/children scan of the namespace.
399 The ACPI CA code will still know about the avoided region.
400 .Sh DEBUGGING OUTPUT
401 To enable debugging output,
402 .Nm
403 must be compiled with
404 .Cd "options ACPI_DEBUG" .
405 Debugging output is separated between layers and levels, where a layer is
406 a component of the ACPI subsystem, and a level is a particular kind
407 of debugging output.
408 .Pp
409 Both layers and levels are specified as a whitespace-separated list of
410 tokens, with layers listed in
411 .Va debug.acpi.layer
412 and levels in
413 .Va debug.acpi.level .
414 .Pp
415 The first set of layers is for ACPI-CA components, and the second is for
416 .Fx
417 drivers.
418 The ACPI-CA layer descriptions include the prefix for the files they
419 refer to.
420 The supported layers are:
421 .Pp
422 .Bl -tag -compact -width ".Li ACPI_CA_DISASSEMBLER"
423 .It Li ACPI_UTILITIES
424 Utility ("ut") functions
425 .It Li ACPI_HARDWARE
426 Hardware access ("hw")
427 .It Li ACPI_EVENTS
428 Event and GPE ("ev")
429 .It Li ACPI_TABLES
430 Table access ("tb")
431 .It Li ACPI_NAMESPACE
432 Namespace evaluation ("ns")
433 .It Li ACPI_PARSER
434 AML parser ("ps")
435 .It Li ACPI_DISPATCHER
436 Internal representation of interpreter state ("ds")
437 .It Li ACPI_EXECUTER
438 Execute AML methods ("ex")
439 .It Li ACPI_RESOURCES
440 Resource parsing ("rs")
441 .It Li ACPI_CA_DEBUGGER
442 Debugger implementation ("db", "dm")
443 .It Li ACPI_OS_SERVICES
444 Usermode support routines ("os")
445 .It Li ACPI_CA_DISASSEMBLER
446 Disassembler implementation (unused)
447 .It Li ACPI_ALL_COMPONENTS
448 All the above ACPI-CA components
449 .It Li ACPI_AC_ADAPTER
450 AC adapter driver
451 .It Li ACPI_BATTERY
452 Control-method battery driver
453 .It Li ACPI_BUS
454 ACPI, ISA, and PCI bus drivers
455 .It Li ACPI_BUTTON
456 Power and sleep button driver
457 .It Li ACPI_EC
458 Embedded controller driver
459 .It Li ACPI_FAN
460 Fan driver
461 .It Li ACPI_OEM
462 Platform-specific driver for hotkeys, LED, etc.
463 .It Li ACPI_POWER
464 Power resource driver
465 .It Li ACPI_PROCESSOR
466 CPU driver
467 .It Li ACPI_THERMAL
468 Thermal zone driver
469 .It Li ACPI_TIMER
470 Timer driver
471 .It Li ACPI_ALL_DRIVERS
472 All the above
473 .Fx
474 ACPI drivers
475 .El
476 .Pp
477 The supported levels are:
478 .Pp
479 .Bl -tag -compact -width ".Li ACPI_LV_AML_DISASSEMBLE"
480 .It Li ACPI_LV_INIT
481 Initialization progress
482 .It Li ACPI_LV_DEBUG_OBJECT
483 Stores to objects
484 .It Li ACPI_LV_INFO
485 General information and progress
486 .It Li ACPI_LV_ALL_EXCEPTIONS
487 All the previous levels
488 .It Li ACPI_LV_PARSE
489 .It Li ACPI_LV_DISPATCH
490 .It Li ACPI_LV_EXEC
491 .It Li ACPI_LV_NAMES
492 .It Li ACPI_LV_OPREGION
493 .It Li ACPI_LV_BFIELD
494 .It Li ACPI_LV_TABLES
495 .It Li ACPI_LV_VALUES
496 .It Li ACPI_LV_OBJECTS
497 .It Li ACPI_LV_RESOURCES
498 .It Li ACPI_LV_USER_REQUESTS
499 .It Li ACPI_LV_PACKAGE
500 .It Li ACPI_LV_VERBOSITY1
501 All the previous levels
502 .It Li ACPI_LV_ALLOCATIONS
503 .It Li ACPI_LV_FUNCTIONS
504 .It Li ACPI_LV_OPTIMIZATIONS
505 .It Li ACPI_LV_VERBOSITY2
506 All the previous levels
507 .It Li ACPI_LV_ALL
508 Synonym for
509 .Qq Li ACPI_LV_VERBOSITY2
510 .It Li ACPI_LV_MUTEX
511 .It Li ACPI_LV_THREADS
512 .It Li ACPI_LV_IO
513 .It Li ACPI_LV_INTERRUPTS
514 .It Li ACPI_LV_VERBOSITY3
515 All the previous levels
516 .It Li ACPI_LV_AML_DISASSEMBLE
517 .It Li ACPI_LV_VERBOSE_INFO
518 .It Li ACPI_LV_FULL_TABLES
519 .It Li ACPI_LV_EVENTS
520 .It Li ACPI_LV_VERBOSE
521 All levels after
522 .Qq Li ACPI_LV_VERBOSITY3
523 .It Li ACPI_LV_INIT_NAMES
524 .It Li ACPI_LV_LOAD
525 .El
526 .Pp
527 Selection of the appropriate layer and level values is important
528 to avoid massive amounts of debugging output.
529 For example, the following configuration is a good way to gather initial
530 information.
531 It enables debug output for both ACPI-CA and the
532 .Nm
533 driver, printing basic information about errors, warnings, and progress.
534 .Bd -literal -offset indent
535 debug.acpi.layer="ACPI_ALL_COMPONENTS ACPI_ALL_DRIVERS"
536 debug.acpi.level="ACPI_LV_ALL_EXCEPTIONS"
537 .Ed
538 .Pp
539 Debugging output by the ACPI CA subsystem is prefixed with the
540 module name in lowercase, followed by a source line number.
541 Output from the
542 .Fx Ns -local
543 code follows the same format, but
544 the module name is uppercased.
545 .Sh OVERRIDING YOUR BIOS BYTECODE
546 ACPI interprets bytecode named AML
547 (ACPI Machine Language)
548 provided by the BIOS vendor as a memory image at boot time.
549 Sometimes, the AML code contains a bug that does not appear when parsed
550 by the Microsoft implementation.
551 .Fx
552 provides a way to override it with your own AML code to work around
553 or debug such problems.
554 Note that all AML in your DSDT and any SSDT tables is overridden.
555 .Pp
556 In order to load your AML code, you must edit
557 .Pa /boot/loader.conf
558 and include the following lines.
559 .Bd -literal -offset indent
560 acpi_dsdt_load="YES"
561 acpi_dsdt_name="/boot/acpi_dsdt.aml" # You may change this name.
562 .Ed
563 .Pp
564 In order to prepare your AML code, you will need the
565 .Xr acpidump 8
566 and
567 .Xr iasl 8
568 utilities and some ACPI knowledge.
569 .Sh COMPATIBILITY
570 ACPI is only found and supported on i386/ia32, ia64, and amd64.
571 .Sh SEE ALSO
572 .Xr kenv 1 ,
573 .Xr acpi_thermal 4 ,
574 .Xr device.hints 5 ,
575 .Xr loader.conf 5 ,
576 .Xr acpiconf 8 ,
577 .Xr acpidump 8 ,
578 .Xr config 8 ,
579 .Xr iasl 8
580 .Rs
581 .%A "Compaq Computer Corporation"
582 .%A "Intel Corporation"
583 .%A "Microsoft Corporation"
584 .%A "Phoenix Technologies Ltd."
585 .%A "Toshiba Corporation"
586 .%D August 25, 2003
587 .%T "Advanced Configuration and Power Interface Specification"
588 .%U http://acpi.info/spec.htm
589 .Re
590 .Sh AUTHORS
591 .An -nosplit
592 The ACPI CA subsystem is developed and maintained by
593 Intel Architecture Labs.
594 .Pp
595 The following people made notable contributions to the ACPI subsystem
596 in
597 .Fx :
598 .An Michael Smith ,
599 .An Takanori Watanabe Aq takawata@jp.FreeBSD.org ,
600 .An Mitsuru IWASAKI Aq iwasaki@jp.FreeBSD.org ,
601 .An Munehiro Matsuda ,
602 .An Nate Lawson ,
603 the ACPI-jp mailing list at
604 .Aq acpi-jp@jp.FreeBSD.org ,
605 and many other contributors.
606 .Pp
607 This manual page was written by
608 .An Michael Smith Aq msmith@FreeBSD.org .
609 .Sh BUGS
610 Many BIOS versions have serious bugs that may cause system instability,
611 break suspend/resume, or prevent devices from operating properly due to
612 IRQ routing problems.
613 Upgrade your BIOS to the latest version available from the vendor before
614 deciding it is a problem with
615 .Nm .
616 .Pp
617 The
618 .Nm
619 CPU idle power management drive conflicts with the local APIC (LAPIC)
620 timer.
621 Disable the local APIC timer with
622 .Va hint.apic.0.clock=0
623 or do not use the
624 .Li C3
625 and deeper states if the local APIC timer is enabled.