1 /*******************************************************************************
3 * Module Name: dmwalk - AML disassembly tree walk
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2013, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
45 #include <contrib/dev/acpica/include/acpi.h>
46 #include <contrib/dev/acpica/include/accommon.h>
47 #include <contrib/dev/acpica/include/acparser.h>
48 #include <contrib/dev/acpica/include/amlcode.h>
49 #include <contrib/dev/acpica/include/acdisasm.h>
50 #include <contrib/dev/acpica/include/acdebug.h>
53 #ifdef ACPI_DISASSEMBLER
55 #define _COMPONENT ACPI_CA_DEBUGGER
56 ACPI_MODULE_NAME ("dmwalk")
59 #define DB_FULL_OP_INFO "[%4.4s] @%5.5X #%4.4X: "
61 /* Stub for non-compiler code */
63 #ifndef ACPI_ASL_COMPILER
72 /* Local prototypes */
76 ACPI_PARSE_OBJECT *Op,
82 ACPI_PARSE_OBJECT *Op,
88 ACPI_PARSE_OBJECT *Op);
91 /*******************************************************************************
93 * FUNCTION: AcpiDmDisassemble
95 * PARAMETERS: WalkState - Current state
96 * Origin - Starting object
97 * NumOpcodes - Max number of opcodes to be displayed
101 * DESCRIPTION: Disassemble parser object and its children. This is the
102 * main entry point of the disassembler.
104 ******************************************************************************/
108 ACPI_WALK_STATE *WalkState,
109 ACPI_PARSE_OBJECT *Origin,
112 ACPI_PARSE_OBJECT *Op = Origin;
113 ACPI_OP_WALK_INFO Info;
124 Info.WalkState = WalkState;
125 AcpiDmWalkParseTree (Op, AcpiDmDescendingOp, AcpiDmAscendingOp, &Info);
130 /*******************************************************************************
132 * FUNCTION: AcpiDmWalkParseTree
134 * PARAMETERS: Op - Root Op object
135 * DescendingCallback - Called during tree descent
136 * AscendingCallback - Called during tree ascent
137 * Context - To be passed to the callbacks
139 * RETURN: Status from callback(s)
141 * DESCRIPTION: Walk the entire parse tree.
143 ******************************************************************************/
146 AcpiDmWalkParseTree (
147 ACPI_PARSE_OBJECT *Op,
148 ASL_WALK_CALLBACK DescendingCallback,
149 ASL_WALK_CALLBACK AscendingCallback,
152 BOOLEAN NodePreviouslyVisited;
153 ACPI_PARSE_OBJECT *StartOp = Op;
155 ACPI_PARSE_OBJECT *Next;
156 ACPI_OP_WALK_INFO *Info = Context;
160 NodePreviouslyVisited = FALSE;
164 if (NodePreviouslyVisited)
166 if (AscendingCallback)
168 Status = AscendingCallback (Op, Info->Level, Context);
169 if (ACPI_FAILURE (Status))
177 /* Let the callback process the node */
179 Status = DescendingCallback (Op, Info->Level, Context);
180 if (ACPI_SUCCESS (Status))
182 /* Visit children first, once */
184 Next = AcpiPsGetArg (Op, 0);
192 else if (Status != AE_CTRL_DEPTH)
194 /* Exit immediately on any error */
200 /* Terminate walk at start op */
207 /* No more children, re-visit this node */
209 if (!NodePreviouslyVisited)
211 NodePreviouslyVisited = TRUE;
215 /* No more children, visit peers */
219 Op = Op->Common.Next;
220 NodePreviouslyVisited = FALSE;
224 /* No peers, re-visit parent */
226 if (Info->Level != 0 )
231 Op = Op->Common.Parent;
232 NodePreviouslyVisited = TRUE;
236 /* If we get here, the walk completed with no errors */
242 /*******************************************************************************
244 * FUNCTION: AcpiDmBlockType
246 * PARAMETERS: Op - Object to be examined
248 * RETURN: BlockType - not a block, parens, braces, or even both.
250 * DESCRIPTION: Type of block for this op (parens or braces)
252 ******************************************************************************/
256 ACPI_PARSE_OBJECT *Op)
258 const ACPI_OPCODE_INFO *OpInfo;
266 switch (Op->Common.AmlOpcode)
270 return (BLOCK_BRACE);
275 case AML_PROCESSOR_OP:
276 case AML_POWER_RES_OP:
277 case AML_THERMAL_ZONE_OP:
281 case AML_INDEX_FIELD_OP:
282 case AML_BANK_FIELD_OP:
284 return (BLOCK_PAREN | BLOCK_BRACE);
288 if (Op->Common.DisasmOpcode == ACPI_DASM_UNICODE)
293 /*lint -fallthrough */
296 case AML_VAR_PACKAGE_OP:
298 return (BLOCK_PAREN | BLOCK_BRACE);
302 return (BLOCK_PAREN);
306 OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
307 if (OpInfo->Flags & AML_HAS_ARGS)
309 return (BLOCK_PAREN);
317 /*******************************************************************************
319 * FUNCTION: AcpiDmListType
321 * PARAMETERS: Op - Object to be examined
323 * RETURN: ListType - has commas or not.
325 * DESCRIPTION: Type of block for this op (parens or braces)
327 ******************************************************************************/
331 ACPI_PARSE_OBJECT *Op)
333 const ACPI_OPCODE_INFO *OpInfo;
341 switch (Op->Common.AmlOpcode)
348 case AML_POWER_RES_OP:
349 case AML_PROCESSOR_OP:
350 case AML_THERMAL_ZONE_OP:
354 case AML_INDEX_FIELD_OP:
355 case AML_BANK_FIELD_OP:
361 case AML_VAR_PACKAGE_OP:
363 return (BLOCK_COMMA_LIST);
367 OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
368 if (OpInfo->Flags & AML_HAS_ARGS)
370 return (BLOCK_COMMA_LIST);
378 /*******************************************************************************
380 * FUNCTION: AcpiDmDescendingOp
382 * PARAMETERS: ASL_WALK_CALLBACK
386 * DESCRIPTION: First visitation of a parse object during tree descent.
387 * Decode opcode name and begin parameter list(s), if any.
389 ******************************************************************************/
393 ACPI_PARSE_OBJECT *Op,
397 ACPI_OP_WALK_INFO *Info = Context;
398 const ACPI_OPCODE_INFO *OpInfo;
400 ACPI_PARSE_OBJECT *NextOp;
403 if (Op->Common.DisasmFlags & ACPI_PARSEOP_IGNORE)
405 /* Ignore this op -- it was handled elsewhere */
407 return (AE_CTRL_DEPTH);
410 /* Level 0 is at the Definition Block level */
414 /* In verbose mode, print the AML offset, opcode and depth count */
418 VERBOSE_PRINT ((DB_FULL_OP_INFO,
419 (Info->WalkState->MethodNode ?
420 Info->WalkState->MethodNode->Name.Ascii : " "),
421 Op->Common.AmlOffset, (UINT32) Op->Common.AmlOpcode));
424 if (Op->Common.AmlOpcode == AML_SCOPE_OP)
426 /* This is the beginning of the Definition Block */
428 AcpiOsPrintf ("{\n");
430 /* Emit all External() declarations here */
432 AcpiDmEmitExternals ();
436 else if ((AcpiDmBlockType (Op->Common.Parent) & BLOCK_BRACE) &&
437 (!(Op->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST)) &&
438 (Op->Common.AmlOpcode != AML_INT_BYTELIST_OP))
441 * This is a first-level element of a term list,
444 switch (Op->Common.AmlOpcode)
448 * Optionally just ignore this opcode. Some tables use
449 * NoOp opcodes for "padding" out packages that the BIOS
450 * changes dynamically. This can leave hundreds or
451 * thousands of NoOp opcodes that if disassembled,
452 * cannot be compiled because they are syntactically
455 if (AcpiGbl_IgnoreNoopOperator)
457 Op->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
465 AcpiDmIndent (Level);
469 Info->LastLevel = Level;
474 * This is an inexpensive mechanism to try and keep lines from getting
475 * too long. When the limit is hit, start a new line at the previous
476 * indent plus one. A better but more expensive mechanism would be to
477 * keep track of the current column.
480 if (Info->Count /* +Info->LastLevel */ > 10)
484 AcpiDmIndent (Info->LastLevel + 1);
487 /* Print the opcode name */
489 AcpiDmDisassembleOneOp (NULL, Info, Op);
491 if ((Op->Common.DisasmOpcode == ACPI_DASM_LNOT_PREFIX) ||
492 (Op->Common.AmlOpcode == AML_INT_CONNECTION_OP))
497 if ((Op->Common.AmlOpcode == AML_NAME_OP) ||
498 (Op->Common.AmlOpcode == AML_RETURN_OP))
503 /* Start the opcode argument list if necessary */
505 OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
507 if ((OpInfo->Flags & AML_HAS_ARGS) ||
508 (Op->Common.AmlOpcode == AML_EVENT_OP))
510 /* This opcode has an argument list */
512 if (AcpiDmBlockType (Op) & BLOCK_PAREN)
517 /* If this is a named opcode, print the associated name value */
519 if (OpInfo->Flags & AML_NAMED)
521 switch (Op->Common.AmlOpcode)
525 NextOp = AcpiPsGetDepthNext (NULL, Op);
526 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
527 AcpiDmNamestring (NextOp->Common.Value.Name);
530 /*lint -fallthrough */
534 Name = AcpiPsGetName (Op);
537 AcpiDmNamestring ((char *) Op->Named.Path);
541 AcpiDmDumpName (Name);
544 if (Op->Common.AmlOpcode != AML_INT_NAMEDFIELD_OP)
546 if (AcpiGbl_DbOpt_verbose)
548 (void) AcpiPsDisplayObjectPathname (NULL, Op);
554 switch (Op->Common.AmlOpcode)
558 AcpiDmMethodFlags (Op);
561 /* Emit description comment for Method() with a predefined ACPI name */
563 AcpiDmPredefinedDescription (Op);
569 /* Check for _HID and related EISAID() */
578 AcpiDmRegionFlags (Op);
582 case AML_POWER_RES_OP:
584 /* Mark the next two Ops as part of the parameter list */
587 NextOp = AcpiPsGetDepthNext (NULL, Op);
588 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_PARAMLIST;
590 NextOp = NextOp->Common.Next;
591 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_PARAMLIST;
595 case AML_PROCESSOR_OP:
597 /* Mark the next three Ops as part of the parameter list */
600 NextOp = AcpiPsGetDepthNext (NULL, Op);
601 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_PARAMLIST;
603 NextOp = NextOp->Common.Next;
604 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_PARAMLIST;
606 NextOp = NextOp->Common.Next;
607 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_PARAMLIST;
612 case AML_DATA_REGION_OP:
626 case AML_THERMAL_ZONE_OP:
634 AcpiOsPrintf ("*** Unhandled named opcode %X\n",
635 Op->Common.AmlOpcode);
640 else switch (Op->Common.AmlOpcode)
643 case AML_BANK_FIELD_OP:
644 case AML_INDEX_FIELD_OP:
648 /* Name of the parent OperationRegion */
650 NextOp = AcpiPsGetDepthNext (NULL, Op);
651 AcpiDmNamestring (NextOp->Common.Value.Name);
653 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
655 switch (Op->Common.AmlOpcode)
657 case AML_BANK_FIELD_OP:
659 /* Namestring - Bank Name */
661 NextOp = AcpiPsGetDepthNext (NULL, NextOp);
662 AcpiDmNamestring (NextOp->Common.Value.Name);
663 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
667 * Bank Value. This is a TermArg in the middle of the parameter
668 * list, must handle it here.
670 * Disassemble the TermArg parse tree. ACPI_PARSEOP_PARAMLIST
671 * eliminates newline in the output.
673 NextOp = NextOp->Common.Next;
675 Info->Flags = ACPI_PARSEOP_PARAMLIST;
676 AcpiDmWalkParseTree (NextOp, AcpiDmDescendingOp,
677 AcpiDmAscendingOp, Info);
681 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
685 case AML_INDEX_FIELD_OP:
687 /* Namestring - Data Name */
689 NextOp = AcpiPsGetDepthNext (NULL, NextOp);
690 AcpiDmNamestring (NextOp->Common.Value.Name);
692 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
700 AcpiDmFieldFlags (NextOp);
705 /* The next op is the size parameter */
707 NextOp = AcpiPsGetDepthNext (NULL, Op);
710 /* Single-step support */
715 if (Op->Common.DisasmOpcode == ACPI_DASM_RESOURCE)
718 * We have a resource list. Don't need to output
719 * the buffer size Op. Open up a new block
721 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE;
722 NextOp = NextOp->Common.Next;
725 /* Emit description comment for Name() with a predefined ACPI name */
727 AcpiDmPredefinedDescription (Op->Asl.Parent);
730 AcpiDmIndent (Info->Level);
731 AcpiOsPrintf ("{\n");
735 /* Normal Buffer, mark size as in the parameter list */
737 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_PARAMLIST;
740 case AML_VAR_PACKAGE_OP:
744 /* The next op is the size or predicate parameter */
746 NextOp = AcpiPsGetDepthNext (NULL, Op);
749 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_PARAMLIST;
755 /* The next op is the size parameter */
757 NextOp = AcpiPsGetDepthNext (NULL, Op);
760 NextOp->Common.DisasmFlags |= ACPI_PARSEOP_PARAMLIST;
774 if (AcpiDmBlockType (Op) & BLOCK_BRACE)
777 AcpiDmIndent (Level);
778 AcpiOsPrintf ("{\n");
786 /*******************************************************************************
788 * FUNCTION: AcpiDmAscendingOp
790 * PARAMETERS: ASL_WALK_CALLBACK
794 * DESCRIPTION: Second visitation of a parse object, during ascent of parse
795 * tree. Close out any parameter lists and complete the opcode.
797 ******************************************************************************/
801 ACPI_PARSE_OBJECT *Op,
805 ACPI_OP_WALK_INFO *Info = Context;
806 ACPI_PARSE_OBJECT *ParentOp;
809 if (Op->Common.DisasmFlags & ACPI_PARSEOP_IGNORE)
811 /* Ignore this op -- it was handled elsewhere */
816 if ((Level == 0) && (Op->Common.AmlOpcode == AML_SCOPE_OP))
818 /* Indicates the end of the current descriptor block (table) */
820 AcpiOsPrintf ("}\n\n");
824 switch (AcpiDmBlockType (Op))
828 /* Completed an op that has arguments, add closing paren */
832 if (Op->Common.AmlOpcode == AML_NAME_OP)
834 /* Emit description comment for Name() with a predefined ACPI name */
836 AcpiDmPredefinedDescription (Op);
840 /* For Create* operators, attempt to emit resource tag description */
842 AcpiDmFieldPredefinedDescription (Op);
845 /* Could be a nested operator, check if comma required */
847 if (!AcpiDmCommaIfListMember (Op))
849 if ((AcpiDmBlockType (Op->Common.Parent) & BLOCK_BRACE) &&
850 (!(Op->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST)) &&
851 (Op->Common.AmlOpcode != AML_INT_BYTELIST_OP))
854 * This is a first-level element of a term list
857 if (!(Info->Flags & ACPI_PARSEOP_PARAMLIST))
866 case (BLOCK_BRACE | BLOCK_PAREN):
868 /* Completed an op that has a term list, add closing brace */
870 if (Op->Common.DisasmFlags & ACPI_PARSEOP_EMPTY_TERMLIST)
876 AcpiDmIndent (Level);
880 AcpiDmCommaIfListMember (Op);
882 if (AcpiDmBlockType (Op->Common.Parent) != BLOCK_PAREN)
885 if (!(Op->Common.DisasmFlags & ACPI_PARSEOP_EMPTY_TERMLIST))
887 if ((Op->Common.AmlOpcode == AML_IF_OP) &&
889 (Op->Common.Next->Common.AmlOpcode == AML_ELSE_OP))
894 if ((AcpiDmBlockType (Op->Common.Parent) & BLOCK_BRACE) &&
907 /* Could be a nested operator, check if comma required */
909 if (!AcpiDmCommaIfListMember (Op))
911 if ((AcpiDmBlockType (Op->Common.Parent) & BLOCK_BRACE) &&
912 (!(Op->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST)) &&
913 (Op->Common.AmlOpcode != AML_INT_BYTELIST_OP))
916 * This is a first-level element of a term list
922 else if (Op->Common.Parent)
924 switch (Op->Common.Parent->Common.AmlOpcode)
927 case AML_VAR_PACKAGE_OP:
929 if (!(Op->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST))
943 if (Op->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST)
945 if ((Op->Common.Next) &&
946 (Op->Common.Next->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST))
952 * Just completed a parameter node for something like "Buffer (param)".
953 * Close the paren and open up the term list block with a brace
959 /* Emit description comment for Name() with a predefined ACPI name */
961 ParentOp = Op->Common.Parent;
964 ParentOp = ParentOp->Common.Parent;
965 if (ParentOp && ParentOp->Asl.AmlOpcode == AML_NAME_OP)
967 AcpiDmPredefinedDescription (ParentOp);
971 AcpiDmIndent (Level - 1);
972 AcpiOsPrintf ("{\n");
976 Op->Common.Parent->Common.DisasmFlags |=
977 ACPI_PARSEOP_EMPTY_TERMLIST;
978 AcpiOsPrintf (") {");
982 if ((Op->Common.AmlOpcode == AML_NAME_OP) ||
983 (Op->Common.AmlOpcode == AML_RETURN_OP))
991 #endif /* ACPI_DISASSEMBLER */