1 /*******************************************************************************
3 * Module Name: dbutils - AML debugger utilities
5 ******************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2010, 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 *****************************************************************************/
117 #include <contrib/dev/acpica/include/acpi.h>
118 #include <contrib/dev/acpica/include/accommon.h>
119 #include <contrib/dev/acpica/include/acnamesp.h>
120 #include <contrib/dev/acpica/include/acdebug.h>
121 #include <contrib/dev/acpica/include/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 ("[Null Object] (Type=0)\n");
255 case ACPI_TYPE_INTEGER:
257 AcpiOsPrintf ("[Integer] = %8.8X%8.8X\n",
258 ACPI_FORMAT_UINT64 (ObjDesc->Integer.Value));
262 case ACPI_TYPE_STRING:
264 AcpiOsPrintf ("[String] Length %.2X = ", ObjDesc->String.Length);
265 for (i = 0; i < ObjDesc->String.Length; i++)
267 AcpiOsPrintf ("%c", ObjDesc->String.Pointer[i]);
273 case ACPI_TYPE_BUFFER:
275 AcpiOsPrintf ("[Buffer] Length %.2X = ", ObjDesc->Buffer.Length);
276 if (ObjDesc->Buffer.Length)
278 if (ObjDesc->Buffer.Length > 16)
282 AcpiUtDumpBuffer (ACPI_CAST_PTR (UINT8, ObjDesc->Buffer.Pointer),
283 ObjDesc->Buffer.Length, DB_DWORD_DISPLAY, _COMPONENT);
292 case ACPI_TYPE_PACKAGE:
294 AcpiOsPrintf ("[Package] Contains %u Elements:\n",
295 ObjDesc->Package.Count);
297 for (i = 0; i < ObjDesc->Package.Count; i++)
299 AcpiDbDumpExternalObject (&ObjDesc->Package.Elements[i], Level+1);
304 case ACPI_TYPE_LOCAL_REFERENCE:
306 AcpiOsPrintf ("[Object Reference] = ");
307 AcpiDmDisplayInternalObject (ObjDesc->Reference.Handle, NULL);
311 case ACPI_TYPE_PROCESSOR:
313 AcpiOsPrintf ("[Processor]\n");
317 case ACPI_TYPE_POWER:
319 AcpiOsPrintf ("[Power Resource]\n");
325 AcpiOsPrintf ("[Unknown Type] %X\n", ObjDesc->Type);
331 /*******************************************************************************
333 * FUNCTION: AcpiDbPrepNamestring
335 * PARAMETERS: Name - String to prepare
339 * DESCRIPTION: Translate all forward slashes and dots to backslashes.
341 ******************************************************************************/
344 AcpiDbPrepNamestring (
355 /* Convert a leading forward slash to a backslash */
362 /* Ignore a leading backslash, this is the root prefix */
369 /* Convert all slash path separators to dots */
373 if ((*Name == '/') ||
384 /*******************************************************************************
386 * FUNCTION: AcpiDbLocalNsLookup
388 * PARAMETERS: Name - Name to lookup
390 * RETURN: Pointer to a namespace node, null on failure
392 * DESCRIPTION: Lookup a name in the ACPI namespace
394 * Note: Currently begins search from the root. Could be enhanced to use
395 * the current prefix (scope) node as the search beginning point.
397 ******************************************************************************/
399 ACPI_NAMESPACE_NODE *
400 AcpiDbLocalNsLookup (
405 ACPI_NAMESPACE_NODE *Node = NULL;
408 AcpiDbPrepNamestring (Name);
410 /* Build an internal namestring */
412 Status = AcpiNsInternalizeName (Name, &InternalPath);
413 if (ACPI_FAILURE (Status))
415 AcpiOsPrintf ("Invalid namestring: %s\n", Name);
421 * (Uses root node as the search starting point)
423 Status = AcpiNsLookup (NULL, InternalPath, ACPI_TYPE_ANY, ACPI_IMODE_EXECUTE,
424 ACPI_NS_NO_UPSEARCH | ACPI_NS_DONT_OPEN_SCOPE, NULL, &Node);
425 if (ACPI_FAILURE (Status))
427 AcpiOsPrintf ("Could not locate name: %s, %s\n",
428 Name, AcpiFormatException (Status));
431 ACPI_FREE (InternalPath);
436 /*******************************************************************************
438 * FUNCTION: AcpiDbUInt32ToHexString
440 * PARAMETERS: Value - The value to be converted to string
441 * Buffer - Buffer for result (not less than 11 bytes)
445 * DESCRIPTION: Convert the unsigned 32-bit value to the hexadecimal image
447 * NOTE: It is the caller's responsibility to ensure that the length of buffer
450 ******************************************************************************/
453 AcpiDbUInt32ToHexString (
462 ACPI_STRCPY (Buffer, "0");
466 ACPI_STRCPY (Buffer, "0x");
469 for (i = 9; i > 1; i--)
471 Buffer[i] = Converter [Value & 0x0F];
477 #ifdef ACPI_OBSOLETE_FUNCTIONS
478 /*******************************************************************************
480 * FUNCTION: AcpiDbSecondPassParse
482 * PARAMETERS: Root - Root of the parse tree
486 * DESCRIPTION: Second pass parse of the ACPI tables. We need to wait until
487 * second pass to parse the control methods
489 ******************************************************************************/
492 AcpiDbSecondPassParse (
493 ACPI_PARSE_OBJECT *Root)
495 ACPI_PARSE_OBJECT *Op = Root;
496 ACPI_PARSE_OBJECT *Method;
497 ACPI_PARSE_OBJECT *SearchOp;
498 ACPI_PARSE_OBJECT *StartOp;
499 ACPI_STATUS Status = AE_OK;
500 UINT32 BaseAmlOffset;
501 ACPI_WALK_STATE *WalkState;
504 ACPI_FUNCTION_ENTRY ();
507 AcpiOsPrintf ("Pass two parse ....\n");
511 if (Op->Common.AmlOpcode == AML_METHOD_OP)
515 /* Create a new walk state for the parse */
517 WalkState = AcpiDsCreateWalkState (0, NULL, NULL, NULL);
520 return (AE_NO_MEMORY);
523 /* Init the Walk State */
525 WalkState->ParserState.Aml =
526 WalkState->ParserState.AmlStart = Method->Named.Data;
527 WalkState->ParserState.AmlEnd =
528 WalkState->ParserState.PkgEnd = Method->Named.Data +
529 Method->Named.Length;
530 WalkState->ParserState.StartScope = Op;
532 WalkState->DescendingCallback = AcpiDsLoad1BeginOp;
533 WalkState->AscendingCallback = AcpiDsLoad1EndOp;
535 /* Perform the AML parse */
537 Status = AcpiPsParseAml (WalkState);
539 BaseAmlOffset = (Method->Common.Value.Arg)->Common.AmlOffset + 1;
540 StartOp = (Method->Common.Value.Arg)->Common.Next;
545 SearchOp->Common.AmlOffset += BaseAmlOffset;
546 SearchOp = AcpiPsGetDepthNext (StartOp, SearchOp);
550 if (Op->Common.AmlOpcode == AML_REGION_OP)
552 /* TBD: [Investigate] this isn't quite the right thing to do! */
555 * Method = (ACPI_DEFERRED_OP *) Op;
556 * Status = AcpiPsParseAml (Op, Method->Body, Method->BodyLength);
560 if (ACPI_FAILURE (Status))
565 Op = AcpiPsGetDepthNext (Root, Op);
572 /*******************************************************************************
574 * FUNCTION: AcpiDbDumpBuffer
576 * PARAMETERS: Address - Pointer to the buffer
580 * DESCRIPTION: Print a portion of a buffer
582 ******************************************************************************/
589 AcpiOsPrintf ("\nLocation %X:\n", Address);
591 AcpiDbgLevel |= ACPI_LV_TABLES;
592 AcpiUtDumpBuffer (ACPI_TO_POINTER (Address), 64, DB_BYTE_DISPLAY,
597 #endif /* ACPI_DEBUGGER */