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