xref: /dragonfly/usr.sbin/acpi/iasl/iasl.8 (revision b0d289c2)
1.\"
2.\" Copyright (c) 2014 The DragonFly Project.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\"
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in
12.\"    the documentation and/or other materials provided with the
13.\"    distribution.
14.\" 3. Neither the name of The DragonFly Project nor the names of its
15.\"    contributors may be used to endorse or promote products derived
16.\"    from this software without specific, prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
21.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
22.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
23.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
24.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
28.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29.\" SUCH DAMAGE.
30.\"
31.Dd April 9, 2015
32.Dt IASL 8
33.Os
34.Sh NAME
35.Nm iasl
36.Nd ACPI Source Language compiler, ACPI table compiler, and AML disassembler
37.Sh SYNOPSIS
38.Nm
39.Op Ar option ...
40.Op Ar file ...
41.Sh DESCRIPTION
42The following options are supported:
43.Bl -tag -width indent
44.It Fl @ Ar file
45Specify command file.
46.It Fl bf
47Create debug file (full tree only) (*.txt).
48.It Fl bp Ar depth
49Prune ASL parse tree.
50.It Fl bs
51Create debug file (parse tree only) (*.txt).
52.It Fl bt Ar type
53Object type to be pruned from the parse tree.
54.It Fl cr
55Disable Resource Descriptor error checking.
56.It Fl d Ar file1 Op Ar file2
57Disassemble or decode binary ACPI tables to file (*.dsl).
58The
59.Ar file2
60is optional, file type is automatically detected.
61.It Fl D Ar symbol
62Define symbol for preprocessor use.
63.It Fl da Ar file ...
64Disassemble multiple tables from single namespace.
65.It Fl db
66Do not translate Buffers to Resource Templates.
67.It Fl dc Ar file ...
68Disassemble AML and immediately compile it.
69Obtain the DSDT from the current system if no input file has it.
70.It Fl df
71Force the disassembler to assume the table contains valid AML.
72.It Fl dl
73Emit legacy ASL code only (no C-style operators).
74.It Fl e Ar file ...
75Include ACPI table(s) for external symbol resolution.
76.It Fl f
77Ignore errors, force creation of AML output file(s).
78.It Fl fe Ar file
79Specify external symbol declaration file.
80.It Fl G
81Compile custom table that contains generic operators.
82.It Fl h
83Display the help message.
84.It Fl hc
85Display operators allowed in constant expressions.
86.It Fl hf
87Display help for output filename generation.
88.It Fl hr
89Display ACPI reserved method names.
90.It Fl ht
91Display currently supported ACPI table names.
92.It Fl I Ar directory
93Specify additional include directory.
94.It Fl ia
95Create include file in assembler (*.inc).
96.It Fl ic
97Create include file in C (*.h).
98.It Fl in
99Ignore NoOp opcodes.
100.It Fl in
101Ignore NoOp operators.
102.It Fl l
103Create mixed listing file (ASL source and AML) (*.lst).
104.It Fl li
105Create preprocessed output file (*.i).
106.It Fl lm
107Create hardware summary map file (*.map).
108.It Fl ln
109Create namespace file (*.nsp).
110.It Fl ls
111Create combined source file (expanded includes) (*.src).
112.It Fl m Ar size
113Set internal line buffer size (in Kbytes).
114.It Fl n
115Parse only, no output generation.
116.It Fl oa
117Disable all optimizations (compatibility mode).
118.It Fl of
119Disable constant folding.
120.It Fl oi
121Disable integer optimization to Zero/One/Ones.
122.It Fl on
123Disable named reference string optimization.
124.It Fl ot
125Display compile times and statistics.
126.It Fl P
127Preprocess only and create preprocessor output file (*.i).
128.It Fl p Ar prefix
129Specify path/filename prefix for all output files.
130.It Fl Pn
131Disable preprocessor.
132.It Fl r Ar revision
133Override table header Revision (1-255).
134.It Fl sa
135Create source file in assembler (*.asm).
136.It Fl sc
137Create source file in C (*.c).
138.It Fl so
139Create offset table in C (*.offset.h).
140.It Fl T Ar sig | ALL | *
141Create table template file for ACPI
142.Ar sig .
143.It Fl ta
144Create hex AML table in assembler (*.hex).
145.It Fl tc
146Create hex AML table in C (*.hex).
147.It Fl ts
148Create hex AML table in ASL (*.hex).
149.It Fl v
150Display compiler version.
151.It Fl va
152Disable all errors/warnings/remarks.
153.It Fl ve
154Report only errors (ignore warnings and remarks).
155.It Fl vi
156Less verbose errors and warnings for use with IDEs.
157.It Fl vo
158Enable optimization comments.
159.It Fl vr
160Disable remarks.
161.It Fl vs
162Disable signon.
163.It Fl vt
164Create verbose template files (full disassembly).
165.It Fl vt
166Dump binary table data in hex format within output file.
167.It Fl vw Ar message_id
168Disable specific warning or remark.
169.It Fl w1 | Fl w2 | Fl w3
170Set warning reporting level.
171.It Fl we
172Report warnings as errors.
173.It Fl x Ar level
174Set debug level for trace output.
175.It Fl z
176Do not insert new compiler ID for DataTables.
177.El
178.Sh SEE ALSO
179.Xr acpi 4 ,
180.Xr acpibin 8 ,
181.Xr acpiconf 8 ,
182.Xr acpidump 8 ,
183.Xr acpiexec 8 ,
184.Xr acpihelp 8 ,
185.Xr acpinames 8 ,
186.Xr acpixtract 8
187.Pp
188.Lk https://acpica.org/documentation/
189.Pp
190.Lk https://acpica.org/sites/acpica/files/aslcompiler_5.pdf
191.Sh AUTHORS
192The
193.Nm
194utility is provided by
195.Tn Intel
196as part of their
197.Sy ACPICA
198distribution.
199.Pp
200This manual page was written by
201.An Sascha Wildner .
202