xref: /dragonfly/usr.sbin/acpi/iasl/iasl.8 (revision e6e77800)
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 September 1, 2017
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 ar
47Enable reference typechecking.
48.It Fl bc
49Create converter debug file (*.cdb).
50.It Fl bf
51Create debug file (full tree only) (*.txt).
52.It Fl bp Ar depth
53Prune ASL parse tree.
54.It Fl bs
55Create debug file (parse tree only) (*.txt).
56.It Fl bt Ar type
57Object type to be pruned from the parse tree.
58.It Fl ca
59Convert legacy-ASL source file to new ASL+ file
60(Original comments are passed through to ASL+ file).
61.It Fl cr
62Disable Resource Descriptor error checking.
63.It Fl d Ar file1 Op Ar file2
64Disassemble or decode binary ACPI tables to file (*.dsl).
65The
66.Ar file2
67is optional, file type is automatically detected.
68.It Fl D Ar symbol
69Define symbol for preprocessor use.
70.It Fl da Ar file ...
71Disassemble multiple tables from single namespace.
72.It Fl db
73Do not translate Buffers to Resource Templates.
74.It Fl dc Ar file ...
75Disassemble AML and immediately compile it.
76Obtain the DSDT from the current system if no input file has it.
77.It Fl df
78Force the disassembler to assume the table contains valid AML.
79.It Fl dl
80Emit legacy ASL code only (no C-style operators).
81.It Fl dv
82Set verbose option.
83.It Fl e Ar file ...
84Include ACPI table(s) for external symbol resolution.
85.It Fl f
86Ignore errors, force creation of AML output file(s).
87.It Fl fe Ar file
88Specify external symbol declaration file.
89.It Fl G
90Compile custom table that contains generic operators.
91.It Fl h
92Display the help message.
93.It Fl hc
94Display operators allowed in constant expressions.
95.It Fl hd
96Info for obtaining and disassembling binary ACPI tables.
97.It Fl hf
98Display help for output filename generation.
99.It Fl hr
100Display ACPI reserved method names.
101.It Fl ht
102Display currently supported ACPI table names.
103.It Fl I Ar directory
104Specify additional include directory.
105.It Fl ia
106Create include file in assembler (*.inc).
107.It Fl ic
108Create include file in C (*.h).
109.It Fl in
110When disassembling, ignore NoOp opcodes.
111When compiling, ignore NoOp operators.
112.It Fl l
113When compiling, create mixed listing file (ASL source and AML) (*.lst).
114When disassembling, disassemble to mixed ASL and AML code.
115.It Fl li
116Create preprocessed output file (*.i).
117.It Fl lm
118Create hardware summary map file (*.map).
119.It Fl ln
120Create namespace file (*.nsp).
121.It Fl ls
122Create combined source file (expanded includes) (*.src).
123.It Fl lx
124Create cross-reference file (*.xrf).
125.It Fl m Ar size
126Set internal line buffer size (in Kbytes).
127.It Fl n
128Parse only, no output generation.
129.It Fl oa
130Disable all optimizations (compatibility mode).
131.It Fl oc
132Display compile times and statistics.
133.It Fl od
134Disable disassembler code optimizations.
135.It Fl of
136Disable constant folding.
137.It Fl oi
138Disable integer optimization to Zero/One/Ones.
139.It Fl on
140Disable named reference string optimization.
141.It Fl ot
142Disable typechecking.
143.It Fl P
144Preprocess only and create preprocessor output file (*.i).
145.It Fl p Ar prefix
146Specify path/filename prefix for all output files.
147.It Fl Pn
148Disable preprocessor.
149.It Fl r Ar revision
150Override table header Revision (1-255).
151.It Fl sa
152Create source file in assembler (*.asm).
153.It Fl sc
154Create source file in C (*.c).
155.It Fl so
156Create offset table in C (*.offset.h).
157.It Fl T Ar sig ... | ALL
158Create ACPI table template/example files.
159.It Fl T Ar count
160Emit DSDT and
161.Ar count
162SSDTs to same file.
163.It Fl ta
164Create hex AML table in assembler (*.hex).
165.It Fl tc
166Create hex AML table in C (*.hex).
167.It Fl ts
168Create hex AML table in ASL (*.hex).
169.It Fl v
170Display compiler version.
171.It Fl va
172Disable all errors/warnings/remarks.
173.It Fl vd
174Display compiler build date and time.
175.It Fl ve
176Report only errors (ignore warnings and remarks).
177.It Fl vi
178Less verbose errors and warnings for use with IDEs.
179.It Fl vo
180Enable optimization comments.
181.It Fl vr
182Disable remarks.
183.It Fl vs
184Disable signon.
185.It Fl vt
186Create verbose template files (full disassembly).
187.It Fl vt
188Dump binary table data in hex format within output file.
189.It Fl vw Ar message_id
190Ignore specific error, warning or remark.
191.It Fl vx Ar message_id
192Expect a specific warning, remark, or error.
193.It Fl w Ar 1 | 2 | 3
194Set warning reporting level.
195.It Fl we
196Report warnings as errors.
197.It Fl x Ar level
198Set debug level for trace output.
199.It Fl z
200Do not insert new compiler ID for DataTables.
201.El
202.Sh SEE ALSO
203.Xr acpi 4 ,
204.Xr acpibin 8 ,
205.Xr acpicall 8 ,
206.Xr acpiconf 8 ,
207.Xr acpidump 8 ,
208.Xr acpiexec 8 ,
209.Xr acpihelp 8 ,
210.Xr acpinames 8 ,
211.Xr acpixtract 8
212.Pp
213.Lk https://acpica.org/documentation/
214.Pp
215.Lk https://acpica.org/sites/acpica/files/aslcompiler_9.pdf
216.Sh AUTHORS
217The
218.Nm
219utility is provided by
220.Tn Intel
221as part of their
222.Sy ACPICA
223distribution.
224.Pp
225This manual page was written by
226.An Sascha Wildner .
227