1 /*******************************************************************************
3 * Module Name: dmobject - ACPI object decode and display
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/acdisasm.h>
123 #ifdef ACPI_DISASSEMBLER
125 #define _COMPONENT ACPI_CA_DEBUGGER
126 ACPI_MODULE_NAME ("dmnames")
128 /* Local prototypes */
132 ACPI_NAMESPACE_NODE *Node);
135 /*******************************************************************************
137 * FUNCTION: AcpiDmDumpMethodInfo
139 * PARAMETERS: Status - Method execution status
140 * WalkState - Current state of the parse tree walk
141 * Op - Executing parse op
145 * DESCRIPTION: Called when a method has been aborted because of an error.
146 * Dumps the method execution stack, and the method locals/args,
147 * and disassembles the AML opcode that failed.
149 ******************************************************************************/
152 AcpiDmDumpMethodInfo (
154 ACPI_WALK_STATE *WalkState,
155 ACPI_PARSE_OBJECT *Op)
157 ACPI_PARSE_OBJECT *Next;
158 ACPI_THREAD_STATE *Thread;
159 ACPI_WALK_STATE *NextWalkState;
160 ACPI_NAMESPACE_NODE *PreviousMethod = NULL;
163 /* Ignore control codes, they are not errors */
165 if ((Status & AE_CODE_MASK) == AE_CODE_CONTROL)
170 /* We may be executing a deferred opcode */
172 if (WalkState->DeferredNode)
174 AcpiOsPrintf ("Executing subtree for Buffer/Package/Region\n");
179 * If there is no Thread, we are not actually executing a method.
180 * This can happen when the iASL compiler calls the interpreter
181 * to perform constant folding.
183 Thread = WalkState->Thread;
189 /* Display exception and method name */
191 AcpiOsPrintf ("\n**** Exception %s during execution of method ",
192 AcpiFormatException (Status));
193 AcpiNsPrintNodePathname (WalkState->MethodNode, NULL);
195 /* Display stack of executing methods */
197 AcpiOsPrintf ("\n\nMethod Execution Stack:\n");
198 NextWalkState = Thread->WalkStateList;
200 /* Walk list of linked walk states */
202 while (NextWalkState)
204 AcpiOsPrintf (" Method [%4.4s] executing: ",
205 AcpiUtGetNodeName (NextWalkState->MethodNode));
207 /* First method is the currently executing method */
209 if (NextWalkState == WalkState)
213 /* Display currently executing ASL statement */
215 Next = Op->Common.Next;
216 Op->Common.Next = NULL;
218 AcpiDmDisassemble (NextWalkState, Op, ACPI_UINT32_MAX);
219 Op->Common.Next = Next;
225 * This method has called another method
226 * NOTE: the method call parse subtree is already deleted at this
227 * point, so we cannot disassemble the method invocation.
229 AcpiOsPrintf ("Call to method ");
230 AcpiNsPrintNodePathname (PreviousMethod, NULL);
233 PreviousMethod = NextWalkState->MethodNode;
234 NextWalkState = NextWalkState->Next;
238 /* Display the method locals and arguments */
241 AcpiDmDisplayLocals (WalkState);
243 AcpiDmDisplayArguments (WalkState);
248 /*******************************************************************************
250 * FUNCTION: AcpiDmDecodeInternalObject
252 * PARAMETERS: ObjDesc - Object to be displayed
256 * DESCRIPTION: Short display of an internal object. Numbers/Strings/Buffers.
258 ******************************************************************************/
261 AcpiDmDecodeInternalObject (
262 ACPI_OPERAND_OBJECT *ObjDesc)
269 AcpiOsPrintf (" Uninitialized");
273 if (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc) != ACPI_DESC_TYPE_OPERAND)
275 AcpiOsPrintf (" %p [%s]", ObjDesc, AcpiUtGetDescriptorName (ObjDesc));
279 AcpiOsPrintf (" %s", AcpiUtGetObjectTypeName (ObjDesc));
281 switch (ObjDesc->Common.Type)
283 case ACPI_TYPE_INTEGER:
285 AcpiOsPrintf (" %8.8X%8.8X",
286 ACPI_FORMAT_UINT64 (ObjDesc->Integer.Value));
290 case ACPI_TYPE_STRING:
292 AcpiOsPrintf ("(%d) \"%.24s",
293 ObjDesc->String.Length, ObjDesc->String.Pointer);
295 if (ObjDesc->String.Length > 24)
297 AcpiOsPrintf ("...");
306 case ACPI_TYPE_BUFFER:
308 AcpiOsPrintf ("(%d)", ObjDesc->Buffer.Length);
309 for (i = 0; (i < 8) && (i < ObjDesc->Buffer.Length); i++)
311 AcpiOsPrintf (" %2.2X", ObjDesc->Buffer.Pointer[i]);
318 AcpiOsPrintf (" %p", ObjDesc);
324 /*******************************************************************************
326 * FUNCTION: AcpiDmDecodeNode
328 * PARAMETERS: Node - Object to be displayed
332 * DESCRIPTION: Short display of a namespace node
334 ******************************************************************************/
338 ACPI_NAMESPACE_NODE *Node)
341 AcpiOsPrintf ("<Node> Name %4.4s",
342 AcpiUtGetNodeName (Node));
344 if (Node->Flags & ANOBJ_METHOD_ARG)
346 AcpiOsPrintf (" [Method Arg]");
348 if (Node->Flags & ANOBJ_METHOD_LOCAL)
350 AcpiOsPrintf (" [Method Local]");
355 /* These types have no attached object */
357 case ACPI_TYPE_DEVICE:
358 AcpiOsPrintf (" Device");
361 case ACPI_TYPE_THERMAL:
362 AcpiOsPrintf (" Thermal Zone");
366 AcpiDmDecodeInternalObject (AcpiNsGetAttachedObject (Node));
372 /*******************************************************************************
374 * FUNCTION: AcpiDmDisplayInternalObject
376 * PARAMETERS: ObjDesc - Object to be displayed
377 * WalkState - Current walk state
381 * DESCRIPTION: Short display of an internal object
383 ******************************************************************************/
386 AcpiDmDisplayInternalObject (
387 ACPI_OPERAND_OBJECT *ObjDesc,
388 ACPI_WALK_STATE *WalkState)
393 AcpiOsPrintf ("%p ", ObjDesc);
397 AcpiOsPrintf ("<Null Object>\n");
401 /* Decode the object type */
403 switch (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc))
405 case ACPI_DESC_TYPE_PARSER:
407 AcpiOsPrintf ("<Parser> ");
411 case ACPI_DESC_TYPE_NAMED:
413 AcpiDmDecodeNode ((ACPI_NAMESPACE_NODE *) ObjDesc);
417 case ACPI_DESC_TYPE_OPERAND:
419 Type = ObjDesc->Common.Type;
420 if (Type > ACPI_TYPE_LOCAL_MAX)
422 AcpiOsPrintf (" Type %X [Invalid Type]", (UINT32) Type);
426 /* Decode the ACPI object type */
428 switch (ObjDesc->Common.Type)
430 case ACPI_TYPE_LOCAL_REFERENCE:
432 AcpiOsPrintf ("[%s] ", AcpiUtGetReferenceName (ObjDesc));
434 /* Decode the refererence */
436 switch (ObjDesc->Reference.Class)
438 case ACPI_REFCLASS_LOCAL:
440 AcpiOsPrintf ("%X ", ObjDesc->Reference.Value);
443 ObjDesc = WalkState->LocalVariables
444 [ObjDesc->Reference.Value].Object;
445 AcpiOsPrintf ("%p", ObjDesc);
446 AcpiDmDecodeInternalObject (ObjDesc);
451 case ACPI_REFCLASS_ARG:
453 AcpiOsPrintf ("%X ", ObjDesc->Reference.Value);
456 ObjDesc = WalkState->Arguments
457 [ObjDesc->Reference.Value].Object;
458 AcpiOsPrintf ("%p", ObjDesc);
459 AcpiDmDecodeInternalObject (ObjDesc);
464 case ACPI_REFCLASS_INDEX:
466 switch (ObjDesc->Reference.TargetType)
468 case ACPI_TYPE_BUFFER_FIELD:
470 AcpiOsPrintf ("%p", ObjDesc->Reference.Object);
471 AcpiDmDecodeInternalObject (ObjDesc->Reference.Object);
474 case ACPI_TYPE_PACKAGE:
476 AcpiOsPrintf ("%p", ObjDesc->Reference.Where);
477 if (!ObjDesc->Reference.Where)
479 AcpiOsPrintf (" Uninitialized WHERE pointer");
483 AcpiDmDecodeInternalObject (
484 *(ObjDesc->Reference.Where));
490 AcpiOsPrintf ("Unknown index target type");
496 case ACPI_REFCLASS_REFOF:
498 if (!ObjDesc->Reference.Object)
500 AcpiOsPrintf ("Uninitialized reference subobject pointer");
504 /* Reference can be to a Node or an Operand object */
506 switch (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc->Reference.Object))
508 case ACPI_DESC_TYPE_NAMED:
509 AcpiDmDecodeNode (ObjDesc->Reference.Object);
512 case ACPI_DESC_TYPE_OPERAND:
513 AcpiDmDecodeInternalObject (ObjDesc->Reference.Object);
522 case ACPI_REFCLASS_NAME:
524 AcpiDmDecodeNode (ObjDesc->Reference.Node);
528 case ACPI_REFCLASS_DEBUG:
529 case ACPI_REFCLASS_TABLE:
535 default: /* Unknown reference class */
537 AcpiOsPrintf ("%2.2X\n", ObjDesc->Reference.Class);
545 AcpiOsPrintf ("<Obj> ");
546 AcpiDmDecodeInternalObject (ObjDesc);
554 AcpiOsPrintf ("<Not a valid ACPI Object Descriptor> [%s]",
555 AcpiUtGetDescriptorName (ObjDesc));
563 /*******************************************************************************
565 * FUNCTION: AcpiDmDisplayLocals
567 * PARAMETERS: WalkState - State for current method
571 * DESCRIPTION: Display all locals for the currently running control method
573 ******************************************************************************/
576 AcpiDmDisplayLocals (
577 ACPI_WALK_STATE *WalkState)
580 ACPI_OPERAND_OBJECT *ObjDesc;
581 ACPI_NAMESPACE_NODE *Node;
584 ObjDesc = WalkState->MethodDesc;
585 Node = WalkState->MethodNode;
589 "No method node (Executing subtree for buffer or opregion)\n");
593 if (Node->Type != ACPI_TYPE_METHOD)
595 AcpiOsPrintf ("Executing subtree for Buffer/Package/Region\n");
599 AcpiOsPrintf ("Local Variables for method [%4.4s]:\n",
600 AcpiUtGetNodeName (Node));
602 for (i = 0; i < ACPI_METHOD_NUM_LOCALS; i++)
604 ObjDesc = WalkState->LocalVariables[i].Object;
605 AcpiOsPrintf (" Local%X: ", i);
606 AcpiDmDisplayInternalObject (ObjDesc, WalkState);
611 /*******************************************************************************
613 * FUNCTION: AcpiDmDisplayArguments
615 * PARAMETERS: WalkState - State for current method
619 * DESCRIPTION: Display all arguments for the currently running control method
621 ******************************************************************************/
624 AcpiDmDisplayArguments (
625 ACPI_WALK_STATE *WalkState)
628 ACPI_OPERAND_OBJECT *ObjDesc;
629 ACPI_NAMESPACE_NODE *Node;
632 ObjDesc = WalkState->MethodDesc;
633 Node = WalkState->MethodNode;
637 "No method node (Executing subtree for buffer or opregion)\n");
641 if (Node->Type != ACPI_TYPE_METHOD)
643 AcpiOsPrintf ("Executing subtree for Buffer/Package/Region\n");
648 "Arguments for Method [%4.4s]: (%X arguments defined, max concurrency = %X)\n",
649 AcpiUtGetNodeName (Node), ObjDesc->Method.ParamCount, ObjDesc->Method.SyncLevel);
651 for (i = 0; i < ACPI_METHOD_NUM_ARGS; i++)
653 ObjDesc = WalkState->Arguments[i].Object;
654 AcpiOsPrintf (" Arg%d: ", i);
655 AcpiDmDisplayInternalObject (ObjDesc, WalkState);