| blob | 6862e17e7dbc0f05429211a208980789961a6b2a |
1 .\" $NetBSD: amldb.8,v 1.3 2008/02/26 04:50:02 lukem Exp $
2 .\" ACPI (ACPI Package)
3 .\"
4 .\" Copyright (c) 2000 Takanori Watanabe <takawata@FreeBSD.org>
5 .\" Copyright (c) 2000 Mitsuru IWASAKI <iwasaki@FreeBSD.org>
6 .\" Copyright (c) 2000 Yasuo YOKOYAMA <yokoyama@jp.FreeBSD.org>
7 .\" Copyright (c) 2000 Norihiro KUMAGAI <kumagai@home.com>
8 .\"
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
11 .\" are met:
12 .\" 1. Redistributions of source code must retain the above copyright
13 .\" notice, this list of conditions and the following disclaimer.
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\" notice, this list of conditions and the following disclaimer in the
16 .\" documentation and/or other materials provided with the distribution.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" SUCH DAMAGE.
29 .\"
30 .\" $FreeBSD: src/usr.sbin/acpi/amldb/amldb.8,v 1.10 2002/08/13 16:07:26 ru Exp $
31 .\"
32 .Dd August 31, 2000
33 .Dt AMLDB 8
34 .Os
35 .Sh NAME
36 .Nm amldb
37 .Nd executing and debugging AML interpreter
38 (with DSDT files)
39 .Sh SYNOPSIS
40 .Nm
41 .Op Fl dhst
42 .Ar dsdt_file ...
43 .Sh DESCRIPTION
44 The
45 .Nm
46 utility parses the DSDT
47 (Differentiated System Description Table)
48 files, which usually are acquired from ACPI BIOS, and executes
49 the sequence of ACPI Control Methods described in AML
50 (ACPI Machine Language)
51 with its AML interpreter.
52 The
53 .Nm
54 utility also has a simple ACPI virtual machine.
55 During execution of the
56 Control Methods each access to the region, such as
57 SystemMemory, SystemIO, PCI_Config, does not affect the real
58 hardware but only the virtual machine.
59 Because the sequence of virtual accesses is maintained in user space,
60 AML interpreter developers need not worry about any effect on hardware
61 when they analyze DSDT data files.
62 They can develop and debug the
63 interpreter, even if the machine has no ACPI BIOS.
64 .Pp
65 The developer will need to acquire a DSDT data file from any machine
66 with ACPI BIOS through
67 .Xr acpidump 8 .
68 The DSDT is a table, a part of the whole ACPI memory table
69 located in somewhere in the BIOS area
70 .Pq Li 0xa0000 \- 0x100000 .
71 It includes such information as the detailed hardware information
72 for PnP, and the set of procedures which perform power management from
73 the OS.
74 The information is stored in AML format.
75 .Pp
76 The AML interpreter can execute any of the Control Methods specified
77 by users.
78 When executed, it interprets the byte sequence in the
79 Control Method of DSDT, and disassembles the opcodes that it
80 recognizes into ASL
81 (ACPI Source Language)
82 format to be displayed.
83 .Pp
84 If it encounters one of more accesses to the region such as
85 SystemMemory in executing the Control Methods, its ACPI Virtual
86 Machine simulates the input/output operations to the resources in the
87 region.
88 In writing to a certain region, the ACPI Virtual Machine
89 prepares a piece of memory corresponding to its address,
90 if necessary, and holds the specified value in the memory as the
91 .Em region contents .
92 In reading from a certain region, it fetches the value in the memory
93 .Pq Em region contents ,
94 prompts with it as the following:
95 .Bd -literal -offset indent
96 DEBUG[read(0, 0x100b6813)\*[Am]mask:0x1](default: 0x1 / 1) \*[Gt]\*[Gt]
97 .Ed
98 .Pp
99 for users to have the opportunity to modify it, and hands it to
100 the AML interpreter.
101 In case that there is no corresponding region
102 in the AML Virtual Machine, the value zero is handed.
103 .Pp
104 The interpreter continues to maintain all of the
105 .Em region contents
106 until
107 .Nm
108 terminates.
109 You can specify their initial values with the file
110 .Pa region.ini
111 in the current directory.
112 If it is executed with
113 .Fl d
114 option, it dumps the final status of all of its
115 .Em region contents
116 to the file
117 .Pa region.dmp
118 when it terminates.
119 Each line of there files consists of the following
120 fields, separated by tabs; region type, address, and value.
121 Region types are specified as follows;
122 .Bl -tag -width "Value" -compact -offset indent
123 .It Sy Value
124 .Sy Region type
125 .It 0
126 SystemMemory
127 .It 1
128 SystemIO
129 .It 2
130 PCI_Config
131 .It 3
132 EmbeddedControl
133 .It 4
134 SMBus
135 .El
136 .Pp
137 Interactive commands are described below:
138 .Bl -tag -width indent
139 .It Cm s
140 .Em Single step :
141 Performs single-step execution of the current Control Method.
142 If the next instruction is an invocation of another Control Method,
143 the step execution will continue in the following Control Method.
144 .It Cm n
145 .Em Step program :
146 Performs single-step execution of the current Control Method.
147 Even if the next instruction is an invocation of another Control
148 Method, the step execution will not continue.
149 .It Cm c
150 .Em Continue program being debugged :
151 Resumes execution of the AML interpreter.
152 Because the current
153 .Nm
154 has no way of breakpoint, this command might not so much useful.
155 .It Cm q
156 .Em Quit method execution :
157 Terminates execution of the current Control Method.
158 If
159 .Nm
160 is not in execution, this command causes to input the next
161 DSDT data file.
162 If there are no next DSDT data files, it terminates
163 .Nm
164 itself.
165 .It Cm t
166 .Em Show local name space tree and variables :
167 Displays the structure of the ACPI namespace tree.
168 If
169 .Nm
170 is in execution, this command displays the structure that relates
171 to the objects, arguments, and local variables below the scope of the
172 current Control Method.
173 .It Cm i
174 .Em Toggle region input prompt :
175 Switches whether the prompt for modifying the value read from the
176 .Em region contents
177 be showed or not.
178 Default is On.
179 .It Cm o
180 .Em Toggle region output prompt :
181 Switches whether the prompt for modifying the value to be written
182 to the region contents will be shown or not.
183 The default is Off.
184 .It Cm m
185 .Em Show memory management statistics :
186 Displays the current statistics of the memory management system
187 on the AML interpreter.
188 .It Cm r Ar method
189 .Em Run specified method :
190 Executes the specified Control Method.
191 If it requires one or
192 more arguments, a prompt such as the following appears;
193 .Bd -literal
194 Method: Arg 1 From 0x280626ce To 0x28062775
195 Enter argument values (ex. number 1 / string foo). 'q' to quit.
196 Arg0 ?
197 .Ed
198 .Pp
199 For each argument, a pair of type string and value delimited by
200 one or more spaces can be entered.
201 Now only
202 .Ic number
203 and
204 .Ic string
205 can be specified as the type string.
206 In the current implementation, only the first character of the type
207 string, such as
208 .Ic n
209 or
210 .Ic s ,
211 is identified.
212 For example, we can enter as follows:
213 .Bd -literal
214 Arg0 ? n 1
215 .Ed
216 .Pp
217 .It Cm f Ar string
218 .Em Find named objects from namespace :
219 Lists the named objects that includes the specified string as the
220 terminate elements searching from the ACPI namespace.
221 For the namespace is expressed as the sequence of four-character
222 elements, appropriate number of additional underscore
223 .Pq Ql _
224 characters are necessary for specifying objects which have less than four
225 character string.
226 Unless additional underscores specified, matching
227 occurs as the beginning of word with the specified number of characters.
228 .It Cm h
229 .Em Show help messsage :
230 Displays the command summary of
231 .Nm .
232 .El
233 .Sh OPTIONS
234 Exactly one of the following options must be specified.
235 Otherwise,
236 .Nm
237 shows its usage and terminates.
238 .Bl -tag -width indent
239 .It Fl d
240 Dump the final status of all of the
241 .Em region contents
242 in the ACPI Virtual Machine to the file
243 .Pa region.dmp .
244 .It Fl h
245 Terminate with the usage of this command.
246 .It Fl s
247 Display the statistics of the memory management system on the
248 AML interpreter when
249 .Nm
250 terminates.
251 .It Fl t
252 Display the tree structure of ACPI namespace after the
253 DSDT data file is read.
254 .El
255 .Sh FILES
256 .Bl -tag -width region.ini -compact
257 .It Pa region.ini
258 .It Pa region.dmp
259 .El
260 .Sh EXAMPLES
261 The following is an example including, invoking the
262 .Nm ,
263 searching
264 .Li _PRS
265 (Possible Resource Settings)
266 objects, and executing the
267 .Li _PTS
268 (Prepare To Sleep)
269 Control Method by the AML interpreter.
270 .Bd -literal -offset indent
271 % amldb p2b.dsdt.dat
272 Loading p2b.dsdt.dat...done
273 AML\*[Gt]f _PRS
274 \\_SB_.PCI0.ISA_.PS2M._PRS.
275 \\_SB_.PCI0.ISA_.IRDA._PRS.
276 \\_SB_.PCI0.ISA_.UAR2._PRS.
277 \\_SB_.PCI0.ISA_.UAR1._PRS.
278 \\_SB_.PCI0.ISA_.ECP_._PRS.
279 \\_SB_.PCI0.ISA_.LPT_._PRS.
280 \\_SB_.PCI0.ISA_.FDC0._PRS.
281 \\_SB_.LNKD._PRS.
282 \\_SB_.LNKC._PRS.
283 \\_SB_.LNKB._PRS.
284 \\_SB_.LNKA._PRS.
285 AML\*[Gt]r _PTS
286 Method: Arg 1 From 0x2805f0a3 To 0x2805f0db
287 Enter argument values (ex. number 1 / string foo). 'q' to quit.
288 Arg0 ? n 5
289 ==== Running _PTS. ====
290 AML\*[Gt]s
291 [\\_PTS. START]
292 If(LNot(LEqual(Arg0, 0x5)))
293 AML\*[Gt]
294 If(LEqual(Arg0, 0x1))
295 AML\*[Gt]
296 If(LEqual(Arg0, 0x2))
297 AML\*[Gt]
298 Store(One, TO12)
299 [aml_region_write(1, 1, 0x1, 0xe42c, 0x18, 0x1)]
300 amldb: region.ini: No such file or directory
301 [1:0x00@0xe42f]-\*[Gt][1:0x01@0xe42f]
302 [write(1, 0x1, 0xe42f)]
303 [aml_region_read(1, 1, 0xe42c, 0x18, 0x1)]
304 [1:0x01@0xe42f]
305 DEBUG[read(1, 0xe42f)\*[Am]mask:0x1](default: 0x1 / 1) \*[Gt]\*[Gt]
306 [read(1, 0xe42f)-\*[Gt]0x1]
307 AML\*[Gt]
308 Or(Arg0, 0xf0, Local2)[Copy number 0xf5]
309 AML\*[Gt]t
310 _PTS Method: Arg 1 From 0x2805f0a3 To 0x2805f0db
311 Arg0 Num:0x5
312 Local2 Num:0xf5
313 AML\*[Gt]s
314 Store(Local2, DBG1)
315 [aml_region_write(1, 1, 0xf5, 0x80, 0x0, 0x8)]
316 [1:0x00@0x80]-\*[Gt][1:0xf5@0x80]
317 [write(1, 0xf5, 0x80)]
318 [aml_region_read(1, 1, 0x80, 0x0, 0x8)]
319 [1:0xf5@0x80]
320 DEBUG[read(1, 0x80)\*[Am]mask:0xf5](default: 0xf5 / 245) \*[Gt]\*[Gt]
321 [read(1, 0x80)-\*[Gt]0xf5]
322 AML\*[Gt]
323 [\\_PTS. END]
324 _PTS Method: Arg 1 From 0x2805f0a3 To 0x2805f0db
325 NO object
326 ==== _PTS finished. ====
327 AML\*[Gt]q
328 %
329 .Ed
330 .Sh SEE ALSO
331 .Xr acpi 4 ,
332 .\" .Xr acpiconf 8 ,
333 .Xr acpidump 8
334 .Sh HISTORY
335 The
336 .Nm
337 utility appeared in
338 .Fx 5.0 .
339 .Sh AUTHORS
340 .An Takanori Watanabe Aq takawata@FreeBSD.org
341 .An Mitsuru IWASAKI Aq iwasaki@FreeBSD.org
342 .An Yasuo YOKOYAMA Aq yokoyama@jp.FreeBSD.org
343 .Pp
344 Some contributions made by
345 .An Chitoshi Ohsawa Aq ohsawa@catv1.ccn-net.ne.jp ,
346 .An Takayasu IWANASHI Aq takayasu@wendy.a.perfect-liberty.or.jp ,
347 .An Norihiro KUMAGAI Aq kumagai@home.com ,
348 .An Kenneth Ingham Aq ingham@I-pi.com ,
349 and
350 .An Michael Lucas Aq mwlucas@blackhelicopters.org .
351 .Sh BUGS
352 The ACPI virtual machine does not completely simulate the behavior
353 of a machine with an ACPI BIOS.
354 In the current implementation, the
355 ACPI virtual machine only reads or writes the stored values by
356 emulating access to regions such as SystemMemory.
357 .Pp
358 Because the AML interpreter interprets and disassembles
359 simultaneously, it is impossible to implement such features as setting
360 breakpoints with the specified line number in ASL.
361 Setting breakpoints
362 at certain Control Methods, which is not very difficult, has not
363 yet implemented because nobody has ever needed it.