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