No empty .Rs/.Re
[netbsd-mini2440.git] / share / man / man4 / acpi.4
blobc6fdf04c23800db6f639f22e728a1eef87b8d9ac
1 .\" $NetBSD: acpi.4,v 1.29 2008/09/21 11:12:36 wiz Exp $
2 .\"
3 .\" Copyright (c) 2002, 2004 The NetBSD Foundation, Inc.
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\"
15 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
16 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
19 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25 .\" POSSIBILITY OF SUCH DAMAGE.
26 .\"
27 .Dd May 16, 2009
28 .Dt ACPI 4
29 .Os
30 .Sh NAME
31 .Nm acpi
32 .Nd Advanced Configuration and Power Interface
33 .Sh SYNOPSIS
34 .Cd "acpi0     at mainbus0"
35 .Cd "acpiacad* at acpi?"
36 .Cd "acpibat*  at acpi?"
37 .Cd "acpibut*  at acpi?"
38 .Cd "acpiec*   at acpi?"
39 .Cd "acpilid*  at acpi?"
40 .Cd "acpitz*   at acpi?"
41 .Cd "attimer*  at acpi?"
42 .Cd "aiboost*  at acpi?"
43 .Cd "com*      at acpi?"
44 .Cd "fdc*      at acpi?"
45 .Cd "hpet*     at acpi?"
46 .Cd "joy*      at acpi?"
47 .Cd "lpt*      at acpi?"
48 .Cd "mpu*      at acpi?"
49 .Cd "npx*      at acpi?"
50 .Cd "pckbc*    at acpi?"
51 .Cd "pcppi*    at acpi?"
52 .Cd "sony*     at acpi?"
53 .Cd "spic*     at acpi?"
54 .Cd "ug*       at acpi?"
55 .Cd "vald*     at acpi?"
56 .Cd "wss*      at acpi?"
57 .Cd "ym*       at acpi?"
58 .Pp
59 .Cd "options   ACPI_DEBUG"
60 .Cd "options   ACPIVERBOSE"
61 .Cd "options   ACPI_ACTIVATE_DEV"
62 .Cd "options   ACPICA_PEDANTIC"
63 .Cd "options   ACPI_DSDT_OVERRIDE"
64 .Sh DESCRIPTION
65 .Nx
66 provides machine-independent bus support for
67 Advanced Configuration and Power Interface
68 .Pq Tn ACPI
69 devices and includes several
70 .Tn ACPI
71 device drivers.
72 .Pp
73 The
74 .Nx
75 implementation of
76 .Tn ACPI
77 integrates Intel's ACPI Component Architecture
78 .Pq Tn ACPI-CA
79 for the OS-independent part.
80 The
81 .Tn ACPI-CA
82 provides OS-neutral
83 .Tn ACPI
84 functionalities such as
85 .Tn ACPI
86 .Tn BIOS
87 table support,
89 .Tn ACPI
90 event framework and an ACPI Machine Language
91 .Pq Tn AML
92 interpreter.
93 .Pp
94 Options:
95 .Bl -tag -width ACPI_DSDT_FILE__filename_XX -offset 3n
96 .It Dv ACPI_DEBUG
97 Enable
98 .Tn ACPI
99 debugging message outputs.
100 .It Dv ACPI_ACTIVATE_DEV
101 Determine if the
102 .Tn ACPI
103 driver should attempt to activate inactive devices.
104 The default is off.
105 .It Dv ACPICA_PEDANTIC
106 Force strict conformance to the
107 .Tn ACPI
108 specification in the
109 .Tn ACPI-CA .
110 Do not enable this option unless you are debugging.
111 .It Dv ACPI_DSDT_OVERRIDE
112 Force a given Differentiated System Description Table
113 .Pq Tn DSDT
114 instead of the BIOS-supplied version.
116 .Dv ACPI_DSDT_FILE
117 to specify a
118 .Tn DSDT .
119 .It Dv ACPI_DSDT_FILE="filename"
121 .Dv ACPI_DSDT_FILE
122 is not specified, default to
123 .Dq dsdt.hex
124 in the build directory.
126 .Ss sysctl support
127 These
128 .Xr sysctl 8
129 variables are directly relevant for
130 .Nm :
131 .Bl -inset -width hw.acpi.supported_states
132 .It Li hw.acpi.root
133 is the
134 .Tn ACPI
135 root pointer.
136 .It Li hw.acpi.supported_states
137 is a list of the supported
138 .Tn ACPI
139 states (see
140 .Xr sysctl 7 ) .
141 .It Li machdep.acpi_vbios_reset
142 defines the handling of the graphics card.
143 The supported values are:
144 .Bl -tag -width '2' -offset indent
145 .It 0
146 No attempt to reset the
147 .Tn VGA
148 controller will be made.
149 .It 1
150 Call the
151 .Tn VGA
152 .Tn BIOS
153 when still in real mode.
154 This can result in direct reboots.
155 In that case, use
156 .Sq 2
158 .Ic vbetool post
159 from the
160 .Pa pkgsrc/sysutils/vbetool
161 package.
162 .It 2
163 Call the
164 .Tn VGA
165 .Tn BIOS
166 using the in-kernel x86 emulator.
169 .Sh SUPPORTED DEVICES
171 .Tn ACPI
172 supports several machine-dependent and machine-independent devices:
173 .Ss machine-independent devices
174 .Bl -tag -width pcdisplay -offset indent
175 .It acpiacad
176 .Tn ACPI
177 AC adapters.
178 .It acpibat
179 .Tn ACPI
180 Control Method Batteries.
181 .It acpibut
182 .Tn ACPI
183 power and sleep buttons.
184 .It acpiec
185 .Tn ACPI
186 Embedded Controllers.
187 .It acpilid
188 .Tn ACPI
189 lid switches.
190 .It acpitz
191 .Tn ACPI
192 thermal zones.
193 .It attimer
194 AT Timer.
195 .It aiboost
196 ASUS AI Booster Hardware monitor.
197 .It com
198 NS8250-, NS16450-, and NS16550-based serial ports.
199 .It fdc
200 Floppy disk controllers.
201 .It hpet
202 High Precision Event Timer.
203 .It joy
204 Joystick/Game port interface.
205 .It lpt
206 Standard ISA parallel port interface.
207 .It mpu
208 Roland MPU-401 (compatible) MIDI UART.
209 .It pcppi
210 AT-style speaker sound.
211 .It ug
212 Abit uGuru Hardware monitor.
213 .It wss
214 Windows Sound System-compatible sound cards based on the AD1848 and compatible chips.
215 .It ym
216 Yamaha OPL3-SA2 and OPL3-SA3 audio device driver.
218 .Ss i386-dependent devices
219 .Bl -tag -width pcdisplay -offset indent
220 .It npx
221 i386 numeric processing extension coprocessor.
222 .It pckbc
223 PC keyboard controllers.
224 .It sony
225 Sony Miscellaneous Controller
226 .It spic
227 Sony programmable I/O controller.
228 .It vald
229 Toshiba Libretto device.
231 .Sh SEE ALSO
232 .Xr acpiacad 4 ,
233 .Xr acpibat 4 ,
234 .Xr acpibut 4 ,
235 .Xr acpiec 4 ,
236 .Xr acpilid 4 ,
237 .Xr acpitz 4 ,
238 .Xr aiboost 4 ,
239 .Xr apm 4 ,
240 .Xr attimer 4 ,
241 .Xr com 4 ,
242 .Xr fdc 4 ,
243 .Xr joy 4 ,
244 .Xr lpt 4 ,
245 .Xr mpu 4 ,
246 .Xr npx 4 ,
247 .Xr pci 4 ,
248 .Xr pckbc 4 ,
249 .Xr pcppi 4 ,
250 .Xr sony 4 ,
251 .Xr spic 4 ,
252 .Xr ug 4 ,
253 .Xr vald 4 ,
254 .Xr wss 4 ,
255 .Xr ym 4 ,
256 .Xr acpidump 8 ,
257 .Xr amldb 8
259 .%T ACPI specification
260 .%O http://www.acpi.info/
263 .%T Intel ACPI CA (Component Architecture)
264 .%O http://developer.intel.com/technology/iapc/acpi/
266 .Sh HISTORY
269 driver
270 appeared in
271 .Nx 1.6 .
272 .Sh BUGS
273 Most of the
274 .Tn ACPI
275 power management functionalities are not implemented.