usr.sbin/acpi/acpidump/acpidump.8

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