Merge commit '9276b3991ba20d5a5660887ba81b0bc7bed25a0c'
[unleashed.git] / share / man / man8 / acpixtract.8
blob660ee21ecda86a713b59a8662fcc767ca3db0dbd
1 .\" This file and its contents are supplied under the terms of the
2 .\" Common Development and Distribution License ("CDDL"), version 1.0.
3 .\" You may only use this file in accordance with the terms of version
4 .\" 1.0 of the CDDL.
5 .\"
6 .\" A full copy of the text of the CDDL should have accompanied this
7 .\" source.  A copy of the CDDL is also available via the Internet at
8 .\" http://www.illumos.org/license/CDDL.
9 .\"
10 .\"
11 .\" Copyright (c) 2017, Joyent, Inc.
12 .\"
13 .Dd May 12, 2017
14 .Dt ACPIXTRACT 8
15 .Os
16 .Sh NAME
17 .Nm acpixtract
18 .Nd extract binary ACPI tables from a dump file
19 .Sh SYNOPSIS
20 .Nm
21 .Op Fl ahlmv
22 .Op Fl s Ar signature
23 .Ar file
24 .Sh DESCRIPTION
25 The
26 .Nm
27 utility extracts the binary data from a dump of the system's Advanced
28 Configuration and Power Interface (ACPI) tables.
29 The dump is usually obtained via the
30 .Xr acpidump 8
31 command.
32 The resulting binary file(s) are represented in the ACPI
33 .Sy ASL
34 assembly language.
35 For each table extracted, a corresponding
36 .Em table.dat
37 file will be created.
38 .Sh OPTIONS
39 The following options are supported:
40 .Bl -tag -width Ds
41 .It Fl a
42 Extract all of the tables found.
43 By default only the
44 .Sy DSDT
45 and
46 .Sy SSDT
47 tables will be extracted.
48 .It Fl h
49 Display the usage message and exit.
50 .It Fl l
51 List tables only, do not extract.
52 .It Fl m
53 Make a single file for all of the
54 .Sy DSDT
55 and
56 .Sy SSDT
57 tables.
58 .It Fl s Ar signature
59 Get the table with the specified signature.
60 .It Fl v
61 Print the version.
62 .El
63 .Sh EXAMPLES
64 .Sy Example 1
65 Extract all ACPI tables
66 .Pp
67 The following example extracts all of the individual ACPI tables from a
68 previously created dump of the ACPI tables from a running system.
69 Such a dump can be created with the
70 .Xr acpidump 1M
71 utility.
72 Extracted tables can then be inspected or disassembled by the
73 iasl utility on any platform.
74 .Bd -literal -offset width
75 # acpixtract -a acpi.dat
77 Intel ACPI Component Architecture
78 ACPI Binary Table Extraction Utility version 20160527-32
79 Copyright (c) 2000 - 2016 Intel Corporation
81 Acpi table [RSDP] -      36 bytes written to rsdp.dat
82 Acpi table [RSDT] -     128 bytes written to rsdt.dat
83 Acpi table [XSDT] -     220 bytes written to xsdt.dat
84 Acpi table [DSDT] -  213221 bytes written to dsdt.dat
85 Acpi table [FACS] -      64 bytes written to facs.dat
86 Acpi table [FACP] -     268 bytes written to facp.dat
87 Acpi table [APIC] -     884 bytes written to apic.dat
88 Acpi table [FPDT] -      68 bytes written to fpdt.dat
89 Acpi table [FIDT] -     156 bytes written to fidt.dat
90 Acpi table [SPMI] -      65 bytes written to spmi.dat
91 Acpi table [MCFG] -      60 bytes written to mcfg.dat
92 Acpi table [UEFI] -      66 bytes written to uefi.dat
93 Acpi table [MCEJ] -     304 bytes written to mcej.dat
94 Acpi table [HPET] -      56 bytes written to hpet.dat
95 Acpi table [MSCT] -     144 bytes written to msct.dat
96 Acpi table [SLIT] -      48 bytes written to slit.dat
97 Acpi table [SRAT] -    4440 bytes written to srat.dat
98 Acpi table [WDDT] -      64 bytes written to wddt.dat
99 Acpi table [SSDT] -   94529 bytes written to ssdt1.dat
100 Acpi table [NITR] -     113 bytes written to nitr.dat
101 Acpi table [SSDT] -    9802 bytes written to ssdt2.dat
102 Acpi table [SSDT] -     100 bytes written to ssdt3.dat
103 Acpi table [PRAD] -     191 bytes written to prad.dat
104 Acpi table [DMAR] -     328 bytes written to dmar.dat
105 Acpi table [HEST] -     168 bytes written to hest.dat
106 Acpi table [BERT] -      48 bytes written to bert.dat
107 Acpi table [ERST] -     560 bytes written to erst.dat
108 Acpi table [EINJ] -     336 bytes written to einj.dat
110 28 binary ACPI tables extracted
112 .Sh SEE ALSO
113 .Xr acpidump 8