1 /*******************************************************************************
3 * Module Name: dmwalk - AML disassembly tree walk
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 *****************************************************************************/
116 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/dmwalk.c,v 1.1 2003/09/24 03:32:15 drhodus Exp $ */
120 #include "acparser.h"
122 #include "acdisasm.h"
126 #ifdef ACPI_DISASSEMBLER
128 #define _COMPONENT ACPI_CA_DEBUGGER
129 ACPI_MODULE_NAME ("dmwalk")
132 #define DB_FULL_OP_INFO "%5.5X #%4.4hX "
135 /*******************************************************************************
137 * FUNCTION: AcpiDmDisassemble
139 * PARAMETERS: Origin - Starting object
140 * NumOpcodes - Max number of opcodes to be displayed
144 * DESCRIPTION: Disassemble parser object and its children. This is the
145 * main entry point of the disassembler.
147 ******************************************************************************/
151 ACPI_WALK_STATE *WalkState,
152 ACPI_PARSE_OBJECT *Origin,
155 ACPI_PARSE_OBJECT *Op = Origin;
156 ACPI_OP_WALK_INFO Info;
165 AcpiDmWalkParseTree (Op, AcpiDmDescendingOp, AcpiDmAscendingOp, &Info);
171 /*******************************************************************************
173 * FUNCTION: AcpiDmWalkParseTree
175 * PARAMETERS: DescendingCallback - Called during tree descent
176 * AscendingCallback - Called during tree ascent
177 * Context - To be passed to the callbacks
179 * RETURN: Status from callback(s)
181 * DESCRIPTION: Walk the entire parse tree.
183 ******************************************************************************/
186 AcpiDmWalkParseTree (
187 ACPI_PARSE_OBJECT *Op,
188 ASL_WALK_CALLBACK DescendingCallback,
189 ASL_WALK_CALLBACK AscendingCallback,
192 BOOLEAN NodePreviouslyVisited;
193 ACPI_PARSE_OBJECT *StartOp = Op;
195 ACPI_PARSE_OBJECT *Next;
196 ACPI_OP_WALK_INFO *Info = Context;
200 NodePreviouslyVisited = FALSE;
204 if (NodePreviouslyVisited)
206 Status = AscendingCallback (Op, Info->Level, Context);
207 if (ACPI_FAILURE (Status))
215 * Let the callback process the node.
217 Status = DescendingCallback (Op, Info->Level, Context);
218 if (ACPI_SUCCESS (Status))
220 /* Visit children first, once */
222 Next = AcpiPsGetArg (Op, 0);
230 else if (Status != AE_CTRL_DEPTH)
232 /* Exit immediately on any error */
238 /* Terminate walk at start op */
245 /* No more children, re-visit this node */
247 if (!NodePreviouslyVisited)
249 NodePreviouslyVisited = TRUE;
253 /* No more children, visit peers */
257 Op = Op->Common.Next;
258 NodePreviouslyVisited = FALSE;
262 /* No peers, re-visit parent */
264 if (Info->Level != 0 )
269 Op = Op->Common.Parent;
270 NodePreviouslyVisited = TRUE;
274 /* If we get here, the walk completed with no errors */
280 /*******************************************************************************
282 * FUNCTION: AcpiDmBlockType
284 * PARAMETERS: Op - Object to be examined
288 * DESCRIPTION: Type of block for this op (parens or braces)
290 ******************************************************************************/
294 ACPI_PARSE_OBJECT *Op)
296 const ACPI_OPCODE_INFO *OpInfo;
304 switch (Op->Common.AmlOpcode)
308 return (BLOCK_BRACE);
313 case AML_PROCESSOR_OP:
314 case AML_POWER_RES_OP:
315 case AML_THERMAL_ZONE_OP:
319 case AML_INDEX_FIELD_OP:
320 case AML_BANK_FIELD_OP:
322 return (BLOCK_PAREN | BLOCK_BRACE);
326 if (Op->Common.DisasmOpcode == ACPI_DASM_UNICODE)
331 /*lint -fallthrough */
334 case AML_VAR_PACKAGE_OP:
336 return (BLOCK_PAREN | BLOCK_BRACE);
340 return (BLOCK_PAREN);
344 OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
345 if (OpInfo->Flags & AML_HAS_ARGS)
347 return (BLOCK_PAREN);
355 /*******************************************************************************
357 * FUNCTION: AcpiDmListType
359 * PARAMETERS: Op - Object to be examined
363 * DESCRIPTION: Type of block for this op (parens or braces)
365 ******************************************************************************/
369 ACPI_PARSE_OBJECT *Op)
371 const ACPI_OPCODE_INFO *OpInfo;
379 switch (Op->Common.AmlOpcode)
386 case AML_POWER_RES_OP:
387 case AML_PROCESSOR_OP:
388 case AML_THERMAL_ZONE_OP:
392 case AML_INDEX_FIELD_OP:
393 case AML_BANK_FIELD_OP:
399 case AML_VAR_PACKAGE_OP:
401 return (BLOCK_COMMA_LIST);
405 OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
406 if (OpInfo->Flags & AML_HAS_ARGS)
408 return (BLOCK_COMMA_LIST);
416 /*******************************************************************************
418 * FUNCTION: AcpiDmDescendingOp
420 * PARAMETERS: ASL_WALK_CALLBACK
424 * DESCRIPTION: First visitation of a parse object during tree descent.
425 * Decode opcode name and begin parameter list(s), if any.
427 ******************************************************************************/
431 ACPI_PARSE_OBJECT *Op,
435 ACPI_OP_WALK_INFO *Info = Context;
436 const ACPI_OPCODE_INFO *OpInfo;
438 ACPI_PARSE_OBJECT *NextOp;
441 if (Op->Common.DisasmFlags & ACPI_PARSEOP_IGNORE)
443 /* Ignore this op -- it was handled elsewhere */
445 return (AE_CTRL_DEPTH);
451 /* In verbose mode, print the AML offset, opcode and depth count */
453 VERBOSE_PRINT ((DB_FULL_OP_INFO, (UINT32) Op->Common.AmlOffset,
454 Op->Common.AmlOpcode));
456 if (Op->Common.AmlOpcode == AML_SCOPE_OP)
458 AcpiOsPrintf ("{\n");
462 else if ((AcpiDmBlockType (Op->Common.Parent) & BLOCK_BRACE) &&
463 (!(Op->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST)) &&
464 (Op->Common.AmlOpcode != AML_INT_BYTELIST_OP))
466 /* This is a first-level element of a term list, indent a new line */
468 AcpiDmIndent (Level);
471 /* Print the opcode name */
473 AcpiDmDisassembleOneOp (NULL, Info, Op);
475 if ((Op->Common.AmlOpcode == AML_NAME_OP) ||
476 (Op->Common.AmlOpcode == AML_RETURN_OP))
482 * Start the opcode argument list if necessary
484 OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
486 if ((OpInfo->Flags & AML_HAS_ARGS) ||
487 (Op->Common.AmlOpcode == AML_EVENT_OP))
489 /* This opcode has an argument list */
491 if (AcpiDmBlockType (Op) & BLOCK_PAREN)
497 * If this is a named opcode, print the associated name value
499 if (OpInfo->Flags & AML_NAMED)
501 switch (Op->Common.AmlOpcode)
505 NextOp = AcpiPsGetDepthNext (NULL, Op);
506 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
507 AcpiDmNamestring (NextOp->Common.Value.Name);
510 /*lint -fallthrough */
514 Name = AcpiPsGetName (Op);
517 AcpiDmNamestring ((char *) Op->Named.Path);
521 AcpiDmDumpName ((char *) &Name);
525 if (Op->Common.AmlOpcode != AML_INT_NAMEDFIELD_OP)
527 AcpiDmValidateName ((char *) &Name, Op);
528 if (AcpiGbl_DbOpt_verbose)
530 (void) AcpiPsDisplayObjectPathname (NULL, Op);
536 switch (Op->Common.AmlOpcode)
540 AcpiDmMethodFlags (Op);
547 /* Check for _HID and related EISAID() */
556 AcpiDmRegionFlags (Op);
560 case AML_POWER_RES_OP:
562 /* Mark the next two Ops as part of the parameter list */
565 NextOp = AcpiPsGetDepthNext (NULL, Op);
566 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_PARAMLIST;
568 NextOp = NextOp->Common.Next;
569 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_PARAMLIST;
573 case AML_PROCESSOR_OP:
575 /* Mark the next three Ops as part of the parameter list */
578 NextOp = AcpiPsGetDepthNext (NULL, Op);
579 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_PARAMLIST;
581 NextOp = NextOp->Common.Next;
582 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_PARAMLIST;
584 NextOp = NextOp->Common.Next;
585 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_PARAMLIST;
603 case AML_THERMAL_ZONE_OP:
611 AcpiOsPrintf ("*** Unhandled named opcode\n");
616 else switch (Op->Common.AmlOpcode)
619 case AML_BANK_FIELD_OP:
620 case AML_INDEX_FIELD_OP:
624 /* Name of the parent OperationRegion */
626 NextOp = AcpiPsGetDepthNext (NULL, Op);
627 AcpiDmNamestring (NextOp->Common.Value.Name);
629 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
631 switch (Op->Common.AmlOpcode)
633 case AML_BANK_FIELD_OP:
637 NextOp = AcpiPsGetDepthNext (NULL, NextOp);
638 AcpiDmNamestring (NextOp->Common.Value.Name);
639 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
643 NextOp = NextOp->Common.Next;
644 AcpiDmDisassembleOneOp (NULL, Info, NextOp);
645 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
649 case AML_INDEX_FIELD_OP:
653 NextOp = AcpiPsGetDepthNext (NULL, NextOp);
654 AcpiDmNamestring (NextOp->Common.Value.Name);
656 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
664 AcpiDmFieldFlags (NextOp);
670 /* The next op is the size parameter */
672 NextOp = AcpiPsGetDepthNext (NULL, Op);
675 /* Single-step support */
680 if (Op->Common.DisasmOpcode == ACPI_DASM_RESOURCE)
683 * We have a resource list. Don't need to output
684 * the buffer size Op. Open up a new block
686 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
687 NextOp = NextOp->Common.Next;
688 AcpiOsPrintf (")\n");
689 AcpiDmIndent (Info->Level);
690 AcpiOsPrintf ("{\n");
694 /* Normal Buffer, mark size as in the parameter list */
696 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_PARAMLIST;
700 case AML_VAR_PACKAGE_OP:
704 /* The next op is the size or predicate parameter */
706 NextOp = AcpiPsGetDepthNext (NULL, Op);
709 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_PARAMLIST;
716 /* The next op is the size or predicate parameter */
718 NextOp = AcpiPsGetDepthNext (NULL, Op);
721 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_PARAMLIST;
737 if (AcpiDmBlockType (Op) & BLOCK_BRACE)
740 AcpiDmIndent (Level);
741 AcpiOsPrintf ("{\n");
749 /*******************************************************************************
751 * FUNCTION: AcpiDmAscendingOp
753 * PARAMETERS: ASL_WALK_CALLBACK
757 * DESCRIPTION: Second visitation of a parse object, during ascent of parse
758 * tree. Close out any parameter lists and complete the opcode.
760 ******************************************************************************/
764 ACPI_PARSE_OBJECT *Op,
768 ACPI_OP_WALK_INFO *Info = Context;
771 if (Op->Common.DisasmFlags & ACPI_PARSEOP_IGNORE)
773 /* Ignore this op -- it was handled elsewhere */
778 if ((Level == 0) && (Op->Common.AmlOpcode == AML_SCOPE_OP))
780 /* Indicates the end of the current descriptor block (table) */
782 AcpiOsPrintf ("}\n\n");
786 switch (AcpiDmBlockType (Op))
790 /* Completed an op that has arguments, add closing paren */
794 /* Could be a nested operator, check if comma required */
796 if (!AcpiDmCommaIfListMember (Op))
798 if ((AcpiDmBlockType (Op->Common.Parent) & BLOCK_BRACE) &&
799 (!(Op->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST)) &&
800 (Op->Common.AmlOpcode != AML_INT_BYTELIST_OP))
802 /* This is a first-level element of a term list, start a new line */
811 case (BLOCK_BRACE | BLOCK_PAREN):
813 /* Completed an op that has a term list, add closing brace */
815 if (Op->Common.DisasmFlags & ACPI_PARSEOP_EMPTY_TERMLIST)
821 AcpiDmIndent (Level);
825 AcpiDmCommaIfListMember (Op);
827 if (AcpiDmBlockType (Op->Common.Parent) != BLOCK_PAREN)
830 if (!(Op->Common.DisasmFlags & ACPI_PARSEOP_EMPTY_TERMLIST))
832 if ((Op->Common.AmlOpcode == AML_IF_OP) &&
834 (Op->Common.Next->Common.AmlOpcode == AML_ELSE_OP))
839 if ((AcpiDmBlockType (Op->Common.Parent) & BLOCK_BRACE) &&
853 /* Could be a nested operator, check if comma required */
855 if (!AcpiDmCommaIfListMember (Op))
857 if ((AcpiDmBlockType (Op->Common.Parent) & BLOCK_BRACE) &&
858 (!(Op->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST)) &&
859 (Op->Common.AmlOpcode != AML_INT_BYTELIST_OP))
861 /* This is a first-level element of a term list, start a new line */
866 else if (Op->Common.Parent)
868 switch (Op->Common.Parent->Common.AmlOpcode)
871 case AML_VAR_PACKAGE_OP:
873 if (!(Op->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST))
887 if (Op->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST)
889 if ((Op->Common.Next) &&
890 (Op->Common.Next->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST))
896 * Just completed a parameter node for something like "Buffer (param)".
897 * Close the paren and open up the term list block with a brace
901 AcpiOsPrintf (")\n");
902 AcpiDmIndent (Level - 1);
903 AcpiOsPrintf ("{\n");
907 Op->Common.Parent->Common.DisasmFlags |= ACPI_PARSEOP_EMPTY_TERMLIST;
908 AcpiOsPrintf (") {");
912 if ((Op->Common.AmlOpcode == AML_NAME_OP) ||
913 (Op->Common.AmlOpcode == AML_RETURN_OP))
921 #endif /* ACPI_DISASSEMBLER */