sys/contrib/dev/acpica-unix/tools/acpiexec/aemain.c

   1 /******************************************************************************
   2  *
   3  * Module Name: aemain - Main routine for the AcpiExec utility
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2009, 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 #include "aecommon.h"
 117
 118 #ifdef _DEBUG
 119 #include <crtdbg.h>
 120 #endif
 121
 122 #define _COMPONENT          PARSER
 123         ACPI_MODULE_NAME    ("aemain")
 124
 125 UINT8           AcpiGbl_BatchMode = 0;
 126 BOOLEAN         AcpiGbl_IgnoreErrors = FALSE;
 127 BOOLEAN         AcpiGbl_DbOpt_NoRegionSupport = FALSE;
 128 BOOLEAN         AcpiGbl_DebugTimeout = FALSE;
 129 char            BatchBuffer[128];
 130
 131
 132 /******************************************************************************
 133  *
 134  * FUNCTION:    usage
 135  *
 136  * PARAMETERS:  None
 137  *
 138  * RETURN:      None
 139  *
 140  * DESCRIPTION: Print a usage message
 141  *
 142  *****************************************************************************/
 143
 144 static void
 145 usage (void)
 146 {
 147     printf ("Usage: acpiexec [Options] [InputFile]\n\n");
 148
 149     printf ("Where:\n");
 150     printf ("   -?                  Display this message\n");
 151     printf ("   -a                  Do not abort methods on error\n");
 152     printf ("   -b <CommandLine>    Batch mode command execution\n");
 153     printf ("   -e [Method]         Batch mode method execution\n");
 154     printf ("   -i                  Do not run STA/INI methods during init\n");
 155     printf ("   -m                  Display final memory use statistics\n");
 156     printf ("   -o <OutputFile>     Send output to this file\n");
 157     printf ("   -r                  Disable OpRegion address simulation\n");
 158     printf ("   -s                  Enable Interpreter Slack Mode\n");
 159     printf ("   -t                  Enable Interpreter Serialized Mode\n");
 160     printf ("   -v                  Verbose init output\n");
 161     printf ("   -x <DebugLevel>     Specify debug output level\n");
 162     printf ("   -z                  Enable debug semaphore timeout\n");
 163 }
 164
 165
 166 /******************************************************************************
 167  *
 168  * FUNCTION:    AcpiDbRunBatchMode
 169  *
 170  * PARAMETERS:  BatchCommandLine    - A semicolon separated list of commands
 171  *                                    to be executed.
 172  *                                    Use only commas to separate elements of
 173  *                                    particular command.
 174  * RETURN:      Status
 175  *
 176  * DESCRIPTION: For each command of list separated by ';' prepare the command
 177  *              buffer and pass it to AcpiDbCommandDispatch.
 178  *
 179  *****************************************************************************/
 180
 181 static ACPI_STATUS
 182 AcpiDbRunBatchMode (
 183     void)
 184 {
 185     ACPI_STATUS             Status;
 186     char                    *Ptr = BatchBuffer;
 187     char                    *Cmd = Ptr;
 188     UINT8                   Run = 0;
 189
 190     AcpiGbl_MethodExecuting = FALSE;
 191     AcpiGbl_StepToNextCall = FALSE;
 192
 193     while (*Ptr)
 194     {
 195         if (*Ptr == ',')
 196         {
 197             /* Convert commas to spaces */
 198             *Ptr = ' ';
 199         }
 200         else if (*Ptr == ';')
 201         {
 202             *Ptr = '\0';
 203             Run = 1;
 204         }
 205
 206         Ptr++;
 207
 208         if (Run || (*Ptr == '\0'))
 209         {
 210             (void) AcpiDbCommandDispatch (Cmd, NULL, NULL);
 211             Run = 0;
 212             Cmd = Ptr;
 213         }
 214     }
 215
 216     Status = AcpiTerminate ();
 217     return (Status);
 218 }
 219
 220
 221 /******************************************************************************
 222  *
 223  * FUNCTION:    main
 224  *
 225  * PARAMETERS:  argc, argv
 226  *
 227  * RETURN:      Status
 228  *
 229  * DESCRIPTION: Main routine for AcpiDump utility
 230  *
 231  *****************************************************************************/
 232
 233 int ACPI_SYSTEM_XFACE
 234 main (
 235     int                     argc,
 236     char                    **argv)
 237 {
 238     int                     j;
 239     ACPI_STATUS             Status;
 240     UINT32                  InitFlags;
 241     ACPI_TABLE_HEADER       *Table;
 242
 243
 244 #ifdef _DEBUG
 245     _CrtSetDbgFlag (_CRTDBG_CHECK_ALWAYS_DF | _CRTDBG_LEAK_CHECK_DF |
 246                     _CrtSetDbgFlag(_CRTDBG_REPORT_FLAG));
 247 #endif
 248
 249     printf ("\nIntel ACPI Component Architecture\nAML Execution/Debug Utility");
 250     printf (" version %8.8X", ((UINT32) ACPI_CA_VERSION));
 251     printf (" [%s]\n\n",  __DATE__);
 252
 253     if (argc < 2)
 254     {
 255         usage ();
 256         return 0;
 257     }
 258
 259     signal (SIGINT, AeCtrlCHandler);
 260
 261     /* Init globals */
 262
 263     AcpiDbgLevel = ACPI_NORMAL_DEFAULT;
 264     AcpiDbgLayer = 0xFFFFFFFF;
 265
 266     /* Init ACPI and start debugger thread */
 267
 268     AcpiInitializeSubsystem ();
 269
 270     /* Get the command line options */
 271
 272     while ((j = AcpiGetopt (argc, argv, "?ab:de^gimo:rstvx:z")) != EOF) switch(j)
 273     {
 274     case 'a':
 275         AcpiGbl_IgnoreErrors = TRUE;
 276         break;
 277
 278     case 'b':
 279         if (strlen (AcpiGbl_Optarg) > 127)
 280         {
 281             printf ("**** The length of command line (%u) exceeded maximum (127)\n",
 282                 (UINT32) strlen (AcpiGbl_Optarg));
 283             return -1;
 284         }
 285         AcpiGbl_BatchMode = 1;
 286         strcpy (BatchBuffer, AcpiGbl_Optarg);
 287         break;
 288
 289     case 'd':
 290         AcpiGbl_DbOpt_disasm = TRUE;
 291         AcpiGbl_DbOpt_stats = TRUE;
 292         break;
 293
 294     case 'e':
 295         AcpiGbl_BatchMode = 2;
 296         switch (AcpiGbl_Optarg[0])
 297         {
 298         case '^':
 299             strcpy (BatchBuffer, "MAIN");
 300             break;
 301         default:
 302             strcpy (BatchBuffer, AcpiGbl_Optarg);
 303             break;
 304         }
 305         break;
 306
 307     case 'g':
 308         AcpiGbl_DbOpt_tables = TRUE;
 309         AcpiGbl_DbFilename = NULL;
 310         break;
 311
 312     case 'i':
 313         AcpiGbl_DbOpt_ini_methods = FALSE;
 314         break;
 315
 316     case 'm':
 317 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
 318         AcpiGbl_DisplayFinalMemStats = TRUE;
 319 #endif
 320         break;
 321
 322     case 'o':
 323         printf ("O option is not implemented\n");
 324         break;
 325
 326     case 'r':
 327         AcpiGbl_DbOpt_NoRegionSupport = TRUE;
 328         break;
 329
 330     case 's':
 331         AcpiGbl_EnableInterpreterSlack = TRUE;
 332         printf ("Enabling AML Interpreter slack mode\n");
 333         break;
 334
 335     case 't':
 336         AcpiGbl_AllMethodsSerialized = TRUE;
 337         printf ("Enabling AML Interpreter serialized mode\n");
 338         break;
 339
 340     case 'v':
 341         AcpiDbgLevel |= ACPI_LV_INIT_NAMES;
 342         break;
 343
 344     case 'x':
 345         AcpiDbgLevel = strtoul (AcpiGbl_Optarg, NULL, 0);
 346         AcpiGbl_DbConsoleDebugLevel = AcpiDbgLevel;
 347         printf ("Debug Level: 0x%8.8X\n", AcpiDbgLevel);
 348         break;
 349
 350     case 'z':
 351         AcpiGbl_DebugTimeout = TRUE;
 352         break;
 353
 354     case '?':
 355     default:
 356         usage();
 357         return -1;
 358     }
 359
 360
 361     InitFlags = (ACPI_NO_HANDLER_INIT | ACPI_NO_ACPI_ENABLE);
 362     if (!AcpiGbl_DbOpt_ini_methods)
 363     {
 364         InitFlags |= (ACPI_NO_DEVICE_INIT | ACPI_NO_OBJECT_INIT);
 365     }
 366
 367     /* Standalone filename is the only argument */
 368
 369     if (argv[AcpiGbl_Optind])
 370     {
 371         AcpiGbl_DbOpt_tables = TRUE;
 372         AcpiGbl_DbFilename = argv[AcpiGbl_Optind];
 373
 374         Status = AcpiDbReadTableFromFile (AcpiGbl_DbFilename, &Table);
 375         if (ACPI_FAILURE (Status))
 376         {
 377             printf ("**** Could not get input table, %s\n", AcpiFormatException (Status));
 378             goto enterloop;
 379         }
 380
 381         AeBuildLocalTables (Table);
 382         Status = AeInstallTables ();
 383         if (ACPI_FAILURE (Status))
 384         {
 385             printf ("**** Could not load ACPI tables, %s\n", AcpiFormatException (Status));
 386             goto enterloop;
 387         }
 388
 389         Status = AeInstallHandlers ();
 390         if (ACPI_FAILURE (Status))
 391         {
 392             goto enterloop;
 393         }
 394
 395         /*
 396          * TBD:
 397          * Need a way to call this after the "LOAD" command
 398          */
 399         Status = AcpiEnableSubsystem (InitFlags);
 400         if (ACPI_FAILURE (Status))
 401         {
 402             printf ("**** Could not EnableSubsystem, %s\n", AcpiFormatException (Status));
 403             goto enterloop;
 404         }
 405
 406         Status = AcpiInitializeObjects (InitFlags);
 407         if (ACPI_FAILURE (Status))
 408         {
 409             printf ("**** Could not InitializeObjects, %s\n", AcpiFormatException (Status));
 410             goto enterloop;
 411         }
 412
 413         AeMiscellaneousTests ();
 414     }
 415
 416 enterloop:
 417
 418     if (AcpiGbl_BatchMode == 1)
 419     {
 420         AcpiDbRunBatchMode ();
 421     }
 422     else if (AcpiGbl_BatchMode == 2)
 423     {
 424         AcpiDbExecute (BatchBuffer, NULL, EX_NO_SINGLE_STEP);
 425     }
 426     else
 427     {
 428         /* Enter the debugger command loop */
 429
 430         AcpiDbUserCommands (ACPI_DEBUGGER_COMMAND_PROMPT, NULL);
 431     }
 432
 433     return 0;
 434 }
 435