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