1 /****************************************************************************** 2 * 3 * Module Name: dttemplate - ACPI table template generation 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2023, 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 #include <contrib/dev/acpica/compiler/aslcompiler.h> 153 #include <contrib/dev/acpica/include/acapps.h> 154 #include <contrib/dev/acpica/compiler/dttemplate.h> /* Contains the hex ACPI table templates */ 155 156 #define _COMPONENT DT_COMPILER 157 ACPI_MODULE_NAME ("dttemplate") 158 159 160 /* Local prototypes */ 161 162 static BOOLEAN 163 AcpiUtIsSpecialTable ( 164 char *Signature); 165 166 static ACPI_STATUS 167 DtCreateOneTemplateFile ( 168 char *Signature, 169 UINT32 TableCount); 170 171 static ACPI_STATUS 172 DtCreateOneTemplate ( 173 char *Signature, 174 UINT32 TableCount, 175 const ACPI_DMTABLE_DATA *TableData); 176 177 static ACPI_STATUS 178 DtCreateAllTemplates ( 179 void); 180 181 static int 182 DtEmitDefinitionBlock ( 183 FILE *File, 184 char *Filename, 185 char *Signature, 186 UINT32 Instance); 187 188 189 /******************************************************************************* 190 * 191 * FUNCTION: AcpiUtIsSpecialTable 192 * 193 * PARAMETERS: Signature - ACPI table signature 194 * 195 * RETURN: TRUE if signature is a special ACPI table 196 * 197 * DESCRIPTION: Check for valid ACPI tables that are not in the main ACPI 198 * table data structure (AcpiDmTableData). 199 * 200 ******************************************************************************/ 201 202 static BOOLEAN 203 AcpiUtIsSpecialTable ( 204 char *Signature) 205 { 206 207 if (ACPI_COMPARE_NAMESEG (Signature, ACPI_SIG_DSDT) || 208 ACPI_COMPARE_NAMESEG (Signature, ACPI_SIG_OSDT) || 209 ACPI_COMPARE_NAMESEG (Signature, ACPI_SIG_SSDT) || 210 ACPI_COMPARE_NAMESEG (Signature, ACPI_SIG_FACS) || 211 ACPI_COMPARE_NAMESEG (Signature, ACPI_RSDP_NAME)) 212 { 213 return (TRUE); 214 } 215 216 return (FALSE); 217 } 218 219 220 /******************************************************************************* 221 * 222 * FUNCTION: DtCreateTemplates 223 * 224 * PARAMETERS: argv - Standard command line arguments 225 * 226 * RETURN: Status 227 * 228 * DESCRIPTION: Create one or more template files. 229 * 230 ******************************************************************************/ 231 232 ACPI_STATUS 233 DtCreateTemplates ( 234 char **argv) 235 { 236 char *Signature; 237 char *End; 238 unsigned long TableCount; 239 ACPI_STATUS Status = AE_OK; 240 241 242 AslInitializeGlobals (); 243 244 Status = AdInitialize (); 245 if (ACPI_FAILURE (Status)) 246 { 247 return (Status); 248 } 249 250 /* 251 * Special cases for DSDT, ALL, and '*' 252 */ 253 254 /* Default (no signature option) is DSDT */ 255 256 if (AcpiGbl_Optind < 3) 257 { 258 fprintf (stderr, "Creating default template: [DSDT]\n"); 259 Status = DtCreateOneTemplateFile (ACPI_SIG_DSDT, 0); 260 goto Exit; 261 } 262 263 AcpiGbl_Optind--; 264 Signature = argv[AcpiGbl_Optind]; 265 AcpiUtStrupr (Signature); 266 267 /* 268 * Multiple SSDT support (-T <ssdt count>) 269 */ 270 TableCount = strtoul (Signature, &End, 0); 271 if (Signature != End) 272 { 273 /* The count is used for table ID and method name - max is 254(+1) */ 274 275 if (TableCount > 254) 276 { 277 fprintf (stderr, "%u SSDTs requested, maximum is 254\n", 278 (unsigned int) TableCount); 279 280 Status = AE_LIMIT; 281 goto Exit; 282 } 283 284 Status = DtCreateOneTemplateFile (ACPI_SIG_DSDT, TableCount); 285 goto Exit; 286 } 287 288 if (!strcmp (Signature, "ALL")) 289 { 290 /* Create all available/known templates */ 291 292 Status = DtCreateAllTemplates (); 293 goto Exit; 294 } 295 296 /* 297 * Normal case: Create template for each signature 298 */ 299 while (argv[AcpiGbl_Optind]) 300 { 301 Signature = argv[AcpiGbl_Optind]; 302 AcpiUtStrupr (Signature); 303 304 Status = DtCreateOneTemplateFile (Signature, 0); 305 if (ACPI_FAILURE (Status)) 306 { 307 goto Exit; 308 } 309 310 AcpiGbl_Optind++; 311 } 312 313 314 Exit: 315 /* Shutdown ACPICA subsystem */ 316 317 (void) AcpiTerminate (); 318 UtDeleteLocalCaches (); 319 return (Status); 320 } 321 322 323 /******************************************************************************* 324 * 325 * FUNCTION: DtCreateOneTemplateFile 326 * 327 * PARAMETERS: Signature - ACPI table signature 328 * 329 * RETURN: Status 330 * 331 * DESCRIPTION: Create one template file of the requested signature. 332 * 333 ******************************************************************************/ 334 335 static ACPI_STATUS 336 DtCreateOneTemplateFile ( 337 char *Signature, 338 UINT32 TableCount) 339 { 340 const ACPI_DMTABLE_DATA *TableData; 341 ACPI_STATUS Status; 342 343 344 /* 345 * Validate signature and get the template data: 346 * 1) Signature must be 4 characters 347 * 2) Signature must be a recognized ACPI table 348 * 3) There must be a template associated with the signature 349 */ 350 if (strlen (Signature) != ACPI_NAMESEG_SIZE) 351 { 352 fprintf (stderr, 353 "%s: Invalid ACPI table signature " 354 "(length must be 4 characters)\n", Signature); 355 return (AE_ERROR); 356 } 357 358 /* 359 * Some slack for the two strange tables whose name is different than 360 * their signatures: MADT->APIC and FADT->FACP. 361 */ 362 if (!strcmp (Signature, "MADT")) 363 { 364 Signature = "APIC"; 365 } 366 else if (!strcmp (Signature, "FADT")) 367 { 368 Signature = "FACP"; 369 } 370 371 /* TableData will point to the template */ 372 373 TableData = AcpiDmGetTableData (Signature); 374 if (TableData) 375 { 376 if (!TableData->Template) 377 { 378 fprintf (stderr, "%4.4s: No template available\n", Signature); 379 return (AE_ERROR); 380 } 381 } 382 else if (!AcpiUtIsSpecialTable (Signature)) 383 { 384 fprintf (stderr, 385 "%4.4s: Unrecognized ACPI table signature\n", Signature); 386 return (AE_ERROR); 387 } 388 389 Status = DtCreateOneTemplate (Signature, TableCount, TableData); 390 return (Status); 391 } 392 393 394 /******************************************************************************* 395 * 396 * FUNCTION: DtCreateAllTemplates 397 * 398 * PARAMETERS: None 399 * 400 * RETURN: Status 401 * 402 * DESCRIPTION: Create all currently defined template files 403 * 404 ******************************************************************************/ 405 406 static ACPI_STATUS 407 DtCreateAllTemplates ( 408 void) 409 { 410 const ACPI_DMTABLE_DATA *TableData; 411 ACPI_STATUS Status; 412 413 414 fprintf (stderr, "Creating all supported Template files\n"); 415 416 /* Walk entire ACPI table data structure */ 417 418 for (TableData = AcpiDmTableData; TableData->Signature; TableData++) 419 { 420 /* If table has a template, create the template file */ 421 422 if (TableData->Template) 423 { 424 Status = DtCreateOneTemplate (TableData->Signature, 425 0, TableData); 426 if (ACPI_FAILURE (Status)) 427 { 428 return (Status); 429 } 430 } 431 } 432 433 /* 434 * Create the special ACPI tables: 435 * 1) DSDT/SSDT are AML tables, not data tables 436 * 2) FACS and RSDP have non-standard headers 437 */ 438 Status = DtCreateOneTemplate (ACPI_SIG_DSDT, 0, NULL); 439 if (ACPI_FAILURE (Status)) 440 { 441 return (Status); 442 } 443 444 Status = DtCreateOneTemplate (ACPI_SIG_SSDT, 0, NULL); 445 if (ACPI_FAILURE (Status)) 446 { 447 return (Status); 448 } 449 450 Status = DtCreateOneTemplate (ACPI_SIG_OSDT, 0, NULL); 451 if (ACPI_FAILURE (Status)) 452 { 453 return (Status); 454 } 455 456 Status = DtCreateOneTemplate (ACPI_SIG_FACS, 0, NULL); 457 if (ACPI_FAILURE (Status)) 458 { 459 return (Status); 460 } 461 462 Status = DtCreateOneTemplate (ACPI_RSDP_NAME, 0, NULL); 463 if (ACPI_FAILURE (Status)) 464 { 465 return (Status); 466 } 467 468 return (AE_OK); 469 } 470 471 472 /******************************************************************************* 473 * 474 * FUNCTION: DtCreateOneTemplate 475 * 476 * PARAMETERS: Signature - ACPI signature, NULL terminated. 477 * TableCount - Used for SSDTs in same file as DSDT 478 * TableData - Entry in ACPI table data structure. 479 * NULL if a special ACPI table. 480 * 481 * RETURN: Status 482 * 483 * DESCRIPTION: Create one template source file for the requested ACPI table. 484 * 485 ******************************************************************************/ 486 487 static ACPI_STATUS 488 DtCreateOneTemplate ( 489 char *Signature, 490 UINT32 TableCount, 491 const ACPI_DMTABLE_DATA *TableData) 492 { 493 char *DisasmFilename; 494 FILE *File; 495 ACPI_STATUS Status = AE_OK; 496 int Actual; 497 UINT32 i; 498 499 500 /* New file will have a .asl suffix */ 501 502 DisasmFilename = FlGenerateFilename ( 503 Signature, FILE_SUFFIX_ASL_CODE); 504 if (!DisasmFilename) 505 { 506 fprintf (stderr, "Could not generate output filename\n"); 507 return (AE_ERROR); 508 } 509 510 AcpiUtStrlwr (DisasmFilename); 511 if (!UtQueryForOverwrite (DisasmFilename)) 512 { 513 return (AE_OK); 514 } 515 516 File = fopen (DisasmFilename, "w+"); 517 if (!File) 518 { 519 fprintf (stderr, "Could not open output file %s\n", 520 DisasmFilename); 521 return (AE_ERROR); 522 } 523 524 /* Emit the common file header */ 525 526 AcpiOsRedirectOutput (File); 527 528 AcpiOsPrintf ("/*\n"); 529 AcpiOsPrintf (ACPI_COMMON_HEADER ("iASL Compiler/Disassembler", " * ")); 530 531 if (TableCount == 0) 532 { 533 AcpiOsPrintf (" * Template for [%4.4s] ACPI Table", 534 Signature); 535 } 536 else 537 { 538 AcpiOsPrintf (" * Template for [%4.4s] and %u [SSDT] ACPI Tables", 539 Signature, TableCount); 540 } 541 542 /* Dump the actual ACPI table */ 543 544 if (TableData) 545 { 546 /* Normal case, tables that appear in AcpiDmTableData */ 547 548 AcpiOsPrintf (" (static data table)\n"); 549 550 if (AslGbl_VerboseTemplates) 551 { 552 AcpiOsPrintf (" * Format: [HexOffset DecimalOffset ByteLength]" 553 " FieldName : HexFieldValue\n */\n\n"); 554 } 555 else 556 { 557 AcpiOsPrintf (" * Format: [ByteLength]" 558 " FieldName : HexFieldValue\n */\n"); 559 } 560 561 AcpiDmDumpDataTable (ACPI_CAST_PTR (ACPI_TABLE_HEADER, 562 TableData->Template)); 563 } 564 else 565 { 566 /* Special ACPI tables - DSDT, SSDT, OSDT, FACS, RSDP */ 567 568 AcpiOsPrintf (" (AML byte code table)\n"); 569 AcpiOsPrintf (" */\n"); 570 571 if (ACPI_COMPARE_NAMESEG (Signature, ACPI_SIG_DSDT)) 572 { 573 Actual = DtEmitDefinitionBlock ( 574 File, DisasmFilename, ACPI_SIG_DSDT, 1); 575 if (Actual < 0) 576 { 577 Status = AE_ERROR; 578 goto Cleanup; 579 } 580 581 /* Emit any requested SSDTs into the same file */ 582 583 for (i = 1; i <= TableCount; i++) 584 { 585 Actual = DtEmitDefinitionBlock ( 586 File, DisasmFilename, ACPI_SIG_SSDT, i + 1); 587 if (Actual < 0) 588 { 589 Status = AE_ERROR; 590 goto Cleanup; 591 } 592 } 593 } 594 else if (ACPI_COMPARE_NAMESEG (Signature, ACPI_SIG_SSDT)) 595 { 596 Actual = DtEmitDefinitionBlock ( 597 File, DisasmFilename, ACPI_SIG_SSDT, 1); 598 if (Actual < 0) 599 { 600 Status = AE_ERROR; 601 goto Cleanup; 602 } 603 } 604 else if (ACPI_COMPARE_NAMESEG (Signature, ACPI_SIG_OSDT)) 605 { 606 Actual = DtEmitDefinitionBlock ( 607 File, DisasmFilename, ACPI_SIG_OSDT, 1); 608 if (Actual < 0) 609 { 610 Status = AE_ERROR; 611 goto Cleanup; 612 } 613 } 614 else if (ACPI_COMPARE_NAMESEG (Signature, ACPI_SIG_FACS)) 615 { 616 AcpiDmDumpDataTable (ACPI_CAST_PTR (ACPI_TABLE_HEADER, 617 TemplateFacs)); 618 } 619 else if (ACPI_COMPARE_NAMESEG (Signature, ACPI_RSDP_NAME)) 620 { 621 AcpiDmDumpDataTable (ACPI_CAST_PTR (ACPI_TABLE_HEADER, 622 TemplateRsdp)); 623 } 624 else 625 { 626 fprintf (stderr, 627 "%4.4s, Unrecognized ACPI table signature\n", Signature); 628 Status = AE_ERROR; 629 goto Cleanup; 630 } 631 } 632 633 if (TableCount == 0) 634 { 635 fprintf (stderr, 636 "Created ACPI table template for [%4.4s], " 637 "written to \"%s\"\n", 638 Signature, DisasmFilename); 639 } 640 else 641 { 642 fprintf (stderr, 643 "Created ACPI table templates for [%4.4s] " 644 "and %u [SSDT] in same file, written to \"%s\"\n", 645 Signature, TableCount, DisasmFilename); 646 } 647 648 Cleanup: 649 fclose (File); 650 AcpiOsRedirectOutput (stdout); 651 return (Status); 652 } 653 654 655 /******************************************************************************* 656 * 657 * FUNCTION: DtEmitDefinitionBlock 658 * 659 * PARAMETERS: File - An open file for the block 660 * Filename - Filename for same, for error msg(s) 661 * Signature - ACPI signature for the block 662 * Instance - Used for multiple SSDTs in the same file 663 * 664 * RETURN: Status from fprintf 665 * 666 * DESCRIPTION: Emit the raw ASL for a complete Definition Block (DSDT or SSDT) 667 * 668 * Note: The AMLFileName parameter for DefinitionBlock is left as a NULL 669 * string. This allows the compiler to create the output AML filename from 670 * the input filename. 671 * 672 ******************************************************************************/ 673 674 static int 675 DtEmitDefinitionBlock ( 676 FILE *File, 677 char *Filename, 678 char *Signature, 679 UINT32 Instance) 680 { 681 int Status; 682 683 684 Status = fprintf (File, 685 "DefinitionBlock (\"\", \"%4.4s\", 2, \"Intel\", \"_%4.4s_%.2X\", 0x00000001)\n" 686 "{\n" 687 " Method (%2.2s%.2X)\n" 688 " {\n" 689 " }\n" 690 "}\n\n", 691 Signature, Signature, Instance, Signature, Instance); 692 693 if (Status < 0) 694 { 695 fprintf (stderr, 696 "Could not write %4.4s to output file %s\n", 697 Signature, Filename); 698 } 699 700 return (Status); 701 } 702