/****************************************************************************** * * Module Name: aslopcode - AML opcode generation * *****************************************************************************/ /****************************************************************************** * * 1. Copyright Notice * * Some or all of this work - Copyright (c) 1999 - 2010, 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. * *****************************************************************************/ #include "aslcompiler.h" #include "aslcompiler.y.h" #include "amlcode.h" #define _COMPONENT ACPI_COMPILER ACPI_MODULE_NAME ("aslopcodes") /* UUID support */ static UINT8 OpcMapToUUID[16] = { 6,4,2,0,11,9,16,14,19,21,24,26,28,30,32,34 }; /* Local prototypes */ static void OpcDoAccessAs ( ACPI_PARSE_OBJECT *Op); static void OpcDoUnicode ( ACPI_PARSE_OBJECT *Op); static void OpcDoEisaId ( ACPI_PARSE_OBJECT *Op); static void OpcDoUuId ( ACPI_PARSE_OBJECT *Op); /******************************************************************************* * * FUNCTION: OpcAmlOpcodeUpdateWalk * * PARAMETERS: ASL_WALK_CALLBACK * * RETURN: Status * * DESCRIPTION: Opcode update walk, ascending callback * ******************************************************************************/ ACPI_STATUS OpcAmlOpcodeUpdateWalk ( ACPI_PARSE_OBJECT *Op, UINT32 Level, void *Context) { /* * Handle the Package() case where the actual opcode cannot be determined * until the PackageLength operand has been folded and minimized. * (PackageOp versus VarPackageOp) * * This is (as of ACPI 3.0) the only case where the AML opcode can change * based upon the value of a parameter. * * The parser always inserts a VarPackage opcode, which can possibly be * optimized to a Package opcode. */ if (Op->Asl.ParseOpcode == PARSEOP_VAR_PACKAGE) { OpnDoPackage (Op); } return (AE_OK); } /******************************************************************************* * * FUNCTION: OpcAmlOpcodeWalk * * PARAMETERS: ASL_WALK_CALLBACK * * RETURN: Status * * DESCRIPTION: Parse tree walk to generate both the AML opcodes and the AML * operands. * ******************************************************************************/ ACPI_STATUS OpcAmlOpcodeWalk ( ACPI_PARSE_OBJECT *Op, UINT32 Level, void *Context) { TotalParseNodes++; OpcGenerateAmlOpcode (Op); OpnGenerateAmlOperands (Op); return (AE_OK); } /******************************************************************************* * * FUNCTION: OpcGetIntegerWidth * * PARAMETERS: Op - DEFINITION BLOCK op * * RETURN: none * * DESCRIPTION: Extract integer width from the table revision * ******************************************************************************/ void OpcGetIntegerWidth ( ACPI_PARSE_OBJECT *Op) { ACPI_PARSE_OBJECT *Child; if (!Op) { return; } if (Gbl_RevisionOverride) { AcpiUtSetIntegerWidth (Gbl_RevisionOverride); } else { Child = Op->Asl.Child; Child = Child->Asl.Next; Child = Child->Asl.Next; /* Use the revision to set the integer width */ AcpiUtSetIntegerWidth ((UINT8) Child->Asl.Value.Integer); } } /******************************************************************************* * * FUNCTION: OpcSetOptimalIntegerSize * * PARAMETERS: Op - A parse tree node * * RETURN: Integer width, in bytes. Also sets the node AML opcode to the * optimal integer AML prefix opcode. * * DESCRIPTION: Determine the optimal AML encoding of an integer. All leading * zeros can be truncated to squeeze the integer into the * minimal number of AML bytes. * ******************************************************************************/ UINT32 OpcSetOptimalIntegerSize ( ACPI_PARSE_OBJECT *Op) { #if 0 /* * TBD: - we don't want to optimize integers in the block header, but the * code below does not work correctly. */ if (Op->Asl.Parent && Op->Asl.Parent->Asl.Parent && (Op->Asl.Parent->Asl.Parent->Asl.ParseOpcode == PARSEOP_DEFINITIONBLOCK)) { return 0; } #endif /* * Check for the special AML integers first - Zero, One, Ones. * These are single-byte opcodes that are the smallest possible * representation of an integer. * * This optimization is optional. */ if (Gbl_IntegerOptimizationFlag) { switch (Op->Asl.Value.Integer) { case 0: Op->Asl.AmlOpcode = AML_ZERO_OP; AslError (ASL_OPTIMIZATION, ASL_MSG_INTEGER_OPTIMIZATION, Op, "Zero"); return 1; case 1: Op->Asl.AmlOpcode = AML_ONE_OP; AslError (ASL_OPTIMIZATION, ASL_MSG_INTEGER_OPTIMIZATION, Op, "One"); return 1; case ACPI_UINT32_MAX: /* Check for table integer width (32 or 64) */ if (AcpiGbl_IntegerByteWidth == 4) { Op->Asl.AmlOpcode = AML_ONES_OP; AslError (ASL_OPTIMIZATION, ASL_MSG_INTEGER_OPTIMIZATION, Op, "Ones"); return 1; } break; case ACPI_UINT64_MAX: /* Check for table integer width (32 or 64) */ if (AcpiGbl_IntegerByteWidth == 8) { Op->Asl.AmlOpcode = AML_ONES_OP; AslError (ASL_OPTIMIZATION, ASL_MSG_INTEGER_OPTIMIZATION, Op, "Ones"); return 1; } break; default: break; } } /* Find the best fit using the various AML integer prefixes */ if (Op->Asl.Value.Integer <= ACPI_UINT8_MAX) { Op->Asl.AmlOpcode = AML_BYTE_OP; return 1; } if (Op->Asl.Value.Integer <= ACPI_UINT16_MAX) { Op->Asl.AmlOpcode = AML_WORD_OP; return 2; } if (Op->Asl.Value.Integer <= ACPI_UINT32_MAX) { Op->Asl.AmlOpcode = AML_DWORD_OP; return 4; } else { if (AcpiGbl_IntegerByteWidth == 4) { AslError (ASL_WARNING, ASL_MSG_INTEGER_LENGTH, Op, NULL); if (!Gbl_IgnoreErrors) { /* Truncate the integer to 32-bit */ Op->Asl.AmlOpcode = AML_DWORD_OP; return 4; } } Op->Asl.AmlOpcode = AML_QWORD_OP; return 8; } } /******************************************************************************* * * FUNCTION: OpcDoAccessAs * * PARAMETERS: Op - Parse node * * RETURN: None * * DESCRIPTION: Implement the ACCESS_AS ASL keyword. * ******************************************************************************/ static void OpcDoAccessAs ( ACPI_PARSE_OBJECT *Op) { ACPI_PARSE_OBJECT *Next; Op->Asl.AmlOpcodeLength = 1; Next = Op->Asl.Child; /* First child is the access type */ Next->Asl.AmlOpcode = AML_RAW_DATA_BYTE; Next->Asl.ParseOpcode = PARSEOP_RAW_DATA; /* Second child is the optional access attribute */ Next = Next->Asl.Next; if (Next->Asl.ParseOpcode == PARSEOP_DEFAULT_ARG) { Next->Asl.Value.Integer = 0; } Next->Asl.AmlOpcode = AML_RAW_DATA_BYTE; Next->Asl.ParseOpcode = PARSEOP_RAW_DATA; } /******************************************************************************* * * FUNCTION: OpcDoUnicode * * PARAMETERS: Op - Parse node * * RETURN: None * * DESCRIPTION: Implement the UNICODE ASL "macro". Convert the input string * to a unicode buffer. There is no Unicode AML opcode. * * Note: The Unicode string is 16 bits per character, no leading signature, * with a 16-bit terminating NULL. * ******************************************************************************/ static void OpcDoUnicode ( ACPI_PARSE_OBJECT *Op) { ACPI_PARSE_OBJECT *InitializerOp; UINT32 Length; UINT32 Count; UINT32 i; UINT8 *AsciiString; UINT16 *UnicodeString; ACPI_PARSE_OBJECT *BufferLengthOp; /* Change op into a buffer object */ Op->Asl.CompileFlags &= ~NODE_COMPILE_TIME_CONST; Op->Asl.ParseOpcode = PARSEOP_BUFFER; UtSetParseOpName (Op); /* Buffer Length is first, followed by the string */ BufferLengthOp = Op->Asl.Child; InitializerOp = BufferLengthOp->Asl.Next; AsciiString = (UINT8 *) InitializerOp->Asl.Value.String; /* Create a new buffer for the Unicode string */ Count = strlen (InitializerOp->Asl.Value.String) + 1; Length = Count * sizeof (UINT16); UnicodeString = UtLocalCalloc (Length); /* Convert to Unicode string (including null terminator) */ for (i = 0; i < Count; i++) { UnicodeString[i] = (UINT16) AsciiString[i]; } /* * Just set the buffer size node to be the buffer length, regardless * of whether it was previously an integer or a default_arg placeholder */ BufferLengthOp->Asl.ParseOpcode = PARSEOP_INTEGER; BufferLengthOp->Asl.AmlOpcode = AML_DWORD_OP; BufferLengthOp->Asl.Value.Integer = Length; UtSetParseOpName (BufferLengthOp); (void) OpcSetOptimalIntegerSize (BufferLengthOp); /* The Unicode string is a raw data buffer */ InitializerOp->Asl.Value.Buffer = (UINT8 *) UnicodeString; InitializerOp->Asl.AmlOpcode = AML_RAW_DATA_BUFFER; InitializerOp->Asl.AmlLength = Length; InitializerOp->Asl.ParseOpcode = PARSEOP_RAW_DATA; InitializerOp->Asl.Child = NULL; UtSetParseOpName (InitializerOp); } /******************************************************************************* * * FUNCTION: OpcDoEisaId * * PARAMETERS: Op - Parse node * * RETURN: None * * DESCRIPTION: Convert a string EISA ID to numeric representation. See the * Pnp BIOS Specification for details. Here is an excerpt: * * A seven character ASCII representation of the product * identifier compressed into a 32-bit identifier. The seven * character ID consists of a three character manufacturer code, * a three character hexadecimal product identifier, and a one * character hexadecimal revision number. The manufacturer code * is a 3 uppercase character code that is compressed into 3 5-bit * values as follows: * 1) Find hex ASCII value for each letter * 2) Subtract 40h from each ASCII value * 3) Retain 5 least signficant bits for each letter by * discarding upper 3 bits because they are always 0. * 4) Compressed code = concatenate 0 and the 3 5-bit values * * The format of the compressed product identifier is as follows: * Byte 0: Bit 7 - Reserved (0) * Bits 6-2: - 1st character of compressed mfg code * Bits 1-0 - Upper 2 bits of 2nd character of mfg code * Byte 1: Bits 7-5 - Lower 3 bits of 2nd character of mfg code * Bits 4-0 - 3rd character of mfg code * Byte 2: Bits 7-4 - 1st hex digit of product number * Bits 3-0 - 2nd hex digit of product number * Byte 3: Bits 7-4 - 3st hex digit of product number * Bits 3-0 - Hex digit of the revision number * ******************************************************************************/ static void OpcDoEisaId ( ACPI_PARSE_OBJECT *Op) { UINT32 EisaId = 0; UINT32 BigEndianId; char *InString; ACPI_STATUS Status = AE_OK; UINT32 i; InString = (char *) Op->Asl.Value.String; /* * The EISAID string must be exactly 7 characters and of the form * "UUUXXXX" -- 3 uppercase letters and 4 hex digits (e.g., "PNP0001") */ if (ACPI_STRLEN (InString) != 7) { Status = AE_BAD_PARAMETER; } else { /* Check all 7 characters for correct format */ for (i = 0; i < 7; i++) { /* First 3 characters must be uppercase letters */ if (i < 3) { if (!isupper ((int) InString[i])) { Status = AE_BAD_PARAMETER; } } /* Last 4 characters must be hex digits */ else if (!isxdigit ((int) InString[i])) { Status = AE_BAD_PARAMETER; } } } if (ACPI_FAILURE (Status)) { AslError (ASL_ERROR, ASL_MSG_INVALID_EISAID, Op, Op->Asl.Value.String); } else { /* Create ID big-endian first (bits are contiguous) */ BigEndianId = (UINT32) (InString[0] - 0x40) << 26 | (UINT32) (InString[1] - 0x40) << 21 | (UINT32) (InString[2] - 0x40) << 16 | (UtHexCharToValue (InString[3])) << 12 | (UtHexCharToValue (InString[4])) << 8 | (UtHexCharToValue (InString[5])) << 4 | UtHexCharToValue (InString[6]); /* Swap to little-endian to get final ID (see function header) */ EisaId = AcpiUtDwordByteSwap (BigEndianId); } /* * Morph the Op into an integer, regardless of whether there * was an error in the EISAID string */ Op->Asl.Value.Integer = EisaId; Op->Asl.CompileFlags &= ~NODE_COMPILE_TIME_CONST; Op->Asl.ParseOpcode = PARSEOP_INTEGER; (void) OpcSetOptimalIntegerSize (Op); /* Op is now an integer */ UtSetParseOpName (Op); } /******************************************************************************* * * FUNCTION: OpcDoUiId * * PARAMETERS: Op - Parse node * * RETURN: None * * DESCRIPTION: Convert UUID string to 16-byte buffer * ******************************************************************************/ static void OpcDoUuId ( ACPI_PARSE_OBJECT *Op) { char *InString; char *Buffer; ACPI_STATUS Status = AE_OK; UINT32 i; ACPI_PARSE_OBJECT *NewOp; InString = (char *) Op->Asl.Value.String; if (ACPI_STRLEN (InString) != 36) { Status = AE_BAD_PARAMETER; } else { /* Check all 36 characters for correct format */ for (i = 0; i < 36; i++) { if ((i == 8) || (i == 13) || (i == 18) || (i == 23)) { if (InString[i] != '-') { Status = AE_BAD_PARAMETER; } } else { if (!isxdigit ((int) InString[i])) { Status = AE_BAD_PARAMETER; } } } } Buffer = UtLocalCalloc (16); if (ACPI_FAILURE (Status)) { AslError (ASL_ERROR, ASL_MSG_INVALID_UUID, Op, Op->Asl.Value.String); } else for (i = 0; i < 16; i++) { Buffer[i] = (char) (UtHexCharToValue (InString[OpcMapToUUID[i]]) << 4); Buffer[i] |= (char) UtHexCharToValue (InString[OpcMapToUUID[i] + 1]); } /* Change Op to a Buffer */ Op->Asl.ParseOpcode = PARSEOP_BUFFER; Op->Common.AmlOpcode = AML_BUFFER_OP; /* Disable further optimization */ Op->Asl.CompileFlags &= ~NODE_COMPILE_TIME_CONST; UtSetParseOpName (Op); /* Child node is the buffer length */ NewOp = TrAllocateNode (PARSEOP_INTEGER); NewOp->Asl.AmlOpcode = AML_BYTE_OP; NewOp->Asl.Value.Integer = 16; NewOp->Asl.Parent = Op; Op->Asl.Child = NewOp; Op = NewOp; /* Peer to the child is the raw buffer data */ NewOp = TrAllocateNode (PARSEOP_RAW_DATA); NewOp->Asl.AmlOpcode = AML_RAW_DATA_BUFFER; NewOp->Asl.AmlLength = 16; NewOp->Asl.Value.String = (char *) Buffer; NewOp->Asl.Parent = Op->Asl.Parent; Op->Asl.Next = NewOp; } /******************************************************************************* * * FUNCTION: OpcGenerateAmlOpcode * * PARAMETERS: Op - Parse node * * RETURN: None * * DESCRIPTION: Generate the AML opcode associated with the node and its * parse (lex/flex) keyword opcode. Essentially implements * a mapping between the parse opcodes and the actual AML opcodes. * ******************************************************************************/ void OpcGenerateAmlOpcode ( ACPI_PARSE_OBJECT *Op) { UINT16 Index; Index = (UINT16) (Op->Asl.ParseOpcode - ASL_PARSE_OPCODE_BASE); Op->Asl.AmlOpcode = AslKeywordMapping[Index].AmlOpcode; Op->Asl.AcpiBtype = AslKeywordMapping[Index].AcpiBtype; Op->Asl.CompileFlags |= AslKeywordMapping[Index].Flags; if (!Op->Asl.Value.Integer) { Op->Asl.Value.Integer = AslKeywordMapping[Index].Value; } /* Special handling for some opcodes */ switch (Op->Asl.ParseOpcode) { case PARSEOP_INTEGER: /* * Set the opcode based on the size of the integer */ (void) OpcSetOptimalIntegerSize (Op); break; case PARSEOP_OFFSET: Op->Asl.AmlOpcodeLength = 1; break; case PARSEOP_ACCESSAS: OpcDoAccessAs (Op); break; case PARSEOP_EISAID: OpcDoEisaId (Op); break; case PARSEOP_TOUUID: OpcDoUuId (Op); break; case PARSEOP_UNICODE: OpcDoUnicode (Op); break; case PARSEOP_INCLUDE: Op->Asl.Child->Asl.ParseOpcode = PARSEOP_DEFAULT_ARG; Gbl_HasIncludeFiles = TRUE; break; case PARSEOP_EXTERNAL: Op->Asl.Child->Asl.ParseOpcode = PARSEOP_DEFAULT_ARG; Op->Asl.Child->Asl.Next->Asl.ParseOpcode = PARSEOP_DEFAULT_ARG; break; default: /* Nothing to do for other opcodes */ break; } return; }