1 /******************************************************************************
3 * Module Name: acfileio - Get ACPI tables from file
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
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.
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.
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.
150 *****************************************************************************/
153 #include "accommon.h"
154 #include "actables.h"
158 #define _COMPONENT ACPI_UTILITIES
159 ACPI_MODULE_NAME ("acfileio")
162 /* Local prototypes */
165 AcGetOneTableFromFile (
168 UINT8 GetOnlyAmlTables
,
169 ACPI_TABLE_HEADER
**Table
);
172 AcCheckTextModeCorruption (
173 ACPI_TABLE_HEADER
*Table
);
176 /*******************************************************************************
178 * FUNCTION: AcDeleteTableList
180 * PARAMETERS: ListHead - List to delete
184 * DESCRIPTION: Delete a list of tables. This is useful for removing memory
185 * allocated by AcGetAllTablesFromFile
187 ******************************************************************************/
191 ACPI_NEW_TABLE_DESC
*ListHead
)
193 ACPI_NEW_TABLE_DESC
*Current
= ListHead
;
194 ACPI_NEW_TABLE_DESC
*Previous
= Current
;
199 Current
= Current
->Next
;
200 AcpiOsFree (Previous
);
206 /*******************************************************************************
208 * FUNCTION: AcGetAllTablesFromFile
210 * PARAMETERS: Filename - Table filename
211 * GetOnlyAmlTables - TRUE if the tables must be AML tables
212 * ReturnListHead - Where table list is returned
216 * DESCRIPTION: Get all ACPI tables from within a single file.
218 ******************************************************************************/
221 AcGetAllTablesFromFile (
223 UINT8 GetOnlyAmlTables
,
224 ACPI_NEW_TABLE_DESC
**ReturnListHead
)
226 ACPI_NEW_TABLE_DESC
*ListHead
= NULL
;
227 ACPI_NEW_TABLE_DESC
*ListTail
= NULL
;
228 ACPI_NEW_TABLE_DESC
*TableDesc
;
230 ACPI_TABLE_HEADER
*Table
= NULL
;
232 ACPI_STATUS Status
= AE_OK
;
235 File
= fopen (Filename
, "rb");
238 fprintf (stderr
, "Could not open input file: %s\n", Filename
);
241 return (AE_NOT_EXIST
);
247 /* Get the file size */
249 FileSize
= CmGetFileSize (File
);
250 if (FileSize
== ACPI_UINT32_MAX
)
257 "Input file %s, Length 0x%X (%u) bytes\n",
258 Filename
, FileSize
, FileSize
);
260 /* We must have at least one ACPI table header */
262 if (FileSize
< sizeof (ACPI_TABLE_HEADER
))
264 Status
= AE_BAD_HEADER
;
268 /* Check for an non-binary file */
270 if (!AcIsFileBinary (File
))
273 " %s: File does not appear to contain a valid AML table\n",
279 /* Read all tables within the file */
281 while (ACPI_SUCCESS (Status
))
283 /* Get one entire ACPI table */
285 Status
= AcGetOneTableFromFile (
286 Filename
, File
, GetOnlyAmlTables
, &Table
);
288 if (Status
== AE_CTRL_TERMINATE
)
293 else if (Status
== AE_TYPE
)
298 else if (ACPI_FAILURE (Status
))
303 /* Print table header for iASL/disassembler only */
305 #ifdef ACPI_ASL_COMPILER
307 AcpiTbPrintTableHeader (0, Table
);
310 /* Allocate and link a table descriptor */
312 TableDesc
= AcpiOsAllocate (sizeof (ACPI_NEW_TABLE_DESC
));
316 Status
= AE_NO_MEMORY
;
320 TableDesc
->Table
= Table
;
321 TableDesc
->Next
= NULL
;
323 /* Link at the end of the local table list */
327 ListHead
= TableDesc
;
328 ListTail
= TableDesc
;
332 ListTail
->Next
= TableDesc
;
333 ListTail
= TableDesc
;
337 /* Add the local table list to the end of the global list */
341 ListTail
= *ReturnListHead
;
342 while (ListTail
->Next
)
344 ListTail
= ListTail
->Next
;
347 ListTail
->Next
= ListHead
;
351 *ReturnListHead
= ListHead
;
360 /*******************************************************************************
362 * FUNCTION: AcGetOneTableFromFile
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
371 * DESCRIPTION: Read the next ACPI table from a file. Implements support
372 * for multiple tables within a single file. File must already
375 * Note: Loading an RSDP is not supported.
377 ******************************************************************************/
380 AcGetOneTableFromFile (
383 UINT8 GetOnlyAmlTables
,
384 ACPI_TABLE_HEADER
**ReturnTable
)
386 ACPI_STATUS Status
= AE_OK
;
387 ACPI_TABLE_HEADER TableHeader
;
388 ACPI_TABLE_HEADER
*Table
;
395 /* Get the table header to examine signature and length */
397 TableOffset
= ftell (File
);
398 Count
= fread (&TableHeader
, 1, sizeof (ACPI_TABLE_HEADER
), File
);
399 if (Count
!= sizeof (ACPI_TABLE_HEADER
))
401 return (AE_CTRL_TERMINATE
);
404 /* Validate the table signature/header (limited ASCII chars) */
406 Status
= AcValidateTableHeader (File
, TableOffset
);
407 if (ACPI_FAILURE (Status
))
412 if (GetOnlyAmlTables
)
415 * Table must be an AML table (DSDT/SSDT).
416 * Used for iASL -e option only.
418 if (!AcpiUtIsAmlTable (&TableHeader
))
421 " %s: Table [%4.4s] is not an AML table - ignoring\n",
422 Filename
, TableHeader
.Signature
);
428 /* Allocate a buffer for the entire table */
430 Table
= AcpiOsAllocate ((ACPI_SIZE
) TableHeader
.Length
);
433 return (AE_NO_MEMORY
);
436 /* Read the entire ACPI table, including header */
438 fseek (File
, TableOffset
, SEEK_SET
);
440 Count
= fread (Table
, 1, TableHeader
.Length
, File
);
441 if (Count
!= (INT32
) TableHeader
.Length
)
447 /* Validate the checksum (just issue a warning) */
449 Status
= AcpiTbVerifyChecksum (Table
, TableHeader
.Length
);
450 if (ACPI_FAILURE (Status
))
452 Status
= AcCheckTextModeCorruption (Table
);
453 if (ACPI_FAILURE (Status
))
459 *ReturnTable
= Table
;
469 /*******************************************************************************
471 * FUNCTION: AcIsFileBinary
473 * PARAMETERS: File - Open input file
475 * RETURN: TRUE if file appears to be binary
477 * DESCRIPTION: Scan a file for any non-ASCII bytes.
479 * Note: Maintains current file position.
481 ******************************************************************************/
488 BOOLEAN IsBinary
= FALSE
;
492 /* Scan entire file for any non-ASCII bytes */
494 FileOffset
= ftell (File
);
495 while (fread (&Byte
, 1, 1, File
) == 1)
497 if (!isprint (Byte
) && !isspace (Byte
))
505 fseek (File
, FileOffset
, SEEK_SET
);
510 /*******************************************************************************
512 * FUNCTION: AcValidateTableHeader
514 * PARAMETERS: File - Open input file
518 * DESCRIPTION: Determine if a file seems to contain one or more binary ACPI
520 * following checks on what would be the table header:
521 * 1) File must be at least as long as an ACPI_TABLE_HEADER
522 * 2) There must be enough room in the file to hold entire table
523 * 3) Signature, OemId, OemTableId, AslCompilerId must be ASCII
525 * Note: There can be multiple definition blocks per file, so we cannot
526 * expect/compare the file size to be equal to the table length. 12/2015.
528 * Note: Maintains current file position.
530 ******************************************************************************/
533 AcValidateTableHeader (
537 ACPI_TABLE_HEADER TableHeader
;
544 ACPI_FUNCTION_TRACE (AcValidateTableHeader
);
547 /* Read a potential table header */
549 OriginalOffset
= ftell (File
);
550 fseek (File
, TableOffset
, SEEK_SET
);
552 Actual
= fread (&TableHeader
, 1, sizeof (ACPI_TABLE_HEADER
), File
);
553 fseek (File
, OriginalOffset
, SEEK_SET
);
555 if (Actual
< sizeof (ACPI_TABLE_HEADER
))
560 /* Validate the signature (limited ASCII chars) */
562 if (!AcpiUtValidNameseg (TableHeader
.Signature
))
564 return (AE_BAD_SIGNATURE
);
567 /* Validate table length against bytes remaining in the file */
569 FileSize
= CmGetFileSize (File
);
570 if (TableHeader
.Length
> (UINT32
) (FileSize
- TableOffset
))
572 fprintf (stderr
, "Table [%4.4s] is too long for file - "
573 "needs: 0x%.2X, remaining in file: 0x%.2X\n",
574 TableHeader
.Signature
, TableHeader
.Length
,
575 (UINT32
) (FileSize
- TableOffset
));
576 return (AE_BAD_HEADER
);
580 * These fields must be ASCII: OemId, OemTableId, AslCompilerId.
581 * We allow a NULL terminator in OemId and OemTableId.
583 for (i
= 0; i
< ACPI_NAME_SIZE
; i
++)
585 if (!ACPI_IS_ASCII ((UINT8
) TableHeader
.AslCompilerId
[i
]))
591 for (i
= 0; (i
< ACPI_OEM_ID_SIZE
) && (TableHeader
.OemId
[i
]); i
++)
593 if (!ACPI_IS_ASCII ((UINT8
) TableHeader
.OemId
[i
]))
599 for (i
= 0; (i
< ACPI_OEM_TABLE_ID_SIZE
) && (TableHeader
.OemTableId
[i
]); i
++)
601 if (!ACPI_IS_ASCII ((UINT8
) TableHeader
.OemTableId
[i
]))
612 ACPI_WARNING ((AE_INFO
,
613 "Table header for [%4.4s] has invalid ASCII character(s)",
614 TableHeader
.Signature
));
619 /*******************************************************************************
621 * FUNCTION: AcCheckTextModeCorruption
623 * PARAMETERS: Table - Table buffer starting with table header
627 * DESCRIPTION: Check table for text mode file corruption where all linefeed
628 * characters (LF) have been replaced by carriage return linefeed
631 ******************************************************************************/
634 AcCheckTextModeCorruption (
635 ACPI_TABLE_HEADER
*Table
)
639 UINT8
*Buffer
= ACPI_CAST_PTR (UINT8
, Table
);
642 /* Scan entire table to determine if each LF has been prefixed with a CR */
644 for (i
= 1; i
< Table
->Length
; i
++)
646 if (Buffer
[i
] == 0x0A)
648 if (Buffer
[i
- 1] != 0x0D)
650 /* The LF does not have a preceding CR, table not corrupted */
656 /* Found a CR/LF pair */
671 * Entire table scanned, each CR is part of a CR/LF pair --
672 * meaning that the table was treated as a text file somewhere.
674 * NOTE: We can't "fix" the table, because any existing CR/LF pairs in the
675 * original table are left untouched by the text conversion process --
676 * meaning that we cannot simply replace CR/LF pairs with LFs.
678 AcpiOsPrintf ("Table has been corrupted by text mode conversion\n");
679 AcpiOsPrintf ("All LFs (%u) were changed to CR/LF pairs\n", Pairs
);
680 AcpiOsPrintf ("Table cannot be repaired!\n");
682 return (AE_BAD_VALUE
);