xref: /illumos-gate/usr/src/man/man8/acpixtract.8 (revision bbf21555)
17b1019a6SJerry Jelinek.\" This file and its contents are supplied under the terms of the
27b1019a6SJerry Jelinek.\" Common Development and Distribution License ("CDDL"), version 1.0.
37b1019a6SJerry Jelinek.\" You may only use this file in accordance with the terms of version
47b1019a6SJerry Jelinek.\" 1.0 of the CDDL.
57b1019a6SJerry Jelinek.\"
67b1019a6SJerry Jelinek.\" A full copy of the text of the CDDL should have accompanied this
77b1019a6SJerry Jelinek.\" source.  A copy of the CDDL is also available via the Internet at
87b1019a6SJerry Jelinek.\" http://www.illumos.org/license/CDDL.
97b1019a6SJerry Jelinek.\"
107b1019a6SJerry Jelinek.\"
110e974e5fSRobert Mustacchi.\" Copyright (c) 2017, Joyent, Inc.
127b1019a6SJerry Jelinek.\"
130e974e5fSRobert Mustacchi.Dd May 12, 2017
14*bbf21555SRichard Lowe.Dt ACPIXTRACT 8
157b1019a6SJerry Jelinek.Os
167b1019a6SJerry Jelinek.Sh NAME
177b1019a6SJerry Jelinek.Nm acpixtract
187b1019a6SJerry Jelinek.Nd extract binary ACPI tables from a dump file
197b1019a6SJerry Jelinek.Sh SYNOPSIS
207b1019a6SJerry Jelinek.Nm
217b1019a6SJerry Jelinek.Op Fl ahlmv
227b1019a6SJerry Jelinek.Op Fl s Ar signature
237b1019a6SJerry Jelinek.Ar file
247b1019a6SJerry Jelinek.Sh DESCRIPTION
257b1019a6SJerry JelinekThe
267b1019a6SJerry Jelinek.Nm
277b1019a6SJerry Jelinekutility extracts the binary data from a dump of the system's Advanced
2872d3dbb9SYuri PankovConfiguration and Power Interface (ACPI) tables.
2972d3dbb9SYuri PankovThe dump is usually obtained via the
30*bbf21555SRichard Lowe.Xr acpidump 8
3172d3dbb9SYuri Pankovcommand.
3272d3dbb9SYuri PankovThe resulting binary file(s) are represented in the ACPI
337b1019a6SJerry Jelinek.Sy ASL
3472d3dbb9SYuri Pankovassembly language.
3572d3dbb9SYuri PankovFor each table extracted, a corresponding
367b1019a6SJerry Jelinek.Em table.dat
377b1019a6SJerry Jelinekfile will be created.
387b1019a6SJerry Jelinek.Sh OPTIONS
397b1019a6SJerry JelinekThe following options are supported:
407b1019a6SJerry Jelinek.Bl -tag -width Ds
417b1019a6SJerry Jelinek.It Fl a
4272d3dbb9SYuri PankovExtract all of the tables found.
4372d3dbb9SYuri PankovBy default only the
447b1019a6SJerry Jelinek.Sy DSDT
457b1019a6SJerry Jelinekand
467b1019a6SJerry Jelinek.Sy SSDT
477b1019a6SJerry Jelinektables will be extracted.
487b1019a6SJerry Jelinek.It Fl h
497b1019a6SJerry JelinekDisplay the usage message and exit.
507b1019a6SJerry Jelinek.It Fl l
517b1019a6SJerry JelinekList tables only, do not extract.
527b1019a6SJerry Jelinek.It Fl m
537b1019a6SJerry JelinekMake a single file for all of the
547b1019a6SJerry Jelinek.Sy DSDT
557b1019a6SJerry Jelinekand
567b1019a6SJerry Jelinek.Sy SSDT
577b1019a6SJerry Jelinektables.
587b1019a6SJerry Jelinek.It Fl s Ar signature
597b1019a6SJerry JelinekGet the table with the specified signature.
607b1019a6SJerry Jelinek.It Fl v
617b1019a6SJerry JelinekPrint the version.
627b1019a6SJerry Jelinek.El
630e974e5fSRobert Mustacchi.Sh EXAMPLES
640e974e5fSRobert Mustacchi.Sy Example 1
650e974e5fSRobert MustacchiExtract all ACPI tables
660e974e5fSRobert Mustacchi.Pp
670e974e5fSRobert MustacchiThe following example extracts all of the individual ACPI tables from a
680e974e5fSRobert Mustacchipreviously created dump of the ACPI tables from a running system.
690e974e5fSRobert MustacchiSuch a dump can be created with the
70*bbf21555SRichard Lowe.Xr acpidump 8
710e974e5fSRobert Mustacchiutility.
720e974e5fSRobert MustacchiExtracted tables can then be inspected or disassembled by the
730e974e5fSRobert Mustacchiiasl utility on any platform.
740e974e5fSRobert Mustacchi.Bd -literal -offset width
750e974e5fSRobert Mustacchi# acpixtract -a acpi.dat
760e974e5fSRobert Mustacchi
770e974e5fSRobert MustacchiIntel ACPI Component Architecture
780e974e5fSRobert MustacchiACPI Binary Table Extraction Utility version 20160527-32
790e974e5fSRobert MustacchiCopyright (c) 2000 - 2016 Intel Corporation
800e974e5fSRobert Mustacchi
810e974e5fSRobert MustacchiAcpi table [RSDP] -      36 bytes written to rsdp.dat
820e974e5fSRobert MustacchiAcpi table [RSDT] -     128 bytes written to rsdt.dat
830e974e5fSRobert MustacchiAcpi table [XSDT] -     220 bytes written to xsdt.dat
840e974e5fSRobert MustacchiAcpi table [DSDT] -  213221 bytes written to dsdt.dat
850e974e5fSRobert MustacchiAcpi table [FACS] -      64 bytes written to facs.dat
860e974e5fSRobert MustacchiAcpi table [FACP] -     268 bytes written to facp.dat
870e974e5fSRobert MustacchiAcpi table [APIC] -     884 bytes written to apic.dat
880e974e5fSRobert MustacchiAcpi table [FPDT] -      68 bytes written to fpdt.dat
890e974e5fSRobert MustacchiAcpi table [FIDT] -     156 bytes written to fidt.dat
900e974e5fSRobert MustacchiAcpi table [SPMI] -      65 bytes written to spmi.dat
910e974e5fSRobert MustacchiAcpi table [MCFG] -      60 bytes written to mcfg.dat
920e974e5fSRobert MustacchiAcpi table [UEFI] -      66 bytes written to uefi.dat
930e974e5fSRobert MustacchiAcpi table [MCEJ] -     304 bytes written to mcej.dat
940e974e5fSRobert MustacchiAcpi table [HPET] -      56 bytes written to hpet.dat
950e974e5fSRobert MustacchiAcpi table [MSCT] -     144 bytes written to msct.dat
960e974e5fSRobert MustacchiAcpi table [SLIT] -      48 bytes written to slit.dat
970e974e5fSRobert MustacchiAcpi table [SRAT] -    4440 bytes written to srat.dat
980e974e5fSRobert MustacchiAcpi table [WDDT] -      64 bytes written to wddt.dat
990e974e5fSRobert MustacchiAcpi table [SSDT] -   94529 bytes written to ssdt1.dat
1000e974e5fSRobert MustacchiAcpi table [NITR] -     113 bytes written to nitr.dat
1010e974e5fSRobert MustacchiAcpi table [SSDT] -    9802 bytes written to ssdt2.dat
1020e974e5fSRobert MustacchiAcpi table [SSDT] -     100 bytes written to ssdt3.dat
1030e974e5fSRobert MustacchiAcpi table [PRAD] -     191 bytes written to prad.dat
1040e974e5fSRobert MustacchiAcpi table [DMAR] -     328 bytes written to dmar.dat
1050e974e5fSRobert MustacchiAcpi table [HEST] -     168 bytes written to hest.dat
1060e974e5fSRobert MustacchiAcpi table [BERT] -      48 bytes written to bert.dat
1070e974e5fSRobert MustacchiAcpi table [ERST] -     560 bytes written to erst.dat
1080e974e5fSRobert MustacchiAcpi table [EINJ] -     336 bytes written to einj.dat
1090e974e5fSRobert Mustacchi
1100e974e5fSRobert Mustacchi28 binary ACPI tables extracted
1110e974e5fSRobert Mustacchi.Ed
1127b1019a6SJerry Jelinek.Sh SEE ALSO
113*bbf21555SRichard Lowe.Xr acpidump 8
114