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: src/share/man/man4/acpi.4,v 1.50 2005/02/23 07:23:35 trhodes Exp $ 27.\" $DragonFly: src/share/man/man4/acpi.4,v 1.7 2007/09/29 19:38:46 swildner Exp $ 28.\" 29.Dd September 29, 2007 30.Dt ACPI 4 31.Os 32.Sh NAME 33.Nm acpi 34.Nd Advanced Configuration and Power Management support 35.Sh SYNOPSIS 36.Cd "device acpi" 37.Pp 38.Cd "options ACPI_QUIRK_VMWARE" 39.Cd "options ACPI_DEBUG" 40.Sh DESCRIPTION 41The 42.Nm 43driver provides support for the Intel/Microsoft/Compaq/Toshiba ACPI 44standard. 45This support includes platform hardware discovery (superseding the 46PnP and PCI BIOS), as well as power management (superseding APM) and 47other features. 48ACPI core support is provided by the ACPI CA reference implementation 49from Intel. 50.Pp 51It was observed that when running 52.Dx 53as a guest in VMware 5.5.1 under SMP conditions, VMware's ACPI-fast24 54timer runs roughly 65 times too fast. 55The 56.Dv ACPI_QUIRK_VMWARE 57option can be specified in the kernel configuration file in order to 58fix this problem. 59.Pp 60Note that the 61.Nm 62driver is automatically loaded by the 63.Xr loader 8 , 64and should only be 65compiled into the kernel on platforms where ACPI is mandatory. 66.Sh SYSCTLS 67The 68.Nm 69driver is intended to provide power management without user intervention. 70Thus, some of these sysctls are controlled automatically by the 71.Pa power_profile 72.Xr rc 8 73script, which can be configured via 74.Xr rc.conf 5 . 75If values are specified manually, they may be overridden. 76.Bl -tag -width indent 77.It Va hw.acpi.cpu.cx_usage 78Debugging information listing the percent of total usage for each sleep state. 79The values are reset when 80.Va hw.acpi.cpu.cx_lowest 81is modified. 82.It Va hw.acpi.cpu.cx_lowest 83Lowest Cx state to use for idling the CPU. 84A scheduling algorithm will select states between C1 and this setting 85as system load dictates. 86To enable ACPI CPU idling control, 87.Va machdep.cpu_idle_hlt 88must be set to 1. 89.It Va hw.acpi.cpu.cx_supported 90List of supported CPU idle states and their transition latency 91in microseconds. 92Each state has a type (e.g., C2). 93C1 is equivalent to the ia32 HLT instruction, C2 provides a deeper 94sleep with the same semantics, and C3 provides the deepest sleep 95but additionally requires bus mastering to be disabled. 96States greater than C3 provide even more power savings with the same 97semantics as the C3 state. 98Deeper sleeps provide more power savings but increased transition 99latency when an interrupt occurs. 100.El 101.Sh TUNABLES 102Tunables can be set at the 103.Xr loader 8 104prompt before booting the kernel or stored in 105.Pa /boot/loader.conf . 106.Bl -tag -width indent 107.It Va acpi_dsdt_load 108Enables loading of a custom ACPI DSDT. 109.It Va acpi_dsdt_name 110Name of the DSDT table to load, if loading is enabled. 111.It Va debug.acpi.disabled 112Selectively disables portions of ACPI that are enabled by default, for 113debugging purposes. 114.It Va debug.acpi.enabled 115Selectively enables portions of ACPI that are disabled by default, for 116debugging purposes. 117.It Va debug.acpi.quirks 118Override any automatic quirks completely. 119.It Va hint.acpi.0.disabled 120Set this to 1 to disable all of ACPI. 121If ACPI has been disabled on your system due to a blacklist entry for your 122BIOS, you can set this to 0 to re-enable ACPI for testing. 123.It Va hw.acpi.ec.poll_timeout 124Delay in milliseconds to wait for the EC to respond. 125Try increasing this number if you get the error 126.Qq Li AE_NO_HARDWARE_RESPONSE . 127.It Va hw.acpi.host_mem_start 128Override the assumed memory starting address for PCI host bridges. 129.It Va hw.acpi.pci.link.%d.%d.%d.irq 130Override the interrupt to use. 131.It Va hw.acpi.reset_video 132Enables calling the VESA reset BIOS vector on the resume path. 133Some graphic chips have problems such as LCD white-out after resume. 134Try setting this to 0 if this causes problems for you. 135.It Va hw.acpi.serialize_methods 136Allow override of whether methods execute in parallel or not. 137Enable this for serial behavior, which fixes 138.Qq Li AE_ALREADY_EXISTS 139errors for 140AML that really cannot handle parallel method execution. 141It is off by default since this breaks recursive methods and some IBMs use 142such code. 143.It Va hw.acpi.verbose 144Turn on verbose debugging information about what ACPI is doing. 145.El 146.Sh DISABLING ACPI 147Since ACPI support on different platforms varies greatly, there are many 148debugging and tuning options available. 149.Pp 150For machines known not to work with 151.Nm 152enabled, there is a BIOS blacklist. 153Currently, the blacklist only controls whether 154.Nm 155should be disabled or not. 156In the future, it will have more granularity to control features (the 157infrastructure for that is already there). 158.Pp 159To enable 160.Nm 161(for debugging purposes, etc.) on machines that are on the blacklist, set the 162kernel environment variable 163.Va hint.acpi.0.disabled 164to 0. 165Before trying this, consider updating your BIOS to a more recent version that 166may be compatible with ACPI. 167.Pp 168To disable the 169.Nm 170driver completely, set the kernel environment variable 171.Va hint.acpi.0.disabled 172to 1. 173.Pp 174Some i386 machines totally fail to operate with some or all of ACPI disabled. 175Other i386 machines fail with ACPI enabled. 176Disabling all or part of ACPI on non-i386 platforms (i.e., platforms where 177ACPI support is mandatory) may result in a non-functional system. 178.Pp 179The 180.Nm 181driver comprises a set of drivers, which may be selectively disabled 182in case of problems. 183To disable a sub-driver, list it in the kernel 184environment variable 185.Va debug.acpi.disabled . 186Multiple entries can be listed, separated by a space. 187.Pp 188ACPI sub-devices and features that can be disabled: 189.Bl -tag -width ".Li sysresource" 190.It Li all 191Disable all ACPI features and devices. 192.It Li acad 193.Pq Vt device 194Supports AC adapter. 195.It Li bus 196.Pq Vt feature 197Probes and attaches subdevices. 198Disabling will avoid scanning the ACPI namespace entirely. 199.It Li children 200.Pq Vt feature 201Attaches standard ACPI sub-drivers and devices enumerated in the 202ACPI namespace. 203Disabling this has a similar effect to disabling 204.Dq Li bus , 205except that the 206ACPI namespace will still be scanned. 207.It Li button 208.Pq Vt device 209Supports ACPI button devices (typically power and sleep buttons). 210.It Li cmbat 211.Pq Vt device 212Control-method batteries device. 213.It Li cpu 214.Pq Vt device 215Supports CPU power-saving and speed-setting functions. 216.It Li ec 217.Pq Vt device 218Supports the ACPI Embedded Controller interface, used to communicate 219with embedded platform controllers. 220.It Li isa 221.Pq Vt device 222Supports an ISA bus bridge defined in the ACPI namespace, 223typically as a child of a PCI bus. 224.It Li lid 225.Pq Vt device 226Supports an ACPI laptop lid switch, which typically puts a 227system to sleep. 228.It Li quirks 229.Pq Vt feature 230Do not honor quirks. 231Quirks automatically disable ACPI functionality based on the XSDT table's 232OEM vendor name and revision date. 233.It Li pci 234.Pq Vt device 235Supports Host to PCI bridges. 236.It Li pci_link 237.Pq Vt feature 238Performs PCI interrupt routing. 239.It Li sysresource 240.Pq Vt device 241Pseudo-devices containing resources which ACPI claims. 242.It Li thermal 243.Pq Vt device 244Supports system cooling and heat management. 245.It Li timer 246.Pq Vt device 247Implements a timecounter using the ACPI fixed-frequency timer. 248.It Li video 249.Pq Vt device 250Supports acpi_video which may conflict with agp device. 251.El 252.Pp 253It is also possible to avoid portions of the ACPI namespace which 254may be causing problems, by listing the full path of the root of 255the region to be avoided in the kernel environment variable 256.Va debug.acpi.avoid.paths , 257or 258.Va debug.acpi.avoid . 259The latter also disables initialization of ACPI namespace as a 260workaround for systems where not doing so crashes interpreter. 261The object and all of its children will be ignored during the 262bus/children scan of the namespace. 263The ACPI CA code will still know about the avoided region. 264.Sh DEBUGGING OUTPUT 265To enable debugging output, 266.Nm 267must be compiled with 268.Cd "options ACPI_DEBUG" . 269Debugging output is separated between layers and levels, where a layer is 270a component of the ACPI subsystem, and a level is a particular kind 271of debugging output. 272.Pp 273Both layers and levels are specified as a whitespace-separated list of 274tokens, with layers listed in 275.Va debug.acpi.layer 276and levels in 277.Va debug.acpi.level . 278.Pp 279The first set of layers is for ACPI-CA components, and the second is for 280.Dx 281drivers. 282The ACPI-CA layer descriptions include the prefix for the files they 283refer to. 284The supported layers are: 285.Pp 286.Bl -tag -compact -width ".Li ACPI_CA_DISASSEMBLER" 287.It Li ACPI_UTILITIES 288Utility ("ut") functions 289.It Li ACPI_HARDWARE 290Hardware access ("hw") 291.It Li ACPI_EVENTS 292Event and GPE ("ev") 293.It Li ACPI_TABLES 294Table access ("tb") 295.It Li ACPI_NAMESPACE 296Namespace evaluation ("ns") 297.It Li ACPI_PARSER 298AML parser ("ps") 299.It Li ACPI_DISPATCHER 300Internal representation of interpreter state ("ds") 301.It Li ACPI_EXECUTER 302Execute AML methods ("ex") 303.It Li ACPI_RESOURCES 304Resource parsing ("rs") 305.It Li ACPI_CA_DEBUGGER 306Debugger implementation ("db", "dm") 307.It Li ACPI_OS_SERVICES 308Usermode support routines ("os") 309.It Li ACPI_CA_DISASSEMBLER 310Disassembler implementation (unused) 311.It Li ACPI_ALL_COMPONENTS 312All the above ACPI-CA components 313.It Li ACPI_AC_ADAPTER 314AC adapter driver 315.It Li ACPI_BATTERY 316Control-method battery driver 317.It Li ACPI_BUS 318ACPI, ISA, and PCI bus drivers 319.It Li ACPI_BUTTON 320Power and sleep button driver 321.It Li ACPI_EC 322Embedded controller driver 323.It Li ACPI_FAN 324Fan driver 325.It Li ACPI_OEM 326Platform-specific driver for hotkeys, LED, etc. 327.It Li ACPI_POWER 328Power resource driver 329.It Li ACPI_PROCESSOR 330CPU driver 331.It Li ACPI_THERMAL 332Thermal zone driver 333.It Li ACPI_TIMER 334Timer driver 335.It Li ACPI_ALL_DRIVERS 336All the above 337.Dx 338ACPI drivers 339.El 340.Pp 341The supported levels are: 342.Pp 343.Bl -tag -compact -width ".Li ACPI_LV_AML_DISASSEMBLE" 344.It Li ACPI_LV_ERROR 345Fatal error conditions 346.It Li ACPI_LV_WARN 347Warnings and potential problems 348.It Li ACPI_LV_INIT 349Initialization progress 350.It Li ACPI_LV_DEBUG_OBJECT 351Stores to objects 352.It Li ACPI_LV_INFO 353General information and progress 354.It Li ACPI_LV_ALL_EXCEPTIONS 355All the previous levels 356.It Li ACPI_LV_INIT_NAMES 357.It Li ACPI_LV_PARSE 358.It Li ACPI_LV_LOAD 359.It Li ACPI_LV_DISPATCH 360.It Li ACPI_LV_EXEC 361.It Li ACPI_LV_NAMES 362.It Li ACPI_LV_OPREGION 363.It Li ACPI_LV_BFIELD 364.It Li ACPI_LV_TABLES 365.It Li ACPI_LV_VALUES 366.It Li ACPI_LV_OBJECTS 367.It Li ACPI_LV_RESOURCES 368.It Li ACPI_LV_USER_REQUESTS 369.It Li ACPI_LV_PACKAGE 370.It Li ACPI_LV_VERBOSITY1 371All the previous levels 372.It Li ACPI_LV_ALLOCATIONS 373.It Li ACPI_LV_FUNCTIONS 374.It Li ACPI_LV_OPTIMIZATIONS 375.It Li ACPI_LV_VERBOSITY2 376.It Li ACPI_LV_ALL 377.It Li ACPI_LV_MUTEX 378.It Li ACPI_LV_THREADS 379.It Li ACPI_LV_IO 380.It Li ACPI_LV_INTERRUPTS 381.It Li ACPI_LV_VERBOSITY3 382All the previous levels 383.It Li ACPI_LV_AML_DISASSEMBLE 384.It Li ACPI_LV_VERBOSE_INFO 385.It Li ACPI_LV_FULL_TABLES 386.It Li ACPI_LV_EVENTS 387.It Li ACPI_LV_VERBOSE 388All levels after 389.Qq Li ACPI_LV_VERBOSITY3 390.El 391.Pp 392Selection of the appropriate layer and level values is important 393to avoid massive amounts of debugging output. 394For example, the following configuration is a good way to gather initial 395information. 396It enables debug output for both ACPI-CA and the 397.Nm 398driver, printing basic information about errors, warnings, and progress. 399.Bd -literal -offset indent 400debug.acpi.layer="ACPI_ALL_COMPONENTS ACPI_ALL_DRIVERS" 401debug.acpi.level="ACPI_LV_ALL_EXCEPTIONS" 402.Ed 403.Pp 404Debugging output by the ACPI CA subsystem is prefixed with the 405module name in lowercase, followed by a source line number. 406Output from the 407.Dx Ns -local 408code follows the same format, but 409the module name is uppercased. 410.Sh OVERRIDING YOUR BIOS BYTECODE 411ACPI interprets bytecode named AML 412(ACPI Machine Language) 413provided by the BIOS vendor as a memory image at boot time. 414Sometimes, the AML code contains a bug that does not appear when parsed 415by the Microsoft implementation. 416.Dx 417provides a way to override it with your own AML code to work around 418or debug such problems. 419Note that all AML in your DSDT and any SSDT tables is overridden. 420.Pp 421In order to load your AML code, you must edit 422.Pa /boot/loader.conf 423and include the following lines. 424.Bd -literal -offset indent 425acpi_dsdt_load="YES" 426acpi_dsdt_name="/boot/acpi_dsdt.aml" # You may change this name. 427.Ed 428.Pp 429In order to prepare your AML code, you will need the 430.Xr acpidump 8 431and 432.Xr iasl 8 433utilities and some ACPI knowledge. 434.Sh COMPATIBILITY 435ACPI is only found and supported on i386/ia32, ia64, and amd64. 436.Sh SEE ALSO 437.Xr kenv 1 , 438.Xr acpi_thermal 4 , 439.Xr loader.conf 5 , 440.Xr acpiconf 8 , 441.Xr acpidump 8 , 442.Xr config 8 , 443.Xr iasl 8 444.Rs 445.%A "Compaq Computer Corporation" 446.%A "Intel Corporation" 447.%A "Microsoft Corporation" 448.%A "Phoenix Technologies Ltd." 449.%A "Toshiba Corporation" 450.%D August 25, 2003 451.%T "Advanced Configuration and Power Interface Specification" 452.%O http://acpi.info/spec.htm 453.Re 454.Sh AUTHORS 455.An -nosplit 456The ACPI CA subsystem is developed and maintained by 457Intel Architecture Labs. 458.Pp 459The following people made notable contributions to the ACPI subsystem 460in 461.Dx : 462.An Michael Smith , 463.An Takanori Watanabe Aq takawata@jp.FreeBSD.org , 464.An Mitsuru IWASAKI Aq iwasaki@jp.FreeBSD.org , 465.An Munehiro Matsuda , 466.An Nate Lawson , 467the ACPI-jp mailing list at 468.Aq acpi-jp@jp.FreeBSD.org , 469and many other contributors. 470.Pp 471This manual page was written by 472.An Michael Smith Aq msmith@FreeBSD.org . 473.Sh BUGS 474If the 475.Nm 476driver is loaded as a module when it is already linked as part of the 477kernel, odd things may happen. 478