1 /******************************************************************************
3 * Module Name: dtcompiler.h - header for data table compiler
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2014, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 #define __DTCOMPILER_H__
55 #ifdef _DECLARE_DT_GLOBALS
57 #define DT_INIT_GLOBAL(a,b) (a)=(b)
59 #define DT_EXTERN extern
60 #define DT_INIT_GLOBAL(a,b) (a)
64 /* Types for individual fields (one per input line) */
66 #define DT_FIELD_TYPE_STRING 0
67 #define DT_FIELD_TYPE_INTEGER 1
68 #define DT_FIELD_TYPE_BUFFER 2
69 #define DT_FIELD_TYPE_PCI_PATH 3
70 #define DT_FIELD_TYPE_FLAG 4
71 #define DT_FIELD_TYPE_FLAGS_INTEGER 5
72 #define DT_FIELD_TYPE_INLINE_SUBTABLE 6
73 #define DT_FIELD_TYPE_UUID 7
74 #define DT_FIELD_TYPE_UNICODE 8
75 #define DT_FIELD_TYPE_DEVICE_PATH 9
76 #define DT_FIELD_TYPE_LABEL 10
80 * Structure used for each individual field within an ACPI table
82 typedef struct dt_field
84 char *Name; /* Field name (from name : value) */
85 char *Value; /* Field value (from name : value) */
86 struct dt_field *Next; /* Next field */
87 struct dt_field *NextLabel; /* If field is a label, next label */
88 UINT32 Line; /* Line number for this field */
89 UINT32 ByteOffset; /* Offset in source file for field */
90 UINT32 NameColumn; /* Start column for field name */
91 UINT32 Column; /* Start column for field value */
92 UINT32 TableOffset;/* Binary offset within ACPI table */
99 #define DT_FIELD_NOT_ALLOCATED 1
103 * Structure used for individual subtables within an ACPI table
105 typedef struct dt_subtable
107 struct dt_subtable *Parent;
108 struct dt_subtable *Child;
109 struct dt_subtable *Peer;
110 struct dt_subtable *StackTop;
115 UINT32 SizeOfLengthField;
126 /* List of all field names and values from the input source */
128 DT_EXTERN DT_FIELD DT_INIT_GLOBAL (*Gbl_FieldList, NULL);
130 /* List of all compiled tables and subtables */
132 DT_EXTERN DT_SUBTABLE DT_INIT_GLOBAL (*Gbl_RootTable, NULL);
134 /* Stack for subtables */
136 DT_EXTERN DT_SUBTABLE DT_INIT_GLOBAL (*Gbl_SubtableStack, NULL);
138 /* List for defined labels */
140 DT_EXTERN DT_FIELD DT_INIT_GLOBAL (*Gbl_LabelList, NULL);
142 /* Current offset within the binary output table */
144 DT_EXTERN UINT32 DT_INIT_GLOBAL (Gbl_CurrentTableOffset, 0);
147 /* dtcompiler - main module */
152 ACPI_DMTABLE_INFO *Info,
153 DT_SUBTABLE **RetSubtable,
157 /* dtio - binary and text input/output */
169 DT_SUBTABLE *RootTable);
180 DtWriteFieldToListing (
186 DtWriteTableToListing (
190 /* dtsubtable - compile subtables */
196 DT_SUBTABLE **RetSubtable);
199 DtGetSubtableLength (
201 ACPI_DMTABLE_INFO *Info);
204 DtSetSubtableLength (
205 DT_SUBTABLE *Subtable);
209 DT_SUBTABLE *Subtable);
221 DT_SUBTABLE *ParentTable,
222 DT_SUBTABLE *Subtable);
226 DT_SUBTABLE *ParentTable,
227 DT_SUBTABLE *ChildTable);
230 DtGetParentSubtable (
231 DT_SUBTABLE *Subtable);
234 /* dtexpress - Integer expressions and labels */
237 DtResolveIntegerExpression (
239 UINT64 *ReturnValue);
253 DT_FIELD *FieldList);
256 /* dtfield - Compile individual fields within a table */
284 ACPI_DMTABLE_INFO *Info);
287 /* dtparser - lex/yacc files */
290 DtEvaluateExpression (
306 /* dtutils - Miscellaneous utilities */
309 void (*DT_WALK_CALLBACK) (
310 DT_SUBTABLE *Subtable,
316 DT_SUBTABLE *StartTable,
317 DT_WALK_CALLBACK UserFunction,
325 DT_FIELD *FieldObject,
332 DT_FIELD *FieldObject,
338 DT_FIELD *FieldObject,
344 UINT64 *ReturnInteger);
352 ACPI_DMTABLE_INFO *Info);
361 ACPI_DMTABLE_INFO *Info);
365 UINT8 *ChecksumPointer);
376 /* dttable - individual table compilation */
380 DT_FIELD **PFieldList);
384 DT_FIELD **PFieldList);
468 DT_FIELD **PFieldList);
503 DtGetGenericTableInfo (
506 /* ACPI Table templates */
508 extern const unsigned char TemplateAsf[];
509 extern const unsigned char TemplateBoot[];
510 extern const unsigned char TemplateBert[];
511 extern const unsigned char TemplateBgrt[];
512 extern const unsigned char TemplateCpep[];
513 extern const unsigned char TemplateCsrt[];
514 extern const unsigned char TemplateDbg2[];
515 extern const unsigned char TemplateDbgp[];
516 extern const unsigned char TemplateDmar[];
517 extern const unsigned char TemplateEcdt[];
518 extern const unsigned char TemplateEinj[];
519 extern const unsigned char TemplateErst[];
520 extern const unsigned char TemplateFadt[];
521 extern const unsigned char TemplateFpdt[];
522 extern const unsigned char TemplateGtdt[];
523 extern const unsigned char TemplateHest[];
524 extern const unsigned char TemplateHpet[];
525 extern const unsigned char TemplateIvrs[];
526 extern const unsigned char TemplateLpit[];
527 extern const unsigned char TemplateMadt[];
528 extern const unsigned char TemplateMcfg[];
529 extern const unsigned char TemplateMchi[];
530 extern const unsigned char TemplateMpst[];
531 extern const unsigned char TemplateMsct[];
532 extern const unsigned char TemplateMtmr[];
533 extern const unsigned char TemplatePcct[];
534 extern const unsigned char TemplatePmtt[];
535 extern const unsigned char TemplateRsdt[];
536 extern const unsigned char TemplateS3pt[];
537 extern const unsigned char TemplateSbst[];
538 extern const unsigned char TemplateSlic[];
539 extern const unsigned char TemplateSlit[];
540 extern const unsigned char TemplateSpcr[];
541 extern const unsigned char TemplateSpmi[];
542 extern const unsigned char TemplateSrat[];
543 extern const unsigned char TemplateTcpa[];
544 extern const unsigned char TemplateTpm2[];
545 extern const unsigned char TemplateUefi[];
546 extern const unsigned char TemplateVrtc[];
547 extern const unsigned char TemplateWaet[];
548 extern const unsigned char TemplateWdat[];
549 extern const unsigned char TemplateWddt[];
550 extern const unsigned char TemplateWdrt[];
551 extern const unsigned char TemplateXsdt[];