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