1 /******************************************************************************
3 * Module Name: anmain - Main routine for the AcpiNames utility
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2019, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
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.
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.
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.
150 *****************************************************************************/
152 #include "acpinames.h"
153 #include "actables.h"
156 #define _COMPONENT ACPI_TOOLS
157 ACPI_MODULE_NAME ("anmain")
160 /* Local prototypes */
163 AnDumpEntireNamespace (
164 ACPI_NEW_TABLE_DESC *ListHead);
168 * Main routine for the ACPI user-space namespace utility.
170 * Portability note: The utility depends upon the host for command-line
171 * wildcard support - it is not implemented locally. For example:
173 * Linux/Unix systems: Shell expands wildcards automatically.
175 * Windows: The setargv.obj module must be linked in to automatically
178 BOOLEAN AcpiGbl_NsLoadOnly = FALSE;
181 #define AN_UTILITY_NAME "ACPI Namespace Dump Utility"
182 #define AN_SUPPORTED_OPTIONS "?hlv^x:"
185 /******************************************************************************
193 * DESCRIPTION: Print a usage message
195 *****************************************************************************/
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");
211 /******************************************************************************
215 * PARAMETERS: argc, argv
217 * RETURN: Status (pass/fail)
219 * DESCRIPTION: Main routine for NsDump utility
221 *****************************************************************************/
223 int ACPI_SYSTEM_XFACE
228 ACPI_NEW_TABLE_DESC *ListHead = NULL;
233 ACPI_DEBUG_INITIALIZE (); /* For debug version only */
235 /* Init debug globals and ACPICA */
237 AcpiDbgLevel = ACPI_NORMAL_DEFAULT | ACPI_LV_TABLES;
238 AcpiDbgLayer = 0xFFFFFFFF;
240 /* Set flags so that the interpreter is not used */
242 AcpiGbl_ExecuteTablesAsMethods = FALSE;
244 Status = AcpiInitializeSubsystem ();
245 ACPI_CHECK_OK (AcpiInitializeSubsystem, Status);
246 if (ACPI_FAILURE (Status))
251 printf (ACPI_COMMON_SIGNON (AN_UTILITY_NAME));
258 /* Get the command line options */
260 while ((j = AcpiGetopt (argc, argv, AN_SUPPORTED_OPTIONS)) != ACPI_OPT_END) switch(j)
264 AcpiGbl_NsLoadOnly = TRUE;
269 switch (AcpiGbl_Optarg[0])
271 case '^': /* -v: (Version): signon already emitted, just exit */
277 printf (ACPI_COMMON_BUILD_TIME);
282 printf ("Unknown option: -v%s\n", AcpiGbl_Optarg);
289 AcpiDbgLevel = strtoul (AcpiGbl_Optarg, NULL, 0);
290 printf ("Debug Level: 0x%8.8X\n", AcpiDbgLevel);
301 /* Get each of the ACPI table files on the command line */
303 while (argv[AcpiGbl_Optind])
305 /* Get all ACPI AML tables in this file */
307 Status = AcGetAllTablesFromFile (argv[AcpiGbl_Optind],
308 ACPI_GET_ALL_TABLES, &ListHead);
309 if (ACPI_FAILURE (Status))
320 * The next argument is the filename for the DSDT or SSDT.
321 * Open the file, build namespace and dump it.
323 return (AnDumpEntireNamespace (ListHead));
327 /******************************************************************************
329 * FUNCTION: AnDumpEntireNamespace
331 * PARAMETERS: AmlFilename - Filename for DSDT or SSDT AML table
333 * RETURN: Status (pass/fail)
335 * DESCRIPTION: Build an ACPI namespace for the input AML table, and dump the
336 * formatted namespace contents.
338 *****************************************************************************/
341 AnDumpEntireNamespace (
342 ACPI_NEW_TABLE_DESC *ListHead)
349 * Build a local XSDT with all tables. Normally, here is where the
350 * RSDP search is performed to find the ACPI tables
352 Status = AnBuildLocalTables (ListHead);
353 if (ACPI_FAILURE (Status))
358 /* Initialize table manager, get XSDT */
360 Status = AcpiInitializeTables (NULL, ACPI_MAX_INIT_TABLES, TRUE);
361 if (ACPI_FAILURE (Status))
363 printf ("**** Could not initialize ACPI table manager, %s\n",
364 AcpiFormatException (Status));
368 /* Build the namespace from the tables */
370 Status = AcpiLoadTables ();
371 if (Status == AE_CTRL_TERMINATE)
373 /* At least one table load failed -- terminate with error */
378 if (ACPI_FAILURE (Status))
380 printf ("**** While creating namespace, %s\n",
381 AcpiFormatException (Status));
385 if (AcpiGbl_NsLoadOnly)
387 printf ("**** Namespace successfully loaded\n");
393 * We don't need to do any further ACPICA initialization, since we don't
394 * have any hardware, nor is the interpreter configured.
396 * Namely, we don't need these calls:
397 * AcpiEnableSubsystem
398 * AcpiInitializeObjects
403 * Perform a namespace walk to dump the contents
405 AcpiOsPrintf ("\nACPI Namespace:\n");
407 AcpiNsDumpObjects (ACPI_TYPE_ANY, ACPI_DISPLAY_SUMMARY,
408 ACPI_UINT32_MAX, ACPI_OWNER_ID_MAX, AcpiGbl_RootNode);
411 /* Example: get a handle to the _GPE scope */
413 Status = AcpiGetHandle (NULL, "\\_GPE", &Handle);
414 ACPI_CHECK_OK (AcpiGetHandle, Status);
416 AcDeleteTableList (ListHead);