src/add-ons/kernel/bus_managers/acpi/acpica/components/utilities/utfileio.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: utfileio - simple file I/O routines
   4  *
   5  ******************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2014, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  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
  19  * property rights.
  20  *
  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
  27  *
  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;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  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.
  53  *
  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
  64  * make.
  65  *
  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
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  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.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  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
  88  * PARTICULAR PURPOSE.
  89  *
  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
  97  * LIMITED REMEDY.
  98  *
  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.
 113  *
 114  *****************************************************************************/
 115
 116
 117 #include "acpi.h"
 118 #include "accommon.h"
 119 #include "actables.h"
 120 #include "acapps.h"
 121
 122 #ifdef ACPI_ASL_COMPILER
 123 #include "aslcompiler.h"
 124 #endif
 125
 126
 127 #define _COMPONENT          ACPI_CA_DEBUGGER
 128         ACPI_MODULE_NAME    ("utfileio")
 129
 130
 131 #ifdef ACPI_APPLICATION
 132
 133 /* Local prototypes */
 134
 135 static ACPI_STATUS
 136 AcpiUtCheckTextModeCorruption (
 137     UINT8                   *Table,
 138     UINT32                  TableLength,
 139     UINT32                  FileLength);
 140
 141 static ACPI_STATUS
 142 AcpiUtReadTable (
 143     FILE                    *fp,
 144     ACPI_TABLE_HEADER       **Table,
 145     UINT32                  *TableLength);
 146
 147
 148 /*******************************************************************************
 149  *
 150  * FUNCTION:    AcpiUtCheckTextModeCorruption
 151  *
 152  * PARAMETERS:  Table           - Table buffer
 153  *              TableLength     - Length of table from the table header
 154  *              FileLength      - Length of the file that contains the table
 155  *
 156  * RETURN:      Status
 157  *
 158  * DESCRIPTION: Check table for text mode file corruption where all linefeed
 159  *              characters (LF) have been replaced by carriage return linefeed
 160  *              pairs (CR/LF).
 161  *
 162  ******************************************************************************/
 163
 164 static ACPI_STATUS
 165 AcpiUtCheckTextModeCorruption (
 166     UINT8                   *Table,
 167     UINT32                  TableLength,
 168     UINT32                  FileLength)
 169 {
 170     UINT32                  i;
 171     UINT32                  Pairs = 0;
 172
 173
 174     if (TableLength != FileLength)
 175     {
 176         ACPI_WARNING ((AE_INFO,
 177             "File length (0x%X) is not the same as the table length (0x%X)",
 178             FileLength, TableLength));
 179     }
 180
 181     /* Scan entire table to determine if each LF has been prefixed with a CR */
 182
 183     for (i = 1; i < FileLength; i++)
 184     {
 185         if (Table[i] == 0x0A)
 186         {
 187             if (Table[i - 1] != 0x0D)
 188             {
 189                 /* The LF does not have a preceding CR, table not corrupted */
 190
 191                 return (AE_OK);
 192             }
 193             else
 194             {
 195                 /* Found a CR/LF pair */
 196
 197                 Pairs++;
 198             }
 199             i++;
 200         }
 201     }
 202
 203     if (!Pairs)
 204     {
 205         return (AE_OK);
 206     }
 207
 208     /*
 209      * Entire table scanned, each CR is part of a CR/LF pair --
 210      * meaning that the table was treated as a text file somewhere.
 211      *
 212      * NOTE: We can't "fix" the table, because any existing CR/LF pairs in the
 213      * original table are left untouched by the text conversion process --
 214      * meaning that we cannot simply replace CR/LF pairs with LFs.
 215      */
 216     AcpiOsPrintf ("Table has been corrupted by text mode conversion\n");
 217     AcpiOsPrintf ("All LFs (%u) were changed to CR/LF pairs\n", Pairs);
 218     AcpiOsPrintf ("Table cannot be repaired!\n");
 219     return (AE_BAD_VALUE);
 220 }
 221
 222
 223 /*******************************************************************************
 224  *
 225  * FUNCTION:    AcpiUtReadTable
 226  *
 227  * PARAMETERS:  fp              - File that contains table
 228  *              Table           - Return value, buffer with table
 229  *              TableLength     - Return value, length of table
 230  *
 231  * RETURN:      Status
 232  *
 233  * DESCRIPTION: Load the DSDT from the file pointer
 234  *
 235  ******************************************************************************/
 236
 237 static ACPI_STATUS
 238 AcpiUtReadTable (
 239     FILE                    *fp,
 240     ACPI_TABLE_HEADER       **Table,
 241     UINT32                  *TableLength)
 242 {
 243     ACPI_TABLE_HEADER       TableHeader;
 244     UINT32                  Actual;
 245     ACPI_STATUS             Status;
 246     UINT32                  FileSize;
 247     BOOLEAN                 StandardHeader = TRUE;
 248     INT32                   Count;
 249
 250     /* Get the file size */
 251
 252     FileSize = CmGetFileSize (fp);
 253     if (FileSize == ACPI_UINT32_MAX)
 254     {
 255         return (AE_ERROR);
 256     }
 257
 258     if (FileSize < 4)
 259     {
 260         return (AE_BAD_HEADER);
 261     }
 262
 263     /* Read the signature */
 264
 265     fseek (fp, 0, SEEK_SET);
 266
 267     Count = fread (&TableHeader, 1, sizeof (ACPI_TABLE_HEADER), fp);
 268     if (Count != sizeof (ACPI_TABLE_HEADER))
 269     {
 270         AcpiOsPrintf ("Could not read the table header\n");
 271         return (AE_BAD_HEADER);
 272     }
 273
 274     /* The RSDP table does not have standard ACPI header */
 275
 276     if (ACPI_VALIDATE_RSDP_SIG (TableHeader.Signature))
 277     {
 278         *TableLength = FileSize;
 279         StandardHeader = FALSE;
 280     }
 281     else
 282     {
 283
 284 #if 0
 285         /* Validate the table header/length */
 286
 287         Status = AcpiTbValidateTableHeader (&TableHeader);
 288         if (ACPI_FAILURE (Status))
 289         {
 290             AcpiOsPrintf ("Table header is invalid!\n");
 291             return (Status);
 292         }
 293 #endif
 294
 295         /* File size must be at least as long as the Header-specified length */
 296
 297         if (TableHeader.Length > FileSize)
 298         {
 299             AcpiOsPrintf (
 300                 "TableHeader length [0x%X] greater than the input file size [0x%X]\n",
 301                 TableHeader.Length, FileSize);
 302
 303 #ifdef ACPI_ASL_COMPILER
 304             Status = FlCheckForAscii (fp, NULL, FALSE);
 305             if (ACPI_SUCCESS (Status))
 306             {
 307                 AcpiOsPrintf ("File appears to be ASCII only, must be binary\n");
 308             }
 309 #endif
 310             return (AE_BAD_HEADER);
 311         }
 312
 313 #ifdef ACPI_OBSOLETE_CODE
 314         /* We only support a limited number of table types */
 315
 316         if (!ACPI_COMPARE_NAME ((char *) TableHeader.Signature, ACPI_SIG_DSDT) &&
 317             !ACPI_COMPARE_NAME ((char *) TableHeader.Signature, ACPI_SIG_PSDT) &&
 318             !ACPI_COMPARE_NAME ((char *) TableHeader.Signature, ACPI_SIG_SSDT))
 319         {
 320             AcpiOsPrintf ("Table signature [%4.4s] is invalid or not supported\n",
 321                 (char *) TableHeader.Signature);
 322             ACPI_DUMP_BUFFER (&TableHeader, sizeof (ACPI_TABLE_HEADER));
 323             return (AE_ERROR);
 324         }
 325 #endif
 326
 327         *TableLength = TableHeader.Length;
 328     }
 329
 330     /* Allocate a buffer for the table */
 331
 332     *Table = AcpiOsAllocate ((size_t) FileSize);
 333     if (!*Table)
 334     {
 335         AcpiOsPrintf (
 336             "Could not allocate memory for ACPI table %4.4s (size=0x%X)\n",
 337             TableHeader.Signature, *TableLength);
 338         return (AE_NO_MEMORY);
 339     }
 340
 341     /* Get the rest of the table */
 342
 343     fseek (fp, 0, SEEK_SET);
 344     Actual = fread (*Table, 1, (size_t) FileSize, fp);
 345     if (Actual == FileSize)
 346     {
 347         if (StandardHeader)
 348         {
 349             /* Now validate the checksum */
 350
 351             Status = AcpiTbVerifyChecksum ((void *) *Table,
 352                         ACPI_CAST_PTR (ACPI_TABLE_HEADER, *Table)->Length);
 353
 354             if (Status == AE_BAD_CHECKSUM)
 355             {
 356                 Status = AcpiUtCheckTextModeCorruption ((UINT8 *) *Table,
 357                             FileSize, (*Table)->Length);
 358                 return (Status);
 359             }
 360         }
 361         return (AE_OK);
 362     }
 363
 364     if (Actual > 0)
 365     {
 366         AcpiOsPrintf ("Warning - reading table, asked for %X got %X\n",
 367             FileSize, Actual);
 368         return (AE_OK);
 369     }
 370
 371     AcpiOsPrintf ("Error - could not read the table file\n");
 372     AcpiOsFree (*Table);
 373     *Table = NULL;
 374     *TableLength = 0;
 375     return (AE_ERROR);
 376 }
 377
 378
 379 /*******************************************************************************
 380  *
 381  * FUNCTION:    AcpiUtReadTableFromFile
 382  *
 383  * PARAMETERS:  Filename         - File where table is located
 384  *              Table            - Where a pointer to the table is returned
 385  *
 386  * RETURN:      Status
 387  *
 388  * DESCRIPTION: Get an ACPI table from a file
 389  *
 390  ******************************************************************************/
 391
 392 ACPI_STATUS
 393 AcpiUtReadTableFromFile (
 394     char                    *Filename,
 395     ACPI_TABLE_HEADER       **Table)
 396 {
 397     FILE                    *File;
 398     UINT32                  FileSize;
 399     UINT32                  TableLength;
 400     ACPI_STATUS             Status = AE_ERROR;
 401
 402
 403     /* Open the file, get current size */
 404
 405     File = fopen (Filename, "rb");
 406     if (!File)
 407     {
 408         perror ("Could not open input file");
 409         return (Status);
 410     }
 411
 412     FileSize = CmGetFileSize (File);
 413     if (FileSize == ACPI_UINT32_MAX)
 414     {
 415         goto Exit;
 416     }
 417
 418     /* Get the entire file */
 419
 420     fprintf (stderr, "Loading Acpi table from file %10s - Length %.8u (%06X)\n",
 421         Filename, FileSize, FileSize);
 422
 423     Status = AcpiUtReadTable (File, Table, &TableLength);
 424     if (ACPI_FAILURE (Status))
 425     {
 426         AcpiOsPrintf ("Could not get table from the file\n");
 427     }
 428
 429 Exit:
 430     fclose(File);
 431     return (Status);
 432 }
 433
 434 #endif