sys/contrib/dev/acpica/source/compiler/aslhelp.c

   1 /******************************************************************************
   2  *
   3  * Module Name: aslhelp - iASL help screens
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  16  * 2.1. This is your license from Intel Corp. under its intellectual property
  17  * rights. You may have additional license terms from the party that provided
  18  * you this software, covering your right to use that party's intellectual
  19  * property rights.
  20  *
  21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  22  * copy of the source code appearing in this file ("Covered Code") an
  23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  24  * base code distributed originally by Intel ("Original Intel Code") to copy,
  25  * make derivatives, distribute, use and display any portion of the Covered
  26  * Code in any form, with the right to sublicense such rights; and
  27  *
  28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  29  * license (with the right to sublicense), under only those claims of Intel
  30  * patents that are infringed by the Original Intel Code, to make, use, sell,
  31  * offer to sell, and import the Covered Code and derivative works thereof
  32  * solely to the minimum extent necessary to exercise the above copyright
  33  * license, and in no event shall the patent license extend to any additions
  34  * to or modifications of the Original Intel Code. No other license or right
  35  * is granted directly or by implication, estoppel or otherwise;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  43  * Redistribution of source code of any substantial portion of the Covered
  44  * Code or modification with rights to further distribute source must include
  45  * the above Copyright Notice, the above License, this list of Conditions,
  46  * and the following Disclaimer and Export Compliance provision. In addition,
  47  * Licensee must cause all Covered Code to which Licensee contributes to
  48  * contain a file documenting the changes Licensee made to create that Covered
  49  * Code and the date of any change. Licensee must include in that file the
  50  * documentation of any changes made by any predecessor Licensee. Licensee
  51  * must include a prominent statement that the modification is derived,
  52  * directly or indirectly, from Original Intel Code.
  53  *
  54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  55  * Redistribution of source code of any substantial portion of the Covered
  56  * Code or modification without rights to further distribute source must
  57  * include the following Disclaimer and Export Compliance provision in the
  58  * documentation and/or other materials provided with distribution. In
  59  * addition, Licensee may not authorize further sublicense of source of any
  60  * portion of the Covered Code, and must include terms to the effect that the
  61  * license from Licensee to its licensee is limited to the intellectual
  62  * property embodied in the software Licensee provides to its licensee, and
  63  * not to intellectual property embodied in modifications its licensee may
  64  * make.
  65  *
  66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  67  * substantial portion of the Covered Code or modification must reproduce the
  68  * above Copyright Notice, and the following Disclaimer and Export Compliance
  69  * provision in the documentation and/or other materials provided with the
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  76  * Intel shall be used in advertising or otherwise to promote the sale, use or
  77  * other dealings in products derived from or relating to the Covered Code
  78  * without prior written authorization from Intel.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
  85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
  86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
  87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  88  * PARTICULAR PURPOSE.
  89  *
  90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
  96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  97  * LIMITED REMEDY.
  98  *
  99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 100  * software or system incorporating such software without first obtaining any
 101  * required license or other approval from the U. S. Department of Commerce or
 102  * any other agency or department of the United States Government. In the
 103  * event Licensee exports any such software from the United States or
 104  * re-exports any such software from a foreign destination, Licensee shall
 105  * ensure that the distribution and export/re-export of the software is in
 106  * compliance with all laws, regulations, orders, or other restrictions of the
 107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 108  * any of its subsidiaries will export/re-export any technical data, process,
 109  * software, or service, directly or indirectly, to any country for which the
 110  * United States government or any agency thereof requires an export license,
 111  * other governmental approval, or letter of assurance, without first obtaining
 112  * such license, approval or letter.
 113  *
 114  *****************************************************************************
 115  *
 116  * Alternatively, you may choose to be licensed under the terms of the
 117  * following license:
 118  *
 119  * Redistribution and use in source and binary forms, with or without
 120  * modification, are permitted provided that the following conditions
 121  * are met:
 122  * 1. Redistributions of source code must retain the above copyright
 123  *    notice, this list of conditions, and the following disclaimer,
 124  *    without modification.
 125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 126  *    substantially similar to the "NO WARRANTY" disclaimer below
 127  *    ("Disclaimer") and any redistribution must be conditioned upon
 128  *    including a substantially similar Disclaimer requirement for further
 129  *    binary redistribution.
 130  * 3. Neither the names of the above-listed copyright holders nor the names
 131  *    of any contributors may be used to endorse or promote products derived
 132  *    from this software without specific prior written permission.
 133  *
 134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 145  *
 146  * Alternatively, you may choose to be licensed under the terms of the
 147  * GNU General Public License ("GPL") version 2 as published by the Free
 148  * Software Foundation.
 149  *
 150  *****************************************************************************/
 151
 152 #include "aslcompiler.h"
 153 #include "acapps.h"
 154
 155 #define _COMPONENT          ACPI_COMPILER
 156         ACPI_MODULE_NAME    ("aslhelp")
 157
 158
 159 /*******************************************************************************
 160  *
 161  * FUNCTION:    Usage
 162  *
 163  * PARAMETERS:  None
 164  *
 165  * RETURN:      None
 166  *
 167  * DESCRIPTION: Display option help message.
 168  *              Optional items in square brackets.
 169  *
 170  ******************************************************************************/
 171
 172 void
 173 Usage (
 174     void)
 175 {
 176     printf (ACPI_COMMON_SIGNON (ASL_COMPILER_NAME));
 177     printf ("%s\n\n", ASL_COMPLIANCE);
 178     ACPI_USAGE_HEADER ("iasl [Options] [Files]");
 179
 180     printf ("\nGeneral:\n");
 181     ACPI_OPTION ("-@  <file>",      "Specify command file");
 182     ACPI_OPTION ("-I  <dir>",       "Specify additional include directory");
 183     ACPI_OPTION ("-p  <prefix>",    "Specify path/filename prefix for all output files");
 184     ACPI_OPTION ("-v",              "Display compiler version");
 185     ACPI_OPTION ("-vd",             "Display compiler build date and time");
 186     ACPI_OPTION ("-vo",             "Enable optimization comments");
 187     ACPI_OPTION ("-vs",             "Disable signon");
 188
 189     printf ("\nHelp:\n");
 190     ACPI_OPTION ("-h",              "This message");
 191     ACPI_OPTION ("-hc",             "Display operators allowed in constant expressions");
 192     ACPI_OPTION ("-hd",             "Info for obtaining and disassembling binary ACPI tables");
 193     ACPI_OPTION ("-hf",             "Display help for output filename generation");
 194     ACPI_OPTION ("-hr",             "Display ACPI reserved method names");
 195     ACPI_OPTION ("-ht",             "Display currently supported ACPI table names");
 196
 197     printf ("\nPreprocessor:\n");
 198     ACPI_OPTION ("-D <symbol>",     "Define symbol for preprocessor use");
 199     ACPI_OPTION ("-li",             "Create preprocessed output file (*.i)");
 200     ACPI_OPTION ("-P",              "Preprocess only and create preprocessor output file (*.i)");
 201     ACPI_OPTION ("-Pn",             "Disable preprocessor");
 202
 203     printf ("\nErrors, Warnings, and Remarks:\n");
 204     ACPI_OPTION ("-va",             "Disable all errors/warnings/remarks");
 205     ACPI_OPTION ("-ve",             "Report only errors (ignore warnings and remarks)");
 206     ACPI_OPTION ("-vi",             "Less verbose errors and warnings for use with IDEs");
 207     ACPI_OPTION ("-vr",             "Disable remarks");
 208     ACPI_OPTION ("-vw <messageid>", "Ignore specific error, warning or remark");
 209     ACPI_OPTION ("-vx <messageid>", "Expect a specific warning, remark, or error");
 210     ACPI_OPTION ("-w <1|2|3>",      "Set warning reporting level");
 211     ACPI_OPTION ("-we",             "Report warnings as errors");
 212     ACPI_OPTION ("-ww <messageid>", "Report specific warning or remark as error");
 213
 214     printf ("\nAML Bytecode Generation (*.aml):\n");
 215     ACPI_OPTION ("-oa",             "Disable all optimizations (compatibility mode)");
 216     ACPI_OPTION ("-of",             "Disable constant folding");
 217     ACPI_OPTION ("-oi",             "Disable integer optimization to Zero/One/Ones");
 218     ACPI_OPTION ("-on",             "Disable named reference string optimization");
 219     ACPI_OPTION ("-ot",             "Disable typechecking");
 220     ACPI_OPTION ("-cr",             "Disable Resource Descriptor error checking");
 221     ACPI_OPTION ("-in",             "Ignore NoOp operators");
 222     ACPI_OPTION ("-r <revision>",   "Override table header Revision (1-255)");
 223
 224     printf ("\nListings:\n");
 225     ACPI_OPTION ("-l",              "Create mixed listing file (ASL source and AML) (*.lst)");
 226     ACPI_OPTION ("-lm",             "Create hardware summary map file (*.map)");
 227     ACPI_OPTION ("-ln",             "Create namespace file (*.nsp)");
 228     ACPI_OPTION ("-ls",             "Create combined source file (expanded includes) (*.src)");
 229     ACPI_OPTION ("-lx",             "Create cross-reference file (*.xrf)");
 230
 231     printf ("\nFirmware Support - C Text Output:\n");
 232     ACPI_OPTION ("-tc",             "Create hex AML table in C (*.hex)");
 233     ACPI_OPTION ("-sc",             "Create named hex AML arrays in C (*.c)");
 234     ACPI_OPTION ("-ic",             "Create include file in C for -sc symbols (*.h)");
 235     ACPI_OPTION ("-so",             "Create namespace AML offset table in C (*.offset.h)");
 236
 237     printf ("\nFirmware Support - Assembler Text Output:\n");
 238     ACPI_OPTION ("-ta",             "Create hex AML table in assembler (*.hex)");
 239     ACPI_OPTION ("-sa",             "Create named hex AML arrays in assembler (*.asm)");
 240     ACPI_OPTION ("-ia",             "Create include file in assembler for -sa symbols (*.inc)");
 241
 242     printf ("\nFirmware Support - ASL Text Output:\n");
 243     ACPI_OPTION ("-ts",             "Create hex AML table in ASL (Buffer object) (*.hex)");
 244
 245     printf ("\nLegacy-ASL to ASL+ Converter:\n");
 246     ACPI_OPTION ("-ca <file>",      "Convert legacy-ASL source file to new ASL+ file");
 247     ACPI_OPTION ("",                "  (Original comments are passed through to ASL+ file)");
 248
 249     printf ("\nData Table Compiler:\n");
 250     ACPI_OPTION ("-G",              "Compile custom table that contains generic operators");
 251     ACPI_OPTION ("-T <sig list>|ALL",   "Create ACPI table template/example files");
 252     ACPI_OPTION ("-T <count>",      "Emit DSDT and <count> SSDTs to same file");
 253     ACPI_OPTION ("-vt",             "Create verbose template files (full disassembly)");
 254
 255     printf ("\nAML Disassembler:\n");
 256     ACPI_OPTION ("-d  <f1 f2 ...>", "Disassemble or decode binary ACPI tables to file (*.dsl)");
 257     ACPI_OPTION ("",                "  (Optional, file type is automatically detected)");
 258     ACPI_OPTION ("-da <f1 f2 ...>", "Disassemble multiple tables from single namespace");
 259     ACPI_OPTION ("-db",             "Do not translate Buffers to Resource Templates");
 260     ACPI_OPTION ("-dc <f1 f2 ...>", "Disassemble AML and immediately compile it");
 261     ACPI_OPTION ("",                "  (Obtain DSDT from current system if no input file)");
 262     ACPI_OPTION ("-df",             "Force disassembler to assume table contains valid AML");
 263     ACPI_OPTION ("-dl",             "Emit legacy ASL code only (no C-style operators)");
 264     ACPI_OPTION ("-e  <f1 f2 ...>", "Include ACPI table(s) for external symbol resolution");
 265     ACPI_OPTION ("-fe <file>",      "Specify external symbol declaration file");
 266     ACPI_OPTION ("-in",             "Ignore NoOp opcodes");
 267     ACPI_OPTION ("-l",              "Disassemble to mixed ASL and AML code");
 268     ACPI_OPTION ("-vt",             "Dump binary table data in hex format within output file");
 269
 270     printf ("\nDebug Options:\n");
 271     ACPI_OPTION ("-bc",             "Create converter debug file (*.cdb)");
 272     ACPI_OPTION ("-bf",             "Create debug file (full output) (*.txt)");
 273     ACPI_OPTION ("-bs",             "Create debug file (parse tree only) (*.txt)");
 274     ACPI_OPTION ("-bp <depth>",     "Prune ASL parse tree");
 275     ACPI_OPTION ("-bt <type>",      "Object type to be pruned from the parse tree");
 276     ACPI_OPTION ("-f",              "Ignore errors, force creation of AML output file(s)");
 277     ACPI_OPTION ("-m <size>",       "Set internal line buffer size (in Kbytes)");
 278     ACPI_OPTION ("-n",              "Parse only, no output generation");
 279     ACPI_OPTION ("-oc",             "Display compile times and statistics");
 280     ACPI_OPTION ("-x <level>",      "Set debug level for trace output");
 281     ACPI_OPTION ("-z",              "Do not insert new compiler ID for DataTables");
 282 }
 283
 284
 285 /*******************************************************************************
 286  *
 287  * FUNCTION:    FilenameHelp
 288  *
 289  * PARAMETERS:  None
 290  *
 291  * RETURN:      None
 292  *
 293  * DESCRIPTION: Display help message for output filename generation
 294  *
 295  ******************************************************************************/
 296
 297 void
 298 AslFilenameHelp (
 299     void)
 300 {
 301
 302     printf ("\nAML output filename generation:\n");
 303     printf ("  Output filenames are generated by appending an extension to a common\n");
 304     printf ("  filename prefix. The filename prefix is obtained via one of the\n");
 305     printf ("  following methods (in priority order):\n");
 306     printf ("    1) The -p option specifies the prefix\n");
 307     printf ("    2) The prefix of the AMLFileName in the ASL Definition Block\n");
 308     printf ("    3) The prefix of the input filename\n");
 309     printf ("\n");
 310 }
 311
 312 /*******************************************************************************
 313  *
 314  * FUNCTION:    AslDisassemblyHelp
 315  *
 316  * PARAMETERS:  None
 317  *
 318  * RETURN:      None
 319  *
 320  * DESCRIPTION: Display help message for obtaining and disassembling AML/ASL
 321  *              files.
 322  *
 323  ******************************************************************************/
 324
 325 void
 326 AslDisassemblyHelp (
 327     void)
 328 {
 329
 330     printf ("\nObtaining binary ACPI tables and disassembling to ASL source code.\n\n");
 331     printf ("Use the following ACPICA toolchain:\n");
 332     printf ("  AcpiDump: Dump all ACPI tables to a hex ascii file\n");
 333     printf ("  AcpiXtract: Extract one or more binary ACPI tables from AcpiDump output\n");
 334     printf ("  iASL -d <file>: Disassemble a binary ACPI table to ASL source code\n");
 335     printf ("\n");
 336 }