drivers/acpi/compiler/aslmain.c

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