1 /****************************************************************************** 2 * 3 * Module Name: acfileio - Get ACPI tables from file 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2020, 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/include/acpi.h> 153 #include <contrib/dev/acpica/include/accommon.h> 154 #include <contrib/dev/acpica/include/actables.h> 155 #include <contrib/dev/acpica/include/acutils.h> 156 #include <contrib/dev/acpica/include/acapps.h> 157 158 #define _COMPONENT ACPI_UTILITIES 159 ACPI_MODULE_NAME ("acfileio") 160 161 162 /* Local prototypes */ 163 164 static ACPI_STATUS 165 AcGetOneTableFromFile ( 166 char *Filename, 167 FILE *File, 168 UINT8 GetOnlyAmlTables, 169 ACPI_TABLE_HEADER **Table); 170 171 static ACPI_STATUS 172 AcCheckTextModeCorruption ( 173 ACPI_TABLE_HEADER *Table); 174 175 176 /******************************************************************************* 177 * 178 * FUNCTION: AcDeleteTableList 179 * 180 * PARAMETERS: ListHead - List to delete 181 * 182 * RETURN: Status 183 * 184 * DESCRIPTION: Delete a list of tables. This is useful for removing memory 185 * allocated by AcGetAllTablesFromFile 186 * 187 ******************************************************************************/ 188 189 void 190 AcDeleteTableList ( 191 ACPI_NEW_TABLE_DESC *ListHead) 192 { 193 ACPI_NEW_TABLE_DESC *Current = ListHead; 194 ACPI_NEW_TABLE_DESC *Previous = Current; 195 196 197 while (Current) 198 { 199 Current = Current->Next; 200 AcpiOsFree (Previous); 201 Previous = Current; 202 } 203 } 204 205 206 /******************************************************************************* 207 * 208 * FUNCTION: AcGetAllTablesFromFile 209 * 210 * PARAMETERS: Filename - Table filename 211 * GetOnlyAmlTables - TRUE if the tables must be AML tables 212 * ReturnListHead - Where table list is returned 213 * 214 * RETURN: Status 215 * 216 * DESCRIPTION: Get all ACPI tables from within a single file. 217 * 218 ******************************************************************************/ 219 220 ACPI_STATUS 221 AcGetAllTablesFromFile ( 222 char *Filename, 223 UINT8 GetOnlyAmlTables, 224 ACPI_NEW_TABLE_DESC **ReturnListHead) 225 { 226 ACPI_NEW_TABLE_DESC *ListHead = NULL; 227 ACPI_NEW_TABLE_DESC *ListTail = NULL; 228 ACPI_NEW_TABLE_DESC *TableDesc; 229 FILE *File; 230 ACPI_TABLE_HEADER *Table = NULL; 231 UINT32 FileSize; 232 ACPI_STATUS Status = AE_OK; 233 234 235 File = fopen (Filename, "rb"); 236 if (!File) 237 { 238 fprintf (stderr, "Could not open input file: %s\n", Filename); 239 if (errno == ENOENT) 240 { 241 return (AE_NOT_EXIST); 242 } 243 244 return (AE_ERROR); 245 } 246 247 /* Get the file size */ 248 249 FileSize = CmGetFileSize (File); 250 if (FileSize == ACPI_UINT32_MAX) 251 { 252 Status = AE_ERROR; 253 goto Exit; 254 } 255 256 fprintf (stderr, 257 "Input file %s, Length 0x%X (%u) bytes\n", 258 Filename, FileSize, FileSize); 259 260 /* We must have at least one ACPI table header */ 261 262 if (FileSize < sizeof (ACPI_TABLE_HEADER)) 263 { 264 Status = AE_BAD_HEADER; 265 goto Exit; 266 } 267 268 /* Check for an non-binary file */ 269 270 if (!AcIsFileBinary (File)) 271 { 272 fprintf (stderr, 273 " %s: File does not appear to contain a valid AML table\n", 274 Filename); 275 Status = AE_TYPE; 276 goto Exit; 277 } 278 279 /* Read all tables within the file */ 280 281 while (ACPI_SUCCESS (Status)) 282 { 283 /* Get one entire ACPI table */ 284 285 Status = AcGetOneTableFromFile ( 286 Filename, File, GetOnlyAmlTables, &Table); 287 288 if (Status == AE_CTRL_TERMINATE) 289 { 290 Status = AE_OK; 291 break; 292 } 293 else if (Status == AE_TYPE) 294 { 295 Status = AE_OK; 296 goto Exit; 297 } 298 else if (ACPI_FAILURE (Status)) 299 { 300 goto Exit; 301 } 302 303 /* Print table header for iASL/disassembler only */ 304 305 #ifdef ACPI_ASL_COMPILER 306 307 AcpiTbPrintTableHeader (0, Table); 308 #endif 309 310 /* Allocate and link a table descriptor */ 311 312 TableDesc = AcpiOsAllocate (sizeof (ACPI_NEW_TABLE_DESC)); 313 if (!TableDesc) 314 { 315 AcpiOsFree (Table); 316 Status = AE_NO_MEMORY; 317 goto Exit; 318 } 319 320 TableDesc->Table = Table; 321 TableDesc->Next = NULL; 322 323 /* Link at the end of the local table list */ 324 325 if (!ListHead) 326 { 327 ListHead = TableDesc; 328 ListTail = TableDesc; 329 } 330 else 331 { 332 ListTail->Next = TableDesc; 333 ListTail = TableDesc; 334 } 335 } 336 337 /* Add the local table list to the end of the global list */ 338 339 if (*ReturnListHead) 340 { 341 ListTail = *ReturnListHead; 342 while (ListTail->Next) 343 { 344 ListTail = ListTail->Next; 345 } 346 347 ListTail->Next = ListHead; 348 } 349 else 350 { 351 *ReturnListHead = ListHead; 352 } 353 354 Exit: 355 fclose(File); 356 return (Status); 357 } 358 359 360 /******************************************************************************* 361 * 362 * FUNCTION: AcGetOneTableFromFile 363 * 364 * PARAMETERS: Filename - File where table is located 365 * File - Open FILE pointer to Filename 366 * GetOnlyAmlTables - TRUE if the tables must be AML tables. 367 * ReturnTable - Where a pointer to the table is returned 368 * 369 * RETURN: Status 370 * 371 * DESCRIPTION: Read the next ACPI table from a file. Implements support 372 * for multiple tables within a single file. File must already 373 * be open. 374 * 375 * Note: Loading an RSDP is not supported. 376 * 377 ******************************************************************************/ 378 379 static ACPI_STATUS 380 AcGetOneTableFromFile ( 381 char *Filename, 382 FILE *File, 383 UINT8 GetOnlyAmlTables, 384 ACPI_TABLE_HEADER **ReturnTable) 385 { 386 ACPI_STATUS Status = AE_OK; 387 ACPI_TABLE_HEADER TableHeader; 388 ACPI_TABLE_HEADER *Table; 389 INT32 Count; 390 long TableOffset; 391 392 393 *ReturnTable = NULL; 394 395 /* Get the table header to examine signature and length */ 396 397 TableOffset = ftell (File); 398 Count = fread (&TableHeader, 1, sizeof (ACPI_TABLE_HEADER), File); 399 if (Count != sizeof (ACPI_TABLE_HEADER)) 400 { 401 return (AE_CTRL_TERMINATE); 402 } 403 404 if (GetOnlyAmlTables) 405 { 406 /* Validate the table signature/header (limited ASCII chars) */ 407 408 Status = AcValidateTableHeader (File, TableOffset); 409 if (ACPI_FAILURE (Status)) 410 { 411 return (Status); 412 } 413 414 /* 415 * Table must be an AML table (DSDT/SSDT). 416 * Used for iASL -e option only. 417 */ 418 if (!AcpiUtIsAmlTable (&TableHeader)) 419 { 420 fprintf (stderr, 421 " %s: Table [%4.4s] is not an AML table - ignoring\n", 422 Filename, TableHeader.Signature); 423 424 return (AE_TYPE); 425 } 426 } 427 428 /* Allocate a buffer for the entire table */ 429 430 Table = AcpiOsAllocate ((ACPI_SIZE) TableHeader.Length); 431 if (!Table) 432 { 433 return (AE_NO_MEMORY); 434 } 435 436 /* Read the entire ACPI table, including header */ 437 438 fseek (File, TableOffset, SEEK_SET); 439 440 Count = fread (Table, 1, TableHeader.Length, File); 441 442 /* 443 * Checks for data table headers happen later in the execution. Only verify 444 * for Aml tables at this point in the code. 445 */ 446 if (GetOnlyAmlTables && Count != (INT32) TableHeader.Length) 447 { 448 Status = AE_ERROR; 449 goto ErrorExit; 450 } 451 452 /* Validate the checksum (just issue a warning) */ 453 454 Status = AcpiTbVerifyChecksum (Table, TableHeader.Length); 455 if (ACPI_FAILURE (Status)) 456 { 457 Status = AcCheckTextModeCorruption (Table); 458 if (ACPI_FAILURE (Status)) 459 { 460 goto ErrorExit; 461 } 462 } 463 464 *ReturnTable = Table; 465 return (AE_OK); 466 467 468 ErrorExit: 469 AcpiOsFree (Table); 470 return (Status); 471 } 472 473 474 /******************************************************************************* 475 * 476 * FUNCTION: AcIsFileBinary 477 * 478 * PARAMETERS: File - Open input file 479 * 480 * RETURN: TRUE if file appears to be binary 481 * 482 * DESCRIPTION: Scan a file for any non-ASCII bytes. 483 * 484 * Note: Maintains current file position. 485 * 486 ******************************************************************************/ 487 488 BOOLEAN 489 AcIsFileBinary ( 490 FILE *File) 491 { 492 UINT8 Byte; 493 BOOLEAN IsBinary = FALSE; 494 long FileOffset; 495 496 497 /* Scan entire file for any non-ASCII bytes */ 498 499 FileOffset = ftell (File); 500 while (fread (&Byte, 1, 1, File) == 1) 501 { 502 if (!isprint (Byte) && !isspace (Byte)) 503 { 504 IsBinary = TRUE; 505 goto Exit; 506 } 507 } 508 509 Exit: 510 fseek (File, FileOffset, SEEK_SET); 511 return (IsBinary); 512 } 513 514 515 /******************************************************************************* 516 * 517 * FUNCTION: AcValidateTableHeader 518 * 519 * PARAMETERS: File - Open input file 520 * 521 * RETURN: Status 522 * 523 * DESCRIPTION: Determine if a file seems to contain one or more binary ACPI 524 * tables, via the 525 * following checks on what would be the table header: 526 * 1) File must be at least as long as an ACPI_TABLE_HEADER 527 * 2) There must be enough room in the file to hold entire table 528 * 3) Signature, OemId, OemTableId, AslCompilerId must be ASCII 529 * 530 * Note: There can be multiple definition blocks per file, so we cannot 531 * expect/compare the file size to be equal to the table length. 12/2015. 532 * 533 * Note: Maintains current file position. 534 * 535 ******************************************************************************/ 536 537 ACPI_STATUS 538 AcValidateTableHeader ( 539 FILE *File, 540 long TableOffset) 541 { 542 ACPI_TABLE_HEADER TableHeader; 543 ACPI_SIZE Actual; 544 long OriginalOffset; 545 UINT32 FileSize; 546 UINT32 i; 547 548 549 ACPI_FUNCTION_TRACE (AcValidateTableHeader); 550 551 552 /* Read a potential table header */ 553 554 OriginalOffset = ftell (File); 555 fseek (File, TableOffset, SEEK_SET); 556 557 Actual = fread (&TableHeader, 1, sizeof (ACPI_TABLE_HEADER), File); 558 fseek (File, OriginalOffset, SEEK_SET); 559 560 if (Actual < sizeof (ACPI_TABLE_HEADER)) 561 { 562 return (AE_ERROR); 563 } 564 565 /* Validate the signature (limited ASCII chars) */ 566 567 if (!AcpiUtValidNameseg (TableHeader.Signature)) 568 { 569 return (AE_BAD_SIGNATURE); 570 } 571 572 /* Validate table length against bytes remaining in the file */ 573 574 FileSize = CmGetFileSize (File); 575 if (TableHeader.Length > (UINT32) (FileSize - TableOffset)) 576 { 577 fprintf (stderr, "Table [%4.4s] is too long for file - " 578 "needs: 0x%.2X, remaining in file: 0x%.2X\n", 579 TableHeader.Signature, TableHeader.Length, 580 (UINT32) (FileSize - TableOffset)); 581 return (AE_BAD_HEADER); 582 } 583 584 /* 585 * These fields must be ASCII: OemId, OemTableId, AslCompilerId. 586 * We allow a NULL terminator in OemId and OemTableId. 587 */ 588 for (i = 0; i < ACPI_NAMESEG_SIZE; i++) 589 { 590 if (!ACPI_IS_ASCII ((UINT8) TableHeader.AslCompilerId[i])) 591 { 592 goto BadCharacters; 593 } 594 } 595 596 for (i = 0; (i < ACPI_OEM_ID_SIZE) && (TableHeader.OemId[i]); i++) 597 { 598 if (!ACPI_IS_ASCII ((UINT8) TableHeader.OemId[i])) 599 { 600 goto BadCharacters; 601 } 602 } 603 604 for (i = 0; (i < ACPI_OEM_TABLE_ID_SIZE) && (TableHeader.OemTableId[i]); i++) 605 { 606 if (!ACPI_IS_ASCII ((UINT8) TableHeader.OemTableId[i])) 607 { 608 goto BadCharacters; 609 } 610 } 611 612 return (AE_OK); 613 614 615 BadCharacters: 616 617 ACPI_WARNING ((AE_INFO, 618 "Table header for [%4.4s] has invalid ASCII character(s)", 619 TableHeader.Signature)); 620 return (AE_OK); 621 } 622 623 624 /******************************************************************************* 625 * 626 * FUNCTION: AcCheckTextModeCorruption 627 * 628 * PARAMETERS: Table - Table buffer starting with table header 629 * 630 * RETURN: Status 631 * 632 * DESCRIPTION: Check table for text mode file corruption where all linefeed 633 * characters (LF) have been replaced by carriage return linefeed 634 * pairs (CR/LF). 635 * 636 ******************************************************************************/ 637 638 static ACPI_STATUS 639 AcCheckTextModeCorruption ( 640 ACPI_TABLE_HEADER *Table) 641 { 642 UINT32 i; 643 UINT32 Pairs = 0; 644 UINT8 *Buffer = ACPI_CAST_PTR (UINT8, Table); 645 646 647 /* Scan entire table to determine if each LF has been prefixed with a CR */ 648 649 for (i = 1; i < Table->Length; i++) 650 { 651 if (Buffer[i] == 0x0A) 652 { 653 if (Buffer[i - 1] != 0x0D) 654 { 655 /* The LF does not have a preceding CR, table not corrupted */ 656 657 return (AE_OK); 658 } 659 else 660 { 661 /* Found a CR/LF pair */ 662 663 Pairs++; 664 } 665 666 i++; 667 } 668 } 669 670 if (!Pairs) 671 { 672 return (AE_OK); 673 } 674 675 /* 676 * Entire table scanned, each CR is part of a CR/LF pair -- 677 * meaning that the table was treated as a text file somewhere. 678 * 679 * NOTE: We can't "fix" the table, because any existing CR/LF pairs in the 680 * original table are left untouched by the text conversion process -- 681 * meaning that we cannot simply replace CR/LF pairs with LFs. 682 */ 683 AcpiOsPrintf ("Table has been corrupted by text mode conversion\n"); 684 AcpiOsPrintf ("All LFs (%u) were changed to CR/LF pairs\n", Pairs); 685 AcpiOsPrintf ("Table cannot be repaired!\n"); 686 687 return (AE_BAD_VALUE); 688 } 689