1 /******************************************************************************
2  *
3  * Module Name: dtcompiler.h - header for data table compiler
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2015, Intel Corp.
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
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.
25  *
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.
29  *
30  * NO WARRANTY
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.
42  */
43 
44 #define __DTCOMPILER_H__
45 
46 #ifndef _DTCOMPILER
47 #define _DTCOMPILER
48 
49 #include <stdio.h>
50 #include "acdisasm.h"
51 
52 
53 #define ASL_FIELD_CACHE_SIZE            512
54 #define ASL_SUBTABLE_CACHE_SIZE         128
55 
56 
57 #undef DT_EXTERN
58 
59 #ifdef _DECLARE_DT_GLOBALS
60 #define DT_EXTERN
61 #define DT_INIT_GLOBAL(a,b)         (a)=(b)
62 #else
63 #define DT_EXTERN                   extern
64 #define DT_INIT_GLOBAL(a,b)         (a)
65 #endif
66 
67 
68 /* Types for individual fields (one per input line) */
69 
70 #define DT_FIELD_TYPE_STRING            0
71 #define DT_FIELD_TYPE_INTEGER           1
72 #define DT_FIELD_TYPE_BUFFER            2
73 #define DT_FIELD_TYPE_PCI_PATH          3
74 #define DT_FIELD_TYPE_FLAG              4
75 #define DT_FIELD_TYPE_FLAGS_INTEGER     5
76 #define DT_FIELD_TYPE_INLINE_SUBTABLE   6
77 #define DT_FIELD_TYPE_UUID              7
78 #define DT_FIELD_TYPE_UNICODE           8
79 #define DT_FIELD_TYPE_DEVICE_PATH       9
80 #define DT_FIELD_TYPE_LABEL             10
81 
82 
83 /*
84  * Structure used for each individual field within an ACPI table
85  */
86 typedef struct dt_field
87 {
88     char                    *Name;       /* Field name (from name : value) */
89     char                    *Value;      /* Field value (from name : value) */
90     UINT32                  StringLength;/* Length of Value */
91     struct dt_field         *Next;       /* Next field */
92     struct dt_field         *NextLabel;  /* If field is a label, next label */
93     UINT32                  Line;        /* Line number for this field */
94     UINT32                  ByteOffset;  /* Offset in source file for field */
95     UINT32                  NameColumn;  /* Start column for field name */
96     UINT32                  Column;      /* Start column for field value */
97     UINT32                  TableOffset; /* Binary offset within ACPI table */
98     UINT8                   Flags;
99 
100 } DT_FIELD;
101 
102 /* Flags for above */
103 
104 #define DT_FIELD_NOT_ALLOCATED      1
105 
106 
107 /*
108  * Structure used for individual subtables within an ACPI table
109  */
110 typedef struct dt_subtable
111 {
112     struct dt_subtable      *Parent;
113     struct dt_subtable      *Child;
114     struct dt_subtable      *Peer;
115     struct dt_subtable      *StackTop;
116     UINT8                   *Buffer;
117     UINT8                   *LengthField;
118     char                    *Name;
119     UINT32                  Length;
120     UINT32                  TotalLength;
121     UINT32                  SizeOfLengthField;
122     UINT16                  Depth;
123     UINT8                   Flags;
124 
125 } DT_SUBTABLE;
126 
127 
128 /*
129  * Globals
130  */
131 
132 /* List of all field names and values from the input source */
133 
134 DT_EXTERN DT_FIELD          DT_INIT_GLOBAL (*Gbl_FieldList, NULL);
135 
136 /* List of all compiled tables and subtables */
137 
138 DT_EXTERN DT_SUBTABLE       DT_INIT_GLOBAL (*Gbl_RootTable, NULL);
139 
140 /* Stack for subtables */
141 
142 DT_EXTERN DT_SUBTABLE       DT_INIT_GLOBAL (*Gbl_SubtableStack, NULL);
143 
144 /* List for defined labels */
145 
146 DT_EXTERN DT_FIELD          DT_INIT_GLOBAL (*Gbl_LabelList, NULL);
147 
148 /* Current offset within the binary output table */
149 
150 DT_EXTERN UINT32            DT_INIT_GLOBAL (Gbl_CurrentTableOffset, 0);
151 
152 /* Local caches */
153 
154 DT_EXTERN UINT32            DT_INIT_GLOBAL (Gbl_SubtableCount, 0);
155 DT_EXTERN ASL_CACHE_INFO    DT_INIT_GLOBAL (*Gbl_SubtableCacheList, NULL);
156 DT_EXTERN DT_SUBTABLE       DT_INIT_GLOBAL (*Gbl_SubtableCacheNext, NULL);
157 DT_EXTERN DT_SUBTABLE       DT_INIT_GLOBAL (*Gbl_SubtableCacheLast, NULL);
158 
159 DT_EXTERN UINT32            DT_INIT_GLOBAL (Gbl_FieldCount, 0);
160 DT_EXTERN ASL_CACHE_INFO    DT_INIT_GLOBAL (*Gbl_FieldCacheList, NULL);
161 DT_EXTERN DT_FIELD          DT_INIT_GLOBAL (*Gbl_FieldCacheNext, NULL);
162 DT_EXTERN DT_FIELD          DT_INIT_GLOBAL (*Gbl_FieldCacheLast, NULL);
163 
164 
165 /* dtcompiler - main module */
166 
167 ACPI_STATUS
168 DtCompileTable (
169     DT_FIELD                **Field,
170     ACPI_DMTABLE_INFO       *Info,
171     DT_SUBTABLE             **RetSubtable,
172     BOOLEAN                 Required);
173 
174 ACPI_STATUS
175 DtCompilePadding (
176     UINT32                  Length,
177     DT_SUBTABLE             **RetSubtable);
178 
179 
180 /* dtio - binary and text input/output */
181 
182 UINT32
183 DtGetNextLine (
184     FILE                    *Handle);
185 
186 DT_FIELD *
187 DtScanFile (
188     FILE                    *Handle);
189 
190 void
191 DtOutputBinary (
192     DT_SUBTABLE             *RootTable);
193 
194 void
195 DtDumpSubtableList (
196     void);
197 
198 void
199 DtDumpFieldList (
200     DT_FIELD                *Field);
201 
202 void
203 DtWriteFieldToListing (
204     UINT8                   *Buffer,
205     DT_FIELD                *Field,
206     UINT32                  Length);
207 
208 void
209 DtWriteTableToListing (
210     void);
211 
212 
213 /* dtsubtable - compile subtables */
214 
215 void
216 DtCreateSubtable (
217     UINT8                   *Buffer,
218     UINT32                  Length,
219     DT_SUBTABLE             **RetSubtable);
220 
221 UINT32
222 DtGetSubtableLength (
223     DT_FIELD                *Field,
224     ACPI_DMTABLE_INFO       *Info);
225 
226 void
227 DtSetSubtableLength (
228     DT_SUBTABLE             *Subtable);
229 
230 void
231 DtPushSubtable (
232     DT_SUBTABLE             *Subtable);
233 
234 void
235 DtPopSubtable (
236     void);
237 
238 DT_SUBTABLE *
239 DtPeekSubtable (
240     void);
241 
242 void
243 DtInsertSubtable (
244     DT_SUBTABLE             *ParentTable,
245     DT_SUBTABLE             *Subtable);
246 
247 DT_SUBTABLE *
248 DtGetNextSubtable (
249     DT_SUBTABLE             *ParentTable,
250     DT_SUBTABLE             *ChildTable);
251 
252 DT_SUBTABLE *
253 DtGetParentSubtable (
254     DT_SUBTABLE             *Subtable);
255 
256 
257 /* dtexpress - Integer expressions and labels */
258 
259 ACPI_STATUS
260 DtResolveIntegerExpression (
261     DT_FIELD                *Field,
262     UINT64                  *ReturnValue);
263 
264 UINT64
265 DtDoOperator (
266     UINT64                  LeftValue,
267     UINT32                  Operator,
268     UINT64                  RightValue);
269 
270 UINT64
271 DtResolveLabel (
272     char                    *LabelString);
273 
274 void
275 DtDetectAllLabels (
276     DT_FIELD                *FieldList);
277 
278 
279 /* dtfield - Compile individual fields within a table */
280 
281 void
282 DtCompileOneField (
283     UINT8                   *Buffer,
284     DT_FIELD                *Field,
285     UINT32                  ByteLength,
286     UINT8                   Type,
287     UINT8                   Flags);
288 
289 void
290 DtCompileInteger (
291     UINT8                   *Buffer,
292     DT_FIELD                *Field,
293     UINT32                  ByteLength,
294     UINT8                   Flags);
295 
296 UINT32
297 DtCompileBuffer (
298     UINT8                   *Buffer,
299     char                    *Value,
300     DT_FIELD                *Field,
301     UINT32                  ByteLength);
302 
303 void
304 DtCompileFlag (
305     UINT8                   *Buffer,
306     DT_FIELD                *Field,
307     ACPI_DMTABLE_INFO       *Info);
308 
309 
310 /* dtparser - lex/yacc files */
311 
312 UINT64
313 DtEvaluateExpression (
314     char                    *ExprString);
315 
316 int
317 DtInitLexer (
318     char                    *String);
319 
320 void
321 DtTerminateLexer (
322     void);
323 
324 char *
325 DtGetOpName (
326     UINT32                  ParseOpcode);
327 
328 
329 /* dtutils - Miscellaneous utilities */
330 
331 typedef
332 void (*DT_WALK_CALLBACK) (
333     DT_SUBTABLE             *Subtable,
334     void                    *Context,
335     void                    *ReturnValue);
336 
337 void
338 DtWalkTableTree (
339     DT_SUBTABLE             *StartTable,
340     DT_WALK_CALLBACK        UserFunction,
341     void                    *Context,
342     void                    *ReturnValue);
343 
344 void
345 DtError (
346     UINT8                   Level,
347     UINT16                  MessageId,
348     DT_FIELD                *FieldObject,
349     char                    *ExtraMessage);
350 
351 void
352 DtNameError (
353     UINT8                   Level,
354     UINT16                  MessageId,
355     DT_FIELD                *FieldObject,
356     char                    *ExtraMessage);
357 
358 void
359 DtFatal (
360     UINT16                  MessageId,
361     DT_FIELD                *FieldObject,
362     char                    *ExtraMessage);
363 
364 ACPI_STATUS
365 DtStrtoul64 (
366     char                    *String,
367     UINT64                  *ReturnInteger);
368 
369 char*
370 DtGetFieldValue (
371     DT_FIELD                *Field);
372 
373 UINT8
374 DtGetFieldType (
375     ACPI_DMTABLE_INFO       *Info);
376 
377 UINT32
378 DtGetBufferLength (
379     char                    *Buffer);
380 
381 UINT32
382 DtGetFieldLength (
383     DT_FIELD                *Field,
384     ACPI_DMTABLE_INFO       *Info);
385 
386 void
387 DtSetTableChecksum (
388     UINT8                   *ChecksumPointer);
389 
390 void
391 DtSetTableLength(
392     void);
393 
394 DT_SUBTABLE *
395 UtSubtableCacheCalloc (
396     void);
397 
398 DT_FIELD *
399 UtFieldCacheCalloc (
400     void);
401 
402 void
403 DtDeleteCaches (
404     void);
405 
406 
407 /* dttable - individual table compilation */
408 
409 ACPI_STATUS
410 DtCompileFacs (
411     DT_FIELD                **PFieldList);
412 
413 ACPI_STATUS
414 DtCompileRsdp (
415     DT_FIELD                **PFieldList);
416 
417 ACPI_STATUS
418 DtCompileAsf (
419     void                    **PFieldList);
420 
421 ACPI_STATUS
422 DtCompileCpep (
423     void                    **PFieldList);
424 
425 ACPI_STATUS
426 DtCompileCsrt (
427     void                    **PFieldList);
428 
429 ACPI_STATUS
430 DtCompileDbg2 (
431     void                    **PFieldList);
432 
433 ACPI_STATUS
434 DtCompileDmar (
435     void                    **PFieldList);
436 
437 ACPI_STATUS
438 DtCompileDrtm (
439     void                    **PFieldList);
440 
441 ACPI_STATUS
442 DtCompileEinj (
443     void                    **PFieldList);
444 
445 ACPI_STATUS
446 DtCompileErst (
447     void                    **PFieldList);
448 
449 ACPI_STATUS
450 DtCompileFadt (
451     void                    **PFieldList);
452 
453 ACPI_STATUS
454 DtCompileFpdt (
455     void                    **PFieldList);
456 
457 ACPI_STATUS
458 DtCompileGtdt (
459     void                    **PFieldList);
460 
461 ACPI_STATUS
462 DtCompileHest (
463     void                    **PFieldList);
464 
465 ACPI_STATUS
466 DtCompileIort (
467     void                    **PFieldList);
468 
469 ACPI_STATUS
470 DtCompileIvrs (
471     void                    **PFieldList);
472 
473 ACPI_STATUS
474 DtCompileLpit (
475     void                    **PFieldList);
476 
477 ACPI_STATUS
478 DtCompileMadt (
479     void                    **PFieldList);
480 
481 ACPI_STATUS
482 DtCompileMcfg (
483     void                    **PFieldList);
484 
485 ACPI_STATUS
486 DtCompileMpst (
487     void                    **PFieldList);
488 
489 ACPI_STATUS
490 DtCompileMsct (
491     void                    **PFieldList);
492 
493 ACPI_STATUS
494 DtCompileMtmr (
495     void                    **PFieldList);
496 
497 ACPI_STATUS
498 DtCompileNfit (
499     void                    **PFieldList);
500 
501 ACPI_STATUS
502 DtCompilePmtt (
503     void                    **PFieldList);
504 
505 ACPI_STATUS
506 DtCompilePcct (
507     void                    **PFieldList);
508 
509 ACPI_STATUS
510 DtCompileRsdt (
511     void                    **PFieldList);
512 
513 ACPI_STATUS
514 DtCompileS3pt (
515     DT_FIELD                **PFieldList);
516 
517 ACPI_STATUS
518 DtCompileSlic (
519     void                    **PFieldList);
520 
521 ACPI_STATUS
522 DtCompileSlit (
523     void                    **PFieldList);
524 
525 ACPI_STATUS
526 DtCompileSrat (
527     void                    **PFieldList);
528 
529 ACPI_STATUS
530 DtCompileStao (
531     void                    **PFieldList);
532 
533 ACPI_STATUS
534 DtCompileUefi (
535     void                    **PFieldList);
536 
537 ACPI_STATUS
538 DtCompileVrtc (
539     void                    **PFieldList);
540 
541 ACPI_STATUS
542 DtCompileWdat (
543     void                    **PFieldList);
544 
545 ACPI_STATUS
546 DtCompileWpbt (
547     void                    **PFieldList);
548 
549 ACPI_STATUS
550 DtCompileXsdt (
551     void                    **PFieldList);
552 
553 ACPI_STATUS
554 DtCompileGeneric (
555     void                    **PFieldList,
556     char                    *TermFieldName,
557     UINT32                  *PFieldLength);
558 
559 ACPI_DMTABLE_INFO *
560 DtGetGenericTableInfo (
561     char                    *Name);
562 
563 /* ACPI Table templates */
564 
565 extern const unsigned char  TemplateAsf[];
566 extern const unsigned char  TemplateBoot[];
567 extern const unsigned char  TemplateBert[];
568 extern const unsigned char  TemplateBgrt[];
569 extern const unsigned char  TemplateCpep[];
570 extern const unsigned char  TemplateCsrt[];
571 extern const unsigned char  TemplateDbg2[];
572 extern const unsigned char  TemplateDbgp[];
573 extern const unsigned char  TemplateDmar[];
574 extern const unsigned char  TemplateDrtm[];
575 extern const unsigned char  TemplateEcdt[];
576 extern const unsigned char  TemplateEinj[];
577 extern const unsigned char  TemplateErst[];
578 extern const unsigned char  TemplateFadt[];
579 extern const unsigned char  TemplateFpdt[];
580 extern const unsigned char  TemplateGtdt[];
581 extern const unsigned char  TemplateHest[];
582 extern const unsigned char  TemplateHpet[];
583 extern const unsigned char  TemplateIort[];
584 extern const unsigned char  TemplateIvrs[];
585 extern const unsigned char  TemplateLpit[];
586 extern const unsigned char  TemplateMadt[];
587 extern const unsigned char  TemplateMcfg[];
588 extern const unsigned char  TemplateMchi[];
589 extern const unsigned char  TemplateMpst[];
590 extern const unsigned char  TemplateMsct[];
591 extern const unsigned char  TemplateMsdm[];
592 extern const unsigned char  TemplateMtmr[];
593 extern const unsigned char  TemplateNfit[];
594 extern const unsigned char  TemplatePcct[];
595 extern const unsigned char  TemplatePmtt[];
596 extern const unsigned char  TemplateRsdt[];
597 extern const unsigned char  TemplateS3pt[];
598 extern const unsigned char  TemplateSbst[];
599 extern const unsigned char  TemplateSlic[];
600 extern const unsigned char  TemplateSlit[];
601 extern const unsigned char  TemplateSpcr[];
602 extern const unsigned char  TemplateSpmi[];
603 extern const unsigned char  TemplateSrat[];
604 extern const unsigned char  TemplateStao[];
605 extern const unsigned char  TemplateTcpa[];
606 extern const unsigned char  TemplateTpm2[];
607 extern const unsigned char  TemplateUefi[];
608 extern const unsigned char  TemplateVrtc[];
609 extern const unsigned char  TemplateWaet[];
610 extern const unsigned char  TemplateWdat[];
611 extern const unsigned char  TemplateWddt[];
612 extern const unsigned char  TemplateWdrt[];
613 extern const unsigned char  TemplateWpbt[];
614 extern const unsigned char  TemplateXenv[];
615 extern const unsigned char  TemplateXsdt[];
616 
617 #endif
618