1 /******************************************************************************
3 * Module Name: dtcompile.c - Front-end 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 __DTCOMPILE_C__
45 #define _DECLARE_DT_GLOBALS
47 #include "aslcompiler.h"
48 #include "dtcompiler.h"
50 #define _COMPONENT DT_COMPILER
51 ACPI_MODULE_NAME ("dtcompile")
53 static char VersionString[9];
56 /* Local prototypes */
71 /******************************************************************************
73 * FUNCTION: DtDoCompile
79 * DESCRIPTION: Main entry point for the data table compiler.
81 * Note: Assumes Gbl_Files[ASL_FILE_INPUT] is initialized and the file is
82 * open at seek offset zero.
84 *****************************************************************************/
95 /* Initialize globals */
97 Status = DtInitialize ();
98 if (ACPI_FAILURE (Status))
100 printf ("Error during compiler initialization, 0x%X\n", Status);
106 Event = UtBeginEvent ("Preprocess input file");
110 if (Gbl_PreprocessOnly)
116 * Scan the input file (file is already open) and
117 * build the parse tree
119 Event = UtBeginEvent ("Scan and parse input file");
120 FieldList = DtScanFile (Gbl_Files[ASL_FILE_INPUT].Handle);
123 /* Did the parse tree get successfully constructed? */
127 /* TBD: temporary error message. Msgs should come from function above */
129 DtError (ASL_ERROR, ASL_MSG_SYNTAX, NULL,
130 "Input file does not appear to be an ASL or data table source file");
136 Event = UtBeginEvent ("Compile parse tree");
139 * Compile the parse tree
141 Status = DtCompileDataTable (&FieldList);
144 if (ACPI_FAILURE (Status))
146 /* TBD: temporary error message. Msgs should come from function above */
148 DtError (ASL_ERROR, ASL_MSG_SYNTAX, NULL,
149 "Could not compile input file");
154 /* Create/open the binary output file */
156 Gbl_Files[ASL_FILE_AML_OUTPUT].Filename = NULL;
157 Status = FlOpenAmlOutputFile (Gbl_OutputFilenamePrefix);
158 if (ACPI_FAILURE (Status))
163 /* Write the binary, then the optional hex file */
165 DtOutputBinary (Gbl_RootTable);
167 DtWriteTableToListing ();
171 AcpiUtDeleteCaches ();
178 /******************************************************************************
180 * FUNCTION: DtInitialize
186 * DESCRIPTION: Initialize data table compiler globals. Enables multiple
187 * compiles per invocation.
189 *****************************************************************************/
198 Status = AcpiOsInitialize ();
199 if (ACPI_FAILURE (Status))
204 Status = AcpiUtInitGlobals ();
205 if (ACPI_FAILURE (Status))
210 Gbl_FieldList = NULL;
211 Gbl_RootTable = NULL;
212 Gbl_SubtableStack = NULL;
214 sprintf (VersionString, "%X", (UINT32) ACPI_CA_VERSION);
219 /******************************************************************************
221 * FUNCTION: DtInsertCompilerIds
223 * PARAMETERS: FieldList - Current field list pointer
227 * DESCRIPTION: Insert the IDs (Name, Version) of the current compiler into
228 * the original ACPI table header.
230 *****************************************************************************/
233 DtInsertCompilerIds (
241 * Don't insert current compiler ID if requested. Used for compiler
242 * debug/validation only.
244 if (Gbl_UseOriginalCompilerId)
249 /* Walk to the Compiler fields at the end of the header */
252 for (i = 0; i < 7; i++)
257 Next->Value = ASL_CREATOR_ID;
258 Next->Flags = DT_FIELD_NOT_ALLOCATED;
261 Next->Value = VersionString;
262 Next->Flags = DT_FIELD_NOT_ALLOCATED;
266 /******************************************************************************
268 * FUNCTION: DtCompileDataTable
270 * PARAMETERS: FieldList - Current field list pointer
274 * DESCRIPTION: Entry point to compile one data table
276 *****************************************************************************/
280 DT_FIELD **FieldList)
282 ACPI_DMTABLE_DATA *TableData;
283 DT_SUBTABLE *Subtable;
285 ACPI_TABLE_HEADER *AcpiTableHeader;
287 DT_FIELD *RootField = *FieldList;
290 /* Verify that we at least have a table signature and save it */
292 Signature = DtGetFieldValue (*FieldList);
295 sprintf (MsgBuffer, "Expected \"%s\"", "Signature");
296 DtNameError (ASL_ERROR, ASL_MSG_INVALID_FIELD_NAME,
297 *FieldList, MsgBuffer);
301 Gbl_Signature = UtStringCacheCalloc (ACPI_STRLEN (Signature) + 1);
302 strcpy (Gbl_Signature, Signature);
305 * Handle tables that don't use the common ACPI table header structure.
306 * Currently, these are the FACS and RSDP. Also check for an OEMx table,
307 * these tables have user-defined contents.
309 if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_FACS))
311 Status = DtCompileFacs (FieldList);
312 if (ACPI_FAILURE (Status))
320 else if (ACPI_VALIDATE_RSDP_SIG (Signature))
322 Status = DtCompileRsdp (FieldList);
325 else if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_S3PT))
327 Status = DtCompileS3pt (FieldList);
328 if (ACPI_FAILURE (Status))
338 * All other tables must use the common ACPI table header. Insert the
339 * current iASL IDs (name, version), and compile the header now.
341 DtInsertCompilerIds (*FieldList);
343 Status = DtCompileTable (FieldList, AcpiDmTableInfoHeader,
344 &Gbl_RootTable, TRUE);
345 if (ACPI_FAILURE (Status))
350 DtPushSubtable (Gbl_RootTable);
352 /* Validate the signature via the ACPI table list */
354 TableData = AcpiDmGetTableData (Signature);
355 if (!TableData || Gbl_CompileGeneric)
357 DtCompileGeneric ((void **) FieldList);
361 /* Dispatch to per-table compile */
363 if (TableData->CmTableHandler)
365 /* Complex table, has a handler */
367 Status = TableData->CmTableHandler ((void **) FieldList);
368 if (ACPI_FAILURE (Status))
373 else if (TableData->TableInfo)
375 /* Simple table, just walk the info table */
378 Status = DtCompileTable (FieldList, TableData->TableInfo,
380 if (ACPI_FAILURE (Status))
385 DtInsertSubtable (Gbl_RootTable, Subtable);
390 DtFatal (ASL_MSG_COMPILER_INTERNAL, *FieldList,
391 "Missing table dispatch info");
397 /* Set the final table length and then the checksum */
400 AcpiTableHeader = ACPI_CAST_PTR (
401 ACPI_TABLE_HEADER, Gbl_RootTable->Buffer);
402 DtSetTableChecksum (&AcpiTableHeader->Checksum);
404 DtDumpFieldList (RootField);
405 DtDumpSubtableList ();
410 /******************************************************************************
412 * FUNCTION: DtCompileTable
414 * PARAMETERS: Field - Current field list pointer
415 * Info - Info table for this ACPI table
416 * RetSubtable - Compile result of table
417 * Required - If this subtable must exist
421 * DESCRIPTION: Compile a subtable
423 *****************************************************************************/
428 ACPI_DMTABLE_INFO *Info,
429 DT_SUBTABLE **RetSubtable,
432 DT_FIELD *LocalField;
434 DT_SUBTABLE *Subtable;
435 DT_SUBTABLE *InlineSubtable;
436 UINT32 FieldLength = 0;
439 UINT8 *FlagBuffer = NULL;
441 UINT32 CurrentFlagByteOffset = 0;
445 if (!Field || !*Field)
447 return (AE_BAD_PARAMETER);
450 /* Ignore optional subtable if name does not match */
452 if ((Info->Flags & DT_OPTIONAL) &&
453 ACPI_STRCMP ((*Field)->Name, Info->Name))
459 Length = DtGetSubtableLength (*Field, Info);
460 if (Length == ASL_EOF)
465 Subtable = UtSubtableCacheCalloc ();
469 String = UtStringCacheCalloc (Length);
470 Subtable->Buffer = ACPI_CAST_PTR (UINT8, String);
473 Subtable->Length = Length;
474 Subtable->TotalLength = Length;
475 Buffer = Subtable->Buffer;
480 * Main loop walks the info table for this ACPI table or subtable
482 for (; Info->Name; Info++)
484 if (Info->Opcode == ACPI_DMT_EXTRA_TEXT)
491 sprintf (MsgBuffer, "Found NULL field - Field name \"%s\" needed",
493 DtFatal (ASL_MSG_COMPILER_INTERNAL, NULL, MsgBuffer);
494 Status = AE_BAD_DATA;
498 /* Maintain table offsets */
500 LocalField->TableOffset = Gbl_CurrentTableOffset;
501 FieldLength = DtGetFieldLength (LocalField, Info);
502 Gbl_CurrentTableOffset += FieldLength;
504 FieldType = DtGetFieldType (Info);
505 Gbl_InputFieldCount++;
509 case DT_FIELD_TYPE_FLAGS_INTEGER:
511 * Start of the definition of a flags field.
512 * This master flags integer starts at value zero, in preparation
513 * to compile and insert the flag fields from the individual bits
515 LocalField = LocalField->Next;
519 CurrentFlagByteOffset = Info->Offset;
522 case DT_FIELD_TYPE_FLAG:
524 /* Individual Flag field, can be multiple bits */
529 * We must increment the FlagBuffer when we have crossed
530 * into the next flags byte within the flags field
531 * of type DT_FIELD_TYPE_FLAGS_INTEGER.
533 FlagBuffer += (Info->Offset - CurrentFlagByteOffset);
534 CurrentFlagByteOffset = Info->Offset;
536 DtCompileFlag (FlagBuffer, LocalField, Info);
540 /* TBD - this is an internal error */
543 LocalField = LocalField->Next;
547 case DT_FIELD_TYPE_INLINE_SUBTABLE:
549 * Recursion (one level max): compile GAS (Generic Address)
550 * or Notify in-line subtable
554 if (Info->Opcode == ACPI_DMT_GAS)
556 Status = DtCompileTable (Field, AcpiDmTableInfoGas,
557 &InlineSubtable, TRUE);
561 Status = DtCompileTable (Field, AcpiDmTableInfoHestNotify,
562 &InlineSubtable, TRUE);
565 if (ACPI_FAILURE (Status))
570 DtSetSubtableLength (InlineSubtable);
572 ACPI_MEMCPY (Buffer, InlineSubtable->Buffer, FieldLength);
576 case DT_FIELD_TYPE_LABEL:
578 DtWriteFieldToListing (Buffer, LocalField, 0);
579 LocalField = LocalField->Next;
584 /* Normal case for most field types (Integer, String, etc.) */
586 DtCompileOneField (Buffer, LocalField,
587 FieldLength, FieldType, Info->Flags);
589 DtWriteFieldToListing (Buffer, LocalField, FieldLength);
590 LocalField = LocalField->Next;
592 if (Info->Flags & DT_LENGTH)
594 /* Field is an Integer that will contain a subtable length */
596 Subtable->LengthField = Buffer;
597 Subtable->SizeOfLengthField = FieldLength;
603 Buffer += FieldLength;
607 *RetSubtable = Subtable;
611 ACPI_FREE (Subtable->Buffer);
612 ACPI_FREE (Subtable);