xref: /freebsd/sys/contrib/dev/acpica/compiler/dtcompile.c (revision 7697e6c4df7188ee3a2aa66f73c572c27479bdf2)
1 /******************************************************************************
2  *
3  * Module Name: dtcompile.c - Front-end for data table compiler
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2026, 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  * Alternatively, you may choose to be licensed under the terms of the
117  * following license:
118  *
119  * Redistribution and use in source and binary forms, with or without
120  * modification, are permitted provided that the following conditions
121  * are met:
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.
133  *
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.
145  *
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.
149  *
150  *****************************************************************************/
151 
152 #define _DECLARE_DT_GLOBALS
153 
154 #include <contrib/dev/acpica/compiler/aslcompiler.h>
155 
156 #define _COMPONENT          DT_COMPILER
157         ACPI_MODULE_NAME    ("dtcompile")
158 
159 static char                 VersionString[9];
160 
161 
162 /* Local prototypes */
163 
164 void
165 DtInitialize (
166     void);
167 
168 static ACPI_STATUS
169 DtCompileDataTable (
170     DT_FIELD                **Field);
171 
172 static void
173 DtInsertCompilerIds (
174     DT_FIELD                *FieldList);
175 
176 
177 /******************************************************************************
178  *
179  * FUNCTION:    DtDoCompile
180  *
181  * PARAMETERS:  None
182  *
183  * RETURN:      Status
184  *
185  * DESCRIPTION: Main entry point for the data table compiler.
186  *
187  * Note: Assumes AslGbl_Files[ASL_FILE_INPUT] is initialized and the file is
188  *          open at seek offset zero.
189  *
190  *****************************************************************************/
191 
192 ACPI_STATUS
DtDoCompile(void)193 DtDoCompile (
194     void)
195 {
196     ACPI_STATUS             Status;
197     UINT8                   Event;
198     DT_FIELD                *FieldList;
199     ASL_GLOBAL_FILE_NODE    *FileNode;
200 
201 
202     /* Initialize globals */
203 
204     DtInitialize ();
205 
206     /* Preprocessor */
207 
208     if (AslGbl_PreprocessFlag)
209     {
210         /* Preprocessor */
211 
212         Event = UtBeginEvent ("Preprocess input file");
213         PrDoPreprocess ();
214         UtEndEvent (Event);
215 
216         if (AslGbl_PreprocessOnly)
217         {
218             return (AE_OK);
219         }
220     }
221 
222     /* Compile the parse tree */
223 
224     if (AslGbl_DtLexBisonPrototype)
225     {
226         Event = UtBeginEvent ("Parse data table in prototype mode");
227 
228         DtCompilerInitLexer (AslGbl_Files[ASL_FILE_INPUT].Handle);
229         DtCompilerParserparse ();
230         FieldList = AslGbl_FieldList;
231         DtCompilerTerminateLexer ();
232 
233         UtEndEvent (Event);
234     }
235     else
236     {
237         /*
238          * Scan the input file (file is already open) and
239          * build the parse tree
240          */
241         Event = UtBeginEvent ("Scan and parse input file");
242         FieldList = DtScanFile (AslGbl_Files[ASL_FILE_INPUT].Handle);
243         UtEndEvent (Event);
244     }
245 
246     /* Did the parse tree get successfully constructed? */
247 
248     if (!FieldList)
249     {
250         /* TBD: temporary error message. Msgs should come from function above */
251 
252         DtError (ASL_ERROR, ASL_MSG_SYNTAX, NULL,
253             "Input file does not appear to be an ASL or data table source file");
254 
255         return (AE_ERROR);
256     }
257 
258     Event = UtBeginEvent ("Compile parse tree");
259 
260     Status = DtCompileDataTable (&FieldList);
261     UtEndEvent (Event);
262 
263     FileNode = FlGetCurrentFileNode ();
264 
265     FileNode->TotalLineCount = AslGbl_CurrentLineNumber;
266     FileNode->OriginalInputFileSize = AslGbl_InputByteCount;
267     DbgPrint (ASL_PARSE_OUTPUT, "Line count: %u input file size: %u\n",
268             FileNode->TotalLineCount, FileNode->OriginalInputFileSize);
269 
270     if (ACPI_FAILURE (Status))
271     {
272         FileNode->ParserErrorDetected = TRUE;
273 
274         /* TBD: temporary error message. Msgs should come from function above */
275 
276         DtError (ASL_ERROR, ASL_MSG_SYNTAX, NULL,
277             "Could not compile input file");
278 
279         return (Status);
280     }
281 
282     /* Create/open the binary output file */
283 
284     AslGbl_Files[ASL_FILE_AML_OUTPUT].Filename = NULL;
285     Status = FlOpenAmlOutputFile (AslGbl_OutputFilenamePrefix);
286     if (ACPI_FAILURE (Status))
287     {
288         return (Status);
289     }
290 
291     /* Write the binary, then the optional hex file */
292 
293     DtOutputBinary (AslGbl_RootTable);
294     HxDoHexOutput ();
295     DtWriteTableToListing ();
296 
297     /* Save the compile time statistics to the current file node */
298 
299     FileNode->TotalFields = AslGbl_InputFieldCount;
300     FileNode->OutputByteLength = AslGbl_TableLength;
301 
302     return (Status);
303 }
304 
305 
306 /******************************************************************************
307  *
308  * FUNCTION:    DtInitialize
309  *
310  * PARAMETERS:  None
311  *
312  * RETURN:      Status
313  *
314  * DESCRIPTION: Initialize data table compiler globals. Enables multiple
315  *              compiles per invocation.
316  *
317  *****************************************************************************/
318 
319 void
DtInitialize(void)320 DtInitialize (
321     void)
322 {
323 
324 
325     AcpiUtSetIntegerWidth (2); /* Set width to 64 bits */
326 
327     AslGbl_FieldList = NULL;
328     AslGbl_RootTable = NULL;
329     AslGbl_SubtableStack = NULL;
330 
331     sprintf (VersionString, "%X", (UINT32) ACPI_CA_VERSION);
332     return;
333 }
334 
335 
336 /******************************************************************************
337  *
338  * FUNCTION:    DtInsertCompilerIds
339  *
340  * PARAMETERS:  FieldList           - Current field list pointer
341  *
342  * RETURN:      None
343  *
344  * DESCRIPTION: Insert the IDs (Name, Version) of the current compiler into
345  *              the original ACPI table header.
346  *
347  *****************************************************************************/
348 
349 static void
DtInsertCompilerIds(DT_FIELD * FieldList)350 DtInsertCompilerIds (
351     DT_FIELD                *FieldList)
352 {
353     DT_FIELD                *Next;
354     UINT32                  i;
355 
356 
357     /*
358      * Don't insert current compiler ID if requested. Used for compiler
359      * debug/validation only.
360      */
361     if (AslGbl_UseOriginalCompilerId)
362     {
363         return;
364     }
365 
366     /* Walk to the Compiler fields at the end of the header, with safety checks */
367 
368     if (!FieldList)
369     {
370         DtError (ASL_WARNING, ASL_MSG_MALFORMED_HEADER, NULL, NULL);
371         return;
372     }
373 
374     Next = FieldList;
375     for (i = 0; i < 7; i++)
376     {
377         if (!Next || !Next->Next)
378         {
379             /* Malformed/short header: cannot insert compiler IDs */
380             DtError (ASL_WARNING, ASL_MSG_MALFORMED_HEADER, FieldList, NULL);
381             return;
382         }
383         Next = Next->Next;
384     }
385 
386     /* Ensure both Creator ID and Revision fields exist */
387     if (!Next || !Next->Next)
388     {
389         DtError (ASL_WARNING, ASL_MSG_MALFORMED_HEADER, FieldList, NULL);
390         return;
391     }
392 
393     Next->Value = ASL_CREATOR_ID;
394     Next->Flags = DT_FIELD_NOT_ALLOCATED;
395 
396     Next = Next->Next;
397     if (!Next)
398     {
399         DtError (ASL_WARNING, ASL_MSG_MALFORMED_HEADER, FieldList, NULL);
400         return;
401     }
402     Next->Value = VersionString;
403     Next->Flags = DT_FIELD_NOT_ALLOCATED;
404 }
405 
406 
407 /******************************************************************************
408  *
409  * FUNCTION:    DtCompileDataTable
410  *
411  * PARAMETERS:  FieldList           - Current field list pointer
412  *
413  * RETURN:      Status
414  *
415  * DESCRIPTION: Entry point to compile one data table
416  *
417  *****************************************************************************/
418 
419 static ACPI_STATUS
DtCompileDataTable(DT_FIELD ** FieldList)420 DtCompileDataTable (
421     DT_FIELD                **FieldList)
422 {
423     const ACPI_DMTABLE_DATA *TableData;
424     DT_SUBTABLE             *Subtable;
425     char                    *Signature;
426     ACPI_TABLE_HEADER       *AcpiTableHeader;
427     ACPI_STATUS             Status;
428     DT_FIELD                *RootField = *FieldList;
429 
430 
431     /* Verify that we at least have a table signature and save it */
432 
433     Signature = DtGetFieldValue (*FieldList);
434     if (!Signature)
435     {
436         sprintf (AslGbl_MsgBuffer, "Expected \"%s\"", "Signature");
437         DtNameError (ASL_ERROR, ASL_MSG_INVALID_FIELD_NAME,
438             *FieldList, AslGbl_MsgBuffer);
439         return (AE_ERROR);
440     }
441 
442     AslGbl_Signature = UtLocalCacheCalloc (strlen (Signature) + 1);
443     strcpy (AslGbl_Signature, Signature);
444 
445     /*
446      * Handle tables that don't use the common ACPI table header structure.
447      * Currently, these are the FACS and RSDP. Also check for an OEMx table,
448      * these tables have user-defined contents.
449      */
450     if (ACPI_COMPARE_NAMESEG (Signature, ACPI_SIG_FACS))
451     {
452         Status = DtCompileFacs (FieldList);
453         if (ACPI_FAILURE (Status))
454         {
455             return (Status);
456         }
457 
458         DtSetTableLength ();
459         return (Status);
460     }
461     else if (ACPI_VALIDATE_RSDP_SIG (Signature))
462     {
463         Status = DtCompileRsdp (FieldList);
464         return (Status);
465     }
466     else if (ACPI_COMPARE_NAMESEG (Signature, ACPI_SIG_S3PT))
467     {
468         Status = DtCompileS3pt (FieldList);
469         if (ACPI_FAILURE (Status))
470         {
471             return (Status);
472         }
473 
474         DtSetTableLength ();
475         return (Status);
476     }
477 
478     /*
479      * If the first field is named "CDAT Table Length" (not "Signature"),
480      * assume that we have a CDAT table (whose table header does not have
481      * a signature). Instead, the TableLength field is where the
482      * signature would (normally) be.
483      */
484     else if (!strcmp ((*FieldList)->Name, "CDAT Table Length"))
485     {
486         /* No longer true: (However, use this technique in the disassembler)
487          * We are assuming that there
488          * should be at least one non-ASCII byte in the 4-character
489          * Signature field, (At least the high-order byte should be zero).
490          */
491         Status = DtCompileTable (FieldList, AcpiDmTableInfoCdatTableHdr,
492             &AslGbl_RootTable);
493         if (ACPI_FAILURE (Status))
494         {
495             return (Status);
496         }
497 
498         /* Compile the CDAT */
499 
500         DtPushSubtable (AslGbl_RootTable);
501         Status = DtCompileCdat ((void **) FieldList);
502         if (ACPI_FAILURE (Status))
503         {
504             return (Status);
505         }
506 
507         /*
508          * Set the overall table length and the table checksum.
509          * The entire compiled table (including the CDAT table header with
510          * the table length and checksum) is in AslGbl_RootTable->Buffer.
511          */
512         DtSetTableLength ();
513         DtSetTableChecksum (&ACPI_CAST_PTR (ACPI_TABLE_CDAT, AslGbl_RootTable->Buffer)->Checksum);
514 
515         DtDumpFieldList (RootField);
516         DtDumpSubtableList ();
517         return (AE_OK);
518     }
519 
520     /*
521      * All other tables must use the common ACPI table header. Insert the
522      * current iASL IDs (name, version), and compile the header now.
523      */
524     DtInsertCompilerIds (*FieldList);
525 
526     Status = DtCompileTable (FieldList, AcpiDmTableInfoHeader,
527         &AslGbl_RootTable);
528     if (ACPI_FAILURE (Status))
529     {
530         return (Status);
531     }
532 
533     DtPushSubtable (AslGbl_RootTable);
534 
535     /* Validate the signature via the ACPI table list */
536 
537     TableData = AcpiDmGetTableData (Signature);
538     if (!TableData || AslGbl_CompileGeneric)
539     {
540         /* Unknown table signature and/or force generic compile */
541 
542         DtCompileGeneric ((void **) FieldList, NULL, NULL);
543         goto FinishHeader;
544     }
545 
546     /* Dispatch to per-table compile */
547 
548     if (TableData->CmTableHandler)
549     {
550         /* Complex table, has a handler */
551 
552         Status = TableData->CmTableHandler ((void **) FieldList);
553         if (ACPI_FAILURE (Status))
554         {
555             return (Status);
556         }
557     }
558     else if (TableData->TableInfo)
559     {
560         /* Simple table, just walk the info table, unless its empty */
561 
562         if (FieldList && *FieldList)
563         {
564             Subtable = NULL;
565             Status = DtCompileTable (FieldList, TableData->TableInfo,
566                 &Subtable);
567             if (ACPI_FAILURE (Status))
568             {
569                 return (Status);
570             }
571 
572             DtInsertSubtable (AslGbl_RootTable, Subtable);
573             DtPopSubtable ();
574         }
575     }
576     else
577     {
578         DtFatal (ASL_MSG_COMPILER_INTERNAL, *FieldList,
579             "Missing table dispatch info");
580         return (AE_ERROR);
581     }
582 
583 FinishHeader:
584 
585     /* Set the final table length and then the checksum */
586 
587     DtSetTableLength ();
588     AcpiTableHeader = ACPI_CAST_PTR (
589         ACPI_TABLE_HEADER, AslGbl_RootTable->Buffer);
590     DtSetTableChecksum (&AcpiTableHeader->Checksum);
591 
592     DtDumpFieldList (RootField);
593     DtDumpSubtableList ();
594     return (AE_OK);
595 }
596 
597 
598 /******************************************************************************
599  *
600  * FUNCTION:    DtCompileTable
601  *
602  * PARAMETERS:  Field               - Current field list pointer
603  *              Info                - Info table for this ACPI table
604  *              RetSubtable         - Compile result of table
605  *
606  * RETURN:      Status
607  *
608  * DESCRIPTION: Compile a subtable
609  *
610  *****************************************************************************/
611 
612 ACPI_STATUS
DtCompileTable(DT_FIELD ** Field,ACPI_DMTABLE_INFO * Info,DT_SUBTABLE ** RetSubtable)613 DtCompileTable (
614     DT_FIELD                **Field,
615     ACPI_DMTABLE_INFO       *Info,
616     DT_SUBTABLE             **RetSubtable)
617 {
618     DT_FIELD                *LocalField;
619     UINT32                  Length;
620     DT_SUBTABLE             *Subtable;
621     DT_SUBTABLE             *InlineSubtable = NULL;
622     UINT32                  FieldLength = 0;
623     UINT8                   FieldType;
624     UINT8                   *Buffer;
625     UINT8                   *FlagBuffer = NULL;
626     char                    *String;
627     UINT32                  CurrentFlagByteOffset = 0;
628     ACPI_STATUS             Status = AE_OK;
629 
630 
631     if (!Field || !Info)
632     {
633         return (AE_BAD_PARAMETER);
634     }
635     if (!*Field)
636     {
637         /*
638          * The field list is empty, this means that we are out of fields to
639          * parse. In other words, we are at the end of the table.
640          */
641         return (AE_END_OF_TABLE);
642     }
643 
644     /* Ignore optional subtable if name does not match */
645 
646     if ((Info->Flags & DT_OPTIONAL) &&
647         strcmp ((*Field)->Name, Info->Name))
648     {
649         *RetSubtable = NULL;
650         return (AE_OK);
651     }
652 
653     Length = DtGetSubtableLength (*Field, Info);
654     if (Length == ASL_EOF)
655     {
656         return (AE_ERROR);
657     }
658 
659     Subtable = UtSubtableCacheCalloc ();
660 
661     if (Length > 0)
662     {
663         String = UtLocalCacheCalloc (Length);
664         Subtable->Buffer = ACPI_CAST_PTR (UINT8, String);
665     }
666 
667     Subtable->Length = Length;
668     Subtable->TotalLength = Length;
669     Buffer = Subtable->Buffer;
670 
671     LocalField = *Field;
672     Subtable->Name = LocalField->Name;
673 
674     /*
675      * Main loop walks the info table for this ACPI table or subtable
676      */
677     for (; Info->Name; Info++)
678     {
679         if (Info->Opcode == ACPI_DMT_EXTRA_TEXT)
680         {
681             continue;
682         }
683 
684         if (!LocalField)
685         {
686             sprintf (AslGbl_MsgBuffer, "Found NULL field - Field name \"%s\" needed",
687                 Info->Name);
688             DtFatal (ASL_MSG_COMPILER_INTERNAL, NULL, AslGbl_MsgBuffer);
689             Status = AE_BAD_DATA;
690             goto Error;
691         }
692 
693         /* Maintain table offsets */
694 
695         LocalField->TableOffset = AslGbl_CurrentTableOffset;
696         FieldLength = DtGetFieldLength (LocalField, Info);
697         AslGbl_CurrentTableOffset += FieldLength;
698 
699         FieldType = DtGetFieldType (Info);
700         AslGbl_InputFieldCount++;
701 
702         if (FieldType != DT_FIELD_TYPE_INLINE_SUBTABLE &&
703             strcmp (Info->Name, LocalField->Name))
704         {
705             sprintf (AslGbl_MsgBuffer, "found \"%s\" expected \"%s\"",
706                 LocalField->Name, Info->Name);
707             DtError (ASL_ERROR, ASL_MSG_INVALID_LABEL, LocalField, AslGbl_MsgBuffer);
708         }
709 
710         switch (FieldType)
711         {
712         case DT_FIELD_TYPE_FLAGS_INTEGER:
713             /*
714              * Start of the definition of a flags field.
715              * This master flags integer starts at value zero, in preparation
716              * to compile and insert the flag fields from the individual bits
717              */
718             LocalField = LocalField->Next;
719             *Field = LocalField;
720 
721             FlagBuffer = Buffer;
722             CurrentFlagByteOffset = Info->Offset;
723             break;
724 
725         case DT_FIELD_TYPE_FLAG:
726 
727             /* Individual Flag field, can be multiple bits */
728 
729             if (FlagBuffer)
730             {
731                 /*
732                  * We must increment the FlagBuffer when we have crossed
733                  * into the next flags byte within the flags field
734                  * of type DT_FIELD_TYPE_FLAGS_INTEGER.
735                  */
736                 FlagBuffer += (Info->Offset - CurrentFlagByteOffset);
737                 CurrentFlagByteOffset = Info->Offset;
738 
739                 DtCompileFlag (FlagBuffer, LocalField, Info);
740             }
741             else
742             {
743                 /* TBD - this is an internal error */
744             }
745 
746             LocalField = LocalField->Next;
747             *Field = LocalField;
748             break;
749 
750         case DT_FIELD_TYPE_INLINE_SUBTABLE:
751             /*
752              * Recursion (one level max): compile GAS (Generic Address)
753              * or Notify in-line subtable
754              */
755             *Field = LocalField;
756 
757             switch (Info->Opcode)
758             {
759             case ACPI_DMT_GAS:
760 
761                 Status = DtCompileTable (Field, AcpiDmTableInfoGas,
762                     &InlineSubtable);
763                 break;
764 
765             case ACPI_DMT_HESTNTFY:
766 
767                 Status = DtCompileTable (Field, AcpiDmTableInfoHestNotify,
768                     &InlineSubtable);
769                 break;
770 
771             case ACPI_DMT_IORTMEM:
772 
773                 Status = DtCompileTable (Field, AcpiDmTableInfoIortAcc,
774                     &InlineSubtable);
775                 break;
776 
777             default:
778                 sprintf (AslGbl_MsgBuffer, "Invalid DMT opcode: 0x%.2X",
779                     Info->Opcode);
780                 DtFatal (ASL_MSG_COMPILER_INTERNAL, NULL, AslGbl_MsgBuffer);
781                 Status = AE_BAD_DATA;
782                 break;
783             }
784 
785             if (ACPI_FAILURE (Status))
786             {
787                 goto Error;
788             }
789 
790             DtSetSubtableLength (InlineSubtable);
791 
792             memcpy (Buffer, InlineSubtable->Buffer, FieldLength);
793             LocalField = *Field;
794             break;
795 
796         case DT_FIELD_TYPE_LABEL:
797 
798             DtWriteFieldToListing (Buffer, LocalField, 0);
799             LocalField = LocalField->Next;
800             break;
801 
802         default:
803 
804             /* Normal case for most field types (Integer, String, etc.) */
805 
806             DtCompileOneField (Buffer, LocalField,
807                 FieldLength, FieldType, Info->Flags);
808 
809             DtWriteFieldToListing (Buffer, LocalField, FieldLength);
810             LocalField = LocalField->Next;
811 
812             if (Info->Flags & DT_LENGTH)
813             {
814                 /* Field is an Integer that will contain a subtable length */
815 
816                 Subtable->LengthField = Buffer;
817                 Subtable->SizeOfLengthField = FieldLength;
818             }
819             break;
820         }
821 
822         Buffer += FieldLength;
823     }
824 
825     *Field = LocalField;
826     *RetSubtable = Subtable;
827     return (AE_OK);
828 
829 Error:
830     ACPI_FREE (Subtable->Buffer);
831     ACPI_FREE (Subtable);
832     return (Status);
833 }
834 
835 
836 /******************************************************************************
837  *
838  * FUNCTION:    DtCompileTwoSubtables
839  *
840  * PARAMETERS:  List                - Current field list pointer
841  *              TableInfo1          - Info table 1
842  *              TableInfo1          - Info table 2
843  *
844  * RETURN:      Status
845  *
846  * DESCRIPTION: Compile tables with a header and one or more same subtables.
847  *              Include CPEP, EINJ, ERST, MCFG, MSCT, WDAT
848  *
849  *****************************************************************************/
850 
851 ACPI_STATUS
DtCompileTwoSubtables(void ** List,ACPI_DMTABLE_INFO * TableInfo1,ACPI_DMTABLE_INFO * TableInfo2)852 DtCompileTwoSubtables (
853     void                    **List,
854     ACPI_DMTABLE_INFO       *TableInfo1,
855     ACPI_DMTABLE_INFO       *TableInfo2)
856 {
857     ACPI_STATUS             Status;
858     DT_SUBTABLE             *Subtable;
859     DT_SUBTABLE             *ParentTable;
860     DT_FIELD                **PFieldList = (DT_FIELD **) List;
861 
862 
863     Status = DtCompileTable (PFieldList, TableInfo1, &Subtable);
864     if (ACPI_FAILURE (Status))
865     {
866         return (Status);
867     }
868 
869     ParentTable = DtPeekSubtable ();
870     DtInsertSubtable (ParentTable, Subtable);
871 
872     while (*PFieldList)
873     {
874         Status = DtCompileTable (PFieldList, TableInfo2, &Subtable);
875         if (ACPI_FAILURE (Status))
876         {
877             return (Status);
878         }
879 
880         DtInsertSubtable (ParentTable, Subtable);
881     }
882 
883     return (AE_OK);
884 }
885 
886 
887 /******************************************************************************
888  *
889  * FUNCTION:    DtCompilePadding
890  *
891  * PARAMETERS:  Length              - Padding field size
892  *              RetSubtable         - Compile result of table
893  *
894  * RETURN:      Status
895  *
896  * DESCRIPTION: Compile a subtable for padding purpose
897  *
898  *****************************************************************************/
899 
900 ACPI_STATUS
DtCompilePadding(UINT32 Length,DT_SUBTABLE ** RetSubtable)901 DtCompilePadding (
902     UINT32                  Length,
903     DT_SUBTABLE             **RetSubtable)
904 {
905     DT_SUBTABLE             *Subtable;
906     /* UINT8                   *Buffer; */
907     char                    *String;
908 
909 
910     Subtable = UtSubtableCacheCalloc ();
911 
912     if (Length > 0)
913     {
914         String = UtLocalCacheCalloc (Length);
915         Subtable->Buffer = ACPI_CAST_PTR (UINT8, String);
916     }
917 
918     Subtable->Length = Length;
919     Subtable->TotalLength = Length;
920     /* Buffer = Subtable->Buffer; */
921 
922     *RetSubtable = Subtable;
923     return (AE_OK);
924 }
925