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