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