1 /******************************************************************************
3 * Module Name: dtcompiler.h - header for data table compiler
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2020, 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 __DTCOMPILER_H__
157 #include <contrib/dev/acpica/include/acdisasm.h>
160 #define ASL_FIELD_CACHE_SIZE 512
161 #define ASL_SUBTABLE_CACHE_SIZE 128
166 #ifdef _DECLARE_DT_GLOBALS
168 #define DT_INIT_GLOBAL(a,b) (a)=(b)
170 #define DT_EXTERN extern
171 #define DT_INIT_GLOBAL(a,b) (a)
175 /* Types for individual fields (one per input line) */
177 #define DT_FIELD_TYPE_STRING 0
178 #define DT_FIELD_TYPE_INTEGER 1
179 #define DT_FIELD_TYPE_BUFFER 2
180 #define DT_FIELD_TYPE_PCI_PATH 3
181 #define DT_FIELD_TYPE_FLAG 4
182 #define DT_FIELD_TYPE_FLAGS_INTEGER 5
183 #define DT_FIELD_TYPE_INLINE_SUBTABLE 6
184 #define DT_FIELD_TYPE_UUID 7
185 #define DT_FIELD_TYPE_UNICODE 8
186 #define DT_FIELD_TYPE_DEVICE_PATH 9
187 #define DT_FIELD_TYPE_LABEL 10
191 * Structure used for each individual field within an ACPI table
193 typedef struct dt_field
195 char *Name; /* Field name (from name : value) */
196 char *Value; /* Field value (from name : value) */
197 UINT32 StringLength; /* Length of Value */
198 struct dt_field *Next; /* Next field */
199 struct dt_field *NextLabel; /* If field is a label, next label */
200 UINT32 Line; /* Line number for this field */
201 UINT32 ByteOffset; /* Offset in source file for field */
202 UINT32 NameColumn; /* Start column for field name */
203 UINT32 Column; /* Start column for field value */
204 UINT32 TableOffset; /* Binary offset within ACPI table */
209 /* Flags for above */
211 #define DT_FIELD_NOT_ALLOCATED 1
214 * Structure used for each individual key or value
216 typedef struct dt_table_unit
218 char *Value; /* Field value (from name : value) */
219 UINT32 Line; /* Line number for this field */
220 UINT32 Column; /* Start column for field value */
226 * Structure used for individual subtables within an ACPI table
228 typedef struct dt_subtable
230 struct dt_subtable *Parent;
231 struct dt_subtable *Child;
232 struct dt_subtable *Peer;
233 struct dt_subtable *StackTop;
239 UINT32 SizeOfLengthField;
250 /* List of all field names and values from the input source */
252 DT_EXTERN DT_FIELD DT_INIT_GLOBAL (*AslGbl_FieldList, NULL);
254 /* List of all compiled tables and subtables */
256 DT_EXTERN DT_SUBTABLE DT_INIT_GLOBAL (*AslGbl_RootTable, NULL);
258 /* Stack for subtables */
260 DT_EXTERN DT_SUBTABLE DT_INIT_GLOBAL (*AslGbl_SubtableStack, NULL);
262 /* List for defined labels */
264 DT_EXTERN DT_FIELD DT_INIT_GLOBAL (*AslGbl_LabelList, NULL);
266 /* Current offset within the binary output table */
268 DT_EXTERN UINT32 DT_INIT_GLOBAL (AslGbl_CurrentTableOffset, 0);
270 /* Data table compiler Flex/Bison prototype */
272 DT_EXTERN BOOLEAN DT_INIT_GLOBAL (AslGbl_DtLexBisonPrototype, FALSE);
276 DT_EXTERN UINT32 DT_INIT_GLOBAL (AslGbl_SubtableCount, 0);
277 DT_EXTERN ASL_CACHE_INFO DT_INIT_GLOBAL (*AslGbl_SubtableCacheList, NULL);
278 DT_EXTERN DT_SUBTABLE DT_INIT_GLOBAL (*AslGbl_SubtableCacheNext, NULL);
279 DT_EXTERN DT_SUBTABLE DT_INIT_GLOBAL (*AslGbl_SubtableCacheLast, NULL);
281 DT_EXTERN UINT32 DT_INIT_GLOBAL (AslGbl_FieldCount, 0);
282 DT_EXTERN ASL_CACHE_INFO DT_INIT_GLOBAL (*AslGbl_FieldCacheList, NULL);
283 DT_EXTERN DT_FIELD DT_INIT_GLOBAL (*AslGbl_FieldCacheNext, NULL);
284 DT_EXTERN DT_FIELD DT_INIT_GLOBAL (*AslGbl_FieldCacheLast, NULL);
287 /* dtcompiler - main module */
292 ACPI_DMTABLE_INFO *Info,
293 DT_SUBTABLE **RetSubtable);
296 DtCompileTwoSubtables (
298 ACPI_DMTABLE_INFO *TableInfo1,
299 ACPI_DMTABLE_INFO *TableInfo2);
304 DT_SUBTABLE **RetSubtable);
307 /* dtio - binary and text input/output */
314 /* Flags for DtGetNextLine */
316 #define DT_ALLOW_MULTILINE_QUOTES 0x01
325 DT_SUBTABLE *RootTable);
336 DtWriteFieldToListing (
342 DtWriteTableToListing (
346 /* dtsubtable - compile subtables */
352 DT_SUBTABLE **RetSubtable);
355 DtGetSubtableLength (
357 ACPI_DMTABLE_INFO *Info);
360 DtSetSubtableLength (
361 DT_SUBTABLE *Subtable);
365 DT_SUBTABLE *Subtable);
377 DT_SUBTABLE *ParentTable,
378 DT_SUBTABLE *Subtable);
382 DT_SUBTABLE *ParentTable,
383 DT_SUBTABLE *ChildTable);
386 DtGetParentSubtable (
387 DT_SUBTABLE *Subtable);
390 /* dtexpress - Integer expressions and labels */
393 DtResolveIntegerExpression (
395 UINT64 *ReturnValue);
409 DT_FIELD *FieldList);
412 /* dtfield - Compile individual fields within a table */
440 ACPI_DMTABLE_INFO *Info);
443 /* dtfield - DT_FIELD operations */
451 DT_TABLE_UNIT *FieldKey,
452 DT_TABLE_UNIT *FieldValue,
462 /* dtparser - lex/yacc files */
464 UINT64 DtCompilerParserResult; /* Expression return value */
466 DtCompilerParserparse (
470 DtEvaluateExpression (
474 DtCompilerInitLexer (
478 DtCompilerTerminateLexer (
494 /* dtutils - Miscellaneous utilities */
497 void (*DT_WALK_CALLBACK) (
498 DT_SUBTABLE *Subtable,
504 DT_SUBTABLE *StartTable,
505 DT_WALK_CALLBACK UserFunction,
513 DT_FIELD *FieldObject,
520 DT_FIELD *FieldObject,
526 DT_FIELD *FieldObject,
539 ACPI_DMTABLE_INFO *Info);
548 ACPI_DMTABLE_INFO *Info);
552 UINT8 *ChecksumPointer);
559 /* dttable - individual table compilation */
563 DT_FIELD **PFieldList);
567 DT_FIELD **PFieldList);
679 DT_FIELD **PFieldList);
733 UINT32 *PFieldLength);
736 DtGetGenericTableInfo (
739 /* ACPI Table templates */
741 extern const unsigned char TemplateAsf[];
742 extern const unsigned char TemplateBoot[];
743 extern const unsigned char TemplateBert[];
744 extern const unsigned char TemplateBgrt[];
745 extern const unsigned char TemplateCpep[];
746 extern const unsigned char TemplateCsrt[];
747 extern const unsigned char TemplateDbg2[];
748 extern const unsigned char TemplateDbgp[];
749 extern const unsigned char TemplateDmar[];
750 extern const unsigned char TemplateDrtm[];
751 extern const unsigned char TemplateEcdt[];
752 extern const unsigned char TemplateEinj[];
753 extern const unsigned char TemplateErst[];
754 extern const unsigned char TemplateFadt[];
755 extern const unsigned char TemplateFpdt[];
756 extern const unsigned char TemplateGtdt[];
757 extern const unsigned char TemplateHest[];
758 extern const unsigned char TemplateHmat[];
759 extern const unsigned char TemplateHpet[];
760 extern const unsigned char TemplateIort[];
761 extern const unsigned char TemplateIvrs[];
762 extern const unsigned char TemplateLpit[];
763 extern const unsigned char TemplateMadt[];
764 extern const unsigned char TemplateMcfg[];
765 extern const unsigned char TemplateMchi[];
766 extern const unsigned char TemplateMpst[];
767 extern const unsigned char TemplateMsct[];
768 extern const unsigned char TemplateMsdm[];
769 extern const unsigned char TemplateMtmr[];
770 extern const unsigned char TemplateNfit[];
771 extern const unsigned char TemplatePcct[];
772 extern const unsigned char TemplatePdtt[];
773 extern const unsigned char TemplatePmtt[];
774 extern const unsigned char TemplatePptt[];
775 extern const unsigned char TemplateRasf[];
776 extern const unsigned char TemplateRsdt[];
777 extern const unsigned char TemplateS3pt[];
778 extern const unsigned char TemplateSbst[];
779 extern const unsigned char TemplateSdei[];
780 extern const unsigned char TemplateSdev[];
781 extern const unsigned char TemplateSlic[];
782 extern const unsigned char TemplateSlit[];
783 extern const unsigned char TemplateSpcr[];
784 extern const unsigned char TemplateSpmi[];
785 extern const unsigned char TemplateSrat[];
786 extern const unsigned char TemplateStao[];
787 extern const unsigned char TemplateTcpa[];
788 extern const unsigned char TemplateTpm2[];
789 extern const unsigned char TemplateUefi[];
790 extern const unsigned char TemplateVrtc[];
791 extern const unsigned char TemplateWaet[];
792 extern const unsigned char TemplateWdat[];
793 extern const unsigned char TemplateWddt[];
794 extern const unsigned char TemplateWdrt[];
795 extern const unsigned char TemplateWpbt[];
796 extern const unsigned char TemplateWsmt[];
797 extern const unsigned char TemplateXenv[];
798 extern const unsigned char TemplateXsdt[];