Home | History | Annotate | Line # | Download | only in common
acfileio.c revision 1.1.1.1.2.5
      1  1.1.1.1.2.2  skrll /******************************************************************************
      2  1.1.1.1.2.2  skrll  *
      3  1.1.1.1.2.2  skrll  * Module Name: acfileio - Get ACPI tables from file
      4  1.1.1.1.2.2  skrll  *
      5  1.1.1.1.2.2  skrll  *****************************************************************************/
      6  1.1.1.1.2.2  skrll 
      7  1.1.1.1.2.2  skrll /*
      8  1.1.1.1.2.5  skrll  * Copyright (C) 2000 - 2017, Intel Corp.
      9  1.1.1.1.2.2  skrll  * All rights reserved.
     10  1.1.1.1.2.2  skrll  *
     11  1.1.1.1.2.2  skrll  * Redistribution and use in source and binary forms, with or without
     12  1.1.1.1.2.2  skrll  * modification, are permitted provided that the following conditions
     13  1.1.1.1.2.2  skrll  * are met:
     14  1.1.1.1.2.2  skrll  * 1. Redistributions of source code must retain the above copyright
     15  1.1.1.1.2.2  skrll  *    notice, this list of conditions, and the following disclaimer,
     16  1.1.1.1.2.2  skrll  *    without modification.
     17  1.1.1.1.2.2  skrll  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
     18  1.1.1.1.2.2  skrll  *    substantially similar to the "NO WARRANTY" disclaimer below
     19  1.1.1.1.2.2  skrll  *    ("Disclaimer") and any redistribution must be conditioned upon
     20  1.1.1.1.2.2  skrll  *    including a substantially similar Disclaimer requirement for further
     21  1.1.1.1.2.2  skrll  *    binary redistribution.
     22  1.1.1.1.2.2  skrll  * 3. Neither the names of the above-listed copyright holders nor the names
     23  1.1.1.1.2.2  skrll  *    of any contributors may be used to endorse or promote products derived
     24  1.1.1.1.2.2  skrll  *    from this software without specific prior written permission.
     25  1.1.1.1.2.2  skrll  *
     26  1.1.1.1.2.2  skrll  * Alternatively, this software may be distributed under the terms of the
     27  1.1.1.1.2.2  skrll  * GNU General Public License ("GPL") version 2 as published by the Free
     28  1.1.1.1.2.2  skrll  * Software Foundation.
     29  1.1.1.1.2.2  skrll  *
     30  1.1.1.1.2.2  skrll  * NO WARRANTY
     31  1.1.1.1.2.2  skrll  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     32  1.1.1.1.2.2  skrll  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     33  1.1.1.1.2.2  skrll  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
     34  1.1.1.1.2.2  skrll  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     35  1.1.1.1.2.2  skrll  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     36  1.1.1.1.2.2  skrll  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     37  1.1.1.1.2.2  skrll  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     38  1.1.1.1.2.2  skrll  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
     39  1.1.1.1.2.2  skrll  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
     40  1.1.1.1.2.2  skrll  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     41  1.1.1.1.2.2  skrll  * POSSIBILITY OF SUCH DAMAGES.
     42  1.1.1.1.2.2  skrll  */
     43  1.1.1.1.2.2  skrll 
     44  1.1.1.1.2.2  skrll #include "acpi.h"
     45  1.1.1.1.2.2  skrll #include "accommon.h"
     46  1.1.1.1.2.2  skrll #include "actables.h"
     47  1.1.1.1.2.2  skrll #include "acutils.h"
     48  1.1.1.1.2.4  skrll #include "acapps.h"
     49  1.1.1.1.2.2  skrll 
     50  1.1.1.1.2.2  skrll #define _COMPONENT          ACPI_UTILITIES
     51  1.1.1.1.2.2  skrll         ACPI_MODULE_NAME    ("acfileio")
     52  1.1.1.1.2.2  skrll 
     53  1.1.1.1.2.2  skrll 
     54  1.1.1.1.2.2  skrll /* Local prototypes */
     55  1.1.1.1.2.2  skrll 
     56  1.1.1.1.2.2  skrll static ACPI_STATUS
     57  1.1.1.1.2.2  skrll AcGetOneTableFromFile (
     58  1.1.1.1.2.2  skrll     char                    *Filename,
     59  1.1.1.1.2.2  skrll     FILE                    *File,
     60  1.1.1.1.2.2  skrll     UINT8                   GetOnlyAmlTables,
     61  1.1.1.1.2.2  skrll     ACPI_TABLE_HEADER       **Table);
     62  1.1.1.1.2.2  skrll 
     63  1.1.1.1.2.2  skrll static ACPI_STATUS
     64  1.1.1.1.2.2  skrll AcCheckTextModeCorruption (
     65  1.1.1.1.2.2  skrll     ACPI_TABLE_HEADER       *Table);
     66  1.1.1.1.2.2  skrll 
     67  1.1.1.1.2.2  skrll 
     68  1.1.1.1.2.2  skrll /*******************************************************************************
     69  1.1.1.1.2.2  skrll  *
     70  1.1.1.1.2.2  skrll  * FUNCTION:    AcGetAllTablesFromFile
     71  1.1.1.1.2.2  skrll  *
     72  1.1.1.1.2.2  skrll  * PARAMETERS:  Filename            - Table filename
     73  1.1.1.1.2.2  skrll  *              GetOnlyAmlTables    - TRUE if the tables must be AML tables
     74  1.1.1.1.2.2  skrll  *              ReturnListHead      - Where table list is returned
     75  1.1.1.1.2.2  skrll  *
     76  1.1.1.1.2.2  skrll  * RETURN:      Status
     77  1.1.1.1.2.2  skrll  *
     78  1.1.1.1.2.2  skrll  * DESCRIPTION: Get all ACPI tables from within a single file.
     79  1.1.1.1.2.2  skrll  *
     80  1.1.1.1.2.2  skrll  ******************************************************************************/
     81  1.1.1.1.2.2  skrll 
     82  1.1.1.1.2.2  skrll ACPI_STATUS
     83  1.1.1.1.2.2  skrll AcGetAllTablesFromFile (
     84  1.1.1.1.2.2  skrll     char                    *Filename,
     85  1.1.1.1.2.2  skrll     UINT8                   GetOnlyAmlTables,
     86  1.1.1.1.2.2  skrll     ACPI_NEW_TABLE_DESC     **ReturnListHead)
     87  1.1.1.1.2.2  skrll {
     88  1.1.1.1.2.2  skrll     ACPI_NEW_TABLE_DESC     *ListHead = NULL;
     89  1.1.1.1.2.2  skrll     ACPI_NEW_TABLE_DESC     *ListTail = NULL;
     90  1.1.1.1.2.2  skrll     ACPI_NEW_TABLE_DESC     *TableDesc;
     91  1.1.1.1.2.2  skrll     FILE                    *File;
     92  1.1.1.1.2.2  skrll     ACPI_TABLE_HEADER       *Table = NULL;
     93  1.1.1.1.2.2  skrll     UINT32                  FileSize;
     94  1.1.1.1.2.2  skrll     ACPI_STATUS             Status = AE_OK;
     95  1.1.1.1.2.2  skrll 
     96  1.1.1.1.2.2  skrll 
     97  1.1.1.1.2.2  skrll     File = fopen (Filename, "rb");
     98  1.1.1.1.2.2  skrll     if (!File)
     99  1.1.1.1.2.2  skrll     {
    100  1.1.1.1.2.4  skrll         fprintf (stderr, "Could not open input file: %s\n", Filename);
    101  1.1.1.1.2.2  skrll         if (errno == ENOENT)
    102  1.1.1.1.2.2  skrll         {
    103  1.1.1.1.2.2  skrll             return (AE_NOT_EXIST);
    104  1.1.1.1.2.2  skrll         }
    105  1.1.1.1.2.2  skrll 
    106  1.1.1.1.2.2  skrll         return (AE_ERROR);
    107  1.1.1.1.2.2  skrll     }
    108  1.1.1.1.2.2  skrll 
    109  1.1.1.1.2.2  skrll     /* Get the file size */
    110  1.1.1.1.2.2  skrll 
    111  1.1.1.1.2.2  skrll     FileSize = CmGetFileSize (File);
    112  1.1.1.1.2.2  skrll     if (FileSize == ACPI_UINT32_MAX)
    113  1.1.1.1.2.2  skrll     {
    114  1.1.1.1.2.3  skrll         Status = AE_ERROR;
    115  1.1.1.1.2.5  skrll         goto Exit;
    116  1.1.1.1.2.2  skrll     }
    117  1.1.1.1.2.2  skrll 
    118  1.1.1.1.2.2  skrll     fprintf (stderr,
    119  1.1.1.1.2.2  skrll         "Input file %s, Length 0x%X (%u) bytes\n",
    120  1.1.1.1.2.2  skrll         Filename, FileSize, FileSize);
    121  1.1.1.1.2.2  skrll 
    122  1.1.1.1.2.2  skrll     /* We must have at least one ACPI table header */
    123  1.1.1.1.2.2  skrll 
    124  1.1.1.1.2.2  skrll     if (FileSize < sizeof (ACPI_TABLE_HEADER))
    125  1.1.1.1.2.2  skrll     {
    126  1.1.1.1.2.3  skrll         Status = AE_BAD_HEADER;
    127  1.1.1.1.2.5  skrll         goto Exit;
    128  1.1.1.1.2.2  skrll     }
    129  1.1.1.1.2.2  skrll 
    130  1.1.1.1.2.2  skrll     /* Check for an non-binary file */
    131  1.1.1.1.2.2  skrll 
    132  1.1.1.1.2.2  skrll     if (!AcIsFileBinary (File))
    133  1.1.1.1.2.2  skrll     {
    134  1.1.1.1.2.2  skrll         fprintf (stderr,
    135  1.1.1.1.2.2  skrll             "    %s: File does not appear to contain a valid AML table\n",
    136  1.1.1.1.2.2  skrll             Filename);
    137  1.1.1.1.2.5  skrll         Status = AE_TYPE;
    138  1.1.1.1.2.5  skrll         goto Exit;
    139  1.1.1.1.2.2  skrll     }
    140  1.1.1.1.2.2  skrll 
    141  1.1.1.1.2.2  skrll     /* Read all tables within the file */
    142  1.1.1.1.2.2  skrll 
    143  1.1.1.1.2.2  skrll     while (ACPI_SUCCESS (Status))
    144  1.1.1.1.2.2  skrll     {
    145  1.1.1.1.2.2  skrll         /* Get one entire ACPI table */
    146  1.1.1.1.2.2  skrll 
    147  1.1.1.1.2.2  skrll         Status = AcGetOneTableFromFile (
    148  1.1.1.1.2.2  skrll             Filename, File, GetOnlyAmlTables, &Table);
    149  1.1.1.1.2.2  skrll 
    150  1.1.1.1.2.2  skrll         if (Status == AE_CTRL_TERMINATE)
    151  1.1.1.1.2.2  skrll         {
    152  1.1.1.1.2.2  skrll             Status = AE_OK;
    153  1.1.1.1.2.2  skrll             break;
    154  1.1.1.1.2.2  skrll         }
    155  1.1.1.1.2.2  skrll         else if (Status == AE_TYPE)
    156  1.1.1.1.2.2  skrll         {
    157  1.1.1.1.2.5  skrll             Status = AE_OK;
    158  1.1.1.1.2.5  skrll             goto Exit;
    159  1.1.1.1.2.2  skrll         }
    160  1.1.1.1.2.2  skrll         else if (ACPI_FAILURE (Status))
    161  1.1.1.1.2.2  skrll         {
    162  1.1.1.1.2.5  skrll             goto Exit;
    163  1.1.1.1.2.2  skrll         }
    164  1.1.1.1.2.2  skrll 
    165  1.1.1.1.2.2  skrll         /* Print table header for iASL/disassembler only */
    166  1.1.1.1.2.2  skrll 
    167  1.1.1.1.2.2  skrll #ifdef ACPI_ASL_COMPILER
    168  1.1.1.1.2.2  skrll 
    169  1.1.1.1.2.5  skrll         AcpiTbPrintTableHeader (0, Table);
    170  1.1.1.1.2.2  skrll #endif
    171  1.1.1.1.2.2  skrll 
    172  1.1.1.1.2.2  skrll         /* Allocate and link a table descriptor */
    173  1.1.1.1.2.2  skrll 
    174  1.1.1.1.2.2  skrll         TableDesc = AcpiOsAllocate (sizeof (ACPI_NEW_TABLE_DESC));
    175  1.1.1.1.2.5  skrll         if (!TableDesc)
    176  1.1.1.1.2.5  skrll         {
    177  1.1.1.1.2.5  skrll             AcpiOsFree (Table);
    178  1.1.1.1.2.5  skrll             Status = AE_NO_MEMORY;
    179  1.1.1.1.2.5  skrll             goto Exit;
    180  1.1.1.1.2.5  skrll         }
    181  1.1.1.1.2.5  skrll 
    182  1.1.1.1.2.2  skrll         TableDesc->Table = Table;
    183  1.1.1.1.2.2  skrll         TableDesc->Next = NULL;
    184  1.1.1.1.2.2  skrll 
    185  1.1.1.1.2.2  skrll         /* Link at the end of the local table list */
    186  1.1.1.1.2.2  skrll 
    187  1.1.1.1.2.2  skrll         if (!ListHead)
    188  1.1.1.1.2.2  skrll         {
    189  1.1.1.1.2.2  skrll             ListHead = TableDesc;
    190  1.1.1.1.2.2  skrll             ListTail = TableDesc;
    191  1.1.1.1.2.2  skrll         }
    192  1.1.1.1.2.2  skrll         else
    193  1.1.1.1.2.2  skrll         {
    194  1.1.1.1.2.2  skrll             ListTail->Next = TableDesc;
    195  1.1.1.1.2.2  skrll             ListTail = TableDesc;
    196  1.1.1.1.2.2  skrll         }
    197  1.1.1.1.2.2  skrll     }
    198  1.1.1.1.2.2  skrll 
    199  1.1.1.1.2.2  skrll     /* Add the local table list to the end of the global list */
    200  1.1.1.1.2.2  skrll 
    201  1.1.1.1.2.2  skrll     if (*ReturnListHead)
    202  1.1.1.1.2.2  skrll     {
    203  1.1.1.1.2.2  skrll         ListTail = *ReturnListHead;
    204  1.1.1.1.2.2  skrll         while (ListTail->Next)
    205  1.1.1.1.2.2  skrll         {
    206  1.1.1.1.2.2  skrll             ListTail = ListTail->Next;
    207  1.1.1.1.2.2  skrll         }
    208  1.1.1.1.2.2  skrll 
    209  1.1.1.1.2.2  skrll         ListTail->Next = ListHead;
    210  1.1.1.1.2.2  skrll     }
    211  1.1.1.1.2.2  skrll     else
    212  1.1.1.1.2.2  skrll     {
    213  1.1.1.1.2.2  skrll         *ReturnListHead = ListHead;
    214  1.1.1.1.2.2  skrll     }
    215  1.1.1.1.2.2  skrll 
    216  1.1.1.1.2.5  skrll Exit:
    217  1.1.1.1.2.2  skrll     fclose(File);
    218  1.1.1.1.2.2  skrll     return (Status);
    219  1.1.1.1.2.2  skrll }
    220  1.1.1.1.2.2  skrll 
    221  1.1.1.1.2.2  skrll 
    222  1.1.1.1.2.2  skrll /*******************************************************************************
    223  1.1.1.1.2.2  skrll  *
    224  1.1.1.1.2.2  skrll  * FUNCTION:    AcGetOneTableFromFile
    225  1.1.1.1.2.2  skrll  *
    226  1.1.1.1.2.2  skrll  * PARAMETERS:  Filename            - File where table is located
    227  1.1.1.1.2.2  skrll  *              File                - Open FILE pointer to Filename
    228  1.1.1.1.2.2  skrll  *              GetOnlyAmlTables    - TRUE if the tables must be AML tables.
    229  1.1.1.1.2.2  skrll  *              ReturnTable         - Where a pointer to the table is returned
    230  1.1.1.1.2.2  skrll  *
    231  1.1.1.1.2.2  skrll  * RETURN:      Status
    232  1.1.1.1.2.2  skrll  *
    233  1.1.1.1.2.2  skrll  * DESCRIPTION: Read the next ACPI table from a file. Implements support
    234  1.1.1.1.2.2  skrll  *              for multiple tables within a single file. File must already
    235  1.1.1.1.2.2  skrll  *              be open.
    236  1.1.1.1.2.2  skrll  *
    237  1.1.1.1.2.2  skrll  * Note: Loading an RSDP is not supported.
    238  1.1.1.1.2.2  skrll  *
    239  1.1.1.1.2.2  skrll  ******************************************************************************/
    240  1.1.1.1.2.2  skrll 
    241  1.1.1.1.2.2  skrll static ACPI_STATUS
    242  1.1.1.1.2.2  skrll AcGetOneTableFromFile (
    243  1.1.1.1.2.2  skrll     char                    *Filename,
    244  1.1.1.1.2.2  skrll     FILE                    *File,
    245  1.1.1.1.2.2  skrll     UINT8                   GetOnlyAmlTables,
    246  1.1.1.1.2.2  skrll     ACPI_TABLE_HEADER       **ReturnTable)
    247  1.1.1.1.2.2  skrll {
    248  1.1.1.1.2.2  skrll     ACPI_STATUS             Status = AE_OK;
    249  1.1.1.1.2.2  skrll     ACPI_TABLE_HEADER       TableHeader;
    250  1.1.1.1.2.2  skrll     ACPI_TABLE_HEADER       *Table;
    251  1.1.1.1.2.2  skrll     INT32                   Count;
    252  1.1.1.1.2.2  skrll     long                    TableOffset;
    253  1.1.1.1.2.2  skrll 
    254  1.1.1.1.2.2  skrll 
    255  1.1.1.1.2.2  skrll     *ReturnTable = NULL;
    256  1.1.1.1.2.2  skrll 
    257  1.1.1.1.2.2  skrll     /* Get the table header to examine signature and length */
    258  1.1.1.1.2.2  skrll 
    259  1.1.1.1.2.2  skrll     TableOffset = ftell (File);
    260  1.1.1.1.2.2  skrll     Count = fread (&TableHeader, 1, sizeof (ACPI_TABLE_HEADER), File);
    261  1.1.1.1.2.2  skrll     if (Count != sizeof (ACPI_TABLE_HEADER))
    262  1.1.1.1.2.2  skrll     {
    263  1.1.1.1.2.2  skrll         return (AE_CTRL_TERMINATE);
    264  1.1.1.1.2.2  skrll     }
    265  1.1.1.1.2.2  skrll 
    266  1.1.1.1.2.2  skrll     /* Validate the table signature/header (limited ASCII chars) */
    267  1.1.1.1.2.2  skrll 
    268  1.1.1.1.2.2  skrll     Status = AcValidateTableHeader (File, TableOffset);
    269  1.1.1.1.2.2  skrll     if (ACPI_FAILURE (Status))
    270  1.1.1.1.2.2  skrll     {
    271  1.1.1.1.2.2  skrll         return (Status);
    272  1.1.1.1.2.2  skrll     }
    273  1.1.1.1.2.2  skrll 
    274  1.1.1.1.2.2  skrll     if (GetOnlyAmlTables)
    275  1.1.1.1.2.2  skrll     {
    276  1.1.1.1.2.4  skrll         /*
    277  1.1.1.1.2.4  skrll          * Table must be an AML table (DSDT/SSDT).
    278  1.1.1.1.2.4  skrll          * Used for iASL -e option only.
    279  1.1.1.1.2.4  skrll          */
    280  1.1.1.1.2.4  skrll         if (!AcpiUtIsAmlTable (&TableHeader))
    281  1.1.1.1.2.2  skrll         {
    282  1.1.1.1.2.2  skrll             fprintf (stderr,
    283  1.1.1.1.2.2  skrll                 "    %s: Table [%4.4s] is not an AML table - ignoring\n",
    284  1.1.1.1.2.2  skrll                 Filename, TableHeader.Signature);
    285  1.1.1.1.2.2  skrll 
    286  1.1.1.1.2.2  skrll             return (AE_TYPE);
    287  1.1.1.1.2.2  skrll         }
    288  1.1.1.1.2.2  skrll     }
    289  1.1.1.1.2.2  skrll 
    290  1.1.1.1.2.2  skrll     /* Allocate a buffer for the entire table */
    291  1.1.1.1.2.2  skrll 
    292  1.1.1.1.2.4  skrll     Table = AcpiOsAllocate ((ACPI_SIZE) TableHeader.Length);
    293  1.1.1.1.2.2  skrll     if (!Table)
    294  1.1.1.1.2.2  skrll     {
    295  1.1.1.1.2.2  skrll         return (AE_NO_MEMORY);
    296  1.1.1.1.2.2  skrll     }
    297  1.1.1.1.2.2  skrll 
    298  1.1.1.1.2.2  skrll     /* Read the entire ACPI table, including header */
    299  1.1.1.1.2.2  skrll 
    300  1.1.1.1.2.2  skrll     fseek (File, TableOffset, SEEK_SET);
    301  1.1.1.1.2.2  skrll 
    302  1.1.1.1.2.2  skrll     Count = fread (Table, 1, TableHeader.Length, File);
    303  1.1.1.1.2.2  skrll     if (Count != (INT32) TableHeader.Length)
    304  1.1.1.1.2.2  skrll     {
    305  1.1.1.1.2.2  skrll         Status = AE_ERROR;
    306  1.1.1.1.2.2  skrll         goto ErrorExit;
    307  1.1.1.1.2.2  skrll     }
    308  1.1.1.1.2.2  skrll 
    309  1.1.1.1.2.2  skrll     /* Validate the checksum (just issue a warning) */
    310  1.1.1.1.2.2  skrll 
    311  1.1.1.1.2.2  skrll     Status = AcpiTbVerifyChecksum (Table, TableHeader.Length);
    312  1.1.1.1.2.2  skrll     if (ACPI_FAILURE (Status))
    313  1.1.1.1.2.2  skrll     {
    314  1.1.1.1.2.2  skrll         Status = AcCheckTextModeCorruption (Table);
    315  1.1.1.1.2.2  skrll         if (ACPI_FAILURE (Status))
    316  1.1.1.1.2.2  skrll         {
    317  1.1.1.1.2.2  skrll             goto ErrorExit;
    318  1.1.1.1.2.2  skrll         }
    319  1.1.1.1.2.2  skrll     }
    320  1.1.1.1.2.2  skrll 
    321  1.1.1.1.2.2  skrll     *ReturnTable = Table;
    322  1.1.1.1.2.2  skrll     return (AE_OK);
    323  1.1.1.1.2.2  skrll 
    324  1.1.1.1.2.2  skrll 
    325  1.1.1.1.2.2  skrll ErrorExit:
    326  1.1.1.1.2.2  skrll     AcpiOsFree (Table);
    327  1.1.1.1.2.2  skrll     return (Status);
    328  1.1.1.1.2.2  skrll }
    329  1.1.1.1.2.2  skrll 
    330  1.1.1.1.2.2  skrll 
    331  1.1.1.1.2.2  skrll /*******************************************************************************
    332  1.1.1.1.2.2  skrll  *
    333  1.1.1.1.2.2  skrll  * FUNCTION:    AcIsFileBinary
    334  1.1.1.1.2.2  skrll  *
    335  1.1.1.1.2.2  skrll  * PARAMETERS:  File                - Open input file
    336  1.1.1.1.2.2  skrll  *
    337  1.1.1.1.2.2  skrll  * RETURN:      TRUE if file appears to be binary
    338  1.1.1.1.2.2  skrll  *
    339  1.1.1.1.2.2  skrll  * DESCRIPTION: Scan a file for any non-ASCII bytes.
    340  1.1.1.1.2.2  skrll  *
    341  1.1.1.1.2.2  skrll  * Note: Maintains current file position.
    342  1.1.1.1.2.2  skrll  *
    343  1.1.1.1.2.2  skrll  ******************************************************************************/
    344  1.1.1.1.2.2  skrll 
    345  1.1.1.1.2.2  skrll BOOLEAN
    346  1.1.1.1.2.2  skrll AcIsFileBinary (
    347  1.1.1.1.2.2  skrll     FILE                    *File)
    348  1.1.1.1.2.2  skrll {
    349  1.1.1.1.2.2  skrll     UINT8                   Byte;
    350  1.1.1.1.2.2  skrll     BOOLEAN                 IsBinary = FALSE;
    351  1.1.1.1.2.2  skrll     long                    FileOffset;
    352  1.1.1.1.2.2  skrll 
    353  1.1.1.1.2.2  skrll 
    354  1.1.1.1.2.2  skrll     /* Scan entire file for any non-ASCII bytes */
    355  1.1.1.1.2.2  skrll 
    356  1.1.1.1.2.2  skrll     FileOffset = ftell (File);
    357  1.1.1.1.2.2  skrll     while (fread (&Byte, 1, 1, File) == 1)
    358  1.1.1.1.2.2  skrll     {
    359  1.1.1.1.2.2  skrll         if (!isprint (Byte) && !isspace (Byte))
    360  1.1.1.1.2.2  skrll         {
    361  1.1.1.1.2.2  skrll             IsBinary = TRUE;
    362  1.1.1.1.2.2  skrll             goto Exit;
    363  1.1.1.1.2.2  skrll         }
    364  1.1.1.1.2.2  skrll     }
    365  1.1.1.1.2.2  skrll 
    366  1.1.1.1.2.2  skrll Exit:
    367  1.1.1.1.2.2  skrll     fseek (File, FileOffset, SEEK_SET);
    368  1.1.1.1.2.2  skrll     return (IsBinary);
    369  1.1.1.1.2.2  skrll }
    370  1.1.1.1.2.2  skrll 
    371  1.1.1.1.2.2  skrll 
    372  1.1.1.1.2.2  skrll /*******************************************************************************
    373  1.1.1.1.2.2  skrll  *
    374  1.1.1.1.2.2  skrll  * FUNCTION:    AcValidateTableHeader
    375  1.1.1.1.2.2  skrll  *
    376  1.1.1.1.2.2  skrll  * PARAMETERS:  File                - Open input file
    377  1.1.1.1.2.2  skrll  *
    378  1.1.1.1.2.2  skrll  * RETURN:      Status
    379  1.1.1.1.2.2  skrll  *
    380  1.1.1.1.2.2  skrll  * DESCRIPTION: Determine if a file seems to contain one or more binary ACPI
    381  1.1.1.1.2.2  skrll  *              tables, via the
    382  1.1.1.1.2.2  skrll  *              following checks on what would be the table header:
    383  1.1.1.1.2.2  skrll  *              1) File must be at least as long as an ACPI_TABLE_HEADER
    384  1.1.1.1.2.2  skrll  *              2) There must be enough room in the file to hold entire table
    385  1.1.1.1.2.2  skrll  *              3) Signature, OemId, OemTableId, AslCompilerId must be ASCII
    386  1.1.1.1.2.2  skrll  *
    387  1.1.1.1.2.2  skrll  * Note: There can be multiple definition blocks per file, so we cannot
    388  1.1.1.1.2.2  skrll  * expect/compare the file size to be equal to the table length. 12/2015.
    389  1.1.1.1.2.2  skrll  *
    390  1.1.1.1.2.2  skrll  * Note: Maintains current file position.
    391  1.1.1.1.2.2  skrll  *
    392  1.1.1.1.2.2  skrll  ******************************************************************************/
    393  1.1.1.1.2.2  skrll 
    394  1.1.1.1.2.2  skrll ACPI_STATUS
    395  1.1.1.1.2.2  skrll AcValidateTableHeader (
    396  1.1.1.1.2.2  skrll     FILE                    *File,
    397  1.1.1.1.2.2  skrll     long                    TableOffset)
    398  1.1.1.1.2.2  skrll {
    399  1.1.1.1.2.2  skrll     ACPI_TABLE_HEADER       TableHeader;
    400  1.1.1.1.2.4  skrll     ACPI_SIZE               Actual;
    401  1.1.1.1.2.2  skrll     long                    OriginalOffset;
    402  1.1.1.1.2.2  skrll     UINT32                  FileSize;
    403  1.1.1.1.2.2  skrll     UINT32                  i;
    404  1.1.1.1.2.2  skrll 
    405  1.1.1.1.2.2  skrll 
    406  1.1.1.1.2.5  skrll     ACPI_FUNCTION_TRACE (AcValidateTableHeader);
    407  1.1.1.1.2.2  skrll 
    408  1.1.1.1.2.2  skrll 
    409  1.1.1.1.2.2  skrll     /* Read a potential table header */
    410  1.1.1.1.2.2  skrll 
    411  1.1.1.1.2.2  skrll     OriginalOffset = ftell (File);
    412  1.1.1.1.2.2  skrll     fseek (File, TableOffset, SEEK_SET);
    413  1.1.1.1.2.2  skrll 
    414  1.1.1.1.2.2  skrll     Actual = fread (&TableHeader, 1, sizeof (ACPI_TABLE_HEADER), File);
    415  1.1.1.1.2.2  skrll     fseek (File, OriginalOffset, SEEK_SET);
    416  1.1.1.1.2.2  skrll 
    417  1.1.1.1.2.2  skrll     if (Actual < sizeof (ACPI_TABLE_HEADER))
    418  1.1.1.1.2.2  skrll     {
    419  1.1.1.1.2.2  skrll         return (AE_ERROR);
    420  1.1.1.1.2.2  skrll     }
    421  1.1.1.1.2.2  skrll 
    422  1.1.1.1.2.2  skrll     /* Validate the signature (limited ASCII chars) */
    423  1.1.1.1.2.2  skrll 
    424  1.1.1.1.2.3  skrll     if (!AcpiUtValidNameseg (TableHeader.Signature))
    425  1.1.1.1.2.2  skrll     {
    426  1.1.1.1.2.2  skrll         fprintf (stderr, "Invalid table signature: 0x%8.8X\n",
    427  1.1.1.1.2.2  skrll             *ACPI_CAST_PTR (UINT32, TableHeader.Signature));
    428  1.1.1.1.2.2  skrll         return (AE_BAD_SIGNATURE);
    429  1.1.1.1.2.2  skrll     }
    430  1.1.1.1.2.2  skrll 
    431  1.1.1.1.2.2  skrll     /* Validate table length against bytes remaining in the file */
    432  1.1.1.1.2.2  skrll 
    433  1.1.1.1.2.2  skrll     FileSize = CmGetFileSize (File);
    434  1.1.1.1.2.2  skrll     if (TableHeader.Length > (UINT32) (FileSize - TableOffset))
    435  1.1.1.1.2.2  skrll     {
    436  1.1.1.1.2.2  skrll         fprintf (stderr, "Table [%4.4s] is too long for file - "
    437  1.1.1.1.2.2  skrll             "needs: 0x%.2X, remaining in file: 0x%.2X\n",
    438  1.1.1.1.2.2  skrll             TableHeader.Signature, TableHeader.Length,
    439  1.1.1.1.2.2  skrll             (UINT32) (FileSize - TableOffset));
    440  1.1.1.1.2.2  skrll         return (AE_BAD_HEADER);
    441  1.1.1.1.2.2  skrll     }
    442  1.1.1.1.2.2  skrll 
    443  1.1.1.1.2.2  skrll     /*
    444  1.1.1.1.2.2  skrll      * These fields must be ASCII: OemId, OemTableId, AslCompilerId.
    445  1.1.1.1.2.2  skrll      * We allow a NULL terminator in OemId and OemTableId.
    446  1.1.1.1.2.2  skrll      */
    447  1.1.1.1.2.2  skrll     for (i = 0; i < ACPI_NAME_SIZE; i++)
    448  1.1.1.1.2.2  skrll     {
    449  1.1.1.1.2.2  skrll         if (!ACPI_IS_ASCII ((UINT8) TableHeader.AslCompilerId[i]))
    450  1.1.1.1.2.2  skrll         {
    451  1.1.1.1.2.2  skrll             goto BadCharacters;
    452  1.1.1.1.2.2  skrll         }
    453  1.1.1.1.2.2  skrll     }
    454  1.1.1.1.2.2  skrll 
    455  1.1.1.1.2.2  skrll     for (i = 0; (i < ACPI_OEM_ID_SIZE) && (TableHeader.OemId[i]); i++)
    456  1.1.1.1.2.2  skrll     {
    457  1.1.1.1.2.2  skrll         if (!ACPI_IS_ASCII ((UINT8) TableHeader.OemId[i]))
    458  1.1.1.1.2.2  skrll         {
    459  1.1.1.1.2.2  skrll             goto BadCharacters;
    460  1.1.1.1.2.2  skrll         }
    461  1.1.1.1.2.2  skrll     }
    462  1.1.1.1.2.2  skrll 
    463  1.1.1.1.2.2  skrll     for (i = 0; (i < ACPI_OEM_TABLE_ID_SIZE) && (TableHeader.OemTableId[i]); i++)
    464  1.1.1.1.2.2  skrll     {
    465  1.1.1.1.2.2  skrll         if (!ACPI_IS_ASCII ((UINT8) TableHeader.OemTableId[i]))
    466  1.1.1.1.2.2  skrll         {
    467  1.1.1.1.2.2  skrll             goto BadCharacters;
    468  1.1.1.1.2.2  skrll         }
    469  1.1.1.1.2.2  skrll     }
    470  1.1.1.1.2.2  skrll 
    471  1.1.1.1.2.2  skrll     return (AE_OK);
    472  1.1.1.1.2.2  skrll 
    473  1.1.1.1.2.2  skrll 
    474  1.1.1.1.2.2  skrll BadCharacters:
    475  1.1.1.1.2.2  skrll 
    476  1.1.1.1.2.2  skrll     ACPI_WARNING ((AE_INFO,
    477  1.1.1.1.2.2  skrll         "Table header for [%4.4s] has invalid ASCII character(s)",
    478  1.1.1.1.2.2  skrll         TableHeader.Signature));
    479  1.1.1.1.2.2  skrll     return (AE_OK);
    480  1.1.1.1.2.2  skrll }
    481  1.1.1.1.2.2  skrll 
    482  1.1.1.1.2.2  skrll 
    483  1.1.1.1.2.2  skrll /*******************************************************************************
    484  1.1.1.1.2.2  skrll  *
    485  1.1.1.1.2.2  skrll  * FUNCTION:    AcCheckTextModeCorruption
    486  1.1.1.1.2.2  skrll  *
    487  1.1.1.1.2.2  skrll  * PARAMETERS:  Table           - Table buffer starting with table header
    488  1.1.1.1.2.2  skrll  *
    489  1.1.1.1.2.2  skrll  * RETURN:      Status
    490  1.1.1.1.2.2  skrll  *
    491  1.1.1.1.2.2  skrll  * DESCRIPTION: Check table for text mode file corruption where all linefeed
    492  1.1.1.1.2.2  skrll  *              characters (LF) have been replaced by carriage return linefeed
    493  1.1.1.1.2.2  skrll  *              pairs (CR/LF).
    494  1.1.1.1.2.2  skrll  *
    495  1.1.1.1.2.2  skrll  ******************************************************************************/
    496  1.1.1.1.2.2  skrll 
    497  1.1.1.1.2.2  skrll static ACPI_STATUS
    498  1.1.1.1.2.2  skrll AcCheckTextModeCorruption (
    499  1.1.1.1.2.2  skrll     ACPI_TABLE_HEADER       *Table)
    500  1.1.1.1.2.2  skrll {
    501  1.1.1.1.2.2  skrll     UINT32                  i;
    502  1.1.1.1.2.2  skrll     UINT32                  Pairs = 0;
    503  1.1.1.1.2.2  skrll     UINT8                   *Buffer = ACPI_CAST_PTR (UINT8, Table);
    504  1.1.1.1.2.2  skrll 
    505  1.1.1.1.2.2  skrll 
    506  1.1.1.1.2.2  skrll     /* Scan entire table to determine if each LF has been prefixed with a CR */
    507  1.1.1.1.2.2  skrll 
    508  1.1.1.1.2.2  skrll     for (i = 1; i < Table->Length; i++)
    509  1.1.1.1.2.2  skrll     {
    510  1.1.1.1.2.2  skrll         if (Buffer[i] == 0x0A)
    511  1.1.1.1.2.2  skrll         {
    512  1.1.1.1.2.2  skrll             if (Buffer[i - 1] != 0x0D)
    513  1.1.1.1.2.2  skrll             {
    514  1.1.1.1.2.2  skrll                 /* The LF does not have a preceding CR, table not corrupted */
    515  1.1.1.1.2.2  skrll 
    516  1.1.1.1.2.2  skrll                 return (AE_OK);
    517  1.1.1.1.2.2  skrll             }
    518  1.1.1.1.2.2  skrll             else
    519  1.1.1.1.2.2  skrll             {
    520  1.1.1.1.2.2  skrll                 /* Found a CR/LF pair */
    521  1.1.1.1.2.2  skrll 
    522  1.1.1.1.2.2  skrll                 Pairs++;
    523  1.1.1.1.2.2  skrll             }
    524  1.1.1.1.2.2  skrll 
    525  1.1.1.1.2.2  skrll             i++;
    526  1.1.1.1.2.2  skrll         }
    527  1.1.1.1.2.2  skrll     }
    528  1.1.1.1.2.2  skrll 
    529  1.1.1.1.2.2  skrll     if (!Pairs)
    530  1.1.1.1.2.2  skrll     {
    531  1.1.1.1.2.2  skrll         return (AE_OK);
    532  1.1.1.1.2.2  skrll     }
    533  1.1.1.1.2.2  skrll 
    534  1.1.1.1.2.2  skrll     /*
    535  1.1.1.1.2.2  skrll      * Entire table scanned, each CR is part of a CR/LF pair --
    536  1.1.1.1.2.2  skrll      * meaning that the table was treated as a text file somewhere.
    537  1.1.1.1.2.2  skrll      *
    538  1.1.1.1.2.2  skrll      * NOTE: We can't "fix" the table, because any existing CR/LF pairs in the
    539  1.1.1.1.2.2  skrll      * original table are left untouched by the text conversion process --
    540  1.1.1.1.2.2  skrll      * meaning that we cannot simply replace CR/LF pairs with LFs.
    541  1.1.1.1.2.2  skrll      */
    542  1.1.1.1.2.2  skrll     AcpiOsPrintf ("Table has been corrupted by text mode conversion\n");
    543  1.1.1.1.2.2  skrll     AcpiOsPrintf ("All LFs (%u) were changed to CR/LF pairs\n", Pairs);
    544  1.1.1.1.2.2  skrll     AcpiOsPrintf ("Table cannot be repaired!\n");
    545  1.1.1.1.2.2  skrll 
    546  1.1.1.1.2.2  skrll     return (AE_BAD_VALUE);
    547  1.1.1.1.2.2  skrll }
    548