1 /*******************************************************************************
3 * Module Name: dmnames - AML disassembler, names, namestrings, pathnames
5 ******************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2018, 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 <contrib/dev/acpica/include/acpi.h>
153 #include <contrib/dev/acpica/include/accommon.h>
154 #include <contrib/dev/acpica/include/amlcode.h>
155 #include <contrib/dev/acpica/include/acnamesp.h>
156 #include <contrib/dev/acpica/include/acdisasm.h>
159 #define _COMPONENT ACPI_CA_DEBUGGER
160 ACPI_MODULE_NAME ("dmnames")
162 /* Local prototypes */
164 #ifdef ACPI_OBSOLETE_FUNCTIONS
167 ACPI_PARSE_OBJECT *Op);
171 /*******************************************************************************
173 * FUNCTION: AcpiDmDumpName
175 * PARAMETERS: Name - 4 character ACPI name
177 * RETURN: Final length of name
179 * DESCRIPTION: Dump an ACPI name, minus any trailing underscores.
181 ******************************************************************************/
192 /* Copy name locally in case the original name is not writeable */
194 *ACPI_CAST_PTR (UINT32, &NewName[0]) = Name;
196 /* Ensure that the name is printable, even if we have to fix it */
198 AcpiUtRepairName (NewName);
200 /* Remove all trailing underscores from the name */
202 Length = ACPI_NAME_SIZE;
203 for (i = (ACPI_NAME_SIZE - 1); i != 0; i--)
205 if (NewName[i] == '_')
215 /* Dump the name, up to the start of the trailing underscores */
217 for (i = 0; i < Length; i++)
219 AcpiOsPrintf ("%c", NewName[i]);
226 /*******************************************************************************
228 * FUNCTION: AcpiPsDisplayObjectPathname
230 * PARAMETERS: WalkState - Current walk state
231 * Op - Object whose pathname is to be obtained
235 * DESCRIPTION: Diplay the pathname associated with a named object. Two
236 * versions. One searches the parse tree (for parser-only
237 * applications suchas AcpiDump), and the other searches the
238 * ACPI namespace (the parse tree is probably deleted)
240 ******************************************************************************/
243 AcpiPsDisplayObjectPathname (
244 ACPI_WALK_STATE *WalkState,
245 ACPI_PARSE_OBJECT *Op)
248 ACPI_NAMESPACE_NODE *Node;
253 /* Save current debug level so we don't get extraneous debug output */
255 DebugLevel = AcpiDbgLevel;
258 /* Just get the Node out of the Op object */
260 Node = Op->Common.Node;
263 /* Node not defined in this scope, look it up */
265 Status = AcpiNsLookup (WalkState->ScopeInfo, Op->Common.Value.String,
266 ACPI_TYPE_ANY, ACPI_IMODE_EXECUTE, ACPI_NS_SEARCH_PARENT,
269 if (ACPI_FAILURE (Status))
272 * We can't get the pathname since the object is not in the
273 * namespace. This can happen during single stepping
274 * where a dynamic named object is *about* to be created.
276 AcpiOsPrintf (" [Path not found]");
280 /* Save it for next time. */
282 Op->Common.Node = Node;
285 /* Convert NamedDesc/handle to a full pathname */
287 Buffer.Length = ACPI_ALLOCATE_LOCAL_BUFFER;
288 Status = AcpiNsHandleToPathname (Node, &Buffer, FALSE);
289 if (ACPI_FAILURE (Status))
291 AcpiOsPrintf ("****Could not get pathname****)");
295 AcpiOsPrintf (" (Path %s)", (char *) Buffer.Pointer);
296 ACPI_FREE (Buffer.Pointer);
300 /* Restore the debug level */
302 AcpiDbgLevel = DebugLevel;
307 /*******************************************************************************
309 * FUNCTION: AcpiDmNamestring
311 * PARAMETERS: Name - ACPI Name string to store
315 * DESCRIPTION: Decode and dump an ACPI namestring. Handles prefix characters
317 ******************************************************************************/
331 /* Handle all Scope Prefix operators */
333 while (ACPI_IS_ROOT_PREFIX (ACPI_GET8 (Name)) ||
334 ACPI_IS_PARENT_PREFIX (ACPI_GET8 (Name)))
336 /* Append prefix character */
338 AcpiOsPrintf ("%1c", ACPI_GET8 (Name));
342 switch (ACPI_GET8 (Name))
349 case AML_DUAL_NAME_PREFIX:
355 case AML_MULTI_NAME_PREFIX:
357 SegCount = (UINT32) ACPI_GET8 (Name + 1);
369 /* Append Name segment */
371 AcpiDmDumpName (*ACPI_CAST_PTR (UINT32, Name));
376 /* Not last name, append dot separator */
381 Name += ACPI_NAME_SIZE;
386 #ifdef ACPI_OBSOLETE_FUNCTIONS
387 /*******************************************************************************
389 * FUNCTION: AcpiDmDisplayPath
391 * PARAMETERS: Op - Named Op whose path is to be constructed
395 * DESCRIPTION: Walk backwards from current scope and display the name
396 * of each previous level of scope up to the root scope
397 * (like "pwd" does with file systems)
399 ******************************************************************************/
403 ACPI_PARSE_OBJECT *Op)
405 ACPI_PARSE_OBJECT *Prev;
406 ACPI_PARSE_OBJECT *Search;
408 BOOLEAN DoDot = FALSE;
409 ACPI_PARSE_OBJECT *NamePath;
410 const ACPI_OPCODE_INFO *OpInfo;
413 /* We are only interested in named objects */
415 OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
416 if (!(OpInfo->Flags & AML_NSNODE))
421 if (OpInfo->Flags & AML_CREATE)
423 /* Field creation - check for a fully qualified namepath */
425 if (Op->Common.AmlOpcode == AML_CREATE_FIELD_OP)
427 NamePath = AcpiPsGetArg (Op, 3);
431 NamePath = AcpiPsGetArg (Op, 2);
435 (NamePath->Common.Value.String) &&
436 (ACPI_IS_ROOT_PREFIX (NamePath->Common.Value.String[0])))
438 AcpiDmNamestring (NamePath->Common.Value.String);
443 Prev = NULL; /* Start with Root Node */
446 /* Search upwards in the tree to find scope with "prev" as its parent */
451 if (Search->Common.Parent == Prev)
456 /* Go up one level */
458 Search = Search->Common.Parent;
463 OpInfo = AcpiPsGetOpcodeInfo (Search->Common.AmlOpcode);
464 if (!(OpInfo->Flags & AML_FIELD))
466 /* Below root scope, append scope name */
475 if (OpInfo->Flags & AML_CREATE)
477 if (Op->Common.AmlOpcode == AML_CREATE_FIELD_OP)
479 NamePath = AcpiPsGetArg (Op, 3);
483 NamePath = AcpiPsGetArg (Op, 2);
487 (NamePath->Common.Value.String))
489 AcpiDmDumpName (NamePath->Common.Value.String);
494 Name = AcpiPsGetName (Search);
495 AcpiDmDumpName ((char *) &Name);
507 /*******************************************************************************
509 * FUNCTION: AcpiDmValidateName
511 * PARAMETERS: Name - 4 character ACPI name
515 * DESCRIPTION: Lookup the name
517 ******************************************************************************/
522 ACPI_PARSE_OBJECT *Op)
524 ACPI_PARSE_OBJECT *TargetOp;
528 (!Op->Common.Parent))
533 if (!Op->Common.Node)
536 " /**** Name not found or not accessible from this scope ****/ ");
540 (!Op->Common.Parent))
545 TargetOp = AcpiPsFind (Op, Name, 0, 0);
549 * Didn't find the name in the parse tree. This may be
550 * a problem, or it may simply be one of the predefined names
551 * (such as _OS_). Rather than worry about looking up all
552 * the predefined names, just display the name as given
555 " /**** Name not found or not accessible from this scope ****/ ");