1 /*******************************************************************************
3 * Module Name: dmwalk - AML disassembly tree walk
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/acparser.h>
120 #include <contrib/dev/acpica/amlcode.h>
121 #include <contrib/dev/acpica/acdisasm.h>
122 #include <contrib/dev/acpica/acdebug.h>
125 #ifdef ACPI_DISASSEMBLER
127 #define _COMPONENT ACPI_CA_DEBUGGER
128 ACPI_MODULE_NAME ("dmwalk")
131 #define DB_FULL_OP_INFO "[%4.4s] @%5.5X #%4.4X: "
133 /* Local prototypes */
137 ACPI_PARSE_OBJECT *Op,
143 ACPI_PARSE_OBJECT *Op,
149 ACPI_PARSE_OBJECT *Op);
152 /*******************************************************************************
154 * FUNCTION: AcpiDmDisassemble
156 * PARAMETERS: WalkState - Current state
157 * Origin - Starting object
158 * NumOpcodes - Max number of opcodes to be displayed
162 * DESCRIPTION: Disassemble parser object and its children. This is the
163 * main entry point of the disassembler.
165 ******************************************************************************/
169 ACPI_WALK_STATE *WalkState,
170 ACPI_PARSE_OBJECT *Origin,
173 ACPI_PARSE_OBJECT *Op = Origin;
174 ACPI_OP_WALK_INFO Info;
185 Info.WalkState = WalkState;
186 AcpiDmWalkParseTree (Op, AcpiDmDescendingOp, AcpiDmAscendingOp, &Info);
191 /*******************************************************************************
193 * FUNCTION: AcpiDmWalkParseTree
195 * PARAMETERS: Op - Root Op object
196 * DescendingCallback - Called during tree descent
197 * AscendingCallback - Called during tree ascent
198 * Context - To be passed to the callbacks
200 * RETURN: Status from callback(s)
202 * DESCRIPTION: Walk the entire parse tree.
204 ******************************************************************************/
207 AcpiDmWalkParseTree (
208 ACPI_PARSE_OBJECT *Op,
209 ASL_WALK_CALLBACK DescendingCallback,
210 ASL_WALK_CALLBACK AscendingCallback,
213 BOOLEAN NodePreviouslyVisited;
214 ACPI_PARSE_OBJECT *StartOp = Op;
216 ACPI_PARSE_OBJECT *Next;
217 ACPI_OP_WALK_INFO *Info = Context;
221 NodePreviouslyVisited = FALSE;
225 if (NodePreviouslyVisited)
227 if (AscendingCallback)
229 Status = AscendingCallback (Op, Info->Level, Context);
230 if (ACPI_FAILURE (Status))
238 /* Let the callback process the node */
240 Status = DescendingCallback (Op, Info->Level, Context);
241 if (ACPI_SUCCESS (Status))
243 /* Visit children first, once */
245 Next = AcpiPsGetArg (Op, 0);
253 else if (Status != AE_CTRL_DEPTH)
255 /* Exit immediately on any error */
261 /* Terminate walk at start op */
268 /* No more children, re-visit this node */
270 if (!NodePreviouslyVisited)
272 NodePreviouslyVisited = TRUE;
276 /* No more children, visit peers */
280 Op = Op->Common.Next;
281 NodePreviouslyVisited = FALSE;
285 /* No peers, re-visit parent */
287 if (Info->Level != 0 )
292 Op = Op->Common.Parent;
293 NodePreviouslyVisited = TRUE;
297 /* If we get here, the walk completed with no errors */
303 /*******************************************************************************
305 * FUNCTION: AcpiDmBlockType
307 * PARAMETERS: Op - Object to be examined
309 * RETURN: BlockType - not a block, parens, braces, or even both.
311 * DESCRIPTION: Type of block for this op (parens or braces)
313 ******************************************************************************/
317 ACPI_PARSE_OBJECT *Op)
319 const ACPI_OPCODE_INFO *OpInfo;
327 switch (Op->Common.AmlOpcode)
331 return (BLOCK_BRACE);
336 case AML_PROCESSOR_OP:
337 case AML_POWER_RES_OP:
338 case AML_THERMAL_ZONE_OP:
342 case AML_INDEX_FIELD_OP:
343 case AML_BANK_FIELD_OP:
345 return (BLOCK_PAREN | BLOCK_BRACE);
349 if (Op->Common.DisasmOpcode == ACPI_DASM_UNICODE)
354 /*lint -fallthrough */
357 case AML_VAR_PACKAGE_OP:
359 return (BLOCK_PAREN | BLOCK_BRACE);
363 return (BLOCK_PAREN);
367 OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
368 if (OpInfo->Flags & AML_HAS_ARGS)
370 return (BLOCK_PAREN);
378 /*******************************************************************************
380 * FUNCTION: AcpiDmListType
382 * PARAMETERS: Op - Object to be examined
384 * RETURN: ListType - has commas or not.
386 * DESCRIPTION: Type of block for this op (parens or braces)
388 ******************************************************************************/
392 ACPI_PARSE_OBJECT *Op)
394 const ACPI_OPCODE_INFO *OpInfo;
402 switch (Op->Common.AmlOpcode)
409 case AML_POWER_RES_OP:
410 case AML_PROCESSOR_OP:
411 case AML_THERMAL_ZONE_OP:
415 case AML_INDEX_FIELD_OP:
416 case AML_BANK_FIELD_OP:
422 case AML_VAR_PACKAGE_OP:
424 return (BLOCK_COMMA_LIST);
428 OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
429 if (OpInfo->Flags & AML_HAS_ARGS)
431 return (BLOCK_COMMA_LIST);
439 /*******************************************************************************
441 * FUNCTION: AcpiDmDescendingOp
443 * PARAMETERS: ASL_WALK_CALLBACK
447 * DESCRIPTION: First visitation of a parse object during tree descent.
448 * Decode opcode name and begin parameter list(s), if any.
450 ******************************************************************************/
454 ACPI_PARSE_OBJECT *Op,
458 ACPI_OP_WALK_INFO *Info = Context;
459 const ACPI_OPCODE_INFO *OpInfo;
461 ACPI_PARSE_OBJECT *NextOp;
462 ACPI_EXTERNAL_LIST *NextExternal;
465 if (Op->Common.DisasmFlags & ACPI_PARSEOP_IGNORE)
467 /* Ignore this op -- it was handled elsewhere */
469 return (AE_CTRL_DEPTH);
472 /* Level 0 is at the Definition Block level */
476 /* In verbose mode, print the AML offset, opcode and depth count */
480 VERBOSE_PRINT ((DB_FULL_OP_INFO,
481 (Info->WalkState->MethodNode ?
482 Info->WalkState->MethodNode->Name.Ascii : " "),
483 Op->Common.AmlOffset, (UINT32) Op->Common.AmlOpcode));
486 if (Op->Common.AmlOpcode == AML_SCOPE_OP)
488 /* This is the beginning of the Definition Block */
490 AcpiOsPrintf ("{\n");
492 /* Emit all External() declarations here */
494 if (AcpiGbl_ExternalList)
497 * Walk the list of externals (unresolved references)
498 * found during parsing
500 while (AcpiGbl_ExternalList)
502 AcpiOsPrintf (" External (%s",
503 AcpiGbl_ExternalList->Path);
505 /* TBD: should be a lookup table */
507 switch (AcpiGbl_ExternalList->Type)
509 case ACPI_TYPE_DEVICE:
510 AcpiOsPrintf (", DeviceObj");
513 case ACPI_TYPE_METHOD:
514 AcpiOsPrintf (", MethodObj");
517 case ACPI_TYPE_INTEGER:
518 AcpiOsPrintf (", IntObj");
525 if (AcpiGbl_ExternalList->Type == ACPI_TYPE_METHOD)
527 AcpiOsPrintf (") // %d Arguments\n", AcpiGbl_ExternalList->Value);
531 AcpiOsPrintf (")\n");
534 NextExternal = AcpiGbl_ExternalList->Next;
535 ACPI_FREE (AcpiGbl_ExternalList->Path);
536 ACPI_FREE (AcpiGbl_ExternalList);
537 AcpiGbl_ExternalList = NextExternal;
545 else if ((AcpiDmBlockType (Op->Common.Parent) & BLOCK_BRACE) &&
546 (!(Op->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST)) &&
547 (Op->Common.AmlOpcode != AML_INT_BYTELIST_OP))
550 * This is a first-level element of a term list,
553 AcpiDmIndent (Level);
554 Info->LastLevel = Level;
559 * This is an inexpensive mechanism to try and keep lines from getting
560 * too long. When the limit is hit, start a new line at the previous
561 * indent plus one. A better but more expensive mechanism would be to
562 * keep track of the current column.
565 if (Info->Count /*+Info->LastLevel*/ > 10)
569 AcpiDmIndent (Info->LastLevel + 1);
572 /* Print the opcode name */
574 AcpiDmDisassembleOneOp (NULL, Info, Op);
576 if (Op->Common.DisasmOpcode == ACPI_DASM_LNOT_PREFIX)
581 if ((Op->Common.AmlOpcode == AML_NAME_OP) ||
582 (Op->Common.AmlOpcode == AML_RETURN_OP))
587 /* Start the opcode argument list if necessary */
589 OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
591 if ((OpInfo->Flags & AML_HAS_ARGS) ||
592 (Op->Common.AmlOpcode == AML_EVENT_OP))
594 /* This opcode has an argument list */
596 if (AcpiDmBlockType (Op) & BLOCK_PAREN)
601 /* If this is a named opcode, print the associated name value */
603 if (OpInfo->Flags & AML_NAMED)
605 switch (Op->Common.AmlOpcode)
609 NextOp = AcpiPsGetDepthNext (NULL, Op);
610 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
611 AcpiDmNamestring (NextOp->Common.Value.Name);
614 /*lint -fallthrough */
618 Name = AcpiPsGetName (Op);
621 AcpiDmNamestring ((char *) Op->Named.Path);
625 AcpiDmDumpName ((char *) &Name);
628 if (Op->Common.AmlOpcode != AML_INT_NAMEDFIELD_OP)
630 if (AcpiGbl_DbOpt_verbose)
632 (void) AcpiPsDisplayObjectPathname (NULL, Op);
638 switch (Op->Common.AmlOpcode)
642 AcpiDmMethodFlags (Op);
649 /* Check for _HID and related EISAID() */
658 AcpiDmRegionFlags (Op);
662 case AML_POWER_RES_OP:
664 /* Mark the next two Ops as part of the parameter list */
667 NextOp = AcpiPsGetDepthNext (NULL, Op);
668 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_PARAMLIST;
670 NextOp = NextOp->Common.Next;
671 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_PARAMLIST;
675 case AML_PROCESSOR_OP:
677 /* Mark the next three Ops as part of the parameter list */
680 NextOp = AcpiPsGetDepthNext (NULL, Op);
681 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_PARAMLIST;
683 NextOp = NextOp->Common.Next;
684 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_PARAMLIST;
686 NextOp = NextOp->Common.Next;
687 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_PARAMLIST;
692 case AML_DATA_REGION_OP:
706 case AML_THERMAL_ZONE_OP:
714 AcpiOsPrintf ("*** Unhandled named opcode %X\n", Op->Common.AmlOpcode);
719 else switch (Op->Common.AmlOpcode)
722 case AML_BANK_FIELD_OP:
723 case AML_INDEX_FIELD_OP:
727 /* Name of the parent OperationRegion */
729 NextOp = AcpiPsGetDepthNext (NULL, Op);
730 AcpiDmNamestring (NextOp->Common.Value.Name);
732 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
734 switch (Op->Common.AmlOpcode)
736 case AML_BANK_FIELD_OP:
738 /* Namestring - Bank Name */
740 NextOp = AcpiPsGetDepthNext (NULL, NextOp);
741 AcpiDmNamestring (NextOp->Common.Value.Name);
742 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
746 * Bank Value. This is a TermArg in the middle of the parameter
747 * list, must handle it here.
749 * Disassemble the TermArg parse tree. ACPI_PARSEOP_PARAMLIST
750 * eliminates newline in the output.
752 NextOp = NextOp->Common.Next;
754 Info->Flags = ACPI_PARSEOP_PARAMLIST;
755 AcpiDmWalkParseTree (NextOp, AcpiDmDescendingOp, AcpiDmAscendingOp, Info);
759 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
763 case AML_INDEX_FIELD_OP:
765 /* Namestring - Data Name */
767 NextOp = AcpiPsGetDepthNext (NULL, NextOp);
768 AcpiDmNamestring (NextOp->Common.Value.Name);
770 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
778 AcpiDmFieldFlags (NextOp);
784 /* The next op is the size parameter */
786 NextOp = AcpiPsGetDepthNext (NULL, Op);
789 /* Single-step support */
794 if (Op->Common.DisasmOpcode == ACPI_DASM_RESOURCE)
797 * We have a resource list. Don't need to output
798 * the buffer size Op. Open up a new block
800 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
801 NextOp = NextOp->Common.Next;
802 AcpiOsPrintf (")\n");
803 AcpiDmIndent (Info->Level);
804 AcpiOsPrintf ("{\n");
808 /* Normal Buffer, mark size as in the parameter list */
810 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_PARAMLIST;
814 case AML_VAR_PACKAGE_OP:
818 /* The next op is the size or predicate parameter */
820 NextOp = AcpiPsGetDepthNext (NULL, Op);
823 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_PARAMLIST;
830 /* The next op is the size or predicate parameter */
832 NextOp = AcpiPsGetDepthNext (NULL, Op);
835 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_PARAMLIST;
851 if (AcpiDmBlockType (Op) & BLOCK_BRACE)
854 AcpiDmIndent (Level);
855 AcpiOsPrintf ("{\n");
863 /*******************************************************************************
865 * FUNCTION: AcpiDmAscendingOp
867 * PARAMETERS: ASL_WALK_CALLBACK
871 * DESCRIPTION: Second visitation of a parse object, during ascent of parse
872 * tree. Close out any parameter lists and complete the opcode.
874 ******************************************************************************/
878 ACPI_PARSE_OBJECT *Op,
882 ACPI_OP_WALK_INFO *Info = Context;
885 if (Op->Common.DisasmFlags & ACPI_PARSEOP_IGNORE)
887 /* Ignore this op -- it was handled elsewhere */
892 if ((Level == 0) && (Op->Common.AmlOpcode == AML_SCOPE_OP))
894 /* Indicates the end of the current descriptor block (table) */
896 AcpiOsPrintf ("}\n\n");
900 switch (AcpiDmBlockType (Op))
904 /* Completed an op that has arguments, add closing paren */
908 /* Could be a nested operator, check if comma required */
910 if (!AcpiDmCommaIfListMember (Op))
912 if ((AcpiDmBlockType (Op->Common.Parent) & BLOCK_BRACE) &&
913 (!(Op->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST)) &&
914 (Op->Common.AmlOpcode != AML_INT_BYTELIST_OP))
917 * This is a first-level element of a term list
920 if (!(Info->Flags & ACPI_PARSEOP_PARAMLIST))
930 case (BLOCK_BRACE | BLOCK_PAREN):
932 /* Completed an op that has a term list, add closing brace */
934 if (Op->Common.DisasmFlags & ACPI_PARSEOP_EMPTY_TERMLIST)
940 AcpiDmIndent (Level);
944 AcpiDmCommaIfListMember (Op);
946 if (AcpiDmBlockType (Op->Common.Parent) != BLOCK_PAREN)
949 if (!(Op->Common.DisasmFlags & ACPI_PARSEOP_EMPTY_TERMLIST))
951 if ((Op->Common.AmlOpcode == AML_IF_OP) &&
953 (Op->Common.Next->Common.AmlOpcode == AML_ELSE_OP))
958 if ((AcpiDmBlockType (Op->Common.Parent) & BLOCK_BRACE) &&
972 /* Could be a nested operator, check if comma required */
974 if (!AcpiDmCommaIfListMember (Op))
976 if ((AcpiDmBlockType (Op->Common.Parent) & BLOCK_BRACE) &&
977 (!(Op->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST)) &&
978 (Op->Common.AmlOpcode != AML_INT_BYTELIST_OP))
981 * This is a first-level element of a term list
987 else if (Op->Common.Parent)
989 switch (Op->Common.Parent->Common.AmlOpcode)
992 case AML_VAR_PACKAGE_OP:
994 if (!(Op->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST))
1008 if (Op->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST)
1010 if ((Op->Common.Next) &&
1011 (Op->Common.Next->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST))
1017 * Just completed a parameter node for something like "Buffer (param)".
1018 * Close the paren and open up the term list block with a brace
1020 if (Op->Common.Next)
1022 AcpiOsPrintf (")\n");
1023 AcpiDmIndent (Level - 1);
1024 AcpiOsPrintf ("{\n");
1028 Op->Common.Parent->Common.DisasmFlags |=
1029 ACPI_PARSEOP_EMPTY_TERMLIST;
1030 AcpiOsPrintf (") {");
1034 if ((Op->Common.AmlOpcode == AML_NAME_OP) ||
1035 (Op->Common.AmlOpcode == AML_RETURN_OP))
1043 #endif /* ACPI_DISASSEMBLER */