1820c5b08SSascha Wildner /******************************************************************************
2820c5b08SSascha Wildner *
3820c5b08SSascha Wildner * Module Name: acfileio - Get ACPI tables from file
4820c5b08SSascha Wildner *
5820c5b08SSascha Wildner *****************************************************************************/
6820c5b08SSascha Wildner
7b4315fc7SSascha Wildner /******************************************************************************
8b4315fc7SSascha Wildner *
9b4315fc7SSascha Wildner * 1. Copyright Notice
10b4315fc7SSascha Wildner *
11383048acSSascha Wildner * Some or all of this work - Copyright (c) 1999 - 2021, Intel Corp.
12820c5b08SSascha Wildner * All rights reserved.
13820c5b08SSascha Wildner *
14b4315fc7SSascha Wildner * 2. License
15b4315fc7SSascha Wildner *
16b4315fc7SSascha Wildner * 2.1. This is your license from Intel Corp. under its intellectual property
17b4315fc7SSascha Wildner * rights. You may have additional license terms from the party that provided
18b4315fc7SSascha Wildner * you this software, covering your right to use that party's intellectual
19b4315fc7SSascha Wildner * property rights.
20b4315fc7SSascha Wildner *
21b4315fc7SSascha Wildner * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22b4315fc7SSascha Wildner * copy of the source code appearing in this file ("Covered Code") an
23b4315fc7SSascha Wildner * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24b4315fc7SSascha Wildner * base code distributed originally by Intel ("Original Intel Code") to copy,
25b4315fc7SSascha Wildner * make derivatives, distribute, use and display any portion of the Covered
26b4315fc7SSascha Wildner * Code in any form, with the right to sublicense such rights; and
27b4315fc7SSascha Wildner *
28b4315fc7SSascha Wildner * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29b4315fc7SSascha Wildner * license (with the right to sublicense), under only those claims of Intel
30b4315fc7SSascha Wildner * patents that are infringed by the Original Intel Code, to make, use, sell,
31b4315fc7SSascha Wildner * offer to sell, and import the Covered Code and derivative works thereof
32b4315fc7SSascha Wildner * solely to the minimum extent necessary to exercise the above copyright
33b4315fc7SSascha Wildner * license, and in no event shall the patent license extend to any additions
34b4315fc7SSascha Wildner * to or modifications of the Original Intel Code. No other license or right
35b4315fc7SSascha Wildner * is granted directly or by implication, estoppel or otherwise;
36b4315fc7SSascha Wildner *
37b4315fc7SSascha Wildner * The above copyright and patent license is granted only if the following
38b4315fc7SSascha Wildner * conditions are met:
39b4315fc7SSascha Wildner *
40b4315fc7SSascha Wildner * 3. Conditions
41b4315fc7SSascha Wildner *
42b4315fc7SSascha Wildner * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43b4315fc7SSascha Wildner * Redistribution of source code of any substantial portion of the Covered
44b4315fc7SSascha Wildner * Code or modification with rights to further distribute source must include
45b4315fc7SSascha Wildner * the above Copyright Notice, the above License, this list of Conditions,
46b4315fc7SSascha Wildner * and the following Disclaimer and Export Compliance provision. In addition,
47b4315fc7SSascha Wildner * Licensee must cause all Covered Code to which Licensee contributes to
48b4315fc7SSascha Wildner * contain a file documenting the changes Licensee made to create that Covered
49b4315fc7SSascha Wildner * Code and the date of any change. Licensee must include in that file the
50b4315fc7SSascha Wildner * documentation of any changes made by any predecessor Licensee. Licensee
51b4315fc7SSascha Wildner * must include a prominent statement that the modification is derived,
52b4315fc7SSascha Wildner * directly or indirectly, from Original Intel Code.
53b4315fc7SSascha Wildner *
54b4315fc7SSascha Wildner * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55b4315fc7SSascha Wildner * Redistribution of source code of any substantial portion of the Covered
56b4315fc7SSascha Wildner * Code or modification without rights to further distribute source must
57b4315fc7SSascha Wildner * include the following Disclaimer and Export Compliance provision in the
58b4315fc7SSascha Wildner * documentation and/or other materials provided with distribution. In
59b4315fc7SSascha Wildner * addition, Licensee may not authorize further sublicense of source of any
60b4315fc7SSascha Wildner * portion of the Covered Code, and must include terms to the effect that the
61b4315fc7SSascha Wildner * license from Licensee to its licensee is limited to the intellectual
62b4315fc7SSascha Wildner * property embodied in the software Licensee provides to its licensee, and
63b4315fc7SSascha Wildner * not to intellectual property embodied in modifications its licensee may
64b4315fc7SSascha Wildner * make.
65b4315fc7SSascha Wildner *
66b4315fc7SSascha Wildner * 3.3. Redistribution of Executable. Redistribution in executable form of any
67b4315fc7SSascha Wildner * substantial portion of the Covered Code or modification must reproduce the
68b4315fc7SSascha Wildner * above Copyright Notice, and the following Disclaimer and Export Compliance
69b4315fc7SSascha Wildner * provision in the documentation and/or other materials provided with the
70b4315fc7SSascha Wildner * distribution.
71b4315fc7SSascha Wildner *
72b4315fc7SSascha Wildner * 3.4. Intel retains all right, title, and interest in and to the Original
73b4315fc7SSascha Wildner * Intel Code.
74b4315fc7SSascha Wildner *
75b4315fc7SSascha Wildner * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76b4315fc7SSascha Wildner * Intel shall be used in advertising or otherwise to promote the sale, use or
77b4315fc7SSascha Wildner * other dealings in products derived from or relating to the Covered Code
78b4315fc7SSascha Wildner * without prior written authorization from Intel.
79b4315fc7SSascha Wildner *
80b4315fc7SSascha Wildner * 4. Disclaimer and Export Compliance
81b4315fc7SSascha Wildner *
82b4315fc7SSascha Wildner * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83b4315fc7SSascha Wildner * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84b4315fc7SSascha Wildner * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85b4315fc7SSascha Wildner * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86b4315fc7SSascha Wildner * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87b4315fc7SSascha Wildner * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88b4315fc7SSascha Wildner * PARTICULAR PURPOSE.
89b4315fc7SSascha Wildner *
90b4315fc7SSascha Wildner * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91b4315fc7SSascha Wildner * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92b4315fc7SSascha Wildner * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93b4315fc7SSascha Wildner * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94b4315fc7SSascha Wildner * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95b4315fc7SSascha Wildner * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96b4315fc7SSascha Wildner * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97b4315fc7SSascha Wildner * LIMITED REMEDY.
98b4315fc7SSascha Wildner *
99b4315fc7SSascha Wildner * 4.3. Licensee shall not export, either directly or indirectly, any of this
100b4315fc7SSascha Wildner * software or system incorporating such software without first obtaining any
101b4315fc7SSascha Wildner * required license or other approval from the U. S. Department of Commerce or
102b4315fc7SSascha Wildner * any other agency or department of the United States Government. In the
103b4315fc7SSascha Wildner * event Licensee exports any such software from the United States or
104b4315fc7SSascha Wildner * re-exports any such software from a foreign destination, Licensee shall
105b4315fc7SSascha Wildner * ensure that the distribution and export/re-export of the software is in
106b4315fc7SSascha Wildner * compliance with all laws, regulations, orders, or other restrictions of the
107b4315fc7SSascha Wildner * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108b4315fc7SSascha Wildner * any of its subsidiaries will export/re-export any technical data, process,
109b4315fc7SSascha Wildner * software, or service, directly or indirectly, to any country for which the
110b4315fc7SSascha Wildner * United States government or any agency thereof requires an export license,
111b4315fc7SSascha Wildner * other governmental approval, or letter of assurance, without first obtaining
112b4315fc7SSascha Wildner * such license, approval or letter.
113b4315fc7SSascha Wildner *
114b4315fc7SSascha Wildner *****************************************************************************
115b4315fc7SSascha Wildner *
116b4315fc7SSascha Wildner * Alternatively, you may choose to be licensed under the terms of the
117b4315fc7SSascha Wildner * following license:
118b4315fc7SSascha Wildner *
119820c5b08SSascha Wildner * Redistribution and use in source and binary forms, with or without
120820c5b08SSascha Wildner * modification, are permitted provided that the following conditions
121820c5b08SSascha Wildner * are met:
122820c5b08SSascha Wildner * 1. Redistributions of source code must retain the above copyright
123820c5b08SSascha Wildner * notice, this list of conditions, and the following disclaimer,
124820c5b08SSascha Wildner * without modification.
125820c5b08SSascha Wildner * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126820c5b08SSascha Wildner * substantially similar to the "NO WARRANTY" disclaimer below
127820c5b08SSascha Wildner * ("Disclaimer") and any redistribution must be conditioned upon
128820c5b08SSascha Wildner * including a substantially similar Disclaimer requirement for further
129820c5b08SSascha Wildner * binary redistribution.
130820c5b08SSascha Wildner * 3. Neither the names of the above-listed copyright holders nor the names
131820c5b08SSascha Wildner * of any contributors may be used to endorse or promote products derived
132820c5b08SSascha Wildner * from this software without specific prior written permission.
133820c5b08SSascha Wildner *
134b4315fc7SSascha Wildner * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135b4315fc7SSascha Wildner * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136b4315fc7SSascha Wildner * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137b4315fc7SSascha Wildner * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138b4315fc7SSascha Wildner * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139b4315fc7SSascha Wildner * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140b4315fc7SSascha Wildner * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141b4315fc7SSascha Wildner * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142b4315fc7SSascha Wildner * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143b4315fc7SSascha Wildner * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144b4315fc7SSascha Wildner * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145b4315fc7SSascha Wildner *
146b4315fc7SSascha Wildner * Alternatively, you may choose to be licensed under the terms of the
147820c5b08SSascha Wildner * GNU General Public License ("GPL") version 2 as published by the Free
148820c5b08SSascha Wildner * Software Foundation.
149820c5b08SSascha Wildner *
150b4315fc7SSascha Wildner *****************************************************************************/
151820c5b08SSascha Wildner
152820c5b08SSascha Wildner #include "acpi.h"
153820c5b08SSascha Wildner #include "accommon.h"
154820c5b08SSascha Wildner #include "actables.h"
155820c5b08SSascha Wildner #include "acutils.h"
156277350a0SSascha Wildner #include "acapps.h"
157820c5b08SSascha Wildner
158820c5b08SSascha Wildner #define _COMPONENT ACPI_UTILITIES
159820c5b08SSascha Wildner ACPI_MODULE_NAME ("acfileio")
160820c5b08SSascha Wildner
161820c5b08SSascha Wildner
162820c5b08SSascha Wildner /* Local prototypes */
163820c5b08SSascha Wildner
164820c5b08SSascha Wildner static ACPI_STATUS
165f5f76cf2SSascha Wildner AcGetOneTableFromFile (
166820c5b08SSascha Wildner char *Filename,
167820c5b08SSascha Wildner FILE *File,
168820c5b08SSascha Wildner UINT8 GetOnlyAmlTables,
169820c5b08SSascha Wildner ACPI_TABLE_HEADER **Table);
170820c5b08SSascha Wildner
171820c5b08SSascha Wildner static ACPI_STATUS
172f5f76cf2SSascha Wildner AcCheckTextModeCorruption (
173820c5b08SSascha Wildner ACPI_TABLE_HEADER *Table);
174820c5b08SSascha Wildner
175820c5b08SSascha Wildner
176820c5b08SSascha Wildner /*******************************************************************************
177820c5b08SSascha Wildner *
1781093ca81SSascha Wildner * FUNCTION: AcDeleteTableList
1791093ca81SSascha Wildner *
1801093ca81SSascha Wildner * PARAMETERS: ListHead - List to delete
1811093ca81SSascha Wildner *
1821093ca81SSascha Wildner * RETURN: Status
1831093ca81SSascha Wildner *
1841093ca81SSascha Wildner * DESCRIPTION: Delete a list of tables. This is useful for removing memory
1851093ca81SSascha Wildner * allocated by AcGetAllTablesFromFile
1861093ca81SSascha Wildner *
1871093ca81SSascha Wildner ******************************************************************************/
1881093ca81SSascha Wildner
1891093ca81SSascha Wildner void
AcDeleteTableList(ACPI_NEW_TABLE_DESC * ListHead)1901093ca81SSascha Wildner AcDeleteTableList (
1911093ca81SSascha Wildner ACPI_NEW_TABLE_DESC *ListHead)
1921093ca81SSascha Wildner {
1931093ca81SSascha Wildner ACPI_NEW_TABLE_DESC *Current = ListHead;
1941093ca81SSascha Wildner ACPI_NEW_TABLE_DESC *Previous = Current;
1951093ca81SSascha Wildner
1961093ca81SSascha Wildner
1971093ca81SSascha Wildner while (Current)
1981093ca81SSascha Wildner {
1991093ca81SSascha Wildner Current = Current->Next;
2001093ca81SSascha Wildner AcpiOsFree (Previous);
2011093ca81SSascha Wildner Previous = Current;
2021093ca81SSascha Wildner }
2031093ca81SSascha Wildner }
2041093ca81SSascha Wildner
2051093ca81SSascha Wildner
2061093ca81SSascha Wildner /*******************************************************************************
2071093ca81SSascha Wildner *
208f5f76cf2SSascha Wildner * FUNCTION: AcGetAllTablesFromFile
209820c5b08SSascha Wildner *
210820c5b08SSascha Wildner * PARAMETERS: Filename - Table filename
211820c5b08SSascha Wildner * GetOnlyAmlTables - TRUE if the tables must be AML tables
212820c5b08SSascha Wildner * ReturnListHead - Where table list is returned
213820c5b08SSascha Wildner *
214820c5b08SSascha Wildner * RETURN: Status
215820c5b08SSascha Wildner *
216820c5b08SSascha Wildner * DESCRIPTION: Get all ACPI tables from within a single file.
217820c5b08SSascha Wildner *
218820c5b08SSascha Wildner ******************************************************************************/
219820c5b08SSascha Wildner
220820c5b08SSascha Wildner ACPI_STATUS
AcGetAllTablesFromFile(char * Filename,UINT8 GetOnlyAmlTables,ACPI_NEW_TABLE_DESC ** ReturnListHead)221f5f76cf2SSascha Wildner AcGetAllTablesFromFile (
222820c5b08SSascha Wildner char *Filename,
223820c5b08SSascha Wildner UINT8 GetOnlyAmlTables,
224820c5b08SSascha Wildner ACPI_NEW_TABLE_DESC **ReturnListHead)
225820c5b08SSascha Wildner {
226820c5b08SSascha Wildner ACPI_NEW_TABLE_DESC *ListHead = NULL;
227820c5b08SSascha Wildner ACPI_NEW_TABLE_DESC *ListTail = NULL;
228820c5b08SSascha Wildner ACPI_NEW_TABLE_DESC *TableDesc;
229820c5b08SSascha Wildner FILE *File;
230820c5b08SSascha Wildner ACPI_TABLE_HEADER *Table = NULL;
231820c5b08SSascha Wildner UINT32 FileSize;
232820c5b08SSascha Wildner ACPI_STATUS Status = AE_OK;
233820c5b08SSascha Wildner
234820c5b08SSascha Wildner
235820c5b08SSascha Wildner File = fopen (Filename, "rb");
236820c5b08SSascha Wildner if (!File)
237820c5b08SSascha Wildner {
238277350a0SSascha Wildner fprintf (stderr, "Could not open input file: %s\n", Filename);
239820c5b08SSascha Wildner if (errno == ENOENT)
240820c5b08SSascha Wildner {
241820c5b08SSascha Wildner return (AE_NOT_EXIST);
242820c5b08SSascha Wildner }
243820c5b08SSascha Wildner
244820c5b08SSascha Wildner return (AE_ERROR);
245820c5b08SSascha Wildner }
246820c5b08SSascha Wildner
247820c5b08SSascha Wildner /* Get the file size */
248820c5b08SSascha Wildner
249820c5b08SSascha Wildner FileSize = CmGetFileSize (File);
250820c5b08SSascha Wildner if (FileSize == ACPI_UINT32_MAX)
251820c5b08SSascha Wildner {
2520d27ae55SSascha Wildner Status = AE_ERROR;
253a96e04f2SSascha Wildner goto Exit;
254820c5b08SSascha Wildner }
255820c5b08SSascha Wildner
256f5f76cf2SSascha Wildner fprintf (stderr,
257f5f76cf2SSascha Wildner "Input file %s, Length 0x%X (%u) bytes\n",
258f5f76cf2SSascha Wildner Filename, FileSize, FileSize);
259f5f76cf2SSascha Wildner
260f5f76cf2SSascha Wildner /* We must have at least one ACPI table header */
261f5f76cf2SSascha Wildner
262f5f76cf2SSascha Wildner if (FileSize < sizeof (ACPI_TABLE_HEADER))
263820c5b08SSascha Wildner {
2640d27ae55SSascha Wildner Status = AE_BAD_HEADER;
265a96e04f2SSascha Wildner goto Exit;
266820c5b08SSascha Wildner }
267820c5b08SSascha Wildner
268f5f76cf2SSascha Wildner /* Check for an non-binary file */
269f5f76cf2SSascha Wildner
270f5f76cf2SSascha Wildner if (!AcIsFileBinary (File))
271f5f76cf2SSascha Wildner {
272f5f76cf2SSascha Wildner fprintf (stderr,
273f5f76cf2SSascha Wildner " %s: File does not appear to contain a valid AML table\n",
274f5f76cf2SSascha Wildner Filename);
275a96e04f2SSascha Wildner Status = AE_TYPE;
276a96e04f2SSascha Wildner goto Exit;
277f5f76cf2SSascha Wildner }
278f5f76cf2SSascha Wildner
279820c5b08SSascha Wildner /* Read all tables within the file */
280820c5b08SSascha Wildner
281820c5b08SSascha Wildner while (ACPI_SUCCESS (Status))
282820c5b08SSascha Wildner {
283820c5b08SSascha Wildner /* Get one entire ACPI table */
284820c5b08SSascha Wildner
285f5f76cf2SSascha Wildner Status = AcGetOneTableFromFile (
286820c5b08SSascha Wildner Filename, File, GetOnlyAmlTables, &Table);
287f5f76cf2SSascha Wildner
288820c5b08SSascha Wildner if (Status == AE_CTRL_TERMINATE)
289820c5b08SSascha Wildner {
290820c5b08SSascha Wildner Status = AE_OK;
291820c5b08SSascha Wildner break;
292820c5b08SSascha Wildner }
293820c5b08SSascha Wildner else if (Status == AE_TYPE)
294820c5b08SSascha Wildner {
295a96e04f2SSascha Wildner Status = AE_OK;
296a96e04f2SSascha Wildner goto Exit;
297820c5b08SSascha Wildner }
298820c5b08SSascha Wildner else if (ACPI_FAILURE (Status))
299820c5b08SSascha Wildner {
300a96e04f2SSascha Wildner goto Exit;
301820c5b08SSascha Wildner }
302820c5b08SSascha Wildner
303f5f76cf2SSascha Wildner /* Print table header for iASL/disassembler only */
304f5f76cf2SSascha Wildner
305f5f76cf2SSascha Wildner #ifdef ACPI_ASL_COMPILER
306f5f76cf2SSascha Wildner
307f5f76cf2SSascha Wildner AcpiTbPrintTableHeader (0, Table);
308f5f76cf2SSascha Wildner #endif
309f5f76cf2SSascha Wildner
310820c5b08SSascha Wildner /* Allocate and link a table descriptor */
311820c5b08SSascha Wildner
312820c5b08SSascha Wildner TableDesc = AcpiOsAllocate (sizeof (ACPI_NEW_TABLE_DESC));
313a96e04f2SSascha Wildner if (!TableDesc)
314a96e04f2SSascha Wildner {
315a96e04f2SSascha Wildner AcpiOsFree (Table);
316a96e04f2SSascha Wildner Status = AE_NO_MEMORY;
317a96e04f2SSascha Wildner goto Exit;
318a96e04f2SSascha Wildner }
319a96e04f2SSascha Wildner
320820c5b08SSascha Wildner TableDesc->Table = Table;
321820c5b08SSascha Wildner TableDesc->Next = NULL;
322820c5b08SSascha Wildner
323820c5b08SSascha Wildner /* Link at the end of the local table list */
324820c5b08SSascha Wildner
325820c5b08SSascha Wildner if (!ListHead)
326820c5b08SSascha Wildner {
327820c5b08SSascha Wildner ListHead = TableDesc;
328820c5b08SSascha Wildner ListTail = TableDesc;
329820c5b08SSascha Wildner }
330820c5b08SSascha Wildner else
331820c5b08SSascha Wildner {
332820c5b08SSascha Wildner ListTail->Next = TableDesc;
333820c5b08SSascha Wildner ListTail = TableDesc;
334820c5b08SSascha Wildner }
335820c5b08SSascha Wildner }
336820c5b08SSascha Wildner
337820c5b08SSascha Wildner /* Add the local table list to the end of the global list */
338820c5b08SSascha Wildner
339820c5b08SSascha Wildner if (*ReturnListHead)
340820c5b08SSascha Wildner {
341820c5b08SSascha Wildner ListTail = *ReturnListHead;
342820c5b08SSascha Wildner while (ListTail->Next)
343820c5b08SSascha Wildner {
344820c5b08SSascha Wildner ListTail = ListTail->Next;
345820c5b08SSascha Wildner }
346820c5b08SSascha Wildner
347820c5b08SSascha Wildner ListTail->Next = ListHead;
348820c5b08SSascha Wildner }
349820c5b08SSascha Wildner else
350820c5b08SSascha Wildner {
351820c5b08SSascha Wildner *ReturnListHead = ListHead;
352820c5b08SSascha Wildner }
353820c5b08SSascha Wildner
354a96e04f2SSascha Wildner Exit:
355820c5b08SSascha Wildner fclose(File);
356820c5b08SSascha Wildner return (Status);
357820c5b08SSascha Wildner }
358820c5b08SSascha Wildner
359820c5b08SSascha Wildner
360820c5b08SSascha Wildner /*******************************************************************************
361820c5b08SSascha Wildner *
362f5f76cf2SSascha Wildner * FUNCTION: AcGetOneTableFromFile
363820c5b08SSascha Wildner *
364820c5b08SSascha Wildner * PARAMETERS: Filename - File where table is located
365820c5b08SSascha Wildner * File - Open FILE pointer to Filename
366820c5b08SSascha Wildner * GetOnlyAmlTables - TRUE if the tables must be AML tables.
367820c5b08SSascha Wildner * ReturnTable - Where a pointer to the table is returned
368820c5b08SSascha Wildner *
369820c5b08SSascha Wildner * RETURN: Status
370820c5b08SSascha Wildner *
371820c5b08SSascha Wildner * DESCRIPTION: Read the next ACPI table from a file. Implements support
372820c5b08SSascha Wildner * for multiple tables within a single file. File must already
373820c5b08SSascha Wildner * be open.
374820c5b08SSascha Wildner *
375820c5b08SSascha Wildner * Note: Loading an RSDP is not supported.
376820c5b08SSascha Wildner *
377820c5b08SSascha Wildner ******************************************************************************/
378820c5b08SSascha Wildner
379820c5b08SSascha Wildner static ACPI_STATUS
AcGetOneTableFromFile(char * Filename,FILE * File,UINT8 GetOnlyAmlTables,ACPI_TABLE_HEADER ** ReturnTable)380f5f76cf2SSascha Wildner AcGetOneTableFromFile (
381820c5b08SSascha Wildner char *Filename,
382820c5b08SSascha Wildner FILE *File,
383820c5b08SSascha Wildner UINT8 GetOnlyAmlTables,
384820c5b08SSascha Wildner ACPI_TABLE_HEADER **ReturnTable)
385820c5b08SSascha Wildner {
386820c5b08SSascha Wildner ACPI_STATUS Status = AE_OK;
387820c5b08SSascha Wildner ACPI_TABLE_HEADER TableHeader;
388820c5b08SSascha Wildner ACPI_TABLE_HEADER *Table;
389820c5b08SSascha Wildner INT32 Count;
390f5f76cf2SSascha Wildner long TableOffset;
391820c5b08SSascha Wildner
392820c5b08SSascha Wildner
393820c5b08SSascha Wildner *ReturnTable = NULL;
394820c5b08SSascha Wildner
395f5f76cf2SSascha Wildner /* Get the table header to examine signature and length */
396820c5b08SSascha Wildner
397f5f76cf2SSascha Wildner TableOffset = ftell (File);
398820c5b08SSascha Wildner Count = fread (&TableHeader, 1, sizeof (ACPI_TABLE_HEADER), File);
399820c5b08SSascha Wildner if (Count != sizeof (ACPI_TABLE_HEADER))
400820c5b08SSascha Wildner {
401820c5b08SSascha Wildner return (AE_CTRL_TERMINATE);
402820c5b08SSascha Wildner }
403820c5b08SSascha Wildner
404e416ee21SSascha Wildner if (GetOnlyAmlTables)
405e416ee21SSascha Wildner {
406f5f76cf2SSascha Wildner /* Validate the table signature/header (limited ASCII chars) */
407f5f76cf2SSascha Wildner
408f5f76cf2SSascha Wildner Status = AcValidateTableHeader (File, TableOffset);
409f5f76cf2SSascha Wildner if (ACPI_FAILURE (Status))
410f5f76cf2SSascha Wildner {
411f5f76cf2SSascha Wildner return (Status);
412f5f76cf2SSascha Wildner }
413f5f76cf2SSascha Wildner
41496f24602SSascha Wildner /*
41596f24602SSascha Wildner * Table must be an AML table (DSDT/SSDT).
41696f24602SSascha Wildner * Used for iASL -e option only.
41796f24602SSascha Wildner */
41896f24602SSascha Wildner if (!AcpiUtIsAmlTable (&TableHeader))
419820c5b08SSascha Wildner {
420820c5b08SSascha Wildner fprintf (stderr,
421f5f76cf2SSascha Wildner " %s: Table [%4.4s] is not an AML table - ignoring\n",
422820c5b08SSascha Wildner Filename, TableHeader.Signature);
423820c5b08SSascha Wildner
424820c5b08SSascha Wildner return (AE_TYPE);
425820c5b08SSascha Wildner }
426820c5b08SSascha Wildner }
427820c5b08SSascha Wildner
428820c5b08SSascha Wildner /* Allocate a buffer for the entire table */
429820c5b08SSascha Wildner
430277350a0SSascha Wildner Table = AcpiOsAllocate ((ACPI_SIZE) TableHeader.Length);
431820c5b08SSascha Wildner if (!Table)
432820c5b08SSascha Wildner {
433820c5b08SSascha Wildner return (AE_NO_MEMORY);
434820c5b08SSascha Wildner }
435820c5b08SSascha Wildner
436f5f76cf2SSascha Wildner /* Read the entire ACPI table, including header */
437820c5b08SSascha Wildner
438f5f76cf2SSascha Wildner fseek (File, TableOffset, SEEK_SET);
439820c5b08SSascha Wildner
440820c5b08SSascha Wildner Count = fread (Table, 1, TableHeader.Length, File);
441e416ee21SSascha Wildner
442e416ee21SSascha Wildner /*
443e416ee21SSascha Wildner * Checks for data table headers happen later in the execution. Only verify
444e416ee21SSascha Wildner * for Aml tables at this point in the code.
445e416ee21SSascha Wildner */
446e416ee21SSascha Wildner if (GetOnlyAmlTables && Count != (INT32) TableHeader.Length)
447820c5b08SSascha Wildner {
448820c5b08SSascha Wildner Status = AE_ERROR;
449820c5b08SSascha Wildner goto ErrorExit;
450820c5b08SSascha Wildner }
451820c5b08SSascha Wildner
452820c5b08SSascha Wildner /* Validate the checksum (just issue a warning) */
453820c5b08SSascha Wildner
454820c5b08SSascha Wildner Status = AcpiTbVerifyChecksum (Table, TableHeader.Length);
455820c5b08SSascha Wildner if (ACPI_FAILURE (Status))
456820c5b08SSascha Wildner {
457f5f76cf2SSascha Wildner Status = AcCheckTextModeCorruption (Table);
458820c5b08SSascha Wildner if (ACPI_FAILURE (Status))
459820c5b08SSascha Wildner {
460820c5b08SSascha Wildner goto ErrorExit;
461820c5b08SSascha Wildner }
462820c5b08SSascha Wildner }
463820c5b08SSascha Wildner
464820c5b08SSascha Wildner *ReturnTable = Table;
465820c5b08SSascha Wildner return (AE_OK);
466820c5b08SSascha Wildner
467820c5b08SSascha Wildner
468820c5b08SSascha Wildner ErrorExit:
469820c5b08SSascha Wildner AcpiOsFree (Table);
470820c5b08SSascha Wildner return (Status);
471820c5b08SSascha Wildner }
472820c5b08SSascha Wildner
473820c5b08SSascha Wildner
474820c5b08SSascha Wildner /*******************************************************************************
475820c5b08SSascha Wildner *
476f5f76cf2SSascha Wildner * FUNCTION: AcIsFileBinary
477f5f76cf2SSascha Wildner *
478f5f76cf2SSascha Wildner * PARAMETERS: File - Open input file
479f5f76cf2SSascha Wildner *
480f5f76cf2SSascha Wildner * RETURN: TRUE if file appears to be binary
481f5f76cf2SSascha Wildner *
482f5f76cf2SSascha Wildner * DESCRIPTION: Scan a file for any non-ASCII bytes.
483f5f76cf2SSascha Wildner *
484f5f76cf2SSascha Wildner * Note: Maintains current file position.
485f5f76cf2SSascha Wildner *
486f5f76cf2SSascha Wildner ******************************************************************************/
487f5f76cf2SSascha Wildner
488f5f76cf2SSascha Wildner BOOLEAN
AcIsFileBinary(FILE * File)489f5f76cf2SSascha Wildner AcIsFileBinary (
490f5f76cf2SSascha Wildner FILE *File)
491f5f76cf2SSascha Wildner {
492f5f76cf2SSascha Wildner UINT8 Byte;
493f5f76cf2SSascha Wildner BOOLEAN IsBinary = FALSE;
494f5f76cf2SSascha Wildner long FileOffset;
495f5f76cf2SSascha Wildner
496f5f76cf2SSascha Wildner
497f5f76cf2SSascha Wildner /* Scan entire file for any non-ASCII bytes */
498f5f76cf2SSascha Wildner
499f5f76cf2SSascha Wildner FileOffset = ftell (File);
500f5f76cf2SSascha Wildner while (fread (&Byte, 1, 1, File) == 1)
501f5f76cf2SSascha Wildner {
502f5f76cf2SSascha Wildner if (!isprint (Byte) && !isspace (Byte))
503f5f76cf2SSascha Wildner {
504f5f76cf2SSascha Wildner IsBinary = TRUE;
505f5f76cf2SSascha Wildner goto Exit;
506f5f76cf2SSascha Wildner }
507f5f76cf2SSascha Wildner }
508f5f76cf2SSascha Wildner
509f5f76cf2SSascha Wildner Exit:
510f5f76cf2SSascha Wildner fseek (File, FileOffset, SEEK_SET);
511f5f76cf2SSascha Wildner return (IsBinary);
512f5f76cf2SSascha Wildner }
513f5f76cf2SSascha Wildner
514f5f76cf2SSascha Wildner
515f5f76cf2SSascha Wildner /*******************************************************************************
516f5f76cf2SSascha Wildner *
517f5f76cf2SSascha Wildner * FUNCTION: AcValidateTableHeader
518f5f76cf2SSascha Wildner *
519f5f76cf2SSascha Wildner * PARAMETERS: File - Open input file
520f5f76cf2SSascha Wildner *
521f5f76cf2SSascha Wildner * RETURN: Status
522f5f76cf2SSascha Wildner *
523f5f76cf2SSascha Wildner * DESCRIPTION: Determine if a file seems to contain one or more binary ACPI
524f5f76cf2SSascha Wildner * tables, via the
525f5f76cf2SSascha Wildner * following checks on what would be the table header:
526f5f76cf2SSascha Wildner * 1) File must be at least as long as an ACPI_TABLE_HEADER
527f5f76cf2SSascha Wildner * 2) There must be enough room in the file to hold entire table
528f5f76cf2SSascha Wildner * 3) Signature, OemId, OemTableId, AslCompilerId must be ASCII
529f5f76cf2SSascha Wildner *
530f5f76cf2SSascha Wildner * Note: There can be multiple definition blocks per file, so we cannot
531f5f76cf2SSascha Wildner * expect/compare the file size to be equal to the table length. 12/2015.
532f5f76cf2SSascha Wildner *
533f5f76cf2SSascha Wildner * Note: Maintains current file position.
534f5f76cf2SSascha Wildner *
535f5f76cf2SSascha Wildner ******************************************************************************/
536f5f76cf2SSascha Wildner
537f5f76cf2SSascha Wildner ACPI_STATUS
AcValidateTableHeader(FILE * File,long TableOffset)538f5f76cf2SSascha Wildner AcValidateTableHeader (
539f5f76cf2SSascha Wildner FILE *File,
540f5f76cf2SSascha Wildner long TableOffset)
541f5f76cf2SSascha Wildner {
542f5f76cf2SSascha Wildner ACPI_TABLE_HEADER TableHeader;
543277350a0SSascha Wildner ACPI_SIZE Actual;
544f5f76cf2SSascha Wildner long OriginalOffset;
545f5f76cf2SSascha Wildner UINT32 FileSize;
546f5f76cf2SSascha Wildner UINT32 i;
547f5f76cf2SSascha Wildner
548f5f76cf2SSascha Wildner
54938b5d46cSSascha Wildner ACPI_FUNCTION_TRACE (AcValidateTableHeader);
550f5f76cf2SSascha Wildner
551f5f76cf2SSascha Wildner
552f5f76cf2SSascha Wildner /* Read a potential table header */
553f5f76cf2SSascha Wildner
554f5f76cf2SSascha Wildner OriginalOffset = ftell (File);
555*aab122a6SSascha Wildner if (fseek (File, TableOffset, SEEK_SET))
556*aab122a6SSascha Wildner {
557*aab122a6SSascha Wildner fprintf (stderr, "SEEK error\n");
558*aab122a6SSascha Wildner }
559f5f76cf2SSascha Wildner Actual = fread (&TableHeader, 1, sizeof (ACPI_TABLE_HEADER), File);
560*aab122a6SSascha Wildner if (fseek (File, OriginalOffset, SEEK_SET))
561*aab122a6SSascha Wildner {
562*aab122a6SSascha Wildner fprintf (stderr, "SEEK error\n");
563*aab122a6SSascha Wildner }
564f5f76cf2SSascha Wildner
565f5f76cf2SSascha Wildner if (Actual < sizeof (ACPI_TABLE_HEADER))
566f5f76cf2SSascha Wildner {
56701d5d5dfSSascha Wildner fprintf (stderr,
56801d5d5dfSSascha Wildner "Could not read entire table header: Actual %u, Requested %u\n",
56901d5d5dfSSascha Wildner (UINT32) Actual, (UINT32) sizeof (ACPI_TABLE_HEADER));
570f5f76cf2SSascha Wildner return (AE_ERROR);
571f5f76cf2SSascha Wildner }
572f5f76cf2SSascha Wildner
573f5f76cf2SSascha Wildner /* Validate the signature (limited ASCII chars) */
574f5f76cf2SSascha Wildner
5750d27ae55SSascha Wildner if (!AcpiUtValidNameseg (TableHeader.Signature))
576f5f76cf2SSascha Wildner {
577f5f76cf2SSascha Wildner return (AE_BAD_SIGNATURE);
578f5f76cf2SSascha Wildner }
579f5f76cf2SSascha Wildner
580f5f76cf2SSascha Wildner /* Validate table length against bytes remaining in the file */
581f5f76cf2SSascha Wildner
582f5f76cf2SSascha Wildner FileSize = CmGetFileSize (File);
583f5f76cf2SSascha Wildner if (TableHeader.Length > (UINT32) (FileSize - TableOffset))
584f5f76cf2SSascha Wildner {
585f5f76cf2SSascha Wildner fprintf (stderr, "Table [%4.4s] is too long for file - "
586f5f76cf2SSascha Wildner "needs: 0x%.2X, remaining in file: 0x%.2X\n",
587f5f76cf2SSascha Wildner TableHeader.Signature, TableHeader.Length,
588f5f76cf2SSascha Wildner (UINT32) (FileSize - TableOffset));
589f5f76cf2SSascha Wildner return (AE_BAD_HEADER);
590f5f76cf2SSascha Wildner }
591f5f76cf2SSascha Wildner
592f5f76cf2SSascha Wildner /*
593f5f76cf2SSascha Wildner * These fields must be ASCII: OemId, OemTableId, AslCompilerId.
594f5f76cf2SSascha Wildner * We allow a NULL terminator in OemId and OemTableId.
595f5f76cf2SSascha Wildner */
596c1776041SSascha Wildner for (i = 0; i < ACPI_NAMESEG_SIZE; i++)
597f5f76cf2SSascha Wildner {
598f5f76cf2SSascha Wildner if (!ACPI_IS_ASCII ((UINT8) TableHeader.AslCompilerId[i]))
599f5f76cf2SSascha Wildner {
600f5f76cf2SSascha Wildner goto BadCharacters;
601f5f76cf2SSascha Wildner }
602f5f76cf2SSascha Wildner }
603f5f76cf2SSascha Wildner
604f5f76cf2SSascha Wildner for (i = 0; (i < ACPI_OEM_ID_SIZE) && (TableHeader.OemId[i]); i++)
605f5f76cf2SSascha Wildner {
606f5f76cf2SSascha Wildner if (!ACPI_IS_ASCII ((UINT8) TableHeader.OemId[i]))
607f5f76cf2SSascha Wildner {
608f5f76cf2SSascha Wildner goto BadCharacters;
609f5f76cf2SSascha Wildner }
610f5f76cf2SSascha Wildner }
611f5f76cf2SSascha Wildner
612f5f76cf2SSascha Wildner for (i = 0; (i < ACPI_OEM_TABLE_ID_SIZE) && (TableHeader.OemTableId[i]); i++)
613f5f76cf2SSascha Wildner {
614f5f76cf2SSascha Wildner if (!ACPI_IS_ASCII ((UINT8) TableHeader.OemTableId[i]))
615f5f76cf2SSascha Wildner {
616f5f76cf2SSascha Wildner goto BadCharacters;
617f5f76cf2SSascha Wildner }
618f5f76cf2SSascha Wildner }
619f5f76cf2SSascha Wildner
620f5f76cf2SSascha Wildner return (AE_OK);
621f5f76cf2SSascha Wildner
622f5f76cf2SSascha Wildner
623f5f76cf2SSascha Wildner BadCharacters:
624f5f76cf2SSascha Wildner
625f5f76cf2SSascha Wildner ACPI_WARNING ((AE_INFO,
626f5f76cf2SSascha Wildner "Table header for [%4.4s] has invalid ASCII character(s)",
627f5f76cf2SSascha Wildner TableHeader.Signature));
628f5f76cf2SSascha Wildner return (AE_OK);
629f5f76cf2SSascha Wildner }
630f5f76cf2SSascha Wildner
631f5f76cf2SSascha Wildner
632f5f76cf2SSascha Wildner /*******************************************************************************
633f5f76cf2SSascha Wildner *
634f5f76cf2SSascha Wildner * FUNCTION: AcCheckTextModeCorruption
635820c5b08SSascha Wildner *
636820c5b08SSascha Wildner * PARAMETERS: Table - Table buffer starting with table header
637820c5b08SSascha Wildner *
638820c5b08SSascha Wildner * RETURN: Status
639820c5b08SSascha Wildner *
640820c5b08SSascha Wildner * DESCRIPTION: Check table for text mode file corruption where all linefeed
641820c5b08SSascha Wildner * characters (LF) have been replaced by carriage return linefeed
642820c5b08SSascha Wildner * pairs (CR/LF).
643820c5b08SSascha Wildner *
644820c5b08SSascha Wildner ******************************************************************************/
645820c5b08SSascha Wildner
646820c5b08SSascha Wildner static ACPI_STATUS
AcCheckTextModeCorruption(ACPI_TABLE_HEADER * Table)647f5f76cf2SSascha Wildner AcCheckTextModeCorruption (
648820c5b08SSascha Wildner ACPI_TABLE_HEADER *Table)
649820c5b08SSascha Wildner {
650820c5b08SSascha Wildner UINT32 i;
651820c5b08SSascha Wildner UINT32 Pairs = 0;
652820c5b08SSascha Wildner UINT8 *Buffer = ACPI_CAST_PTR (UINT8, Table);
653820c5b08SSascha Wildner
654820c5b08SSascha Wildner
655820c5b08SSascha Wildner /* Scan entire table to determine if each LF has been prefixed with a CR */
656820c5b08SSascha Wildner
657820c5b08SSascha Wildner for (i = 1; i < Table->Length; i++)
658820c5b08SSascha Wildner {
659820c5b08SSascha Wildner if (Buffer[i] == 0x0A)
660820c5b08SSascha Wildner {
661820c5b08SSascha Wildner if (Buffer[i - 1] != 0x0D)
662820c5b08SSascha Wildner {
663820c5b08SSascha Wildner /* The LF does not have a preceding CR, table not corrupted */
664820c5b08SSascha Wildner
665820c5b08SSascha Wildner return (AE_OK);
666820c5b08SSascha Wildner }
667820c5b08SSascha Wildner else
668820c5b08SSascha Wildner {
669820c5b08SSascha Wildner /* Found a CR/LF pair */
670820c5b08SSascha Wildner
671820c5b08SSascha Wildner Pairs++;
672820c5b08SSascha Wildner }
673820c5b08SSascha Wildner
674820c5b08SSascha Wildner i++;
675820c5b08SSascha Wildner }
676820c5b08SSascha Wildner }
677820c5b08SSascha Wildner
678820c5b08SSascha Wildner if (!Pairs)
679820c5b08SSascha Wildner {
680820c5b08SSascha Wildner return (AE_OK);
681820c5b08SSascha Wildner }
682820c5b08SSascha Wildner
683820c5b08SSascha Wildner /*
684820c5b08SSascha Wildner * Entire table scanned, each CR is part of a CR/LF pair --
685820c5b08SSascha Wildner * meaning that the table was treated as a text file somewhere.
686820c5b08SSascha Wildner *
687820c5b08SSascha Wildner * NOTE: We can't "fix" the table, because any existing CR/LF pairs in the
688820c5b08SSascha Wildner * original table are left untouched by the text conversion process --
689820c5b08SSascha Wildner * meaning that we cannot simply replace CR/LF pairs with LFs.
690820c5b08SSascha Wildner */
691820c5b08SSascha Wildner AcpiOsPrintf ("Table has been corrupted by text mode conversion\n");
692820c5b08SSascha Wildner AcpiOsPrintf ("All LFs (%u) were changed to CR/LF pairs\n", Pairs);
693820c5b08SSascha Wildner AcpiOsPrintf ("Table cannot be repaired!\n");
694820c5b08SSascha Wildner
695820c5b08SSascha Wildner return (AE_BAD_VALUE);
696820c5b08SSascha Wildner }
697