1 /*******************************************************************************
3 * Module Name: utfileio - simple file I/O routines
5 ******************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2014, 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 *****************************************************************************/
117 #include "accommon.h"
118 #include "actables.h"
121 #ifdef ACPI_ASL_COMPILER
122 #include "aslcompiler.h"
126 #define _COMPONENT ACPI_CA_DEBUGGER
127 ACPI_MODULE_NAME ("utfileio")
130 #ifdef ACPI_APPLICATION
132 /* Local prototypes */
135 AcpiUtCheckTextModeCorruption (
143 ACPI_TABLE_HEADER
**Table
,
144 UINT32
*TableLength
);
147 /*******************************************************************************
149 * FUNCTION: AcpiUtCheckTextModeCorruption
151 * PARAMETERS: Table - Table buffer
152 * TableLength - Length of table from the table header
153 * FileLength - Length of the file that contains the table
157 * DESCRIPTION: Check table for text mode file corruption where all linefeed
158 * characters (LF) have been replaced by carriage return linefeed
161 ******************************************************************************/
164 AcpiUtCheckTextModeCorruption (
173 if (TableLength
!= FileLength
)
175 ACPI_WARNING ((AE_INFO
,
176 "File length (0x%X) is not the same as the table length (0x%X)",
177 FileLength
, TableLength
));
180 /* Scan entire table to determine if each LF has been prefixed with a CR */
182 for (i
= 1; i
< FileLength
; i
++)
184 if (Table
[i
] == 0x0A)
186 if (Table
[i
- 1] != 0x0D)
188 /* The LF does not have a preceding CR, table not corrupted */
194 /* Found a CR/LF pair */
208 * Entire table scanned, each CR is part of a CR/LF pair --
209 * meaning that the table was treated as a text file somewhere.
211 * NOTE: We can't "fix" the table, because any existing CR/LF pairs in the
212 * original table are left untouched by the text conversion process --
213 * meaning that we cannot simply replace CR/LF pairs with LFs.
215 AcpiOsPrintf ("Table has been corrupted by text mode conversion\n");
216 AcpiOsPrintf ("All LFs (%u) were changed to CR/LF pairs\n", Pairs
);
217 AcpiOsPrintf ("Table cannot be repaired!\n");
218 return (AE_BAD_VALUE
);
222 /*******************************************************************************
224 * FUNCTION: AcpiUtReadTable
226 * PARAMETERS: fp - File that contains table
227 * Table - Return value, buffer with table
228 * TableLength - Return value, length of table
232 * DESCRIPTION: Load the DSDT from the file pointer
234 ******************************************************************************/
239 ACPI_TABLE_HEADER
**Table
,
242 ACPI_TABLE_HEADER TableHeader
;
246 BOOLEAN StandardHeader
= TRUE
;
249 /* Get the file size */
251 FileSize
= CmGetFileSize (fp
);
252 if (FileSize
== ACPI_UINT32_MAX
)
259 return (AE_BAD_HEADER
);
262 /* Read the signature */
264 fseek (fp
, 0, SEEK_SET
);
266 Count
= fread (&TableHeader
, 1, sizeof (ACPI_TABLE_HEADER
), fp
);
267 if (Count
!= sizeof (ACPI_TABLE_HEADER
))
269 AcpiOsPrintf ("Could not read the table header\n");
270 return (AE_BAD_HEADER
);
273 /* The RSDP table does not have standard ACPI header */
275 if (ACPI_VALIDATE_RSDP_SIG (TableHeader
.Signature
))
277 *TableLength
= FileSize
;
278 StandardHeader
= FALSE
;
284 /* Validate the table header/length */
286 Status
= AcpiTbValidateTableHeader (&TableHeader
);
287 if (ACPI_FAILURE (Status
))
289 AcpiOsPrintf ("Table header is invalid!\n");
294 /* File size must be at least as long as the Header-specified length */
296 if (TableHeader
.Length
> FileSize
)
299 "TableHeader length [0x%X] greater than the input file size [0x%X]\n",
300 TableHeader
.Length
, FileSize
);
302 #ifdef ACPI_ASL_COMPILER
303 Status
= FlCheckForAscii (fp
, NULL
, FALSE
);
304 if (ACPI_SUCCESS (Status
))
306 AcpiOsPrintf ("File appears to be ASCII only, must be binary\n");
309 return (AE_BAD_HEADER
);
312 #ifdef ACPI_OBSOLETE_CODE
313 /* We only support a limited number of table types */
315 if (!ACPI_COMPARE_NAME ((char *) TableHeader
.Signature
, ACPI_SIG_DSDT
) &&
316 !ACPI_COMPARE_NAME ((char *) TableHeader
.Signature
, ACPI_SIG_PSDT
) &&
317 !ACPI_COMPARE_NAME ((char *) TableHeader
.Signature
, ACPI_SIG_SSDT
))
319 AcpiOsPrintf ("Table signature [%4.4s] is invalid or not supported\n",
320 (char *) TableHeader
.Signature
);
321 ACPI_DUMP_BUFFER (&TableHeader
, sizeof (ACPI_TABLE_HEADER
));
326 *TableLength
= TableHeader
.Length
;
329 /* Allocate a buffer for the table */
331 *Table
= AcpiOsAllocate ((size_t) FileSize
);
335 "Could not allocate memory for ACPI table %4.4s (size=0x%X)\n",
336 TableHeader
.Signature
, *TableLength
);
337 return (AE_NO_MEMORY
);
340 /* Get the rest of the table */
342 fseek (fp
, 0, SEEK_SET
);
343 Actual
= fread (*Table
, 1, (size_t) FileSize
, fp
);
344 if (Actual
== FileSize
)
348 /* Now validate the checksum */
350 Status
= AcpiTbVerifyChecksum ((void *) *Table
,
351 ACPI_CAST_PTR (ACPI_TABLE_HEADER
, *Table
)->Length
);
353 if (Status
== AE_BAD_CHECKSUM
)
355 Status
= AcpiUtCheckTextModeCorruption ((UINT8
*) *Table
,
356 FileSize
, (*Table
)->Length
);
365 AcpiOsPrintf ("Warning - reading table, asked for %X got %X\n",
370 AcpiOsPrintf ("Error - could not read the table file\n");
378 /*******************************************************************************
380 * FUNCTION: AcpiUtReadTableFromFile
382 * PARAMETERS: Filename - File where table is located
383 * Table - Where a pointer to the table is returned
387 * DESCRIPTION: Get an ACPI table from a file
389 ******************************************************************************/
392 AcpiUtReadTableFromFile (
394 ACPI_TABLE_HEADER
**Table
)
399 ACPI_STATUS Status
= AE_ERROR
;
402 /* Open the file, get current size */
404 File
= fopen (Filename
, "rb");
407 perror ("Could not open input file");
411 FileSize
= CmGetFileSize (File
);
412 if (FileSize
== ACPI_UINT32_MAX
)
417 /* Get the entire file */
419 fprintf (stderr
, "Loading Acpi table from file %10s - Length %.8u (%06X)\n",
420 Filename
, FileSize
, FileSize
);
422 Status
= AcpiUtReadTable (File
, Table
, &TableLength
);
423 if (ACPI_FAILURE (Status
))
425 AcpiOsPrintf ("Could not get table from the file\n");