path: root/usr.sbin/acpidump/acpidump.8

.\"	$OpenBSD: acpidump.8,v 1.4 2007/02/22 19:29:51 jordan Exp $
.\"
.\" Copyright (c) 1999 Doug Rabson <dfr@FreeBSD.org>
.\" Copyright (c) 2000 Mitsuru IWASAKI <iwasaki@FreeBSD.org>
.\" Copyright (c) 2000 Yasuo YOKOYAMA <yokoyama@jp.FreeBSD.org>
.\" Copyright (c) 2000 Hiroki Sato <hrs@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD: src/usr.sbin/acpi/acpidump/acpidump.8,v 1.9 2001/09/05 19:21:25 dd Exp $
.\"
.Dd February 22, 2007
.Dt ACPIDUMP 8
.Os
.Sh NAME
.Nm acpidump
.Nd dump ACPI tables
.Sh SYNOPSIS
.Nm
.Op Fl h
.Nm
.Op Fl f Ar dsdt_file_for_input
.Nm
.Op Fl o Ar prefix_for_output
.Sh DESCRIPTION
The
.Nm
command analyzes ACPI tables in physical memory and dumps them to standard output.
In addition,
.Nm
can disassemble some contents of the tables in AML
(ACPI Machine Language)
and dump them in ASL
(ACPI Source Language).
.Pp
ACPI tables have an notably essential data block called DSDT
(Differentiated System Description Table),
that includes information used on the kernel side such as
detailed information about PnP hardware, procedures for controlling
power management support, and so on.
.Nm
can extract a DSDT data block from physical memory and store it into
a DSDT data file, and can also generate an output in ASL
from a given DSDT data file.
.Pp
When
.Nm
is invoked with no options, it will search ACPI tables from physical
memory via a special file
.Pa /dev/mem
and dump them.
First, it searches Root System Description Pointer,
that has a signature
.Qq RSD PTR\ \& ,
and then gets RSDT
(Root System Description Table),
which includes a list of pointers to physical memory addresses
for other tables.
RSDT itself and all other tables linked from RSDT are generically
called SDT
(System Description Table)
and their header has the common format which consists of items
such as Signature, Length, Revision, Checksum, OEMID, OEM Table ID,
OEM Revision, Creator ID, and Creator Revision.
.Nm
dumps the contents of these SDTs.
For further information about the formats of each table,
see chapter 5: ACPI Software Programming Model,
.Dq Advanced Configuration and Power Interface Specification Revision 1.0b
from Intel/Microsoft/Toshiba.
.Pp
There is always a pointer to a physical memory address in RSDT for FACP
(Fixed ACPI Description Table).
FACP defines static system information about power management support
(ACPI Hardware Register Implementation)
such as interrupt mode
(INT_MODEL),
SCI interrupt number, SMI command port
(SMI_CMD),
and the location of ACPI registers.
FACP also has a pointer to a physical memory address for DSDT,
which includes information used on the kernel side such as
PnP, power management support, and so on.
While the other tables are described in a fixed format,
DSDT consists of AML data which is compiled from sources
written in free formatted ASL, a description language for ACPI.
When
.Nm
outputs DSDT, it disassembles the AML data and
translates them into ASL.
.Sh OPTIONS
The following options are supported by
.Nm :
.Bl -tag -width indent
.It Fl f Ar dsdt_file_for_input
Interpret AML data in DSDT from a file specified in
.Ar dsdt_file_for_input
and dumps them in ASL to standard output.
.It Fl h
Display usage and exit.
.It Fl o Ar prefix_for_output
Store ACPI tables from physical memory into files specified by
.Ar prefix_for_output
in addition to behavior with no option.  The files generated will
be of the form <prefix>.<sig>.<id>.  The sig is the signature of
the ACPI Table, id is unique for each table.

The following are common table signatures (there may be others):
RSDP, FACP, DSDT, SSDT, HPET, MCFG, SPMI, APIC, SPCR, SRAT, XSDT
.El
.Sh FILES
.Bl -tag -width /dev/mem
.It Pa /dev/mem
.El
.Sh EXAMPLES
This is an example to get a dump of SDTs and a DSDT data file
simultaneously on a machine that supports ACPI BIOS:
.Pp
.Dl # acpidump -o foo \*(Gt foo.asl

This will generate foo.RSDP.x, foo.FACP.x, foo.DSDT.x, etc.
.Sh SEE ALSO
.\" .Xr acpi 4 ,
.Xr mem 4 ,
.\" .Xr acpiconf 8 ,
.\" Xr amldb 8
.Rs
.%T Advanced Configuration and Power Interface Specification
.%A Intel
.%A Microsoft
.%A Toshiba
.%R Revision 1.0b
.%O http://www.teleport.com/~acpi/
.Re
.Sh HISTORY
The
.Nm
command first appeared in
.Ox 3.8 .
.Sh AUTHORS
.An Doug Rabson Aq dfr@FreeBSD.org
.An Mitsuru IWASAKI Aq iwasaki@FreeBSD.org
.An Yasuo YOKOYAMA Aq yokoyama@jp.FreeBSD.org
.Pp
Some contributions made by:
.An Chitoshi Ohsawa Aq ohsawa@catv1.ccn-net.ne.jp ,
.An Takayasu IWANASHI Aq takayasu@wendy.a.perfect-liberty.or.jp ,
.An Yoshihiko SARUMARU Aq mistral@imasy.or.jp ,
.An Hiroki Sato Aq hrs@FreeBSD.org ,
.An Jordan Hargrave Aq jordan@openbsd.org
and
.An Michael Lucas Aq mwlucas@blackhelicopters.org .
.Sh BUGS
In the current implementation,
.Nm
doesn't dump any information of Firmware ACPI Control Structure
(FACS)
specified by a pointer in FACP.