1 /****************************************************************************** 2 * 3 * Module Name: acapps - common include for ACPI applications/tools 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2013, 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 - 2013 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\n%s\n\n", \ 73 ACPICA_NAME, \ 74 UtilityName, ((UINT32) ACPI_CA_VERSION), ACPI_WIDTH, \ 75 ACPICA_COPYRIGHT 76 77 #define ACPI_COMMON_HEADER(UtilityName, Prefix) \ 78 "%s%s\n%s%s version %8.8X%s\n%s%s\n%s\n", \ 79 Prefix, ACPICA_NAME, \ 80 Prefix, UtilityName, ((UINT32) ACPI_CA_VERSION), ACPI_WIDTH, \ 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 #ifndef ACPI_DUMP_APP 118 /* 119 * adisasm 120 */ 121 ACPI_STATUS 122 AdAmlDisassemble ( 123 BOOLEAN OutToFile, 124 char *Filename, 125 char *Prefix, 126 char **OutFilename, 127 BOOLEAN GetAllTables); 128 129 void 130 AdPrintStatistics ( 131 void); 132 133 ACPI_STATUS 134 AdFindDsdt( 135 UINT8 **DsdtPtr, 136 UINT32 *DsdtLength); 137 138 void 139 AdDumpTables ( 140 void); 141 142 ACPI_STATUS 143 AdGetLocalTables ( 144 char *Filename, 145 BOOLEAN GetAllTables); 146 147 ACPI_STATUS 148 AdParseTable ( 149 ACPI_TABLE_HEADER *Table, 150 ACPI_OWNER_ID *OwnerId, 151 BOOLEAN LoadTable, 152 BOOLEAN External); 153 154 ACPI_STATUS 155 AdDisplayTables ( 156 char *Filename, 157 ACPI_TABLE_HEADER *Table); 158 159 ACPI_STATUS 160 AdDisplayStatistics ( 161 void); 162 163 164 /* 165 * adwalk 166 */ 167 void 168 AcpiDmCrossReferenceNamespace ( 169 ACPI_PARSE_OBJECT *ParseTreeRoot, 170 ACPI_NAMESPACE_NODE *NamespaceRoot, 171 ACPI_OWNER_ID OwnerId); 172 173 void 174 AcpiDmDumpTree ( 175 ACPI_PARSE_OBJECT *Origin); 176 177 void 178 AcpiDmFindOrphanMethods ( 179 ACPI_PARSE_OBJECT *Origin); 180 181 void 182 AcpiDmFinishNamespaceLoad ( 183 ACPI_PARSE_OBJECT *ParseTreeRoot, 184 ACPI_NAMESPACE_NODE *NamespaceRoot, 185 ACPI_OWNER_ID OwnerId); 186 187 void 188 AcpiDmConvertResourceIndexes ( 189 ACPI_PARSE_OBJECT *ParseTreeRoot, 190 ACPI_NAMESPACE_NODE *NamespaceRoot); 191 192 193 /* 194 * adfile 195 */ 196 ACPI_STATUS 197 AdInitialize ( 198 void); 199 200 char * 201 FlGenerateFilename ( 202 char *InputFilename, 203 char *Suffix); 204 205 ACPI_STATUS 206 FlSplitInputPathname ( 207 char *InputPath, 208 char **OutDirectoryPath, 209 char **OutFilename); 210 211 char * 212 AdGenerateFilename ( 213 char *Prefix, 214 char *TableId); 215 216 void 217 AdWriteTable ( 218 ACPI_TABLE_HEADER *Table, 219 UINT32 Length, 220 char *TableName, 221 char *OemTableId); 222 #endif 223 224 #endif /* _ACAPPS */ 225