Home | History | Annotate | Line # | Download | only in common
acfileio.c revision 1.1.1.16
      1       1.1  christos /******************************************************************************
      2       1.1  christos  *
      3       1.1  christos  * Module Name: acfileio - Get ACPI tables from file
      4       1.1  christos  *
      5       1.1  christos  *****************************************************************************/
      6       1.1  christos 
      7  1.1.1.15  christos /******************************************************************************
      8  1.1.1.15  christos  *
      9  1.1.1.15  christos  * 1. Copyright Notice
     10  1.1.1.15  christos  *
     11  1.1.1.16  christos  * Some or all of this work - Copyright (c) 1999 - 2025, Intel Corp.
     12       1.1  christos  * All rights reserved.
     13       1.1  christos  *
     14  1.1.1.15  christos  * 2. License
     15  1.1.1.15  christos  *
     16  1.1.1.15  christos  * 2.1. This is your license from Intel Corp. under its intellectual property
     17  1.1.1.15  christos  * rights. You may have additional license terms from the party that provided
     18  1.1.1.15  christos  * you this software, covering your right to use that party's intellectual
     19  1.1.1.15  christos  * property rights.
     20  1.1.1.15  christos  *
     21  1.1.1.15  christos  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
     22  1.1.1.15  christos  * copy of the source code appearing in this file ("Covered Code") an
     23  1.1.1.15  christos  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
     24  1.1.1.15  christos  * base code distributed originally by Intel ("Original Intel Code") to copy,
     25  1.1.1.15  christos  * make derivatives, distribute, use and display any portion of the Covered
     26  1.1.1.15  christos  * Code in any form, with the right to sublicense such rights; and
     27  1.1.1.15  christos  *
     28  1.1.1.15  christos  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
     29  1.1.1.15  christos  * license (with the right to sublicense), under only those claims of Intel
     30  1.1.1.15  christos  * patents that are infringed by the Original Intel Code, to make, use, sell,
     31  1.1.1.15  christos  * offer to sell, and import the Covered Code and derivative works thereof
     32  1.1.1.15  christos  * solely to the minimum extent necessary to exercise the above copyright
     33  1.1.1.15  christos  * license, and in no event shall the patent license extend to any additions
     34  1.1.1.15  christos  * to or modifications of the Original Intel Code. No other license or right
     35  1.1.1.15  christos  * is granted directly or by implication, estoppel or otherwise;
     36  1.1.1.15  christos  *
     37  1.1.1.15  christos  * The above copyright and patent license is granted only if the following
     38  1.1.1.15  christos  * conditions are met:
     39  1.1.1.15  christos  *
     40  1.1.1.15  christos  * 3. Conditions
     41  1.1.1.15  christos  *
     42  1.1.1.15  christos  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
     43  1.1.1.15  christos  * Redistribution of source code of any substantial portion of the Covered
     44  1.1.1.15  christos  * Code or modification with rights to further distribute source must include
     45  1.1.1.15  christos  * the above Copyright Notice, the above License, this list of Conditions,
     46  1.1.1.15  christos  * and the following Disclaimer and Export Compliance provision. In addition,
     47  1.1.1.15  christos  * Licensee must cause all Covered Code to which Licensee contributes to
     48  1.1.1.15  christos  * contain a file documenting the changes Licensee made to create that Covered
     49  1.1.1.15  christos  * Code and the date of any change. Licensee must include in that file the
     50  1.1.1.15  christos  * documentation of any changes made by any predecessor Licensee. Licensee
     51  1.1.1.15  christos  * must include a prominent statement that the modification is derived,
     52  1.1.1.15  christos  * directly or indirectly, from Original Intel Code.
     53  1.1.1.15  christos  *
     54  1.1.1.15  christos  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
     55  1.1.1.15  christos  * Redistribution of source code of any substantial portion of the Covered
     56  1.1.1.15  christos  * Code or modification without rights to further distribute source must
     57  1.1.1.15  christos  * include the following Disclaimer and Export Compliance provision in the
     58  1.1.1.15  christos  * documentation and/or other materials provided with distribution. In
     59  1.1.1.15  christos  * addition, Licensee may not authorize further sublicense of source of any
     60  1.1.1.15  christos  * portion of the Covered Code, and must include terms to the effect that the
     61  1.1.1.15  christos  * license from Licensee to its licensee is limited to the intellectual
     62  1.1.1.15  christos  * property embodied in the software Licensee provides to its licensee, and
     63  1.1.1.15  christos  * not to intellectual property embodied in modifications its licensee may
     64  1.1.1.15  christos  * make.
     65  1.1.1.15  christos  *
     66  1.1.1.15  christos  * 3.3. Redistribution of Executable. Redistribution in executable form of any
     67  1.1.1.15  christos  * substantial portion of the Covered Code or modification must reproduce the
     68  1.1.1.15  christos  * above Copyright Notice, and the following Disclaimer and Export Compliance
     69  1.1.1.15  christos  * provision in the documentation and/or other materials provided with the
     70  1.1.1.15  christos  * distribution.
     71  1.1.1.15  christos  *
     72  1.1.1.15  christos  * 3.4. Intel retains all right, title, and interest in and to the Original
     73  1.1.1.15  christos  * Intel Code.
     74  1.1.1.15  christos  *
     75  1.1.1.15  christos  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
     76  1.1.1.15  christos  * Intel shall be used in advertising or otherwise to promote the sale, use or
     77  1.1.1.15  christos  * other dealings in products derived from or relating to the Covered Code
     78  1.1.1.15  christos  * without prior written authorization from Intel.
     79  1.1.1.15  christos  *
     80  1.1.1.15  christos  * 4. Disclaimer and Export Compliance
     81  1.1.1.15  christos  *
     82  1.1.1.15  christos  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
     83  1.1.1.15  christos  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
     84  1.1.1.15  christos  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
     85  1.1.1.15  christos  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
     86  1.1.1.15  christos  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
     87  1.1.1.15  christos  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
     88  1.1.1.15  christos  * PARTICULAR PURPOSE.
     89  1.1.1.15  christos  *
     90  1.1.1.15  christos  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
     91  1.1.1.15  christos  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
     92  1.1.1.15  christos  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
     93  1.1.1.15  christos  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
     94  1.1.1.15  christos  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
     95  1.1.1.15  christos  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
     96  1.1.1.15  christos  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
     97  1.1.1.15  christos  * LIMITED REMEDY.
     98  1.1.1.15  christos  *
     99  1.1.1.15  christos  * 4.3. Licensee shall not export, either directly or indirectly, any of this
    100  1.1.1.15  christos  * software or system incorporating such software without first obtaining any
    101  1.1.1.15  christos  * required license or other approval from the U. S. Department of Commerce or
    102  1.1.1.15  christos  * any other agency or department of the United States Government. In the
    103  1.1.1.15  christos  * event Licensee exports any such software from the United States or
    104  1.1.1.15  christos  * re-exports any such software from a foreign destination, Licensee shall
    105  1.1.1.15  christos  * ensure that the distribution and export/re-export of the software is in
    106  1.1.1.15  christos  * compliance with all laws, regulations, orders, or other restrictions of the
    107  1.1.1.15  christos  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
    108  1.1.1.15  christos  * any of its subsidiaries will export/re-export any technical data, process,
    109  1.1.1.15  christos  * software, or service, directly or indirectly, to any country for which the
    110  1.1.1.15  christos  * United States government or any agency thereof requires an export license,
    111  1.1.1.15  christos  * other governmental approval, or letter of assurance, without first obtaining
    112  1.1.1.15  christos  * such license, approval or letter.
    113  1.1.1.15  christos  *
    114  1.1.1.15  christos  *****************************************************************************
    115  1.1.1.15  christos  *
    116  1.1.1.15  christos  * Alternatively, you may choose to be licensed under the terms of the
    117  1.1.1.15  christos  * following license:
    118  1.1.1.15  christos  *
    119       1.1  christos  * Redistribution and use in source and binary forms, with or without
    120       1.1  christos  * modification, are permitted provided that the following conditions
    121       1.1  christos  * are met:
    122       1.1  christos  * 1. Redistributions of source code must retain the above copyright
    123       1.1  christos  *    notice, this list of conditions, and the following disclaimer,
    124       1.1  christos  *    without modification.
    125       1.1  christos  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
    126       1.1  christos  *    substantially similar to the "NO WARRANTY" disclaimer below
    127       1.1  christos  *    ("Disclaimer") and any redistribution must be conditioned upon
    128       1.1  christos  *    including a substantially similar Disclaimer requirement for further
    129       1.1  christos  *    binary redistribution.
    130       1.1  christos  * 3. Neither the names of the above-listed copyright holders nor the names
    131       1.1  christos  *    of any contributors may be used to endorse or promote products derived
    132       1.1  christos  *    from this software without specific prior written permission.
    133       1.1  christos  *
    134       1.1  christos  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    135       1.1  christos  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    136  1.1.1.10  christos  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    137       1.1  christos  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
    138  1.1.1.15  christos  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    139  1.1.1.15  christos  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    140  1.1.1.15  christos  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    141  1.1.1.15  christos  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    142  1.1.1.15  christos  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    143  1.1.1.15  christos  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
    144  1.1.1.15  christos  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    145  1.1.1.15  christos  *
    146  1.1.1.15  christos  * Alternatively, you may choose to be licensed under the terms of the
    147  1.1.1.15  christos  * GNU General Public License ("GPL") version 2 as published by the Free
    148  1.1.1.15  christos  * Software Foundation.
    149  1.1.1.15  christos  *
    150  1.1.1.15  christos  *****************************************************************************/
    151       1.1  christos 
    152       1.1  christos #include "acpi.h"
    153       1.1  christos #include "accommon.h"
    154       1.1  christos #include "actables.h"
    155       1.1  christos #include "acutils.h"
    156   1.1.1.3  christos #include "acapps.h"
    157       1.1  christos 
    158       1.1  christos #define _COMPONENT          ACPI_UTILITIES
    159       1.1  christos         ACPI_MODULE_NAME    ("acfileio")
    160       1.1  christos 
    161       1.1  christos 
    162       1.1  christos /* Local prototypes */
    163       1.1  christos 
    164       1.1  christos static ACPI_STATUS
    165       1.1  christos AcGetOneTableFromFile (
    166       1.1  christos     char                    *Filename,
    167       1.1  christos     FILE                    *File,
    168       1.1  christos     UINT8                   GetOnlyAmlTables,
    169       1.1  christos     ACPI_TABLE_HEADER       **Table);
    170       1.1  christos 
    171       1.1  christos static ACPI_STATUS
    172       1.1  christos AcCheckTextModeCorruption (
    173       1.1  christos     ACPI_TABLE_HEADER       *Table);
    174       1.1  christos 
    175       1.1  christos 
    176       1.1  christos /*******************************************************************************
    177       1.1  christos  *
    178   1.1.1.5  christos  * FUNCTION:    AcDeleteTableList
    179   1.1.1.5  christos  *
    180   1.1.1.5  christos  * PARAMETERS:  ListHead            - List to delete
    181   1.1.1.5  christos  *
    182   1.1.1.5  christos  * RETURN:      Status
    183   1.1.1.5  christos  *
    184   1.1.1.5  christos  * DESCRIPTION: Delete a list of tables. This is useful for removing memory
    185   1.1.1.5  christos  *              allocated by AcGetAllTablesFromFile
    186   1.1.1.5  christos  *
    187   1.1.1.5  christos  ******************************************************************************/
    188   1.1.1.5  christos 
    189   1.1.1.5  christos void
    190   1.1.1.5  christos AcDeleteTableList (
    191   1.1.1.5  christos     ACPI_NEW_TABLE_DESC     *ListHead)
    192   1.1.1.5  christos {
    193   1.1.1.5  christos     ACPI_NEW_TABLE_DESC     *Current = ListHead;
    194   1.1.1.5  christos     ACPI_NEW_TABLE_DESC     *Previous = Current;
    195   1.1.1.5  christos 
    196   1.1.1.5  christos 
    197   1.1.1.5  christos     while (Current)
    198   1.1.1.5  christos     {
    199   1.1.1.5  christos         Current = Current->Next;
    200   1.1.1.5  christos         AcpiOsFree (Previous);
    201   1.1.1.5  christos         Previous = Current;
    202   1.1.1.5  christos     }
    203   1.1.1.5  christos }
    204   1.1.1.5  christos 
    205   1.1.1.5  christos 
    206   1.1.1.5  christos /*******************************************************************************
    207   1.1.1.5  christos  *
    208       1.1  christos  * FUNCTION:    AcGetAllTablesFromFile
    209       1.1  christos  *
    210       1.1  christos  * PARAMETERS:  Filename            - Table filename
    211       1.1  christos  *              GetOnlyAmlTables    - TRUE if the tables must be AML tables
    212       1.1  christos  *              ReturnListHead      - Where table list is returned
    213       1.1  christos  *
    214       1.1  christos  * RETURN:      Status
    215       1.1  christos  *
    216       1.1  christos  * DESCRIPTION: Get all ACPI tables from within a single file.
    217       1.1  christos  *
    218       1.1  christos  ******************************************************************************/
    219       1.1  christos 
    220       1.1  christos ACPI_STATUS
    221       1.1  christos AcGetAllTablesFromFile (
    222       1.1  christos     char                    *Filename,
    223       1.1  christos     UINT8                   GetOnlyAmlTables,
    224       1.1  christos     ACPI_NEW_TABLE_DESC     **ReturnListHead)
    225       1.1  christos {
    226       1.1  christos     ACPI_NEW_TABLE_DESC     *ListHead = NULL;
    227       1.1  christos     ACPI_NEW_TABLE_DESC     *ListTail = NULL;
    228       1.1  christos     ACPI_NEW_TABLE_DESC     *TableDesc;
    229       1.1  christos     FILE                    *File;
    230       1.1  christos     ACPI_TABLE_HEADER       *Table = NULL;
    231       1.1  christos     UINT32                  FileSize;
    232       1.1  christos     ACPI_STATUS             Status = AE_OK;
    233       1.1  christos 
    234       1.1  christos 
    235       1.1  christos     File = fopen (Filename, "rb");
    236       1.1  christos     if (!File)
    237       1.1  christos     {
    238   1.1.1.3  christos         fprintf (stderr, "Could not open input file: %s\n", Filename);
    239       1.1  christos         if (errno == ENOENT)
    240       1.1  christos         {
    241       1.1  christos             return (AE_NOT_EXIST);
    242       1.1  christos         }
    243       1.1  christos 
    244       1.1  christos         return (AE_ERROR);
    245       1.1  christos     }
    246       1.1  christos 
    247       1.1  christos     /* Get the file size */
    248       1.1  christos 
    249       1.1  christos     FileSize = CmGetFileSize (File);
    250       1.1  christos     if (FileSize == ACPI_UINT32_MAX)
    251       1.1  christos     {
    252   1.1.1.2  christos         Status = AE_ERROR;
    253   1.1.1.4  christos         goto Exit;
    254       1.1  christos     }
    255       1.1  christos 
    256       1.1  christos     fprintf (stderr,
    257       1.1  christos         "Input file %s, Length 0x%X (%u) bytes\n",
    258       1.1  christos         Filename, FileSize, FileSize);
    259       1.1  christos 
    260       1.1  christos     /* We must have at least one ACPI table header */
    261       1.1  christos 
    262       1.1  christos     if (FileSize < sizeof (ACPI_TABLE_HEADER))
    263       1.1  christos     {
    264   1.1.1.2  christos         Status = AE_BAD_HEADER;
    265   1.1.1.4  christos         goto Exit;
    266       1.1  christos     }
    267       1.1  christos 
    268       1.1  christos     /* Check for an non-binary file */
    269       1.1  christos 
    270       1.1  christos     if (!AcIsFileBinary (File))
    271       1.1  christos     {
    272       1.1  christos         fprintf (stderr,
    273       1.1  christos             "    %s: File does not appear to contain a valid AML table\n",
    274       1.1  christos             Filename);
    275   1.1.1.4  christos         Status = AE_TYPE;
    276   1.1.1.4  christos         goto Exit;
    277       1.1  christos     }
    278       1.1  christos 
    279       1.1  christos     /* Read all tables within the file */
    280       1.1  christos 
    281       1.1  christos     while (ACPI_SUCCESS (Status))
    282       1.1  christos     {
    283       1.1  christos         /* Get one entire ACPI table */
    284       1.1  christos 
    285       1.1  christos         Status = AcGetOneTableFromFile (
    286       1.1  christos             Filename, File, GetOnlyAmlTables, &Table);
    287       1.1  christos 
    288       1.1  christos         if (Status == AE_CTRL_TERMINATE)
    289       1.1  christos         {
    290       1.1  christos             Status = AE_OK;
    291       1.1  christos             break;
    292       1.1  christos         }
    293       1.1  christos         else if (Status == AE_TYPE)
    294       1.1  christos         {
    295   1.1.1.4  christos             Status = AE_OK;
    296   1.1.1.4  christos             goto Exit;
    297       1.1  christos         }
    298       1.1  christos         else if (ACPI_FAILURE (Status))
    299       1.1  christos         {
    300   1.1.1.4  christos             goto Exit;
    301       1.1  christos         }
    302       1.1  christos 
    303       1.1  christos         /* Print table header for iASL/disassembler only */
    304       1.1  christos 
    305       1.1  christos #ifdef ACPI_ASL_COMPILER
    306       1.1  christos 
    307   1.1.1.4  christos         AcpiTbPrintTableHeader (0, Table);
    308       1.1  christos #endif
    309       1.1  christos 
    310       1.1  christos         /* Allocate and link a table descriptor */
    311       1.1  christos 
    312       1.1  christos         TableDesc = AcpiOsAllocate (sizeof (ACPI_NEW_TABLE_DESC));
    313   1.1.1.4  christos         if (!TableDesc)
    314   1.1.1.4  christos         {
    315   1.1.1.4  christos             AcpiOsFree (Table);
    316   1.1.1.4  christos             Status = AE_NO_MEMORY;
    317   1.1.1.4  christos             goto Exit;
    318   1.1.1.4  christos         }
    319   1.1.1.4  christos 
    320       1.1  christos         TableDesc->Table = Table;
    321       1.1  christos         TableDesc->Next = NULL;
    322       1.1  christos 
    323       1.1  christos         /* Link at the end of the local table list */
    324       1.1  christos 
    325       1.1  christos         if (!ListHead)
    326       1.1  christos         {
    327       1.1  christos             ListHead = TableDesc;
    328       1.1  christos             ListTail = TableDesc;
    329       1.1  christos         }
    330       1.1  christos         else
    331       1.1  christos         {
    332       1.1  christos             ListTail->Next = TableDesc;
    333       1.1  christos             ListTail = TableDesc;
    334       1.1  christos         }
    335       1.1  christos     }
    336       1.1  christos 
    337       1.1  christos     /* Add the local table list to the end of the global list */
    338       1.1  christos 
    339       1.1  christos     if (*ReturnListHead)
    340       1.1  christos     {
    341       1.1  christos         ListTail = *ReturnListHead;
    342       1.1  christos         while (ListTail->Next)
    343       1.1  christos         {
    344       1.1  christos             ListTail = ListTail->Next;
    345       1.1  christos         }
    346       1.1  christos 
    347       1.1  christos         ListTail->Next = ListHead;
    348       1.1  christos     }
    349       1.1  christos     else
    350       1.1  christos     {
    351       1.1  christos         *ReturnListHead = ListHead;
    352       1.1  christos     }
    353       1.1  christos 
    354   1.1.1.4  christos Exit:
    355       1.1  christos     fclose(File);
    356       1.1  christos     return (Status);
    357       1.1  christos }
    358       1.1  christos 
    359       1.1  christos 
    360       1.1  christos /*******************************************************************************
    361       1.1  christos  *
    362       1.1  christos  * FUNCTION:    AcGetOneTableFromFile
    363       1.1  christos  *
    364       1.1  christos  * PARAMETERS:  Filename            - File where table is located
    365       1.1  christos  *              File                - Open FILE pointer to Filename
    366       1.1  christos  *              GetOnlyAmlTables    - TRUE if the tables must be AML tables.
    367       1.1  christos  *              ReturnTable         - Where a pointer to the table is returned
    368       1.1  christos  *
    369       1.1  christos  * RETURN:      Status
    370       1.1  christos  *
    371       1.1  christos  * DESCRIPTION: Read the next ACPI table from a file. Implements support
    372       1.1  christos  *              for multiple tables within a single file. File must already
    373       1.1  christos  *              be open.
    374       1.1  christos  *
    375       1.1  christos  * Note: Loading an RSDP is not supported.
    376       1.1  christos  *
    377       1.1  christos  ******************************************************************************/
    378       1.1  christos 
    379       1.1  christos static ACPI_STATUS
    380       1.1  christos AcGetOneTableFromFile (
    381       1.1  christos     char                    *Filename,
    382       1.1  christos     FILE                    *File,
    383       1.1  christos     UINT8                   GetOnlyAmlTables,
    384       1.1  christos     ACPI_TABLE_HEADER       **ReturnTable)
    385       1.1  christos {
    386       1.1  christos     ACPI_STATUS             Status = AE_OK;
    387       1.1  christos     ACPI_TABLE_HEADER       TableHeader;
    388       1.1  christos     ACPI_TABLE_HEADER       *Table;
    389       1.1  christos     INT32                   Count;
    390  1.1.1.13  christos     UINT32                  TableLength;
    391  1.1.1.13  christos     UINT32                  HeaderLength;
    392  1.1.1.13  christos     long                    TableOffset = 0;
    393       1.1  christos 
    394       1.1  christos     *ReturnTable = NULL;
    395       1.1  christos 
    396       1.1  christos     /* Get the table header to examine signature and length */
    397  1.1.1.13  christos     /*
    398  1.1.1.13  christos      * Special handling for the CDAT table (both the Length field
    399  1.1.1.13  christos      * and the Checksum field are not in the standard positions).
    400  1.1.1.13  christos      * (The table header is non-standard).
    401  1.1.1.13  christos      */
    402  1.1.1.13  christos     if (AcpiGbl_CDAT)
    403  1.1.1.13  christos     {
    404  1.1.1.13  christos         HeaderLength = sizeof (ACPI_TABLE_CDAT);
    405  1.1.1.13  christos     }
    406  1.1.1.13  christos     else
    407  1.1.1.13  christos     {
    408  1.1.1.13  christos         HeaderLength = sizeof (ACPI_TABLE_HEADER);
    409  1.1.1.13  christos     }
    410  1.1.1.13  christos 
    411  1.1.1.13  christos     Status = AcValidateTableHeader (File, TableOffset);
    412  1.1.1.13  christos     if (ACPI_FAILURE (Status))
    413  1.1.1.13  christos     {
    414  1.1.1.13  christos         return (Status);
    415  1.1.1.13  christos     }
    416       1.1  christos 
    417       1.1  christos     TableOffset = ftell (File);
    418  1.1.1.13  christos     Count = fread (&TableHeader, 1, HeaderLength, File);
    419  1.1.1.13  christos     if (Count != (INT32) HeaderLength)
    420       1.1  christos     {
    421       1.1  christos         return (AE_CTRL_TERMINATE);
    422       1.1  christos     }
    423       1.1  christos 
    424       1.1  christos     if (GetOnlyAmlTables)
    425       1.1  christos     {
    426   1.1.1.7  christos         /* Validate the table signature/header (limited ASCII chars) */
    427   1.1.1.7  christos 
    428   1.1.1.3  christos         /*
    429   1.1.1.3  christos          * Table must be an AML table (DSDT/SSDT).
    430   1.1.1.3  christos          * Used for iASL -e option only.
    431   1.1.1.3  christos          */
    432   1.1.1.3  christos         if (!AcpiUtIsAmlTable (&TableHeader))
    433       1.1  christos         {
    434       1.1  christos             fprintf (stderr,
    435       1.1  christos                 "    %s: Table [%4.4s] is not an AML table - ignoring\n",
    436       1.1  christos                 Filename, TableHeader.Signature);
    437       1.1  christos 
    438       1.1  christos             return (AE_TYPE);
    439       1.1  christos         }
    440       1.1  christos     }
    441       1.1  christos 
    442  1.1.1.13  christos     /*
    443  1.1.1.13  christos      * Special handling for the CDAT table (both the Length field
    444  1.1.1.13  christos      * and the Checksum field are not in the standard positions).
    445  1.1.1.13  christos      */
    446  1.1.1.13  christos     if (AcpiGbl_CDAT)
    447  1.1.1.13  christos     {
    448  1.1.1.13  christos         TableLength = ACPI_CAST_PTR (ACPI_TABLE_CDAT, &TableHeader)->Length;
    449  1.1.1.13  christos     }
    450  1.1.1.13  christos     else
    451  1.1.1.13  christos     {
    452  1.1.1.13  christos         TableLength = TableHeader.Length;
    453  1.1.1.13  christos     }
    454  1.1.1.13  christos 
    455       1.1  christos     /* Allocate a buffer for the entire table */
    456       1.1  christos 
    457  1.1.1.13  christos     Table = AcpiOsAllocate ((ACPI_SIZE) TableLength);
    458       1.1  christos     if (!Table)
    459       1.1  christos     {
    460       1.1  christos         return (AE_NO_MEMORY);
    461       1.1  christos     }
    462       1.1  christos 
    463       1.1  christos     /* Read the entire ACPI table, including header */
    464       1.1  christos 
    465       1.1  christos     fseek (File, TableOffset, SEEK_SET);
    466  1.1.1.13  christos     Count = fread (Table, 1, TableLength, File);
    467   1.1.1.7  christos 
    468   1.1.1.7  christos     /*
    469   1.1.1.7  christos      * Checks for data table headers happen later in the execution. Only verify
    470   1.1.1.7  christos      * for Aml tables at this point in the code.
    471   1.1.1.7  christos      */
    472  1.1.1.13  christos     if (GetOnlyAmlTables && Count != (INT32) TableLength)
    473       1.1  christos     {
    474       1.1  christos         Status = AE_ERROR;
    475       1.1  christos         goto ErrorExit;
    476       1.1  christos     }
    477       1.1  christos 
    478  1.1.1.13  christos     /*
    479  1.1.1.13  christos      * Validate the checksum (just issue a warning if incorrect).
    480  1.1.1.13  christos      * Note: CDAT is special cased here because the table does
    481  1.1.1.13  christos      * not have the checksum field in the standard position.
    482  1.1.1.13  christos      */
    483  1.1.1.13  christos     if (AcpiGbl_CDAT)
    484  1.1.1.13  christos     {
    485  1.1.1.13  christos         Status = AcpiUtVerifyCdatChecksum ((ACPI_TABLE_CDAT *) Table, TableLength);
    486  1.1.1.13  christos     } else
    487  1.1.1.13  christos     {
    488  1.1.1.13  christos         Status = AcpiUtVerifyChecksum (Table, TableLength);
    489  1.1.1.13  christos     }
    490       1.1  christos 
    491       1.1  christos     if (ACPI_FAILURE (Status))
    492       1.1  christos     {
    493       1.1  christos         Status = AcCheckTextModeCorruption (Table);
    494       1.1  christos         if (ACPI_FAILURE (Status))
    495       1.1  christos         {
    496       1.1  christos             goto ErrorExit;
    497       1.1  christos         }
    498       1.1  christos     }
    499       1.1  christos 
    500       1.1  christos     *ReturnTable = Table;
    501       1.1  christos     return (AE_OK);
    502       1.1  christos 
    503       1.1  christos 
    504       1.1  christos ErrorExit:
    505       1.1  christos     AcpiOsFree (Table);
    506       1.1  christos     return (Status);
    507       1.1  christos }
    508       1.1  christos 
    509       1.1  christos 
    510       1.1  christos /*******************************************************************************
    511       1.1  christos  *
    512       1.1  christos  * FUNCTION:    AcIsFileBinary
    513       1.1  christos  *
    514       1.1  christos  * PARAMETERS:  File                - Open input file
    515       1.1  christos  *
    516       1.1  christos  * RETURN:      TRUE if file appears to be binary
    517       1.1  christos  *
    518       1.1  christos  * DESCRIPTION: Scan a file for any non-ASCII bytes.
    519       1.1  christos  *
    520       1.1  christos  * Note: Maintains current file position.
    521       1.1  christos  *
    522       1.1  christos  ******************************************************************************/
    523       1.1  christos 
    524       1.1  christos BOOLEAN
    525       1.1  christos AcIsFileBinary (
    526       1.1  christos     FILE                    *File)
    527       1.1  christos {
    528       1.1  christos     UINT8                   Byte;
    529       1.1  christos     BOOLEAN                 IsBinary = FALSE;
    530       1.1  christos     long                    FileOffset;
    531       1.1  christos 
    532       1.1  christos 
    533       1.1  christos     /* Scan entire file for any non-ASCII bytes */
    534       1.1  christos 
    535       1.1  christos     FileOffset = ftell (File);
    536       1.1  christos     while (fread (&Byte, 1, 1, File) == 1)
    537       1.1  christos     {
    538       1.1  christos         if (!isprint (Byte) && !isspace (Byte))
    539       1.1  christos         {
    540       1.1  christos             IsBinary = TRUE;
    541       1.1  christos             goto Exit;
    542       1.1  christos         }
    543       1.1  christos     }
    544       1.1  christos 
    545       1.1  christos Exit:
    546       1.1  christos     fseek (File, FileOffset, SEEK_SET);
    547       1.1  christos     return (IsBinary);
    548       1.1  christos }
    549       1.1  christos 
    550       1.1  christos 
    551       1.1  christos /*******************************************************************************
    552       1.1  christos  *
    553       1.1  christos  * FUNCTION:    AcValidateTableHeader
    554       1.1  christos  *
    555       1.1  christos  * PARAMETERS:  File                - Open input file
    556       1.1  christos  *
    557       1.1  christos  * RETURN:      Status
    558       1.1  christos  *
    559       1.1  christos  * DESCRIPTION: Determine if a file seems to contain one or more binary ACPI
    560       1.1  christos  *              tables, via the
    561       1.1  christos  *              following checks on what would be the table header:
    562       1.1  christos  *              1) File must be at least as long as an ACPI_TABLE_HEADER
    563       1.1  christos  *              2) There must be enough room in the file to hold entire table
    564       1.1  christos  *              3) Signature, OemId, OemTableId, AslCompilerId must be ASCII
    565       1.1  christos  *
    566       1.1  christos  * Note: There can be multiple definition blocks per file, so we cannot
    567       1.1  christos  * expect/compare the file size to be equal to the table length. 12/2015.
    568       1.1  christos  *
    569       1.1  christos  * Note: Maintains current file position.
    570       1.1  christos  *
    571       1.1  christos  ******************************************************************************/
    572       1.1  christos 
    573       1.1  christos ACPI_STATUS
    574       1.1  christos AcValidateTableHeader (
    575       1.1  christos     FILE                    *File,
    576       1.1  christos     long                    TableOffset)
    577       1.1  christos {
    578       1.1  christos     ACPI_TABLE_HEADER       TableHeader;
    579  1.1.1.13  christos     ACPI_TABLE_CDAT         *CdatTableHeader = ACPI_CAST_PTR (ACPI_TABLE_CDAT, &TableHeader);
    580  1.1.1.13  christos     UINT32                  HeaderLength;
    581   1.1.1.3  christos     ACPI_SIZE               Actual;
    582       1.1  christos     long                    OriginalOffset;
    583       1.1  christos     UINT32                  FileSize;
    584       1.1  christos     UINT32                  i;
    585       1.1  christos 
    586       1.1  christos 
    587   1.1.1.4  christos     ACPI_FUNCTION_TRACE (AcValidateTableHeader);
    588       1.1  christos 
    589  1.1.1.13  christos     /* Determine the type of table header */
    590  1.1.1.13  christos 
    591  1.1.1.13  christos     if (AcpiGbl_CDAT)
    592  1.1.1.13  christos     {
    593  1.1.1.13  christos         HeaderLength = sizeof (ACPI_TABLE_CDAT);
    594  1.1.1.13  christos     }
    595  1.1.1.13  christos     else
    596  1.1.1.13  christos     {
    597  1.1.1.13  christos         HeaderLength = sizeof (ACPI_TABLE_HEADER);
    598  1.1.1.13  christos     }
    599       1.1  christos 
    600       1.1  christos     /* Read a potential table header */
    601       1.1  christos 
    602       1.1  christos     OriginalOffset = ftell (File);
    603  1.1.1.11  christos     if (fseek (File, TableOffset, SEEK_SET))
    604  1.1.1.11  christos     {
    605  1.1.1.11  christos         fprintf (stderr, "SEEK error\n");
    606  1.1.1.11  christos     }
    607  1.1.1.13  christos     Actual = fread (&TableHeader, 1, HeaderLength, File);
    608  1.1.1.11  christos     if (fseek (File, OriginalOffset, SEEK_SET))
    609  1.1.1.11  christos     {
    610  1.1.1.11  christos         fprintf (stderr, "SEEK error\n");
    611  1.1.1.11  christos     }
    612       1.1  christos 
    613  1.1.1.13  christos     if (Actual < HeaderLength)
    614       1.1  christos     {
    615  1.1.1.10  christos         fprintf (stderr,
    616  1.1.1.10  christos             "Could not read entire table header: Actual %u, Requested %u\n",
    617  1.1.1.13  christos             (UINT32) Actual, HeaderLength);
    618       1.1  christos         return (AE_ERROR);
    619       1.1  christos     }
    620       1.1  christos 
    621       1.1  christos     /* Validate the signature (limited ASCII chars) */
    622       1.1  christos 
    623  1.1.1.13  christos     if (!AcpiGbl_CDAT && !AcpiUtValidNameseg (TableHeader.Signature))
    624       1.1  christos     {
    625  1.1.1.13  christos         /*
    626  1.1.1.13  christos          * The "-ds cdat" option was not used, and the signature is not valid.
    627  1.1.1.13  christos          *
    628  1.1.1.13  christos          * For CDAT we are assuming that there should be at least one non-ASCII
    629  1.1.1.13  christos          * byte in the (normally) 4-character Signature field (at least the
    630  1.1.1.13  christos          * high-order byte should be zero). Otherwise, this is OK.
    631  1.1.1.13  christos          */
    632  1.1.1.13  christos         fprintf (stderr,
    633  1.1.1.13  christos             "\nTable appears to be a CDAT table, which has no signature.\n"
    634  1.1.1.13  christos             "If this is in fact a CDAT table, use the -ds option on the\n"
    635  1.1.1.13  christos             "command line to specify the table type (signature):\n"
    636  1.1.1.13  christos             "\"iasl -d -ds CDAT <file>\" or \"iasl -ds CDAT -T CDAT\"\n\n");
    637  1.1.1.13  christos 
    638       1.1  christos         return (AE_BAD_SIGNATURE);
    639       1.1  christos     }
    640       1.1  christos 
    641       1.1  christos     /* Validate table length against bytes remaining in the file */
    642       1.1  christos 
    643       1.1  christos     FileSize = CmGetFileSize (File);
    644  1.1.1.13  christos     if (!AcpiGbl_CDAT)
    645  1.1.1.13  christos     {
    646  1.1.1.13  christos         /* Standard ACPI table header */
    647  1.1.1.13  christos 
    648  1.1.1.13  christos         if (TableHeader.Length > (UINT32) (FileSize - TableOffset))
    649  1.1.1.13  christos         {
    650  1.1.1.13  christos             fprintf (stderr, "Table [%4.4s] is too long for file - "
    651  1.1.1.13  christos                 "needs: 0x%.2X, remaining in file: 0x%.2X\n",
    652  1.1.1.13  christos                 TableHeader.Signature, TableHeader.Length,
    653  1.1.1.13  christos                 (UINT32) (FileSize - TableOffset));
    654  1.1.1.13  christos             return (AE_BAD_HEADER);
    655  1.1.1.13  christos         }
    656  1.1.1.13  christos     }
    657  1.1.1.13  christos     else if (CdatTableHeader->Length > (UINT32) (FileSize - TableOffset))
    658       1.1  christos     {
    659  1.1.1.13  christos         /* Special header for CDAT table */
    660  1.1.1.13  christos 
    661  1.1.1.13  christos         fprintf (stderr, "Table [CDAT] is too long for file - "
    662       1.1  christos             "needs: 0x%.2X, remaining in file: 0x%.2X\n",
    663  1.1.1.13  christos             CdatTableHeader->Length,
    664       1.1  christos             (UINT32) (FileSize - TableOffset));
    665       1.1  christos         return (AE_BAD_HEADER);
    666       1.1  christos     }
    667       1.1  christos 
    668  1.1.1.13  christos     /* For CDAT table, there are no ASCII fields in the header, we are done */
    669  1.1.1.13  christos 
    670  1.1.1.13  christos     if (AcpiGbl_CDAT)
    671  1.1.1.13  christos     {
    672  1.1.1.13  christos         return (AE_OK);
    673  1.1.1.13  christos     }
    674  1.1.1.13  christos 
    675       1.1  christos     /*
    676  1.1.1.13  christos      * These standard fields must be ASCII: OemId, OemTableId, AslCompilerId.
    677       1.1  christos      * We allow a NULL terminator in OemId and OemTableId.
    678       1.1  christos      */
    679   1.1.1.8  christos     for (i = 0; i < ACPI_NAMESEG_SIZE; i++)
    680       1.1  christos     {
    681       1.1  christos         if (!ACPI_IS_ASCII ((UINT8) TableHeader.AslCompilerId[i]))
    682       1.1  christos         {
    683       1.1  christos             goto BadCharacters;
    684       1.1  christos         }
    685       1.1  christos     }
    686       1.1  christos 
    687       1.1  christos     for (i = 0; (i < ACPI_OEM_ID_SIZE) && (TableHeader.OemId[i]); i++)
    688       1.1  christos     {
    689       1.1  christos         if (!ACPI_IS_ASCII ((UINT8) TableHeader.OemId[i]))
    690       1.1  christos         {
    691       1.1  christos             goto BadCharacters;
    692       1.1  christos         }
    693       1.1  christos     }
    694       1.1  christos 
    695       1.1  christos     for (i = 0; (i < ACPI_OEM_TABLE_ID_SIZE) && (TableHeader.OemTableId[i]); i++)
    696       1.1  christos     {
    697       1.1  christos         if (!ACPI_IS_ASCII ((UINT8) TableHeader.OemTableId[i]))
    698       1.1  christos         {
    699       1.1  christos             goto BadCharacters;
    700       1.1  christos         }
    701       1.1  christos     }
    702       1.1  christos 
    703       1.1  christos     return (AE_OK);
    704       1.1  christos 
    705       1.1  christos 
    706       1.1  christos BadCharacters:
    707       1.1  christos 
    708       1.1  christos     ACPI_WARNING ((AE_INFO,
    709       1.1  christos         "Table header for [%4.4s] has invalid ASCII character(s)",
    710       1.1  christos         TableHeader.Signature));
    711       1.1  christos     return (AE_OK);
    712       1.1  christos }
    713       1.1  christos 
    714       1.1  christos 
    715       1.1  christos /*******************************************************************************
    716       1.1  christos  *
    717       1.1  christos  * FUNCTION:    AcCheckTextModeCorruption
    718       1.1  christos  *
    719       1.1  christos  * PARAMETERS:  Table           - Table buffer starting with table header
    720       1.1  christos  *
    721       1.1  christos  * RETURN:      Status
    722       1.1  christos  *
    723       1.1  christos  * DESCRIPTION: Check table for text mode file corruption where all linefeed
    724       1.1  christos  *              characters (LF) have been replaced by carriage return linefeed
    725       1.1  christos  *              pairs (CR/LF).
    726       1.1  christos  *
    727       1.1  christos  ******************************************************************************/
    728       1.1  christos 
    729       1.1  christos static ACPI_STATUS
    730       1.1  christos AcCheckTextModeCorruption (
    731       1.1  christos     ACPI_TABLE_HEADER       *Table)
    732       1.1  christos {
    733       1.1  christos     UINT32                  i;
    734       1.1  christos     UINT32                  Pairs = 0;
    735       1.1  christos     UINT8                   *Buffer = ACPI_CAST_PTR (UINT8, Table);
    736       1.1  christos 
    737       1.1  christos 
    738       1.1  christos     /* Scan entire table to determine if each LF has been prefixed with a CR */
    739       1.1  christos 
    740       1.1  christos     for (i = 1; i < Table->Length; i++)
    741       1.1  christos     {
    742       1.1  christos         if (Buffer[i] == 0x0A)
    743       1.1  christos         {
    744       1.1  christos             if (Buffer[i - 1] != 0x0D)
    745       1.1  christos             {
    746       1.1  christos                 /* The LF does not have a preceding CR, table not corrupted */
    747       1.1  christos 
    748       1.1  christos                 return (AE_OK);
    749       1.1  christos             }
    750       1.1  christos             else
    751       1.1  christos             {
    752       1.1  christos                 /* Found a CR/LF pair */
    753       1.1  christos 
    754       1.1  christos                 Pairs++;
    755       1.1  christos             }
    756       1.1  christos 
    757       1.1  christos             i++;
    758       1.1  christos         }
    759       1.1  christos     }
    760       1.1  christos 
    761       1.1  christos     if (!Pairs)
    762       1.1  christos     {
    763       1.1  christos         return (AE_OK);
    764       1.1  christos     }
    765       1.1  christos 
    766       1.1  christos     /*
    767       1.1  christos      * Entire table scanned, each CR is part of a CR/LF pair --
    768       1.1  christos      * meaning that the table was treated as a text file somewhere.
    769       1.1  christos      *
    770       1.1  christos      * NOTE: We can't "fix" the table, because any existing CR/LF pairs in the
    771       1.1  christos      * original table are left untouched by the text conversion process --
    772       1.1  christos      * meaning that we cannot simply replace CR/LF pairs with LFs.
    773       1.1  christos      */
    774       1.1  christos     AcpiOsPrintf ("Table has been corrupted by text mode conversion\n");
    775       1.1  christos     AcpiOsPrintf ("All LFs (%u) were changed to CR/LF pairs\n", Pairs);
    776       1.1  christos     AcpiOsPrintf ("Table cannot be repaired!\n");
    777       1.1  christos 
    778       1.1  christos     return (AE_BAD_VALUE);
    779       1.1  christos }
    780