1 /*******************************************************************************
3 * Module Name: dbutils - AML debugger utilities
6 ******************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2007, Intel Corp.
13 * All rights reserved.
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights. You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code. No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
38 * The above copyright and patent license is granted only if the following
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision. In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change. Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee. Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution. In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
73 * 3.4. Intel retains all right, title, and interest in and to the Original
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
81 * 4. Disclaimer and Export Compliance
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
115 *****************************************************************************/
118 #include <contrib/dev/acpica/acpi.h>
119 #include <contrib/dev/acpica/acnamesp.h>
120 #include <contrib/dev/acpica/acdebug.h>
121 #include <contrib/dev/acpica/acdisasm.h>
126 #define _COMPONENT ACPI_CA_DEBUGGER
127 ACPI_MODULE_NAME ("dbutils")
129 /* Local prototypes */
131 #ifdef ACPI_OBSOLETE_FUNCTIONS
133 AcpiDbSecondPassParse (
134 ACPI_PARSE_OBJECT *Root);
141 static char *Converter = "0123456789ABCDEF";
144 /*******************************************************************************
146 * FUNCTION: AcpiDbMatchArgument
148 * PARAMETERS: UserArgument - User command line
149 * Arguments - Array of commands to match against
151 * RETURN: Index into command array or ACPI_TYPE_NOT_FOUND if not found
153 * DESCRIPTION: Search command array for a command match
155 ******************************************************************************/
158 AcpiDbMatchArgument (
160 ARGUMENT_INFO *Arguments)
165 if (!UserArgument || UserArgument[0] == 0)
167 return (ACPI_TYPE_NOT_FOUND);
170 for (i = 0; Arguments[i].Name; i++)
172 if (ACPI_STRSTR (Arguments[i].Name, UserArgument) == Arguments[i].Name)
178 /* Argument not recognized */
180 return (ACPI_TYPE_NOT_FOUND);
184 /*******************************************************************************
186 * FUNCTION: AcpiDbSetOutputDestination
188 * PARAMETERS: OutputFlags - Current flags word
192 * DESCRIPTION: Set the current destination for debugger output. Also sets
193 * the debug output level accordingly.
195 ******************************************************************************/
198 AcpiDbSetOutputDestination (
202 AcpiGbl_DbOutputFlags = (UINT8) OutputFlags;
204 if ((OutputFlags & ACPI_DB_REDIRECTABLE_OUTPUT) && AcpiGbl_DbOutputToFile)
206 AcpiDbgLevel = AcpiGbl_DbDebugLevel;
210 AcpiDbgLevel = AcpiGbl_DbConsoleDebugLevel;
215 /*******************************************************************************
217 * FUNCTION: AcpiDbDumpExternalObject
219 * PARAMETERS: ObjDesc - External ACPI object to dump
220 * Level - Nesting level.
224 * DESCRIPTION: Dump the contents of an ACPI external object
226 ******************************************************************************/
229 AcpiDbDumpExternalObject (
230 ACPI_OBJECT *ObjDesc,
238 AcpiOsPrintf ("[Null Object]\n");
242 for (i = 0; i < Level; i++)
247 switch (ObjDesc->Type)
251 AcpiOsPrintf ("[Object Reference] = %p", ObjDesc->Reference.Handle);
252 AcpiDmDisplayInternalObject (ObjDesc->Reference.Handle, NULL);
256 case ACPI_TYPE_INTEGER:
258 AcpiOsPrintf ("[Integer] = %8.8X%8.8X\n",
259 ACPI_FORMAT_UINT64 (ObjDesc->Integer.Value));
263 case ACPI_TYPE_STRING:
265 AcpiOsPrintf ("[String] Length %.2X = ", ObjDesc->String.Length);
266 for (i = 0; i < ObjDesc->String.Length; i++)
268 AcpiOsPrintf ("%c", ObjDesc->String.Pointer[i]);
274 case ACPI_TYPE_BUFFER:
276 AcpiOsPrintf ("[Buffer] Length %.2X = ", ObjDesc->Buffer.Length);
277 if (ObjDesc->Buffer.Length)
279 AcpiUtDumpBuffer (ACPI_CAST_PTR (UINT8, ObjDesc->Buffer.Pointer),
280 ObjDesc->Buffer.Length, DB_DWORD_DISPLAY, _COMPONENT);
289 case ACPI_TYPE_PACKAGE:
291 AcpiOsPrintf ("[Package] Contains %d Elements:\n",
292 ObjDesc->Package.Count);
294 for (i = 0; i < ObjDesc->Package.Count; i++)
296 AcpiDbDumpExternalObject (&ObjDesc->Package.Elements[i], Level+1);
301 case ACPI_TYPE_LOCAL_REFERENCE:
303 AcpiOsPrintf ("[Object Reference] = %p", ObjDesc->Reference.Handle);
304 AcpiDmDisplayInternalObject (ObjDesc->Reference.Handle, NULL);
308 case ACPI_TYPE_PROCESSOR:
310 AcpiOsPrintf ("[Processor]\n");
314 case ACPI_TYPE_POWER:
316 AcpiOsPrintf ("[Power Resource]\n");
322 AcpiOsPrintf ("[Unknown Type] %X\n", ObjDesc->Type);
328 /*******************************************************************************
330 * FUNCTION: AcpiDbPrepNamestring
332 * PARAMETERS: Name - String to prepare
336 * DESCRIPTION: Translate all forward slashes and dots to backslashes.
338 ******************************************************************************/
341 AcpiDbPrepNamestring (
352 /* Convert a leading forward slash to a backslash */
359 /* Ignore a leading backslash, this is the root prefix */
366 /* Convert all slash path separators to dots */
370 if ((*Name == '/') ||
381 /*******************************************************************************
383 * FUNCTION: AcpiDbLocalNsLookup
385 * PARAMETERS: Name - Name to lookup
387 * RETURN: Pointer to a namespace node, null on failure
389 * DESCRIPTION: Lookup a name in the ACPI namespace
391 * Note: Currently begins search from the root. Could be enhanced to use
392 * the current prefix (scope) node as the search beginning point.
394 ******************************************************************************/
396 ACPI_NAMESPACE_NODE *
397 AcpiDbLocalNsLookup (
402 ACPI_NAMESPACE_NODE *Node = NULL;
405 AcpiDbPrepNamestring (Name);
407 /* Build an internal namestring */
409 Status = AcpiNsInternalizeName (Name, &InternalPath);
410 if (ACPI_FAILURE (Status))
412 AcpiOsPrintf ("Invalid namestring: %s\n", Name);
418 * (Uses root node as the search starting point)
420 Status = AcpiNsLookup (NULL, InternalPath, ACPI_TYPE_ANY, ACPI_IMODE_EXECUTE,
421 ACPI_NS_NO_UPSEARCH | ACPI_NS_DONT_OPEN_SCOPE, NULL, &Node);
422 if (ACPI_FAILURE (Status))
424 AcpiOsPrintf ("Could not locate name: %s, %s\n",
425 Name, AcpiFormatException (Status));
428 ACPI_FREE (InternalPath);
433 /*******************************************************************************
435 * FUNCTION: AcpiDbUInt32ToHexString
437 * PARAMETERS: Value - The value to be converted to string
438 * Buffer - Buffer for result (not less than 11 bytes)
442 * DESCRIPTION: Convert the unsigned 32-bit value to the hexadecimal image
444 * NOTE: It is the caller's responsibility to ensure that the length of buffer
447 ******************************************************************************/
450 AcpiDbUInt32ToHexString (
459 ACPI_STRCPY (Buffer, "0");
463 ACPI_STRCPY (Buffer, "0x");
466 for (i = 9; i > 1; i--)
468 Buffer[i] = Converter [Value & 0x0F];
474 #ifdef ACPI_OBSOLETE_FUNCTIONS
475 /*******************************************************************************
477 * FUNCTION: AcpiDbSecondPassParse
479 * PARAMETERS: Root - Root of the parse tree
483 * DESCRIPTION: Second pass parse of the ACPI tables. We need to wait until
484 * second pass to parse the control methods
486 ******************************************************************************/
489 AcpiDbSecondPassParse (
490 ACPI_PARSE_OBJECT *Root)
492 ACPI_PARSE_OBJECT *Op = Root;
493 ACPI_PARSE_OBJECT *Method;
494 ACPI_PARSE_OBJECT *SearchOp;
495 ACPI_PARSE_OBJECT *StartOp;
496 ACPI_STATUS Status = AE_OK;
497 UINT32 BaseAmlOffset;
498 ACPI_WALK_STATE *WalkState;
501 ACPI_FUNCTION_ENTRY ();
504 AcpiOsPrintf ("Pass two parse ....\n");
508 if (Op->Common.AmlOpcode == AML_METHOD_OP)
512 /* Create a new walk state for the parse */
514 WalkState = AcpiDsCreateWalkState (0, NULL, NULL, NULL);
517 return (AE_NO_MEMORY);
520 /* Init the Walk State */
522 WalkState->ParserState.Aml =
523 WalkState->ParserState.AmlStart = Method->Named.Data;
524 WalkState->ParserState.AmlEnd =
525 WalkState->ParserState.PkgEnd = Method->Named.Data +
526 Method->Named.Length;
527 WalkState->ParserState.StartScope = Op;
529 WalkState->DescendingCallback = AcpiDsLoad1BeginOp;
530 WalkState->AscendingCallback = AcpiDsLoad1EndOp;
532 /* Perform the AML parse */
534 Status = AcpiPsParseAml (WalkState);
536 BaseAmlOffset = (Method->Common.Value.Arg)->Common.AmlOffset + 1;
537 StartOp = (Method->Common.Value.Arg)->Common.Next;
542 SearchOp->Common.AmlOffset += BaseAmlOffset;
543 SearchOp = AcpiPsGetDepthNext (StartOp, SearchOp);
547 if (Op->Common.AmlOpcode == AML_REGION_OP)
549 /* TBD: [Investigate] this isn't quite the right thing to do! */
552 * Method = (ACPI_DEFERRED_OP *) Op;
553 * Status = AcpiPsParseAml (Op, Method->Body, Method->BodyLength);
557 if (ACPI_FAILURE (Status))
562 Op = AcpiPsGetDepthNext (Root, Op);
569 /*******************************************************************************
571 * FUNCTION: AcpiDbDumpBuffer
573 * PARAMETERS: Address - Pointer to the buffer
577 * DESCRIPTION: Print a portion of a buffer
579 ******************************************************************************/
586 AcpiOsPrintf ("\nLocation %X:\n", Address);
588 AcpiDbgLevel |= ACPI_LV_TABLES;
589 AcpiUtDumpBuffer (ACPI_TO_POINTER (Address), 64, DB_BYTE_DISPLAY,
594 #endif /* ACPI_DEBUGGER */