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 "aslcompiler.h"
120 #include "aslcompiler.y.h"
123 #define _COMPONENT ACPI_COMPILER
124 ACPI_MODULE_NAME ("aslopcodes")
127 /*******************************************************************************
129 * FUNCTION: OpcAmlOpcodeWalk
131 * PARAMETERS: ASL_WALK_CALLBACK
135 * DESCRIPTION: Parse tree walk to generate both the AML opcodes and the AML
138 ******************************************************************************/
142 ACPI_PARSE_OBJECT *Op,
149 OpcGenerateAmlOpcode (Op);
150 OpnGenerateAmlOperands (Op);
156 /*******************************************************************************
158 * FUNCTION: OpcGetIntegerWidth
160 * PARAMETERS: Op - DEFINITION BLOCK op
164 * DESCRIPTION: Extract integer width from the table revision
166 ******************************************************************************/
170 ACPI_PARSE_OBJECT *Op)
172 ACPI_PARSE_OBJECT *Child;
179 Child = Op->Asl.Child;
180 Child = Child->Asl.Next;
181 Child = Child->Asl.Next;
183 /* Use the revision to set the integer width */
185 AcpiUtSetIntegerWidth ((UINT8) Child->Asl.Value.Integer);
189 /*******************************************************************************
191 * FUNCTION: OpcSetOptimalIntegerSize
193 * PARAMETERS: Op - A parse tree node
195 * RETURN: Integer width, in bytes. Also sets the node AML opcode to the
196 * optimal integer AML prefix opcode.
198 * DESCRIPTION: Determine the optimal AML encoding of an integer. All leading
199 * zeros can be truncated to squeeze the integer into the
200 * minimal number of AML bytes.
202 ******************************************************************************/
205 OpcSetOptimalIntegerSize (
206 ACPI_PARSE_OBJECT *Op)
210 TBD: - we don't want to optimize integers in the block header, but the
211 code below does not work correctly.
213 if (Op->Asl.Parent &&
214 Op->Asl.Parent->Asl.Parent &&
215 (Op->Asl.Parent->Asl.Parent->Asl.ParseOpcode == PARSEOP_DEFINITIONBLOCK))
222 * Check for the special AML integers first - Zero, One, Ones.
223 * These are single-byte opcodes that are the smallest possible
224 * representation of an integer.
226 * This optimization is optional.
228 if (Gbl_IntegerOptimizationFlag)
230 switch (Op->Asl.Value.Integer)
234 Op->Asl.AmlOpcode = AML_ZERO_OP;
235 AslError (ASL_OPTIMIZATION, ASL_MSG_INTEGER_OPTIMIZATION, Op, "Zero");
240 Op->Asl.AmlOpcode = AML_ONE_OP;
241 AslError (ASL_OPTIMIZATION, ASL_MSG_INTEGER_OPTIMIZATION, Op, "One");
244 case ACPI_UINT32_MAX:
246 /* Check for table integer width (32 or 64) */
248 if (AcpiGbl_IntegerByteWidth == 4)
250 Op->Asl.AmlOpcode = AML_ONES_OP;
251 AslError (ASL_OPTIMIZATION, ASL_MSG_INTEGER_OPTIMIZATION, Op, "Ones");
256 case ACPI_INTEGER_MAX:
258 /* Check for table integer width (32 or 64) */
260 if (AcpiGbl_IntegerByteWidth == 8)
262 Op->Asl.AmlOpcode = AML_ONES_OP;
263 AslError (ASL_OPTIMIZATION, ASL_MSG_INTEGER_OPTIMIZATION, Op, "Ones");
273 /* Find the best fit using the various AML integer prefixes */
275 if (Op->Asl.Value.Integer <= ACPI_UINT8_MAX)
277 Op->Asl.AmlOpcode = AML_BYTE_OP;
280 if (Op->Asl.Value.Integer <= ACPI_UINT16_MAX)
282 Op->Asl.AmlOpcode = AML_WORD_OP;
285 if (Op->Asl.Value.Integer <= ACPI_UINT32_MAX)
287 Op->Asl.AmlOpcode = AML_DWORD_OP;
292 Op->Asl.AmlOpcode = AML_QWORD_OP;
298 /*******************************************************************************
300 * FUNCTION: OpcDoAccessAs
302 * PARAMETERS: Op - Parse node
306 * DESCRIPTION: Implement the ACCESS_AS ASL keyword.
308 ******************************************************************************/
312 ACPI_PARSE_OBJECT *Op)
314 ACPI_PARSE_OBJECT *Next;
317 Op->Asl.AmlOpcodeLength = 1;
318 Next = Op->Asl.Child;
320 /* First child is the access type */
322 Next->Asl.AmlOpcode = AML_RAW_DATA_BYTE;
323 Next->Asl.ParseOpcode = PARSEOP_RAW_DATA;
325 /* Second child is the optional access attribute */
327 Next = Next->Asl.Next;
328 if (Next->Asl.ParseOpcode == PARSEOP_DEFAULT_ARG)
330 Next->Asl.Value.Integer = 0;
332 Next->Asl.AmlOpcode = AML_RAW_DATA_BYTE;
333 Next->Asl.ParseOpcode = PARSEOP_RAW_DATA;
337 /*******************************************************************************
339 * FUNCTION: OpcDoUnicode
341 * PARAMETERS: Op - Parse node
345 * DESCRIPTION: Implement the UNICODE ASL "macro". Convert the input string
346 * to a unicode buffer. There is no Unicode AML opcode.
348 * Note: The Unicode string is 16 bits per character, no leading signature,
349 * with a 16-bit terminating NULL.
351 ******************************************************************************/
355 ACPI_PARSE_OBJECT *Op)
357 ACPI_PARSE_OBJECT *InitializerOp;
362 UINT16 *UnicodeString;
363 ACPI_PARSE_OBJECT *BufferLengthOp;
366 /* Change op into a buffer object */
368 Op->Asl.CompileFlags &= ~NODE_COMPILE_TIME_CONST;
369 Op->Asl.ParseOpcode = PARSEOP_BUFFER;
370 UtSetParseOpName (Op);
372 /* Buffer Length is first, followed by the string */
374 BufferLengthOp = Op->Asl.Child;
375 InitializerOp = BufferLengthOp->Asl.Next;
377 AsciiString = (UINT8 *) InitializerOp->Asl.Value.String;
379 /* Create a new buffer for the Unicode string */
381 Count = strlen (InitializerOp->Asl.Value.String) + 1;
382 Length = Count * sizeof (UINT16);
383 UnicodeString = UtLocalCalloc (Length);
385 /* Convert to Unicode string (including null terminator) */
387 for (i = 0; i < Count; i++)
389 UnicodeString[i] = (UINT16) AsciiString[i];
393 * Just set the buffer size node to be the buffer length, regardless
394 * of whether it was previously an integer or a default_arg placeholder
396 BufferLengthOp->Asl.ParseOpcode = PARSEOP_INTEGER;
397 BufferLengthOp->Asl.AmlOpcode = AML_DWORD_OP;
398 BufferLengthOp->Asl.Value.Integer = Length;
399 UtSetParseOpName (BufferLengthOp);
401 (void) OpcSetOptimalIntegerSize (BufferLengthOp);
403 /* The Unicode string is a raw data buffer */
405 InitializerOp->Asl.Value.Buffer = (UINT8 *) UnicodeString;
406 InitializerOp->Asl.AmlOpcode = AML_RAW_DATA_BUFFER;
407 InitializerOp->Asl.AmlLength = Length;
408 InitializerOp->Asl.ParseOpcode = PARSEOP_RAW_DATA;
409 InitializerOp->Asl.Child = NULL;
410 UtSetParseOpName (InitializerOp);
414 /*******************************************************************************
416 * FUNCTION: OpcDoEisaId
418 * PARAMETERS: Op - Parse node
422 * DESCRIPTION: Convert a string EISA ID to numeric representation. See the
423 * Pnp BIOS Specification for details. Here is an excerpt:
425 * A seven character ASCII representation of the product
426 * identifier compressed into a 32-bit identifier. The seven
427 * character ID consists of a three character manufacturer code,
428 * a three character hexadecimal product identifier, and a one
429 * character hexadecimal revision number. The manufacturer code
430 * is a 3 uppercase character code that is compressed into 3 5-bit
432 * 1) Find hex ASCII value for each letter
433 * 2) Subtract 40h from each ASCII value
434 * 3) Retain 5 least signficant bits for each letter by
435 * discarding upper 3 bits because they are always 0.
436 * 4) Compressed code = concatenate 0 and the 3 5-bit values
438 * The format of the compressed product identifier is as follows:
439 * Byte 0: Bit 7 - Reserved (0)
440 * Bits 6-2: - 1st character of compressed mfg code
441 * Bits 1-0 - Upper 2 bits of 2nd character of mfg code
442 * Byte 1: Bits 7-5 - Lower 3 bits of 2nd character of mfg code
443 * Bits 4-0 - 3rd character of mfg code
444 * Byte 2: Bits 7-4 - 1st hex digit of product number
445 * Bits 3-0 - 2nd hex digit of product number
446 * Byte 3: Bits 7-4 - 3st hex digit of product number
447 * Bits 3-0 - Hex digit of the revision number
449 ******************************************************************************/
453 ACPI_PARSE_OBJECT *Op)
458 ACPI_STATUS Status = AE_OK;
462 InString = (char *) Op->Asl.Value.String;
465 * The EISAID string must be exactly 7 characters and of the form
466 * "LLLXXXX" -- 3 letters and 4 hex digits (e.g., "PNP0001")
468 if (ACPI_STRLEN (InString) != 7)
470 Status = AE_BAD_PARAMETER;
474 /* Check all 7 characters for correct format */
476 for (i = 0; i < 7; i++)
478 /* First 3 characters must be uppercase letters */
482 if (!isupper (InString[i]))
484 Status = AE_BAD_PARAMETER;
488 /* Last 4 characters must be hex digits */
490 else if (!isxdigit (InString[i]))
492 Status = AE_BAD_PARAMETER;
497 if (ACPI_FAILURE (Status))
499 AslError (ASL_ERROR, ASL_MSG_INVALID_EISAID, Op, Op->Asl.Value.String);
503 /* Create ID big-endian first (bits are contiguous) */
505 BigEndianId = (UINT32) (InString[0] - 0x40) << 26 |
506 (UINT32) (InString[1] - 0x40) << 21 |
507 (UINT32) (InString[2] - 0x40) << 16 |
509 (UtHexCharToValue (InString[3])) << 12 |
510 (UtHexCharToValue (InString[4])) << 8 |
511 (UtHexCharToValue (InString[5])) << 4 |
512 UtHexCharToValue (InString[6]);
514 /* Swap to little-endian to get final ID (see function header) */
516 EisaId = AcpiUtDwordByteSwap (BigEndianId);
520 * Morph the Op into an integer, regardless of whether there
521 * was an error in the EISAID string
523 Op->Asl.Value.Integer = EisaId;
525 Op->Asl.CompileFlags &= ~NODE_COMPILE_TIME_CONST;
526 Op->Asl.ParseOpcode = PARSEOP_INTEGER;
527 (void) OpcSetOptimalIntegerSize (Op);
529 /* Op is now an integer */
531 UtSetParseOpName (Op);
535 /*******************************************************************************
537 * FUNCTION: OpcDoUiId
539 * PARAMETERS: Op - Parse node
545 ******************************************************************************/
547 static UINT8 OpcMapToUUID[16] = {6,4,2,0,11,9,16,14,19,21,24,26,28,30,32,34};
551 ACPI_PARSE_OBJECT *Op)
555 ACPI_STATUS Status = AE_OK;
557 ACPI_PARSE_OBJECT *NewOp;
560 InString = (char *) Op->Asl.Value.String;
562 if (ACPI_STRLEN (InString) != 36)
564 Status = AE_BAD_PARAMETER;
568 /* Check all 36 characters for correct format */
570 for (i = 0; i < 36; i++)
572 if ((i == 8) || (i == 13) || (i == 18) || (i == 23))
574 if (InString[i] != '-')
576 Status = AE_BAD_PARAMETER;
581 if (!isxdigit (InString[i]))
583 Status = AE_BAD_PARAMETER;
589 Buffer = UtLocalCalloc (16);
591 if (ACPI_FAILURE (Status))
593 AslError (ASL_ERROR, ASL_MSG_INVALID_UUID, Op, Op->Asl.Value.String);
595 else for (i = 0; i < 16; i++)
597 Buffer[i] = (char) (UtHexCharToValue (InString[OpcMapToUUID[i]]) << 4);
598 Buffer[i] |= (char) UtHexCharToValue (InString[OpcMapToUUID[i] + 1]);
601 /* Change Op to a Buffer */
603 Op->Asl.ParseOpcode = PARSEOP_BUFFER;
604 Op->Common.AmlOpcode = AML_BUFFER_OP;
605 Op->Asl.CompileFlags &= ~NODE_COMPILE_TIME_CONST; /* Disable further optimization */
606 UtSetParseOpName (Op);
608 /* Child node is the buffer length */
610 NewOp = TrAllocateNode (PARSEOP_INTEGER);
612 NewOp->Asl.AmlOpcode = AML_BYTE_OP;
613 NewOp->Asl.Value.Integer = 16;
614 NewOp->Asl.Parent = Op;
616 Op->Asl.Child = NewOp;
619 /* Peer to the child is the raw buffer data */
621 NewOp = TrAllocateNode (PARSEOP_RAW_DATA);
622 NewOp->Asl.AmlOpcode = AML_RAW_DATA_BUFFER;
623 NewOp->Asl.AmlLength = 16;
624 NewOp->Asl.Value.String = (char *) Buffer;
625 NewOp->Asl.Parent = Op->Asl.Parent;
627 Op->Asl.Next = NewOp;
631 /*******************************************************************************
633 * FUNCTION: OpcGenerateAmlOpcode
635 * PARAMETERS: Op - Parse node
639 * DESCRIPTION: Generate the AML opcode associated with the node and its
640 * parse (lex/flex) keyword opcode. Essentially implements
641 * a mapping between the parse opcodes and the actual AML opcodes.
643 ******************************************************************************/
646 OpcGenerateAmlOpcode (
647 ACPI_PARSE_OBJECT *Op)
653 Index = (UINT16) (Op->Asl.ParseOpcode - ASL_PARSE_OPCODE_BASE);
655 Op->Asl.AmlOpcode = AslKeywordMapping[Index].AmlOpcode;
656 Op->Asl.AcpiBtype = AslKeywordMapping[Index].AcpiBtype;
657 Op->Asl.CompileFlags |= AslKeywordMapping[Index].Flags;
659 if (!Op->Asl.Value.Integer)
661 Op->Asl.Value.Integer = AslKeywordMapping[Index].Value;
664 /* Special handling for some opcodes */
666 switch (Op->Asl.ParseOpcode)
668 case PARSEOP_INTEGER:
670 * Set the opcode based on the size of the integer
672 (void) OpcSetOptimalIntegerSize (Op);
677 Op->Asl.AmlOpcodeLength = 1;
680 case PARSEOP_ACCESSAS:
695 case PARSEOP_UNICODE:
700 case PARSEOP_INCLUDE:
702 Op->Asl.Child->Asl.ParseOpcode = PARSEOP_DEFAULT_ARG;
703 Gbl_HasIncludeFiles = TRUE;
706 case PARSEOP_EXTERNAL:
708 Op->Asl.Child->Asl.ParseOpcode = PARSEOP_DEFAULT_ARG;
709 Op->Asl.Child->Asl.Next->Asl.ParseOpcode = PARSEOP_DEFAULT_ARG;
712 case PARSEOP_PACKAGE:
714 * The variable-length package has a different opcode
716 if ((Op->Asl.Child->Asl.ParseOpcode != PARSEOP_DEFAULT_ARG) &&
717 (Op->Asl.Child->Asl.ParseOpcode != PARSEOP_INTEGER) &&
718 (Op->Asl.Child->Asl.ParseOpcode != PARSEOP_BYTECONST))
720 Op->Asl.AmlOpcode = AML_VAR_PACKAGE_OP;
725 /* Nothing to do for other opcodes */