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 "aslcompiler.h"
155 #include "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 AcpiUtSetIntegerWidth (2); /* Set width to 64 bits */
324 Gbl_FieldList
= NULL
;
325 Gbl_RootTable
= NULL
;
326 Gbl_SubtableStack
= NULL
;
328 sprintf (VersionString
, "%X", (UINT32
) ACPI_CA_VERSION
);
333 /******************************************************************************
335 * FUNCTION: DtInsertCompilerIds
337 * PARAMETERS: FieldList - Current field list pointer
341 * DESCRIPTION: Insert the IDs (Name, Version) of the current compiler into
342 * the original ACPI table header.
344 *****************************************************************************/
347 DtInsertCompilerIds (
355 * Don't insert current compiler ID if requested. Used for compiler
356 * debug/validation only.
358 if (Gbl_UseOriginalCompilerId
)
363 /* Walk to the Compiler fields at the end of the header */
366 for (i
= 0; i
< 7; i
++)
371 Next
->Value
= ASL_CREATOR_ID
;
372 Next
->Flags
= DT_FIELD_NOT_ALLOCATED
;
375 Next
->Value
= VersionString
;
376 Next
->Flags
= DT_FIELD_NOT_ALLOCATED
;
380 /******************************************************************************
382 * FUNCTION: DtCompileDataTable
384 * PARAMETERS: FieldList - Current field list pointer
388 * DESCRIPTION: Entry point to compile one data table
390 *****************************************************************************/
394 DT_FIELD
**FieldList
)
396 const ACPI_DMTABLE_DATA
*TableData
;
397 DT_SUBTABLE
*Subtable
;
399 ACPI_TABLE_HEADER
*AcpiTableHeader
;
401 DT_FIELD
*RootField
= *FieldList
;
404 /* Verify that we at least have a table signature and save it */
406 Signature
= DtGetFieldValue (*FieldList
);
409 sprintf (MsgBuffer
, "Expected \"%s\"", "Signature");
410 DtNameError (ASL_ERROR
, ASL_MSG_INVALID_FIELD_NAME
,
411 *FieldList
, MsgBuffer
);
415 Gbl_Signature
= UtStringCacheCalloc (strlen (Signature
) + 1);
416 strcpy (Gbl_Signature
, Signature
);
419 * Handle tables that don't use the common ACPI table header structure.
420 * Currently, these are the FACS and RSDP. Also check for an OEMx table,
421 * these tables have user-defined contents.
423 if (ACPI_COMPARE_NAME (Signature
, ACPI_SIG_FACS
))
425 Status
= DtCompileFacs (FieldList
);
426 if (ACPI_FAILURE (Status
))
434 else if (ACPI_VALIDATE_RSDP_SIG (Signature
))
436 Status
= DtCompileRsdp (FieldList
);
439 else if (ACPI_COMPARE_NAME (Signature
, ACPI_SIG_S3PT
))
441 Status
= DtCompileS3pt (FieldList
);
442 if (ACPI_FAILURE (Status
))
452 * All other tables must use the common ACPI table header. Insert the
453 * current iASL IDs (name, version), and compile the header now.
455 DtInsertCompilerIds (*FieldList
);
457 Status
= DtCompileTable (FieldList
, AcpiDmTableInfoHeader
,
458 &Gbl_RootTable
, TRUE
);
459 if (ACPI_FAILURE (Status
))
464 DtPushSubtable (Gbl_RootTable
);
466 /* Validate the signature via the ACPI table list */
468 TableData
= AcpiDmGetTableData (Signature
);
469 if (!TableData
|| Gbl_CompileGeneric
)
471 /* Unknown table signature and/or force generic compile */
473 DtCompileGeneric ((void **) FieldList
, NULL
, NULL
);
477 /* Dispatch to per-table compile */
479 if (TableData
->CmTableHandler
)
481 /* Complex table, has a handler */
483 Status
= TableData
->CmTableHandler ((void **) FieldList
);
484 if (ACPI_FAILURE (Status
))
489 else if (TableData
->TableInfo
)
491 /* Simple table, just walk the info table, unless its empty */
493 if (FieldList
&& *FieldList
)
496 Status
= DtCompileTable (FieldList
, TableData
->TableInfo
,
498 if (ACPI_FAILURE (Status
))
503 DtInsertSubtable (Gbl_RootTable
, Subtable
);
509 DtFatal (ASL_MSG_COMPILER_INTERNAL
, *FieldList
,
510 "Missing table dispatch info");
516 /* Set the final table length and then the checksum */
519 AcpiTableHeader
= ACPI_CAST_PTR (
520 ACPI_TABLE_HEADER
, Gbl_RootTable
->Buffer
);
521 DtSetTableChecksum (&AcpiTableHeader
->Checksum
);
523 DtDumpFieldList (RootField
);
524 DtDumpSubtableList ();
529 /******************************************************************************
531 * FUNCTION: DtCompileTable
533 * PARAMETERS: Field - Current field list pointer
534 * Info - Info table for this ACPI table
535 * RetSubtable - Compile result of table
536 * Required - If this subtable must exist
540 * DESCRIPTION: Compile a subtable
542 *****************************************************************************/
547 ACPI_DMTABLE_INFO
*Info
,
548 DT_SUBTABLE
**RetSubtable
,
551 DT_FIELD
*LocalField
;
553 DT_SUBTABLE
*Subtable
;
554 DT_SUBTABLE
*InlineSubtable
= NULL
;
555 UINT32 FieldLength
= 0;
558 UINT8
*FlagBuffer
= NULL
;
560 UINT32 CurrentFlagByteOffset
= 0;
561 ACPI_STATUS Status
= AE_OK
;
564 if (!Field
|| !*Field
)
566 return (AE_BAD_PARAMETER
);
569 /* Ignore optional subtable if name does not match */
571 if ((Info
->Flags
& DT_OPTIONAL
) &&
572 strcmp ((*Field
)->Name
, Info
->Name
))
578 Length
= DtGetSubtableLength (*Field
, Info
);
579 if (Length
== ASL_EOF
)
584 Subtable
= UtSubtableCacheCalloc ();
588 String
= UtStringCacheCalloc (Length
);
589 Subtable
->Buffer
= ACPI_CAST_PTR (UINT8
, String
);
592 Subtable
->Length
= Length
;
593 Subtable
->TotalLength
= Length
;
594 Buffer
= Subtable
->Buffer
;
597 Subtable
->Name
= LocalField
->Name
;
600 * Main loop walks the info table for this ACPI table or subtable
602 for (; Info
->Name
; Info
++)
604 if (Info
->Opcode
== ACPI_DMT_EXTRA_TEXT
)
611 sprintf (MsgBuffer
, "Found NULL field - Field name \"%s\" needed",
613 DtFatal (ASL_MSG_COMPILER_INTERNAL
, NULL
, MsgBuffer
);
614 Status
= AE_BAD_DATA
;
618 /* Maintain table offsets */
620 LocalField
->TableOffset
= Gbl_CurrentTableOffset
;
621 FieldLength
= DtGetFieldLength (LocalField
, Info
);
622 Gbl_CurrentTableOffset
+= FieldLength
;
624 FieldType
= DtGetFieldType (Info
);
625 Gbl_InputFieldCount
++;
629 case DT_FIELD_TYPE_FLAGS_INTEGER
:
631 * Start of the definition of a flags field.
632 * This master flags integer starts at value zero, in preparation
633 * to compile and insert the flag fields from the individual bits
635 LocalField
= LocalField
->Next
;
639 CurrentFlagByteOffset
= Info
->Offset
;
642 case DT_FIELD_TYPE_FLAG
:
644 /* Individual Flag field, can be multiple bits */
649 * We must increment the FlagBuffer when we have crossed
650 * into the next flags byte within the flags field
651 * of type DT_FIELD_TYPE_FLAGS_INTEGER.
653 FlagBuffer
+= (Info
->Offset
- CurrentFlagByteOffset
);
654 CurrentFlagByteOffset
= Info
->Offset
;
656 DtCompileFlag (FlagBuffer
, LocalField
, Info
);
660 /* TBD - this is an internal error */
663 LocalField
= LocalField
->Next
;
667 case DT_FIELD_TYPE_INLINE_SUBTABLE
:
669 * Recursion (one level max): compile GAS (Generic Address)
670 * or Notify in-line subtable
674 switch (Info
->Opcode
)
678 Status
= DtCompileTable (Field
, AcpiDmTableInfoGas
,
679 &InlineSubtable
, TRUE
);
682 case ACPI_DMT_HESTNTFY
:
684 Status
= DtCompileTable (Field
, AcpiDmTableInfoHestNotify
,
685 &InlineSubtable
, TRUE
);
688 case ACPI_DMT_IORTMEM
:
690 Status
= DtCompileTable (Field
, AcpiDmTableInfoIortAcc
,
691 &InlineSubtable
, TRUE
);
695 sprintf (MsgBuffer
, "Invalid DMT opcode: 0x%.2X",
697 DtFatal (ASL_MSG_COMPILER_INTERNAL
, NULL
, MsgBuffer
);
698 Status
= AE_BAD_DATA
;
702 if (ACPI_FAILURE (Status
))
707 DtSetSubtableLength (InlineSubtable
);
709 memcpy (Buffer
, InlineSubtable
->Buffer
, FieldLength
);
713 case DT_FIELD_TYPE_LABEL
:
715 DtWriteFieldToListing (Buffer
, LocalField
, 0);
716 LocalField
= LocalField
->Next
;
721 /* Normal case for most field types (Integer, String, etc.) */
723 DtCompileOneField (Buffer
, LocalField
,
724 FieldLength
, FieldType
, Info
->Flags
);
726 DtWriteFieldToListing (Buffer
, LocalField
, FieldLength
);
727 LocalField
= LocalField
->Next
;
729 if (Info
->Flags
& DT_LENGTH
)
731 /* Field is an Integer that will contain a subtable length */
733 Subtable
->LengthField
= Buffer
;
734 Subtable
->SizeOfLengthField
= FieldLength
;
739 Buffer
+= FieldLength
;
743 *RetSubtable
= Subtable
;
747 ACPI_FREE (Subtable
->Buffer
);
748 ACPI_FREE (Subtable
);
753 /******************************************************************************
755 * FUNCTION: DtCompileTwoSubtables
757 * PARAMETERS: List - Current field list pointer
758 * TableInfo1 - Info table 1
759 * TableInfo1 - Info table 2
763 * DESCRIPTION: Compile tables with a header and one or more same subtables.
764 * Include CPEP, EINJ, ERST, MCFG, MSCT, WDAT
766 *****************************************************************************/
769 DtCompileTwoSubtables (
771 ACPI_DMTABLE_INFO
*TableInfo1
,
772 ACPI_DMTABLE_INFO
*TableInfo2
)
775 DT_SUBTABLE
*Subtable
;
776 DT_SUBTABLE
*ParentTable
;
777 DT_FIELD
**PFieldList
= (DT_FIELD
**) List
;
780 Status
= DtCompileTable (PFieldList
, TableInfo1
, &Subtable
, TRUE
);
781 if (ACPI_FAILURE (Status
))
786 ParentTable
= DtPeekSubtable ();
787 DtInsertSubtable (ParentTable
, Subtable
);
791 Status
= DtCompileTable (PFieldList
, TableInfo2
, &Subtable
, FALSE
);
792 if (ACPI_FAILURE (Status
))
797 DtInsertSubtable (ParentTable
, Subtable
);
804 /******************************************************************************
806 * FUNCTION: DtCompilePadding
808 * PARAMETERS: Length - Padding field size
809 * RetSubtable - Compile result of table
813 * DESCRIPTION: Compile a subtable for padding purpose
815 *****************************************************************************/
820 DT_SUBTABLE
**RetSubtable
)
822 DT_SUBTABLE
*Subtable
;
827 Subtable
= UtSubtableCacheCalloc ();
831 String
= UtStringCacheCalloc (Length
);
832 Subtable
->Buffer
= ACPI_CAST_PTR (UINT8
, String
);
835 Subtable
->Length
= Length
;
836 Subtable
->TotalLength
= Length
;
837 /* Buffer = Subtable->Buffer; */
839 *RetSubtable
= Subtable
;