1 /*******************************************************************************
3 * Module Name: dbdisply - debug display commands
6 ******************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2003, 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 *****************************************************************************/
120 #include "acdispat.h"
121 #include "acnamesp.h"
122 #include "acparser.h"
123 #include "acinterp.h"
125 #include "acdisasm.h"
131 #define _COMPONENT ACPI_CA_DEBUGGER
132 ACPI_MODULE_NAME ("dbdisply")
135 /******************************************************************************
137 * FUNCTION: AcpiDbGetPointer
139 * PARAMETERS: Target - Pointer to string to be converted
141 * RETURN: Converted pointer
143 * DESCRIPTION: Convert an ascii pointer value to a real value
145 *****************************************************************************/
154 #if ACPI_MACHINE_WIDTH == 16
157 /* Have to handle 16-bit pointers of the form segment:offset */
159 if (!sscanf (Target, "%p", &ObjPtr))
161 AcpiOsPrintf ("Invalid pointer: %s\n", Target);
167 /* Simple flat pointer */
169 ObjPtr = ACPI_TO_POINTER (ACPI_STRTOUL (Target, NULL, 16));
176 /*******************************************************************************
178 * FUNCTION: AcpiDbDumpParserDescriptor
180 * PARAMETERS: Op - A parser Op descriptor
184 * DESCRIPTION: Display a formatted parser object
186 ******************************************************************************/
189 AcpiDbDumpParserDescriptor (
190 ACPI_PARSE_OBJECT *Op)
192 const ACPI_OPCODE_INFO *Info;
195 Info = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
197 AcpiOsPrintf ("Parser Op Descriptor:\n");
198 AcpiOsPrintf ("%20.20s : %4.4X\n", "Opcode", Op->Common.AmlOpcode);
200 ACPI_DEBUG_ONLY_MEMBERS (AcpiOsPrintf ("%20.20s : %s\n", "Opcode Name", Info->Name));
202 AcpiOsPrintf ("%20.20s : %p\n", "Value/ArgList", Op->Common.Value.Arg);
203 AcpiOsPrintf ("%20.20s : %p\n", "Parent", Op->Common.Parent);
204 AcpiOsPrintf ("%20.20s : %p\n", "NextOp", Op->Common.Next);
208 /*******************************************************************************
210 * FUNCTION: AcpiDbDecodeAndDisplayObject
212 * PARAMETERS: Target - String with object to be displayed. Names
213 * and hex pointers are supported.
214 * OutputType - Byte, Word, Dword, or Qword (B|W|D|Q)
218 * DESCRIPTION: Display a formatted ACPI object
220 ******************************************************************************/
223 AcpiDbDecodeAndDisplayObject (
228 ACPI_NAMESPACE_NODE *Node;
229 ACPI_OPERAND_OBJECT *ObjDesc;
230 UINT32 Display = DB_BYTE_DISPLAY;
242 /* Decode the output type */
246 ACPI_STRUPR (OutputType);
247 if (OutputType[0] == 'W')
249 Display = DB_WORD_DISPLAY;
251 else if (OutputType[0] == 'D')
253 Display = DB_DWORD_DISPLAY;
255 else if (OutputType[0] == 'Q')
257 Display = DB_QWORD_DISPLAY;
261 RetBuf.Length = sizeof (Buffer);
262 RetBuf.Pointer = Buffer;
264 /* Differentiate between a number and a name */
266 if ((Target[0] >= 0x30) && (Target[0] <= 0x39))
268 ObjPtr = AcpiDbGetPointer (Target);
269 if (!AcpiOsReadable (ObjPtr, 16))
271 AcpiOsPrintf ("Address %p is invalid in this address space\n", ObjPtr);
275 /* Decode the object type */
277 switch (ACPI_GET_DESCRIPTOR_TYPE (ObjPtr))
279 case ACPI_DESC_TYPE_NAMED:
281 /* This is a namespace Node */
283 if (!AcpiOsReadable (ObjPtr, sizeof (ACPI_NAMESPACE_NODE)))
285 AcpiOsPrintf ("Cannot read entire Named object at address %p\n", ObjPtr);
293 case ACPI_DESC_TYPE_OPERAND:
295 /* This is a ACPI OPERAND OBJECT */
297 if (!AcpiOsReadable (ObjPtr, sizeof (ACPI_OPERAND_OBJECT)))
299 AcpiOsPrintf ("Cannot read entire ACPI object at address %p\n", ObjPtr);
303 AcpiUtDumpBuffer (ObjPtr, sizeof (ACPI_OPERAND_OBJECT), Display, ACPI_UINT32_MAX);
304 AcpiExDumpObjectDescriptor (ObjPtr, 1);
308 case ACPI_DESC_TYPE_PARSER:
310 /* This is a Parser Op object */
312 if (!AcpiOsReadable (ObjPtr, sizeof (ACPI_PARSE_OBJECT)))
314 AcpiOsPrintf ("Cannot read entire Parser object at address %p\n", ObjPtr);
318 AcpiUtDumpBuffer (ObjPtr, sizeof (ACPI_PARSE_OBJECT), Display, ACPI_UINT32_MAX);
319 AcpiDbDumpParserDescriptor ((ACPI_PARSE_OBJECT *) ObjPtr);
325 /* Is not a recognizeable object */
328 if (AcpiOsReadable (ObjPtr, 64))
333 /* Just dump some memory */
335 AcpiUtDumpBuffer (ObjPtr, Size, Display, ACPI_UINT32_MAX);
342 /* The parameter is a name string that must be resolved to a Named obj */
344 Node = AcpiDbLocalNsLookup (Target);
352 /* Now dump the Named obj */
354 Status = AcpiGetName (Node, ACPI_FULL_PATHNAME, &RetBuf);
355 if (ACPI_FAILURE (Status))
357 AcpiOsPrintf ("Could not convert name to pathname\n");
362 AcpiOsPrintf ("Object (%p) Pathname: %s\n", Node, (char *) RetBuf.Pointer);
365 if (!AcpiOsReadable (Node, sizeof (ACPI_NAMESPACE_NODE)))
367 AcpiOsPrintf ("Invalid Named object at address %p\n", Node);
371 AcpiUtDumpBuffer ((void *) Node, sizeof (ACPI_NAMESPACE_NODE), Display, ACPI_UINT32_MAX);
372 AcpiExDumpNode (Node, 1);
374 ObjDesc = AcpiNsGetAttachedObject (Node);
377 AcpiOsPrintf ("\nAttached Object (%p):\n", ObjDesc);
378 if (!AcpiOsReadable (ObjDesc, sizeof (ACPI_OPERAND_OBJECT)))
380 AcpiOsPrintf ("Invalid internal ACPI Object at address %p\n", ObjDesc);
384 AcpiUtDumpBuffer ((void *) ObjDesc, sizeof (ACPI_OPERAND_OBJECT), Display, ACPI_UINT32_MAX);
385 AcpiExDumpObjectDescriptor (ObjDesc, 1);
390 /*******************************************************************************
392 * FUNCTION: AcpiDbDisplayMethodInfo
394 * PARAMETERS: StartOp - Root of the control method parse tree
398 * DESCRIPTION: Display information about the current method
400 ******************************************************************************/
403 AcpiDbDisplayMethodInfo (
404 ACPI_PARSE_OBJECT *StartOp)
406 ACPI_WALK_STATE *WalkState;
407 ACPI_OPERAND_OBJECT *ObjDesc;
408 ACPI_NAMESPACE_NODE *Node;
409 ACPI_PARSE_OBJECT *RootOp;
410 ACPI_PARSE_OBJECT *Op;
411 const ACPI_OPCODE_INFO *OpInfo;
413 UINT32 NumOperands = 0;
414 UINT32 NumOperators = 0;
415 UINT32 NumRemainingOps = 0;
416 UINT32 NumRemainingOperands = 0;
417 UINT32 NumRemainingOperators = 0;
420 BOOLEAN CountRemaining = FALSE;
423 WalkState = AcpiDsGetCurrentWalkState (AcpiGbl_CurrentWalkList);
426 AcpiOsPrintf ("There is no method currently executing\n");
430 ObjDesc = WalkState->MethodDesc;
431 Node = WalkState->MethodNode;
433 NumArgs = ObjDesc->Method.ParamCount;
434 Concurrency = ObjDesc->Method.Concurrency;
436 AcpiOsPrintf ("Currently executing control method is [%4.4s]\n",
437 AcpiUtGetNodeName (Node));
438 AcpiOsPrintf ("%X arguments, max concurrency = %X\n",
439 NumArgs, Concurrency);
443 while (RootOp->Common.Parent)
445 RootOp = RootOp->Common.Parent;
454 CountRemaining = TRUE;
463 /* Decode the opcode */
465 OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
466 switch (OpInfo->Class)
468 case AML_CLASS_ARGUMENT:
471 NumRemainingOperands++;
477 case AML_CLASS_UNKNOWN:
478 /* Bad opcode or ASCII character */
485 NumRemainingOperators++;
492 Op = AcpiPsGetDepthNext (StartOp, Op);
495 AcpiOsPrintf ("Method contains: %X AML Opcodes - %X Operators, %X Operands\n",
496 NumOps, NumOperators, NumOperands);
498 AcpiOsPrintf ("Remaining to execute: %X AML Opcodes - %X Operators, %X Operands\n",
499 NumRemainingOps, NumRemainingOperators, NumRemainingOperands);
503 /*******************************************************************************
505 * FUNCTION: AcpiDbDisplayLocals
511 * DESCRIPTION: Display all locals for the currently running control method
513 ******************************************************************************/
516 AcpiDbDisplayLocals (void)
518 ACPI_WALK_STATE *WalkState;
521 WalkState = AcpiDsGetCurrentWalkState (AcpiGbl_CurrentWalkList);
524 AcpiOsPrintf ("There is no method currently executing\n");
528 AcpiDmDisplayLocals (WalkState);
532 /*******************************************************************************
534 * FUNCTION: AcpiDbDisplayArguments
540 * DESCRIPTION: Display all arguments for the currently running control method
542 ******************************************************************************/
545 AcpiDbDisplayArguments (void)
547 ACPI_WALK_STATE *WalkState;
550 WalkState = AcpiDsGetCurrentWalkState (AcpiGbl_CurrentWalkList);
553 AcpiOsPrintf ("There is no method currently executing\n");
557 AcpiDmDisplayArguments (WalkState);
561 /*******************************************************************************
563 * FUNCTION: AcpiDbDisplayResults
569 * DESCRIPTION: Display current contents of a method result stack
571 ******************************************************************************/
574 AcpiDbDisplayResults (void)
577 ACPI_WALK_STATE *WalkState;
578 ACPI_OPERAND_OBJECT *ObjDesc;
579 UINT32 NumResults = 0;
580 ACPI_NAMESPACE_NODE *Node;
583 WalkState = AcpiDsGetCurrentWalkState (AcpiGbl_CurrentWalkList);
586 AcpiOsPrintf ("There is no method currently executing\n");
590 ObjDesc = WalkState->MethodDesc;
591 Node = WalkState->MethodNode;
593 if (WalkState->Results)
595 NumResults = WalkState->Results->Results.NumResults;
598 AcpiOsPrintf ("Method [%4.4s] has %X stacked result objects\n",
599 AcpiUtGetNodeName (Node), NumResults);
601 for (i = 0; i < NumResults; i++)
603 ObjDesc = WalkState->Results->Results.ObjDesc[i];
604 AcpiOsPrintf ("Result%d: ", i);
605 AcpiDmDisplayInternalObject (ObjDesc, WalkState);
610 /*******************************************************************************
612 * FUNCTION: AcpiDbDisplayCallingTree
618 * DESCRIPTION: Display current calling tree of nested control methods
620 ******************************************************************************/
623 AcpiDbDisplayCallingTree (void)
625 ACPI_WALK_STATE *WalkState;
626 ACPI_NAMESPACE_NODE *Node;
629 WalkState = AcpiDsGetCurrentWalkState (AcpiGbl_CurrentWalkList);
632 AcpiOsPrintf ("There is no method currently executing\n");
636 Node = WalkState->MethodNode;
637 AcpiOsPrintf ("Current Control Method Call Tree\n");
641 Node = WalkState->MethodNode;
643 AcpiOsPrintf (" [%4.4s]\n", AcpiUtGetNodeName (Node));
645 WalkState = WalkState->Next;
650 /*******************************************************************************
652 * FUNCTION: AcpiDbDisplayObjectType
654 * PARAMETERS: ObjectArg - User entered NS node handle
658 * DESCRIPTION: Display type of an arbitrary NS node
660 ******************************************************************************/
663 AcpiDbDisplayObjectType (
668 ACPI_DEVICE_INFO *Info;
673 Handle = ACPI_TO_POINTER (ACPI_STRTOUL (ObjectArg, NULL, 16));
674 Buffer.Length = ACPI_ALLOCATE_LOCAL_BUFFER;
676 Status = AcpiGetObjectInfo (Handle, &Buffer);
677 if (ACPI_SUCCESS (Status))
679 Info = Buffer.Pointer;
680 AcpiOsPrintf ("HID: %s, ADR: %8.8X%8.8X, Status %8.8X\n",
682 ACPI_FORMAT_UINT64 (Info->Address),
683 Info->CurrentStatus);
685 if (Info->Valid & ACPI_VALID_CID)
687 for (i = 0; i < Info->CompatibilityId.Count; i++)
689 AcpiOsPrintf ("CID #%d: %s\n", i, &Info->CompatibilityId.Id[i]);
693 ACPI_MEM_FREE (Info);
697 AcpiOsPrintf ("%s\n", AcpiFormatException (Status));
702 /*******************************************************************************
704 * FUNCTION: AcpiDbDisplayResultObject
706 * PARAMETERS: ObjDesc - Object to be displayed
707 * WalkState - Current walk state
711 * DESCRIPTION: Display the result of an AML opcode
713 * Note: Curently only displays the result object if we are single stepping.
714 * However, this output may be useful in other contexts and could be enabled
715 * to do so if needed.
717 ******************************************************************************/
720 AcpiDbDisplayResultObject (
721 ACPI_OPERAND_OBJECT *ObjDesc,
722 ACPI_WALK_STATE *WalkState)
725 /* Only display if single stepping */
727 if (!AcpiGbl_CmSingleStep)
732 AcpiOsPrintf ("ResultObj: ");
733 AcpiDmDisplayInternalObject (ObjDesc, WalkState);
738 /*******************************************************************************
740 * FUNCTION: AcpiDbDisplayArgumentObject
742 * PARAMETERS: ObjDesc - Object to be displayed
743 * WalkState - Current walk state
747 * DESCRIPTION: Display the result of an AML opcode
749 ******************************************************************************/
752 AcpiDbDisplayArgumentObject (
753 ACPI_OPERAND_OBJECT *ObjDesc,
754 ACPI_WALK_STATE *WalkState)
757 if (!AcpiGbl_CmSingleStep)
762 AcpiOsPrintf ("ArgObj: ");
763 AcpiDmDisplayInternalObject (ObjDesc, WalkState);
767 /*******************************************************************************
769 * FUNCTION: AcpiDbDisplayGpes
775 * DESCRIPTION: Display the current GPE structures
777 ******************************************************************************/
780 AcpiDbDisplayGpes (void)
782 ACPI_GPE_BLOCK_INFO *GpeBlock;
783 ACPI_GPE_XRUPT_INFO *GpeXruptInfo;
787 GpeXruptInfo = AcpiGbl_GpeXruptListHead;
790 GpeBlock = GpeXruptInfo->GpeBlockListHead;
793 AcpiOsPrintf ("Block %d - %p\n", i, GpeBlock);
794 AcpiOsPrintf (" Registers: %d\n", GpeBlock->RegisterCount);
795 AcpiOsPrintf (" GPE range: %d to %d\n", GpeBlock->BlockBaseNumber,
796 GpeBlock->BlockBaseNumber + (GpeBlock->RegisterCount * 8) -1);
797 AcpiOsPrintf (" RegisterInfo: %p\n", GpeBlock->RegisterInfo);
798 AcpiOsPrintf (" EventInfo: %p\n", GpeBlock->EventInfo);
801 GpeBlock = GpeBlock->Next;
804 GpeXruptInfo = GpeXruptInfo->Next;
809 #endif /* ACPI_DEBUGGER */