1 /****************************************************************************** 2 * 3 * Module Name: acapps - common include for ACPI applications/tools 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2016, Intel Corp. 9 * All rights reserved. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions, and the following disclaimer, 16 * without modification. 17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 18 * substantially similar to the "NO WARRANTY" disclaimer below 19 * ("Disclaimer") and any redistribution must be conditioned upon 20 * including a substantially similar Disclaimer requirement for further 21 * binary redistribution. 22 * 3. Neither the names of the above-listed copyright holders nor the names 23 * of any contributors may be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * Alternatively, this software may be distributed under the terms of the 27 * GNU General Public License ("GPL") version 2 as published by the Free 28 * Software Foundation. 29 * 30 * NO WARRANTY 31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 41 * POSSIBILITY OF SUCH DAMAGES. 42 */ 43 44 #ifndef _ACAPPS 45 #define _ACAPPS 46 47 #ifdef ACPI_USE_STANDARD_HEADERS 48 #include <sys/stat.h> 49 #endif /* ACPI_USE_STANDARD_HEADERS */ 50 51 /* Common info for tool signons */ 52 53 #define ACPICA_NAME "Intel ACPI Component Architecture" 54 #define ACPICA_COPYRIGHT "Copyright (c) 2000 - 2016 Intel Corporation" 55 56 #if ACPI_MACHINE_WIDTH == 64 57 #define ACPI_WIDTH "-64" 58 59 #elif ACPI_MACHINE_WIDTH == 32 60 #define ACPI_WIDTH "-32" 61 62 #else 63 #error unknown ACPI_MACHINE_WIDTH 64 #define ACPI_WIDTH "-??" 65 66 #endif 67 68 /* Macros for signons and file headers */ 69 70 #define ACPI_COMMON_SIGNON(UtilityName) \ 71 "\n%s\n%s version %8.8X%s\n%s\n\n", \ 72 ACPICA_NAME, \ 73 UtilityName, ((UINT32) ACPI_CA_VERSION), ACPI_WIDTH, \ 74 ACPICA_COPYRIGHT 75 76 #define ACPI_COMMON_HEADER(UtilityName, Prefix) \ 77 "%s%s\n%s%s version %8.8X%s\n%s%s\n%s\n", \ 78 Prefix, ACPICA_NAME, \ 79 Prefix, UtilityName, ((UINT32) ACPI_CA_VERSION), ACPI_WIDTH, \ 80 Prefix, ACPICA_COPYRIGHT, \ 81 Prefix 82 83 /* Macros for usage messages */ 84 85 #define ACPI_USAGE_HEADER(Usage) \ 86 printf ("Usage: %s\nOptions:\n", Usage); 87 88 #define ACPI_USAGE_TEXT(Description) \ 89 printf (Description); 90 91 #define ACPI_OPTION(Name, Description) \ 92 printf (" %-20s%s\n", Name, Description); 93 94 95 /* Check for unexpected exceptions */ 96 97 #define ACPI_CHECK_STATUS(Name, Status, Expected) \ 98 if (Status != Expected) \ 99 { \ 100 AcpiOsPrintf ("Unexpected %s from %s (%s-%d)\n", \ 101 AcpiFormatException (Status), #Name, _AcpiModuleName, __LINE__); \ 102 } 103 104 /* Check for unexpected non-AE_OK errors */ 105 106 107 #define ACPI_CHECK_OK(Name, Status) ACPI_CHECK_STATUS (Name, Status, AE_OK); 108 109 #define FILE_SUFFIX_DISASSEMBLY "dsl" 110 #define FILE_SUFFIX_BINARY_TABLE ".dat" /* Needs the dot */ 111 112 113 /* acfileio */ 114 115 ACPI_STATUS 116 AcGetAllTablesFromFile ( 117 char *Filename, 118 UINT8 GetOnlyAmlTables, 119 ACPI_NEW_TABLE_DESC **ReturnListHead); 120 121 BOOLEAN 122 AcIsFileBinary ( 123 FILE *File); 124 125 ACPI_STATUS 126 AcValidateTableHeader ( 127 FILE *File, 128 long TableOffset); 129 130 131 /* Values for GetOnlyAmlTables */ 132 133 #define ACPI_GET_ONLY_AML_TABLES TRUE 134 #define ACPI_GET_ALL_TABLES FALSE 135 136 137 /* 138 * getopt 139 */ 140 int 141 AcpiGetopt( 142 int argc, 143 char **argv, 144 char *opts); 145 146 int 147 AcpiGetoptArgument ( 148 int argc, 149 char **argv); 150 151 extern int AcpiGbl_Optind; 152 extern int AcpiGbl_Opterr; 153 extern int AcpiGbl_SubOptChar; 154 extern char *AcpiGbl_Optarg; 155 156 157 /* 158 * cmfsize - Common get file size function 159 */ 160 UINT32 161 CmGetFileSize ( 162 ACPI_FILE File); 163 164 165 /* 166 * adwalk 167 */ 168 void 169 AcpiDmCrossReferenceNamespace ( 170 ACPI_PARSE_OBJECT *ParseTreeRoot, 171 ACPI_NAMESPACE_NODE *NamespaceRoot, 172 ACPI_OWNER_ID OwnerId); 173 174 void 175 AcpiDmDumpTree ( 176 ACPI_PARSE_OBJECT *Origin); 177 178 void 179 AcpiDmFindOrphanMethods ( 180 ACPI_PARSE_OBJECT *Origin); 181 182 void 183 AcpiDmFinishNamespaceLoad ( 184 ACPI_PARSE_OBJECT *ParseTreeRoot, 185 ACPI_NAMESPACE_NODE *NamespaceRoot, 186 ACPI_OWNER_ID OwnerId); 187 188 void 189 AcpiDmConvertResourceIndexes ( 190 ACPI_PARSE_OBJECT *ParseTreeRoot, 191 ACPI_NAMESPACE_NODE *NamespaceRoot); 192 193 194 /* 195 * adfile 196 */ 197 ACPI_STATUS 198 AdInitialize ( 199 void); 200 201 char * 202 FlGenerateFilename ( 203 char *InputFilename, 204 char *Suffix); 205 206 ACPI_STATUS 207 FlSplitInputPathname ( 208 char *InputPath, 209 char **OutDirectoryPath, 210 char **OutFilename); 211 212 char * 213 AdGenerateFilename ( 214 char *Prefix, 215 char *TableId); 216 217 void 218 AdWriteTable ( 219 ACPI_TABLE_HEADER *Table, 220 UINT32 Length, 221 char *TableName, 222 char *OemTableId); 223 224 #endif /* _ACAPPS */ 225