1820c5b08SSascha Wildner /****************************************************************************** 2820c5b08SSascha Wildner * 3820c5b08SSascha Wildner * Module Name: acpixtract.h - Include for acpixtract utility 4820c5b08SSascha Wildner * 5820c5b08SSascha Wildner *****************************************************************************/ 6820c5b08SSascha Wildner 7b4315fc7SSascha Wildner /****************************************************************************** 8b4315fc7SSascha Wildner * 9b4315fc7SSascha Wildner * 1. Copyright Notice 10b4315fc7SSascha Wildner * 11*383048acSSascha Wildner * Some or all of this work - Copyright (c) 1999 - 2021, Intel Corp. 12820c5b08SSascha Wildner * All rights reserved. 13820c5b08SSascha Wildner * 14b4315fc7SSascha Wildner * 2. License 15b4315fc7SSascha Wildner * 16b4315fc7SSascha Wildner * 2.1. This is your license from Intel Corp. under its intellectual property 17b4315fc7SSascha Wildner * rights. You may have additional license terms from the party that provided 18b4315fc7SSascha Wildner * you this software, covering your right to use that party's intellectual 19b4315fc7SSascha Wildner * property rights. 20b4315fc7SSascha Wildner * 21b4315fc7SSascha Wildner * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 22b4315fc7SSascha Wildner * copy of the source code appearing in this file ("Covered Code") an 23b4315fc7SSascha Wildner * irrevocable, perpetual, worldwide license under Intel's copyrights in the 24b4315fc7SSascha Wildner * base code distributed originally by Intel ("Original Intel Code") to copy, 25b4315fc7SSascha Wildner * make derivatives, distribute, use and display any portion of the Covered 26b4315fc7SSascha Wildner * Code in any form, with the right to sublicense such rights; and 27b4315fc7SSascha Wildner * 28b4315fc7SSascha Wildner * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 29b4315fc7SSascha Wildner * license (with the right to sublicense), under only those claims of Intel 30b4315fc7SSascha Wildner * patents that are infringed by the Original Intel Code, to make, use, sell, 31b4315fc7SSascha Wildner * offer to sell, and import the Covered Code and derivative works thereof 32b4315fc7SSascha Wildner * solely to the minimum extent necessary to exercise the above copyright 33b4315fc7SSascha Wildner * license, and in no event shall the patent license extend to any additions 34b4315fc7SSascha Wildner * to or modifications of the Original Intel Code. No other license or right 35b4315fc7SSascha Wildner * is granted directly or by implication, estoppel or otherwise; 36b4315fc7SSascha Wildner * 37b4315fc7SSascha Wildner * The above copyright and patent license is granted only if the following 38b4315fc7SSascha Wildner * conditions are met: 39b4315fc7SSascha Wildner * 40b4315fc7SSascha Wildner * 3. Conditions 41b4315fc7SSascha Wildner * 42b4315fc7SSascha Wildner * 3.1. Redistribution of Source with Rights to Further Distribute Source. 43b4315fc7SSascha Wildner * Redistribution of source code of any substantial portion of the Covered 44b4315fc7SSascha Wildner * Code or modification with rights to further distribute source must include 45b4315fc7SSascha Wildner * the above Copyright Notice, the above License, this list of Conditions, 46b4315fc7SSascha Wildner * and the following Disclaimer and Export Compliance provision. In addition, 47b4315fc7SSascha Wildner * Licensee must cause all Covered Code to which Licensee contributes to 48b4315fc7SSascha Wildner * contain a file documenting the changes Licensee made to create that Covered 49b4315fc7SSascha Wildner * Code and the date of any change. Licensee must include in that file the 50b4315fc7SSascha Wildner * documentation of any changes made by any predecessor Licensee. Licensee 51b4315fc7SSascha Wildner * must include a prominent statement that the modification is derived, 52b4315fc7SSascha Wildner * directly or indirectly, from Original Intel Code. 53b4315fc7SSascha Wildner * 54b4315fc7SSascha Wildner * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 55b4315fc7SSascha Wildner * Redistribution of source code of any substantial portion of the Covered 56b4315fc7SSascha Wildner * Code or modification without rights to further distribute source must 57b4315fc7SSascha Wildner * include the following Disclaimer and Export Compliance provision in the 58b4315fc7SSascha Wildner * documentation and/or other materials provided with distribution. In 59b4315fc7SSascha Wildner * addition, Licensee may not authorize further sublicense of source of any 60b4315fc7SSascha Wildner * portion of the Covered Code, and must include terms to the effect that the 61b4315fc7SSascha Wildner * license from Licensee to its licensee is limited to the intellectual 62b4315fc7SSascha Wildner * property embodied in the software Licensee provides to its licensee, and 63b4315fc7SSascha Wildner * not to intellectual property embodied in modifications its licensee may 64b4315fc7SSascha Wildner * make. 65b4315fc7SSascha Wildner * 66b4315fc7SSascha Wildner * 3.3. Redistribution of Executable. Redistribution in executable form of any 67b4315fc7SSascha Wildner * substantial portion of the Covered Code or modification must reproduce the 68b4315fc7SSascha Wildner * above Copyright Notice, and the following Disclaimer and Export Compliance 69b4315fc7SSascha Wildner * provision in the documentation and/or other materials provided with the 70b4315fc7SSascha Wildner * distribution. 71b4315fc7SSascha Wildner * 72b4315fc7SSascha Wildner * 3.4. Intel retains all right, title, and interest in and to the Original 73b4315fc7SSascha Wildner * Intel Code. 74b4315fc7SSascha Wildner * 75b4315fc7SSascha Wildner * 3.5. Neither the name Intel nor any other trademark owned or controlled by 76b4315fc7SSascha Wildner * Intel shall be used in advertising or otherwise to promote the sale, use or 77b4315fc7SSascha Wildner * other dealings in products derived from or relating to the Covered Code 78b4315fc7SSascha Wildner * without prior written authorization from Intel. 79b4315fc7SSascha Wildner * 80b4315fc7SSascha Wildner * 4. Disclaimer and Export Compliance 81b4315fc7SSascha Wildner * 82b4315fc7SSascha Wildner * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 83b4315fc7SSascha Wildner * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 84b4315fc7SSascha Wildner * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 85b4315fc7SSascha Wildner * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 86b4315fc7SSascha Wildner * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 87b4315fc7SSascha Wildner * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 88b4315fc7SSascha Wildner * PARTICULAR PURPOSE. 89b4315fc7SSascha Wildner * 90b4315fc7SSascha Wildner * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 91b4315fc7SSascha Wildner * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 92b4315fc7SSascha Wildner * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 93b4315fc7SSascha Wildner * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 94b4315fc7SSascha Wildner * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 95b4315fc7SSascha Wildner * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 96b4315fc7SSascha Wildner * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 97b4315fc7SSascha Wildner * LIMITED REMEDY. 98b4315fc7SSascha Wildner * 99b4315fc7SSascha Wildner * 4.3. Licensee shall not export, either directly or indirectly, any of this 100b4315fc7SSascha Wildner * software or system incorporating such software without first obtaining any 101b4315fc7SSascha Wildner * required license or other approval from the U. S. Department of Commerce or 102b4315fc7SSascha Wildner * any other agency or department of the United States Government. In the 103b4315fc7SSascha Wildner * event Licensee exports any such software from the United States or 104b4315fc7SSascha Wildner * re-exports any such software from a foreign destination, Licensee shall 105b4315fc7SSascha Wildner * ensure that the distribution and export/re-export of the software is in 106b4315fc7SSascha Wildner * compliance with all laws, regulations, orders, or other restrictions of the 107b4315fc7SSascha Wildner * U.S. Export Administration Regulations. Licensee agrees that neither it nor 108b4315fc7SSascha Wildner * any of its subsidiaries will export/re-export any technical data, process, 109b4315fc7SSascha Wildner * software, or service, directly or indirectly, to any country for which the 110b4315fc7SSascha Wildner * United States government or any agency thereof requires an export license, 111b4315fc7SSascha Wildner * other governmental approval, or letter of assurance, without first obtaining 112b4315fc7SSascha Wildner * such license, approval or letter. 113b4315fc7SSascha Wildner * 114b4315fc7SSascha Wildner ***************************************************************************** 115b4315fc7SSascha Wildner * 116b4315fc7SSascha Wildner * Alternatively, you may choose to be licensed under the terms of the 117b4315fc7SSascha Wildner * following license: 118b4315fc7SSascha Wildner * 119820c5b08SSascha Wildner * Redistribution and use in source and binary forms, with or without 120820c5b08SSascha Wildner * modification, are permitted provided that the following conditions 121820c5b08SSascha Wildner * are met: 122820c5b08SSascha Wildner * 1. Redistributions of source code must retain the above copyright 123820c5b08SSascha Wildner * notice, this list of conditions, and the following disclaimer, 124820c5b08SSascha Wildner * without modification. 125820c5b08SSascha Wildner * 2. Redistributions in binary form must reproduce at minimum a disclaimer 126820c5b08SSascha Wildner * substantially similar to the "NO WARRANTY" disclaimer below 127820c5b08SSascha Wildner * ("Disclaimer") and any redistribution must be conditioned upon 128820c5b08SSascha Wildner * including a substantially similar Disclaimer requirement for further 129820c5b08SSascha Wildner * binary redistribution. 130820c5b08SSascha Wildner * 3. Neither the names of the above-listed copyright holders nor the names 131820c5b08SSascha Wildner * of any contributors may be used to endorse or promote products derived 132820c5b08SSascha Wildner * from this software without specific prior written permission. 133820c5b08SSascha Wildner * 134b4315fc7SSascha Wildner * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 135b4315fc7SSascha Wildner * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 136b4315fc7SSascha Wildner * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 137b4315fc7SSascha Wildner * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 138b4315fc7SSascha Wildner * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 139b4315fc7SSascha Wildner * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 140b4315fc7SSascha Wildner * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 141b4315fc7SSascha Wildner * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 142b4315fc7SSascha Wildner * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 143b4315fc7SSascha Wildner * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 144b4315fc7SSascha Wildner * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 145b4315fc7SSascha Wildner * 146b4315fc7SSascha Wildner * Alternatively, you may choose to be licensed under the terms of the 147820c5b08SSascha Wildner * GNU General Public License ("GPL") version 2 as published by the Free 148820c5b08SSascha Wildner * Software Foundation. 149820c5b08SSascha Wildner * 150b4315fc7SSascha Wildner *****************************************************************************/ 151820c5b08SSascha Wildner 152820c5b08SSascha Wildner #include "acpi.h" 153820c5b08SSascha Wildner #include "accommon.h" 154820c5b08SSascha Wildner #include "acapps.h" 155820c5b08SSascha Wildner #include <stdio.h> 156820c5b08SSascha Wildner 157820c5b08SSascha Wildner 158820c5b08SSascha Wildner #undef ACPI_GLOBAL 159820c5b08SSascha Wildner 160820c5b08SSascha Wildner #ifdef DEFINE_ACPIXTRACT_GLOBALS 161820c5b08SSascha Wildner #define ACPI_GLOBAL(type,name) \ 162820c5b08SSascha Wildner extern type name; \ 163820c5b08SSascha Wildner type name 164820c5b08SSascha Wildner 165820c5b08SSascha Wildner #else 166820c5b08SSascha Wildner #define ACPI_GLOBAL(type,name) \ 167820c5b08SSascha Wildner extern type name 168820c5b08SSascha Wildner #endif 169820c5b08SSascha Wildner 170820c5b08SSascha Wildner 171820c5b08SSascha Wildner /* Options */ 172820c5b08SSascha Wildner 173820c5b08SSascha Wildner #define AX_EXTRACT_ALL 0 174820c5b08SSascha Wildner #define AX_LIST_ALL 1 175820c5b08SSascha Wildner #define AX_EXTRACT_SIGNATURE 2 176820c5b08SSascha Wildner #define AX_EXTRACT_AML_TABLES 3 177820c5b08SSascha Wildner #define AX_EXTRACT_MULTI_TABLE 4 178820c5b08SSascha Wildner 179820c5b08SSascha Wildner #define AX_OPTIONAL_TABLES 0 180820c5b08SSascha Wildner #define AX_REQUIRED_TABLE 1 181820c5b08SSascha Wildner 182820c5b08SSascha Wildner #define AX_UTILITY_NAME "ACPI Binary Table Extraction Utility" 1837bcb6cafSSascha Wildner #define AX_SUPPORTED_OPTIONS "afhlms:v^" 184820c5b08SSascha Wildner #define AX_MULTI_TABLE_FILENAME "amltables.dat" 1857bcb6cafSSascha Wildner #define AX_TABLE_INFO_FORMAT " %4.4s - %7u bytes written (0x%8.8X) - %s\n" 186820c5b08SSascha Wildner 187820c5b08SSascha Wildner /* Extraction states */ 188820c5b08SSascha Wildner 189820c5b08SSascha Wildner #define AX_STATE_FIND_HEADER 0 190820c5b08SSascha Wildner #define AX_STATE_EXTRACT_DATA 1 191820c5b08SSascha Wildner 192820c5b08SSascha Wildner /* Miscellaneous constants */ 193820c5b08SSascha Wildner 194820c5b08SSascha Wildner #define AX_LINE_BUFFER_SIZE 256 195820c5b08SSascha Wildner #define AX_MIN_BLOCK_HEADER_LENGTH 6 /* strlen ("DSDT @") */ 1967bcb6cafSSascha Wildner #define AX_HEX_DATA_LENGTH 49 /* (3 * 16) + 1 for the colon delimiter */ 19771c97a3cSSascha Wildner #define AX_IS_TABLE_BLOCK_HEADER (strlen (Gbl_LineBuffer) < AX_HEX_DATA_LENGTH && \ 19871c97a3cSSascha Wildner strstr (Gbl_LineBuffer, " @ ")) 199820c5b08SSascha Wildner 200820c5b08SSascha Wildner 201820c5b08SSascha Wildner typedef struct AxTableInfo 202820c5b08SSascha Wildner { 203820c5b08SSascha Wildner UINT32 Signature; 204820c5b08SSascha Wildner unsigned int Instances; 205820c5b08SSascha Wildner unsigned int NextInstance; 206820c5b08SSascha Wildner struct AxTableInfo *Next; 207820c5b08SSascha Wildner 208820c5b08SSascha Wildner } AX_TABLE_INFO; 209820c5b08SSascha Wildner 210820c5b08SSascha Wildner 211820c5b08SSascha Wildner /* Globals */ 212820c5b08SSascha Wildner 213820c5b08SSascha Wildner ACPI_GLOBAL (char, Gbl_LineBuffer[AX_LINE_BUFFER_SIZE]); 214820c5b08SSascha Wildner ACPI_GLOBAL (char, Gbl_HeaderBuffer[AX_LINE_BUFFER_SIZE]); 215820c5b08SSascha Wildner ACPI_GLOBAL (char, Gbl_InstanceBuffer[AX_LINE_BUFFER_SIZE]); 216820c5b08SSascha Wildner ACPI_GLOBAL (AX_TABLE_INFO, *Gbl_TableListHead); 217820c5b08SSascha Wildner ACPI_GLOBAL (char, Gbl_OutputFilename[32]); 218820c5b08SSascha Wildner ACPI_GLOBAL (unsigned char, Gbl_BinaryData[16]); 219820c5b08SSascha Wildner ACPI_GLOBAL (unsigned int, Gbl_TableCount); 2207bcb6cafSSascha Wildner ACPI_GLOBAL (BOOLEAN, Gbl_ForceExtraction); 2217bcb6cafSSascha Wildner 222820c5b08SSascha Wildner 223820c5b08SSascha Wildner /* 224820c5b08SSascha Wildner * acpixtract.c 225820c5b08SSascha Wildner */ 226820c5b08SSascha Wildner int 227820c5b08SSascha Wildner AxExtractTables ( 228820c5b08SSascha Wildner char *InputPathname, 229820c5b08SSascha Wildner char *Signature, 230820c5b08SSascha Wildner unsigned int MinimumInstances); 231820c5b08SSascha Wildner 232820c5b08SSascha Wildner int 233820c5b08SSascha Wildner AxExtractToMultiAmlFile ( 234820c5b08SSascha Wildner char *InputPathname); 235820c5b08SSascha Wildner 236820c5b08SSascha Wildner int 2377bcb6cafSSascha Wildner AxListAllTables ( 238820c5b08SSascha Wildner char *InputPathname); 239820c5b08SSascha Wildner 240820c5b08SSascha Wildner 241820c5b08SSascha Wildner /* 242820c5b08SSascha Wildner * axutils.c 243820c5b08SSascha Wildner */ 244820c5b08SSascha Wildner unsigned int 245820c5b08SSascha Wildner AxCountTableInstances ( 246820c5b08SSascha Wildner char *InputPathname, 247820c5b08SSascha Wildner char *Signature); 248820c5b08SSascha Wildner 249820c5b08SSascha Wildner unsigned int 250820c5b08SSascha Wildner AxGetNextInstance ( 251820c5b08SSascha Wildner char *InputPathname, 252820c5b08SSascha Wildner char *Signature); 253820c5b08SSascha Wildner 254820c5b08SSascha Wildner void 255820c5b08SSascha Wildner AxNormalizeSignature ( 256820c5b08SSascha Wildner char *Signature); 257820c5b08SSascha Wildner 258820c5b08SSascha Wildner void 259820c5b08SSascha Wildner AxCheckAscii ( 260820c5b08SSascha Wildner char *Name, 261820c5b08SSascha Wildner int Count); 262820c5b08SSascha Wildner 2637bcb6cafSSascha Wildner BOOLEAN 2647bcb6cafSSascha Wildner AxIsFileAscii ( 2657bcb6cafSSascha Wildner FILE *Handle); 2667bcb6cafSSascha Wildner 2677bcb6cafSSascha Wildner BOOLEAN 2687bcb6cafSSascha Wildner AxIsHexDataLine ( 2697bcb6cafSSascha Wildner void); 2707bcb6cafSSascha Wildner 2717bcb6cafSSascha Wildner BOOLEAN 272820c5b08SSascha Wildner AxIsEmptyLine ( 273820c5b08SSascha Wildner char *Buffer); 274820c5b08SSascha Wildner 2757bcb6cafSSascha Wildner BOOLEAN 276820c5b08SSascha Wildner AxIsDataBlockHeader ( 277820c5b08SSascha Wildner void); 278820c5b08SSascha Wildner 279ef944814SSascha Wildner int 2807bcb6cafSSascha Wildner AxConvertAndWrite ( 281820c5b08SSascha Wildner FILE *OutputFile, 282ef944814SSascha Wildner char *ThisSignature); 283820c5b08SSascha Wildner 284ef944814SSascha Wildner int 2857bcb6cafSSascha Wildner AxConvertToBinary ( 286820c5b08SSascha Wildner char *InputLine, 287820c5b08SSascha Wildner unsigned char *OutputData); 2887bcb6cafSSascha Wildner 2897bcb6cafSSascha Wildner void 2907bcb6cafSSascha Wildner AxDumpTableHeader ( 2917bcb6cafSSascha Wildner unsigned char *Header); 292