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