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