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 July 10, 2018 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 DMAR 101.It DSDT 102.It ECDT 103.It FACS 104.It FADT 105.It HPET 106.It LPIT 107.It MADT 108.It MCFG 109.It NFIT 110.It RSD PTR 111.It RSDT 112.It WDDT 113.El 114.Pp 115The RSDT contains a pointer to the physical memory address of the FACP 116(Fixed ACPI Description Table). 117The FACP defines static system information about power management support 118(ACPI Hardware Register Implementation) 119such as interrupt mode (INT_MODEL), 120SCI interrupt number, SMI command port (SMI_CMD) 121and the location of ACPI registers. 122The FACP also has a pointer to a physical memory address for the DSDT. 123While the other tables are fixed format, 124the DSDT consists of free-formatted AML data. 125.Sh OPTIONS 126The following options are supported by 127.Nm : 128.Bl -tag -width indent 129.It Fl d 130Disassemble the DSDT into ASL using 131.Xr iasl 8 132and print the results to stdout. 133.It Fl t 134Dump the contents of the various fixed tables listed above. 135.It Fl h 136Displays usage and exit. 137.It Fl v 138Enable verbose messages. 139.It Fl f Ar dsdt_input 140Load the DSDT from the specified file instead of physical memory. 141Since only the DSDT is stored in the file, the 142.Fl t 143flag may not be used with this option. 144.It Fl o Ar dsdt_output 145Store the DSDT data block from physical memory into the specified file. 146.El 147.Sh FILES 148.Bl -tag -width /dev/mem 149.It Pa /dev/mem 150.El 151.Sh EXAMPLES 152If a developer requests a copy of your ASL, please use the following 153command to dump all tables and compress the result. 154.Bd -literal -offset indent 155# acpidump -dt | gzip -c9 > my_computer.asl.gz 156.Ed 157.Pp 158This example dumps the DSDT from physical memory to foo.dsdt. 159It also prints the contents of various system tables and disassembles 160the AML contained in the DSDT to stdout, redirecting the output 161to foo.asl. 162.Bd -literal -offset indent 163# acpidump -t -d -o foo.dsdt > foo.asl 164.Ed 165.Pp 166This example reads a DSDT file and disassembles it to stdout. 167Verbose messages are enabled. 168.Bd -literal -offset indent 169# acpidump -v -d -f foo.dsdt 170.Ed 171.Sh SEE ALSO 172.Xr acpi 4 , 173.Xr mem 4 , 174.Xr acpiconf 8 , 175.Xr acpidb 8 , 176.Xr iasl 8 177.Sh HISTORY 178The 179.Nm 180utility first appeared in 181.Fx 5.0 182and was rewritten to use 183.Xr iasl 8 184for 185.Fx 5.2 . 186.Sh AUTHORS 187.An Doug Rabson Aq Mt dfr@FreeBSD.org 188.An Mitsuru IWASAKI Aq Mt iwasaki@FreeBSD.org 189.An Yasuo YOKOYAMA Aq Mt yokoyama@jp.FreeBSD.org 190.An Nate Lawson Aq Mt njl@FreeBSD.org 191.Pp 192.An -nosplit 193Some contributions made by 194.An Chitoshi Ohsawa Aq Mt ohsawa@catv1.ccn-net.ne.jp , 195.An Takayasu IWANASHI Aq Mt takayasu@wendy.a.perfect-liberty.or.jp , 196.An Yoshihiko SARUMARU Aq Mt mistral@imasy.or.jp , 197.An Hiroki Sato Aq Mt hrs@FreeBSD.org , 198.An Michael Lucas Aq Mt mwlucas@blackhelicopters.org 199and 200.An Michael Smith Aq Mt msmith@FreeBSD.org . 201.Sh BUGS 202The current implementation does not dump the BOOT structure or 203other miscellaneous tables. 204