Home | History | Annotate | Line # | Download | only in acpixtract
      1 /******************************************************************************
      2  *
      3  * Module Name: acpixtract.h - Include for acpixtract utility
      4  *
      5  *****************************************************************************/
      6 
      7 /******************************************************************************
      8  *
      9  * 1. Copyright Notice
     10  *
     11  * Some or all of this work - Copyright (c) 1999 - 2025, 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  * Alternatively, you may choose to be licensed under the terms of the
    117  * following license:
    118  *
    119  * Redistribution and use in source and binary forms, with or without
    120  * modification, are permitted provided that the following conditions
    121  * are met:
    122  * 1. Redistributions of source code must retain the above copyright
    123  *    notice, this list of conditions, and the following disclaimer,
    124  *    without modification.
    125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
    126  *    substantially similar to the "NO WARRANTY" disclaimer below
    127  *    ("Disclaimer") and any redistribution must be conditioned upon
    128  *    including a substantially similar Disclaimer requirement for further
    129  *    binary redistribution.
    130  * 3. Neither the names of the above-listed copyright holders nor the names
    131  *    of any contributors may be used to endorse or promote products derived
    132  *    from this software without specific prior written permission.
    133  *
    134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
    138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
    144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    145  *
    146  * Alternatively, you may choose to be licensed under the terms of the
    147  * GNU General Public License ("GPL") version 2 as published by the Free
    148  * Software Foundation.
    149  *
    150  *****************************************************************************/
    151 
    152 #include "acpi.h"
    153 #include "accommon.h"
    154 #include "acapps.h"
    155 #include <stdio.h>
    156 
    157 
    158 #undef ACPI_GLOBAL
    159 
    160 #ifdef DEFINE_ACPIXTRACT_GLOBALS
    161 #define ACPI_GLOBAL(type,name) \
    162     extern type name; \
    163     type name
    164 
    165 #else
    166 #define ACPI_GLOBAL(type,name) \
    167     extern type name
    168 #endif
    169 
    170 
    171 /* Options */
    172 
    173 #define AX_EXTRACT_ALL              0
    174 #define AX_LIST_ALL                 1
    175 #define AX_EXTRACT_SIGNATURE        2
    176 #define AX_EXTRACT_AML_TABLES       3
    177 #define AX_EXTRACT_MULTI_TABLE      4
    178 
    179 #define AX_OPTIONAL_TABLES          0
    180 #define AX_REQUIRED_TABLE           1
    181 
    182 #define AX_UTILITY_NAME             "ACPI Binary Table Extraction Utility"
    183 #define AX_SUPPORTED_OPTIONS        "afhlms:v^"
    184 #define AX_MULTI_TABLE_FILENAME     "amltables.dat"
    185 #define AX_TABLE_INFO_FORMAT        "  %4.4s - %7u bytes written (0x%8.8X) - %s\n"
    186 
    187 /* Extraction states */
    188 
    189 #define AX_STATE_FIND_HEADER        0
    190 #define AX_STATE_EXTRACT_DATA       1
    191 
    192 /* Miscellaneous constants */
    193 
    194 #define AX_LINE_BUFFER_SIZE         256
    195 #define AX_MIN_BLOCK_HEADER_LENGTH  6   /* strlen ("DSDT @") */
    196 #define AX_HEX_DATA_LENGTH          49  /*  (3 * 16) + 1 for the colon delimiter */
    197 #define AX_IS_TABLE_BLOCK_HEADER    (strlen (Gbl_LineBuffer) < AX_HEX_DATA_LENGTH && \
    198                                     strstr (Gbl_LineBuffer, " @ "))
    199 
    200 
    201 typedef struct AxTableInfo
    202 {
    203     UINT32                  Signature;
    204     unsigned int            Instances;
    205     unsigned int            NextInstance;
    206     struct AxTableInfo      *Next;
    207 
    208 } AX_TABLE_INFO;
    209 
    210 
    211 /* Globals */
    212 
    213 ACPI_GLOBAL (char,           Gbl_LineBuffer[AX_LINE_BUFFER_SIZE]);
    214 ACPI_GLOBAL (char,           Gbl_HeaderBuffer[AX_LINE_BUFFER_SIZE]);
    215 ACPI_GLOBAL (char,           Gbl_InstanceBuffer[AX_LINE_BUFFER_SIZE]);
    216 ACPI_GLOBAL (AX_TABLE_INFO, *Gbl_TableListHead);
    217 ACPI_GLOBAL (char,           Gbl_OutputFilename[32]);
    218 ACPI_GLOBAL (unsigned char,  Gbl_BinaryData[16]);
    219 ACPI_GLOBAL (unsigned int,   Gbl_TableCount);
    220 ACPI_GLOBAL (BOOLEAN,        Gbl_ForceExtraction);
    221 
    222 
    223 /*
    224  * acpixtract.c
    225  */
    226 int
    227 AxExtractTables (
    228     char                    *InputPathname,
    229     char                    *Signature,
    230     unsigned int            MinimumInstances);
    231 
    232 int
    233 AxExtractToMultiAmlFile (
    234     char                    *InputPathname);
    235 
    236 int
    237 AxListAllTables (
    238     char                    *InputPathname);
    239 
    240 
    241 /*
    242  * axutils.c
    243  */
    244 unsigned int
    245 AxCountTableInstances (
    246     char                    *InputPathname,
    247     char                    *Signature);
    248 
    249 unsigned int
    250 AxGetNextInstance (
    251     char                    *InputPathname,
    252     char                    *Signature);
    253 
    254 void
    255 AxNormalizeSignature (
    256     char                    *Signature);
    257 
    258 void
    259 AxCheckAscii (
    260     char                    *Name,
    261     int                     Count);
    262 
    263 BOOLEAN
    264 AxIsFileAscii (
    265     FILE                    *Handle);
    266 
    267 BOOLEAN
    268 AxIsHexDataLine (
    269     void);
    270 
    271 BOOLEAN
    272 AxIsEmptyLine (
    273     char                    *Buffer);
    274 
    275 BOOLEAN
    276 AxIsDataBlockHeader (
    277     void);
    278 
    279 int
    280 AxConvertAndWrite (
    281     FILE                    *OutputFile,
    282     char                    *ThisSignature);
    283 
    284 int
    285 AxConvertToBinary (
    286     char                    *InputLine,
    287     unsigned char           *OutputData);
    288 
    289 void
    290 AxDumpTableHeader (
    291     unsigned char           *Header);
    292