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 - 2016, 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 #ifndef _ACAPPS 117 #define _ACAPPS 118 119 #ifdef ACPI_USE_STANDARD_HEADERS 120 #include <sys/stat.h> 121 #endif /* ACPI_USE_STANDARD_HEADERS */ 122 123 /* Common info for tool signons */ 124 125 #define ACPICA_NAME "Intel ACPI Component Architecture" 126 #define ACPICA_COPYRIGHT "Copyright (c) 2000 - 2016 Intel Corporation" 127 128 #if ACPI_MACHINE_WIDTH == 64 129 #define ACPI_WIDTH "-64" 130 131 #elif ACPI_MACHINE_WIDTH == 32 132 #define ACPI_WIDTH "-32" 133 134 #else 135 #error unknown ACPI_MACHINE_WIDTH 136 #define ACPI_WIDTH "-??" 137 138 #endif 139 140 /* Macros for signons and file headers */ 141 142 #define ACPI_COMMON_SIGNON(UtilityName) \ 143 "\n%s\n%s version %8.8X%s\n%s\n\n", \ 144 ACPICA_NAME, \ 145 UtilityName, ((UINT32) ACPI_CA_VERSION), ACPI_WIDTH, \ 146 ACPICA_COPYRIGHT 147 148 #define ACPI_COMMON_HEADER(UtilityName, Prefix) \ 149 "%s%s\n%s%s version %8.8X%s\n%s%s\n%s\n", \ 150 Prefix, ACPICA_NAME, \ 151 Prefix, UtilityName, ((UINT32) ACPI_CA_VERSION), ACPI_WIDTH, \ 152 Prefix, ACPICA_COPYRIGHT, \ 153 Prefix 154 155 /* Macros for usage messages */ 156 157 #define ACPI_USAGE_HEADER(Usage) \ 158 printf ("Usage: %s\nOptions:\n", Usage); 159 160 #define ACPI_USAGE_TEXT(Description) \ 161 printf (Description); 162 163 #define ACPI_OPTION(Name, Description) \ 164 printf (" %-20s%s\n", Name, Description); 165 166 167 /* Check for unexpected exceptions */ 168 169 #define ACPI_CHECK_STATUS(Name, Status, Expected) \ 170 if (Status != Expected) \ 171 { \ 172 AcpiOsPrintf ("Unexpected %s from %s (%s-%d)\n", \ 173 AcpiFormatException (Status), #Name, _AcpiModuleName, __LINE__); \ 174 } 175 176 /* Check for unexpected non-AE_OK errors */ 177 178 179 #define ACPI_CHECK_OK(Name, Status) ACPI_CHECK_STATUS (Name, Status, AE_OK); 180 181 #define FILE_SUFFIX_DISASSEMBLY "dsl" 182 #define FILE_SUFFIX_BINARY_TABLE ".dat" /* Needs the dot */ 183 184 185 /* acfileio */ 186 187 ACPI_STATUS 188 AcGetAllTablesFromFile ( 189 char *Filename, 190 UINT8 GetOnlyAmlTables, 191 ACPI_NEW_TABLE_DESC **ReturnListHead); 192 193 BOOLEAN 194 AcIsFileBinary ( 195 FILE *File); 196 197 ACPI_STATUS 198 AcValidateTableHeader ( 199 FILE *File, 200 long TableOffset); 201 202 203 /* Values for GetOnlyAmlTables */ 204 205 #define ACPI_GET_ONLY_AML_TABLES TRUE 206 #define ACPI_GET_ALL_TABLES FALSE 207 208 209 /* 210 * getopt 211 */ 212 int 213 AcpiGetopt( 214 int argc, 215 char **argv, 216 char *opts); 217 218 int 219 AcpiGetoptArgument ( 220 int argc, 221 char **argv); 222 223 extern int AcpiGbl_Optind; 224 extern int AcpiGbl_Opterr; 225 extern int AcpiGbl_SubOptChar; 226 extern char *AcpiGbl_Optarg; 227 228 229 /* 230 * cmfsize - Common get file size function 231 */ 232 UINT32 233 CmGetFileSize ( 234 ACPI_FILE File); 235 236 237 /* 238 * adwalk 239 */ 240 void 241 AcpiDmCrossReferenceNamespace ( 242 ACPI_PARSE_OBJECT *ParseTreeRoot, 243 ACPI_NAMESPACE_NODE *NamespaceRoot, 244 ACPI_OWNER_ID OwnerId); 245 246 void 247 AcpiDmDumpTree ( 248 ACPI_PARSE_OBJECT *Origin); 249 250 void 251 AcpiDmFindOrphanMethods ( 252 ACPI_PARSE_OBJECT *Origin); 253 254 void 255 AcpiDmFinishNamespaceLoad ( 256 ACPI_PARSE_OBJECT *ParseTreeRoot, 257 ACPI_NAMESPACE_NODE *NamespaceRoot, 258 ACPI_OWNER_ID OwnerId); 259 260 void 261 AcpiDmConvertResourceIndexes ( 262 ACPI_PARSE_OBJECT *ParseTreeRoot, 263 ACPI_NAMESPACE_NODE *NamespaceRoot); 264 265 266 /* 267 * adfile 268 */ 269 ACPI_STATUS 270 AdInitialize ( 271 void); 272 273 char * 274 FlGenerateFilename ( 275 char *InputFilename, 276 char *Suffix); 277 278 ACPI_STATUS 279 FlSplitInputPathname ( 280 char *InputPath, 281 char **OutDirectoryPath, 282 char **OutFilename); 283 284 char * 285 AdGenerateFilename ( 286 char *Prefix, 287 char *TableId); 288 289 void 290 AdWriteTable ( 291 ACPI_TABLE_HEADER *Table, 292 UINT32 Length, 293 char *TableName, 294 char *OemTableId); 295 296 #endif /* _ACAPPS */ 297