1 /****************************************************************************** 2 * 3 * Module Name: aslmain - compiler main and utilities 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2016, Intel Corp. 9 * All rights reserved. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions, and the following disclaimer, 16 * without modification. 17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 18 * substantially similar to the "NO WARRANTY" disclaimer below 19 * ("Disclaimer") and any redistribution must be conditioned upon 20 * including a substantially similar Disclaimer requirement for further 21 * binary redistribution. 22 * 3. Neither the names of the above-listed copyright holders nor the names 23 * of any contributors may be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * Alternatively, this software may be distributed under the terms of the 27 * GNU General Public License ("GPL") version 2 as published by the Free 28 * Software Foundation. 29 * 30 * NO WARRANTY 31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 41 * POSSIBILITY OF SUCH DAMAGES. 42 */ 43 44 #define _DECLARE_GLOBALS 45 46 #include <contrib/dev/acpica/compiler/aslcompiler.h> 47 #include <contrib/dev/acpica/include/acapps.h> 48 #include <contrib/dev/acpica/include/acdisasm.h> 49 #include <signal.h> 50 51 #define _COMPONENT ACPI_COMPILER 52 ACPI_MODULE_NAME ("aslmain") 53 54 /* 55 * Main routine for the iASL compiler. 56 * 57 * Portability note: The compiler depends upon the host for command-line 58 * wildcard support - it is not implemented locally. For example: 59 * 60 * Linux/Unix systems: Shell expands wildcards automatically. 61 * 62 * Windows: The setargv.obj module must be linked in to automatically 63 * expand wildcards. 64 */ 65 66 /* Local prototypes */ 67 68 static void ACPI_SYSTEM_XFACE 69 AslSignalHandler ( 70 int Sig); 71 72 static void 73 AslInitialize ( 74 void); 75 76 77 /******************************************************************************* 78 * 79 * FUNCTION: Usage 80 * 81 * PARAMETERS: None 82 * 83 * RETURN: None 84 * 85 * DESCRIPTION: Display option help message. 86 * Optional items in square brackets. 87 * 88 ******************************************************************************/ 89 90 void 91 Usage ( 92 void) 93 { 94 printf ("%s\n\n", ASL_COMPLIANCE); 95 ACPI_USAGE_HEADER ("iasl [Options] [Files]"); 96 97 printf ("\nGeneral:\n"); 98 ACPI_OPTION ("-@ <file>", "Specify command file"); 99 ACPI_OPTION ("-I <dir>", "Specify additional include directory"); 100 ACPI_OPTION ("-T <sig list>|ALL", "Create ACPI table template/example files"); 101 ACPI_OPTION ("-T <count>", "Emit DSDT and <count> SSDTs to same file"); 102 ACPI_OPTION ("-p <prefix>", "Specify path/filename prefix for all output files"); 103 ACPI_OPTION ("-v", "Display compiler version"); 104 ACPI_OPTION ("-vo", "Enable optimization comments"); 105 ACPI_OPTION ("-vs", "Disable signon"); 106 107 printf ("\nHelp:\n"); 108 ACPI_OPTION ("-h", "This message"); 109 ACPI_OPTION ("-hc", "Display operators allowed in constant expressions"); 110 ACPI_OPTION ("-hf", "Display help for output filename generation"); 111 ACPI_OPTION ("-hr", "Display ACPI reserved method names"); 112 ACPI_OPTION ("-ht", "Display currently supported ACPI table names"); 113 114 printf ("\nPreprocessor:\n"); 115 ACPI_OPTION ("-D <symbol>", "Define symbol for preprocessor use"); 116 ACPI_OPTION ("-li", "Create preprocessed output file (*.i)"); 117 ACPI_OPTION ("-P", "Preprocess only and create preprocessor output file (*.i)"); 118 ACPI_OPTION ("-Pn", "Disable preprocessor"); 119 120 printf ("\nErrors, Warnings, and Remarks:\n"); 121 ACPI_OPTION ("-va", "Disable all errors/warnings/remarks"); 122 ACPI_OPTION ("-ve", "Report only errors (ignore warnings and remarks)"); 123 ACPI_OPTION ("-vi", "Less verbose errors and warnings for use with IDEs"); 124 ACPI_OPTION ("-vr", "Disable remarks"); 125 ACPI_OPTION ("-vw <messageid>", "Disable specific warning or remark"); 126 ACPI_OPTION ("-w1 -w2 -w3", "Set warning reporting level"); 127 ACPI_OPTION ("-we", "Report warnings as errors"); 128 129 printf ("\nAML Code Generation (*.aml):\n"); 130 ACPI_OPTION ("-oa", "Disable all optimizations (compatibility mode)"); 131 ACPI_OPTION ("-of", "Disable constant folding"); 132 ACPI_OPTION ("-oi", "Disable integer optimization to Zero/One/Ones"); 133 ACPI_OPTION ("-on", "Disable named reference string optimization"); 134 ACPI_OPTION ("-ot", "Disable typechecking"); 135 ACPI_OPTION ("-cr", "Disable Resource Descriptor error checking"); 136 ACPI_OPTION ("-in", "Ignore NoOp operators"); 137 ACPI_OPTION ("-r <revision>", "Override table header Revision (1-255)"); 138 139 printf ("\nOptional Source Code Output Files:\n"); 140 ACPI_OPTION ("-sc -sa", "Create source file in C or assembler (*.c or *.asm)"); 141 ACPI_OPTION ("-ic -ia", "Create include file in C or assembler (*.h or *.inc)"); 142 ACPI_OPTION ("-tc -ta -ts", "Create hex AML table in C, assembler, or ASL (*.hex)"); 143 ACPI_OPTION ("-so", "Create offset table in C (*.offset.h)"); 144 145 printf ("\nOptional Listing Files:\n"); 146 ACPI_OPTION ("-l", "Create mixed listing file (ASL source and AML) (*.lst)"); 147 ACPI_OPTION ("-lm", "Create hardware summary map file (*.map)"); 148 ACPI_OPTION ("-ln", "Create namespace file (*.nsp)"); 149 ACPI_OPTION ("-ls", "Create combined source file (expanded includes) (*.src)"); 150 ACPI_OPTION ("-lx", "Create cross-reference file (*.xrf)"); 151 152 printf ("\nData Table Compiler:\n"); 153 ACPI_OPTION ("-G", "Compile custom table that contains generic operators"); 154 ACPI_OPTION ("-vt", "Create verbose template files (full disassembly)"); 155 156 printf ("\nAML Disassembler:\n"); 157 ACPI_OPTION ("-d <f1 f2 ...>", "Disassemble or decode binary ACPI tables to file (*.dsl)"); 158 ACPI_OPTION ("", " (Optional, file type is automatically detected)"); 159 ACPI_OPTION ("-da <f1 f2 ...>", "Disassemble multiple tables from single namespace"); 160 ACPI_OPTION ("-db", "Do not translate Buffers to Resource Templates"); 161 ACPI_OPTION ("-dc <f1 f2 ...>", "Disassemble AML and immediately compile it"); 162 ACPI_OPTION ("", " (Obtain DSDT from current system if no input file)"); 163 ACPI_OPTION ("-df", "Force disassembler to assume table contains valid AML"); 164 ACPI_OPTION ("-dl", "Emit legacy ASL code only (no C-style operators)"); 165 ACPI_OPTION ("-e <f1 f2 ...>", "Include ACPI table(s) for external symbol resolution"); 166 ACPI_OPTION ("-fe <file>", "Specify external symbol declaration file"); 167 ACPI_OPTION ("-in", "Ignore NoOp opcodes"); 168 ACPI_OPTION ("-l", "Disassemble to mixed ASL and AML code"); 169 ACPI_OPTION ("-vt", "Dump binary table data in hex format within output file"); 170 171 printf ("\nDebug Options:\n"); 172 ACPI_OPTION ("-bf", "Create debug file (full output) (*.txt)"); 173 ACPI_OPTION ("-bs", "Create debug file (parse tree only) (*.txt)"); 174 ACPI_OPTION ("-bp <depth>", "Prune ASL parse tree"); 175 ACPI_OPTION ("-bt <type>", "Object type to be pruned from the parse tree"); 176 ACPI_OPTION ("-f", "Ignore errors, force creation of AML output file(s)"); 177 ACPI_OPTION ("-m <size>", "Set internal line buffer size (in Kbytes)"); 178 ACPI_OPTION ("-n", "Parse only, no output generation"); 179 ACPI_OPTION ("-oc", "Display compile times and statistics"); 180 ACPI_OPTION ("-x <level>", "Set debug level for trace output"); 181 ACPI_OPTION ("-z", "Do not insert new compiler ID for DataTables"); 182 } 183 184 185 /******************************************************************************* 186 * 187 * FUNCTION: FilenameHelp 188 * 189 * PARAMETERS: None 190 * 191 * RETURN: None 192 * 193 * DESCRIPTION: Display help message for output filename generation 194 * 195 ******************************************************************************/ 196 197 void 198 AslFilenameHelp ( 199 void) 200 { 201 202 printf ("\nAML output filename generation:\n"); 203 printf (" Output filenames are generated by appending an extension to a common\n"); 204 printf (" filename prefix. The filename prefix is obtained via one of the\n"); 205 printf (" following methods (in priority order):\n"); 206 printf (" 1) The -p option specifies the prefix\n"); 207 printf (" 2) The prefix of the AMLFileName in the ASL Definition Block\n"); 208 printf (" 3) The prefix of the input filename\n"); 209 printf ("\n"); 210 } 211 212 213 /****************************************************************************** 214 * 215 * FUNCTION: AslSignalHandler 216 * 217 * PARAMETERS: Sig - Signal that invoked this handler 218 * 219 * RETURN: None 220 * 221 * DESCRIPTION: Control-C handler. Delete any intermediate files and any 222 * output files that may be left in an indeterminate state. 223 * 224 *****************************************************************************/ 225 226 static void ACPI_SYSTEM_XFACE 227 AslSignalHandler ( 228 int Sig) 229 { 230 UINT32 i; 231 232 233 signal (Sig, SIG_IGN); 234 printf ("Aborting\n\n"); 235 236 /* Close all open files */ 237 238 Gbl_Files[ASL_FILE_PREPROCESSOR].Handle = NULL; /* the .pre file is same as source file */ 239 240 for (i = ASL_FILE_INPUT; i < ASL_MAX_FILE_TYPE; i++) 241 { 242 FlCloseFile (i); 243 } 244 245 /* Delete any output files */ 246 247 for (i = ASL_FILE_AML_OUTPUT; i < ASL_MAX_FILE_TYPE; i++) 248 { 249 FlDeleteFile (i); 250 } 251 252 exit (0); 253 } 254 255 256 /******************************************************************************* 257 * 258 * FUNCTION: AslInitialize 259 * 260 * PARAMETERS: None 261 * 262 * RETURN: None 263 * 264 * DESCRIPTION: Initialize compiler globals 265 * 266 ******************************************************************************/ 267 268 static void 269 AslInitialize ( 270 void) 271 { 272 UINT32 i; 273 274 275 AcpiGbl_DmOpt_Verbose = FALSE; 276 277 /* Default integer width is 64 bits */ 278 279 AcpiGbl_IntegerBitWidth = 64; 280 AcpiGbl_IntegerNybbleWidth = 16; 281 AcpiGbl_IntegerByteWidth = 8; 282 283 for (i = 0; i < ASL_NUM_FILES; i++) 284 { 285 Gbl_Files[i].Handle = NULL; 286 Gbl_Files[i].Filename = NULL; 287 } 288 289 Gbl_Files[ASL_FILE_STDOUT].Handle = stdout; 290 Gbl_Files[ASL_FILE_STDOUT].Filename = "STDOUT"; 291 292 Gbl_Files[ASL_FILE_STDERR].Handle = stderr; 293 Gbl_Files[ASL_FILE_STDERR].Filename = "STDERR"; 294 } 295 296 297 /******************************************************************************* 298 * 299 * FUNCTION: main 300 * 301 * PARAMETERS: Standard argc/argv 302 * 303 * RETURN: Program termination code 304 * 305 * DESCRIPTION: C main routine for the Asl Compiler. Handle command line 306 * options and begin the compile for each file on the command line 307 * 308 ******************************************************************************/ 309 310 int ACPI_SYSTEM_XFACE 311 main ( 312 int argc, 313 char **argv) 314 { 315 ACPI_STATUS Status; 316 int Index1; 317 int Index2; 318 int ReturnStatus = 0; 319 320 321 /* 322 * Big-endian machines are not currently supported. ACPI tables must 323 * be little-endian, and support for big-endian machines needs to 324 * be implemented. 325 */ 326 if (UtIsBigEndianMachine ()) 327 { 328 fprintf (stderr, 329 "iASL is not currently supported on big-endian machines.\n"); 330 return (-1); 331 } 332 333 AcpiOsInitialize (); 334 ACPI_DEBUG_INITIALIZE (); /* For debug version only */ 335 336 /* Initialize preprocessor and compiler before command line processing */ 337 338 signal (SIGINT, AslSignalHandler); 339 AcpiGbl_ExternalFileList = NULL; 340 AcpiDbgLevel = 0; 341 PrInitializePreprocessor (); 342 AslInitialize (); 343 344 Index1 = Index2 = AslCommandLine (argc, argv); 345 346 /* Allocate the line buffer(s), must be after command line */ 347 348 Gbl_LineBufferSize /= 2; 349 UtExpandLineBuffers (); 350 351 /* Perform global actions first/only */ 352 353 if (Gbl_DisassembleAll) 354 { 355 while (argv[Index1]) 356 { 357 Status = AcpiDmAddToExternalFileList (argv[Index1]); 358 if (ACPI_FAILURE (Status)) 359 { 360 return (-1); 361 } 362 363 Index1++; 364 } 365 } 366 367 /* Process each pathname/filename in the list, with possible wildcards */ 368 369 while (argv[Index2]) 370 { 371 /* 372 * If -p not specified, we will use the input filename as the 373 * output filename prefix 374 */ 375 if (Gbl_UseDefaultAmlFilename) 376 { 377 Gbl_OutputFilenamePrefix = argv[Index2]; 378 UtConvertBackslashes (Gbl_OutputFilenamePrefix); 379 } 380 381 Status = AslDoOneFile (argv[Index2]); 382 if (ACPI_FAILURE (Status)) 383 { 384 ReturnStatus = -1; 385 goto CleanupAndExit; 386 } 387 388 Index2++; 389 } 390 391 392 CleanupAndExit: 393 394 UtFreeLineBuffers (); 395 AslParserCleanup (); 396 397 if (AcpiGbl_ExternalFileList) 398 { 399 AcpiDmClearExternalFileList(); 400 } 401 402 return (ReturnStatus); 403 } 404