1 /******************************************************************************
3 * Module Name: dtfield.c - Code generation for individual source fields
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2021, Intel Corp.
12 * All rights reserved.
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
37 * The above copyright and patent license is granted only if the following
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
72 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
80 * 4. Disclaimer and Export Compliance
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
150 *****************************************************************************/
152 #include "aslcompiler.h"
154 #define _COMPONENT DT_COMPILER
155 ACPI_MODULE_NAME ("dtfield")
158 /* Local prototypes */
184 /******************************************************************************
186 * FUNCTION: DtCompileOneField
188 * PARAMETERS: Buffer - Output buffer
189 * Field - Field to be compiled
190 * ByteLength - Byte length of the field
195 * DESCRIPTION: Compile a field value to binary
197 *****************************************************************************/
212 case DT_FIELD_TYPE_INTEGER:
214 DtCompileInteger (Buffer, Field, ByteLength, Flags);
217 case DT_FIELD_TYPE_STRING:
219 DtCompileString (Buffer, Field, ByteLength);
222 case DT_FIELD_TYPE_UUID:
224 Status = DtCompileUuid (Buffer, Field, ByteLength);
225 if (ACPI_SUCCESS (Status))
232 case DT_FIELD_TYPE_BUFFER:
234 DtCompileBuffer (Buffer, Field->Value, Field, ByteLength);
237 case DT_FIELD_TYPE_UNICODE:
239 DtCompileUnicode (Buffer, Field, ByteLength);
242 case DT_FIELD_TYPE_DEVICE_PATH:
248 DtFatal (ASL_MSG_COMPILER_INTERNAL, Field, "Invalid field type");
254 /******************************************************************************
256 * FUNCTION: DtCompileString
258 * PARAMETERS: Buffer - Output buffer
259 * Field - String to be copied to buffer
260 * ByteLength - Maximum length of string
264 * DESCRIPTION: Copy string to the buffer
266 *****************************************************************************/
277 Length = strlen (Field->Value);
279 /* Check if the string is too long for the field */
281 if (Length > ByteLength)
283 sprintf (AslGbl_MsgBuffer,
284 "Maximum %u characters, found %u characters [%s]",
285 ByteLength, Length, Field->Value);
286 DtError (ASL_ERROR, ASL_MSG_STRING_LENGTH, Field, AslGbl_MsgBuffer);
290 memcpy (Buffer, Field->Value, Length);
294 /******************************************************************************
296 * FUNCTION: DtCompileUnicode
298 * PARAMETERS: Buffer - Output buffer
299 * Field - String to be copied to buffer
300 * ByteLength - Maximum length of string
304 * DESCRIPTION: Convert ASCII string to Unicode string
306 * Note: The Unicode string is 16 bits per character, no leading signature,
307 * with a 16-bit terminating NULL.
309 *****************************************************************************/
320 UINT16 *UnicodeString;
323 AsciiString = Field->Value;
324 UnicodeString = (UINT16 *) Buffer;
325 Count = strlen (AsciiString) + 1;
327 /* Convert to Unicode string (including null terminator) */
329 for (i = 0; i < Count; i++)
331 UnicodeString[i] = (UINT16) AsciiString[i];
336 /*******************************************************************************
338 * FUNCTION: DtCompileUuid
340 * PARAMETERS: Buffer - Output buffer
341 * Field - String to be copied to buffer
342 * ByteLength - Maximum length of string
346 * DESCRIPTION: Convert UUID string to 16-byte buffer
348 ******************************************************************************/
360 InString = Field->Value;
362 Status = AuValidateUuid (InString);
363 if (ACPI_FAILURE (Status))
365 sprintf (AslGbl_MsgBuffer, "%s", Field->Value);
366 DtNameError (ASL_ERROR, ASL_MSG_INVALID_UUID, Field, AslGbl_MsgBuffer);
370 AcpiUtConvertStringToUuid (InString, Buffer);
377 /******************************************************************************
379 * FUNCTION: DtCompileInteger
381 * PARAMETERS: Buffer - Output buffer
382 * Field - Field obj with Integer to be compiled
383 * ByteLength - Byte length of the integer
384 * Flags - Additional compile info
388 * DESCRIPTION: Compile an integer. Supports integer expressions with C-style
391 *****************************************************************************/
405 /* Output buffer byte length must be in range 1-8 */
407 if ((ByteLength > 8) || (ByteLength == 0))
409 DtFatal (ASL_MSG_COMPILER_INTERNAL, Field,
410 "Invalid internal Byte length");
414 /* Resolve integer expression to a single integer value */
416 Status = DtResolveIntegerExpression (Field, &Value);
417 if (ACPI_FAILURE (Status))
423 * Ensure that reserved fields are set properly. Note: uses
424 * the DT_NON_ZERO flag to indicate that the reserved value
425 * must be exactly one. Otherwise, the value must be zero.
426 * This is sufficient for now.
429 /* TBD: Should use a flag rather than compare "Reserved" */
431 if (!strcmp (Field->Name, "Reserved"))
433 if (Flags & DT_NON_ZERO)
437 DtError (ASL_WARNING, ASL_MSG_RESERVED_VALUE, Field,
438 "Must be one, setting to one");
444 DtError (ASL_WARNING, ASL_MSG_RESERVED_VALUE, Field,
445 "Must be zero, setting to zero");
450 /* Check if the value must be non-zero */
452 else if ((Flags & DT_NON_ZERO) && (Value == 0))
454 DtError (ASL_ERROR, ASL_MSG_ZERO_VALUE, Field, NULL);
458 * Generate the maximum value for the data type (ByteLength)
459 * Note: construct chosen for maximum portability
461 MaxValue = ((UINT64) (-1)) >> (64 - (ByteLength * 8));
463 /* Validate that the input value is within range of the target */
465 if (Value > MaxValue)
467 sprintf (AslGbl_MsgBuffer, "%8.8X%8.8X - max %u bytes",
468 ACPI_FORMAT_UINT64 (Value), ByteLength);
469 DtError (ASL_ERROR, ASL_MSG_INTEGER_SIZE, Field, AslGbl_MsgBuffer);
472 memcpy (Buffer, &Value, ByteLength);
477 /******************************************************************************
479 * FUNCTION: DtNormalizeBuffer
481 * PARAMETERS: Buffer - Input buffer
482 * Count - Output the count of hex numbers in
485 * RETURN: The normalized buffer, must be freed by caller
487 * DESCRIPTION: [1A,2B,3C,4D] or 1A, 2B, 3C, 4D will be normalized
490 *****************************************************************************/
499 UINT32 BufferCount = 0;
500 BOOLEAN Separator = TRUE;
504 NewBuffer = UtLocalCalloc (strlen (Buffer) + 1);
505 TmpBuffer = NewBuffer;
507 while ((c = *Buffer++))
511 /* Valid separators */
525 /* Insert blank as the standard separator */
541 *Count = BufferCount + 1;
546 /******************************************************************************
548 * FUNCTION: DtCompileBuffer
550 * PARAMETERS: Buffer - Output buffer
551 * StringValue - Integer list to be compiled
552 * Field - Current field object
553 * ByteLength - Byte length of the integer list
555 * RETURN: Count of remaining data in the input list
557 * DESCRIPTION: Compile and pack an integer list, for example
558 * "AA 1F 20 3B" ==> Buffer[] = {0xAA,0x1F,0x20,0x3B}
560 *****************************************************************************/
575 /* Allow several different types of value separators */
577 StringValue = DtNormalizeBuffer (StringValue, &Count);
578 Substring = StringValue;
579 if (Count != ByteLength)
581 sprintf(AslGbl_MsgBuffer,
582 "Found %u values, must match expected count: %u",
584 DtError (ASL_ERROR, ASL_MSG_BUFFER_LIST, Field, AslGbl_MsgBuffer);
588 /* Each element of StringValue is now three chars (2 hex + 1 space) */
590 for (i = 0; i < Count; i++, Substring += 3)
592 /* Check for byte value too long */
594 if (*(&Substring[2]) &&
595 (*(&Substring[2]) != ' '))
597 DtError (ASL_ERROR, ASL_MSG_BUFFER_ELEMENT, Field, Substring);
601 /* Convert two ASCII characters to one hex byte */
603 Status = AcpiUtAsciiToHexByte (Substring, &Buffer[i]);
604 if (ACPI_FAILURE (Status))
606 DtError (ASL_ERROR, ASL_MSG_BUFFER_ELEMENT, Field, Substring);
612 ACPI_FREE (StringValue);
613 return (ByteLength - Count);
617 /******************************************************************************
619 * FUNCTION: DtCompileFlag
621 * PARAMETERS: Buffer - Output buffer
622 * Field - Field to be compiled
627 * DESCRIPTION: Compile a flag field. Handles flags up to 64 bits.
629 *****************************************************************************/
635 ACPI_DMTABLE_INFO *Info)
638 UINT32 BitLength = 1;
639 UINT8 BitPosition = 0;
642 Value = AcpiUtImplicitStrtoul64 (Field->Value);
644 switch (Info->Opcode)
655 BitPosition = Info->Opcode;
659 case ACPI_DMT_FLAGS0:
666 case ACPI_DMT_FLAGS1:
673 case ACPI_DMT_FLAGS2:
679 case ACPI_DMT_FLAGS4:
685 case ACPI_DMT_FLAGS4_0:
691 case ACPI_DMT_FLAGS4_4:
697 case ACPI_DMT_FLAGS4_8:
703 case ACPI_DMT_FLAGS4_12:
709 case ACPI_DMT_FLAGS16_16:
717 DtFatal (ASL_MSG_COMPILER_INTERNAL, Field, "Invalid flag opcode");
721 /* Check range of the input flag value */
723 if (Value >= ((UINT64) 1 << BitLength))
725 sprintf (AslGbl_MsgBuffer, "Maximum %u bit", BitLength);
726 DtError (ASL_ERROR, ASL_MSG_FLAG_VALUE, Field, AslGbl_MsgBuffer);
730 *Buffer |= (UINT8) (Value << BitPosition);
734 /******************************************************************************
736 * FUNCTION: DtCreateField
747 * DESCRIPTION: Create a field
749 *****************************************************************************/
753 DT_TABLE_UNIT *FieldKey,
754 DT_TABLE_UNIT *FieldValue,
757 DT_FIELD *Field = UtFieldCacheCalloc ();
760 Field->StringLength = 0;
764 strcpy (UtLocalCacheCalloc (strlen (FieldKey->Value) + 1), FieldKey->Value);
767 if (FieldValue->Value)
769 Field->StringLength = strlen (FieldValue->Value);
771 strcpy (UtLocalCacheCalloc (Field->StringLength + 1), FieldValue->Value);
774 Field->Line = FieldValue->Line;
775 Field->ByteOffset = Offset;
776 Field->NameColumn = FieldKey->Column;
777 Field->Column = FieldValue->Column;
780 DtDumpFieldList (AslGbl_FieldList);
784 /******************************************************************************
786 * FUNCTION: DtCreateTableUnit
792 * RETURN: a table unit
794 * DESCRIPTION: Create a table unit
796 *****************************************************************************/
804 DT_TABLE_UNIT *Unit = (DT_TABLE_UNIT *) UtFieldCacheCalloc ();
809 Unit->Column = Column;
814 /******************************************************************************
816 * FUNCTION: DtLinkField
818 * PARAMETERS: Field - New field object to link
822 * DESCRIPTION: Link one field name and value to the list
824 *****************************************************************************/
834 Prev = Next = AslGbl_FieldList;
848 AslGbl_FieldList = Field;