xref: /freebsd/usr.sbin/acpi/acpidb/acpidb.8 (revision 2008043f386721d58158e37e0d7e50df8095942d)
1.\"-
2.\" Copyright (c) 2003 Nate Lawson
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.\"    in this position and unchanged.
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.\" 3. The name of the author may not be used to endorse or promote products
15.\"    derived from this software without specific prior written permission.
16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27.\"
28.Dd August 7, 2003
29.Dt ACPIDB 8
30.Os
31.Sh NAME
32.Nm acpidb
33.Nd ACPI DSDT debugger
34.Sh SYNOPSIS
35.Nm
36.Ar input-file
37.Sh DESCRIPTION
38The
39.Nm
40utility is a debugger for the ACPI DSDT.
41It can parse and execute various
42AML methods and display the result.
43.Sh COMMANDS
44.Ss General-Purpose Commands
45.Bl -tag -width indent
46.It Ic Allocations
47Display list of current memory allocations
48.It Ic Dump Ar Address | Namepath Op Cm Byte | Word | Dword | Qword
49Display ACPI objects or memory
50.It Ic EnableAcpi
51Enable ACPI (hardware) mode
52.It Ic Help
53Show various help screens
54.It Ic History
55Display command history buffer
56.It Ic Level Ar DebugLevel Op Cm console
57Get/Set debug level for file or console
58.It Ic Locks
59Current status of internal mutexes
60.It Ic Quit No or Ic Exit
61Exit the debugger
62.It Ic Stats Op Cm Allocations | Memory | Misc | Objects | Tables
63Display namespace and memory statistics
64.It Ic Tables
65Display info about loaded ACPI tables
66.It Ic Unload Ar TableSig Op Ar Instance
67Unload an ACPI table
68.It Ic !\& Ar CommandNumber
69Execute command from history buffer
70.It Ic !!
71Execute last command again
72.El
73.Ss Namespace Access Commands
74.Bl -tag -width indent
75.It Ic Event Cm F | G Ar Value
76Generate AcpiEvent (Fixed/GPE)
77.It Ic Find Ar Name
78Find ACPI name(s) with wildcards
79.Ql ( ?\&
80is wildcard)
81.It Ic Method
82Display list of loaded control methods
83.It Ic Namespace Oo Ar Addr | Path Oc Op Ar Depth
84Display loaded namespace tree/subtree
85.It Ic Notify Ar NamePath Value
86Send a notification
87.It Ic Objects Ar ObjectType
88Display all objects of the given type
89.It Ic Owner Ar OwnerId Op Ar Depth
90Display loaded namespace by object owner
91.It Ic Prefix Op Ar NamePath
92Set or Get current execution prefix
93.It Ic References Ar Addr
94Find all references to object at addr
95.It Ic Resources
96Get and display resources
97.It Ic Terminate
98Delete namespace and all internal objects
99.It Ic Thread Ar Threads Loops NamePath
100Spawn threads to execute method(s)
101.El
102.Ss Control Method Execution Commands
103.Bl -tag -width indent
104.It Ic Arguments
105.Pq Ic Args
106Display method arguments
107.It Ic Breakpoint Ar AmlOffset
108Set an AML execution breakpoint
109.It Ic Call
110Run to next control method invocation
111.It Ic Debug Ar Namepath Op Ar Arguments
112Single Step a control method
113.It Ic Execute Ar Namepath Op Arguments
114Execute control method
115.It Ic Go
116Allow method to run to completion
117.It Ic Information
118Display info about the current method
119.It Ic Into
120Step into (not over) a method call
121.It Ic List Op OpcodeCount
122Display method ASL statements
123.It Ic Locals
124Display method local variables
125.It Ic Results
126Display method result stack
127.It Ic Set Cm A | L Ar # Value
128Set method data (Arguments/Locals)
129.It Ic Stop
130Terminate control method
131.It Ic Tree
132Display control method calling tree
133.It Ic <Enter>
134Single step next AML opcode (over calls)
135.El
136.Ss File I/O Commands
137.Bl -tag -width indent
138.It Ic Close
139Close debug output file
140.It Ic Open Ar Filename
141Open a file for debug output
142.It Ic Load Ar Filename
143Load ACPI table from a file
144.El
145.Sh SEE ALSO
146.Xr acpi 4 ,
147.Xr acpidump 8 ,
148.Xr iasl 8
149.Sh HISTORY
150The
151.Nm
152utility first appeared in the
153.Nm acpicatools
154port.
155It was imported for
156.Fx 5.2 .
157.Sh AUTHORS
158.An -nosplit
159The
160.Nm
161utility was written by
162.An Mitsuru Iwasaki Aq Mt iwasaki@FreeBSD.org
163and uses Intel ACPI-CA for the backend.
164This manual page was written by
165.An Nate Lawson .
166