2 /******************************************************************************
4 * Module Name: aslopcode - AML opcode generation
7 *****************************************************************************/
9 /******************************************************************************
13 * Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp.
14 * All rights reserved.
18 * 2.1. This is your license from Intel Corp. under its intellectual property
19 * rights. You may have additional license terms from the party that provided
20 * you this software, covering your right to use that party's intellectual
23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
24 * copy of the source code appearing in this file ("Covered Code") an
25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
26 * base code distributed originally by Intel ("Original Intel Code") to copy,
27 * make derivatives, distribute, use and display any portion of the Covered
28 * Code in any form, with the right to sublicense such rights; and
30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
31 * license (with the right to sublicense), under only those claims of Intel
32 * patents that are infringed by the Original Intel Code, to make, use, sell,
33 * offer to sell, and import the Covered Code and derivative works thereof
34 * solely to the minimum extent necessary to exercise the above copyright
35 * license, and in no event shall the patent license extend to any additions
36 * to or modifications of the Original Intel Code. No other license or right
37 * is granted directly or by implication, estoppel or otherwise;
39 * The above copyright and patent license is granted only if the following
44 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
45 * Redistribution of source code of any substantial portion of the Covered
46 * Code or modification with rights to further distribute source must include
47 * the above Copyright Notice, the above License, this list of Conditions,
48 * and the following Disclaimer and Export Compliance provision. In addition,
49 * Licensee must cause all Covered Code to which Licensee contributes to
50 * contain a file documenting the changes Licensee made to create that Covered
51 * Code and the date of any change. Licensee must include in that file the
52 * documentation of any changes made by any predecessor Licensee. Licensee
53 * must include a prominent statement that the modification is derived,
54 * directly or indirectly, from Original Intel Code.
56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
57 * Redistribution of source code of any substantial portion of the Covered
58 * Code or modification without rights to further distribute source must
59 * include the following Disclaimer and Export Compliance provision in the
60 * documentation and/or other materials provided with distribution. In
61 * addition, Licensee may not authorize further sublicense of source of any
62 * portion of the Covered Code, and must include terms to the effect that the
63 * license from Licensee to its licensee is limited to the intellectual
64 * property embodied in the software Licensee provides to its licensee, and
65 * not to intellectual property embodied in modifications its licensee may
68 * 3.3. Redistribution of Executable. Redistribution in executable form of any
69 * substantial portion of the Covered Code or modification must reproduce the
70 * above Copyright Notice, and the following Disclaimer and Export Compliance
71 * provision in the documentation and/or other materials provided with the
74 * 3.4. Intel retains all right, title, and interest in and to the Original
77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
78 * Intel shall be used in advertising or otherwise to promote the sale, use or
79 * other dealings in products derived from or relating to the Covered Code
80 * without prior written authorization from Intel.
82 * 4. Disclaimer and Export Compliance
84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
101 * 4.3. Licensee shall not export, either directly or indirectly, any of this
102 * software or system incorporating such software without first obtaining any
103 * required license or other approval from the U. S. Department of Commerce or
104 * any other agency or department of the United States Government. In the
105 * event Licensee exports any such software from the United States or
106 * re-exports any such software from a foreign destination, Licensee shall
107 * ensure that the distribution and export/re-export of the software is in
108 * compliance with all laws, regulations, orders, or other restrictions of the
109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110 * any of its subsidiaries will export/re-export any technical data, process,
111 * software, or service, directly or indirectly, to any country for which the
112 * United States government or any agency thereof requires an export license,
113 * other governmental approval, or letter of assurance, without first obtaining
114 * such license, approval or letter.
116 *****************************************************************************/
119 #include <contrib/dev/acpica/compiler/aslcompiler.h>
120 #include "aslcompiler.y.h"
121 #include <contrib/dev/acpica/amlcode.h>
123 #define _COMPONENT ACPI_COMPILER
124 ACPI_MODULE_NAME ("aslopcodes")
129 static UINT8 OpcMapToUUID[16] =
131 6,4,2,0,11,9,16,14,19,21,24,26,28,30,32,34
134 /* Local prototypes */
138 ACPI_PARSE_OBJECT *Op);
142 ACPI_PARSE_OBJECT *Op);
146 ACPI_PARSE_OBJECT *Op);
150 ACPI_PARSE_OBJECT *Op);
153 /*******************************************************************************
155 * FUNCTION: OpcAmlOpcodeUpdateWalk
157 * PARAMETERS: ASL_WALK_CALLBACK
161 * DESCRIPTION: Opcode update walk, ascending callback
163 ******************************************************************************/
166 OpcAmlOpcodeUpdateWalk (
167 ACPI_PARSE_OBJECT *Op,
173 * Handle the Package() case where the actual opcode cannot be determined
174 * until the PackageLength operand has been folded and minimized.
175 * (PackageOp versus VarPackageOp)
177 * This is (as of ACPI 3.0) the only case where the AML opcode can change
178 * based upon the value of a parameter.
180 * The parser always inserts a VarPackage opcode, which can possibly be
181 * optimized to a Package opcode.
183 if (Op->Asl.ParseOpcode == PARSEOP_VAR_PACKAGE)
192 /*******************************************************************************
194 * FUNCTION: OpcAmlOpcodeWalk
196 * PARAMETERS: ASL_WALK_CALLBACK
200 * DESCRIPTION: Parse tree walk to generate both the AML opcodes and the AML
203 ******************************************************************************/
207 ACPI_PARSE_OBJECT *Op,
214 OpcGenerateAmlOpcode (Op);
215 OpnGenerateAmlOperands (Op);
221 /*******************************************************************************
223 * FUNCTION: OpcGetIntegerWidth
225 * PARAMETERS: Op - DEFINITION BLOCK op
229 * DESCRIPTION: Extract integer width from the table revision
231 ******************************************************************************/
235 ACPI_PARSE_OBJECT *Op)
237 ACPI_PARSE_OBJECT *Child;
245 if (Gbl_RevisionOverride)
247 AcpiUtSetIntegerWidth (Gbl_RevisionOverride);
251 Child = Op->Asl.Child;
252 Child = Child->Asl.Next;
253 Child = Child->Asl.Next;
255 /* Use the revision to set the integer width */
257 AcpiUtSetIntegerWidth ((UINT8) Child->Asl.Value.Integer);
262 /*******************************************************************************
264 * FUNCTION: OpcSetOptimalIntegerSize
266 * PARAMETERS: Op - A parse tree node
268 * RETURN: Integer width, in bytes. Also sets the node AML opcode to the
269 * optimal integer AML prefix opcode.
271 * DESCRIPTION: Determine the optimal AML encoding of an integer. All leading
272 * zeros can be truncated to squeeze the integer into the
273 * minimal number of AML bytes.
275 ******************************************************************************/
278 OpcSetOptimalIntegerSize (
279 ACPI_PARSE_OBJECT *Op)
284 * TBD: - we don't want to optimize integers in the block header, but the
285 * code below does not work correctly.
287 if (Op->Asl.Parent &&
288 Op->Asl.Parent->Asl.Parent &&
289 (Op->Asl.Parent->Asl.Parent->Asl.ParseOpcode == PARSEOP_DEFINITIONBLOCK))
296 * Check for the special AML integers first - Zero, One, Ones.
297 * These are single-byte opcodes that are the smallest possible
298 * representation of an integer.
300 * This optimization is optional.
302 if (Gbl_IntegerOptimizationFlag)
304 switch (Op->Asl.Value.Integer)
308 Op->Asl.AmlOpcode = AML_ZERO_OP;
309 AslError (ASL_OPTIMIZATION, ASL_MSG_INTEGER_OPTIMIZATION,
315 Op->Asl.AmlOpcode = AML_ONE_OP;
316 AslError (ASL_OPTIMIZATION, ASL_MSG_INTEGER_OPTIMIZATION,
320 case ACPI_UINT32_MAX:
322 /* Check for table integer width (32 or 64) */
324 if (AcpiGbl_IntegerByteWidth == 4)
326 Op->Asl.AmlOpcode = AML_ONES_OP;
327 AslError (ASL_OPTIMIZATION, ASL_MSG_INTEGER_OPTIMIZATION,
333 case ACPI_INTEGER_MAX:
335 /* Check for table integer width (32 or 64) */
337 if (AcpiGbl_IntegerByteWidth == 8)
339 Op->Asl.AmlOpcode = AML_ONES_OP;
340 AslError (ASL_OPTIMIZATION, ASL_MSG_INTEGER_OPTIMIZATION,
351 /* Find the best fit using the various AML integer prefixes */
353 if (Op->Asl.Value.Integer <= ACPI_UINT8_MAX)
355 Op->Asl.AmlOpcode = AML_BYTE_OP;
358 if (Op->Asl.Value.Integer <= ACPI_UINT16_MAX)
360 Op->Asl.AmlOpcode = AML_WORD_OP;
363 if (Op->Asl.Value.Integer <= ACPI_UINT32_MAX)
365 Op->Asl.AmlOpcode = AML_DWORD_OP;
370 if (AcpiGbl_IntegerByteWidth == 4)
372 AslError (ASL_WARNING, ASL_MSG_INTEGER_LENGTH,
375 if (!Gbl_IgnoreErrors)
377 /* Truncate the integer to 32-bit */
378 Op->Asl.AmlOpcode = AML_DWORD_OP;
383 Op->Asl.AmlOpcode = AML_QWORD_OP;
389 /*******************************************************************************
391 * FUNCTION: OpcDoAccessAs
393 * PARAMETERS: Op - Parse node
397 * DESCRIPTION: Implement the ACCESS_AS ASL keyword.
399 ******************************************************************************/
403 ACPI_PARSE_OBJECT *Op)
405 ACPI_PARSE_OBJECT *Next;
408 Op->Asl.AmlOpcodeLength = 1;
409 Next = Op->Asl.Child;
411 /* First child is the access type */
413 Next->Asl.AmlOpcode = AML_RAW_DATA_BYTE;
414 Next->Asl.ParseOpcode = PARSEOP_RAW_DATA;
416 /* Second child is the optional access attribute */
418 Next = Next->Asl.Next;
419 if (Next->Asl.ParseOpcode == PARSEOP_DEFAULT_ARG)
421 Next->Asl.Value.Integer = 0;
423 Next->Asl.AmlOpcode = AML_RAW_DATA_BYTE;
424 Next->Asl.ParseOpcode = PARSEOP_RAW_DATA;
428 /*******************************************************************************
430 * FUNCTION: OpcDoUnicode
432 * PARAMETERS: Op - Parse node
436 * DESCRIPTION: Implement the UNICODE ASL "macro". Convert the input string
437 * to a unicode buffer. There is no Unicode AML opcode.
439 * Note: The Unicode string is 16 bits per character, no leading signature,
440 * with a 16-bit terminating NULL.
442 ******************************************************************************/
446 ACPI_PARSE_OBJECT *Op)
448 ACPI_PARSE_OBJECT *InitializerOp;
453 UINT16 *UnicodeString;
454 ACPI_PARSE_OBJECT *BufferLengthOp;
457 /* Change op into a buffer object */
459 Op->Asl.CompileFlags &= ~NODE_COMPILE_TIME_CONST;
460 Op->Asl.ParseOpcode = PARSEOP_BUFFER;
461 UtSetParseOpName (Op);
463 /* Buffer Length is first, followed by the string */
465 BufferLengthOp = Op->Asl.Child;
466 InitializerOp = BufferLengthOp->Asl.Next;
468 AsciiString = (UINT8 *) InitializerOp->Asl.Value.String;
470 /* Create a new buffer for the Unicode string */
472 Count = strlen (InitializerOp->Asl.Value.String) + 1;
473 Length = Count * sizeof (UINT16);
474 UnicodeString = UtLocalCalloc (Length);
476 /* Convert to Unicode string (including null terminator) */
478 for (i = 0; i < Count; i++)
480 UnicodeString[i] = (UINT16) AsciiString[i];
484 * Just set the buffer size node to be the buffer length, regardless
485 * of whether it was previously an integer or a default_arg placeholder
487 BufferLengthOp->Asl.ParseOpcode = PARSEOP_INTEGER;
488 BufferLengthOp->Asl.AmlOpcode = AML_DWORD_OP;
489 BufferLengthOp->Asl.Value.Integer = Length;
490 UtSetParseOpName (BufferLengthOp);
492 (void) OpcSetOptimalIntegerSize (BufferLengthOp);
494 /* The Unicode string is a raw data buffer */
496 InitializerOp->Asl.Value.Buffer = (UINT8 *) UnicodeString;
497 InitializerOp->Asl.AmlOpcode = AML_RAW_DATA_BUFFER;
498 InitializerOp->Asl.AmlLength = Length;
499 InitializerOp->Asl.ParseOpcode = PARSEOP_RAW_DATA;
500 InitializerOp->Asl.Child = NULL;
501 UtSetParseOpName (InitializerOp);
505 /*******************************************************************************
507 * FUNCTION: OpcDoEisaId
509 * PARAMETERS: Op - Parse node
513 * DESCRIPTION: Convert a string EISA ID to numeric representation. See the
514 * Pnp BIOS Specification for details. Here is an excerpt:
516 * A seven character ASCII representation of the product
517 * identifier compressed into a 32-bit identifier. The seven
518 * character ID consists of a three character manufacturer code,
519 * a three character hexadecimal product identifier, and a one
520 * character hexadecimal revision number. The manufacturer code
521 * is a 3 uppercase character code that is compressed into 3 5-bit
523 * 1) Find hex ASCII value for each letter
524 * 2) Subtract 40h from each ASCII value
525 * 3) Retain 5 least signficant bits for each letter by
526 * discarding upper 3 bits because they are always 0.
527 * 4) Compressed code = concatenate 0 and the 3 5-bit values
529 * The format of the compressed product identifier is as follows:
530 * Byte 0: Bit 7 - Reserved (0)
531 * Bits 6-2: - 1st character of compressed mfg code
532 * Bits 1-0 - Upper 2 bits of 2nd character of mfg code
533 * Byte 1: Bits 7-5 - Lower 3 bits of 2nd character of mfg code
534 * Bits 4-0 - 3rd character of mfg code
535 * Byte 2: Bits 7-4 - 1st hex digit of product number
536 * Bits 3-0 - 2nd hex digit of product number
537 * Byte 3: Bits 7-4 - 3st hex digit of product number
538 * Bits 3-0 - Hex digit of the revision number
540 ******************************************************************************/
544 ACPI_PARSE_OBJECT *Op)
549 ACPI_STATUS Status = AE_OK;
553 InString = (char *) Op->Asl.Value.String;
556 * The EISAID string must be exactly 7 characters and of the form
557 * "UUUXXXX" -- 3 uppercase letters and 4 hex digits (e.g., "PNP0001")
559 if (ACPI_STRLEN (InString) != 7)
561 Status = AE_BAD_PARAMETER;
565 /* Check all 7 characters for correct format */
567 for (i = 0; i < 7; i++)
569 /* First 3 characters must be uppercase letters */
573 if (!isupper (InString[i]))
575 Status = AE_BAD_PARAMETER;
579 /* Last 4 characters must be hex digits */
581 else if (!isxdigit (InString[i]))
583 Status = AE_BAD_PARAMETER;
588 if (ACPI_FAILURE (Status))
590 AslError (ASL_ERROR, ASL_MSG_INVALID_EISAID, Op, Op->Asl.Value.String);
594 /* Create ID big-endian first (bits are contiguous) */
596 BigEndianId = (UINT32) (InString[0] - 0x40) << 26 |
597 (UINT32) (InString[1] - 0x40) << 21 |
598 (UINT32) (InString[2] - 0x40) << 16 |
600 (UtHexCharToValue (InString[3])) << 12 |
601 (UtHexCharToValue (InString[4])) << 8 |
602 (UtHexCharToValue (InString[5])) << 4 |
603 UtHexCharToValue (InString[6]);
605 /* Swap to little-endian to get final ID (see function header) */
607 EisaId = AcpiUtDwordByteSwap (BigEndianId);
611 * Morph the Op into an integer, regardless of whether there
612 * was an error in the EISAID string
614 Op->Asl.Value.Integer = EisaId;
616 Op->Asl.CompileFlags &= ~NODE_COMPILE_TIME_CONST;
617 Op->Asl.ParseOpcode = PARSEOP_INTEGER;
618 (void) OpcSetOptimalIntegerSize (Op);
620 /* Op is now an integer */
622 UtSetParseOpName (Op);
626 /*******************************************************************************
628 * FUNCTION: OpcDoUiId
630 * PARAMETERS: Op - Parse node
634 * DESCRIPTION: Convert UUID string to 16-byte buffer
636 ******************************************************************************/
640 ACPI_PARSE_OBJECT *Op)
644 ACPI_STATUS Status = AE_OK;
646 ACPI_PARSE_OBJECT *NewOp;
649 InString = (char *) Op->Asl.Value.String;
651 if (ACPI_STRLEN (InString) != 36)
653 Status = AE_BAD_PARAMETER;
657 /* Check all 36 characters for correct format */
659 for (i = 0; i < 36; i++)
661 if ((i == 8) || (i == 13) || (i == 18) || (i == 23))
663 if (InString[i] != '-')
665 Status = AE_BAD_PARAMETER;
670 if (!isxdigit (InString[i]))
672 Status = AE_BAD_PARAMETER;
678 Buffer = UtLocalCalloc (16);
680 if (ACPI_FAILURE (Status))
682 AslError (ASL_ERROR, ASL_MSG_INVALID_UUID, Op, Op->Asl.Value.String);
684 else for (i = 0; i < 16; i++)
686 Buffer[i] = (char) (UtHexCharToValue (InString[OpcMapToUUID[i]]) << 4);
687 Buffer[i] |= (char) UtHexCharToValue (InString[OpcMapToUUID[i] + 1]);
690 /* Change Op to a Buffer */
692 Op->Asl.ParseOpcode = PARSEOP_BUFFER;
693 Op->Common.AmlOpcode = AML_BUFFER_OP;
695 /* Disable further optimization */
697 Op->Asl.CompileFlags &= ~NODE_COMPILE_TIME_CONST;
698 UtSetParseOpName (Op);
700 /* Child node is the buffer length */
702 NewOp = TrAllocateNode (PARSEOP_INTEGER);
704 NewOp->Asl.AmlOpcode = AML_BYTE_OP;
705 NewOp->Asl.Value.Integer = 16;
706 NewOp->Asl.Parent = Op;
708 Op->Asl.Child = NewOp;
711 /* Peer to the child is the raw buffer data */
713 NewOp = TrAllocateNode (PARSEOP_RAW_DATA);
714 NewOp->Asl.AmlOpcode = AML_RAW_DATA_BUFFER;
715 NewOp->Asl.AmlLength = 16;
716 NewOp->Asl.Value.String = (char *) Buffer;
717 NewOp->Asl.Parent = Op->Asl.Parent;
719 Op->Asl.Next = NewOp;
723 /*******************************************************************************
725 * FUNCTION: OpcGenerateAmlOpcode
727 * PARAMETERS: Op - Parse node
731 * DESCRIPTION: Generate the AML opcode associated with the node and its
732 * parse (lex/flex) keyword opcode. Essentially implements
733 * a mapping between the parse opcodes and the actual AML opcodes.
735 ******************************************************************************/
738 OpcGenerateAmlOpcode (
739 ACPI_PARSE_OBJECT *Op)
745 Index = (UINT16) (Op->Asl.ParseOpcode - ASL_PARSE_OPCODE_BASE);
747 Op->Asl.AmlOpcode = AslKeywordMapping[Index].AmlOpcode;
748 Op->Asl.AcpiBtype = AslKeywordMapping[Index].AcpiBtype;
749 Op->Asl.CompileFlags |= AslKeywordMapping[Index].Flags;
751 if (!Op->Asl.Value.Integer)
753 Op->Asl.Value.Integer = AslKeywordMapping[Index].Value;
756 /* Special handling for some opcodes */
758 switch (Op->Asl.ParseOpcode)
760 case PARSEOP_INTEGER:
762 * Set the opcode based on the size of the integer
764 (void) OpcSetOptimalIntegerSize (Op);
769 Op->Asl.AmlOpcodeLength = 1;
772 case PARSEOP_ACCESSAS:
787 case PARSEOP_UNICODE:
792 case PARSEOP_INCLUDE:
794 Op->Asl.Child->Asl.ParseOpcode = PARSEOP_DEFAULT_ARG;
795 Gbl_HasIncludeFiles = TRUE;
798 case PARSEOP_EXTERNAL:
800 Op->Asl.Child->Asl.ParseOpcode = PARSEOP_DEFAULT_ARG;
801 Op->Asl.Child->Asl.Next->Asl.ParseOpcode = PARSEOP_DEFAULT_ARG;
805 /* Nothing to do for other opcodes */