1a9f12690SJung-uk Kim /****************************************************************************** 2a9f12690SJung-uk Kim * 3a9f12690SJung-uk Kim * Module Name: acapps - common include for ACPI applications/tools 4a9f12690SJung-uk Kim * 5a9f12690SJung-uk Kim *****************************************************************************/ 6a9f12690SJung-uk Kim 70d84335fSJung-uk Kim /****************************************************************************** 80d84335fSJung-uk Kim * 90d84335fSJung-uk Kim * 1. Copyright Notice 100d84335fSJung-uk Kim * 110d84335fSJung-uk Kim * Some or all of this work - Copyright (c) 1999 - 2017, Intel Corp. 12a9f12690SJung-uk Kim * All rights reserved. 13a9f12690SJung-uk Kim * 140d84335fSJung-uk Kim * 2. License 150d84335fSJung-uk Kim * 160d84335fSJung-uk Kim * 2.1. This is your license from Intel Corp. under its intellectual property 170d84335fSJung-uk Kim * rights. You may have additional license terms from the party that provided 180d84335fSJung-uk Kim * you this software, covering your right to use that party's intellectual 190d84335fSJung-uk Kim * property rights. 200d84335fSJung-uk Kim * 210d84335fSJung-uk Kim * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 220d84335fSJung-uk Kim * copy of the source code appearing in this file ("Covered Code") an 230d84335fSJung-uk Kim * irrevocable, perpetual, worldwide license under Intel's copyrights in the 240d84335fSJung-uk Kim * base code distributed originally by Intel ("Original Intel Code") to copy, 250d84335fSJung-uk Kim * make derivatives, distribute, use and display any portion of the Covered 260d84335fSJung-uk Kim * Code in any form, with the right to sublicense such rights; and 270d84335fSJung-uk Kim * 280d84335fSJung-uk Kim * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 290d84335fSJung-uk Kim * license (with the right to sublicense), under only those claims of Intel 300d84335fSJung-uk Kim * patents that are infringed by the Original Intel Code, to make, use, sell, 310d84335fSJung-uk Kim * offer to sell, and import the Covered Code and derivative works thereof 320d84335fSJung-uk Kim * solely to the minimum extent necessary to exercise the above copyright 330d84335fSJung-uk Kim * license, and in no event shall the patent license extend to any additions 340d84335fSJung-uk Kim * to or modifications of the Original Intel Code. No other license or right 350d84335fSJung-uk Kim * is granted directly or by implication, estoppel or otherwise; 360d84335fSJung-uk Kim * 370d84335fSJung-uk Kim * The above copyright and patent license is granted only if the following 380d84335fSJung-uk Kim * conditions are met: 390d84335fSJung-uk Kim * 400d84335fSJung-uk Kim * 3. Conditions 410d84335fSJung-uk Kim * 420d84335fSJung-uk Kim * 3.1. Redistribution of Source with Rights to Further Distribute Source. 430d84335fSJung-uk Kim * Redistribution of source code of any substantial portion of the Covered 440d84335fSJung-uk Kim * Code or modification with rights to further distribute source must include 450d84335fSJung-uk Kim * the above Copyright Notice, the above License, this list of Conditions, 460d84335fSJung-uk Kim * and the following Disclaimer and Export Compliance provision. In addition, 470d84335fSJung-uk Kim * Licensee must cause all Covered Code to which Licensee contributes to 480d84335fSJung-uk Kim * contain a file documenting the changes Licensee made to create that Covered 490d84335fSJung-uk Kim * Code and the date of any change. Licensee must include in that file the 500d84335fSJung-uk Kim * documentation of any changes made by any predecessor Licensee. Licensee 510d84335fSJung-uk Kim * must include a prominent statement that the modification is derived, 520d84335fSJung-uk Kim * directly or indirectly, from Original Intel Code. 530d84335fSJung-uk Kim * 540d84335fSJung-uk Kim * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 550d84335fSJung-uk Kim * Redistribution of source code of any substantial portion of the Covered 560d84335fSJung-uk Kim * Code or modification without rights to further distribute source must 570d84335fSJung-uk Kim * include the following Disclaimer and Export Compliance provision in the 580d84335fSJung-uk Kim * documentation and/or other materials provided with distribution. In 590d84335fSJung-uk Kim * addition, Licensee may not authorize further sublicense of source of any 600d84335fSJung-uk Kim * portion of the Covered Code, and must include terms to the effect that the 610d84335fSJung-uk Kim * license from Licensee to its licensee is limited to the intellectual 620d84335fSJung-uk Kim * property embodied in the software Licensee provides to its licensee, and 630d84335fSJung-uk Kim * not to intellectual property embodied in modifications its licensee may 640d84335fSJung-uk Kim * make. 650d84335fSJung-uk Kim * 660d84335fSJung-uk Kim * 3.3. Redistribution of Executable. Redistribution in executable form of any 670d84335fSJung-uk Kim * substantial portion of the Covered Code or modification must reproduce the 680d84335fSJung-uk Kim * above Copyright Notice, and the following Disclaimer and Export Compliance 690d84335fSJung-uk Kim * provision in the documentation and/or other materials provided with the 700d84335fSJung-uk Kim * distribution. 710d84335fSJung-uk Kim * 720d84335fSJung-uk Kim * 3.4. Intel retains all right, title, and interest in and to the Original 730d84335fSJung-uk Kim * Intel Code. 740d84335fSJung-uk Kim * 750d84335fSJung-uk Kim * 3.5. Neither the name Intel nor any other trademark owned or controlled by 760d84335fSJung-uk Kim * Intel shall be used in advertising or otherwise to promote the sale, use or 770d84335fSJung-uk Kim * other dealings in products derived from or relating to the Covered Code 780d84335fSJung-uk Kim * without prior written authorization from Intel. 790d84335fSJung-uk Kim * 800d84335fSJung-uk Kim * 4. Disclaimer and Export Compliance 810d84335fSJung-uk Kim * 820d84335fSJung-uk Kim * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 830d84335fSJung-uk Kim * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 840d84335fSJung-uk Kim * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 850d84335fSJung-uk Kim * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 860d84335fSJung-uk Kim * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 870d84335fSJung-uk Kim * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 880d84335fSJung-uk Kim * PARTICULAR PURPOSE. 890d84335fSJung-uk Kim * 900d84335fSJung-uk Kim * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 910d84335fSJung-uk Kim * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 920d84335fSJung-uk Kim * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 930d84335fSJung-uk Kim * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 940d84335fSJung-uk Kim * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 950d84335fSJung-uk Kim * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 960d84335fSJung-uk Kim * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 970d84335fSJung-uk Kim * LIMITED REMEDY. 980d84335fSJung-uk Kim * 990d84335fSJung-uk Kim * 4.3. Licensee shall not export, either directly or indirectly, any of this 1000d84335fSJung-uk Kim * software or system incorporating such software without first obtaining any 1010d84335fSJung-uk Kim * required license or other approval from the U. S. Department of Commerce or 1020d84335fSJung-uk Kim * any other agency or department of the United States Government. In the 1030d84335fSJung-uk Kim * event Licensee exports any such software from the United States or 1040d84335fSJung-uk Kim * re-exports any such software from a foreign destination, Licensee shall 1050d84335fSJung-uk Kim * ensure that the distribution and export/re-export of the software is in 1060d84335fSJung-uk Kim * compliance with all laws, regulations, orders, or other restrictions of the 1070d84335fSJung-uk Kim * U.S. Export Administration Regulations. Licensee agrees that neither it nor 1080d84335fSJung-uk Kim * any of its subsidiaries will export/re-export any technical data, process, 1090d84335fSJung-uk Kim * software, or service, directly or indirectly, to any country for which the 1100d84335fSJung-uk Kim * United States government or any agency thereof requires an export license, 1110d84335fSJung-uk Kim * other governmental approval, or letter of assurance, without first obtaining 1120d84335fSJung-uk Kim * such license, approval or letter. 1130d84335fSJung-uk Kim * 1140d84335fSJung-uk Kim ***************************************************************************** 1150d84335fSJung-uk Kim * 1160d84335fSJung-uk Kim * Alternatively, you may choose to be licensed under the terms of the 1170d84335fSJung-uk Kim * following license: 1180d84335fSJung-uk Kim * 119d244b227SJung-uk Kim * Redistribution and use in source and binary forms, with or without 120d244b227SJung-uk Kim * modification, are permitted provided that the following conditions 121d244b227SJung-uk Kim * are met: 122d244b227SJung-uk Kim * 1. Redistributions of source code must retain the above copyright 123d244b227SJung-uk Kim * notice, this list of conditions, and the following disclaimer, 124d244b227SJung-uk Kim * without modification. 125d244b227SJung-uk Kim * 2. Redistributions in binary form must reproduce at minimum a disclaimer 126d244b227SJung-uk Kim * substantially similar to the "NO WARRANTY" disclaimer below 127d244b227SJung-uk Kim * ("Disclaimer") and any redistribution must be conditioned upon 128d244b227SJung-uk Kim * including a substantially similar Disclaimer requirement for further 129d244b227SJung-uk Kim * binary redistribution. 130d244b227SJung-uk Kim * 3. Neither the names of the above-listed copyright holders nor the names 131d244b227SJung-uk Kim * of any contributors may be used to endorse or promote products derived 132d244b227SJung-uk Kim * from this software without specific prior written permission. 133a9f12690SJung-uk Kim * 1340d84335fSJung-uk Kim * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1350d84335fSJung-uk Kim * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1360d84335fSJung-uk Kim * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 1370d84335fSJung-uk Kim * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 1380d84335fSJung-uk Kim * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 1390d84335fSJung-uk Kim * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 1400d84335fSJung-uk Kim * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 1410d84335fSJung-uk Kim * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 1420d84335fSJung-uk Kim * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 1430d84335fSJung-uk Kim * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 1440d84335fSJung-uk Kim * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 1450d84335fSJung-uk Kim * 1460d84335fSJung-uk Kim * Alternatively, you may choose to be licensed under the terms of the 147d244b227SJung-uk Kim * GNU General Public License ("GPL") version 2 as published by the Free 148d244b227SJung-uk Kim * Software Foundation. 149a9f12690SJung-uk Kim * 1500d84335fSJung-uk Kim *****************************************************************************/ 151a9f12690SJung-uk Kim 152a9f12690SJung-uk Kim #ifndef _ACAPPS 153a9f12690SJung-uk Kim #define _ACAPPS 154a9f12690SJung-uk Kim 155493deb39SJung-uk Kim #ifdef ACPI_USE_STANDARD_HEADERS 156493deb39SJung-uk Kim #include <sys/stat.h> 157493deb39SJung-uk Kim #endif /* ACPI_USE_STANDARD_HEADERS */ 158a9f12690SJung-uk Kim 1593c1812acSJung-uk Kim /* Common info for tool signons */ 1603c1812acSJung-uk Kim 1613c1812acSJung-uk Kim #define ACPICA_NAME "Intel ACPI Component Architecture" 16261673a1fSJung-uk Kim #define ACPICA_COPYRIGHT "Copyright (c) 2000 - 2017 Intel Corporation" 1633c1812acSJung-uk Kim 1643c1812acSJung-uk Kim #if ACPI_MACHINE_WIDTH == 64 16561673a1fSJung-uk Kim #define ACPI_WIDTH " (64-bit version)" 1663c1812acSJung-uk Kim 1673c1812acSJung-uk Kim #elif ACPI_MACHINE_WIDTH == 32 16861673a1fSJung-uk Kim #define ACPI_WIDTH " (32-bit version)" 1693c1812acSJung-uk Kim 1703c1812acSJung-uk Kim #else 1713c1812acSJung-uk Kim #error unknown ACPI_MACHINE_WIDTH 17261673a1fSJung-uk Kim #define ACPI_WIDTH " (unknown bit width, not 32 or 64)" 1733c1812acSJung-uk Kim 1743c1812acSJung-uk Kim #endif 1753c1812acSJung-uk Kim 1763c1812acSJung-uk Kim /* Macros for signons and file headers */ 1773c1812acSJung-uk Kim 1783c1812acSJung-uk Kim #define ACPI_COMMON_SIGNON(UtilityName) \ 17961673a1fSJung-uk Kim "\n%s\n%s version %8.8X\n%s\n\n", \ 1803c1812acSJung-uk Kim ACPICA_NAME, \ 18161673a1fSJung-uk Kim UtilityName, ((UINT32) ACPI_CA_VERSION), \ 1823c1812acSJung-uk Kim ACPICA_COPYRIGHT 1833c1812acSJung-uk Kim 1843c1812acSJung-uk Kim #define ACPI_COMMON_HEADER(UtilityName, Prefix) \ 1853c1812acSJung-uk Kim "%s%s\n%s%s version %8.8X%s\n%s%s\n%s\n", \ 1863c1812acSJung-uk Kim Prefix, ACPICA_NAME, \ 1873c1812acSJung-uk Kim Prefix, UtilityName, ((UINT32) ACPI_CA_VERSION), ACPI_WIDTH, \ 1883c1812acSJung-uk Kim Prefix, ACPICA_COPYRIGHT, \ 1893c1812acSJung-uk Kim Prefix 1903c1812acSJung-uk Kim 1913f0275a0SJung-uk Kim /* Macros for usage messages */ 1923f0275a0SJung-uk Kim 1933f0275a0SJung-uk Kim #define ACPI_USAGE_HEADER(Usage) \ 194493deb39SJung-uk Kim printf ("Usage: %s\nOptions:\n", Usage); 195313a0c13SJung-uk Kim 196313a0c13SJung-uk Kim #define ACPI_USAGE_TEXT(Description) \ 197493deb39SJung-uk Kim printf (Description); 1983f0275a0SJung-uk Kim 1993f0275a0SJung-uk Kim #define ACPI_OPTION(Name, Description) \ 200493deb39SJung-uk Kim printf (" %-20s%s\n", Name, Description); 2013f0275a0SJung-uk Kim 2023f0275a0SJung-uk Kim 203f8146b88SJung-uk Kim /* Check for unexpected exceptions */ 204f8146b88SJung-uk Kim 205f8146b88SJung-uk Kim #define ACPI_CHECK_STATUS(Name, Status, Expected) \ 206f8146b88SJung-uk Kim if (Status != Expected) \ 207f8146b88SJung-uk Kim { \ 208f8146b88SJung-uk Kim AcpiOsPrintf ("Unexpected %s from %s (%s-%d)\n", \ 209f8146b88SJung-uk Kim AcpiFormatException (Status), #Name, _AcpiModuleName, __LINE__); \ 210f8146b88SJung-uk Kim } 211f8146b88SJung-uk Kim 212f8146b88SJung-uk Kim /* Check for unexpected non-AE_OK errors */ 213f8146b88SJung-uk Kim 214f8146b88SJung-uk Kim 215f8146b88SJung-uk Kim #define ACPI_CHECK_OK(Name, Status) ACPI_CHECK_STATUS (Name, Status, AE_OK); 216f8146b88SJung-uk Kim 217a9f12690SJung-uk Kim #define FILE_SUFFIX_DISASSEMBLY "dsl" 218f8146b88SJung-uk Kim #define FILE_SUFFIX_BINARY_TABLE ".dat" /* Needs the dot */ 219f8146b88SJung-uk Kim 220f8146b88SJung-uk Kim 221f8146b88SJung-uk Kim /* acfileio */ 222f8146b88SJung-uk Kim 223f8146b88SJung-uk Kim ACPI_STATUS 224f8146b88SJung-uk Kim AcGetAllTablesFromFile ( 225f8146b88SJung-uk Kim char *Filename, 226f8146b88SJung-uk Kim UINT8 GetOnlyAmlTables, 227f8146b88SJung-uk Kim ACPI_NEW_TABLE_DESC **ReturnListHead); 228f8146b88SJung-uk Kim 229f8146b88SJung-uk Kim BOOLEAN 230f8146b88SJung-uk Kim AcIsFileBinary ( 231f8146b88SJung-uk Kim FILE *File); 232f8146b88SJung-uk Kim 233f8146b88SJung-uk Kim ACPI_STATUS 234f8146b88SJung-uk Kim AcValidateTableHeader ( 235f8146b88SJung-uk Kim FILE *File, 236f8146b88SJung-uk Kim long TableOffset); 237f8146b88SJung-uk Kim 238f8146b88SJung-uk Kim 239f8146b88SJung-uk Kim /* Values for GetOnlyAmlTables */ 240f8146b88SJung-uk Kim 241f8146b88SJung-uk Kim #define ACPI_GET_ONLY_AML_TABLES TRUE 242f8146b88SJung-uk Kim #define ACPI_GET_ALL_TABLES FALSE 243a9f12690SJung-uk Kim 244a9f12690SJung-uk Kim 245f556842eSJung-uk Kim /* 246f556842eSJung-uk Kim * getopt 247f556842eSJung-uk Kim */ 248a9f12690SJung-uk Kim int 249a9f12690SJung-uk Kim AcpiGetopt( 250a9f12690SJung-uk Kim int argc, 251a9f12690SJung-uk Kim char **argv, 252a9f12690SJung-uk Kim char *opts); 253a9f12690SJung-uk Kim 254a9d8d09cSJung-uk Kim int 255a9d8d09cSJung-uk Kim AcpiGetoptArgument ( 256a9d8d09cSJung-uk Kim int argc, 257a9d8d09cSJung-uk Kim char **argv); 258a9d8d09cSJung-uk Kim 259f556842eSJung-uk Kim extern int AcpiGbl_Optind; 2609a179dd8SJung-uk Kim extern int AcpiGbl_Opterr; 261a9d8d09cSJung-uk Kim extern int AcpiGbl_SubOptChar; 262f556842eSJung-uk Kim extern char *AcpiGbl_Optarg; 263f556842eSJung-uk Kim 264f556842eSJung-uk Kim 265313a0c13SJung-uk Kim /* 266313a0c13SJung-uk Kim * cmfsize - Common get file size function 267313a0c13SJung-uk Kim */ 268313a0c13SJung-uk Kim UINT32 269313a0c13SJung-uk Kim CmGetFileSize ( 270313a0c13SJung-uk Kim ACPI_FILE File); 271313a0c13SJung-uk Kim 272313a0c13SJung-uk Kim 273a9f12690SJung-uk Kim /* 274a9f12690SJung-uk Kim * adwalk 275a9f12690SJung-uk Kim */ 276a9f12690SJung-uk Kim void 277a9f12690SJung-uk Kim AcpiDmCrossReferenceNamespace ( 278a9f12690SJung-uk Kim ACPI_PARSE_OBJECT *ParseTreeRoot, 279a9f12690SJung-uk Kim ACPI_NAMESPACE_NODE *NamespaceRoot, 280a9f12690SJung-uk Kim ACPI_OWNER_ID OwnerId); 281a9f12690SJung-uk Kim 282a9f12690SJung-uk Kim void 283a9f12690SJung-uk Kim AcpiDmDumpTree ( 284a9f12690SJung-uk Kim ACPI_PARSE_OBJECT *Origin); 285a9f12690SJung-uk Kim 286a9f12690SJung-uk Kim void 287a9f12690SJung-uk Kim AcpiDmFindOrphanMethods ( 288a9f12690SJung-uk Kim ACPI_PARSE_OBJECT *Origin); 289a9f12690SJung-uk Kim 290a9f12690SJung-uk Kim void 291a9f12690SJung-uk Kim AcpiDmFinishNamespaceLoad ( 292a9f12690SJung-uk Kim ACPI_PARSE_OBJECT *ParseTreeRoot, 293a9f12690SJung-uk Kim ACPI_NAMESPACE_NODE *NamespaceRoot, 294a9f12690SJung-uk Kim ACPI_OWNER_ID OwnerId); 295a9f12690SJung-uk Kim 296a9f12690SJung-uk Kim void 297*af051161SJung-uk Kim AcpiDmConvertParseObjects ( 298a9f12690SJung-uk Kim ACPI_PARSE_OBJECT *ParseTreeRoot, 299a9f12690SJung-uk Kim ACPI_NAMESPACE_NODE *NamespaceRoot); 300a9f12690SJung-uk Kim 301f556842eSJung-uk Kim 302a9f12690SJung-uk Kim /* 303a9f12690SJung-uk Kim * adfile 304a9f12690SJung-uk Kim */ 305a9f12690SJung-uk Kim ACPI_STATUS 306a9f12690SJung-uk Kim AdInitialize ( 307a9f12690SJung-uk Kim void); 308a9f12690SJung-uk Kim 309a9f12690SJung-uk Kim char * 310a9f12690SJung-uk Kim FlGenerateFilename ( 311a9f12690SJung-uk Kim char *InputFilename, 312a9f12690SJung-uk Kim char *Suffix); 313a9f12690SJung-uk Kim 314a9f12690SJung-uk Kim ACPI_STATUS 315a9f12690SJung-uk Kim FlSplitInputPathname ( 316a9f12690SJung-uk Kim char *InputPath, 317a9f12690SJung-uk Kim char **OutDirectoryPath, 318a9f12690SJung-uk Kim char **OutFilename); 319a9f12690SJung-uk Kim 320a9f12690SJung-uk Kim char * 321a9f12690SJung-uk Kim AdGenerateFilename ( 322a9f12690SJung-uk Kim char *Prefix, 323a9f12690SJung-uk Kim char *TableId); 324a9f12690SJung-uk Kim 325a9f12690SJung-uk Kim void 326a9f12690SJung-uk Kim AdWriteTable ( 327a9f12690SJung-uk Kim ACPI_TABLE_HEADER *Table, 328a9f12690SJung-uk Kim UINT32 Length, 329a9f12690SJung-uk Kim char *TableName, 330a9f12690SJung-uk Kim char *OemTableId); 331a9f12690SJung-uk Kim 332a9f12690SJung-uk Kim #endif /* _ACAPPS */ 333