sys/contrib/dev/acpica/source/tools/acpinames/anmain.c

   1 /******************************************************************************
   2  *
   3  * Module Name: anmain - Main routine for the AcpiNames utility
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2019, 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  * Alternatively, you may choose to be licensed under the terms of the
 117  * following license:
 118  *
 119  * Redistribution and use in source and binary forms, with or without
 120  * modification, are permitted provided that the following conditions
 121  * are met:
 122  * 1. Redistributions of source code must retain the above copyright
 123  *    notice, this list of conditions, and the following disclaimer,
 124  *    without modification.
 125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 126  *    substantially similar to the "NO WARRANTY" disclaimer below
 127  *    ("Disclaimer") and any redistribution must be conditioned upon
 128  *    including a substantially similar Disclaimer requirement for further
 129  *    binary redistribution.
 130  * 3. Neither the names of the above-listed copyright holders nor the names
 131  *    of any contributors may be used to endorse or promote products derived
 132  *    from this software without specific prior written permission.
 133  *
 134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 145  *
 146  * Alternatively, you may choose to be licensed under the terms of the
 147  * GNU General Public License ("GPL") version 2 as published by the Free
 148  * Software Foundation.
 149  *
 150  *****************************************************************************/
 151
 152 #include "acpinames.h"
 153 #include "actables.h"
 154 #include "errno.h"
 155
 156 #define _COMPONENT          ACPI_TOOLS
 157         ACPI_MODULE_NAME    ("anmain")
 158
 159
 160 /* Local prototypes */
 161
 162 static int
 163 AnDumpEntireNamespace (
 164     ACPI_NEW_TABLE_DESC     *ListHead);
 165
 166
 167 /*
 168  * Main routine for the ACPI user-space namespace utility.
 169  *
 170  * Portability note: The utility depends upon the host for command-line
 171  * wildcard support - it is not implemented locally. For example:
 172  *
 173  * Linux/Unix systems: Shell expands wildcards automatically.
 174  *
 175  * Windows: The setargv.obj module must be linked in to automatically
 176  * expand wildcards.
 177  */
 178 BOOLEAN                     AcpiGbl_NsLoadOnly = FALSE;
 179
 180
 181 #define AN_UTILITY_NAME             "ACPI Namespace Dump Utility"
 182 #define AN_SUPPORTED_OPTIONS        "?hlv^x:"
 183
 184
 185 /******************************************************************************
 186  *
 187  * FUNCTION:    usage
 188  *
 189  * PARAMETERS:  None
 190  *
 191  * RETURN:      None
 192  *
 193  * DESCRIPTION: Print a usage message
 194  *
 195  *****************************************************************************/
 196
 197 static void
 198 usage (
 199     void)
 200 {
 201
 202     ACPI_USAGE_HEADER ("AcpiNames [options] AMLfile");
 203     ACPI_OPTION ("-?",                  "Display this message");
 204     ACPI_OPTION ("-l",                  "Load namespace only, no display");
 205     ACPI_OPTION ("-v",                  "Display version information");
 206     ACPI_OPTION ("-vd",                 "Display build date and time");
 207     ACPI_OPTION ("-x <DebugLevel>",     "Debug output level");
 208 }
 209
 210
 211 /******************************************************************************
 212  *
 213  * FUNCTION:    main
 214  *
 215  * PARAMETERS:  argc, argv
 216  *
 217  * RETURN:      Status (pass/fail)
 218  *
 219  * DESCRIPTION: Main routine for NsDump utility
 220  *
 221  *****************************************************************************/
 222
 223 int ACPI_SYSTEM_XFACE
 224 main (
 225     int                     argc,
 226     char                    **argv)
 227 {
 228     ACPI_NEW_TABLE_DESC     *ListHead = NULL;
 229     ACPI_STATUS             Status;
 230     int                     j;
 231
 232
 233     ACPI_DEBUG_INITIALIZE (); /* For debug version only */
 234
 235     /* Init debug globals and ACPICA */
 236
 237     AcpiDbgLevel = ACPI_NORMAL_DEFAULT | ACPI_LV_TABLES;
 238     AcpiDbgLayer = 0xFFFFFFFF;
 239
 240     /* Set flags so that the interpreter is not used */
 241
 242     Status = AcpiInitializeSubsystem ();
 243     ACPI_CHECK_OK (AcpiInitializeSubsystem, Status);
 244     if (ACPI_FAILURE (Status))
 245     {
 246         return (-1);
 247     }
 248
 249     printf (ACPI_COMMON_SIGNON (AN_UTILITY_NAME));
 250     if (argc < 2)
 251     {
 252         usage ();
 253         return (0);
 254     }
 255
 256     /* Get the command line options */
 257
 258     while ((j = AcpiGetopt (argc, argv, AN_SUPPORTED_OPTIONS)) != ACPI_OPT_END) switch(j)
 259     {
 260     case 'l':
 261
 262         AcpiGbl_NsLoadOnly = TRUE;
 263         break;
 264
 265     case 'v':
 266
 267         switch (AcpiGbl_Optarg[0])
 268         {
 269         case '^':  /* -v: (Version): signon already emitted, just exit */
 270
 271             exit (0);
 272
 273         case 'd':
 274
 275             printf (ACPI_COMMON_BUILD_TIME);
 276             return (0);
 277
 278         default:
 279
 280             printf ("Unknown option: -v%s\n", AcpiGbl_Optarg);
 281             return (-1);
 282         }
 283         break;
 284
 285     case 'x':
 286
 287         AcpiDbgLevel = strtoul (AcpiGbl_Optarg, NULL, 0);
 288         printf ("Debug Level: 0x%8.8X\n", AcpiDbgLevel);
 289         break;
 290
 291     case '?':
 292     case 'h':
 293     default:
 294
 295         usage();
 296         return (0);
 297     }
 298
 299     /* Get each of the ACPI table files on the command line */
 300
 301     while (argv[AcpiGbl_Optind])
 302     {
 303         /* Get all ACPI AML tables in this file */
 304
 305         Status = AcGetAllTablesFromFile (argv[AcpiGbl_Optind],
 306             ACPI_GET_ALL_TABLES, &ListHead);
 307         if (ACPI_FAILURE (Status))
 308         {
 309             return (-1);
 310         }
 311
 312         AcpiGbl_Optind++;
 313     }
 314
 315     printf ("\n");
 316
 317     /*
 318      * The next argument is the filename for the DSDT or SSDT.
 319      * Open the file, build namespace and dump it.
 320      */
 321     return (AnDumpEntireNamespace (ListHead));
 322 }
 323
 324
 325 /******************************************************************************
 326  *
 327  * FUNCTION:    AnDumpEntireNamespace
 328  *
 329  * PARAMETERS:  AmlFilename         - Filename for DSDT or SSDT AML table
 330  *
 331  * RETURN:      Status (pass/fail)
 332  *
 333  * DESCRIPTION: Build an ACPI namespace for the input AML table, and dump the
 334  *              formatted namespace contents.
 335  *
 336  *****************************************************************************/
 337
 338 static int
 339 AnDumpEntireNamespace (
 340     ACPI_NEW_TABLE_DESC     *ListHead)
 341 {
 342     ACPI_STATUS             Status;
 343     ACPI_HANDLE             Handle;
 344
 345
 346     /*
 347      * Build a local XSDT with all tables. Normally, here is where the
 348      * RSDP search is performed to find the ACPI tables
 349      */
 350     Status = AnBuildLocalTables (ListHead);
 351     if (ACPI_FAILURE (Status))
 352     {
 353         return (-1);
 354     }
 355
 356     /* Initialize table manager, get XSDT */
 357
 358     Status = AcpiInitializeTables (NULL, ACPI_MAX_INIT_TABLES, TRUE);
 359     if (ACPI_FAILURE (Status))
 360     {
 361         printf ("**** Could not initialize ACPI table manager, %s\n",
 362             AcpiFormatException (Status));
 363         return (-1);
 364     }
 365
 366     /* Build the namespace from the tables */
 367
 368     Status = AcpiLoadTables ();
 369     if (Status == AE_CTRL_TERMINATE)
 370     {
 371         /* At least one table load failed -- terminate with error */
 372
 373         return (-1);
 374     }
 375
 376     if (ACPI_FAILURE (Status))
 377     {
 378         printf ("**** While creating namespace, %s\n",
 379             AcpiFormatException (Status));
 380         return (-1);
 381     }
 382
 383     if (AcpiGbl_NsLoadOnly)
 384     {
 385         printf ("**** Namespace successfully loaded\n");
 386         return (0);
 387     }
 388
 389     /*
 390      * NOTE:
 391      * We don't need to do any further ACPICA initialization, since we don't
 392      * have any hardware, nor is the interpreter configured.
 393      *
 394      * Namely, we don't need these calls:
 395      *  AcpiEnableSubsystem
 396      *  AcpiInitializeObjects
 397      */
 398
 399
 400     /*
 401      * Perform a namespace walk to dump the contents
 402      */
 403     AcpiOsPrintf ("\nACPI Namespace:\n");
 404
 405     AcpiNsDumpObjects (ACPI_TYPE_ANY, ACPI_DISPLAY_SUMMARY,
 406         ACPI_UINT32_MAX, ACPI_OWNER_ID_MAX, AcpiGbl_RootNode);
 407
 408
 409     /* Example: get a handle to the _GPE scope */
 410
 411     Status = AcpiGetHandle (NULL, "\\_GPE", &Handle);
 412     ACPI_CHECK_OK (AcpiGetHandle, Status);
 413
 414     AcDeleteTableList (ListHead);
 415     return (0);
 416 }