1 /******************************************************************************
3 * Module Name: dtcompile.c - Front-end for data table compiler
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2011, 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 <contrib/dev/acpica/compiler/aslcompiler.h>
48 #include <contrib/dev/acpica/compiler/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);
105 * Scan the input file (file is already open) and
106 * build the parse tree
108 Event = UtBeginEvent ("Scan and parse input file");
109 FieldList = DtScanFile (Gbl_Files[ASL_FILE_INPUT].Handle);
112 /* Did the parse tree get successfully constructed? */
116 /* TBD: temporary error message. Msgs should come from function above */
118 DtError (ASL_ERROR, ASL_MSG_SYNTAX, NULL,
119 "Input file does not appear to be an ASL or data table source file");
125 Event = UtBeginEvent ("Compile parse tree");
128 * Compile the parse tree
130 Status = DtCompileDataTable (&FieldList);
135 if (ACPI_FAILURE (Status))
137 /* TBD: temporary error message. Msgs should come from function above */
139 DtError (ASL_ERROR, ASL_MSG_SYNTAX, NULL,
140 "Could not compile input file");
145 /* Create/open the binary output file */
147 Gbl_Files[ASL_FILE_AML_OUTPUT].Filename = NULL;
148 Status = FlOpenAmlOutputFile (Gbl_OutputFilenamePrefix);
149 if (ACPI_FAILURE (Status))
154 /* Write the binary, then the optional hex file */
156 DtOutputBinary (Gbl_RootTable);
158 DtWriteTableToListing ();
167 /******************************************************************************
169 * FUNCTION: DtInitialize
175 * DESCRIPTION: Initialize data table compiler globals. Enables multiple
176 * compiles per invocation.
178 *****************************************************************************/
187 Status = AcpiOsInitialize ();
188 if (ACPI_FAILURE (Status))
193 Status = AcpiUtInitGlobals ();
194 if (ACPI_FAILURE (Status))
199 Gbl_FieldList = NULL;
200 Gbl_RootTable = NULL;
201 Gbl_SubtableStack = NULL;
203 sprintf (VersionString, "%X", (UINT32) ACPI_CA_VERSION);
208 /******************************************************************************
210 * FUNCTION: DtInsertCompilerIds
212 * PARAMETERS: FieldList - Current field list pointer
216 * DESCRIPTION: Insert the IDs (Name, Version) of the current compiler into
217 * the original ACPI table header.
219 *****************************************************************************/
222 DtInsertCompilerIds (
230 * Don't insert current compiler ID if requested. Used for compiler
231 * debug/validation only.
233 if (Gbl_UseOriginalCompilerId)
238 /* Walk to the Compiler fields at the end of the header */
241 for (i = 0; i < 7; i++)
246 Next->Value = ASL_CREATOR_ID;
247 Next->Flags = DT_FIELD_NOT_ALLOCATED;
250 Next->Value = VersionString;
251 Next->Flags = DT_FIELD_NOT_ALLOCATED;
255 /******************************************************************************
257 * FUNCTION: DtCompileDataTable
259 * PARAMETERS: FieldList - Current field list pointer
263 * DESCRIPTION: Entry point to compile one data table
265 *****************************************************************************/
269 DT_FIELD **FieldList)
271 ACPI_DMTABLE_DATA *TableData;
272 DT_SUBTABLE *Subtable;
274 ACPI_TABLE_HEADER *AcpiTableHeader;
278 /* Verify that we at least have a table signature and save it */
280 Signature = DtGetFieldValue (*FieldList);
283 sprintf (MsgBuffer, "Expected \"%s\"", "Signature");
284 DtNameError (ASL_ERROR, ASL_MSG_INVALID_FIELD_NAME,
285 *FieldList, MsgBuffer);
289 Gbl_Signature = UtLocalCalloc (ACPI_STRLEN (Signature) + 1);
290 strcpy (Gbl_Signature, Signature);
293 * Handle tables that don't use the common ACPI table header structure.
294 * Currently, these are the FACS and RSDP. Also check for an OEMx table,
295 * these tables have user-defined contents.
297 if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_FACS))
299 Status = DtCompileFacs (FieldList);
300 if (ACPI_FAILURE (Status))
308 else if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_RSDP))
310 Status = DtCompileRsdp (FieldList);
313 else if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_S3PT))
315 Status = DtCompileS3pt (FieldList);
316 if (ACPI_FAILURE (Status))
326 * All other tables must use the common ACPI table header. Insert the
327 * current iASL IDs (name, version), and compile the header now.
329 DtInsertCompilerIds (*FieldList);
331 Status = DtCompileTable (FieldList, AcpiDmTableInfoHeader,
332 &Gbl_RootTable, TRUE);
333 if (ACPI_FAILURE (Status))
338 DtPushSubtable (Gbl_RootTable);
340 /* Validate the signature via the ACPI table list */
342 TableData = AcpiDmGetTableData (Signature);
343 if (!TableData || Gbl_CompileGeneric)
345 DtCompileGeneric ((void **) FieldList);
349 /* Dispatch to per-table compile */
351 if (TableData->CmTableHandler)
353 /* Complex table, has a handler */
355 Status = TableData->CmTableHandler ((void **) FieldList);
356 if (ACPI_FAILURE (Status))
361 else if (TableData->TableInfo)
363 /* Simple table, just walk the info table */
366 Status = DtCompileTable (FieldList, TableData->TableInfo,
368 if (ACPI_FAILURE (Status))
373 DtInsertSubtable (Gbl_RootTable, Subtable);
378 DtFatal (ASL_MSG_COMPILER_INTERNAL, *FieldList,
379 "Missing table dispatch info");
384 /* Set the final table length and then the checksum */
387 AcpiTableHeader = ACPI_CAST_PTR (
388 ACPI_TABLE_HEADER, Gbl_RootTable->Buffer);
389 DtSetTableChecksum (&AcpiTableHeader->Checksum);
395 /******************************************************************************
397 * FUNCTION: DtCompileTable
399 * PARAMETERS: Field - Current field list pointer
400 * Info - Info table for this ACPI table
401 * RetSubtable - Compile result of table
402 * Required - If this subtable must exist
406 * DESCRIPTION: Compile a subtable
408 *****************************************************************************/
413 ACPI_DMTABLE_INFO *Info,
414 DT_SUBTABLE **RetSubtable,
417 DT_FIELD *LocalField;
419 DT_SUBTABLE *Subtable;
420 DT_SUBTABLE *InlineSubtable;
421 UINT32 FieldLength = 0;
424 UINT8 *FlagBuffer = NULL;
425 UINT32 CurrentFlagByteOffset = 0;
429 if (!Field || !*Field)
431 return (AE_BAD_PARAMETER);
434 Length = DtGetSubtableLength (*Field, Info);
435 if (Length == ASL_EOF)
440 Subtable = UtLocalCalloc (sizeof (DT_SUBTABLE));
444 Subtable->Buffer = UtLocalCalloc (Length);
446 Subtable->Length = Length;
447 Subtable->TotalLength = Length;
448 Buffer = Subtable->Buffer;
453 * Main loop walks the info table for this ACPI table or subtable
455 for (; Info->Name; Info++)
457 if (Info->Opcode == ACPI_DMT_EXTRA_TEXT)
464 sprintf (MsgBuffer, "Found NULL field - Field name \"%s\" needed",
466 DtFatal (ASL_MSG_COMPILER_INTERNAL, NULL, MsgBuffer);
467 Status = AE_BAD_DATA;
471 /* Maintain table offsets */
473 LocalField->TableOffset = Gbl_CurrentTableOffset;
474 FieldLength = DtGetFieldLength (LocalField, Info);
475 Gbl_CurrentTableOffset += FieldLength;
477 FieldType = DtGetFieldType (Info);
478 Gbl_InputFieldCount++;
482 case DT_FIELD_TYPE_FLAGS_INTEGER:
484 * Start of the definition of a flags field.
485 * This master flags integer starts at value zero, in preparation
486 * to compile and insert the flag fields from the individual bits
488 LocalField = LocalField->Next;
492 CurrentFlagByteOffset = Info->Offset;
495 case DT_FIELD_TYPE_FLAG:
497 /* Individual Flag field, can be multiple bits */
502 * We must increment the FlagBuffer when we have crossed
503 * into the next flags byte within the flags field
504 * of type DT_FIELD_TYPE_FLAGS_INTEGER.
506 FlagBuffer += (Info->Offset - CurrentFlagByteOffset);
507 CurrentFlagByteOffset = Info->Offset;
509 DtCompileFlag (FlagBuffer, LocalField, Info);
513 /* TBD - this is an internal error */
516 LocalField = LocalField->Next;
520 case DT_FIELD_TYPE_INLINE_SUBTABLE:
522 * Recursion (one level max): compile GAS (Generic Address)
523 * or Notify in-line subtable
527 if (Info->Opcode == ACPI_DMT_GAS)
529 Status = DtCompileTable (Field, AcpiDmTableInfoGas,
530 &InlineSubtable, TRUE);
534 Status = DtCompileTable (Field, AcpiDmTableInfoHestNotify,
535 &InlineSubtable, TRUE);
538 if (ACPI_FAILURE (Status))
543 DtSetSubtableLength (InlineSubtable);
545 ACPI_MEMCPY (Buffer, InlineSubtable->Buffer, FieldLength);
546 ACPI_FREE (InlineSubtable->Buffer);
547 ACPI_FREE (InlineSubtable);
551 case DT_FIELD_TYPE_LABEL:
553 DtWriteFieldToListing (Buffer, LocalField, 0);
554 LocalField = LocalField->Next;
559 /* Normal case for most field types (Integer, String, etc.) */
561 DtCompileOneField (Buffer, LocalField,
562 FieldLength, FieldType, Info->Flags);
564 DtWriteFieldToListing (Buffer, LocalField, FieldLength);
565 LocalField = LocalField->Next;
567 if (Info->Flags & DT_LENGTH)
569 /* Field is an Integer that will contain a subtable length */
571 Subtable->LengthField = Buffer;
572 Subtable->SizeOfLengthField = FieldLength;
578 Buffer += FieldLength;
582 *RetSubtable = Subtable;
586 ACPI_FREE (Subtable->Buffer);
587 ACPI_FREE (Subtable);