/******************************************************************************* * * Module Name: dmutils - AML disassembler utilities * ******************************************************************************/ /****************************************************************************** * * 1. Copyright Notice * * Some or all of this work - Copyright (c) 1999 - 2023, Intel Corp. * All rights reserved. * * 2. License * * 2.1. This is your license from Intel Corp. under its intellectual property * rights. You may have additional license terms from the party that provided * you this software, covering your right to use that party's intellectual * property rights. * * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a * copy of the source code appearing in this file ("Covered Code") an * irrevocable, perpetual, worldwide license under Intel's copyrights in the * base code distributed originally by Intel ("Original Intel Code") to copy, * make derivatives, distribute, use and display any portion of the Covered * Code in any form, with the right to sublicense such rights; and * * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent * license (with the right to sublicense), under only those claims of Intel * patents that are infringed by the Original Intel Code, to make, use, sell, * offer to sell, and import the Covered Code and derivative works thereof * solely to the minimum extent necessary to exercise the above copyright * license, and in no event shall the patent license extend to any additions * to or modifications of the Original Intel Code. No other license or right * is granted directly or by implication, estoppel or otherwise; * * The above copyright and patent license is granted only if the following * conditions are met: * * 3. Conditions * * 3.1. Redistribution of Source with Rights to Further Distribute Source. * Redistribution of source code of any substantial portion of the Covered * Code or modification with rights to further distribute source must include * the above Copyright Notice, the above License, this list of Conditions, * and the following Disclaimer and Export Compliance provision. In addition, * Licensee must cause all Covered Code to which Licensee contributes to * contain a file documenting the changes Licensee made to create that Covered * Code and the date of any change. Licensee must include in that file the * documentation of any changes made by any predecessor Licensee. Licensee * must include a prominent statement that the modification is derived, * directly or indirectly, from Original Intel Code. * * 3.2. Redistribution of Source with no Rights to Further Distribute Source. * Redistribution of source code of any substantial portion of the Covered * Code or modification without rights to further distribute source must * include the following Disclaimer and Export Compliance provision in the * documentation and/or other materials provided with distribution. In * addition, Licensee may not authorize further sublicense of source of any * portion of the Covered Code, and must include terms to the effect that the * license from Licensee to its licensee is limited to the intellectual * property embodied in the software Licensee provides to its licensee, and * not to intellectual property embodied in modifications its licensee may * make. * * 3.3. Redistribution of Executable. Redistribution in executable form of any * substantial portion of the Covered Code or modification must reproduce the * above Copyright Notice, and the following Disclaimer and Export Compliance * provision in the documentation and/or other materials provided with the * distribution. * * 3.4. Intel retains all right, title, and interest in and to the Original * Intel Code. * * 3.5. Neither the name Intel nor any other trademark owned or controlled by * Intel shall be used in advertising or otherwise to promote the sale, use or * other dealings in products derived from or relating to the Covered Code * without prior written authorization from Intel. * * 4. Disclaimer and Export Compliance * * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A * PARTICULAR PURPOSE. * * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY * LIMITED REMEDY. * * 4.3. Licensee shall not export, either directly or indirectly, any of this * software or system incorporating such software without first obtaining any * required license or other approval from the U. S. Department of Commerce or * any other agency or department of the United States Government. In the * event Licensee exports any such software from the United States or * re-exports any such software from a foreign destination, Licensee shall * ensure that the distribution and export/re-export of the software is in * compliance with all laws, regulations, orders, or other restrictions of the * U.S. Export Administration Regulations. Licensee agrees that neither it nor * any of its subsidiaries will export/re-export any technical data, process, * software, or service, directly or indirectly, to any country for which the * United States government or any agency thereof requires an export license, * other governmental approval, or letter of assurance, without first obtaining * such license, approval or letter. * ***************************************************************************** * * Alternatively, you may choose to be licensed under the terms of the * following license: * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions, and the following disclaimer, * without modification. * 2. Redistributions in binary form must reproduce at minimum a disclaimer * substantially similar to the "NO WARRANTY" disclaimer below * ("Disclaimer") and any redistribution must be conditioned upon * including a substantially similar Disclaimer requirement for further * binary redistribution. * 3. Neither the names of the above-listed copyright holders nor the names * of any contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * * Alternatively, you may choose to be licensed under the terms of the * GNU General Public License ("GPL") version 2 as published by the Free * Software Foundation. * *****************************************************************************/ #include #include #include #include #include #ifdef ACPI_ASL_COMPILER #include #endif #define _COMPONENT ACPI_CA_DEBUGGER ACPI_MODULE_NAME ("dmutils") /* Data used in keeping track of fields */ #if 0 const char *AcpiGbl_FENames[] = { "skip", "?access?" }; /* FE = Field Element */ #endif /* Operators for Match() */ const char *AcpiGbl_MatchOps[] = { "MTR", "MEQ", "MLE", "MLT", "MGE", "MGT" }; /* Access type decoding */ const char *AcpiGbl_AccessTypes[] = { "AnyAcc", "ByteAcc", "WordAcc", "DWordAcc", "QWordAcc", "BufferAcc", "InvalidAccType", "InvalidAccType" }; /* Lock rule decoding */ const char *AcpiGbl_LockRule[] = { "NoLock", "Lock" }; /* Update rule decoding */ const char *AcpiGbl_UpdateRules[] = { "Preserve", "WriteAsOnes", "WriteAsZeros", "InvalidUpdateRule" }; /* Strings used to decode resource descriptors */ const char *AcpiGbl_WordDecode[] = { "Memory", "IO", "BusNumber", "UnknownResourceType" }; const char *AcpiGbl_IrqDecode[] = { "IRQNoFlags", "IRQ" }; /******************************************************************************* * * FUNCTION: AcpiDmDecodeAttribute * * PARAMETERS: Attribute - Attribute field of AccessAs keyword * * RETURN: None * * DESCRIPTION: Decode the AccessAs attribute byte. (Mostly SMBus and * GenericSerialBus stuff.) * ******************************************************************************/ void AcpiDmDecodeAttribute ( UINT8 Attribute) { switch (Attribute) { case AML_FIELD_ATTRIB_QUICK: AcpiOsPrintf ("AttribQuick"); break; case AML_FIELD_ATTRIB_SEND_RECEIVE: AcpiOsPrintf ("AttribSendReceive"); break; case AML_FIELD_ATTRIB_BYTE: AcpiOsPrintf ("AttribByte"); break; case AML_FIELD_ATTRIB_WORD: AcpiOsPrintf ("AttribWord"); break; case AML_FIELD_ATTRIB_BLOCK: AcpiOsPrintf ("AttribBlock"); break; case AML_FIELD_ATTRIB_BYTES: AcpiOsPrintf ("AttribBytes"); break; case AML_FIELD_ATTRIB_PROCESS_CALL: AcpiOsPrintf ("AttribProcessCall"); break; case AML_FIELD_ATTRIB_BLOCK_PROCESS_CALL: AcpiOsPrintf ("AttribBlockProcessCall"); break; case AML_FIELD_ATTRIB_RAW_BYTES: AcpiOsPrintf ("AttribRawBytes"); break; case AML_FIELD_ATTRIB_RAW_PROCESS_BYTES: AcpiOsPrintf ("AttribRawProcessBytes"); break; default: /* A ByteConst is allowed by the grammar */ AcpiOsPrintf ("0x%2.2X", Attribute); break; } } /******************************************************************************* * * FUNCTION: AcpiDmIndent * * PARAMETERS: Level - Current source code indentation level * * RETURN: None * * DESCRIPTION: Indent 4 spaces per indentation level. * ******************************************************************************/ void AcpiDmIndent ( UINT32 Level) { if (!Level) { return; } AcpiOsPrintf ("%*.s", (Level * 4), " "); } /******************************************************************************* * * FUNCTION: AcpiDmCommaIfListMember * * PARAMETERS: Op - Current operator/operand * * RETURN: TRUE if a comma was inserted * * DESCRIPTION: Insert a comma if this Op is a member of an argument list. * ******************************************************************************/ BOOLEAN AcpiDmCommaIfListMember ( ACPI_PARSE_OBJECT *Op) { if (!Op->Common.Next) { ASL_CV_PRINT_ONE_COMMENT (Op, AMLCOMMENT_INLINE, NULL, 0); return (FALSE); } if (AcpiDmListType (Op->Common.Parent) & BLOCK_COMMA_LIST) { /* Exit if Target has been marked IGNORE */ if (Op->Common.Next->Common.DisasmFlags & ACPI_PARSEOP_IGNORE) { ASL_CV_PRINT_ONE_COMMENT (Op, AMLCOMMENT_INLINE, NULL, 0); return (FALSE); } /* Check for a NULL target operand */ if ((Op->Common.Next->Common.AmlOpcode == AML_INT_NAMEPATH_OP) && (!Op->Common.Next->Common.Value.String)) { /* * To handle the Divide() case where there are two optional * targets, look ahead one more op. If null, this null target * is the one and only target -- no comma needed. Otherwise, * we need a comma to prepare for the next target. */ if (!Op->Common.Next->Common.Next) { ASL_CV_PRINT_ONE_COMMENT (Op, AMLCOMMENT_INLINE, NULL, 0); return (FALSE); } } if ((Op->Common.DisasmFlags & ACPI_PARSEOP_PARAMETER_LIST) && (!(Op->Common.Next->Common.DisasmFlags & ACPI_PARSEOP_PARAMETER_LIST))) { ASL_CV_PRINT_ONE_COMMENT (Op, AMLCOMMENT_INLINE, NULL, 0); return (FALSE); } /* Emit comma only if this is not a C-style operator */ if (!Op->Common.OperatorSymbol) { AcpiOsPrintf (", "); ASL_CV_PRINT_ONE_COMMENT (Op, AMLCOMMENT_INLINE, NULL, 0); } return (TRUE); } else if ((Op->Common.DisasmFlags & ACPI_PARSEOP_PARAMETER_LIST) && (Op->Common.Next->Common.DisasmFlags & ACPI_PARSEOP_PARAMETER_LIST)) { AcpiOsPrintf (", "); ASL_CV_PRINT_ONE_COMMENT (Op, AMLCOMMENT_INLINE, NULL, 0); return (TRUE); } return (FALSE); } /******************************************************************************* * * FUNCTION: AcpiDmCommaIfFieldMember * * PARAMETERS: Op - Current operator/operand * * RETURN: None * * DESCRIPTION: Insert a comma if this Op is a member of a Field argument list. * ******************************************************************************/ void AcpiDmCommaIfFieldMember ( ACPI_PARSE_OBJECT *Op) { if (Op->Common.Next) { AcpiOsPrintf (", "); } }