1 /******************************************************************************
3 * Module Name: acfileio - Get ACPI tables from file
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2016, 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 #include <contrib/dev/acpica/include/acpi.h>
45 #include <contrib/dev/acpica/include/accommon.h>
46 #include <contrib/dev/acpica/include/acapps.h>
47 #include <contrib/dev/acpica/include/actables.h>
48 #include <contrib/dev/acpica/include/acutils.h>
51 #define _COMPONENT ACPI_UTILITIES
52 ACPI_MODULE_NAME ("acfileio")
55 /* Local prototypes */
58 AcGetOneTableFromFile (
61 UINT8 GetOnlyAmlTables,
62 ACPI_TABLE_HEADER **Table);
65 AcCheckTextModeCorruption (
66 ACPI_TABLE_HEADER *Table);
69 /*******************************************************************************
71 * FUNCTION: AcGetAllTablesFromFile
73 * PARAMETERS: Filename - Table filename
74 * GetOnlyAmlTables - TRUE if the tables must be AML tables
75 * ReturnListHead - Where table list is returned
79 * DESCRIPTION: Get all ACPI tables from within a single file.
81 ******************************************************************************/
84 AcGetAllTablesFromFile (
86 UINT8 GetOnlyAmlTables,
87 ACPI_NEW_TABLE_DESC **ReturnListHead)
89 ACPI_NEW_TABLE_DESC *ListHead = NULL;
90 ACPI_NEW_TABLE_DESC *ListTail = NULL;
91 ACPI_NEW_TABLE_DESC *TableDesc;
93 ACPI_TABLE_HEADER *Table = NULL;
95 ACPI_STATUS Status = AE_OK;
98 File = fopen (Filename, "rb");
101 perror ("Could not open input file");
104 return (AE_NOT_EXIST);
110 /* Get the file size */
112 FileSize = CmGetFileSize (File);
113 if (FileSize == ACPI_UINT32_MAX)
120 "Input file %s, Length 0x%X (%u) bytes\n",
121 Filename, FileSize, FileSize);
123 /* We must have at least one ACPI table header */
125 if (FileSize < sizeof (ACPI_TABLE_HEADER))
127 Status = AE_BAD_HEADER;
131 /* Check for an non-binary file */
133 if (!AcIsFileBinary (File))
136 " %s: File does not appear to contain a valid AML table\n",
141 /* Read all tables within the file */
143 while (ACPI_SUCCESS (Status))
145 /* Get one entire ACPI table */
147 Status = AcGetOneTableFromFile (
148 Filename, File, GetOnlyAmlTables, &Table);
150 if (Status == AE_CTRL_TERMINATE)
155 else if (Status == AE_TYPE)
159 else if (ACPI_FAILURE (Status))
164 /* Print table header for iASL/disassembler only */
166 #ifdef ACPI_ASL_COMPILER
168 AcpiTbPrintTableHeader (0, Table);
171 /* Allocate and link a table descriptor */
173 TableDesc = AcpiOsAllocate (sizeof (ACPI_NEW_TABLE_DESC));
174 TableDesc->Table = Table;
175 TableDesc->Next = NULL;
177 /* Link at the end of the local table list */
181 ListHead = TableDesc;
182 ListTail = TableDesc;
186 ListTail->Next = TableDesc;
187 ListTail = TableDesc;
191 /* Add the local table list to the end of the global list */
195 ListTail = *ReturnListHead;
196 while (ListTail->Next)
198 ListTail = ListTail->Next;
201 ListTail->Next = ListHead;
205 *ReturnListHead = ListHead;
214 /*******************************************************************************
216 * FUNCTION: AcGetOneTableFromFile
218 * PARAMETERS: Filename - File where table is located
219 * File - Open FILE pointer to Filename
220 * GetOnlyAmlTables - TRUE if the tables must be AML tables.
221 * ReturnTable - Where a pointer to the table is returned
225 * DESCRIPTION: Read the next ACPI table from a file. Implements support
226 * for multiple tables within a single file. File must already
229 * Note: Loading an RSDP is not supported.
231 ******************************************************************************/
234 AcGetOneTableFromFile (
237 UINT8 GetOnlyAmlTables,
238 ACPI_TABLE_HEADER **ReturnTable)
240 ACPI_STATUS Status = AE_OK;
241 ACPI_TABLE_HEADER TableHeader;
242 ACPI_TABLE_HEADER *Table;
249 /* Get the table header to examine signature and length */
251 TableOffset = ftell (File);
252 Count = fread (&TableHeader, 1, sizeof (ACPI_TABLE_HEADER), File);
253 if (Count != sizeof (ACPI_TABLE_HEADER))
255 return (AE_CTRL_TERMINATE);
258 /* Validate the table signature/header (limited ASCII chars) */
260 Status = AcValidateTableHeader (File, TableOffset);
261 if (ACPI_FAILURE (Status))
266 if (GetOnlyAmlTables)
268 /* Table must be an AML table (DSDT/SSDT) or FADT */
270 if (!ACPI_COMPARE_NAME (TableHeader.Signature, ACPI_SIG_FADT) &&
271 !AcpiUtIsAmlTable (&TableHeader))
274 " %s: Table [%4.4s] is not an AML table - ignoring\n",
275 Filename, TableHeader.Signature);
281 /* Allocate a buffer for the entire table */
283 Table = AcpiOsAllocate ((size_t) TableHeader.Length);
286 return (AE_NO_MEMORY);
289 /* Read the entire ACPI table, including header */
291 fseek (File, TableOffset, SEEK_SET);
293 Count = fread (Table, 1, TableHeader.Length, File);
294 if (Count != (INT32) TableHeader.Length)
300 /* Validate the checksum (just issue a warning) */
302 Status = AcpiTbVerifyChecksum (Table, TableHeader.Length);
303 if (ACPI_FAILURE (Status))
305 Status = AcCheckTextModeCorruption (Table);
306 if (ACPI_FAILURE (Status))
312 *ReturnTable = Table;
322 /*******************************************************************************
324 * FUNCTION: AcIsFileBinary
326 * PARAMETERS: File - Open input file
328 * RETURN: TRUE if file appears to be binary
330 * DESCRIPTION: Scan a file for any non-ASCII bytes.
332 * Note: Maintains current file position.
334 ******************************************************************************/
341 BOOLEAN IsBinary = FALSE;
345 /* Scan entire file for any non-ASCII bytes */
347 FileOffset = ftell (File);
348 while (fread (&Byte, 1, 1, File) == 1)
350 if (!isprint (Byte) && !isspace (Byte))
358 fseek (File, FileOffset, SEEK_SET);
363 /*******************************************************************************
365 * FUNCTION: AcValidateTableHeader
367 * PARAMETERS: File - Open input file
371 * DESCRIPTION: Determine if a file seems to contain one or more binary ACPI
373 * following checks on what would be the table header:
374 * 1) File must be at least as long as an ACPI_TABLE_HEADER
375 * 2) There must be enough room in the file to hold entire table
376 * 3) Signature, OemId, OemTableId, AslCompilerId must be ASCII
378 * Note: There can be multiple definition blocks per file, so we cannot
379 * expect/compare the file size to be equal to the table length. 12/2015.
381 * Note: Maintains current file position.
383 ******************************************************************************/
386 AcValidateTableHeader (
390 ACPI_TABLE_HEADER TableHeader;
397 ACPI_FUNCTION_TRACE ("AcValidateTableHeader");
400 /* Read a potential table header */
402 OriginalOffset = ftell (File);
403 fseek (File, TableOffset, SEEK_SET);
405 Actual = fread (&TableHeader, 1, sizeof (ACPI_TABLE_HEADER), File);
406 fseek (File, OriginalOffset, SEEK_SET);
408 if (Actual < sizeof (ACPI_TABLE_HEADER))
413 /* Validate the signature (limited ASCII chars) */
415 if (!AcpiUtValidNameseg (TableHeader.Signature))
417 fprintf (stderr, "Invalid table signature: 0x%8.8X\n",
418 *ACPI_CAST_PTR (UINT32, TableHeader.Signature));
419 return (AE_BAD_SIGNATURE);
422 /* Validate table length against bytes remaining in the file */
424 FileSize = CmGetFileSize (File);
425 if (TableHeader.Length > (UINT32) (FileSize - TableOffset))
427 fprintf (stderr, "Table [%4.4s] is too long for file - "
428 "needs: 0x%.2X, remaining in file: 0x%.2X\n",
429 TableHeader.Signature, TableHeader.Length,
430 (UINT32) (FileSize - TableOffset));
431 return (AE_BAD_HEADER);
435 * These fields must be ASCII: OemId, OemTableId, AslCompilerId.
436 * We allow a NULL terminator in OemId and OemTableId.
438 for (i = 0; i < ACPI_NAME_SIZE; i++)
440 if (!ACPI_IS_ASCII ((UINT8) TableHeader.AslCompilerId[i]))
446 for (i = 0; (i < ACPI_OEM_ID_SIZE) && (TableHeader.OemId[i]); i++)
448 if (!ACPI_IS_ASCII ((UINT8) TableHeader.OemId[i]))
454 for (i = 0; (i < ACPI_OEM_TABLE_ID_SIZE) && (TableHeader.OemTableId[i]); i++)
456 if (!ACPI_IS_ASCII ((UINT8) TableHeader.OemTableId[i]))
467 ACPI_WARNING ((AE_INFO,
468 "Table header for [%4.4s] has invalid ASCII character(s)",
469 TableHeader.Signature));
474 /*******************************************************************************
476 * FUNCTION: AcCheckTextModeCorruption
478 * PARAMETERS: Table - Table buffer starting with table header
482 * DESCRIPTION: Check table for text mode file corruption where all linefeed
483 * characters (LF) have been replaced by carriage return linefeed
486 ******************************************************************************/
489 AcCheckTextModeCorruption (
490 ACPI_TABLE_HEADER *Table)
494 UINT8 *Buffer = ACPI_CAST_PTR (UINT8, Table);
497 /* Scan entire table to determine if each LF has been prefixed with a CR */
499 for (i = 1; i < Table->Length; i++)
501 if (Buffer[i] == 0x0A)
503 if (Buffer[i - 1] != 0x0D)
505 /* The LF does not have a preceding CR, table not corrupted */
511 /* Found a CR/LF pair */
526 * Entire table scanned, each CR is part of a CR/LF pair --
527 * meaning that the table was treated as a text file somewhere.
529 * NOTE: We can't "fix" the table, because any existing CR/LF pairs in the
530 * original table are left untouched by the text conversion process --
531 * meaning that we cannot simply replace CR/LF pairs with LFs.
533 AcpiOsPrintf ("Table has been corrupted by text mode conversion\n");
534 AcpiOsPrintf ("All LFs (%u) were changed to CR/LF pairs\n", Pairs);
535 AcpiOsPrintf ("Table cannot be repaired!\n");
537 return (AE_BAD_VALUE);