1 /****************************************************************************** 2 * 3 * Module Name: acapps - common include for ACPI applications/tools 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2014, 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 48 #ifdef _MSC_VER /* disable some level-4 warnings */ 49 #pragma warning(disable:4100) /* warning C4100: unreferenced formal parameter */ 50 #endif 51 52 /* Common info for tool signons */ 53 54 #define ACPICA_NAME "Intel ACPI Component Architecture" 55 #define ACPICA_COPYRIGHT "Copyright (c) 2000 - 2014 Intel Corporation" 56 57 #if ACPI_MACHINE_WIDTH == 64 58 #define ACPI_WIDTH "-64" 59 60 #elif ACPI_MACHINE_WIDTH == 32 61 #define ACPI_WIDTH "-32" 62 63 #else 64 #error unknown ACPI_MACHINE_WIDTH 65 #define ACPI_WIDTH "-??" 66 67 #endif 68 69 /* Macros for signons and file headers */ 70 71 #define ACPI_COMMON_SIGNON(UtilityName) \ 72 "\n%s\n%s version %8.8X%s [%s]\n%s\n\n", \ 73 ACPICA_NAME, \ 74 UtilityName, ((UINT32) ACPI_CA_VERSION), ACPI_WIDTH, __DATE__, \ 75 ACPICA_COPYRIGHT 76 77 #define ACPI_COMMON_HEADER(UtilityName, Prefix) \ 78 "%s%s\n%s%s version %8.8X%s [%s]\n%s%s\n%s\n", \ 79 Prefix, ACPICA_NAME, \ 80 Prefix, UtilityName, ((UINT32) ACPI_CA_VERSION), ACPI_WIDTH, __DATE__, \ 81 Prefix, ACPICA_COPYRIGHT, \ 82 Prefix 83 84 /* Macros for usage messages */ 85 86 #define ACPI_USAGE_HEADER(Usage) \ 87 printf ("Usage: %s\nOptions:\n", Usage); 88 89 #define ACPI_OPTION(Name, Description) \ 90 printf (" %-18s%s\n", Name, Description); 91 92 93 #define FILE_SUFFIX_DISASSEMBLY "dsl" 94 #define ACPI_TABLE_FILE_SUFFIX ".dat" 95 96 97 /* 98 * getopt 99 */ 100 int 101 AcpiGetopt( 102 int argc, 103 char **argv, 104 char *opts); 105 106 int 107 AcpiGetoptArgument ( 108 int argc, 109 char **argv); 110 111 extern int AcpiGbl_Optind; 112 extern int AcpiGbl_Opterr; 113 extern int AcpiGbl_SubOptChar; 114 extern char *AcpiGbl_Optarg; 115 116 117 /* 118 * cmfsize - Common get file size function 119 */ 120 UINT32 121 CmGetFileSize ( 122 FILE *File); 123 124 125 #ifndef ACPI_DUMP_APP 126 /* 127 * adisasm 128 */ 129 ACPI_STATUS 130 AdAmlDisassemble ( 131 BOOLEAN OutToFile, 132 char *Filename, 133 char *Prefix, 134 char **OutFilename); 135 136 void 137 AdPrintStatistics ( 138 void); 139 140 ACPI_STATUS 141 AdFindDsdt( 142 UINT8 **DsdtPtr, 143 UINT32 *DsdtLength); 144 145 void 146 AdDumpTables ( 147 void); 148 149 ACPI_STATUS 150 AdGetLocalTables ( 151 void); 152 153 ACPI_STATUS 154 AdParseTable ( 155 ACPI_TABLE_HEADER *Table, 156 ACPI_OWNER_ID *OwnerId, 157 BOOLEAN LoadTable, 158 BOOLEAN External); 159 160 ACPI_STATUS 161 AdDisplayTables ( 162 char *Filename, 163 ACPI_TABLE_HEADER *Table); 164 165 ACPI_STATUS 166 AdDisplayStatistics ( 167 void); 168 169 170 /* 171 * adwalk 172 */ 173 void 174 AcpiDmCrossReferenceNamespace ( 175 ACPI_PARSE_OBJECT *ParseTreeRoot, 176 ACPI_NAMESPACE_NODE *NamespaceRoot, 177 ACPI_OWNER_ID OwnerId); 178 179 void 180 AcpiDmDumpTree ( 181 ACPI_PARSE_OBJECT *Origin); 182 183 void 184 AcpiDmFindOrphanMethods ( 185 ACPI_PARSE_OBJECT *Origin); 186 187 void 188 AcpiDmFinishNamespaceLoad ( 189 ACPI_PARSE_OBJECT *ParseTreeRoot, 190 ACPI_NAMESPACE_NODE *NamespaceRoot, 191 ACPI_OWNER_ID OwnerId); 192 193 void 194 AcpiDmConvertResourceIndexes ( 195 ACPI_PARSE_OBJECT *ParseTreeRoot, 196 ACPI_NAMESPACE_NODE *NamespaceRoot); 197 198 199 /* 200 * adfile 201 */ 202 ACPI_STATUS 203 AdInitialize ( 204 void); 205 206 char * 207 FlGenerateFilename ( 208 char *InputFilename, 209 char *Suffix); 210 211 ACPI_STATUS 212 FlSplitInputPathname ( 213 char *InputPath, 214 char **OutDirectoryPath, 215 char **OutFilename); 216 217 char * 218 AdGenerateFilename ( 219 char *Prefix, 220 char *TableId); 221 222 void 223 AdWriteTable ( 224 ACPI_TABLE_HEADER *Table, 225 UINT32 Length, 226 char *TableName, 227 char *OemTableId); 228 #endif 229 230 #endif /* _ACAPPS */ 231