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.8 2008/08/28 16:38:59 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 253The 254.Nm 255driver comprises a set of drivers, 256which may be selectively enabled in case of testing. 257To enable a sub-driver, 258list it in the kernel environment variable 259.Va debug.acpi.enabled . 260Multiple entries can be listed, 261separated by a space. 262.Pp 263ACPI sub-devices and features that can be enabled: 264.Bl -tag -width ".Li sysresource" 265.It Li hpet 266.Pq Vt device 267Supports HPET. 268.El 269.Pp 270It is also possible to avoid portions of the ACPI namespace which 271may be causing problems, by listing the full path of the root of 272the region to be avoided in the kernel environment variable 273.Va debug.acpi.avoid.paths , 274or 275.Va debug.acpi.avoid . 276The latter also disables initialization of ACPI namespace as a 277workaround for systems where not doing so crashes interpreter. 278The object and all of its children will be ignored during the 279bus/children scan of the namespace. 280The ACPI CA code will still know about the avoided region. 281.Sh DEBUGGING OUTPUT 282To enable debugging output, 283.Nm 284must be compiled with 285.Cd "options ACPI_DEBUG" . 286Debugging output is separated between layers and levels, where a layer is 287a component of the ACPI subsystem, and a level is a particular kind 288of debugging output. 289.Pp 290Both layers and levels are specified as a whitespace-separated list of 291tokens, with layers listed in 292.Va debug.acpi.layer 293and levels in 294.Va debug.acpi.level . 295.Pp 296The first set of layers is for ACPI-CA components, and the second is for 297.Dx 298drivers. 299The ACPI-CA layer descriptions include the prefix for the files they 300refer to. 301The supported layers are: 302.Pp 303.Bl -tag -compact -width ".Li ACPI_CA_DISASSEMBLER" 304.It Li ACPI_UTILITIES 305Utility ("ut") functions 306.It Li ACPI_HARDWARE 307Hardware access ("hw") 308.It Li ACPI_EVENTS 309Event and GPE ("ev") 310.It Li ACPI_TABLES 311Table access ("tb") 312.It Li ACPI_NAMESPACE 313Namespace evaluation ("ns") 314.It Li ACPI_PARSER 315AML parser ("ps") 316.It Li ACPI_DISPATCHER 317Internal representation of interpreter state ("ds") 318.It Li ACPI_EXECUTER 319Execute AML methods ("ex") 320.It Li ACPI_RESOURCES 321Resource parsing ("rs") 322.It Li ACPI_CA_DEBUGGER 323Debugger implementation ("db", "dm") 324.It Li ACPI_OS_SERVICES 325Usermode support routines ("os") 326.It Li ACPI_CA_DISASSEMBLER 327Disassembler implementation (unused) 328.It Li ACPI_ALL_COMPONENTS 329All the above ACPI-CA components 330.It Li ACPI_AC_ADAPTER 331AC adapter driver 332.It Li ACPI_BATTERY 333Control-method battery driver 334.It Li ACPI_BUS 335ACPI, ISA, and PCI bus drivers 336.It Li ACPI_BUTTON 337Power and sleep button driver 338.It Li ACPI_EC 339Embedded controller driver 340.It Li ACPI_FAN 341Fan driver 342.It Li ACPI_OEM 343Platform-specific driver for hotkeys, LED, etc. 344.It Li ACPI_POWER 345Power resource driver 346.It Li ACPI_PROCESSOR 347CPU driver 348.It Li ACPI_THERMAL 349Thermal zone driver 350.It Li ACPI_TIMER 351Timer driver 352.It Li ACPI_ALL_DRIVERS 353All the above 354.Dx 355ACPI drivers 356.El 357.Pp 358The supported levels are: 359.Pp 360.Bl -tag -compact -width ".Li ACPI_LV_AML_DISASSEMBLE" 361.It Li ACPI_LV_ERROR 362Fatal error conditions 363.It Li ACPI_LV_WARN 364Warnings and potential problems 365.It Li ACPI_LV_INIT 366Initialization progress 367.It Li ACPI_LV_DEBUG_OBJECT 368Stores to objects 369.It Li ACPI_LV_INFO 370General information and progress 371.It Li ACPI_LV_ALL_EXCEPTIONS 372All the previous levels 373.It Li ACPI_LV_INIT_NAMES 374.It Li ACPI_LV_PARSE 375.It Li ACPI_LV_LOAD 376.It Li ACPI_LV_DISPATCH 377.It Li ACPI_LV_EXEC 378.It Li ACPI_LV_NAMES 379.It Li ACPI_LV_OPREGION 380.It Li ACPI_LV_BFIELD 381.It Li ACPI_LV_TABLES 382.It Li ACPI_LV_VALUES 383.It Li ACPI_LV_OBJECTS 384.It Li ACPI_LV_RESOURCES 385.It Li ACPI_LV_USER_REQUESTS 386.It Li ACPI_LV_PACKAGE 387.It Li ACPI_LV_VERBOSITY1 388All the previous levels 389.It Li ACPI_LV_ALLOCATIONS 390.It Li ACPI_LV_FUNCTIONS 391.It Li ACPI_LV_OPTIMIZATIONS 392.It Li ACPI_LV_VERBOSITY2 393.It Li ACPI_LV_ALL 394.It Li ACPI_LV_MUTEX 395.It Li ACPI_LV_THREADS 396.It Li ACPI_LV_IO 397.It Li ACPI_LV_INTERRUPTS 398.It Li ACPI_LV_VERBOSITY3 399All the previous levels 400.It Li ACPI_LV_AML_DISASSEMBLE 401.It Li ACPI_LV_VERBOSE_INFO 402.It Li ACPI_LV_FULL_TABLES 403.It Li ACPI_LV_EVENTS 404.It Li ACPI_LV_VERBOSE 405All levels after 406.Qq Li ACPI_LV_VERBOSITY3 407.El 408.Pp 409Selection of the appropriate layer and level values is important 410to avoid massive amounts of debugging output. 411For example, the following configuration is a good way to gather initial 412information. 413It enables debug output for both ACPI-CA and the 414.Nm 415driver, printing basic information about errors, warnings, and progress. 416.Bd -literal -offset indent 417debug.acpi.layer="ACPI_ALL_COMPONENTS ACPI_ALL_DRIVERS" 418debug.acpi.level="ACPI_LV_ALL_EXCEPTIONS" 419.Ed 420.Pp 421Debugging output by the ACPI CA subsystem is prefixed with the 422module name in lowercase, followed by a source line number. 423Output from the 424.Dx Ns -local 425code follows the same format, but 426the module name is uppercased. 427.Sh OVERRIDING YOUR BIOS BYTECODE 428ACPI interprets bytecode named AML 429(ACPI Machine Language) 430provided by the BIOS vendor as a memory image at boot time. 431Sometimes, the AML code contains a bug that does not appear when parsed 432by the Microsoft implementation. 433.Dx 434provides a way to override it with your own AML code to work around 435or debug such problems. 436Note that all AML in your DSDT and any SSDT tables is overridden. 437.Pp 438In order to load your AML code, you must edit 439.Pa /boot/loader.conf 440and include the following lines. 441.Bd -literal -offset indent 442acpi_dsdt_load="YES" 443acpi_dsdt_name="/boot/acpi_dsdt.aml" # You may change this name. 444.Ed 445.Pp 446In order to prepare your AML code, you will need the 447.Xr acpidump 8 448and 449.Xr iasl 8 450utilities and some ACPI knowledge. 451.Sh COMPATIBILITY 452ACPI is only found and supported on i386/ia32, ia64, and amd64. 453.Sh SEE ALSO 454.Xr kenv 1 , 455.Xr acpi_thermal 4 , 456.Xr acpi_thinkpad 4 , 457.Xr acpi_toshiba 4 , 458.Xr loader.conf 5 , 459.Xr acpiconf 8 , 460.Xr acpidump 8 , 461.Xr config 8 , 462.Xr iasl 8 463.Rs 464.%A "Compaq Computer Corporation" 465.%A "Intel Corporation" 466.%A "Microsoft Corporation" 467.%A "Phoenix Technologies Ltd." 468.%A "Toshiba Corporation" 469.%D August 25, 2003 470.%T "Advanced Configuration and Power Interface Specification" 471.%O http://acpi.info/spec.htm 472.Re 473.Sh AUTHORS 474.An -nosplit 475The ACPI CA subsystem is developed and maintained by 476Intel Architecture Labs. 477.Pp 478The following people made notable contributions to the ACPI subsystem 479in 480.Dx : 481.An Michael Smith , 482.An Takanori Watanabe Aq takawata@jp.FreeBSD.org , 483.An Mitsuru IWASAKI Aq iwasaki@jp.FreeBSD.org , 484.An Munehiro Matsuda , 485.An Nate Lawson , 486the ACPI-jp mailing list at 487.Aq acpi-jp@jp.FreeBSD.org , 488and many other contributors. 489.Pp 490This manual page was written by 491.An Michael Smith Aq msmith@FreeBSD.org . 492.Sh BUGS 493If the 494.Nm 495driver is loaded as a module when it is already linked as part of the 496kernel, odd things may happen. 497