1 /******************************************************************************
3 * Module Name: dtcompile.c - Front-end for data table compiler
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 #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 ();
265 FileNode
->TotalLineCount
= AslGbl_CurrentLineNumber
;
266 FileNode
->OriginalInputFileSize
= AslGbl_InputByteCount
;
267 DbgPrint (ASL_PARSE_OUTPUT
, "Line count: %u input file size: %u\n",
268 FileNode
->TotalLineCount
, FileNode
->OriginalInputFileSize
);
270 if (ACPI_FAILURE (Status
))
272 FileNode
->ParserErrorDetected
= TRUE
;
274 /* TBD: temporary error message. Msgs should come from function above */
276 DtError (ASL_ERROR
, ASL_MSG_SYNTAX
, NULL
,
277 "Could not compile input file");
282 /* Create/open the binary output file */
284 AslGbl_Files
[ASL_FILE_AML_OUTPUT
].Filename
= NULL
;
285 Status
= FlOpenAmlOutputFile (AslGbl_OutputFilenamePrefix
);
286 if (ACPI_FAILURE (Status
))
291 /* Write the binary, then the optional hex file */
293 DtOutputBinary (AslGbl_RootTable
);
295 DtWriteTableToListing ();
297 /* Save the compile time statistics to the current file node */
299 FileNode
->TotalFields
= AslGbl_InputFieldCount
;
300 FileNode
->OutputByteLength
= AslGbl_TableLength
;
306 /******************************************************************************
308 * FUNCTION: DtInitialize
314 * DESCRIPTION: Initialize data table compiler globals. Enables multiple
315 * compiles per invocation.
317 *****************************************************************************/
325 AcpiUtSetIntegerWidth (2); /* Set width to 64 bits */
327 AslGbl_FieldList
= NULL
;
328 AslGbl_RootTable
= NULL
;
329 AslGbl_SubtableStack
= NULL
;
331 sprintf (VersionString
, "%X", (UINT32
) ACPI_CA_VERSION
);
336 /******************************************************************************
338 * FUNCTION: DtInsertCompilerIds
340 * PARAMETERS: FieldList - Current field list pointer
344 * DESCRIPTION: Insert the IDs (Name, Version) of the current compiler into
345 * the original ACPI table header.
347 *****************************************************************************/
350 DtInsertCompilerIds (
358 * Don't insert current compiler ID if requested. Used for compiler
359 * debug/validation only.
361 if (AslGbl_UseOriginalCompilerId
)
366 /* Walk to the Compiler fields at the end of the header */
369 for (i
= 0; i
< 7; i
++)
374 Next
->Value
= ASL_CREATOR_ID
;
375 Next
->Flags
= DT_FIELD_NOT_ALLOCATED
;
378 Next
->Value
= VersionString
;
379 Next
->Flags
= DT_FIELD_NOT_ALLOCATED
;
383 /******************************************************************************
385 * FUNCTION: DtCompileDataTable
387 * PARAMETERS: FieldList - Current field list pointer
391 * DESCRIPTION: Entry point to compile one data table
393 *****************************************************************************/
397 DT_FIELD
**FieldList
)
399 const ACPI_DMTABLE_DATA
*TableData
;
400 DT_SUBTABLE
*Subtable
;
402 ACPI_TABLE_HEADER
*AcpiTableHeader
;
404 DT_FIELD
*RootField
= *FieldList
;
407 /* Verify that we at least have a table signature and save it */
409 Signature
= DtGetFieldValue (*FieldList
);
412 sprintf (AslGbl_MsgBuffer
, "Expected \"%s\"", "Signature");
413 DtNameError (ASL_ERROR
, ASL_MSG_INVALID_FIELD_NAME
,
414 *FieldList
, AslGbl_MsgBuffer
);
418 AslGbl_Signature
= UtLocalCacheCalloc (strlen (Signature
) + 1);
419 strcpy (AslGbl_Signature
, Signature
);
422 * Handle tables that don't use the common ACPI table header structure.
423 * Currently, these are the FACS and RSDP. Also check for an OEMx table,
424 * these tables have user-defined contents.
426 if (ACPI_COMPARE_NAMESEG (Signature
, ACPI_SIG_FACS
))
428 Status
= DtCompileFacs (FieldList
);
429 if (ACPI_FAILURE (Status
))
437 else if (ACPI_VALIDATE_RSDP_SIG (Signature
))
439 Status
= DtCompileRsdp (FieldList
);
442 else if (ACPI_COMPARE_NAMESEG (Signature
, ACPI_SIG_S3PT
))
444 Status
= DtCompileS3pt (FieldList
);
445 if (ACPI_FAILURE (Status
))
455 * All other tables must use the common ACPI table header. Insert the
456 * current iASL IDs (name, version), and compile the header now.
458 DtInsertCompilerIds (*FieldList
);
460 Status
= DtCompileTable (FieldList
, AcpiDmTableInfoHeader
,
462 if (ACPI_FAILURE (Status
))
467 DtPushSubtable (AslGbl_RootTable
);
469 /* Validate the signature via the ACPI table list */
471 TableData
= AcpiDmGetTableData (Signature
);
472 if (!TableData
|| AslGbl_CompileGeneric
)
474 /* Unknown table signature and/or force generic compile */
476 DtCompileGeneric ((void **) FieldList
, NULL
, NULL
);
480 /* Dispatch to per-table compile */
482 if (TableData
->CmTableHandler
)
484 /* Complex table, has a handler */
486 Status
= TableData
->CmTableHandler ((void **) FieldList
);
487 if (ACPI_FAILURE (Status
))
492 else if (TableData
->TableInfo
)
494 /* Simple table, just walk the info table, unless its empty */
496 if (FieldList
&& *FieldList
)
499 Status
= DtCompileTable (FieldList
, TableData
->TableInfo
,
501 if (ACPI_FAILURE (Status
))
506 DtInsertSubtable (AslGbl_RootTable
, Subtable
);
512 DtFatal (ASL_MSG_COMPILER_INTERNAL
, *FieldList
,
513 "Missing table dispatch info");
519 /* Set the final table length and then the checksum */
522 AcpiTableHeader
= ACPI_CAST_PTR (
523 ACPI_TABLE_HEADER
, AslGbl_RootTable
->Buffer
);
524 DtSetTableChecksum (&AcpiTableHeader
->Checksum
);
526 DtDumpFieldList (RootField
);
527 DtDumpSubtableList ();
532 /******************************************************************************
534 * FUNCTION: DtCompileTable
536 * PARAMETERS: Field - Current field list pointer
537 * Info - Info table for this ACPI table
538 * RetSubtable - Compile result of table
542 * DESCRIPTION: Compile a subtable
544 *****************************************************************************/
549 ACPI_DMTABLE_INFO
*Info
,
550 DT_SUBTABLE
**RetSubtable
)
552 DT_FIELD
*LocalField
;
554 DT_SUBTABLE
*Subtable
;
555 DT_SUBTABLE
*InlineSubtable
= NULL
;
556 UINT32 FieldLength
= 0;
559 UINT8
*FlagBuffer
= NULL
;
561 UINT32 CurrentFlagByteOffset
= 0;
562 ACPI_STATUS Status
= AE_OK
;
567 return (AE_BAD_PARAMETER
);
572 * The field list is empty, this means that we are out of fields to
573 * parse. In other words, we are at the end of the table.
575 return (AE_END_OF_TABLE
);
578 /* Ignore optional subtable if name does not match */
580 if ((Info
->Flags
& DT_OPTIONAL
) &&
581 strcmp ((*Field
)->Name
, Info
->Name
))
587 Length
= DtGetSubtableLength (*Field
, Info
);
588 if (Length
== ASL_EOF
)
593 Subtable
= UtSubtableCacheCalloc ();
597 String
= UtLocalCacheCalloc (Length
);
598 Subtable
->Buffer
= ACPI_CAST_PTR (UINT8
, String
);
601 Subtable
->Length
= Length
;
602 Subtable
->TotalLength
= Length
;
603 Buffer
= Subtable
->Buffer
;
606 Subtable
->Name
= LocalField
->Name
;
609 * Main loop walks the info table for this ACPI table or subtable
611 for (; Info
->Name
; Info
++)
613 if (Info
->Opcode
== ACPI_DMT_EXTRA_TEXT
)
620 sprintf (AslGbl_MsgBuffer
, "Found NULL field - Field name \"%s\" needed",
622 DtFatal (ASL_MSG_COMPILER_INTERNAL
, NULL
, AslGbl_MsgBuffer
);
623 Status
= AE_BAD_DATA
;
627 /* Maintain table offsets */
629 LocalField
->TableOffset
= AslGbl_CurrentTableOffset
;
630 FieldLength
= DtGetFieldLength (LocalField
, Info
);
631 AslGbl_CurrentTableOffset
+= FieldLength
;
633 FieldType
= DtGetFieldType (Info
);
634 AslGbl_InputFieldCount
++;
636 if (FieldType
!= DT_FIELD_TYPE_INLINE_SUBTABLE
&&
637 strcmp (Info
->Name
, LocalField
->Name
))
639 sprintf (AslGbl_MsgBuffer
, "found \"%s\" expected \"%s\"",
640 LocalField
->Name
, Info
->Name
);
641 DtError (ASL_ERROR
, ASL_MSG_INVALID_LABEL
, LocalField
, AslGbl_MsgBuffer
);
646 case DT_FIELD_TYPE_FLAGS_INTEGER
:
648 * Start of the definition of a flags field.
649 * This master flags integer starts at value zero, in preparation
650 * to compile and insert the flag fields from the individual bits
652 LocalField
= LocalField
->Next
;
656 CurrentFlagByteOffset
= Info
->Offset
;
659 case DT_FIELD_TYPE_FLAG
:
661 /* Individual Flag field, can be multiple bits */
666 * We must increment the FlagBuffer when we have crossed
667 * into the next flags byte within the flags field
668 * of type DT_FIELD_TYPE_FLAGS_INTEGER.
670 FlagBuffer
+= (Info
->Offset
- CurrentFlagByteOffset
);
671 CurrentFlagByteOffset
= Info
->Offset
;
673 DtCompileFlag (FlagBuffer
, LocalField
, Info
);
677 /* TBD - this is an internal error */
680 LocalField
= LocalField
->Next
;
684 case DT_FIELD_TYPE_INLINE_SUBTABLE
:
686 * Recursion (one level max): compile GAS (Generic Address)
687 * or Notify in-line subtable
691 switch (Info
->Opcode
)
695 Status
= DtCompileTable (Field
, AcpiDmTableInfoGas
,
699 case ACPI_DMT_HESTNTFY
:
701 Status
= DtCompileTable (Field
, AcpiDmTableInfoHestNotify
,
705 case ACPI_DMT_IORTMEM
:
707 Status
= DtCompileTable (Field
, AcpiDmTableInfoIortAcc
,
712 sprintf (AslGbl_MsgBuffer
, "Invalid DMT opcode: 0x%.2X",
714 DtFatal (ASL_MSG_COMPILER_INTERNAL
, NULL
, AslGbl_MsgBuffer
);
715 Status
= AE_BAD_DATA
;
719 if (ACPI_FAILURE (Status
))
724 DtSetSubtableLength (InlineSubtable
);
726 memcpy (Buffer
, InlineSubtable
->Buffer
, FieldLength
);
730 case DT_FIELD_TYPE_LABEL
:
732 DtWriteFieldToListing (Buffer
, LocalField
, 0);
733 LocalField
= LocalField
->Next
;
738 /* Normal case for most field types (Integer, String, etc.) */
740 DtCompileOneField (Buffer
, LocalField
,
741 FieldLength
, FieldType
, Info
->Flags
);
743 DtWriteFieldToListing (Buffer
, LocalField
, FieldLength
);
744 LocalField
= LocalField
->Next
;
746 if (Info
->Flags
& DT_LENGTH
)
748 /* Field is an Integer that will contain a subtable length */
750 Subtable
->LengthField
= Buffer
;
751 Subtable
->SizeOfLengthField
= FieldLength
;
756 Buffer
+= FieldLength
;
760 *RetSubtable
= Subtable
;
764 ACPI_FREE (Subtable
->Buffer
);
765 ACPI_FREE (Subtable
);
770 /******************************************************************************
772 * FUNCTION: DtCompileTwoSubtables
774 * PARAMETERS: List - Current field list pointer
775 * TableInfo1 - Info table 1
776 * TableInfo1 - Info table 2
780 * DESCRIPTION: Compile tables with a header and one or more same subtables.
781 * Include CPEP, EINJ, ERST, MCFG, MSCT, WDAT
783 *****************************************************************************/
786 DtCompileTwoSubtables (
788 ACPI_DMTABLE_INFO
*TableInfo1
,
789 ACPI_DMTABLE_INFO
*TableInfo2
)
792 DT_SUBTABLE
*Subtable
;
793 DT_SUBTABLE
*ParentTable
;
794 DT_FIELD
**PFieldList
= (DT_FIELD
**) List
;
797 Status
= DtCompileTable (PFieldList
, TableInfo1
, &Subtable
);
798 if (ACPI_FAILURE (Status
))
803 ParentTable
= DtPeekSubtable ();
804 DtInsertSubtable (ParentTable
, Subtable
);
808 Status
= DtCompileTable (PFieldList
, TableInfo2
, &Subtable
);
809 if (ACPI_FAILURE (Status
))
814 DtInsertSubtable (ParentTable
, Subtable
);
821 /******************************************************************************
823 * FUNCTION: DtCompilePadding
825 * PARAMETERS: Length - Padding field size
826 * RetSubtable - Compile result of table
830 * DESCRIPTION: Compile a subtable for padding purpose
832 *****************************************************************************/
837 DT_SUBTABLE
**RetSubtable
)
839 DT_SUBTABLE
*Subtable
;
844 Subtable
= UtSubtableCacheCalloc ();
848 String
= UtLocalCacheCalloc (Length
);
849 Subtable
->Buffer
= ACPI_CAST_PTR (UINT8
, String
);
852 Subtable
->Length
= Length
;
853 Subtable
->TotalLength
= Length
;
854 /* Buffer = Subtable->Buffer; */
856 *RetSubtable
= Subtable
;