1 /*******************************************************************************
3 * Module Name: dbobject - ACPI object decode and display
5 ******************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2018, 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 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
150 *****************************************************************************/
152 #include <contrib/dev/acpica/include/acpi.h>
153 #include <contrib/dev/acpica/include/accommon.h>
154 #include <contrib/dev/acpica/include/acnamesp.h>
155 #include <contrib/dev/acpica/include/acdebug.h>
158 #define _COMPONENT ACPI_CA_DEBUGGER
159 ACPI_MODULE_NAME ("dbobject")
162 /* Local prototypes */
166 ACPI_NAMESPACE_NODE *Node);
169 /*******************************************************************************
171 * FUNCTION: AcpiDbDumpMethodInfo
173 * PARAMETERS: Status - Method execution status
174 * WalkState - Current state of the parse tree walk
178 * DESCRIPTION: Called when a method has been aborted because of an error.
179 * Dumps the method execution stack, and the method locals/args,
180 * and disassembles the AML opcode that failed.
182 ******************************************************************************/
185 AcpiDbDumpMethodInfo (
187 ACPI_WALK_STATE *WalkState)
189 ACPI_THREAD_STATE *Thread;
190 ACPI_NAMESPACE_NODE *Node;
193 Node = WalkState->MethodNode;
195 /* There are no locals or arguments for the module-level code case */
197 if (Node == AcpiGbl_RootNode)
202 /* Ignore control codes, they are not errors */
204 if ((Status & AE_CODE_MASK) == AE_CODE_CONTROL)
209 /* We may be executing a deferred opcode */
211 if (WalkState->DeferredNode)
213 AcpiOsPrintf ("Executing subtree for Buffer/Package/Region\n");
218 * If there is no Thread, we are not actually executing a method.
219 * This can happen when the iASL compiler calls the interpreter
220 * to perform constant folding.
222 Thread = WalkState->Thread;
228 /* Display the method locals and arguments */
231 AcpiDbDecodeLocals (WalkState);
233 AcpiDbDecodeArguments (WalkState);
238 /*******************************************************************************
240 * FUNCTION: AcpiDbDecodeInternalObject
242 * PARAMETERS: ObjDesc - Object to be displayed
246 * DESCRIPTION: Short display of an internal object. Numbers/Strings/Buffers.
248 ******************************************************************************/
251 AcpiDbDecodeInternalObject (
252 ACPI_OPERAND_OBJECT *ObjDesc)
259 AcpiOsPrintf (" Uninitialized");
263 if (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc) != ACPI_DESC_TYPE_OPERAND)
265 AcpiOsPrintf (" %p [%s]", ObjDesc,
266 AcpiUtGetDescriptorName (ObjDesc));
270 AcpiOsPrintf (" %s", AcpiUtGetObjectTypeName (ObjDesc));
272 switch (ObjDesc->Common.Type)
274 case ACPI_TYPE_INTEGER:
276 AcpiOsPrintf (" %8.8X%8.8X",
277 ACPI_FORMAT_UINT64 (ObjDesc->Integer.Value));
280 case ACPI_TYPE_STRING:
282 AcpiOsPrintf ("(%u) \"%.60s",
283 ObjDesc->String.Length, ObjDesc->String.Pointer);
285 if (ObjDesc->String.Length > 60)
287 AcpiOsPrintf ("...");
295 case ACPI_TYPE_BUFFER:
297 AcpiOsPrintf ("(%u)", ObjDesc->Buffer.Length);
298 for (i = 0; (i < 8) && (i < ObjDesc->Buffer.Length); i++)
300 AcpiOsPrintf (" %2.2X", ObjDesc->Buffer.Pointer[i]);
306 AcpiOsPrintf (" %p", ObjDesc);
312 /*******************************************************************************
314 * FUNCTION: AcpiDbDecodeNode
316 * PARAMETERS: Node - Object to be displayed
320 * DESCRIPTION: Short display of a namespace node
322 ******************************************************************************/
326 ACPI_NAMESPACE_NODE *Node)
329 AcpiOsPrintf ("<Node> Name %4.4s",
330 AcpiUtGetNodeName (Node));
332 if (Node->Flags & ANOBJ_METHOD_ARG)
334 AcpiOsPrintf (" [Method Arg]");
336 if (Node->Flags & ANOBJ_METHOD_LOCAL)
338 AcpiOsPrintf (" [Method Local]");
343 /* These types have no attached object */
345 case ACPI_TYPE_DEVICE:
347 AcpiOsPrintf (" Device");
350 case ACPI_TYPE_THERMAL:
352 AcpiOsPrintf (" Thermal Zone");
357 AcpiDbDecodeInternalObject (AcpiNsGetAttachedObject (Node));
363 /*******************************************************************************
365 * FUNCTION: AcpiDbDisplayInternalObject
367 * PARAMETERS: ObjDesc - Object to be displayed
368 * WalkState - Current walk state
372 * DESCRIPTION: Short display of an internal object
374 ******************************************************************************/
377 AcpiDbDisplayInternalObject (
378 ACPI_OPERAND_OBJECT *ObjDesc,
379 ACPI_WALK_STATE *WalkState)
384 AcpiOsPrintf ("%p ", ObjDesc);
388 AcpiOsPrintf ("<Null Object>\n");
392 /* Decode the object type */
394 switch (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc))
396 case ACPI_DESC_TYPE_PARSER:
398 AcpiOsPrintf ("<Parser> ");
401 case ACPI_DESC_TYPE_NAMED:
403 AcpiDbDecodeNode ((ACPI_NAMESPACE_NODE *) ObjDesc);
406 case ACPI_DESC_TYPE_OPERAND:
408 Type = ObjDesc->Common.Type;
409 if (Type > ACPI_TYPE_LOCAL_MAX)
411 AcpiOsPrintf (" Type %X [Invalid Type]", (UINT32) Type);
415 /* Decode the ACPI object type */
417 switch (ObjDesc->Common.Type)
419 case ACPI_TYPE_LOCAL_REFERENCE:
421 AcpiOsPrintf ("[%s] ", AcpiUtGetReferenceName (ObjDesc));
423 /* Decode the refererence */
425 switch (ObjDesc->Reference.Class)
427 case ACPI_REFCLASS_LOCAL:
429 AcpiOsPrintf ("%X ", ObjDesc->Reference.Value);
432 ObjDesc = WalkState->LocalVariables
433 [ObjDesc->Reference.Value].Object;
434 AcpiOsPrintf ("%p", ObjDesc);
435 AcpiDbDecodeInternalObject (ObjDesc);
439 case ACPI_REFCLASS_ARG:
441 AcpiOsPrintf ("%X ", ObjDesc->Reference.Value);
444 ObjDesc = WalkState->Arguments
445 [ObjDesc->Reference.Value].Object;
446 AcpiOsPrintf ("%p", ObjDesc);
447 AcpiDbDecodeInternalObject (ObjDesc);
451 case ACPI_REFCLASS_INDEX:
453 switch (ObjDesc->Reference.TargetType)
455 case ACPI_TYPE_BUFFER_FIELD:
457 AcpiOsPrintf ("%p", ObjDesc->Reference.Object);
458 AcpiDbDecodeInternalObject (ObjDesc->Reference.Object);
461 case ACPI_TYPE_PACKAGE:
463 AcpiOsPrintf ("%p", ObjDesc->Reference.Where);
464 if (!ObjDesc->Reference.Where)
466 AcpiOsPrintf (" Uninitialized WHERE pointer");
470 AcpiDbDecodeInternalObject (
471 *(ObjDesc->Reference.Where));
477 AcpiOsPrintf ("Unknown index target type");
482 case ACPI_REFCLASS_REFOF:
484 if (!ObjDesc->Reference.Object)
487 "Uninitialized reference subobject pointer");
491 /* Reference can be to a Node or an Operand object */
493 switch (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc->Reference.Object))
495 case ACPI_DESC_TYPE_NAMED:
497 AcpiDbDecodeNode (ObjDesc->Reference.Object);
500 case ACPI_DESC_TYPE_OPERAND:
502 AcpiDbDecodeInternalObject (ObjDesc->Reference.Object);
510 case ACPI_REFCLASS_NAME:
512 AcpiDbDecodeNode (ObjDesc->Reference.Node);
515 case ACPI_REFCLASS_DEBUG:
516 case ACPI_REFCLASS_TABLE:
521 default: /* Unknown reference class */
523 AcpiOsPrintf ("%2.2X\n", ObjDesc->Reference.Class);
530 AcpiOsPrintf ("<Obj> ");
531 AcpiDbDecodeInternalObject (ObjDesc);
538 AcpiOsPrintf ("<Not a valid ACPI Object Descriptor> [%s]",
539 AcpiUtGetDescriptorName (ObjDesc));
547 /*******************************************************************************
549 * FUNCTION: AcpiDbDecodeLocals
551 * PARAMETERS: WalkState - State for current method
555 * DESCRIPTION: Display all locals for the currently running control method
557 ******************************************************************************/
561 ACPI_WALK_STATE *WalkState)
564 ACPI_OPERAND_OBJECT *ObjDesc;
565 ACPI_NAMESPACE_NODE *Node;
566 BOOLEAN DisplayLocals = FALSE;
569 Node = WalkState->MethodNode;
570 ObjDesc = WalkState->MethodDesc;
572 /* There are no locals for the module-level code case */
574 if (Node == AcpiGbl_RootNode)
582 "No method node (Executing subtree for buffer or opregion)\n");
586 if (Node->Type != ACPI_TYPE_METHOD)
588 AcpiOsPrintf ("Executing subtree for Buffer/Package/Region\n");
592 /* Are any locals actually set? */
594 for (i = 0; i < ACPI_METHOD_NUM_LOCALS; i++)
596 ObjDesc = WalkState->LocalVariables[i].Object;
599 DisplayLocals = TRUE;
604 /* If any are set, only display the ones that are set */
608 AcpiOsPrintf ("\nInitialized Local Variables for Method [%4.4s]:\n",
609 AcpiUtGetNodeName (Node));
611 for (i = 0; i < ACPI_METHOD_NUM_LOCALS; i++)
613 ObjDesc = WalkState->LocalVariables[i].Object;
616 AcpiOsPrintf (" Local%X: ", i);
617 AcpiDbDisplayInternalObject (ObjDesc, WalkState);
624 "No Local Variables are initialized for Method [%4.4s]\n",
625 AcpiUtGetNodeName (Node));
630 /*******************************************************************************
632 * FUNCTION: AcpiDbDecodeArguments
634 * PARAMETERS: WalkState - State for current method
638 * DESCRIPTION: Display all arguments for the currently running control method
640 ******************************************************************************/
643 AcpiDbDecodeArguments (
644 ACPI_WALK_STATE *WalkState)
647 ACPI_OPERAND_OBJECT *ObjDesc;
648 ACPI_NAMESPACE_NODE *Node;
649 BOOLEAN DisplayArgs = FALSE;
652 Node = WalkState->MethodNode;
653 ObjDesc = WalkState->MethodDesc;
655 /* There are no arguments for the module-level code case */
657 if (Node == AcpiGbl_RootNode)
665 "No method node (Executing subtree for buffer or opregion)\n");
669 if (Node->Type != ACPI_TYPE_METHOD)
671 AcpiOsPrintf ("Executing subtree for Buffer/Package/Region\n");
675 /* Are any arguments actually set? */
677 for (i = 0; i < ACPI_METHOD_NUM_ARGS; i++)
679 ObjDesc = WalkState->Arguments[i].Object;
687 /* If any are set, only display the ones that are set */
692 "Initialized Arguments for Method [%4.4s]: "
693 "(%X arguments defined for method invocation)\n",
694 AcpiUtGetNodeName (Node), Node->Object->Method.ParamCount);
696 for (i = 0; i < ACPI_METHOD_NUM_ARGS; i++)
698 ObjDesc = WalkState->Arguments[i].Object;
701 AcpiOsPrintf (" Arg%u: ", i);
702 AcpiDbDisplayInternalObject (ObjDesc, WalkState);
709 "No Arguments are initialized for method [%4.4s]\n",
710 AcpiUtGetNodeName (Node));