dtcompiler.h revision 209734 
1/******************************************************************************
2 *
3 * Module Name: dtcompiler.h - header for data table compiler
4 *
5 *****************************************************************************/
6
7/******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp.
12 * All rights reserved.
13 *
14 * 2. License
15 *
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
19 * property rights.
20 *
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
27 *
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;
36 *
37 * The above copyright and patent license is granted only if the following
38 * conditions are met:
39 *
40 * 3. Conditions
41 *
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.
53 *
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
64 * make.
65 *
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
70 * distribution.
71 *
72 * 3.4. Intel retains all right, title, and interest in and to the Original
73 * Intel Code.
74 *
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.
79 *
80 * 4. Disclaimer and Export Compliance
81 *
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
88 * PARTICULAR PURPOSE.
89 *
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
97 * LIMITED REMEDY.
98 *
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.
113 *
114 *****************************************************************************/
115
116#define __DTCOMPILER_H__
117
118#ifndef _DTCOMPILER
119#define _DTCOMPILER
120
121#include <stdio.h>
122#include "acdisasm.h"
123
124
125#undef DT_EXTERN
126
127#ifdef _DECLARE_DT_GLOBALS
128#define DT_EXTERN
129#define DT_INIT_GLOBAL(a,b)         (a)=(b)
130#else
131#define DT_EXTERN                   extern
132#define DT_INIT_GLOBAL(a,b)         (a)
133#endif
134
135
136/* Types for individual fields (one per input line) */
137
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
146
147/*
148 * Structure used for each individual field within an ACPI table
149 */
150typedef struct dt_field
151{
152    char                    *Name;
153    char                    *Value;
154    struct dt_field         *Next;
155    UINT32                  Line;       /* Line number for this field */
156    UINT32                  ByteOffset; /* Offset in source file for field */
157    UINT32                  NameColumn; /* Start column for field name */
158    UINT32                  Column;     /* Start column for field value */
159    UINT8                   Flags;
160
161} DT_FIELD;
162
163/* Flags for above */
164
165#define DT_FIELD_NOT_ALLOCATED      1
166
167
168/*
169 * Structure used for individual subtables within an ACPI table
170 */
171typedef struct dt_subtable
172{
173    struct dt_subtable      *Parent;
174    struct dt_subtable      *Child;
175    struct dt_subtable      *Peer;
176    struct dt_subtable      *StackTop;
177    UINT8                   *Buffer;
178    UINT8                   *LengthField;
179    UINT32                  Length;
180    UINT32                  TotalLength;
181    UINT32                  SizeOfLengthField;
182    UINT8                   Flags;
183
184} DT_SUBTABLE;
185
186
187/*
188 * Globals
189 */
190
191/* List of all field names and values from the input source */
192
193DT_EXTERN DT_FIELD          DT_INIT_GLOBAL (*Gbl_FieldList, NULL);
194
195/* List of all compiled tables and subtables */
196
197DT_EXTERN DT_SUBTABLE       DT_INIT_GLOBAL (*Gbl_RootTable, NULL);
198
199/* Stack for subtables */
200
201DT_EXTERN DT_SUBTABLE       DT_INIT_GLOBAL (*Gbl_SubtableStack, NULL);
202
203
204/* dtcompiler - main module */
205
206ACPI_STATUS
207DtCompileTable (
208    DT_FIELD                **Field,
209    ACPI_DMTABLE_INFO       *Info,
210    DT_SUBTABLE             **RetSubtable,
211    BOOLEAN                 Required);
212
213
214/* dtio - binary and text input/output */
215
216DT_FIELD *
217DtScanFile (
218    FILE                    *Handle);
219
220void
221DtOutputBinary (
222    DT_SUBTABLE             *RootTable);
223
224
225/* dtsubtable - compile subtables */
226
227void
228DtCreateSubtable (
229    UINT8                   *Buffer,
230    UINT32                  Length,
231    DT_SUBTABLE             **RetSubtable);
232
233UINT32
234DtGetSubtableLength (
235    DT_FIELD                *Field,
236    ACPI_DMTABLE_INFO       *Info);
237
238void
239DtSetSubtableLength (
240    DT_SUBTABLE             *Subtable);
241
242void
243DtPushSubtable (
244    DT_SUBTABLE             *Subtable);
245
246void
247DtPopSubtable (
248    void);
249
250DT_SUBTABLE *
251DtPeekSubtable (
252    void);
253
254void
255DtInsertSubtable (
256    DT_SUBTABLE             *ParentTable,
257    DT_SUBTABLE             *Subtable);
258
259DT_SUBTABLE *
260DtGetNextSubtable (
261    DT_SUBTABLE             *ParentTable,
262    DT_SUBTABLE             *ChildTable);
263
264DT_SUBTABLE *
265DtGetParentSubtable (
266    DT_SUBTABLE             *Subtable);
267
268
269/* dtfield - Compile individual fields within a table */
270
271void
272DtCompileOneField (
273    UINT8                   *Buffer,
274    DT_FIELD                *Field,
275    UINT32                  ByteLength,
276    UINT8                   Type,
277    UINT8                   Flags);
278
279void
280DtCompileInteger (
281    UINT8                   *Buffer,
282    DT_FIELD                *Field,
283    UINT32                  ByteLength,
284    UINT8                   Flags);
285
286UINT32
287DtCompileBuffer (
288    UINT8                   *Buffer,
289    char                    *Value,
290    DT_FIELD                *Field,
291    UINT32                  ByteLength);
292
293void
294DtCompileFlag (
295    UINT8                   *Buffer,
296    DT_FIELD                *Field,
297    ACPI_DMTABLE_INFO       *Info);
298
299
300/* dtutils - Miscellaneous utilities */
301
302typedef
303void (*DT_WALK_CALLBACK) (
304    DT_SUBTABLE             *Subtable,
305    void                    *Context,
306    void                    *ReturnValue);
307
308void
309DtWalkTableTree (
310    DT_SUBTABLE             *StartTable,
311    DT_WALK_CALLBACK        UserFunction,
312    void                    *Context,
313    void                    *ReturnValue);
314
315void
316DtError (
317    UINT8                   Level,
318    UINT8                   MessageId,
319    DT_FIELD                *FieldObject,
320    char                    *ExtraMessage);
321
322void
323DtNameError (
324    UINT8                   Level,
325    UINT8                   MessageId,
326    DT_FIELD                *FieldObject,
327    char                    *ExtraMessage);
328
329void
330DtFatal (
331    UINT8                   MessageId,
332    DT_FIELD                *FieldObject,
333    char                    *ExtraMessage);
334
335ACPI_STATUS
336DtStrtoul64 (
337    char                    *String,
338    UINT64                  *ReturnInteger);
339
340UINT32
341DtGetFileSize (
342    FILE                    *Handle);
343
344char*
345DtGetFieldValue (
346    DT_FIELD                *Field,
347    char                    *Name);
348
349UINT8
350DtGetFieldType (
351    ACPI_DMTABLE_INFO       *Info);
352
353UINT32
354DtGetBufferLength (
355    char                    *Buffer);
356
357UINT32
358DtGetFieldLength (
359    DT_FIELD                *Field,
360    ACPI_DMTABLE_INFO       *Info);
361
362void
363DtSetTableChecksum (
364    UINT8                   *ChecksumPointer);
365
366void
367DtSetTableLength(
368    void);
369
370void
371DtFreeFieldList (
372    void);
373
374
375/* dttable - individual table compilation */
376
377ACPI_STATUS
378DtCompileFacs (
379    DT_FIELD                **PFieldList);
380
381ACPI_STATUS
382DtCompileRsdp (
383    DT_FIELD                **PFieldList);
384
385ACPI_STATUS
386DtCompileAsf (
387    void                    **PFieldList);
388
389ACPI_STATUS
390DtCompileCpep (
391    void                    **PFieldList);
392
393ACPI_STATUS
394DtCompileDmar (
395    void                    **PFieldList);
396
397ACPI_STATUS
398DtCompileEinj (
399    void                    **PFieldList);
400
401ACPI_STATUS
402DtCompileErst (
403    void                    **PFieldList);
404
405ACPI_STATUS
406DtCompileFadt (
407    void                    **PFieldList);
408
409ACPI_STATUS
410DtCompileHest (
411    void                    **PFieldList);
412
413ACPI_STATUS
414DtCompileIvrs (
415    void                    **PFieldList);
416
417ACPI_STATUS
418DtCompileMadt (
419    void                    **PFieldList);
420
421ACPI_STATUS
422DtCompileMcfg (
423    void                    **PFieldList);
424
425ACPI_STATUS
426DtCompileMsct (
427    void                    **PFieldList);
428
429ACPI_STATUS
430DtCompileRsdt (
431    void                    **PFieldList);
432
433ACPI_STATUS
434DtCompileSlit (
435    void                    **PFieldList);
436
437ACPI_STATUS
438DtCompileSrat (
439    void                    **PFieldList);
440
441ACPI_STATUS
442DtCompileWdat (
443    void                    **PFieldList);
444
445ACPI_STATUS
446DtCompileXsdt (
447    void                    **PFieldList);
448
449/* ACPI Table templates */
450
451extern const unsigned char  TemplateAsf[];
452extern const unsigned char  TemplateBoot[];
453extern const unsigned char  TemplateBert[];
454extern const unsigned char  TemplateCpep[];
455extern const unsigned char  TemplateDbgp[];
456extern const unsigned char  TemplateDmar[];
457extern const unsigned char  TemplateEcdt[];
458extern const unsigned char  TemplateEinj[];
459extern const unsigned char  TemplateErst[];
460extern const unsigned char  TemplateFadt[];
461extern const unsigned char  TemplateHest[];
462extern const unsigned char  TemplateHpet[];
463extern const unsigned char  TemplateIvrs[];
464extern const unsigned char  TemplateMadt[];
465extern const unsigned char  TemplateMcfg[];
466extern const unsigned char  TemplateMchi[];
467extern const unsigned char  TemplateMsct[];
468extern const unsigned char  TemplateRsdt[];
469extern const unsigned char  TemplateSbst[];
470extern const unsigned char  TemplateSlic[];
471extern const unsigned char  TemplateSlit[];
472extern const unsigned char  TemplateSpcr[];
473extern const unsigned char  TemplateSpmi[];
474extern const unsigned char  TemplateSrat[];
475extern const unsigned char  TemplateTcpa[];
476extern const unsigned char  TemplateUefi[];
477extern const unsigned char  TemplateWaet[];
478extern const unsigned char  TemplateWdat[];
479extern const unsigned char  TemplateWddt[];
480extern const unsigned char  TemplateWdrt[];
481extern const unsigned char  TemplateXsdt[];
482
483/* Debug */
484
485#define MYDEBUG         printf
486
487#endif
488