1 /****************************************************************************** 2 * 3 * Module Name: acapps - common include for ACPI applications/tools 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2017, 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 #ifndef _ACAPPS 153 #define _ACAPPS 154 155 #ifdef ACPI_USE_STANDARD_HEADERS 156 #include <sys/stat.h> 157 #endif /* ACPI_USE_STANDARD_HEADERS */ 158 159 /* Common info for tool signons */ 160 161 #define ACPICA_NAME "Intel ACPI Component Architecture" 162 #define ACPICA_COPYRIGHT "Copyright (c) 2000 - 2017 Intel Corporation" 163 164 #if ACPI_MACHINE_WIDTH == 64 165 #define ACPI_WIDTH " (64-bit version)" 166 167 #elif ACPI_MACHINE_WIDTH == 32 168 #define ACPI_WIDTH " (32-bit version)" 169 170 #else 171 #error unknown ACPI_MACHINE_WIDTH 172 #define ACPI_WIDTH " (unknown bit width, not 32 or 64)" 173 174 #endif 175 176 /* Macros for signons and file headers */ 177 178 #define ACPI_COMMON_SIGNON(UtilityName) \ 179 "\n%s\n%s version %8.8X\n%s\n\n", \ 180 ACPICA_NAME, \ 181 UtilityName, ((UINT32) ACPI_CA_VERSION), \ 182 ACPICA_COPYRIGHT 183 184 #define ACPI_COMMON_HEADER(UtilityName, Prefix) \ 185 "%s%s\n%s%s version %8.8X%s\n%s%s\n%s\n", \ 186 Prefix, ACPICA_NAME, \ 187 Prefix, UtilityName, ((UINT32) ACPI_CA_VERSION), ACPI_WIDTH, \ 188 Prefix, ACPICA_COPYRIGHT, \ 189 Prefix 190 191 /* Macros for usage messages */ 192 193 #define ACPI_USAGE_HEADER(Usage) \ 194 printf ("Usage: %s\nOptions:\n", Usage); 195 196 #define ACPI_USAGE_TEXT(Description) \ 197 printf (Description); 198 199 #define ACPI_OPTION(Name, Description) \ 200 printf (" %-20s%s\n", Name, Description); 201 202 203 /* Check for unexpected exceptions */ 204 205 #define ACPI_CHECK_STATUS(Name, Status, Expected) \ 206 if (Status != Expected) \ 207 { \ 208 AcpiOsPrintf ("Unexpected %s from %s (%s-%d)\n", \ 209 AcpiFormatException (Status), #Name, _AcpiModuleName, __LINE__); \ 210 } 211 212 /* Check for unexpected non-AE_OK errors */ 213 214 215 #define ACPI_CHECK_OK(Name, Status) ACPI_CHECK_STATUS (Name, Status, AE_OK); 216 217 #define FILE_SUFFIX_DISASSEMBLY "dsl" 218 #define FILE_SUFFIX_BINARY_TABLE ".dat" /* Needs the dot */ 219 220 221 /* acfileio */ 222 223 ACPI_STATUS 224 AcGetAllTablesFromFile ( 225 char *Filename, 226 UINT8 GetOnlyAmlTables, 227 ACPI_NEW_TABLE_DESC **ReturnListHead); 228 229 BOOLEAN 230 AcIsFileBinary ( 231 FILE *File); 232 233 ACPI_STATUS 234 AcValidateTableHeader ( 235 FILE *File, 236 long TableOffset); 237 238 239 /* Values for GetOnlyAmlTables */ 240 241 #define ACPI_GET_ONLY_AML_TABLES TRUE 242 #define ACPI_GET_ALL_TABLES FALSE 243 244 245 /* 246 * getopt 247 */ 248 int 249 AcpiGetopt( 250 int argc, 251 char **argv, 252 char *opts); 253 254 int 255 AcpiGetoptArgument ( 256 int argc, 257 char **argv); 258 259 extern int AcpiGbl_Optind; 260 extern int AcpiGbl_Opterr; 261 extern int AcpiGbl_SubOptChar; 262 extern char *AcpiGbl_Optarg; 263 264 265 /* 266 * cmfsize - Common get file size function 267 */ 268 UINT32 269 CmGetFileSize ( 270 ACPI_FILE File); 271 272 273 /* 274 * adwalk 275 */ 276 void 277 AcpiDmCrossReferenceNamespace ( 278 ACPI_PARSE_OBJECT *ParseTreeRoot, 279 ACPI_NAMESPACE_NODE *NamespaceRoot, 280 ACPI_OWNER_ID OwnerId); 281 282 void 283 AcpiDmDumpTree ( 284 ACPI_PARSE_OBJECT *Origin); 285 286 void 287 AcpiDmFindOrphanMethods ( 288 ACPI_PARSE_OBJECT *Origin); 289 290 void 291 AcpiDmFinishNamespaceLoad ( 292 ACPI_PARSE_OBJECT *ParseTreeRoot, 293 ACPI_NAMESPACE_NODE *NamespaceRoot, 294 ACPI_OWNER_ID OwnerId); 295 296 void 297 AcpiDmConvertResourceIndexes ( 298 ACPI_PARSE_OBJECT *ParseTreeRoot, 299 ACPI_NAMESPACE_NODE *NamespaceRoot); 300 301 302 /* 303 * adfile 304 */ 305 ACPI_STATUS 306 AdInitialize ( 307 void); 308 309 char * 310 FlGenerateFilename ( 311 char *InputFilename, 312 char *Suffix); 313 314 ACPI_STATUS 315 FlSplitInputPathname ( 316 char *InputPath, 317 char **OutDirectoryPath, 318 char **OutFilename); 319 320 char * 321 AdGenerateFilename ( 322 char *Prefix, 323 char *TableId); 324 325 void 326 AdWriteTable ( 327 ACPI_TABLE_HEADER *Table, 328 UINT32 Length, 329 char *TableName, 330 char *OemTableId); 331 332 #endif /* _ACAPPS */ 333