1 /******************************************************************************
3 * Module Name: dtcompile.c - Front-end for data table compiler
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2017, 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 <contrib/dev/acpica/compiler/aslcompiler.h>
155 #include <contrib/dev/acpica/compiler/dtcompiler.h>
157 #define _COMPONENT DT_COMPILER
158 ACPI_MODULE_NAME ("dtcompile")
160 static char VersionString[9];
163 /* Local prototypes */
174 DtInsertCompilerIds (
175 DT_FIELD *FieldList);
178 /******************************************************************************
180 * FUNCTION: DtDoCompile
186 * DESCRIPTION: Main entry point for the data table compiler.
188 * Note: Assumes Gbl_Files[ASL_FILE_INPUT] is initialized and the file is
189 * open at seek offset zero.
191 *****************************************************************************/
202 /* Initialize globals */
204 Status = DtInitialize ();
205 if (ACPI_FAILURE (Status))
207 printf ("Error during compiler initialization, 0x%X\n", Status);
213 if (Gbl_PreprocessFlag)
217 Event = UtBeginEvent ("Preprocess input file");
221 if (Gbl_PreprocessOnly)
228 * Scan the input file (file is already open) and
229 * build the parse tree
231 Event = UtBeginEvent ("Scan and parse input file");
232 FieldList = DtScanFile (Gbl_Files[ASL_FILE_INPUT].Handle);
235 /* Did the parse tree get successfully constructed? */
239 /* TBD: temporary error message. Msgs should come from function above */
241 DtError (ASL_ERROR, ASL_MSG_SYNTAX, NULL,
242 "Input file does not appear to be an ASL or data table source file");
248 Event = UtBeginEvent ("Compile parse tree");
251 * Compile the parse tree
253 Status = DtCompileDataTable (&FieldList);
256 if (ACPI_FAILURE (Status))
258 /* TBD: temporary error message. Msgs should come from function above */
260 DtError (ASL_ERROR, ASL_MSG_SYNTAX, NULL,
261 "Could not compile input file");
266 /* Create/open the binary output file */
268 Gbl_Files[ASL_FILE_AML_OUTPUT].Filename = NULL;
269 Status = FlOpenAmlOutputFile (Gbl_OutputFilenamePrefix);
270 if (ACPI_FAILURE (Status))
275 /* Write the binary, then the optional hex file */
277 DtOutputBinary (Gbl_RootTable);
279 DtWriteTableToListing ();
283 AcpiUtDeleteCaches ();
290 /******************************************************************************
292 * FUNCTION: DtInitialize
298 * DESCRIPTION: Initialize data table compiler globals. Enables multiple
299 * compiles per invocation.
301 *****************************************************************************/
310 Status = AcpiOsInitialize ();
311 if (ACPI_FAILURE (Status))
316 Status = AcpiUtInitGlobals ();
317 if (ACPI_FAILURE (Status))
322 Gbl_FieldList = NULL;
323 Gbl_RootTable = NULL;
324 Gbl_SubtableStack = NULL;
326 sprintf (VersionString, "%X", (UINT32) ACPI_CA_VERSION);
331 /******************************************************************************
333 * FUNCTION: DtInsertCompilerIds
335 * PARAMETERS: FieldList - Current field list pointer
339 * DESCRIPTION: Insert the IDs (Name, Version) of the current compiler into
340 * the original ACPI table header.
342 *****************************************************************************/
345 DtInsertCompilerIds (
353 * Don't insert current compiler ID if requested. Used for compiler
354 * debug/validation only.
356 if (Gbl_UseOriginalCompilerId)
361 /* Walk to the Compiler fields at the end of the header */
364 for (i = 0; i < 7; i++)
369 Next->Value = ASL_CREATOR_ID;
370 Next->Flags = DT_FIELD_NOT_ALLOCATED;
373 Next->Value = VersionString;
374 Next->Flags = DT_FIELD_NOT_ALLOCATED;
378 /******************************************************************************
380 * FUNCTION: DtCompileDataTable
382 * PARAMETERS: FieldList - Current field list pointer
386 * DESCRIPTION: Entry point to compile one data table
388 *****************************************************************************/
392 DT_FIELD **FieldList)
394 const ACPI_DMTABLE_DATA *TableData;
395 DT_SUBTABLE *Subtable;
397 ACPI_TABLE_HEADER *AcpiTableHeader;
399 DT_FIELD *RootField = *FieldList;
402 /* Verify that we at least have a table signature and save it */
404 Signature = DtGetFieldValue (*FieldList);
407 sprintf (MsgBuffer, "Expected \"%s\"", "Signature");
408 DtNameError (ASL_ERROR, ASL_MSG_INVALID_FIELD_NAME,
409 *FieldList, MsgBuffer);
413 Gbl_Signature = UtStringCacheCalloc (strlen (Signature) + 1);
414 strcpy (Gbl_Signature, Signature);
417 * Handle tables that don't use the common ACPI table header structure.
418 * Currently, these are the FACS and RSDP. Also check for an OEMx table,
419 * these tables have user-defined contents.
421 if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_FACS))
423 Status = DtCompileFacs (FieldList);
424 if (ACPI_FAILURE (Status))
432 else if (ACPI_VALIDATE_RSDP_SIG (Signature))
434 Status = DtCompileRsdp (FieldList);
437 else if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_S3PT))
439 Status = DtCompileS3pt (FieldList);
440 if (ACPI_FAILURE (Status))
450 * All other tables must use the common ACPI table header. Insert the
451 * current iASL IDs (name, version), and compile the header now.
453 DtInsertCompilerIds (*FieldList);
455 Status = DtCompileTable (FieldList, AcpiDmTableInfoHeader,
456 &Gbl_RootTable, TRUE);
457 if (ACPI_FAILURE (Status))
462 DtPushSubtable (Gbl_RootTable);
464 /* Validate the signature via the ACPI table list */
466 TableData = AcpiDmGetTableData (Signature);
467 if (!TableData || Gbl_CompileGeneric)
469 /* Unknown table signature and/or force generic compile */
471 DtCompileGeneric ((void **) FieldList, NULL, NULL);
475 /* Dispatch to per-table compile */
477 if (TableData->CmTableHandler)
479 /* Complex table, has a handler */
481 Status = TableData->CmTableHandler ((void **) FieldList);
482 if (ACPI_FAILURE (Status))
487 else if (TableData->TableInfo)
489 /* Simple table, just walk the info table, unless its empty */
491 if (FieldList && *FieldList)
494 Status = DtCompileTable (FieldList, TableData->TableInfo,
496 if (ACPI_FAILURE (Status))
501 DtInsertSubtable (Gbl_RootTable, Subtable);
507 DtFatal (ASL_MSG_COMPILER_INTERNAL, *FieldList,
508 "Missing table dispatch info");
514 /* Set the final table length and then the checksum */
517 AcpiTableHeader = ACPI_CAST_PTR (
518 ACPI_TABLE_HEADER, Gbl_RootTable->Buffer);
519 DtSetTableChecksum (&AcpiTableHeader->Checksum);
521 DtDumpFieldList (RootField);
522 DtDumpSubtableList ();
527 /******************************************************************************
529 * FUNCTION: DtCompileTable
531 * PARAMETERS: Field - Current field list pointer
532 * Info - Info table for this ACPI table
533 * RetSubtable - Compile result of table
534 * Required - If this subtable must exist
538 * DESCRIPTION: Compile a subtable
540 *****************************************************************************/
545 ACPI_DMTABLE_INFO *Info,
546 DT_SUBTABLE **RetSubtable,
549 DT_FIELD *LocalField;
551 DT_SUBTABLE *Subtable;
552 DT_SUBTABLE *InlineSubtable = NULL;
553 UINT32 FieldLength = 0;
556 UINT8 *FlagBuffer = NULL;
558 UINT32 CurrentFlagByteOffset = 0;
559 ACPI_STATUS Status = AE_OK;
562 if (!Field || !*Field)
564 return (AE_BAD_PARAMETER);
567 /* Ignore optional subtable if name does not match */
569 if ((Info->Flags & DT_OPTIONAL) &&
570 strcmp ((*Field)->Name, Info->Name))
576 Length = DtGetSubtableLength (*Field, Info);
577 if (Length == ASL_EOF)
582 Subtable = UtSubtableCacheCalloc ();
586 String = UtStringCacheCalloc (Length);
587 Subtable->Buffer = ACPI_CAST_PTR (UINT8, String);
590 Subtable->Length = Length;
591 Subtable->TotalLength = Length;
592 Buffer = Subtable->Buffer;
595 Subtable->Name = LocalField->Name;
598 * Main loop walks the info table for this ACPI table or subtable
600 for (; Info->Name; Info++)
602 if (Info->Opcode == ACPI_DMT_EXTRA_TEXT)
609 sprintf (MsgBuffer, "Found NULL field - Field name \"%s\" needed",
611 DtFatal (ASL_MSG_COMPILER_INTERNAL, NULL, MsgBuffer);
612 Status = AE_BAD_DATA;
616 /* Maintain table offsets */
618 LocalField->TableOffset = Gbl_CurrentTableOffset;
619 FieldLength = DtGetFieldLength (LocalField, Info);
620 Gbl_CurrentTableOffset += FieldLength;
622 FieldType = DtGetFieldType (Info);
623 Gbl_InputFieldCount++;
627 case DT_FIELD_TYPE_FLAGS_INTEGER:
629 * Start of the definition of a flags field.
630 * This master flags integer starts at value zero, in preparation
631 * to compile and insert the flag fields from the individual bits
633 LocalField = LocalField->Next;
637 CurrentFlagByteOffset = Info->Offset;
640 case DT_FIELD_TYPE_FLAG:
642 /* Individual Flag field, can be multiple bits */
647 * We must increment the FlagBuffer when we have crossed
648 * into the next flags byte within the flags field
649 * of type DT_FIELD_TYPE_FLAGS_INTEGER.
651 FlagBuffer += (Info->Offset - CurrentFlagByteOffset);
652 CurrentFlagByteOffset = Info->Offset;
654 DtCompileFlag (FlagBuffer, LocalField, Info);
658 /* TBD - this is an internal error */
661 LocalField = LocalField->Next;
665 case DT_FIELD_TYPE_INLINE_SUBTABLE:
667 * Recursion (one level max): compile GAS (Generic Address)
668 * or Notify in-line subtable
672 switch (Info->Opcode)
676 Status = DtCompileTable (Field, AcpiDmTableInfoGas,
677 &InlineSubtable, TRUE);
680 case ACPI_DMT_HESTNTFY:
682 Status = DtCompileTable (Field, AcpiDmTableInfoHestNotify,
683 &InlineSubtable, TRUE);
686 case ACPI_DMT_IORTMEM:
688 Status = DtCompileTable (Field, AcpiDmTableInfoIortAcc,
689 &InlineSubtable, TRUE);
693 sprintf (MsgBuffer, "Invalid DMT opcode: 0x%.2X",
695 DtFatal (ASL_MSG_COMPILER_INTERNAL, NULL, MsgBuffer);
696 Status = AE_BAD_DATA;
700 if (ACPI_FAILURE (Status))
705 DtSetSubtableLength (InlineSubtable);
707 memcpy (Buffer, InlineSubtable->Buffer, FieldLength);
711 case DT_FIELD_TYPE_LABEL:
713 DtWriteFieldToListing (Buffer, LocalField, 0);
714 LocalField = LocalField->Next;
719 /* Normal case for most field types (Integer, String, etc.) */
721 DtCompileOneField (Buffer, LocalField,
722 FieldLength, FieldType, Info->Flags);
724 DtWriteFieldToListing (Buffer, LocalField, FieldLength);
725 LocalField = LocalField->Next;
727 if (Info->Flags & DT_LENGTH)
729 /* Field is an Integer that will contain a subtable length */
731 Subtable->LengthField = Buffer;
732 Subtable->SizeOfLengthField = FieldLength;
737 Buffer += FieldLength;
741 *RetSubtable = Subtable;
745 ACPI_FREE (Subtable->Buffer);
746 ACPI_FREE (Subtable);
751 /******************************************************************************
753 * FUNCTION: DtCompileTwoSubtables
755 * PARAMETERS: List - Current field list pointer
756 * TableInfo1 - Info table 1
757 * TableInfo1 - Info table 2
761 * DESCRIPTION: Compile tables with a header and one or more same subtables.
762 * Include CPEP, EINJ, ERST, MCFG, MSCT, WDAT
764 *****************************************************************************/
767 DtCompileTwoSubtables (
769 ACPI_DMTABLE_INFO *TableInfo1,
770 ACPI_DMTABLE_INFO *TableInfo2)
773 DT_SUBTABLE *Subtable;
774 DT_SUBTABLE *ParentTable;
775 DT_FIELD **PFieldList = (DT_FIELD **) List;
778 Status = DtCompileTable (PFieldList, TableInfo1, &Subtable, TRUE);
779 if (ACPI_FAILURE (Status))
784 ParentTable = DtPeekSubtable ();
785 DtInsertSubtable (ParentTable, Subtable);
789 Status = DtCompileTable (PFieldList, TableInfo2, &Subtable, FALSE);
790 if (ACPI_FAILURE (Status))
795 DtInsertSubtable (ParentTable, Subtable);
802 /******************************************************************************
804 * FUNCTION: DtCompilePadding
806 * PARAMETERS: Length - Padding field size
807 * RetSubtable - Compile result of table
811 * DESCRIPTION: Compile a subtable for padding purpose
813 *****************************************************************************/
818 DT_SUBTABLE **RetSubtable)
820 DT_SUBTABLE *Subtable;
825 Subtable = UtSubtableCacheCalloc ();
829 String = UtStringCacheCalloc (Length);
830 Subtable->Buffer = ACPI_CAST_PTR (UINT8, String);
833 Subtable->Length = Length;
834 Subtable->TotalLength = Length;
835 /* Buffer = Subtable->Buffer; */
837 *RetSubtable = Subtable;