1/****************************************************************************** 2 * 3 * Module Name: aslmain - compiler main and utilities 4 * 5 *****************************************************************************/ 6 7/****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2016, 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#define _DECLARE_GLOBALS 117 118#include "aslcompiler.h" 119#include "acapps.h" 120#include "acdisasm.h" 121#include <signal.h> 122 123#define _COMPONENT ACPI_COMPILER 124 ACPI_MODULE_NAME ("aslmain") 125 126/* 127 * Main routine for the iASL compiler. 128 * 129 * Portability note: The compiler depends upon the host for command-line 130 * wildcard support - it is not implemented locally. For example: 131 * 132 * Linux/Unix systems: Shell expands wildcards automatically. 133 * 134 * Windows: The setargv.obj module must be linked in to automatically 135 * expand wildcards. 136 */ 137 138/* Local prototypes */ 139 140static void ACPI_SYSTEM_XFACE 141AslSignalHandler ( 142 int Sig); 143 144static void 145AslInitialize ( 146 void); 147 148 149/******************************************************************************* 150 * 151 * FUNCTION: Usage 152 * 153 * PARAMETERS: None 154 * 155 * RETURN: None 156 * 157 * DESCRIPTION: Display option help message. 158 * Optional items in square brackets. 159 * 160 ******************************************************************************/ 161 162void 163Usage ( 164 void) 165{ 166 printf ("%s\n\n", ASL_COMPLIANCE); 167 ACPI_USAGE_HEADER ("iasl [Options] [Files]"); 168 169 printf ("\nGeneral:\n"); 170 ACPI_OPTION ("-@ <file>", "Specify command file"); 171 ACPI_OPTION ("-I <dir>", "Specify additional include directory"); 172 ACPI_OPTION ("-T <sig list>|ALL", "Create ACPI table template/example files"); 173 ACPI_OPTION ("-T <count>", "Emit DSDT and <count> SSDTs to same file"); 174 ACPI_OPTION ("-p <prefix>", "Specify path/filename prefix for all output files"); 175 ACPI_OPTION ("-v", "Display compiler version"); 176 ACPI_OPTION ("-vo", "Enable optimization comments"); 177 ACPI_OPTION ("-vs", "Disable signon"); 178 179 printf ("\nHelp:\n"); 180 ACPI_OPTION ("-h", "This message"); 181 ACPI_OPTION ("-hc", "Display operators allowed in constant expressions"); 182 ACPI_OPTION ("-hf", "Display help for output filename generation"); 183 ACPI_OPTION ("-hr", "Display ACPI reserved method names"); 184 ACPI_OPTION ("-ht", "Display currently supported ACPI table names"); 185 186 printf ("\nPreprocessor:\n"); 187 ACPI_OPTION ("-D <symbol>", "Define symbol for preprocessor use"); 188 ACPI_OPTION ("-li", "Create preprocessed output file (*.i)"); 189 ACPI_OPTION ("-P", "Preprocess only and create preprocessor output file (*.i)"); 190 ACPI_OPTION ("-Pn", "Disable preprocessor"); 191 192 printf ("\nErrors, Warnings, and Remarks:\n"); 193 ACPI_OPTION ("-va", "Disable all errors/warnings/remarks"); 194 ACPI_OPTION ("-ve", "Report only errors (ignore warnings and remarks)"); 195 ACPI_OPTION ("-vi", "Less verbose errors and warnings for use with IDEs"); 196 ACPI_OPTION ("-vr", "Disable remarks"); 197 ACPI_OPTION ("-vw <messageid>", "Disable specific warning or remark"); 198 ACPI_OPTION ("-w1 -w2 -w3", "Set warning reporting level"); 199 ACPI_OPTION ("-we", "Report warnings as errors"); 200 201 printf ("\nAML Code Generation (*.aml):\n"); 202 ACPI_OPTION ("-oa", "Disable all optimizations (compatibility mode)"); 203 ACPI_OPTION ("-of", "Disable constant folding"); 204 ACPI_OPTION ("-oi", "Disable integer optimization to Zero/One/Ones"); 205 ACPI_OPTION ("-on", "Disable named reference string optimization"); 206 ACPI_OPTION ("-ot", "Disable typechecking"); 207 ACPI_OPTION ("-cr", "Disable Resource Descriptor error checking"); 208 ACPI_OPTION ("-in", "Ignore NoOp operators"); 209 ACPI_OPTION ("-r <revision>", "Override table header Revision (1-255)"); 210 211 printf ("\nOptional Source Code Output Files:\n"); 212 ACPI_OPTION ("-sc -sa", "Create source file in C or assembler (*.c or *.asm)"); 213 ACPI_OPTION ("-ic -ia", "Create include file in C or assembler (*.h or *.inc)"); 214 ACPI_OPTION ("-tc -ta -ts", "Create hex AML table in C, assembler, or ASL (*.hex)"); 215 ACPI_OPTION ("-so", "Create offset table in C (*.offset.h)"); 216 217 printf ("\nOptional Listing Files:\n"); 218 ACPI_OPTION ("-l", "Create mixed listing file (ASL source and AML) (*.lst)"); 219 ACPI_OPTION ("-lm", "Create hardware summary map file (*.map)"); 220 ACPI_OPTION ("-ln", "Create namespace file (*.nsp)"); 221 ACPI_OPTION ("-ls", "Create combined source file (expanded includes) (*.src)"); 222 ACPI_OPTION ("-lx", "Create cross-reference file (*.xrf)"); 223 224 printf ("\nData Table Compiler:\n"); 225 ACPI_OPTION ("-G", "Compile custom table that contains generic operators"); 226 ACPI_OPTION ("-vt", "Create verbose template files (full disassembly)"); 227 228 printf ("\nAML Disassembler:\n"); 229 ACPI_OPTION ("-d <f1 f2 ...>", "Disassemble or decode binary ACPI tables to file (*.dsl)"); 230 ACPI_OPTION ("", " (Optional, file type is automatically detected)"); 231 ACPI_OPTION ("-da <f1 f2 ...>", "Disassemble multiple tables from single namespace"); 232 ACPI_OPTION ("-db", "Do not translate Buffers to Resource Templates"); 233 ACPI_OPTION ("-dc <f1 f2 ...>", "Disassemble AML and immediately compile it"); 234 ACPI_OPTION ("", " (Obtain DSDT from current system if no input file)"); 235 ACPI_OPTION ("-df", "Force disassembler to assume table contains valid AML"); 236 ACPI_OPTION ("-dl", "Emit legacy ASL code only (no C-style operators)"); 237 ACPI_OPTION ("-e <f1 f2 ...>", "Include ACPI table(s) for external symbol resolution"); 238 ACPI_OPTION ("-fe <file>", "Specify external symbol declaration file"); 239 ACPI_OPTION ("-in", "Ignore NoOp opcodes"); 240 ACPI_OPTION ("-l", "Disassemble to mixed ASL and AML code"); 241 ACPI_OPTION ("-vt", "Dump binary table data in hex format within output file"); 242 243 printf ("\nDebug Options:\n"); 244 ACPI_OPTION ("-bf", "Create debug file (full output) (*.txt)"); 245 ACPI_OPTION ("-bs", "Create debug file (parse tree only) (*.txt)"); 246 ACPI_OPTION ("-bp <depth>", "Prune ASL parse tree"); 247 ACPI_OPTION ("-bt <type>", "Object type to be pruned from the parse tree"); 248 ACPI_OPTION ("-f", "Ignore errors, force creation of AML output file(s)"); 249 ACPI_OPTION ("-m <size>", "Set internal line buffer size (in Kbytes)"); 250 ACPI_OPTION ("-n", "Parse only, no output generation"); 251 ACPI_OPTION ("-oc", "Display compile times and statistics"); 252 ACPI_OPTION ("-x <level>", "Set debug level for trace output"); 253 ACPI_OPTION ("-z", "Do not insert new compiler ID for DataTables"); 254} 255 256 257/******************************************************************************* 258 * 259 * FUNCTION: FilenameHelp 260 * 261 * PARAMETERS: None 262 * 263 * RETURN: None 264 * 265 * DESCRIPTION: Display help message for output filename generation 266 * 267 ******************************************************************************/ 268 269void 270AslFilenameHelp ( 271 void) 272{ 273 274 printf ("\nAML output filename generation:\n"); 275 printf (" Output filenames are generated by appending an extension to a common\n"); 276 printf (" filename prefix. The filename prefix is obtained via one of the\n"); 277 printf (" following methods (in priority order):\n"); 278 printf (" 1) The -p option specifies the prefix\n"); 279 printf (" 2) The prefix of the AMLFileName in the ASL Definition Block\n"); 280 printf (" 3) The prefix of the input filename\n"); 281 printf ("\n"); 282} 283 284 285/****************************************************************************** 286 * 287 * FUNCTION: AslSignalHandler 288 * 289 * PARAMETERS: Sig - Signal that invoked this handler 290 * 291 * RETURN: None 292 * 293 * DESCRIPTION: Control-C handler. Delete any intermediate files and any 294 * output files that may be left in an indeterminate state. 295 * 296 *****************************************************************************/ 297 298static void ACPI_SYSTEM_XFACE 299AslSignalHandler ( 300 int Sig) 301{ 302 UINT32 i; 303 304 305 signal (Sig, SIG_IGN); 306 printf ("Aborting\n\n"); 307 308 /* Close all open files */ 309 310 Gbl_Files[ASL_FILE_PREPROCESSOR].Handle = NULL; /* the .pre file is same as source file */ 311 312 for (i = ASL_FILE_INPUT; i < ASL_MAX_FILE_TYPE; i++) 313 { 314 FlCloseFile (i); 315 } 316 317 /* Delete any output files */ 318 319 for (i = ASL_FILE_AML_OUTPUT; i < ASL_MAX_FILE_TYPE; i++) 320 { 321 FlDeleteFile (i); 322 } 323 324 exit (0); 325} 326 327 328/******************************************************************************* 329 * 330 * FUNCTION: AslInitialize 331 * 332 * PARAMETERS: None 333 * 334 * RETURN: None 335 * 336 * DESCRIPTION: Initialize compiler globals 337 * 338 ******************************************************************************/ 339 340static void 341AslInitialize ( 342 void) 343{ 344 UINT32 i; 345 346 347 AcpiGbl_DmOpt_Verbose = FALSE; 348 349 /* Default integer width is 64 bits */ 350 351 AcpiGbl_IntegerBitWidth = 64; 352 AcpiGbl_IntegerNybbleWidth = 16; 353 AcpiGbl_IntegerByteWidth = 8; 354 355 for (i = 0; i < ASL_NUM_FILES; i++) 356 { 357 Gbl_Files[i].Handle = NULL; 358 Gbl_Files[i].Filename = NULL; 359 } 360 361 Gbl_Files[ASL_FILE_STDOUT].Handle = stdout; 362 Gbl_Files[ASL_FILE_STDOUT].Filename = "STDOUT"; 363 364 Gbl_Files[ASL_FILE_STDERR].Handle = stderr; 365 Gbl_Files[ASL_FILE_STDERR].Filename = "STDERR"; 366} 367 368 369/******************************************************************************* 370 * 371 * FUNCTION: main 372 * 373 * PARAMETERS: Standard argc/argv 374 * 375 * RETURN: Program termination code 376 * 377 * DESCRIPTION: C main routine for the Asl Compiler. Handle command line 378 * options and begin the compile for each file on the command line 379 * 380 ******************************************************************************/ 381 382int ACPI_SYSTEM_XFACE 383main ( 384 int argc, 385 char **argv) 386{ 387 ACPI_STATUS Status; 388 int Index1; 389 int Index2; 390 int ReturnStatus = 0; 391 392 393 /* 394 * Big-endian machines are not currently supported. ACPI tables must 395 * be little-endian, and support for big-endian machines needs to 396 * be implemented. 397 */ 398 if (UtIsBigEndianMachine ()) 399 { 400 fprintf (stderr, 401 "iASL is not currently supported on big-endian machines.\n"); 402 return (-1); 403 } 404 405 AcpiOsInitialize (); 406 ACPI_DEBUG_INITIALIZE (); /* For debug version only */ 407 408 /* Initialize preprocessor and compiler before command line processing */ 409 410 signal (SIGINT, AslSignalHandler); 411 AcpiGbl_ExternalFileList = NULL; 412 AcpiDbgLevel = 0; 413 PrInitializePreprocessor (); 414 AslInitialize (); 415 416 Index1 = Index2 = AslCommandLine (argc, argv); 417 418 /* Allocate the line buffer(s), must be after command line */ 419 420 Gbl_LineBufferSize /= 2; 421 UtExpandLineBuffers (); 422 423 /* Perform global actions first/only */ 424 425 if (Gbl_DisassembleAll) 426 { 427 while (argv[Index1]) 428 { 429 Status = AcpiDmAddToExternalFileList (argv[Index1]); 430 if (ACPI_FAILURE (Status)) 431 { 432 return (-1); 433 } 434 435 Index1++; 436 } 437 } 438 439 /* Process each pathname/filename in the list, with possible wildcards */ 440 441 while (argv[Index2]) 442 { 443 /* 444 * If -p not specified, we will use the input filename as the 445 * output filename prefix 446 */ 447 if (Gbl_UseDefaultAmlFilename) 448 { 449 Gbl_OutputFilenamePrefix = argv[Index2]; 450 UtConvertBackslashes (Gbl_OutputFilenamePrefix); 451 } 452 453 Status = AslDoOneFile (argv[Index2]); 454 if (ACPI_FAILURE (Status)) 455 { 456 ReturnStatus = -1; 457 goto CleanupAndExit; 458 } 459 460 Index2++; 461 } 462 463 464CleanupAndExit: 465 466 UtFreeLineBuffers (); 467 AslParserCleanup (); 468 469 if (AcpiGbl_ExternalFileList) 470 { 471 AcpiDmClearExternalFileList(); 472 } 473 474 return (ReturnStatus); 475} 476