aslhelp.c revision 1.1.1.5.2.2
1 1.1.1.5.2.2 jdolecek /****************************************************************************** 2 1.1.1.5.2.2 jdolecek * 3 1.1.1.5.2.2 jdolecek * Module Name: aslhelp - iASL help screens 4 1.1.1.5.2.2 jdolecek * 5 1.1.1.5.2.2 jdolecek *****************************************************************************/ 6 1.1.1.5.2.2 jdolecek 7 1.1.1.5.2.2 jdolecek /* 8 1.1.1.5.2.2 jdolecek * Copyright (C) 2000 - 2017, Intel Corp. 9 1.1.1.5.2.2 jdolecek * All rights reserved. 10 1.1.1.5.2.2 jdolecek * 11 1.1.1.5.2.2 jdolecek * Redistribution and use in source and binary forms, with or without 12 1.1.1.5.2.2 jdolecek * modification, are permitted provided that the following conditions 13 1.1.1.5.2.2 jdolecek * are met: 14 1.1.1.5.2.2 jdolecek * 1. Redistributions of source code must retain the above copyright 15 1.1.1.5.2.2 jdolecek * notice, this list of conditions, and the following disclaimer, 16 1.1.1.5.2.2 jdolecek * without modification. 17 1.1.1.5.2.2 jdolecek * 2. Redistributions in binary form must reproduce at minimum a disclaimer 18 1.1.1.5.2.2 jdolecek * substantially similar to the "NO WARRANTY" disclaimer below 19 1.1.1.5.2.2 jdolecek * ("Disclaimer") and any redistribution must be conditioned upon 20 1.1.1.5.2.2 jdolecek * including a substantially similar Disclaimer requirement for further 21 1.1.1.5.2.2 jdolecek * binary redistribution. 22 1.1.1.5.2.2 jdolecek * 3. Neither the names of the above-listed copyright holders nor the names 23 1.1.1.5.2.2 jdolecek * of any contributors may be used to endorse or promote products derived 24 1.1.1.5.2.2 jdolecek * from this software without specific prior written permission. 25 1.1.1.5.2.2 jdolecek * 26 1.1.1.5.2.2 jdolecek * Alternatively, this software may be distributed under the terms of the 27 1.1.1.5.2.2 jdolecek * GNU General Public License ("GPL") version 2 as published by the Free 28 1.1.1.5.2.2 jdolecek * Software Foundation. 29 1.1.1.5.2.2 jdolecek * 30 1.1.1.5.2.2 jdolecek * NO WARRANTY 31 1.1.1.5.2.2 jdolecek * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 32 1.1.1.5.2.2 jdolecek * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 33 1.1.1.5.2.2 jdolecek * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 34 1.1.1.5.2.2 jdolecek * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 35 1.1.1.5.2.2 jdolecek * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 36 1.1.1.5.2.2 jdolecek * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 37 1.1.1.5.2.2 jdolecek * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 38 1.1.1.5.2.2 jdolecek * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 39 1.1.1.5.2.2 jdolecek * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 40 1.1.1.5.2.2 jdolecek * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 41 1.1.1.5.2.2 jdolecek * POSSIBILITY OF SUCH DAMAGES. 42 1.1.1.5.2.2 jdolecek */ 43 1.1.1.5.2.2 jdolecek 44 1.1.1.5.2.2 jdolecek #include "aslcompiler.h" 45 1.1.1.5.2.2 jdolecek #include "acapps.h" 46 1.1.1.5.2.2 jdolecek 47 1.1.1.5.2.2 jdolecek #define _COMPONENT ACPI_COMPILER 48 1.1.1.5.2.2 jdolecek ACPI_MODULE_NAME ("aslhelp") 49 1.1.1.5.2.2 jdolecek 50 1.1.1.5.2.2 jdolecek 51 1.1.1.5.2.2 jdolecek /******************************************************************************* 52 1.1.1.5.2.2 jdolecek * 53 1.1.1.5.2.2 jdolecek * FUNCTION: Usage 54 1.1.1.5.2.2 jdolecek * 55 1.1.1.5.2.2 jdolecek * PARAMETERS: None 56 1.1.1.5.2.2 jdolecek * 57 1.1.1.5.2.2 jdolecek * RETURN: None 58 1.1.1.5.2.2 jdolecek * 59 1.1.1.5.2.2 jdolecek * DESCRIPTION: Display option help message. 60 1.1.1.5.2.2 jdolecek * Optional items in square brackets. 61 1.1.1.5.2.2 jdolecek * 62 1.1.1.5.2.2 jdolecek ******************************************************************************/ 63 1.1.1.5.2.2 jdolecek 64 1.1.1.5.2.2 jdolecek void 65 1.1.1.5.2.2 jdolecek Usage ( 66 1.1.1.5.2.2 jdolecek void) 67 1.1.1.5.2.2 jdolecek { 68 1.1.1.5.2.2 jdolecek printf (ACPI_COMMON_SIGNON (ASL_COMPILER_NAME)); 69 1.1.1.5.2.2 jdolecek printf ("%s\n\n", ASL_COMPLIANCE); 70 1.1.1.5.2.2 jdolecek ACPI_USAGE_HEADER ("iasl [Options] [Files]"); 71 1.1.1.5.2.2 jdolecek 72 1.1.1.5.2.2 jdolecek printf ("\nGeneral:\n"); 73 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-@ <file>", "Specify command file"); 74 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-I <dir>", "Specify additional include directory"); 75 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-p <prefix>", "Specify path/filename prefix for all output files"); 76 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-v", "Display compiler version"); 77 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-vd", "Display compiler build date and time"); 78 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-vo", "Enable optimization comments"); 79 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-vs", "Disable signon"); 80 1.1.1.5.2.2 jdolecek 81 1.1.1.5.2.2 jdolecek printf ("\nHelp:\n"); 82 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-h", "This message"); 83 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-hc", "Display operators allowed in constant expressions"); 84 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-hd", "Info for obtaining and disassembling binary ACPI tables"); 85 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-hf", "Display help for output filename generation"); 86 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-hr", "Display ACPI reserved method names"); 87 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-ht", "Display currently supported ACPI table names"); 88 1.1.1.5.2.2 jdolecek 89 1.1.1.5.2.2 jdolecek printf ("\nPreprocessor:\n"); 90 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-D <symbol>", "Define symbol for preprocessor use"); 91 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-li", "Create preprocessed output file (*.i)"); 92 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-P", "Preprocess only and create preprocessor output file (*.i)"); 93 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-Pn", "Disable preprocessor"); 94 1.1.1.5.2.2 jdolecek 95 1.1.1.5.2.2 jdolecek printf ("\nErrors, Warnings, and Remarks:\n"); 96 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-va", "Disable all errors/warnings/remarks"); 97 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-ve", "Report only errors (ignore warnings and remarks)"); 98 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-vi", "Less verbose errors and warnings for use with IDEs"); 99 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-vr", "Disable remarks"); 100 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-vw <messageid>", "Ignore specific error, warning or remark"); 101 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-vx <messageid>", "Expect a specific warning, remark, or error"); 102 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-w <1|2|3>", "Set warning reporting level"); 103 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-we", "Report warnings as errors"); 104 1.1.1.5.2.2 jdolecek 105 1.1.1.5.2.2 jdolecek printf ("\nAML Bytecode Generation (*.aml):\n"); 106 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-oa", "Disable all optimizations (compatibility mode)"); 107 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-of", "Disable constant folding"); 108 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-oi", "Disable integer optimization to Zero/One/Ones"); 109 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-on", "Disable named reference string optimization"); 110 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-ot", "Disable typechecking"); 111 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-cr", "Disable Resource Descriptor error checking"); 112 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-in", "Ignore NoOp operators"); 113 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-r <revision>", "Override table header Revision (1-255)"); 114 1.1.1.5.2.2 jdolecek 115 1.1.1.5.2.2 jdolecek printf ("\nListings:\n"); 116 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-l", "Create mixed listing file (ASL source and AML) (*.lst)"); 117 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-lm", "Create hardware summary map file (*.map)"); 118 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-ln", "Create namespace file (*.nsp)"); 119 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-ls", "Create combined source file (expanded includes) (*.src)"); 120 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-lx", "Create cross-reference file (*.xrf)"); 121 1.1.1.5.2.2 jdolecek 122 1.1.1.5.2.2 jdolecek printf ("\nFirmware Support - C Text Output:\n"); 123 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-tc", "Create hex AML table in C (*.hex)"); 124 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-sc", "Create named hex AML arrays in C (*.c)"); 125 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-ic", "Create include file in C for -sc symbols (*.h)"); 126 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-so", "Create namespace AML offset table in C (*.offset.h)"); 127 1.1.1.5.2.2 jdolecek 128 1.1.1.5.2.2 jdolecek printf ("\nFirmware Support - Assembler Text Output:\n"); 129 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-ta", "Create hex AML table in assembler (*.hex)"); 130 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-sa", "Create named hex AML arrays in assembler (*.asm)"); 131 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-ia", "Create include file in assembler for -sa symbols (*.inc)"); 132 1.1.1.5.2.2 jdolecek 133 1.1.1.5.2.2 jdolecek printf ("\nFirmware Support - ASL Text Output:\n"); 134 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-ts", "Create hex AML table in ASL (Buffer object) (*.hex)"); 135 1.1.1.5.2.2 jdolecek 136 1.1.1.5.2.2 jdolecek printf ("\nLegacy-ASL to ASL+ Converter:\n"); 137 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-ca <file>", "Convert legacy-ASL source file to new ASL+ file"); 138 1.1.1.5.2.2 jdolecek ACPI_OPTION ("", " (Original comments are passed through to ASL+ file)"); 139 1.1.1.5.2.2 jdolecek 140 1.1.1.5.2.2 jdolecek printf ("\nData Table Compiler:\n"); 141 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-G", "Compile custom table that contains generic operators"); 142 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-T <sig list>|ALL", "Create ACPI table template/example files"); 143 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-T <count>", "Emit DSDT and <count> SSDTs to same file"); 144 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-vt", "Create verbose template files (full disassembly)"); 145 1.1.1.5.2.2 jdolecek 146 1.1.1.5.2.2 jdolecek printf ("\nAML Disassembler:\n"); 147 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-d <f1 f2 ...>", "Disassemble or decode binary ACPI tables to file (*.dsl)"); 148 1.1.1.5.2.2 jdolecek ACPI_OPTION ("", " (Optional, file type is automatically detected)"); 149 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-da <f1 f2 ...>", "Disassemble multiple tables from single namespace"); 150 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-db", "Do not translate Buffers to Resource Templates"); 151 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-dc <f1 f2 ...>", "Disassemble AML and immediately compile it"); 152 1.1.1.5.2.2 jdolecek ACPI_OPTION ("", " (Obtain DSDT from current system if no input file)"); 153 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-df", "Force disassembler to assume table contains valid AML"); 154 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-dl", "Emit legacy ASL code only (no C-style operators)"); 155 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-e <f1 f2 ...>", "Include ACPI table(s) for external symbol resolution"); 156 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-fe <file>", "Specify external symbol declaration file"); 157 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-in", "Ignore NoOp opcodes"); 158 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-l", "Disassemble to mixed ASL and AML code"); 159 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-vt", "Dump binary table data in hex format within output file"); 160 1.1.1.5.2.2 jdolecek 161 1.1.1.5.2.2 jdolecek printf ("\nDebug Options:\n"); 162 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-bc", "Create converter debug file (*.cdb)"); 163 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-bf", "Create debug file (full output) (*.txt)"); 164 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-bs", "Create debug file (parse tree only) (*.txt)"); 165 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-bp <depth>", "Prune ASL parse tree"); 166 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-bt <type>", "Object type to be pruned from the parse tree"); 167 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-f", "Ignore errors, force creation of AML output file(s)"); 168 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-m <size>", "Set internal line buffer size (in Kbytes)"); 169 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-n", "Parse only, no output generation"); 170 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-oc", "Display compile times and statistics"); 171 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-x <level>", "Set debug level for trace output"); 172 1.1.1.5.2.2 jdolecek ACPI_OPTION ("-z", "Do not insert new compiler ID for DataTables"); 173 1.1.1.5.2.2 jdolecek } 174 1.1.1.5.2.2 jdolecek 175 1.1.1.5.2.2 jdolecek 176 1.1.1.5.2.2 jdolecek /******************************************************************************* 177 1.1.1.5.2.2 jdolecek * 178 1.1.1.5.2.2 jdolecek * FUNCTION: FilenameHelp 179 1.1.1.5.2.2 jdolecek * 180 1.1.1.5.2.2 jdolecek * PARAMETERS: None 181 1.1.1.5.2.2 jdolecek * 182 1.1.1.5.2.2 jdolecek * RETURN: None 183 1.1.1.5.2.2 jdolecek * 184 1.1.1.5.2.2 jdolecek * DESCRIPTION: Display help message for output filename generation 185 1.1.1.5.2.2 jdolecek * 186 1.1.1.5.2.2 jdolecek ******************************************************************************/ 187 1.1.1.5.2.2 jdolecek 188 1.1.1.5.2.2 jdolecek void 189 1.1.1.5.2.2 jdolecek AslFilenameHelp ( 190 1.1.1.5.2.2 jdolecek void) 191 1.1.1.5.2.2 jdolecek { 192 1.1.1.5.2.2 jdolecek 193 1.1.1.5.2.2 jdolecek printf ("\nAML output filename generation:\n"); 194 1.1.1.5.2.2 jdolecek printf (" Output filenames are generated by appending an extension to a common\n"); 195 1.1.1.5.2.2 jdolecek printf (" filename prefix. The filename prefix is obtained via one of the\n"); 196 1.1.1.5.2.2 jdolecek printf (" following methods (in priority order):\n"); 197 1.1.1.5.2.2 jdolecek printf (" 1) The -p option specifies the prefix\n"); 198 1.1.1.5.2.2 jdolecek printf (" 2) The prefix of the AMLFileName in the ASL Definition Block\n"); 199 1.1.1.5.2.2 jdolecek printf (" 3) The prefix of the input filename\n"); 200 1.1.1.5.2.2 jdolecek printf ("\n"); 201 1.1.1.5.2.2 jdolecek } 202 1.1.1.5.2.2 jdolecek 203 1.1.1.5.2.2 jdolecek /******************************************************************************* 204 1.1.1.5.2.2 jdolecek * 205 1.1.1.5.2.2 jdolecek * FUNCTION: AslDisassemblyHelp 206 1.1.1.5.2.2 jdolecek * 207 1.1.1.5.2.2 jdolecek * PARAMETERS: None 208 1.1.1.5.2.2 jdolecek * 209 1.1.1.5.2.2 jdolecek * RETURN: None 210 1.1.1.5.2.2 jdolecek * 211 1.1.1.5.2.2 jdolecek * DESCRIPTION: Display help message for obtaining and disassembling AML/ASL 212 1.1.1.5.2.2 jdolecek * files. 213 1.1.1.5.2.2 jdolecek * 214 1.1.1.5.2.2 jdolecek ******************************************************************************/ 215 1.1.1.5.2.2 jdolecek 216 1.1.1.5.2.2 jdolecek void 217 1.1.1.5.2.2 jdolecek AslDisassemblyHelp ( 218 1.1.1.5.2.2 jdolecek void) 219 1.1.1.5.2.2 jdolecek { 220 1.1.1.5.2.2 jdolecek 221 1.1.1.5.2.2 jdolecek printf ("\nObtaining binary ACPI tables and disassembling to ASL source code.\n\n"); 222 1.1.1.5.2.2 jdolecek printf ("Use the following ACPICA toolchain:\n"); 223 1.1.1.5.2.2 jdolecek printf (" AcpiDump: Dump all ACPI tables to a hex ascii file\n"); 224 1.1.1.5.2.2 jdolecek printf (" AcpiXtract: Extract one or more binary ACPI tables from AcpiDump output\n"); 225 1.1.1.5.2.2 jdolecek printf (" iASL -d <file>: Disassemble a binary ACPI table to ASL source code\n"); 226 1.1.1.5.2.2 jdolecek printf ("\n"); 227 1.1.1.5.2.2 jdolecek } 228
Indexes created Wed Oct 01 07:09:59 GMT 2025