1 /******************************************************************************
3 * Module Name: dtcompile.c - Front-end for data table compiler
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2019, 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 #define _DECLARE_DT_GLOBALS
154 #include "aslcompiler.h"
156 #define _COMPONENT DT_COMPILER
157 ACPI_MODULE_NAME ("dtcompile")
159 static char VersionString[9];
162 /* Local prototypes */
173 DtInsertCompilerIds (
174 DT_FIELD *FieldList);
177 /******************************************************************************
179 * FUNCTION: DtDoCompile
185 * DESCRIPTION: Main entry point for the data table compiler.
187 * Note: Assumes AslGbl_Files[ASL_FILE_INPUT] is initialized and the file is
188 * open at seek offset zero.
190 *****************************************************************************/
199 ASL_GLOBAL_FILE_NODE *FileNode;
202 /* Initialize globals */
208 if (AslGbl_PreprocessFlag)
212 Event = UtBeginEvent ("Preprocess input file");
216 if (AslGbl_PreprocessOnly)
222 /* Compile the parse tree */
224 if (AslGbl_DtLexBisonPrototype)
226 Event = UtBeginEvent ("Parse data table in prototype mode");
228 DtCompilerInitLexer (AslGbl_Files[ASL_FILE_INPUT].Handle);
229 DtCompilerParserparse ();
230 FieldList = AslGbl_FieldList;
231 DtCompilerTerminateLexer ();
238 * Scan the input file (file is already open) and
239 * build the parse tree
241 Event = UtBeginEvent ("Scan and parse input file");
242 FieldList = DtScanFile (AslGbl_Files[ASL_FILE_INPUT].Handle);
246 /* Did the parse tree get successfully constructed? */
250 /* TBD: temporary error message. Msgs should come from function above */
252 DtError (ASL_ERROR, ASL_MSG_SYNTAX, NULL,
253 "Input file does not appear to be an ASL or data table source file");
258 Event = UtBeginEvent ("Compile parse tree");
260 Status = DtCompileDataTable (&FieldList);
263 FileNode = FlGetCurrentFileNode ();
266 fprintf (stderr, "Summary for %s could not be generated",
267 AslGbl_Files[ASL_FILE_INPUT].Filename);
271 FileNode->TotalLineCount = AslGbl_CurrentLineNumber;
272 FileNode->OriginalInputFileSize = AslGbl_InputByteCount;
273 DbgPrint (ASL_PARSE_OUTPUT, "Line count: %u input file size: %u\n",
274 FileNode->TotalLineCount, FileNode->OriginalInputFileSize);
277 if (ACPI_FAILURE (Status))
281 FileNode->ParserErrorDetected = TRUE;
284 /* TBD: temporary error message. Msgs should come from function above */
286 DtError (ASL_ERROR, ASL_MSG_SYNTAX, NULL,
287 "Could not compile input file");
292 /* Create/open the binary output file */
294 AslGbl_Files[ASL_FILE_AML_OUTPUT].Filename = NULL;
295 Status = FlOpenAmlOutputFile (AslGbl_OutputFilenamePrefix);
296 if (ACPI_FAILURE (Status))
301 /* Write the binary, then the optional hex file */
303 DtOutputBinary (AslGbl_RootTable);
305 DtWriteTableToListing ();
307 /* Save the compile time statistics to the current file node */
311 FileNode->TotalFields = AslGbl_InputFieldCount;
312 FileNode->OutputByteLength = AslGbl_TableLength;
319 /******************************************************************************
321 * FUNCTION: DtInitialize
327 * DESCRIPTION: Initialize data table compiler globals. Enables multiple
328 * compiles per invocation.
330 *****************************************************************************/
338 AcpiUtSetIntegerWidth (2); /* Set width to 64 bits */
340 AslGbl_FieldList = NULL;
341 AslGbl_RootTable = NULL;
342 AslGbl_SubtableStack = NULL;
344 sprintf (VersionString, "%X", (UINT32) ACPI_CA_VERSION);
349 /******************************************************************************
351 * FUNCTION: DtInsertCompilerIds
353 * PARAMETERS: FieldList - Current field list pointer
357 * DESCRIPTION: Insert the IDs (Name, Version) of the current compiler into
358 * the original ACPI table header.
360 *****************************************************************************/
363 DtInsertCompilerIds (
371 * Don't insert current compiler ID if requested. Used for compiler
372 * debug/validation only.
374 if (AslGbl_UseOriginalCompilerId)
379 /* Walk to the Compiler fields at the end of the header */
382 for (i = 0; i < 7; i++)
387 Next->Value = ASL_CREATOR_ID;
388 Next->Flags = DT_FIELD_NOT_ALLOCATED;
391 Next->Value = VersionString;
392 Next->Flags = DT_FIELD_NOT_ALLOCATED;
396 /******************************************************************************
398 * FUNCTION: DtCompileDataTable
400 * PARAMETERS: FieldList - Current field list pointer
404 * DESCRIPTION: Entry point to compile one data table
406 *****************************************************************************/
410 DT_FIELD **FieldList)
412 const ACPI_DMTABLE_DATA *TableData;
413 DT_SUBTABLE *Subtable;
415 ACPI_TABLE_HEADER *AcpiTableHeader;
417 DT_FIELD *RootField = *FieldList;
420 /* Verify that we at least have a table signature and save it */
422 Signature = DtGetFieldValue (*FieldList);
425 sprintf (AslGbl_MsgBuffer, "Expected \"%s\"", "Signature");
426 DtNameError (ASL_ERROR, ASL_MSG_INVALID_FIELD_NAME,
427 *FieldList, AslGbl_MsgBuffer);
431 AslGbl_Signature = UtLocalCacheCalloc (strlen (Signature) + 1);
432 strcpy (AslGbl_Signature, Signature);
435 * Handle tables that don't use the common ACPI table header structure.
436 * Currently, these are the FACS and RSDP. Also check for an OEMx table,
437 * these tables have user-defined contents.
439 if (ACPI_COMPARE_NAMESEG (Signature, ACPI_SIG_FACS))
441 Status = DtCompileFacs (FieldList);
442 if (ACPI_FAILURE (Status))
450 else if (ACPI_VALIDATE_RSDP_SIG (Signature))
452 Status = DtCompileRsdp (FieldList);
455 else if (ACPI_COMPARE_NAMESEG (Signature, ACPI_SIG_S3PT))
457 Status = DtCompileS3pt (FieldList);
458 if (ACPI_FAILURE (Status))
468 * All other tables must use the common ACPI table header. Insert the
469 * current iASL IDs (name, version), and compile the header now.
471 DtInsertCompilerIds (*FieldList);
473 Status = DtCompileTable (FieldList, AcpiDmTableInfoHeader,
475 if (ACPI_FAILURE (Status))
480 DtPushSubtable (AslGbl_RootTable);
482 /* Validate the signature via the ACPI table list */
484 TableData = AcpiDmGetTableData (Signature);
485 if (!TableData || AslGbl_CompileGeneric)
487 /* Unknown table signature and/or force generic compile */
489 DtCompileGeneric ((void **) FieldList, NULL, NULL);
493 /* Dispatch to per-table compile */
495 if (TableData->CmTableHandler)
497 /* Complex table, has a handler */
499 Status = TableData->CmTableHandler ((void **) FieldList);
500 if (ACPI_FAILURE (Status))
505 else if (TableData->TableInfo)
507 /* Simple table, just walk the info table, unless its empty */
509 if (FieldList && *FieldList)
512 Status = DtCompileTable (FieldList, TableData->TableInfo,
514 if (ACPI_FAILURE (Status))
519 DtInsertSubtable (AslGbl_RootTable, Subtable);
525 DtFatal (ASL_MSG_COMPILER_INTERNAL, *FieldList,
526 "Missing table dispatch info");
532 /* Set the final table length and then the checksum */
535 AcpiTableHeader = ACPI_CAST_PTR (
536 ACPI_TABLE_HEADER, AslGbl_RootTable->Buffer);
537 DtSetTableChecksum (&AcpiTableHeader->Checksum);
539 DtDumpFieldList (RootField);
540 DtDumpSubtableList ();
545 /******************************************************************************
547 * FUNCTION: DtCompileTable
549 * PARAMETERS: Field - Current field list pointer
550 * Info - Info table for this ACPI table
551 * RetSubtable - Compile result of table
555 * DESCRIPTION: Compile a subtable
557 *****************************************************************************/
562 ACPI_DMTABLE_INFO *Info,
563 DT_SUBTABLE **RetSubtable)
565 DT_FIELD *LocalField;
567 DT_SUBTABLE *Subtable;
568 DT_SUBTABLE *InlineSubtable = NULL;
569 UINT32 FieldLength = 0;
572 UINT8 *FlagBuffer = NULL;
574 UINT32 CurrentFlagByteOffset = 0;
575 ACPI_STATUS Status = AE_OK;
580 return (AE_BAD_PARAMETER);
585 * The field list is empty, this means that we are out of fields to
586 * parse. In other words, we are at the end of the table.
588 return (AE_END_OF_TABLE);
591 /* Ignore optional subtable if name does not match */
593 if ((Info->Flags & DT_OPTIONAL) &&
594 strcmp ((*Field)->Name, Info->Name))
600 Length = DtGetSubtableLength (*Field, Info);
601 if (Length == ASL_EOF)
606 Subtable = UtSubtableCacheCalloc ();
610 String = UtLocalCacheCalloc (Length);
611 Subtable->Buffer = ACPI_CAST_PTR (UINT8, String);
614 Subtable->Length = Length;
615 Subtable->TotalLength = Length;
616 Buffer = Subtable->Buffer;
619 Subtable->Name = LocalField->Name;
622 * Main loop walks the info table for this ACPI table or subtable
624 for (; Info->Name; Info++)
626 if (Info->Opcode == ACPI_DMT_EXTRA_TEXT)
633 sprintf (AslGbl_MsgBuffer, "Found NULL field - Field name \"%s\" needed",
635 DtFatal (ASL_MSG_COMPILER_INTERNAL, NULL, AslGbl_MsgBuffer);
636 Status = AE_BAD_DATA;
640 /* Maintain table offsets */
642 LocalField->TableOffset = AslGbl_CurrentTableOffset;
643 FieldLength = DtGetFieldLength (LocalField, Info);
644 AslGbl_CurrentTableOffset += FieldLength;
646 FieldType = DtGetFieldType (Info);
647 AslGbl_InputFieldCount++;
649 if (FieldType != DT_FIELD_TYPE_INLINE_SUBTABLE &&
650 strcmp (Info->Name, LocalField->Name))
652 sprintf (AslGbl_MsgBuffer, "found \"%s\" expected \"%s\"",
653 LocalField->Name, Info->Name);
654 DtError (ASL_ERROR, ASL_MSG_INVALID_LABEL, LocalField, AslGbl_MsgBuffer);
659 case DT_FIELD_TYPE_FLAGS_INTEGER:
661 * Start of the definition of a flags field.
662 * This master flags integer starts at value zero, in preparation
663 * to compile and insert the flag fields from the individual bits
665 LocalField = LocalField->Next;
669 CurrentFlagByteOffset = Info->Offset;
672 case DT_FIELD_TYPE_FLAG:
674 /* Individual Flag field, can be multiple bits */
679 * We must increment the FlagBuffer when we have crossed
680 * into the next flags byte within the flags field
681 * of type DT_FIELD_TYPE_FLAGS_INTEGER.
683 FlagBuffer += (Info->Offset - CurrentFlagByteOffset);
684 CurrentFlagByteOffset = Info->Offset;
686 DtCompileFlag (FlagBuffer, LocalField, Info);
690 /* TBD - this is an internal error */
693 LocalField = LocalField->Next;
697 case DT_FIELD_TYPE_INLINE_SUBTABLE:
699 * Recursion (one level max): compile GAS (Generic Address)
700 * or Notify in-line subtable
704 switch (Info->Opcode)
708 Status = DtCompileTable (Field, AcpiDmTableInfoGas,
712 case ACPI_DMT_HESTNTFY:
714 Status = DtCompileTable (Field, AcpiDmTableInfoHestNotify,
718 case ACPI_DMT_IORTMEM:
720 Status = DtCompileTable (Field, AcpiDmTableInfoIortAcc,
725 sprintf (AslGbl_MsgBuffer, "Invalid DMT opcode: 0x%.2X",
727 DtFatal (ASL_MSG_COMPILER_INTERNAL, NULL, AslGbl_MsgBuffer);
728 Status = AE_BAD_DATA;
732 if (ACPI_FAILURE (Status))
737 DtSetSubtableLength (InlineSubtable);
739 memcpy (Buffer, InlineSubtable->Buffer, FieldLength);
743 case DT_FIELD_TYPE_LABEL:
745 DtWriteFieldToListing (Buffer, LocalField, 0);
746 LocalField = LocalField->Next;
751 /* Normal case for most field types (Integer, String, etc.) */
753 DtCompileOneField (Buffer, LocalField,
754 FieldLength, FieldType, Info->Flags);
756 DtWriteFieldToListing (Buffer, LocalField, FieldLength);
757 LocalField = LocalField->Next;
759 if (Info->Flags & DT_LENGTH)
761 /* Field is an Integer that will contain a subtable length */
763 Subtable->LengthField = Buffer;
764 Subtable->SizeOfLengthField = FieldLength;
769 Buffer += FieldLength;
773 *RetSubtable = Subtable;
777 ACPI_FREE (Subtable->Buffer);
778 ACPI_FREE (Subtable);
783 /******************************************************************************
785 * FUNCTION: DtCompileTwoSubtables
787 * PARAMETERS: List - Current field list pointer
788 * TableInfo1 - Info table 1
789 * TableInfo1 - Info table 2
793 * DESCRIPTION: Compile tables with a header and one or more same subtables.
794 * Include CPEP, EINJ, ERST, MCFG, MSCT, WDAT
796 *****************************************************************************/
799 DtCompileTwoSubtables (
801 ACPI_DMTABLE_INFO *TableInfo1,
802 ACPI_DMTABLE_INFO *TableInfo2)
805 DT_SUBTABLE *Subtable;
806 DT_SUBTABLE *ParentTable;
807 DT_FIELD **PFieldList = (DT_FIELD **) List;
810 Status = DtCompileTable (PFieldList, TableInfo1, &Subtable);
811 if (ACPI_FAILURE (Status))
816 ParentTable = DtPeekSubtable ();
817 DtInsertSubtable (ParentTable, Subtable);
821 Status = DtCompileTable (PFieldList, TableInfo2, &Subtable);
822 if (ACPI_FAILURE (Status))
827 DtInsertSubtable (ParentTable, Subtable);
834 /******************************************************************************
836 * FUNCTION: DtCompilePadding
838 * PARAMETERS: Length - Padding field size
839 * RetSubtable - Compile result of table
843 * DESCRIPTION: Compile a subtable for padding purpose
845 *****************************************************************************/
850 DT_SUBTABLE **RetSubtable)
852 DT_SUBTABLE *Subtable;
857 Subtable = UtSubtableCacheCalloc ();
861 String = UtLocalCacheCalloc (Length);
862 Subtable->Buffer = ACPI_CAST_PTR (UINT8, String);
865 Subtable->Length = Length;
866 Subtable->TotalLength = Length;
867 /* Buffer = Subtable->Buffer; */
869 *RetSubtable = Subtable;