xref: /freebsd/usr.sbin/acpi/acpidb/acpidb.8 (revision 9336e0699bda8a301cd2bfa37106b6ec5e32012e)
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.\" $FreeBSD$
29.\"
30.Dd August 7, 2003
31.Dt ACPIDB 8
32.Os
33.Sh NAME
34.Nm acpidb
35.Nd ACPI DSDT debugger
36.Sh SYNOPSIS
37.Nm
38.Ar input-file
39.Sh DESCRIPTION
40The
41.Nm
42utility is a debugger for the ACPI DSDT.
43It can parse and execute various
44AML methods and display the result.
45.Sh COMMANDS
46.Ss General-Purpose Commands
47.Bl -tag -width indent
48.It Ic Allocations
49Display list of current memory allocations
50.It Ic Dump Ar Address | Namepath Op Cm Byte | Word | Dword | Qword
51Display ACPI objects or memory
52.It Ic EnableAcpi
53Enable ACPI (hardware) mode
54.It Ic Help
55Show various help screens
56.It Ic History
57Display command history buffer
58.It Ic Level Ar DebugLevel Op Cm console
59Get/Set debug level for file or console
60.It Ic Locks
61Current status of internal mutexes
62.It Ic Quit No or Ic Exit
63Exit the debugger
64.It Ic Stats Op Cm Allocations | Memory | Misc | Objects | Tables
65Display namespace and memory statistics
66.It Ic Tables
67Display info about loaded ACPI tables
68.It Ic Unload Ar TableSig Op Ar Instance
69Unload an ACPI table
70.It Ic !\& Ar CommandNumber
71Execute command from history buffer
72.It Ic !!
73Execute last command again
74.El
75.Ss Namespace Access Commands
76.Bl -tag -width indent
77.It Ic Event Cm F | G Ar Value
78Generate AcpiEvent (Fixed/GPE)
79.It Ic Find Ar Name
80Find ACPI name(s) with wildcards
81.Ql ( ?\&
82is wildcard)
83.It Ic Method
84Display list of loaded control methods
85.It Ic Namespace Oo Ar Addr | Path Oc Op Ar Depth
86Display loaded namespace tree/subtree
87.It Ic Notify Ar NamePath Value
88Send a notification
89.It Ic Objects Ar ObjectType
90Display all objects of the given type
91.It Ic Owner Ar OwnerId Op Ar Depth
92Display loaded namespace by object owner
93.It Ic Prefix Op Ar NamePath
94Set or Get current execution prefix
95.It Ic References Ar Addr
96Find all references to object at addr
97.It Ic Resources
98Get and display resources
99.It Ic Terminate
100Delete namespace and all internal objects
101.It Ic Thread Ar Threads Loops NamePath
102Spawn threads to execute method(s)
103.El
104.Ss Control Method Execution Commands
105.Bl -tag -width indent
106.It Ic Arguments
107.Pq Ic Args
108Display method arguments
109.It Ic Breakpoint Ar AmlOffset
110Set an AML execution breakpoint
111.It Ic Call
112Run to next control method invocation
113.It Ic Debug Ar Namepath Op Ar Arguments
114Single Step a control method
115.It Ic Execute Ar Namepath Op Arguments
116Execute control method
117.It Ic Go
118Allow method to run to completion
119.It Ic Information
120Display info about the current method
121.It Ic Into
122Step into (not over) a method call
123.It Ic List Op OpcodeCount
124Display method ASL statements
125.It Ic Locals
126Display method local variables
127.It Ic Results
128Display method result stack
129.It Ic Set Cm A | L Ar # Value
130Set method data (Arguments/Locals)
131.It Ic Stop
132Terminate control method
133.It Ic Tree
134Display control method calling tree
135.It Ic <Enter>
136Single step next AML opcode (over calls)
137.El
138.Ss File I/O Commands
139.Bl -tag -width indent
140.It Ic Close
141Close debug output file
142.It Ic Open Ar Filename
143Open a file for debug output
144.It Ic Load Ar Filename
145Load ACPI table from a file
146.El
147.Sh SEE ALSO
148.Xr acpi 4 ,
149.Xr acpidump 8 ,
150.Xr iasl 8
151.Sh HISTORY
152The
153.Nm
154utility first appeared in the
155.Nm acpicatools
156port.
157It was imported for
158.Fx 5.2 .
159.Sh AUTHORS
160.An -nosplit
161The
162.Nm
163utility was written by
164.An Mitsuru Iwasaki Aq iwasaki@FreeBSD.org
165and uses Intel ACPI-CA for the backend.
166This manual page was written by
167.An Nate Lawson .
168