1 /******************************************************************************
3 * Module Name: dtcompiler.h - header for data table compiler
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2011, 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 #define __DTCOMPILER_H__
122 #include "acdisasm.h"
127 #ifdef _DECLARE_DT_GLOBALS
129 #define DT_INIT_GLOBAL(a,b) (a)=(b)
131 #define DT_EXTERN extern
132 #define DT_INIT_GLOBAL(a,b) (a)
136 /* Types for individual fields (one per input line) */
138 #define DT_FIELD_TYPE_STRING 0
139 #define DT_FIELD_TYPE_INTEGER 1
140 #define DT_FIELD_TYPE_BUFFER 2
141 #define DT_FIELD_TYPE_PCI_PATH 3
142 #define DT_FIELD_TYPE_FLAG 4
143 #define DT_FIELD_TYPE_FLAGS_INTEGER 5
144 #define DT_FIELD_TYPE_INLINE_SUBTABLE 6
145 #define DT_FIELD_TYPE_UUID 7
146 #define DT_FIELD_TYPE_UNICODE 8
147 #define DT_FIELD_TYPE_DEVICE_PATH 9
148 #define DT_FIELD_TYPE_LABEL 10
152 * Structure used for each individual field within an ACPI table
154 typedef struct dt_field
156 char *Name; /* Field name (from name : value) */
157 char *Value; /* Field value (from name : value) */
158 struct dt_field *Next; /* Next field */
159 struct dt_field *NextLabel; /* If field is a label, next label */
160 UINT32 Line; /* Line number for this field */
161 UINT32 ByteOffset; /* Offset in source file for field */
162 UINT32 NameColumn; /* Start column for field name */
163 UINT32 Column; /* Start column for field value */
164 UINT32 TableOffset;/* Binary offset within ACPI table */
169 /* Flags for above */
171 #define DT_FIELD_NOT_ALLOCATED 1
175 * Structure used for individual subtables within an ACPI table
177 typedef struct dt_subtable
179 struct dt_subtable *Parent;
180 struct dt_subtable *Child;
181 struct dt_subtable *Peer;
182 struct dt_subtable *StackTop;
187 UINT32 SizeOfLengthField;
197 /* List of all field names and values from the input source */
199 DT_EXTERN DT_FIELD DT_INIT_GLOBAL (*Gbl_FieldList, NULL);
201 /* List of all compiled tables and subtables */
203 DT_EXTERN DT_SUBTABLE DT_INIT_GLOBAL (*Gbl_RootTable, NULL);
205 /* Stack for subtables */
207 DT_EXTERN DT_SUBTABLE DT_INIT_GLOBAL (*Gbl_SubtableStack, NULL);
209 /* List for defined labels */
211 DT_EXTERN DT_FIELD DT_INIT_GLOBAL (*Gbl_LabelList, NULL);
213 /* Current offset within the binary output table */
215 DT_EXTERN UINT32 DT_INIT_GLOBAL (Gbl_CurrentTableOffset, 0);
218 /* dtcompiler - main module */
223 ACPI_DMTABLE_INFO *Info,
224 DT_SUBTABLE **RetSubtable,
228 /* dtio - binary and text input/output */
236 DT_SUBTABLE *RootTable);
239 DtWriteFieldToListing (
245 DtWriteTableToListing (
249 /* dtsubtable - compile subtables */
255 DT_SUBTABLE **RetSubtable);
258 DtGetSubtableLength (
260 ACPI_DMTABLE_INFO *Info);
263 DtSetSubtableLength (
264 DT_SUBTABLE *Subtable);
268 DT_SUBTABLE *Subtable);
280 DT_SUBTABLE *ParentTable,
281 DT_SUBTABLE *Subtable);
285 DT_SUBTABLE *ParentTable,
286 DT_SUBTABLE *ChildTable);
289 DtGetParentSubtable (
290 DT_SUBTABLE *Subtable);
293 /* dtexpress - Integer expressions and labels */
296 DtResolveIntegerExpression (
298 UINT64 *ReturnValue);
312 DT_FIELD *FieldList);
315 /* dtfield - Compile individual fields within a table */
343 ACPI_DMTABLE_INFO *Info);
346 /* dtparser - lex/yacc files */
349 DtEvaluateExpression (
365 /* dtutils - Miscellaneous utilities */
368 void (*DT_WALK_CALLBACK) (
369 DT_SUBTABLE *Subtable,
375 DT_SUBTABLE *StartTable,
376 DT_WALK_CALLBACK UserFunction,
384 DT_FIELD *FieldObject,
391 DT_FIELD *FieldObject,
397 DT_FIELD *FieldObject,
403 UINT64 *ReturnInteger);
415 ACPI_DMTABLE_INFO *Info);
424 ACPI_DMTABLE_INFO *Info);
428 UINT8 *ChecksumPointer);
439 /* dttable - individual table compilation */
443 DT_FIELD **PFieldList);
447 DT_FIELD **PFieldList);
526 DtGetGenericTableInfo (
529 /* ACPI Table templates */
531 extern const unsigned char TemplateAsf[];
532 extern const unsigned char TemplateBoot[];
533 extern const unsigned char TemplateBert[];
534 extern const unsigned char TemplateCpep[];
535 extern const unsigned char TemplateDbgp[];
536 extern const unsigned char TemplateDmar[];
537 extern const unsigned char TemplateEcdt[];
538 extern const unsigned char TemplateEinj[];
539 extern const unsigned char TemplateErst[];
540 extern const unsigned char TemplateFadt[];
541 extern const unsigned char TemplateHest[];
542 extern const unsigned char TemplateHpet[];
543 extern const unsigned char TemplateIvrs[];
544 extern const unsigned char TemplateMadt[];
545 extern const unsigned char TemplateMcfg[];
546 extern const unsigned char TemplateMchi[];
547 extern const unsigned char TemplateMsct[];
548 extern const unsigned char TemplateRsdt[];
549 extern const unsigned char TemplateSbst[];
550 extern const unsigned char TemplateSlic[];
551 extern const unsigned char TemplateSlit[];
552 extern const unsigned char TemplateSpcr[];
553 extern const unsigned char TemplateSpmi[];
554 extern const unsigned char TemplateSrat[];
555 extern const unsigned char TemplateTcpa[];
556 extern const unsigned char TemplateUefi[];
557 extern const unsigned char TemplateWaet[];
558 extern const unsigned char TemplateWdat[];
559 extern const unsigned char TemplateWddt[];
560 extern const unsigned char TemplateWdrt[];
561 extern const unsigned char TemplateXsdt[];