xref: /dragonfly/usr.sbin/acpi/iasl/iasl.8 (revision 279dd846)
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 August 21, 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 dv
75Set verbose option.
76.It Fl e Ar file ...
77Include ACPI table(s) for external symbol resolution.
78.It Fl f
79Ignore errors, force creation of AML output file(s).
80.It Fl fe Ar file
81Specify external symbol declaration file.
82.It Fl G
83Compile custom table that contains generic operators.
84.It Fl h
85Display the help message.
86.It Fl hc
87Display operators allowed in constant expressions.
88.It Fl hf
89Display help for output filename generation.
90.It Fl hr
91Display ACPI reserved method names.
92.It Fl ht
93Display currently supported ACPI table names.
94.It Fl I Ar directory
95Specify additional include directory.
96.It Fl ia
97Create include file in assembler (*.inc).
98.It Fl ic
99Create include file in C (*.h).
100.It Fl in
101When disassembling, ignore NoOp opcodes.
102When compiling, ignore NoOp operators.
103.It Fl l
104When compiling, create mixed listing file (ASL source and AML) (*.lst).
105When disassembling, disassemble to mixed ASL and AML code.
106.It Fl li
107Create preprocessed output file (*.i).
108.It Fl lm
109Create hardware summary map file (*.map).
110.It Fl ln
111Create namespace file (*.nsp).
112.It Fl ls
113Create combined source file (expanded includes) (*.src).
114.It Fl m Ar size
115Set internal line buffer size (in Kbytes).
116.It Fl n
117Parse only, no output generation.
118.It Fl oa
119Disable all optimizations (compatibility mode).
120.It Fl of
121Disable constant folding.
122.It Fl oi
123Disable integer optimization to Zero/One/Ones.
124.It Fl on
125Disable named reference string optimization.
126.It Fl ot
127Display compile times and statistics.
128.It Fl P
129Preprocess only and create preprocessor output file (*.i).
130.It Fl p Ar prefix
131Specify path/filename prefix for all output files.
132.It Fl Pn
133Disable preprocessor.
134.It Fl r Ar revision
135Override table header Revision (1-255).
136.It Fl sa
137Create source file in assembler (*.asm).
138.It Fl sc
139Create source file in C (*.c).
140.It Fl so
141Create offset table in C (*.offset.h).
142.It Fl T Ar sig | ALL | *
143Create table template file for ACPI
144.Ar sig .
145.It Fl ta
146Create hex AML table in assembler (*.hex).
147.It Fl tc
148Create hex AML table in C (*.hex).
149.It Fl ts
150Create hex AML table in ASL (*.hex).
151.It Fl v
152Display compiler version.
153.It Fl va
154Disable all errors/warnings/remarks.
155.It Fl ve
156Report only errors (ignore warnings and remarks).
157.It Fl vi
158Less verbose errors and warnings for use with IDEs.
159.It Fl vo
160Enable optimization comments.
161.It Fl vr
162Disable remarks.
163.It Fl vs
164Disable signon.
165.It Fl vt
166Create verbose template files (full disassembly).
167.It Fl vt
168Dump binary table data in hex format within output file.
169.It Fl vw Ar message_id
170Disable specific warning or remark.
171.It Fl w1 | Fl w2 | Fl w3
172Set warning reporting level.
173.It Fl we
174Report warnings as errors.
175.It Fl x Ar level
176Set debug level for trace output.
177.It Fl z
178Do not insert new compiler ID for DataTables.
179.El
180.Sh SEE ALSO
181.Xr acpi 4 ,
182.Xr acpibin 8 ,
183.Xr acpicall 8 ,
184.Xr acpiconf 8 ,
185.Xr acpidump 8 ,
186.Xr acpiexec 8 ,
187.Xr acpihelp 8 ,
188.Xr acpinames 8 ,
189.Xr acpixtract 8
190.Pp
191.Lk https://acpica.org/documentation/
192.Pp
193.Lk https://acpica.org/sites/acpica/files/aslcompiler_5.pdf
194.Sh AUTHORS
195The
196.Nm
197utility is provided by
198.Tn Intel
199as part of their
200.Sy ACPICA
201distribution.
202.Pp
203This manual page was written by
204.An Sascha Wildner .
205