1 /******************************************************************************
3 * Module Name: aslopcode - AML opcode generation
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2014, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 #include "aslcompiler.h"
45 #include "aslcompiler.y.h"
48 #define _COMPONENT ACPI_COMPILER
49 ACPI_MODULE_NAME ("aslopcodes")
52 /* Local prototypes */
56 ACPI_PARSE_OBJECT *Op);
60 ACPI_PARSE_OBJECT *Op);
64 ACPI_PARSE_OBJECT *Op);
68 ACPI_PARSE_OBJECT *Op);
72 ACPI_PARSE_OBJECT *Op);
75 /*******************************************************************************
77 * FUNCTION: OpcAmlOpcodeUpdateWalk
79 * PARAMETERS: ASL_WALK_CALLBACK
83 * DESCRIPTION: Opcode update walk, ascending callback
85 ******************************************************************************/
88 OpcAmlOpcodeUpdateWalk (
89 ACPI_PARSE_OBJECT *Op,
95 * Handle the Package() case where the actual opcode cannot be determined
96 * until the PackageLength operand has been folded and minimized.
97 * (PackageOp versus VarPackageOp)
99 * This is (as of ACPI 3.0) the only case where the AML opcode can change
100 * based upon the value of a parameter.
102 * The parser always inserts a VarPackage opcode, which can possibly be
103 * optimized to a Package opcode.
105 if (Op->Asl.ParseOpcode == PARSEOP_VAR_PACKAGE)
114 /*******************************************************************************
116 * FUNCTION: OpcAmlOpcodeWalk
118 * PARAMETERS: ASL_WALK_CALLBACK
122 * DESCRIPTION: Parse tree walk to generate both the AML opcodes and the AML
125 ******************************************************************************/
129 ACPI_PARSE_OBJECT *Op,
136 OpcGenerateAmlOpcode (Op);
137 OpnGenerateAmlOperands (Op);
142 /*******************************************************************************
144 * FUNCTION: OpcGetIntegerWidth
146 * PARAMETERS: Op - DEFINITION BLOCK op
150 * DESCRIPTION: Extract integer width from the table revision
152 ******************************************************************************/
156 ACPI_PARSE_OBJECT *Op)
158 ACPI_PARSE_OBJECT *Child;
166 if (Gbl_RevisionOverride)
168 AcpiUtSetIntegerWidth (Gbl_RevisionOverride);
172 Child = Op->Asl.Child;
173 Child = Child->Asl.Next;
174 Child = Child->Asl.Next;
176 /* Use the revision to set the integer width */
178 AcpiUtSetIntegerWidth ((UINT8) Child->Asl.Value.Integer);
183 /*******************************************************************************
185 * FUNCTION: OpcSetOptimalIntegerSize
187 * PARAMETERS: Op - A parse tree node
189 * RETURN: Integer width, in bytes. Also sets the node AML opcode to the
190 * optimal integer AML prefix opcode.
192 * DESCRIPTION: Determine the optimal AML encoding of an integer. All leading
193 * zeros can be truncated to squeeze the integer into the
194 * minimal number of AML bytes.
196 ******************************************************************************/
199 OpcSetOptimalIntegerSize (
200 ACPI_PARSE_OBJECT *Op)
205 * TBD: - we don't want to optimize integers in the block header, but the
206 * code below does not work correctly.
208 if (Op->Asl.Parent &&
209 Op->Asl.Parent->Asl.Parent &&
210 (Op->Asl.Parent->Asl.Parent->Asl.ParseOpcode == PARSEOP_DEFINITIONBLOCK))
217 * Check for the special AML integers first - Zero, One, Ones.
218 * These are single-byte opcodes that are the smallest possible
219 * representation of an integer.
221 * This optimization is optional.
223 if (Gbl_IntegerOptimizationFlag)
225 switch (Op->Asl.Value.Integer)
229 Op->Asl.AmlOpcode = AML_ZERO_OP;
230 AslError (ASL_OPTIMIZATION, ASL_MSG_INTEGER_OPTIMIZATION,
236 Op->Asl.AmlOpcode = AML_ONE_OP;
237 AslError (ASL_OPTIMIZATION, ASL_MSG_INTEGER_OPTIMIZATION,
241 case ACPI_UINT32_MAX:
243 /* Check for table integer width (32 or 64) */
245 if (AcpiGbl_IntegerByteWidth == 4)
247 Op->Asl.AmlOpcode = AML_ONES_OP;
248 AslError (ASL_OPTIMIZATION, ASL_MSG_INTEGER_OPTIMIZATION,
254 case ACPI_UINT64_MAX:
256 /* Check for table integer width (32 or 64) */
258 if (AcpiGbl_IntegerByteWidth == 8)
260 Op->Asl.AmlOpcode = AML_ONES_OP;
261 AslError (ASL_OPTIMIZATION, ASL_MSG_INTEGER_OPTIMIZATION,
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 if (AcpiGbl_IntegerByteWidth == 4)
294 AslError (ASL_WARNING, ASL_MSG_INTEGER_LENGTH,
297 if (!Gbl_IgnoreErrors)
299 /* Truncate the integer to 32-bit */
300 Op->Asl.AmlOpcode = AML_DWORD_OP;
305 Op->Asl.AmlOpcode = AML_QWORD_OP;
311 /*******************************************************************************
313 * FUNCTION: OpcDoAccessAs
315 * PARAMETERS: Op - Parse node
319 * DESCRIPTION: Implement the ACCESS_AS ASL keyword.
321 ******************************************************************************/
325 ACPI_PARSE_OBJECT *Op)
327 ACPI_PARSE_OBJECT *TypeOp;
328 ACPI_PARSE_OBJECT *AttribOp;
329 ACPI_PARSE_OBJECT *LengthOp;
333 Op->Asl.AmlOpcodeLength = 1;
334 TypeOp = Op->Asl.Child;
336 /* First child is the access type */
338 TypeOp->Asl.AmlOpcode = AML_RAW_DATA_BYTE;
339 TypeOp->Asl.ParseOpcode = PARSEOP_RAW_DATA;
341 /* Second child is the optional access attribute */
343 AttribOp = TypeOp->Asl.Next;
344 if (AttribOp->Asl.ParseOpcode == PARSEOP_DEFAULT_ARG)
346 AttribOp->Asl.Value.Integer = 0;
348 AttribOp->Asl.AmlOpcode = AML_RAW_DATA_BYTE;
349 AttribOp->Asl.ParseOpcode = PARSEOP_RAW_DATA;
351 /* Only a few AccessAttributes support AccessLength */
353 Attribute = (UINT8) AttribOp->Asl.Value.Integer;
354 if ((Attribute != AML_FIELD_ATTRIB_MULTIBYTE) &&
355 (Attribute != AML_FIELD_ATTRIB_RAW_BYTES) &&
356 (Attribute != AML_FIELD_ATTRIB_RAW_PROCESS))
361 Op->Asl.AmlOpcode = AML_FIELD_EXT_ACCESS_OP;
364 * Child of Attributes is the AccessLength (required for Multibyte,
365 * RawBytes, RawProcess.)
367 LengthOp = AttribOp->Asl.Child;
373 /* TBD: probably can remove */
375 if (LengthOp->Asl.ParseOpcode == PARSEOP_DEFAULT_ARG)
377 LengthOp->Asl.Value.Integer = 16;
380 LengthOp->Asl.AmlOpcode = AML_RAW_DATA_BYTE;
381 LengthOp->Asl.ParseOpcode = PARSEOP_RAW_DATA;
385 /*******************************************************************************
387 * FUNCTION: OpcDoConnection
389 * PARAMETERS: Op - Parse node
393 * DESCRIPTION: Implement the Connection ASL keyword.
395 ******************************************************************************/
399 ACPI_PARSE_OBJECT *Op)
401 ASL_RESOURCE_NODE *Rnode;
402 ACPI_PARSE_OBJECT *BufferOp;
403 ACPI_PARSE_OBJECT *BufferLengthOp;
404 ACPI_PARSE_OBJECT *BufferDataOp;
405 ASL_RESOURCE_INFO Info;
409 Op->Asl.AmlOpcodeLength = 1;
411 if (Op->Asl.Child->Asl.AmlOpcode == AML_INT_NAMEPATH_OP)
416 BufferOp = Op->Asl.Child;
417 BufferLengthOp = BufferOp->Asl.Child;
418 BufferDataOp = BufferLengthOp->Asl.Next;
420 Info.DescriptorTypeOp = BufferDataOp->Asl.Next;
421 Info.CurrentByteOffset = 0;
422 State = ACPI_RSTATE_NORMAL;
423 Rnode = RsDoOneResourceDescriptor (&Info, &State);
430 * Transform the nodes into the following
432 * Op -> AML_BUFFER_OP
433 * First Child -> BufferLength
434 * Second Child -> Descriptor Buffer (raw byte data)
436 BufferOp->Asl.ParseOpcode = PARSEOP_BUFFER;
437 BufferOp->Asl.AmlOpcode = AML_BUFFER_OP;
438 BufferOp->Asl.CompileFlags = NODE_AML_PACKAGE | NODE_IS_RESOURCE_DESC;
439 UtSetParseOpName (BufferOp);
441 BufferLengthOp->Asl.ParseOpcode = PARSEOP_INTEGER;
442 BufferLengthOp->Asl.Value.Integer = Rnode->BufferLength;
443 (void) OpcSetOptimalIntegerSize (BufferLengthOp);
444 UtSetParseOpName (BufferLengthOp);
446 BufferDataOp->Asl.ParseOpcode = PARSEOP_RAW_DATA;
447 BufferDataOp->Asl.AmlOpcode = AML_RAW_DATA_CHAIN;
448 BufferDataOp->Asl.AmlOpcodeLength = 0;
449 BufferDataOp->Asl.AmlLength = Rnode->BufferLength;
450 BufferDataOp->Asl.Value.Buffer = (UINT8 *) Rnode;
451 UtSetParseOpName (BufferDataOp);
455 /*******************************************************************************
457 * FUNCTION: OpcDoUnicode
459 * PARAMETERS: Op - Parse node
463 * DESCRIPTION: Implement the UNICODE ASL "macro". Convert the input string
464 * to a unicode buffer. There is no Unicode AML opcode.
466 * Note: The Unicode string is 16 bits per character, no leading signature,
467 * with a 16-bit terminating NULL.
469 ******************************************************************************/
473 ACPI_PARSE_OBJECT *Op)
475 ACPI_PARSE_OBJECT *InitializerOp;
480 UINT16 *UnicodeString;
481 ACPI_PARSE_OBJECT *BufferLengthOp;
484 /* Change op into a buffer object */
486 Op->Asl.CompileFlags &= ~NODE_COMPILE_TIME_CONST;
487 Op->Asl.ParseOpcode = PARSEOP_BUFFER;
488 UtSetParseOpName (Op);
490 /* Buffer Length is first, followed by the string */
492 BufferLengthOp = Op->Asl.Child;
493 InitializerOp = BufferLengthOp->Asl.Next;
495 AsciiString = (UINT8 *) InitializerOp->Asl.Value.String;
497 /* Create a new buffer for the Unicode string */
499 Count = strlen (InitializerOp->Asl.Value.String) + 1;
500 Length = Count * sizeof (UINT16);
501 UnicodeString = UtLocalCalloc (Length);
503 /* Convert to Unicode string (including null terminator) */
505 for (i = 0; i < Count; i++)
507 UnicodeString[i] = (UINT16) AsciiString[i];
511 * Just set the buffer size node to be the buffer length, regardless
512 * of whether it was previously an integer or a default_arg placeholder
514 BufferLengthOp->Asl.ParseOpcode = PARSEOP_INTEGER;
515 BufferLengthOp->Asl.AmlOpcode = AML_DWORD_OP;
516 BufferLengthOp->Asl.Value.Integer = Length;
517 UtSetParseOpName (BufferLengthOp);
519 (void) OpcSetOptimalIntegerSize (BufferLengthOp);
521 /* The Unicode string is a raw data buffer */
523 InitializerOp->Asl.Value.Buffer = (UINT8 *) UnicodeString;
524 InitializerOp->Asl.AmlOpcode = AML_RAW_DATA_BUFFER;
525 InitializerOp->Asl.AmlLength = Length;
526 InitializerOp->Asl.ParseOpcode = PARSEOP_RAW_DATA;
527 InitializerOp->Asl.Child = NULL;
528 UtSetParseOpName (InitializerOp);
532 /*******************************************************************************
534 * FUNCTION: OpcDoEisaId
536 * PARAMETERS: Op - Parse node
540 * DESCRIPTION: Convert a string EISA ID to numeric representation. See the
541 * Pnp BIOS Specification for details. Here is an excerpt:
543 * A seven character ASCII representation of the product
544 * identifier compressed into a 32-bit identifier. The seven
545 * character ID consists of a three character manufacturer code,
546 * a three character hexadecimal product identifier, and a one
547 * character hexadecimal revision number. The manufacturer code
548 * is a 3 uppercase character code that is compressed into 3 5-bit
550 * 1) Find hex ASCII value for each letter
551 * 2) Subtract 40h from each ASCII value
552 * 3) Retain 5 least significant bits for each letter by
553 * discarding upper 3 bits because they are always 0.
554 * 4) Compressed code = concatenate 0 and the 3 5-bit values
556 * The format of the compressed product identifier is as follows:
557 * Byte 0: Bit 7 - Reserved (0)
558 * Bits 6-2: - 1st character of compressed mfg code
559 * Bits 1-0 - Upper 2 bits of 2nd character of mfg code
560 * Byte 1: Bits 7-5 - Lower 3 bits of 2nd character of mfg code
561 * Bits 4-0 - 3rd character of mfg code
562 * Byte 2: Bits 7-4 - 1st hex digit of product number
563 * Bits 3-0 - 2nd hex digit of product number
564 * Byte 3: Bits 7-4 - 3st hex digit of product number
565 * Bits 3-0 - Hex digit of the revision number
567 ******************************************************************************/
571 ACPI_PARSE_OBJECT *Op)
576 ACPI_STATUS Status = AE_OK;
580 InString = (char *) Op->Asl.Value.String;
583 * The EISAID string must be exactly 7 characters and of the form
584 * "UUUXXXX" -- 3 uppercase letters and 4 hex digits (e.g., "PNP0001")
586 if (ACPI_STRLEN (InString) != 7)
588 Status = AE_BAD_PARAMETER;
592 /* Check all 7 characters for correct format */
594 for (i = 0; i < 7; i++)
596 /* First 3 characters must be uppercase letters */
600 if (!isupper ((int) InString[i]))
602 Status = AE_BAD_PARAMETER;
606 /* Last 4 characters must be hex digits */
608 else if (!isxdigit ((int) InString[i]))
610 Status = AE_BAD_PARAMETER;
615 if (ACPI_FAILURE (Status))
617 AslError (ASL_ERROR, ASL_MSG_INVALID_EISAID, Op, Op->Asl.Value.String);
621 /* Create ID big-endian first (bits are contiguous) */
624 (UINT32) ((UINT8) (InString[0] - 0x40)) << 26 |
625 (UINT32) ((UINT8) (InString[1] - 0x40)) << 21 |
626 (UINT32) ((UINT8) (InString[2] - 0x40)) << 16 |
628 (AcpiUtAsciiCharToHex (InString[3])) << 12 |
629 (AcpiUtAsciiCharToHex (InString[4])) << 8 |
630 (AcpiUtAsciiCharToHex (InString[5])) << 4 |
631 AcpiUtAsciiCharToHex (InString[6]);
633 /* Swap to little-endian to get final ID (see function header) */
635 EisaId = AcpiUtDwordByteSwap (BigEndianId);
639 * Morph the Op into an integer, regardless of whether there
640 * was an error in the EISAID string
642 Op->Asl.Value.Integer = EisaId;
644 Op->Asl.CompileFlags &= ~NODE_COMPILE_TIME_CONST;
645 Op->Asl.ParseOpcode = PARSEOP_INTEGER;
646 (void) OpcSetOptimalIntegerSize (Op);
648 /* Op is now an integer */
650 UtSetParseOpName (Op);
654 /*******************************************************************************
656 * FUNCTION: OpcDoUuId
658 * PARAMETERS: Op - Parse node
662 * DESCRIPTION: Convert UUID string to 16-byte buffer
664 ******************************************************************************/
668 ACPI_PARSE_OBJECT *Op)
672 ACPI_STATUS Status = AE_OK;
673 ACPI_PARSE_OBJECT *NewOp;
676 InString = (char *) Op->Asl.Value.String;
677 Buffer = UtLocalCalloc (16);
679 Status = AuValidateUuid (InString);
680 if (ACPI_FAILURE (Status))
682 AslError (ASL_ERROR, ASL_MSG_INVALID_UUID, Op, Op->Asl.Value.String);
686 AcpiUtConvertStringToUuid (InString, Buffer);
689 /* Change Op to a Buffer */
691 Op->Asl.ParseOpcode = PARSEOP_BUFFER;
692 Op->Common.AmlOpcode = AML_BUFFER_OP;
694 /* Disable further optimization */
696 Op->Asl.CompileFlags &= ~NODE_COMPILE_TIME_CONST;
697 UtSetParseOpName (Op);
699 /* Child node is the buffer length */
701 NewOp = TrAllocateNode (PARSEOP_INTEGER);
703 NewOp->Asl.AmlOpcode = AML_BYTE_OP;
704 NewOp->Asl.Value.Integer = 16;
705 NewOp->Asl.Parent = Op;
707 Op->Asl.Child = NewOp;
710 /* Peer to the child is the raw buffer data */
712 NewOp = TrAllocateNode (PARSEOP_RAW_DATA);
713 NewOp->Asl.AmlOpcode = AML_RAW_DATA_BUFFER;
714 NewOp->Asl.AmlLength = 16;
715 NewOp->Asl.Value.String = (char *) Buffer;
716 NewOp->Asl.Parent = Op->Asl.Parent;
718 Op->Asl.Next = NewOp;
722 /*******************************************************************************
724 * FUNCTION: OpcGenerateAmlOpcode
726 * PARAMETERS: Op - Parse node
730 * DESCRIPTION: Generate the AML opcode associated with the node and its
731 * parse (lex/flex) keyword opcode. Essentially implements
732 * a mapping between the parse opcodes and the actual AML opcodes.
734 ******************************************************************************/
737 OpcGenerateAmlOpcode (
738 ACPI_PARSE_OBJECT *Op)
744 Index = (UINT16) (Op->Asl.ParseOpcode - ASL_PARSE_OPCODE_BASE);
746 Op->Asl.AmlOpcode = AslKeywordMapping[Index].AmlOpcode;
747 Op->Asl.AcpiBtype = AslKeywordMapping[Index].AcpiBtype;
748 Op->Asl.CompileFlags |= AslKeywordMapping[Index].Flags;
750 if (!Op->Asl.Value.Integer)
752 Op->Asl.Value.Integer = AslKeywordMapping[Index].Value;
755 /* Special handling for some opcodes */
757 switch (Op->Asl.ParseOpcode)
759 case PARSEOP_INTEGER:
761 * Set the opcode based on the size of the integer
763 (void) OpcSetOptimalIntegerSize (Op);
768 Op->Asl.AmlOpcodeLength = 1;
771 case PARSEOP_ACCESSAS:
776 case PARSEOP_CONNECTION:
778 OpcDoConnection (Op);
791 case PARSEOP_UNICODE:
796 case PARSEOP_INCLUDE:
798 Op->Asl.Child->Asl.ParseOpcode = PARSEOP_DEFAULT_ARG;
799 Gbl_HasIncludeFiles = TRUE;
802 case PARSEOP_EXTERNAL:
804 Op->Asl.Child->Asl.ParseOpcode = PARSEOP_DEFAULT_ARG;
805 Op->Asl.Child->Asl.Next->Asl.ParseOpcode = PARSEOP_DEFAULT_ARG;
810 if (AcpiGbl_IntegerBitWidth == 32)
812 AslError (ASL_REMARK, ASL_MSG_TRUNCATION, Op, NULL);
818 /* Nothing to do for other opcodes */