Merge branch 'vendor/GDB'
[dragonfly.git] / usr.sbin / acpi / iasl / iasl.8
1 .\"-
2 .\" Copyright (c) 2003 Nate Lawson
3 .\" All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer
10 .\"    in this position and unchanged.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\" 3. The name of the author may not be used to endorse or promote products
15 .\"    derived from this software without specific prior written permission.
16 .\"
17 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 .\"
28 .\" $FreeBSD: src/usr.sbin/acpi/iasl/iasl.8,v 1.2 2004/06/13 18:03:39 ru Exp $
29 .\" $DragonFly: src/usr.sbin/acpi/iasl/iasl.8,v 1.1 2004/07/05 00:22:43 dillon Exp $
30 .\"
31 .Dd August 7, 2003
32 .Dt IASL 8
33 .Os
34 .Sh NAME
35 .Nm iasl
36 .Nd Intel ACPI compiler/decompiler
37 .Sh SYNOPSIS
38 .Nm
39 .Op Fl cefghl
40 .Op Fl b Ar type
41 .Op Fl d Ar file
42 .Op Fl dc Ar file
43 .Op Fl hc
44 .Op Fl hr
45 .Op Fl i Ar type
46 .Op Fl ln
47 .Op Fl ls
48 .Op Fl oa
49 .Op Fl of
50 .Op Fl oi
51 .Op Fl on
52 .Op Fl ot
53 .Op Fl p Ar prefix
54 .Op Fl s Ar type
55 .Op Fl t Ar type
56 .Op Fl vi
57 .Op Fl vo
58 .Op Fl vr
59 .Op Fl vs
60 .Op Fl x Ar level
61 .Ar input-file
62 .Sh DESCRIPTION
63 The
64 .Nm
65 utility is a compiler/decompiler for ACPI Source Language (ASL)
66 and ACPI Machine Language (AML).
67 Major features of
68 .Nm
69 include:
70 .Bl -bullet -offset indent
71 .It
72 Full support for the ACPI 2.0b Specification including ASL grammar
73 elements and operators.
74 .It
75 Extensive compiler syntax and semantic error checking, especially in
76 the area of control methods.
77 This reduces the number of errors that are
78 not discovered until the AML code is actually interpreted (i.e., the
79 compile-time error checking reduces the number of run-time errors).
80 .It
81 Multiple types of output files, including formatted listing files with
82 intermixed source, several types of AML files, and error messages.
83 .El
84 .Sh OPTIONS
85 .Bl -tag -width indent
86 .It Fl b Sm Cm p | t | b Sm
87 Create compiler debug/trace file
88 .Pq Pa *.txt .
89 Types: Parse/Tree/Both.
90 .It Fl c
91 Parse only, no output generation.
92 .It Fl d Ar file
93 Disassemble AML to ASL source code file
94 .Pq Pa *.dsl .
95 .It Fl dc Ar file
96 Disassemble AML and immediately compile it.
97 (Obtain DSDT from current system if no input file.)
98 .It Fl e
99 Generate
100 .Fn External
101 statements for unresolved symbols.
102 .It Fl f
103 Ignore errors, force creation of AML output file(s).
104 .It Fl g
105 Get ACPI tables and write to files
106 .Pq Pa *.dat .
107 .It Fl h
108 Additional help and compiler debug options.
109 .It Fl hc
110 Display operators allowed in constant expressions.
111 .It Fl hr
112 Display ACPI reserved method names.
113 .It Fl i Sm Cm a | c Sm
114 Create assembler or C include file
115 .Pa ( *.inc
116 or
117 .Pa *.h ) .
118 .It Fl l
119 Create mixed listing file (ASL source and AML)
120 .Pq Pa *.lst .
121 .It Fl ln
122 Create namespace file
123 .Pq Pa *.nsp .
124 .It Fl ls
125 Create combined source file (expanded includes)
126 .Pq Pa *.src .
127 .It Fl oa
128 Disable all optimizations (compatibility mode).
129 .It Fl of
130 Disable constant folding.
131 .It Fl oi
132 Disable integer optimization to Zero/One/Ones.
133 .It Fl on
134 Disable named reference string optimization.
135 .It Fl ot
136 Display compile times.
137 .It Fl p Ar prefix
138 Specify filename prefix for all output files (including
139 .Pa .aml ) .
140 .It Fl s Sm Cm a | c Sm
141 Create AML in assembler or C source file
142 .Pa ( *.asm
143 or
144 .Pa *.c ) .
145 .It Fl t Ar a|c
146 Create AML in assembler or C hex table
147 .Pq Pa *.hex .
148 .It Fl vi
149 Less verbose errors and warnings for use with IDEs.
150 .It Fl vo
151 Enable optimization comments.
152 .It Fl vr
153 Disable remarks.
154 .It Fl vs
155 Disable signon.
156 .It Fl x Ar level
157 Set debug level for trace output.
158 .El
159 .Sh SEE ALSO
160 .Xr acpi 4 ,
161 .Xr acpidump 8
162 .Sh HISTORY
163 The
164 .Nm
165 utility is provided with Intel ACPI-CA.
166 It first appeared in
167 .Fx 5.2 .
168 .Sh AUTHORS
169 .An -nosplit
170 The
171 .Nm
172 utility was written by
173 .An Intel .
174 This manual page was written by
175 .An Nate Lawson .