dtcompile.c revision 209746
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 - 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 __DTCOMPILE_C__ 117#define _DECLARE_DT_GLOBALS 118 119#include <contrib/dev/acpica/compiler/aslcompiler.h> 120#include <contrib/dev/acpica/compiler/dtcompiler.h> 121 122#define _COMPONENT DT_COMPILER 123 ACPI_MODULE_NAME ("dtcompile") 124 125static char VersionString[9]; 126 127 128/* Local prototypes */ 129 130static void 131DtInitialize ( 132 void); 133 134static ACPI_STATUS 135DtCompileDataTable ( 136 DT_FIELD **Field); 137 138static void 139DtInsertCompilerIds ( 140 DT_FIELD *FieldList); 141 142 143/****************************************************************************** 144 * 145 * FUNCTION: DtDoCompile 146 * 147 * PARAMETERS: None 148 * 149 * RETURN: Status 150 * 151 * DESCRIPTION: Main entry point for the data table compiler. 152 * 153 * Note: Assumes Gbl_Files[ASL_FILE_INPUT] is initialized and the file is 154 * open at seek offset zero. 155 * 156 *****************************************************************************/ 157 158ACPI_STATUS 159DtDoCompile ( 160 void) 161{ 162 ACPI_STATUS Status; 163 UINT8 Event; 164 DT_FIELD *FieldList; 165 166 167 /* Initialize globals */ 168 169 DtInitialize (); 170 171 /* 172 * Scan the input file (file is already open) and 173 * build the parse tree 174 */ 175 Event = UtBeginEvent ("Scan and parse input file"); 176 FieldList = DtScanFile (Gbl_Files[ASL_FILE_INPUT].Handle); 177 UtEndEvent (Event); 178 179 /* Did the parse tree get successfully constructed? */ 180 181 if (!FieldList) 182 { 183 /* TBD: temporary error message. Msgs should come from function above */ 184 185 DtError (ASL_ERROR, ASL_MSG_SYNTAX, NULL, 186 "Input file does not appear to be an ASL or data table source file"); 187 188 Status = AE_ERROR; 189 goto CleanupAndExit; 190 } 191 192 Event = UtBeginEvent ("Compile parse tree"); 193 194 /* 195 * Compile the parse tree 196 */ 197 Status = DtCompileDataTable (&FieldList); 198 UtEndEvent (Event); 199 200 DtFreeFieldList (); 201 202 if (ACPI_FAILURE (Status)) 203 { 204 /* TBD: temporary error message. Msgs should come from function above */ 205 206 DtError (ASL_ERROR, ASL_MSG_SYNTAX, NULL, 207 "Could not compile input file"); 208 209 goto CleanupAndExit; 210 } 211 212 /* Create/open the binary output file */ 213 214 Gbl_Files[ASL_FILE_AML_OUTPUT].Filename = NULL; 215 Status = FlOpenAmlOutputFile (Gbl_OutputFilenamePrefix); 216 if (ACPI_FAILURE (Status)) 217 { 218 goto CleanupAndExit; 219 } 220 221 /* Write the binary, then the optional hex file */ 222 223 DtOutputBinary (Gbl_RootTable); 224 LsDoHexOutput (); 225 226CleanupAndExit: 227 228 CmCleanupAndExit (); 229 return (Status); 230} 231 232 233/****************************************************************************** 234 * 235 * FUNCTION: DtInitialize 236 * 237 * PARAMETERS: None 238 * 239 * RETURN: None 240 * 241 * DESCRIPTION: Initialize data table compiler globals. Enables multiple 242 * compiles per invocation. 243 * 244 *****************************************************************************/ 245 246static void 247DtInitialize ( 248 void) 249{ 250 251 AcpiOsInitialize (); 252 AcpiUtInitGlobals (); 253 254 Gbl_FieldList = NULL; 255 Gbl_RootTable = NULL; 256 Gbl_SubtableStack = NULL; 257 258 sprintf (VersionString, "%X", (UINT32) ACPI_CA_VERSION); 259} 260 261 262/****************************************************************************** 263 * 264 * FUNCTION: DtInsertCompilerIds 265 * 266 * PARAMETERS: FieldList - Current field list pointer 267 * 268 * RETURN: None 269 * 270 * DESCRIPTION: Insert the IDs (Name, Version) of the current compiler into 271 * the original ACPI table header. 272 * 273 *****************************************************************************/ 274 275static void 276DtInsertCompilerIds ( 277 DT_FIELD *FieldList) 278{ 279 DT_FIELD *Next; 280 UINT32 i; 281 282 283 /* 284 * Don't insert current compiler ID if requested. Used for compiler 285 * debug/validation only. 286 */ 287 if (Gbl_UseOriginalCompilerId) 288 { 289 return; 290 } 291 292 /* Walk to the Compiler fields at the end of the header */ 293 294 Next = FieldList; 295 for (i = 0; i < 7; i++) 296 { 297 Next = Next->Next; 298 } 299 300 Next->Value = CompilerCreatorId; 301 Next->Flags = DT_FIELD_NOT_ALLOCATED; 302 303 Next = Next->Next; 304 Next->Value = VersionString; 305 Next->Flags = DT_FIELD_NOT_ALLOCATED; 306} 307 308 309/****************************************************************************** 310 * 311 * FUNCTION: DtCompileDataTable 312 * 313 * PARAMETERS: FieldList - Current field list pointer 314 * 315 * RETURN: Status 316 * 317 * DESCRIPTION: Entry point to compile one data table 318 * 319 *****************************************************************************/ 320 321static ACPI_STATUS 322DtCompileDataTable ( 323 DT_FIELD **FieldList) 324{ 325 ACPI_DMTABLE_DATA *TableData; 326 DT_SUBTABLE *Subtable; 327 char *Signature; 328 ACPI_TABLE_HEADER *AcpiTableHeader; 329 ACPI_STATUS Status; 330 331 332 /* Verify that we at least have a table signature and save it */ 333 334 Signature = DtGetFieldValue (*FieldList, "Signature"); 335 if (!Signature) 336 { 337 sprintf (MsgBuffer, "Expected \"%s\"", "Signature"); 338 DtNameError (ASL_ERROR, ASL_MSG_INVALID_FIELD_NAME, 339 *FieldList, MsgBuffer); 340 return (AE_ERROR); 341 } 342 343 Gbl_Signature = UtLocalCalloc (ACPI_STRLEN (Signature) + 1); 344 strcpy (Gbl_Signature, Signature); 345 346 /* 347 * Handle tables that don't use the common ACPI table header structure. 348 * Currently, these are the FACS and RSDP. Also check for an OEMx table, 349 * these tables have user-defined contents. 350 */ 351 if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_FACS)) 352 { 353 Status = DtCompileFacs (FieldList); 354 if (ACPI_FAILURE (Status)) 355 { 356 return (Status); 357 } 358 359 DtSetTableLength (); 360 return (Status); 361 } 362 else if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_RSDP)) 363 { 364 Status = DtCompileRsdp (FieldList); 365 return (Status); 366 } 367 else if (!ACPI_STRNCMP (Signature, "OEM", 3)) 368 { 369 DtFatal (ASL_MSG_OEM_TABLE, *FieldList, Signature); 370 return (AE_ERROR); 371 } 372 373 /* Validate the signature via the ACPI table list */ 374 375 TableData = AcpiDmGetTableData (Signature); 376 if (!TableData) 377 { 378 DtFatal (ASL_MSG_UNKNOWN_TABLE, *FieldList, Signature); 379 return (AE_ERROR); 380 } 381 382 /* 383 * All other tables must use the common ACPI table header. Insert the 384 * current iASL IDs (name, version), and compile the header now. 385 */ 386 DtInsertCompilerIds (*FieldList); 387 388 Status = DtCompileTable (FieldList, AcpiDmTableInfoHeader, 389 &Gbl_RootTable, TRUE); 390 if (ACPI_FAILURE (Status)) 391 { 392 return (Status); 393 } 394 395 DtPushSubtable (Gbl_RootTable); 396 397 /* Dispatch to per-table compile */ 398 399 if (TableData->CmTableHandler) 400 { 401 /* Complex table, has a handler */ 402 403 Status = TableData->CmTableHandler ((void **) FieldList); 404 if (ACPI_FAILURE (Status)) 405 { 406 return (Status); 407 } 408 } 409 else if (TableData->TableInfo) 410 { 411 /* Simple table, just walk the info table */ 412 413 Subtable = NULL; 414 Status = DtCompileTable (FieldList, TableData->TableInfo, 415 &Subtable, TRUE); 416 if (ACPI_FAILURE (Status)) 417 { 418 return (Status); 419 } 420 421 DtInsertSubtable (Gbl_RootTable, Subtable); 422 DtPopSubtable (); 423 } 424 else 425 { 426 DtFatal (ASL_MSG_COMPILER_INTERNAL, *FieldList, 427 "Missing table dispatch info"); 428 return (AE_ERROR); 429 } 430 431 /* Set the final table length and then the checksum */ 432 433 DtSetTableLength (); 434 AcpiTableHeader = ACPI_CAST_PTR ( 435 ACPI_TABLE_HEADER, Gbl_RootTable->Buffer); 436 DtSetTableChecksum (&AcpiTableHeader->Checksum); 437 438 return (AE_OK); 439} 440 441 442/****************************************************************************** 443 * 444 * FUNCTION: DtCompileTable 445 * 446 * PARAMETERS: Field - Current field list pointer 447 * Info - Info table for this ACPI table 448 * RetSubtable - Compile result of table 449 * Required - If this subtable must exist 450 * 451 * RETURN: Status 452 * 453 * DESCRIPTION: Compile a subtable 454 * 455 *****************************************************************************/ 456 457ACPI_STATUS 458DtCompileTable ( 459 DT_FIELD **Field, 460 ACPI_DMTABLE_INFO *Info, 461 DT_SUBTABLE **RetSubtable, 462 BOOLEAN Required) 463{ 464 DT_FIELD *LocalField; 465 UINT32 Length; 466 DT_SUBTABLE *Subtable; 467 DT_SUBTABLE *InlineSubtable; 468 UINT32 FieldLength = 0; 469 UINT8 FieldType; 470 UINT8 *Buffer; 471 UINT8 *FlagBuffer = NULL; 472 ACPI_STATUS Status; 473 474 475 if (!Field || !*Field) 476 { 477 return (AE_BAD_PARAMETER); 478 } 479 480 Length = DtGetSubtableLength (*Field, Info); 481 Subtable = UtLocalCalloc (sizeof (DT_SUBTABLE)); 482 483 Subtable->Buffer = UtLocalCalloc (Length); 484 Subtable->Length = Length; 485 Subtable->TotalLength = Length; 486 Buffer = Subtable->Buffer; 487 488 LocalField = *Field; 489 490 /* 491 * Main loop walks the info table for this ACPI table or subtable 492 */ 493 for (; Info->Name; Info++) 494 { 495 if (!LocalField) 496 { 497 sprintf (MsgBuffer, "Found NULL field - Field name \"%s\" needed", 498 Info->Name); 499 DtFatal (ASL_MSG_COMPILER_INTERNAL, NULL, MsgBuffer); 500 Status = AE_BAD_DATA; 501 goto Error; 502 } 503 504 /* Does input field name match what is expected? */ 505 506 if (ACPI_STRCMP (LocalField->Name, Info->Name)) 507 { 508 /* 509 * If Required = TRUE, the subtable must exist. 510 * If Required = FALSE, the subtable is optional 511 * (For example, AcpiDmTableInfoDmarScope in DMAR table is 512 * optional) 513 */ 514 if (Required) 515 { 516 sprintf (MsgBuffer, "Expected \"%s\"", Info->Name); 517 DtNameError (ASL_ERROR, ASL_MSG_INVALID_FIELD_NAME, 518 LocalField, MsgBuffer); 519 } 520 else 521 { 522 Status = AE_NOT_FOUND; 523 goto Error; 524 } 525 } 526 527 FieldLength = DtGetFieldLength (LocalField, Info); 528 FieldType = DtGetFieldType (Info); 529 Gbl_InputFieldCount++; 530 531 switch (FieldType) 532 { 533 case DT_FIELD_TYPE_FLAGS_INTEGER: 534 /* 535 * Start of the definition of a flags field. 536 * This master flags integer starts at value zero, in preparation 537 * to compile and insert the flag fields from the individual bits 538 */ 539 LocalField = LocalField->Next; 540 *Field = LocalField; 541 542 FlagBuffer = Buffer; 543 break; 544 545 case DT_FIELD_TYPE_FLAG: 546 547 /* Individual Flag field, can be multiple bits */ 548 549 if (FlagBuffer) 550 { 551 DtCompileFlag (FlagBuffer, LocalField, Info); 552 } 553 else 554 { 555 /* TBD - this is an internal error */ 556 } 557 558 LocalField = LocalField->Next; 559 *Field = LocalField; 560 break; 561 562 case DT_FIELD_TYPE_INLINE_SUBTABLE: 563 /* 564 * Recursion (one level max): compile GAS (Generic Address) 565 * or Notify in-line subtable 566 */ 567 LocalField = LocalField->Next; 568 *Field = LocalField; 569 570 if (Info->Opcode == ACPI_DMT_GAS) 571 { 572 Status = DtCompileTable (Field, AcpiDmTableInfoGas, 573 &InlineSubtable, TRUE); 574 } 575 else 576 { 577 Status = DtCompileTable (Field, AcpiDmTableInfoHestNotify, 578 &InlineSubtable, TRUE); 579 } 580 581 if (ACPI_FAILURE (Status)) 582 { 583 goto Error; 584 } 585 586 DtSetSubtableLength (InlineSubtable); 587 588 ACPI_MEMCPY (Buffer, InlineSubtable->Buffer, FieldLength); 589 ACPI_FREE (InlineSubtable->Buffer); 590 ACPI_FREE (InlineSubtable); 591 LocalField = *Field; 592 break; 593 594 default: 595 596 /* Normal case for most field types (Integer, String, etc.) */ 597 598 DtCompileOneField (Buffer, LocalField, 599 FieldLength, FieldType, Info->Flags); 600 LocalField = LocalField->Next; 601 602 if (Info->Flags & DT_LENGTH) 603 { 604 /* Field is an Integer that will contain a subtable length */ 605 606 Subtable->LengthField = Buffer; 607 Subtable->SizeOfLengthField = FieldLength; 608 } 609 break; 610 } 611 612 Buffer += FieldLength; 613 } 614 615 *Field = LocalField; 616 *RetSubtable = Subtable; 617 return (AE_OK); 618 619Error: 620 ACPI_FREE (Subtable->Buffer); 621 ACPI_FREE (Subtable); 622 return (Status); 623} 624