1 /*******************************************************************************
3 * Module Name: dmutils - AML disassembler utilities
6 ******************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2004, 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 *****************************************************************************/
120 #include "acdisasm.h"
121 #include "acnamesp.h"
124 #ifdef ACPI_DISASSEMBLER
126 #define _COMPONENT ACPI_CA_DEBUGGER
127 ACPI_MODULE_NAME ("dmutils")
130 ACPI_EXTERNAL_LIST *AcpiGbl_ExternalList = NULL;
133 /* Data used in keeping track of fields */
135 const char *AcpiGbl_FENames[ACPI_NUM_FIELD_NAMES] =
139 }; /* FE = Field Element */
143 const char *AcpiGbl_MatchOps[ACPI_NUM_MATCH_OPS] =
154 /* Access type decoding */
156 const char *AcpiGbl_AccessTypes[ACPI_NUM_ACCESS_TYPES] =
167 /* Lock rule decoding */
169 const char *AcpiGbl_LockRule[ACPI_NUM_LOCK_RULES] =
175 /* Update rule decoding */
177 const char *AcpiGbl_UpdateRules[ACPI_NUM_UPDATE_RULES] =
185 * Strings used to decode resource descriptors
187 const char *AcpiGbl_IoDecode[2] =
193 const char *AcpiGbl_WordDecode[4] =
198 "Unknown-resource-type"
201 const char *AcpiGbl_ConsumeDecode[2] =
207 const char *AcpiGbl_MinDecode[2] =
213 const char *AcpiGbl_MaxDecode[2] =
219 const char *AcpiGbl_DECDecode[2] =
225 const char *AcpiGbl_RNGDecode[4] =
233 const char *AcpiGbl_MEMDecode[4] =
241 const char *AcpiGbl_RWDecode[2] =
247 const char *AcpiGbl_IrqDecode[2] =
253 const char *AcpiGbl_HEDecode[2] =
259 const char *AcpiGbl_LLDecode[2] =
265 const char *AcpiGbl_SHRDecode[2] =
271 const char *AcpiGbl_TYPDecode[4] =
279 const char *AcpiGbl_BMDecode[2] =
285 const char *AcpiGbl_SIZDecode[4] =
294 /*******************************************************************************
296 * FUNCTION: AcpiDmAddToExternalList
298 * PARAMETERS: Path - Internal (AML) path to the object
302 * DESCRIPTION: Insert a new path into the list of Externals which will in
303 * turn be emitted as an External() declaration in the disassembled
306 ******************************************************************************/
309 AcpiDmAddToExternalList (
313 ACPI_EXTERNAL_LIST *NewExternal;
322 /* Externalize the ACPI path */
324 Status = AcpiNsExternalizeName (ACPI_UINT32_MAX, Path,
325 NULL, &ExternalPath);
326 if (ACPI_SUCCESS (Status))
328 /* Allocate and init a new External() descriptor */
330 NewExternal = ACPI_MEM_CALLOCATE (sizeof (ACPI_EXTERNAL_LIST));
331 NewExternal->Path = ExternalPath;
333 /* Link the new descriptor into the global list */
335 if (AcpiGbl_ExternalList)
337 NewExternal->Next = AcpiGbl_ExternalList;
339 AcpiGbl_ExternalList = NewExternal;
344 /*******************************************************************************
346 * FUNCTION: AcpiDmDecodeAttribute
348 * PARAMETERS: Attribute - Attribute field of AccessAs keyword
352 * DESCRIPTION: Decode the AccessAs attribute byte. (Mostly SMBus stuff)
354 ******************************************************************************/
357 AcpiDmDecodeAttribute (
363 case AML_FIELD_ATTRIB_SMB_QUICK:
365 AcpiOsPrintf ("SMBQuick");
368 case AML_FIELD_ATTRIB_SMB_SEND_RCV:
370 AcpiOsPrintf ("SMBSendReceive");
373 case AML_FIELD_ATTRIB_SMB_BYTE:
375 AcpiOsPrintf ("SMBByte");
378 case AML_FIELD_ATTRIB_SMB_WORD:
380 AcpiOsPrintf ("SMBWord");
383 case AML_FIELD_ATTRIB_SMB_WORD_CALL:
385 AcpiOsPrintf ("SMBProcessCall");
388 case AML_FIELD_ATTRIB_SMB_BLOCK:
390 AcpiOsPrintf ("SMBBlock");
393 case AML_FIELD_ATTRIB_SMB_BLOCK_CALL:
395 AcpiOsPrintf ("SMBBlockProcessCall");
400 AcpiOsPrintf ("0x%.2X", Attribute);
406 /*******************************************************************************
408 * FUNCTION: AcpiDmIndent
410 * PARAMETERS: Level - Current source code indentation level
414 * DESCRIPTION: Indent 4 spaces per indentation level.
416 ******************************************************************************/
428 AcpiOsPrintf ("%*.s", ACPI_MUL_4 (Level), " ");
432 /*******************************************************************************
434 * FUNCTION: AcpiDmCommaIfListMember
436 * PARAMETERS: Op - Current operator/operand
438 * RETURN: TRUE if a comma was inserted
440 * DESCRIPTION: Insert a comma if this Op is a member of an argument list.
442 ******************************************************************************/
445 AcpiDmCommaIfListMember (
446 ACPI_PARSE_OBJECT *Op)
449 if (!Op->Common.Next)
454 if (AcpiDmListType (Op->Common.Parent) & BLOCK_COMMA_LIST)
456 /* Check for a NULL target operand */
458 if ((Op->Common.Next->Common.AmlOpcode == AML_INT_NAMEPATH_OP) &&
459 (!Op->Common.Next->Common.Value.String))
462 * To handle the Divide() case where there are two optional
463 * targets, look ahead one more op. If null, this null target
464 * is the one and only target -- no comma needed. Otherwise,
465 * we need a comma to prepare for the next target.
467 if (!Op->Common.Next->Common.Next)
473 if ((Op->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST) &&
474 (!(Op->Common.Next->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST)))
483 else if ((Op->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST) &&
484 (Op->Common.Next->Common.DisasmFlags & ACPI_PARSEOP_PARAMLIST))
494 /*******************************************************************************
496 * FUNCTION: AcpiDmCommaIfFieldMember
498 * PARAMETERS: Op - Current operator/operand
502 * DESCRIPTION: Insert a comma if this Op is a member of a Field argument list.
504 ******************************************************************************/
507 AcpiDmCommaIfFieldMember (
508 ACPI_PARSE_OBJECT *Op)