1 /*******************************************************************************
3 * Module Name: dmobject - ACPI object decode and display
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/amlcode.h>
120 #include <contrib/dev/acpica/acnamesp.h>
121 #include <contrib/dev/acpica/acdisasm.h>
122 #include <contrib/dev/acpica/acparser.h>
125 #ifdef ACPI_DISASSEMBLER
127 #define _COMPONENT ACPI_CA_DEBUGGER
128 ACPI_MODULE_NAME ("dmnames")
130 /* Local prototypes */
134 ACPI_NAMESPACE_NODE *Node);
137 /*******************************************************************************
139 * FUNCTION: AcpiDmDumpMethodInfo
141 * PARAMETERS: Status - Method execution status
142 * WalkState - Current state of the parse tree walk
143 * Op - Executing parse op
147 * DESCRIPTION: Called when a method has been aborted because of an error.
148 * Dumps the method execution stack, and the method locals/args,
149 * and disassembles the AML opcode that failed.
151 ******************************************************************************/
154 AcpiDmDumpMethodInfo (
156 ACPI_WALK_STATE *WalkState,
157 ACPI_PARSE_OBJECT *Op)
159 ACPI_PARSE_OBJECT *Next;
160 ACPI_THREAD_STATE *Thread;
161 ACPI_WALK_STATE *NextWalkState;
162 ACPI_NAMESPACE_NODE *PreviousMethod = NULL;
165 /* Ignore control codes, they are not errors */
167 if ((Status & AE_CODE_MASK) == AE_CODE_CONTROL)
172 /* We may be executing a deferred opcode */
174 if (WalkState->DeferredNode)
176 AcpiOsPrintf ("Executing subtree for Buffer/Package/Region\n");
181 * If there is no Thread, we are not actually executing a method.
182 * This can happen when the iASL compiler calls the interpreter
183 * to perform constant folding.
185 Thread = WalkState->Thread;
191 /* Display exception and method name */
193 AcpiOsPrintf ("\n**** Exception %s during execution of method ",
194 AcpiFormatException (Status));
195 AcpiNsPrintNodePathname (WalkState->MethodNode, NULL);
197 /* Display stack of executing methods */
199 AcpiOsPrintf ("\n\nMethod Execution Stack:\n");
200 NextWalkState = Thread->WalkStateList;
202 /* Walk list of linked walk states */
204 while (NextWalkState)
206 AcpiOsPrintf (" Method [%4.4s] executing: ",
207 AcpiUtGetNodeName (NextWalkState->MethodNode));
209 /* First method is the currently executing method */
211 if (NextWalkState == WalkState)
215 /* Display currently executing ASL statement */
217 Next = Op->Common.Next;
218 Op->Common.Next = NULL;
220 AcpiDmDisassemble (NextWalkState, Op, ACPI_UINT32_MAX);
221 Op->Common.Next = Next;
227 * This method has called another method
228 * NOTE: the method call parse subtree is already deleted at this
229 * point, so we cannot disassemble the method invocation.
231 AcpiOsPrintf ("Call to method ");
232 AcpiNsPrintNodePathname (PreviousMethod, NULL);
235 PreviousMethod = NextWalkState->MethodNode;
236 NextWalkState = NextWalkState->Next;
240 /* Display the method locals and arguments */
243 AcpiDmDisplayLocals (WalkState);
245 AcpiDmDisplayArguments (WalkState);
250 /*******************************************************************************
252 * FUNCTION: AcpiDmDecodeInternalObject
254 * PARAMETERS: ObjDesc - Object to be displayed
258 * DESCRIPTION: Short display of an internal object. Numbers/Strings/Buffers.
260 ******************************************************************************/
263 AcpiDmDecodeInternalObject (
264 ACPI_OPERAND_OBJECT *ObjDesc)
271 AcpiOsPrintf (" Uninitialized");
275 if (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc) != ACPI_DESC_TYPE_OPERAND)
277 AcpiOsPrintf (" %p [%s]", ObjDesc, AcpiUtGetDescriptorName (ObjDesc));
281 AcpiOsPrintf (" %s", AcpiUtGetObjectTypeName (ObjDesc));
283 switch (ACPI_GET_OBJECT_TYPE (ObjDesc))
285 case ACPI_TYPE_INTEGER:
287 AcpiOsPrintf (" %8.8X%8.8X",
288 ACPI_FORMAT_UINT64 (ObjDesc->Integer.Value));
292 case ACPI_TYPE_STRING:
294 AcpiOsPrintf ("(%d) \"%.24s",
295 ObjDesc->String.Length, ObjDesc->String.Pointer);
297 if (ObjDesc->String.Length > 24)
299 AcpiOsPrintf ("...");
308 case ACPI_TYPE_BUFFER:
310 AcpiOsPrintf ("(%d)", ObjDesc->Buffer.Length);
311 for (i = 0; (i < 8) && (i < ObjDesc->Buffer.Length); i++)
313 AcpiOsPrintf (" %2.2X", ObjDesc->Buffer.Pointer[i]);
320 AcpiOsPrintf (" %p", ObjDesc);
326 /*******************************************************************************
328 * FUNCTION: AcpiDmDecodeNode
330 * PARAMETERS: Node - Object to be displayed
334 * DESCRIPTION: Short display of a namespace node
336 ******************************************************************************/
340 ACPI_NAMESPACE_NODE *Node)
343 AcpiOsPrintf ("<Node> Name %4.4s",
344 AcpiUtGetNodeName (Node));
346 if (Node->Flags & ANOBJ_METHOD_ARG)
348 AcpiOsPrintf (" [Method Arg]");
350 if (Node->Flags & ANOBJ_METHOD_LOCAL)
352 AcpiOsPrintf (" [Method Local]");
355 AcpiDmDecodeInternalObject (AcpiNsGetAttachedObject (Node));
359 /*******************************************************************************
361 * FUNCTION: AcpiDmDisplayInternalObject
363 * PARAMETERS: ObjDesc - Object to be displayed
364 * WalkState - Current walk state
368 * DESCRIPTION: Short display of an internal object
370 ******************************************************************************/
373 AcpiDmDisplayInternalObject (
374 ACPI_OPERAND_OBJECT *ObjDesc,
375 ACPI_WALK_STATE *WalkState)
380 AcpiOsPrintf ("%p ", ObjDesc);
384 AcpiOsPrintf ("<Null Object>\n");
388 /* Decode the object type */
390 switch (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc))
392 case ACPI_DESC_TYPE_PARSER:
394 AcpiOsPrintf ("<Parser> ");
398 case ACPI_DESC_TYPE_NAMED:
400 AcpiDmDecodeNode ((ACPI_NAMESPACE_NODE *) ObjDesc);
404 case ACPI_DESC_TYPE_OPERAND:
406 Type = ACPI_GET_OBJECT_TYPE (ObjDesc);
407 if (Type > ACPI_TYPE_LOCAL_MAX)
409 AcpiOsPrintf (" Type %X [Invalid Type]", (UINT32) Type);
413 /* Decode the ACPI object type */
415 switch (ACPI_GET_OBJECT_TYPE (ObjDesc))
417 case ACPI_TYPE_LOCAL_REFERENCE:
419 switch (ObjDesc->Reference.Opcode)
423 AcpiOsPrintf ("[Local%d] ", ObjDesc->Reference.Offset);
426 ObjDesc = WalkState->LocalVariables[
427 ObjDesc->Reference.Offset].Object;
428 AcpiOsPrintf ("%p", ObjDesc);
429 AcpiDmDecodeInternalObject (ObjDesc);
436 AcpiOsPrintf ("[Arg%d] ", ObjDesc->Reference.Offset);
439 ObjDesc = WalkState->Arguments[
440 ObjDesc->Reference.Offset].Object;
441 AcpiOsPrintf ("%p", ObjDesc);
442 AcpiDmDecodeInternalObject (ObjDesc);
449 AcpiOsPrintf ("[Debug] ");
455 AcpiOsPrintf ("[Index] ");
456 switch (ObjDesc->Reference.TargetType)
458 case ACPI_TYPE_BUFFER_FIELD:
459 AcpiOsPrintf ("%p", ObjDesc->Reference.Object);
460 AcpiDmDecodeInternalObject (ObjDesc->Reference.Object);
463 case ACPI_TYPE_PACKAGE:
465 AcpiOsPrintf ("%p", ObjDesc->Reference.Where);
466 if (!ObjDesc->Reference.Where)
468 AcpiOsPrintf (" Uninitialized WHERE ptr");
472 AcpiDmDecodeInternalObject (
473 *(ObjDesc->Reference.Where));
478 AcpiOsPrintf ("Unknown index target type");
486 AcpiOsPrintf ("[DdbHandle] ");
492 AcpiOsPrintf ("[RefOf] ");
494 if (!ObjDesc->Reference.Object)
496 AcpiOsPrintf ("Uninitialized reference subobject ptr");
500 /* Reference can be to a Node or an Operand object */
502 switch (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc->Reference.Object))
504 case ACPI_DESC_TYPE_NAMED:
505 AcpiDmDecodeNode (ObjDesc->Reference.Object);
508 case ACPI_DESC_TYPE_OPERAND:
509 AcpiDmDecodeInternalObject (ObjDesc->Reference.Object);
517 case AML_INT_NAMEPATH_OP:
519 AcpiDmDecodeNode (ObjDesc->Reference.Node);
524 AcpiOsPrintf ("Unknown Reference opcode %X (%s)\n",
525 ObjDesc->Reference.Opcode,
526 AcpiPsGetOpcodeName (ObjDesc->Reference.Opcode));
533 AcpiOsPrintf ("<Obj> ");
534 AcpiDmDecodeInternalObject (ObjDesc);
542 AcpiOsPrintf ("<Not a valid ACPI Object Descriptor> [%s]",
543 AcpiUtGetDescriptorName (ObjDesc));
551 /*******************************************************************************
553 * FUNCTION: AcpiDmDisplayLocals
555 * PARAMETERS: WalkState - State for current method
559 * DESCRIPTION: Display all locals for the currently running control method
561 ******************************************************************************/
564 AcpiDmDisplayLocals (
565 ACPI_WALK_STATE *WalkState)
568 ACPI_OPERAND_OBJECT *ObjDesc;
569 ACPI_NAMESPACE_NODE *Node;
572 ObjDesc = WalkState->MethodDesc;
573 Node = WalkState->MethodNode;
577 "No method node (Executing subtree for buffer or opregion)\n");
581 if (Node->Type != ACPI_TYPE_METHOD)
583 AcpiOsPrintf ("Executing subtree for Buffer/Package/Region\n");
587 AcpiOsPrintf ("Local Variables for method [%4.4s]:\n",
588 AcpiUtGetNodeName (Node));
590 for (i = 0; i < ACPI_METHOD_NUM_LOCALS; i++)
592 ObjDesc = WalkState->LocalVariables[i].Object;
593 AcpiOsPrintf (" Local%X: ", i);
594 AcpiDmDisplayInternalObject (ObjDesc, WalkState);
599 /*******************************************************************************
601 * FUNCTION: AcpiDmDisplayArguments
603 * PARAMETERS: WalkState - State for current method
607 * DESCRIPTION: Display all arguments for the currently running control method
609 ******************************************************************************/
612 AcpiDmDisplayArguments (
613 ACPI_WALK_STATE *WalkState)
616 ACPI_OPERAND_OBJECT *ObjDesc;
617 ACPI_NAMESPACE_NODE *Node;
620 ObjDesc = WalkState->MethodDesc;
621 Node = WalkState->MethodNode;
625 "No method node (Executing subtree for buffer or opregion)\n");
629 if (Node->Type != ACPI_TYPE_METHOD)
631 AcpiOsPrintf ("Executing subtree for Buffer/Package/Region\n");
636 "Arguments for Method [%4.4s]: (%X arguments defined, max concurrency = %X)\n",
637 AcpiUtGetNodeName (Node), ObjDesc->Method.ParamCount, ObjDesc->Method.SyncLevel);
639 for (i = 0; i < ACPI_METHOD_NUM_ARGS; i++)
641 ObjDesc = WalkState->Arguments[i].Object;
642 AcpiOsPrintf (" Arg%d: ", i);
643 AcpiDmDisplayInternalObject (ObjDesc, WalkState);