123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615 |
- /******************************************************************************
- *
- * Module Name: acfileio - Get ACPI tables from file
- *
- *****************************************************************************/
- /******************************************************************************
- *
- * 1. Copyright Notice
- *
- * Some or all of this work - Copyright (c) 1999 - 2016, Intel Corp.
- * All rights reserved.
- *
- * 2. License
- *
- * 2.1. This is your license from Intel Corp. under its intellectual property
- * rights. You may have additional license terms from the party that provided
- * you this software, covering your right to use that party's intellectual
- * property rights.
- *
- * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
- * copy of the source code appearing in this file ("Covered Code") an
- * irrevocable, perpetual, worldwide license under Intel's copyrights in the
- * base code distributed originally by Intel ("Original Intel Code") to copy,
- * make derivatives, distribute, use and display any portion of the Covered
- * Code in any form, with the right to sublicense such rights; and
- *
- * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
- * license (with the right to sublicense), under only those claims of Intel
- * patents that are infringed by the Original Intel Code, to make, use, sell,
- * offer to sell, and import the Covered Code and derivative works thereof
- * solely to the minimum extent necessary to exercise the above copyright
- * license, and in no event shall the patent license extend to any additions
- * to or modifications of the Original Intel Code. No other license or right
- * is granted directly or by implication, estoppel or otherwise;
- *
- * The above copyright and patent license is granted only if the following
- * conditions are met:
- *
- * 3. Conditions
- *
- * 3.1. Redistribution of Source with Rights to Further Distribute Source.
- * Redistribution of source code of any substantial portion of the Covered
- * Code or modification with rights to further distribute source must include
- * the above Copyright Notice, the above License, this list of Conditions,
- * and the following Disclaimer and Export Compliance provision. In addition,
- * Licensee must cause all Covered Code to which Licensee contributes to
- * contain a file documenting the changes Licensee made to create that Covered
- * Code and the date of any change. Licensee must include in that file the
- * documentation of any changes made by any predecessor Licensee. Licensee
- * must include a prominent statement that the modification is derived,
- * directly or indirectly, from Original Intel Code.
- *
- * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
- * Redistribution of source code of any substantial portion of the Covered
- * Code or modification without rights to further distribute source must
- * include the following Disclaimer and Export Compliance provision in the
- * documentation and/or other materials provided with distribution. In
- * addition, Licensee may not authorize further sublicense of source of any
- * portion of the Covered Code, and must include terms to the effect that the
- * license from Licensee to its licensee is limited to the intellectual
- * property embodied in the software Licensee provides to its licensee, and
- * not to intellectual property embodied in modifications its licensee may
- * make.
- *
- * 3.3. Redistribution of Executable. Redistribution in executable form of any
- * substantial portion of the Covered Code or modification must reproduce the
- * above Copyright Notice, and the following Disclaimer and Export Compliance
- * provision in the documentation and/or other materials provided with the
- * distribution.
- *
- * 3.4. Intel retains all right, title, and interest in and to the Original
- * Intel Code.
- *
- * 3.5. Neither the name Intel nor any other trademark owned or controlled by
- * Intel shall be used in advertising or otherwise to promote the sale, use or
- * other dealings in products derived from or relating to the Covered Code
- * without prior written authorization from Intel.
- *
- * 4. Disclaimer and Export Compliance
- *
- * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
- * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
- * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
- * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
- * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
- * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
- * PARTICULAR PURPOSE.
- *
- * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
- * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
- * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
- * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
- * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
- * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
- * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
- * LIMITED REMEDY.
- *
- * 4.3. Licensee shall not export, either directly or indirectly, any of this
- * software or system incorporating such software without first obtaining any
- * required license or other approval from the U. S. Department of Commerce or
- * any other agency or department of the United States Government. In the
- * event Licensee exports any such software from the United States or
- * re-exports any such software from a foreign destination, Licensee shall
- * ensure that the distribution and export/re-export of the software is in
- * compliance with all laws, regulations, orders, or other restrictions of the
- * U.S. Export Administration Regulations. Licensee agrees that neither it nor
- * any of its subsidiaries will export/re-export any technical data, process,
- * software, or service, directly or indirectly, to any country for which the
- * United States government or any agency thereof requires an export license,
- * other governmental approval, or letter of assurance, without first obtaining
- * such license, approval or letter.
- *
- *****************************************************************************/
- #include "acpi.h"
- #include "accommon.h"
- #include "acapps.h"
- #include "actables.h"
- #include "acutils.h"
- #define _COMPONENT ACPI_UTILITIES
- ACPI_MODULE_NAME ("acfileio")
- /* Local prototypes */
- static ACPI_STATUS
- AcGetOneTableFromFile (
- char *Filename,
- FILE *File,
- UINT8 GetOnlyAmlTables,
- ACPI_TABLE_HEADER **Table);
- static ACPI_STATUS
- AcCheckTextModeCorruption (
- ACPI_TABLE_HEADER *Table);
- /*******************************************************************************
- *
- * FUNCTION: AcGetAllTablesFromFile
- *
- * PARAMETERS: Filename - Table filename
- * GetOnlyAmlTables - TRUE if the tables must be AML tables
- * ReturnListHead - Where table list is returned
- *
- * RETURN: Status
- *
- * DESCRIPTION: Get all ACPI tables from within a single file.
- *
- ******************************************************************************/
- ACPI_STATUS
- AcGetAllTablesFromFile (
- char *Filename,
- UINT8 GetOnlyAmlTables,
- ACPI_NEW_TABLE_DESC **ReturnListHead)
- {
- #if 0
- ACPI_NEW_TABLE_DESC *ListHead = NULL;
- ACPI_NEW_TABLE_DESC *ListTail = NULL;
- ACPI_NEW_TABLE_DESC *TableDesc;
- FILE *File;
- ACPI_TABLE_HEADER *Table = NULL;
- UINT32 FileSize;
- ACPI_STATUS Status = AE_OK;
- File = fopen (Filename, "rb");
- if (!File)
- {
- perror ("Could not open input file");
- if (errno == ENOENT)
- {
- return (AE_NOT_EXIST);
- }
- return (AE_ERROR);
- }
- /* Get the file size */
- FileSize = CmGetFileSize (File);
- if (FileSize == ACPI_UINT32_MAX)
- {
- Status = AE_ERROR;
- goto ErrorExit;
- }
- fprintf (stderr,
- "Input file %s, Length 0x%X (%u) bytes\n",
- Filename, FileSize, FileSize);
- /* We must have at least one ACPI table header */
- if (FileSize < sizeof (ACPI_TABLE_HEADER))
- {
- Status = AE_BAD_HEADER;
- goto ErrorExit;
- }
- /* Check for an non-binary file */
- if (!AcIsFileBinary (File))
- {
- fprintf (stderr,
- " %s: File does not appear to contain a valid AML table\n",
- Filename);
- return (AE_TYPE);
- }
- /* Read all tables within the file */
- while (ACPI_SUCCESS (Status))
- {
- /* Get one entire ACPI table */
- Status = AcGetOneTableFromFile (
- Filename, File, GetOnlyAmlTables, &Table);
- if (Status == AE_CTRL_TERMINATE)
- {
- Status = AE_OK;
- break;
- }
- else if (Status == AE_TYPE)
- {
- return (AE_OK);
- }
- else if (ACPI_FAILURE (Status))
- {
- goto ErrorExit;
- }
- /* Print table header for iASL/disassembler only */
- #ifdef ACPI_ASL_COMPILER
- AcpiTbPrintTableHeader (0, Table);
- #endif
- /* Allocate and link a table descriptor */
- TableDesc = AcpiOsAllocate (sizeof (ACPI_NEW_TABLE_DESC));
- TableDesc->Table = Table;
- TableDesc->Next = NULL;
- /* Link at the end of the local table list */
- if (!ListHead)
- {
- ListHead = TableDesc;
- ListTail = TableDesc;
- }
- else
- {
- ListTail->Next = TableDesc;
- ListTail = TableDesc;
- }
- }
- /* Add the local table list to the end of the global list */
- if (*ReturnListHead)
- {
- ListTail = *ReturnListHead;
- while (ListTail->Next)
- {
- ListTail = ListTail->Next;
- }
- ListTail->Next = ListHead;
- }
- else
- {
- *ReturnListHead = ListHead;
- }
- ErrorExit:
- fclose(File);
- return (Status);
- #endif
- sysfatal("Panic can't do this");
- return AE_OK;
- }
- #if 0
- /*******************************************************************************
- *
- * FUNCTION: AcGetOneTableFromFile
- *
- * PARAMETERS: Filename - File where table is located
- * File - Open FILE pointer to Filename
- * GetOnlyAmlTables - TRUE if the tables must be AML tables.
- * ReturnTable - Where a pointer to the table is returned
- *
- * RETURN: Status
- *
- * DESCRIPTION: Read the next ACPI table from a file. Implements support
- * for multiple tables within a single file. File must already
- * be open.
- *
- * Note: Loading an RSDP is not supported.
- *
- ******************************************************************************/
- static ACPI_STATUS
- AcGetOneTableFromFile (
- char *Filename,
- FILE *File,
- UINT8 GetOnlyAmlTables,
- ACPI_TABLE_HEADER **ReturnTable)
- {
- ACPI_STATUS Status = AE_OK;
- ACPI_TABLE_HEADER TableHeader;
- ACPI_TABLE_HEADER *Table;
- INT32 Count;
- long TableOffset;
- *ReturnTable = NULL;
- /* Get the table header to examine signature and length */
- TableOffset = ftell (File);
- Count = fread (&TableHeader, 1, sizeof (ACPI_TABLE_HEADER), File);
- if (Count != sizeof (ACPI_TABLE_HEADER))
- {
- return (AE_CTRL_TERMINATE);
- }
- /* Validate the table signature/header (limited ASCII chars) */
- Status = AcValidateTableHeader (File, TableOffset);
- if (ACPI_FAILURE (Status))
- {
- return (Status);
- }
- if (GetOnlyAmlTables)
- {
- /* Table must be an AML table (DSDT/SSDT) or FADT */
- if (!ACPI_COMPARE_NAME (TableHeader.Signature, ACPI_SIG_FADT) &&
- !AcpiUtIsAmlTable (&TableHeader))
- {
- fprintf (stderr,
- " %s: Table [%4.4s] is not an AML table - ignoring\n",
- Filename, TableHeader.Signature);
- return (AE_TYPE);
- }
- }
- /* Allocate a buffer for the entire table */
- Table = AcpiOsAllocate ((size_t) TableHeader.Length);
- if (!Table)
- {
- return (AE_NO_MEMORY);
- }
- /* Read the entire ACPI table, including header */
- fseek (File, TableOffset, SEEK_SET);
- Count = fread (Table, 1, TableHeader.Length, File);
- if (Count != (INT32) TableHeader.Length)
- {
- Status = AE_ERROR;
- goto ErrorExit;
- }
- /* Validate the checksum (just issue a warning) */
- Status = AcpiTbVerifyChecksum (Table, TableHeader.Length);
- if (ACPI_FAILURE (Status))
- {
- Status = AcCheckTextModeCorruption (Table);
- if (ACPI_FAILURE (Status))
- {
- goto ErrorExit;
- }
- }
- *ReturnTable = Table;
- return (AE_OK);
- ErrorExit:
- AcpiOsFree (Table);
- return (Status);
- }
- /*******************************************************************************
- *
- * FUNCTION: AcIsFileBinary
- *
- * PARAMETERS: File - Open input file
- *
- * RETURN: TRUE if file appears to be binary
- *
- * DESCRIPTION: Scan a file for any non-ASCII bytes.
- *
- * Note: Maintains current file position.
- *
- ******************************************************************************/
- BOOLEAN
- AcIsFileBinary (
- FILE *File)
- {
- UINT8 Byte;
- BOOLEAN IsBinary = FALSE;
- long FileOffset;
- /* Scan entire file for any non-ASCII bytes */
- FileOffset = ftell (File);
- while (fread (&Byte, 1, 1, File) == 1)
- {
- if (!isprint (Byte) && !isspace (Byte))
- {
- IsBinary = TRUE;
- goto Exit;
- }
- }
- Exit:
- fseek (File, FileOffset, SEEK_SET);
- return (IsBinary);
- }
- /*******************************************************************************
- *
- * FUNCTION: AcValidateTableHeader
- *
- * PARAMETERS: File - Open input file
- *
- * RETURN: Status
- *
- * DESCRIPTION: Determine if a file seems to contain one or more binary ACPI
- * tables, via the
- * following checks on what would be the table header:
- * 1) File must be at least as long as an ACPI_TABLE_HEADER
- * 2) There must be enough room in the file to hold entire table
- * 3) Signature, OemId, OemTableId, AslCompilerId must be ASCII
- *
- * Note: There can be multiple definition blocks per file, so we cannot
- * expect/compare the file size to be equal to the table length. 12/2015.
- *
- * Note: Maintains current file position.
- *
- ******************************************************************************/
- ACPI_STATUS
- AcValidateTableHeader (
- FILE *File,
- long TableOffset)
- {
- ACPI_TABLE_HEADER TableHeader;
- size_t Actual;
- long OriginalOffset;
- UINT32 FileSize;
- UINT32 i;
- ACPI_FUNCTION_TRACE ("AcValidateTableHeader");
- /* Read a potential table header */
- OriginalOffset = ftell (File);
- fseek (File, TableOffset, SEEK_SET);
- Actual = fread (&TableHeader, 1, sizeof (ACPI_TABLE_HEADER), File);
- fseek (File, OriginalOffset, SEEK_SET);
- if (Actual < sizeof (ACPI_TABLE_HEADER))
- {
- return (AE_ERROR);
- }
- /* Validate the signature (limited ASCII chars) */
- if (!AcpiUtValidNameseg (TableHeader.Signature))
- {
- fprintf (stderr, "Invalid table signature: 0x%8.8X\n",
- *ACPI_CAST_PTR (UINT32, TableHeader.Signature));
- return (AE_BAD_SIGNATURE);
- }
- /* Validate table length against bytes remaining in the file */
- FileSize = CmGetFileSize (File);
- if (TableHeader.Length > (UINT32) (FileSize - TableOffset))
- {
- fprintf (stderr, "Table [%4.4s] is too long for file - "
- "needs: 0x%.2X, remaining in file: 0x%.2X\n",
- TableHeader.Signature, TableHeader.Length,
- (UINT32) (FileSize - TableOffset));
- return (AE_BAD_HEADER);
- }
- /*
- * These fields must be ASCII: OemId, OemTableId, AslCompilerId.
- * We allow a NULL terminator in OemId and OemTableId.
- */
- for (i = 0; i < ACPI_NAME_SIZE; i++)
- {
- if (!ACPI_IS_ASCII ((UINT8) TableHeader.AslCompilerId[i]))
- {
- goto BadCharacters;
- }
- }
- for (i = 0; (i < ACPI_OEM_ID_SIZE) && (TableHeader.OemId[i]); i++)
- {
- if (!ACPI_IS_ASCII ((UINT8) TableHeader.OemId[i]))
- {
- goto BadCharacters;
- }
- }
- for (i = 0; (i < ACPI_OEM_TABLE_ID_SIZE) && (TableHeader.OemTableId[i]); i++)
- {
- if (!ACPI_IS_ASCII ((UINT8) TableHeader.OemTableId[i]))
- {
- goto BadCharacters;
- }
- }
- return (AE_OK);
- BadCharacters:
- ACPI_WARNING ((AE_INFO,
- "Table header for [%4.4s] has invalid ASCII character(s)",
- TableHeader.Signature));
- return (AE_OK);
- }
- /*******************************************************************************
- *
- * FUNCTION: AcCheckTextModeCorruption
- *
- * PARAMETERS: Table - Table buffer starting with table header
- *
- * RETURN: Status
- *
- * DESCRIPTION: Check table for text mode file corruption where all linefeed
- * characters (LF) have been replaced by carriage return linefeed
- * pairs (CR/LF).
- *
- ******************************************************************************/
- static ACPI_STATUS
- AcCheckTextModeCorruption (
- ACPI_TABLE_HEADER *Table)
- {
- UINT32 i;
- UINT32 Pairs = 0;
- UINT8 *Buffer = ACPI_CAST_PTR (UINT8, Table);
- /* Scan entire table to determine if each LF has been prefixed with a CR */
- for (i = 1; i < Table->Length; i++)
- {
- if (Buffer[i] == 0x0A)
- {
- if (Buffer[i - 1] != 0x0D)
- {
- /* The LF does not have a preceding CR, table not corrupted */
- return (AE_OK);
- }
- else
- {
- /* Found a CR/LF pair */
- Pairs++;
- }
- i++;
- }
- }
- if (!Pairs)
- {
- return (AE_OK);
- }
- /*
- * Entire table scanned, each CR is part of a CR/LF pair --
- * meaning that the table was treated as a text file somewhere.
- *
- * NOTE: We can't "fix" the table, because any existing CR/LF pairs in the
- * original table are left untouched by the text conversion process --
- * meaning that we cannot simply replace CR/LF pairs with LFs.
- */
- AcpiOsPrintf ("Table has been corrupted by text mode conversion\n");
- AcpiOsPrintf ("All LFs (%u) were changed to CR/LF pairs\n", Pairs);
- AcpiOsPrintf ("Table cannot be repaired!\n");
- return (AE_BAD_VALUE);
- }
- #endif
|