Sync ACPICA with Intel's version 20141107.
[dragonfly.git] / usr.sbin / acpi / iasl / iasl.8
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
42 The following options are supported:
43 .Bl -tag -width indent
44 .It Fl @ Ar file
45 Specify command file.
46 .It Fl bf
47 Create debug file (full tree only) (*.txt).
48 .It Fl bp Ar depth
49 Prune ASL parse tree.
50 .It Fl bs
51 Create debug file (parse tree only) (*.txt).
52 .It Fl bt Ar type
53 Object type to be pruned from the parse tree.
54 .It Fl cr
55 Disable Resource Descriptor error checking.
56 .It Fl d Ar file1 Op Ar file2
57 Disassemble or decode binary ACPI tables to file (*.dsl).
58 The
59 .Ar file2
60 is optional, file type is automatically detected.
61 .It Fl D Ar symbol
62 Define symbol for preprocessor use.
63 .It Fl da Ar file ...
64 Disassemble multiple tables from single namespace.
65 .It Fl db
66 Do not translate Buffers to Resource Templates.
67 .It Fl dc Ar file ...
68 Disassemble AML and immediately compile it.
69 Obtain the DSDT from the current system if no input file has it.
70 .It Fl dl
71 Emit legacy ASL code only (no C-style operators).
72 .It Fl e Ar file ...
73 Include ACPI table(s) for external symbol resolution.
74 .It Fl f
75 Ignore errors, force creation of AML output file(s).
76 .It Fl fe Ar file
77 Specify external symbol declaration file.
78 .It Fl G
79 Compile custom table that contains generic operators.
80 .It Fl h
81 Display the help message.
82 .It Fl hc
83 Display operators allowed in constant expressions.
84 .It Fl hf
85 Display help for output filename generation.
86 .It Fl hr
87 Display ACPI reserved method names.
88 .It Fl ht
89 Display currently supported ACPI table names.
90 .It Fl I Ar directory
91 Specify additional include directory.
92 .It Fl ia
93 Create include file in assembler (*.inc).
94 .It Fl ic
95 Create include file in C (*.h).
96 .It Fl in
97 Ignore NoOp opcodes.
98 .It Fl in
99 Ignore NoOp operators.
100 .It Fl l
101 Create mixed listing file (ASL source and AML) (*.lst).
102 .It Fl li
103 Create preprocessed output file (*.i).
104 .It Fl lm
105 Create hardware summary map file (*.map).
106 .It Fl ln
107 Create namespace file (*.nsp).
108 .It Fl ls
109 Create combined source file (expanded includes) (*.src).
110 .It Fl m Ar size
111 Set internal line buffer size (in Kbytes).
112 .It Fl n
113 Parse only, no output generation.
114 .It Fl oa
115 Disable all optimizations (compatibility mode).
116 .It Fl of
117 Disable constant folding.
118 .It Fl oi
119 Disable integer optimization to Zero/One/Ones.
120 .It Fl on
121 Disable named reference string optimization.
122 .It Fl ot
123 Display compile times and statistics.
124 .It Fl P
125 Preprocess only and create preprocessor output file (*.i).
126 .It Fl p Ar prefix
127 Specify path/filename prefix for all output files.
128 .It Fl Pn
129 Disable preprocessor.
130 .It Fl r Ar revision
131 Override table header Revision (1-255).
132 .It Fl sa
133 Create source file in assembler (*.asm).
134 .It Fl sc
135 Create source file in C (*.c).
136 .It Fl so
137 Create offset table in C (*.offset.h).
138 .It Fl T Ar sig | ALL | *
139 Create table template file for ACPI
140 .Ar sig .
141 .It Fl ta
142 Create hex AML table in assembler (*.hex).
143 .It Fl tc
144 Create hex AML table in C (*.hex).
145 .It Fl ts
146 Create hex AML table in ASL (*.hex).
147 .It Fl v
148 Display compiler version.
149 .It Fl va
150 Disable all errors/warnings/remarks.
151 .It Fl ve
152 Report only errors (ignore warnings and remarks).
153 .It Fl vi
154 Less verbose errors and warnings for use with IDEs.
155 .It Fl vo
156 Enable optimization comments.
157 .It Fl vr
158 Disable remarks.
159 .It Fl vs
160 Disable signon.
161 .It Fl vt
162 Create verbose template files (full disassembly).
163 .It Fl vt
164 Dump binary table data in hex format within output file.
165 .It Fl vw Ar message_id
166 Disable specific warning or remark.
167 .It Fl w1 | Fl w2 | Fl w3
168 Set warning reporting level.
169 .It Fl we
170 Report warnings as errors.
171 .It Fl x Ar level
172 Set debug level for trace output.
173 .It Fl z
174 Do 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
190 The
191 .Nm
192 utility is provided by
193 .Tn Intel
194 as part of their
195 .Sy ACPICA
196 distribution.
197 .Pp
198 This manual page was written by
199 .An Sascha Wildner .