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