xref: /dragonfly/usr.sbin/acpi/acpidump/acpidump.8 (revision 0bb9290e)
1.\" ACPI (ACPI Package)
2.\"
3.\" Copyright (c) 1999 Doug Rabson <dfr@FreeBSD.org>
4.\" Copyright (c) 2000 Mitsuru IWASAKI <iwasaki@FreeBSD.org>
5.\" Copyright (c) 2000 Yasuo YOKOYAMA <yokoyama@jp.FreeBSD.org>
6.\" Copyright (c) 2000 Hiroki Sato <hrs@FreeBSD.org>
7.\" All rights reserved.
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/acpidump/acpidump.8,v 1.16 2004/06/04 19:21:06 ru Exp $
31.\" $DragonFly: src/usr.sbin/acpi/acpidump/acpidump.8,v 1.4 2006/08/18 01:42:58 swildner Exp $
32.\"
33.Dd August 31, 2000
34.Dt ACPIDUMP 8
35.Os
36.Sh NAME
37.Nm acpidump
38.Nd dump ACPI tables and ASL
39.Sh SYNOPSIS
40.Nm
41.Op Fl d
42.Op Fl t
43.Op Fl h
44.Op Fl v
45.Op Fl f Ar dsdt_input
46.Op Fl o Ar dsdt_output
47.Sh DESCRIPTION
48The
49.Nm
50utility analyzes ACPI tables in physical memory and can dump them to a file.
51In addition,
52.Nm
53can call
54.Xr iasl 8
55to disassemble AML
56(ACPI Machine Language)
57found in these tables and dump them as ASL
58(ACPI Source Language)
59to stdout.
60.Pp
61ACPI tables have an essential data block (the DSDT,
62Differentiated System Description Table)
63that includes information used on the kernel side such as
64detailed information about PnP hardware, procedures for controlling
65power management support, and so on.
66The
67.Nm
68utility can extract the DSDT data block from physical memory and store it into
69a DSDT output file and optionally also disassemble it.
70.Pp
71When
72.Nm
73is invoked without the
74.Fl f
75option, it will read ACPI tables from physical memory via
76.Pa /dev/mem .
77First it searches for the RSDP
78(Root System Description Pointer),
79which has the signature
80.Qq RSD PTR\ \& ,
81and then gets the RSDT
82(Root System Description Table),
83which includes a list of pointers to physical memory addresses
84for other tables.
85The RSDT itself and all other tables linked from RSDT are generically
86called SDTs
87(System Description Tables)
88and their header has a common format which consists of items
89such as Signature, Length, Revision, Checksum, OEMID, OEM Table ID,
90OEM Revision, Creator ID and Creator Revision.
91When invoked with the
92.Fl t
93flag, the
94.Nm
95utility dumps contents of the following tables:
96.Pp
97.Bl -tag -offset indent -width 12345 -compact
98.It DSDT
99.It FADT
100.It HPET
101.It MADT
102.It RSD PTR
103.It RSDT
104.El
105.Pp
106The RSDT contains a pointer to the physical memory address of the FACP
107(Fixed ACPI Description Table).
108The FACP defines static system information about power management support
109(ACPI Hardware Register Implementation)
110such as interrupt mode (INT_MODEL),
111SCI interrupt number, SMI command port (SMI_CMD)
112and the location of ACPI registers.
113The FACP also has a pointer to a physical memory address for the DSDT.
114While the other tables are fixed format,
115the DSDT consists of free-formatted AML data.
116.Sh OPTIONS
117The following options are supported by
118.Nm :
119.Bl -tag -width indent
120.It Fl d
121Disassemble the DSDT into ASL using
122.Xr iasl 8
123and print the results to stdout.
124.It Fl t
125Dump the contents of the various fixed tables listed above.
126.It Fl h
127Displays usage and exit.
128.It Fl v
129Enable verbose messages.
130.It Fl f Ar dsdt_input
131Load the DSDT from the specified file instead of physical memory.
132Since only the DSDT is stored in the file, the
133.Fl t
134flag may not be used with this option.
135.It Fl o Ar dsdt_output
136Store the DSDT data block from physical memory into the specified file.
137.El
138.Sh FILES
139.Bl -tag -width /dev/mem
140.It Pa /dev/mem
141.El
142.Sh EXAMPLES
143This example dumps the DSDT from physical memory to foo.dsdt.
144It also prints the contents of various system tables and disassembles
145the AML contained in the DSDT to stdout, redirecting the output
146to foo.asl.
147.Bd -literal -offset indent
148# acpidump -t -d -o foo.dsdt > foo.asl
149.Ed
150.Pp
151This example reads a DSDT file and disassembles it to stdout.
152Verbose messages are enabled.
153.Bd -literal -offset indent
154# acpidump -v -d -f foo.dsdt
155.Ed
156.Sh SEE ALSO
157.Xr acpi 4 ,
158.Xr mem 4 ,
159.Xr acpiconf 8 ,
160.Xr acpidb 8 ,
161.Xr iasl 8
162.Sh HISTORY
163The
164.Nm
165utility first appeared in
166.Fx 5.0
167and was rewritten to use
168.Xr iasl 8
169for
170.Fx 5.2 .
171.Sh AUTHORS
172.An Doug Rabson Aq dfr@FreeBSD.org
173.An Mitsuru IWASAKI Aq iwasaki@FreeBSD.org
174.An Yasuo YOKOYAMA Aq yokoyama@jp.FreeBSD.org
175.Pp
176.An -nosplit
177Some contributions made by
178.An Chitoshi Ohsawa Aq ohsawa@catv1.ccn-net.ne.jp ,
179.An Takayasu IWANASHI Aq takayasu@wendy.a.perfect-liberty.or.jp ,
180.An Yoshihiko SARUMARU Aq mistral@imasy.or.jp ,
181.An Hiroki Sato Aq hrs@FreeBSD.org ,
182.An Michael Lucas Aq mwlucas@blackhelicopters.org
183and
184.An Michael Smith Aq msmith@FreeBSD.org .
185.Sh BUGS
186In the current implementation,
187.Nm
188does not dump the
189Secondary System Descriptor Table (SSDT),
190Embedded Controller Descriptor Table (ECDT),
191or BOOT structures.
192