apmain.c revision 1.1.1.1.10.2
1 1.1.1.1.10.2 tls /****************************************************************************** 2 1.1.1.1.10.2 tls * 3 1.1.1.1.10.2 tls * Module Name: apmain - Main module for the acpidump utility 4 1.1.1.1.10.2 tls * 5 1.1.1.1.10.2 tls *****************************************************************************/ 6 1.1.1.1.10.2 tls 7 1.1.1.1.10.2 tls /* 8 1.1.1.1.10.2 tls * Copyright (C) 2000 - 2013, Intel Corp. 9 1.1.1.1.10.2 tls * All rights reserved. 10 1.1.1.1.10.2 tls * 11 1.1.1.1.10.2 tls * Redistribution and use in source and binary forms, with or without 12 1.1.1.1.10.2 tls * modification, are permitted provided that the following conditions 13 1.1.1.1.10.2 tls * are met: 14 1.1.1.1.10.2 tls * 1. Redistributions of source code must retain the above copyright 15 1.1.1.1.10.2 tls * notice, this list of conditions, and the following disclaimer, 16 1.1.1.1.10.2 tls * without modification. 17 1.1.1.1.10.2 tls * 2. Redistributions in binary form must reproduce at minimum a disclaimer 18 1.1.1.1.10.2 tls * substantially similar to the "NO WARRANTY" disclaimer below 19 1.1.1.1.10.2 tls * ("Disclaimer") and any redistribution must be conditioned upon 20 1.1.1.1.10.2 tls * including a substantially similar Disclaimer requirement for further 21 1.1.1.1.10.2 tls * binary redistribution. 22 1.1.1.1.10.2 tls * 3. Neither the names of the above-listed copyright holders nor the names 23 1.1.1.1.10.2 tls * of any contributors may be used to endorse or promote products derived 24 1.1.1.1.10.2 tls * from this software without specific prior written permission. 25 1.1.1.1.10.2 tls * 26 1.1.1.1.10.2 tls * Alternatively, this software may be distributed under the terms of the 27 1.1.1.1.10.2 tls * GNU General Public License ("GPL") version 2 as published by the Free 28 1.1.1.1.10.2 tls * Software Foundation. 29 1.1.1.1.10.2 tls * 30 1.1.1.1.10.2 tls * NO WARRANTY 31 1.1.1.1.10.2 tls * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 32 1.1.1.1.10.2 tls * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 33 1.1.1.1.10.2 tls * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 34 1.1.1.1.10.2 tls * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 35 1.1.1.1.10.2 tls * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 36 1.1.1.1.10.2 tls * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 37 1.1.1.1.10.2 tls * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 38 1.1.1.1.10.2 tls * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 39 1.1.1.1.10.2 tls * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 40 1.1.1.1.10.2 tls * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 41 1.1.1.1.10.2 tls * POSSIBILITY OF SUCH DAMAGES. 42 1.1.1.1.10.2 tls */ 43 1.1.1.1.10.2 tls 44 1.1.1.1.10.2 tls #define _DECLARE_GLOBALS 45 1.1.1.1.10.2 tls #include "acpidump.h" 46 1.1.1.1.10.2 tls #include "acapps.h" 47 1.1.1.1.10.2 tls 48 1.1.1.1.10.2 tls 49 1.1.1.1.10.2 tls /* 50 1.1.1.1.10.2 tls * acpidump - A portable utility for obtaining system ACPI tables and dumping 51 1.1.1.1.10.2 tls * them in an ASCII hex format suitable for binary extraction via acpixtract. 52 1.1.1.1.10.2 tls * 53 1.1.1.1.10.2 tls * Obtaining the system ACPI tables is an OS-specific operation. 54 1.1.1.1.10.2 tls * 55 1.1.1.1.10.2 tls * This utility can be ported to any host operating system by providing a 56 1.1.1.1.10.2 tls * module containing system-specific versions of these interfaces: 57 1.1.1.1.10.2 tls * 58 1.1.1.1.10.2 tls * AcpiOsGetTableByAddress 59 1.1.1.1.10.2 tls * AcpiOsGetTableByIndex 60 1.1.1.1.10.2 tls * AcpiOsGetTableByName 61 1.1.1.1.10.2 tls * 62 1.1.1.1.10.2 tls * See the ACPICA Reference Guide for the exact definitions of these 63 1.1.1.1.10.2 tls * interfaces. Also, see these ACPICA source code modules for example 64 1.1.1.1.10.2 tls * implementations: 65 1.1.1.1.10.2 tls * 66 1.1.1.1.10.2 tls * source/os_specific/service_layers/oswintbl.c 67 1.1.1.1.10.2 tls * source/os_specific/service_layers/oslinuxtbl.c 68 1.1.1.1.10.2 tls */ 69 1.1.1.1.10.2 tls 70 1.1.1.1.10.2 tls 71 1.1.1.1.10.2 tls /* Local prototypes */ 72 1.1.1.1.10.2 tls 73 1.1.1.1.10.2 tls static void 74 1.1.1.1.10.2 tls ApDisplayUsage ( 75 1.1.1.1.10.2 tls void); 76 1.1.1.1.10.2 tls 77 1.1.1.1.10.2 tls static int 78 1.1.1.1.10.2 tls ApDoOptions ( 79 1.1.1.1.10.2 tls int argc, 80 1.1.1.1.10.2 tls char **argv); 81 1.1.1.1.10.2 tls 82 1.1.1.1.10.2 tls static void 83 1.1.1.1.10.2 tls ApInsertAction ( 84 1.1.1.1.10.2 tls char *Argument, 85 1.1.1.1.10.2 tls UINT32 ToBeDone); 86 1.1.1.1.10.2 tls 87 1.1.1.1.10.2 tls 88 1.1.1.1.10.2 tls /* Table for deferred actions from command line options */ 89 1.1.1.1.10.2 tls 90 1.1.1.1.10.2 tls AP_DUMP_ACTION ActionTable [AP_MAX_ACTIONS]; 91 1.1.1.1.10.2 tls UINT32 CurrentAction = 0; 92 1.1.1.1.10.2 tls 93 1.1.1.1.10.2 tls 94 1.1.1.1.10.2 tls #define AP_UTILITY_NAME "ACPI Binary Table Dump Utility" 95 1.1.1.1.10.2 tls #define AP_SUPPORTED_OPTIONS "?a:bcf:hn:o:r:svz" 96 1.1.1.1.10.2 tls 97 1.1.1.1.10.2 tls 98 1.1.1.1.10.2 tls /****************************************************************************** 99 1.1.1.1.10.2 tls * 100 1.1.1.1.10.2 tls * FUNCTION: ApDisplayUsage 101 1.1.1.1.10.2 tls * 102 1.1.1.1.10.2 tls * DESCRIPTION: Usage message for the AcpiDump utility 103 1.1.1.1.10.2 tls * 104 1.1.1.1.10.2 tls ******************************************************************************/ 105 1.1.1.1.10.2 tls 106 1.1.1.1.10.2 tls static void 107 1.1.1.1.10.2 tls ApDisplayUsage ( 108 1.1.1.1.10.2 tls void) 109 1.1.1.1.10.2 tls { 110 1.1.1.1.10.2 tls 111 1.1.1.1.10.2 tls ACPI_USAGE_HEADER ("acpidump [options]"); 112 1.1.1.1.10.2 tls 113 1.1.1.1.10.2 tls ACPI_OPTION ("-b", "Dump tables to binary files"); 114 1.1.1.1.10.2 tls ACPI_OPTION ("-c", "Dump customized tables"); 115 1.1.1.1.10.2 tls ACPI_OPTION ("-h -?", "This help message"); 116 1.1.1.1.10.2 tls ACPI_OPTION ("-o <File>", "Redirect output to file"); 117 1.1.1.1.10.2 tls ACPI_OPTION ("-r <Address>", "Dump tables from specified RSDP"); 118 1.1.1.1.10.2 tls ACPI_OPTION ("-s", "Print table summaries only"); 119 1.1.1.1.10.2 tls ACPI_OPTION ("-v", "Display version information"); 120 1.1.1.1.10.2 tls ACPI_OPTION ("-z", "Verbose mode"); 121 1.1.1.1.10.2 tls 122 1.1.1.1.10.2 tls printf ("\nTable Options:\n"); 123 1.1.1.1.10.2 tls 124 1.1.1.1.10.2 tls ACPI_OPTION ("-a <Address>", "Get table via a physical address"); 125 1.1.1.1.10.2 tls ACPI_OPTION ("-f <BinaryFile>", "Get table via a binary file"); 126 1.1.1.1.10.2 tls ACPI_OPTION ("-n <Signature>", "Get table via a name/signature"); 127 1.1.1.1.10.2 tls 128 1.1.1.1.10.2 tls printf ( 129 1.1.1.1.10.2 tls "\n" 130 1.1.1.1.10.2 tls "Invocation without parameters dumps all available tables\n" 131 1.1.1.1.10.2 tls "Multiple mixed instances of -a, -f, and -n are supported\n\n"); 132 1.1.1.1.10.2 tls } 133 1.1.1.1.10.2 tls 134 1.1.1.1.10.2 tls 135 1.1.1.1.10.2 tls /****************************************************************************** 136 1.1.1.1.10.2 tls * 137 1.1.1.1.10.2 tls * FUNCTION: ApInsertAction 138 1.1.1.1.10.2 tls * 139 1.1.1.1.10.2 tls * PARAMETERS: Argument - Pointer to the argument for this action 140 1.1.1.1.10.2 tls * ToBeDone - What to do to process this action 141 1.1.1.1.10.2 tls * 142 1.1.1.1.10.2 tls * RETURN: None. Exits program if action table becomes full. 143 1.1.1.1.10.2 tls * 144 1.1.1.1.10.2 tls * DESCRIPTION: Add an action item to the action table 145 1.1.1.1.10.2 tls * 146 1.1.1.1.10.2 tls ******************************************************************************/ 147 1.1.1.1.10.2 tls 148 1.1.1.1.10.2 tls static void 149 1.1.1.1.10.2 tls ApInsertAction ( 150 1.1.1.1.10.2 tls char *Argument, 151 1.1.1.1.10.2 tls UINT32 ToBeDone) 152 1.1.1.1.10.2 tls { 153 1.1.1.1.10.2 tls 154 1.1.1.1.10.2 tls /* Insert action and check for table overflow */ 155 1.1.1.1.10.2 tls 156 1.1.1.1.10.2 tls ActionTable [CurrentAction].Argument = Argument; 157 1.1.1.1.10.2 tls ActionTable [CurrentAction].ToBeDone = ToBeDone; 158 1.1.1.1.10.2 tls 159 1.1.1.1.10.2 tls CurrentAction++; 160 1.1.1.1.10.2 tls if (CurrentAction > AP_MAX_ACTIONS) 161 1.1.1.1.10.2 tls { 162 1.1.1.1.10.2 tls fprintf (stderr, "Too many table options (max %u)\n", AP_MAX_ACTIONS); 163 1.1.1.1.10.2 tls exit (-1); 164 1.1.1.1.10.2 tls } 165 1.1.1.1.10.2 tls } 166 1.1.1.1.10.2 tls 167 1.1.1.1.10.2 tls 168 1.1.1.1.10.2 tls /****************************************************************************** 169 1.1.1.1.10.2 tls * 170 1.1.1.1.10.2 tls * FUNCTION: ApDoOptions 171 1.1.1.1.10.2 tls * 172 1.1.1.1.10.2 tls * PARAMETERS: argc/argv - Standard argc/argv 173 1.1.1.1.10.2 tls * 174 1.1.1.1.10.2 tls * RETURN: Status 175 1.1.1.1.10.2 tls * 176 1.1.1.1.10.2 tls * DESCRIPTION: Command line option processing. The main actions for getting 177 1.1.1.1.10.2 tls * and dumping tables are deferred via the action table. 178 1.1.1.1.10.2 tls * 179 1.1.1.1.10.2 tls *****************************************************************************/ 180 1.1.1.1.10.2 tls 181 1.1.1.1.10.2 tls static int 182 1.1.1.1.10.2 tls ApDoOptions ( 183 1.1.1.1.10.2 tls int argc, 184 1.1.1.1.10.2 tls char **argv) 185 1.1.1.1.10.2 tls { 186 1.1.1.1.10.2 tls int j; 187 1.1.1.1.10.2 tls ACPI_STATUS Status; 188 1.1.1.1.10.2 tls 189 1.1.1.1.10.2 tls 190 1.1.1.1.10.2 tls /* Command line options */ 191 1.1.1.1.10.2 tls 192 1.1.1.1.10.2 tls while ((j = AcpiGetopt (argc, argv, AP_SUPPORTED_OPTIONS)) != EOF) switch (j) 193 1.1.1.1.10.2 tls { 194 1.1.1.1.10.2 tls /* 195 1.1.1.1.10.2 tls * Global options 196 1.1.1.1.10.2 tls */ 197 1.1.1.1.10.2 tls case 'b': /* Dump all input tables to binary files */ 198 1.1.1.1.10.2 tls 199 1.1.1.1.10.2 tls Gbl_BinaryMode = TRUE; 200 1.1.1.1.10.2 tls continue; 201 1.1.1.1.10.2 tls 202 1.1.1.1.10.2 tls case 'c': /* Dump customized tables */ 203 1.1.1.1.10.2 tls 204 1.1.1.1.10.2 tls Gbl_DumpCustomizedTables = TRUE; 205 1.1.1.1.10.2 tls continue; 206 1.1.1.1.10.2 tls 207 1.1.1.1.10.2 tls case 'h': 208 1.1.1.1.10.2 tls case '?': 209 1.1.1.1.10.2 tls 210 1.1.1.1.10.2 tls ApDisplayUsage (); 211 1.1.1.1.10.2 tls exit (0); 212 1.1.1.1.10.2 tls 213 1.1.1.1.10.2 tls case 'o': /* Redirect output to a single file */ 214 1.1.1.1.10.2 tls 215 1.1.1.1.10.2 tls if (ApOpenOutputFile (AcpiGbl_Optarg)) 216 1.1.1.1.10.2 tls { 217 1.1.1.1.10.2 tls exit (-1); 218 1.1.1.1.10.2 tls } 219 1.1.1.1.10.2 tls continue; 220 1.1.1.1.10.2 tls 221 1.1.1.1.10.2 tls case 'r': /* Dump tables from specified RSDP */ 222 1.1.1.1.10.2 tls 223 1.1.1.1.10.2 tls Status = AcpiUtStrtoul64 (AcpiGbl_Optarg, 0, &Gbl_RsdpBase); 224 1.1.1.1.10.2 tls if (ACPI_FAILURE (Status)) 225 1.1.1.1.10.2 tls { 226 1.1.1.1.10.2 tls fprintf (stderr, "%s: Could not convert to a physical address\n", 227 1.1.1.1.10.2 tls AcpiGbl_Optarg); 228 1.1.1.1.10.2 tls exit (-1); 229 1.1.1.1.10.2 tls } 230 1.1.1.1.10.2 tls continue; 231 1.1.1.1.10.2 tls 232 1.1.1.1.10.2 tls case 's': /* Print table summaries only */ 233 1.1.1.1.10.2 tls 234 1.1.1.1.10.2 tls Gbl_SummaryMode = TRUE; 235 1.1.1.1.10.2 tls continue; 236 1.1.1.1.10.2 tls 237 1.1.1.1.10.2 tls case 'v': /* Revision/version */ 238 1.1.1.1.10.2 tls 239 1.1.1.1.10.2 tls printf (ACPI_COMMON_SIGNON (AP_UTILITY_NAME)); 240 1.1.1.1.10.2 tls exit (0); 241 1.1.1.1.10.2 tls 242 1.1.1.1.10.2 tls case 'z': /* Verbose mode */ 243 1.1.1.1.10.2 tls 244 1.1.1.1.10.2 tls Gbl_VerboseMode = TRUE; 245 1.1.1.1.10.2 tls fprintf (stderr, ACPI_COMMON_SIGNON (AP_UTILITY_NAME)); 246 1.1.1.1.10.2 tls continue; 247 1.1.1.1.10.2 tls 248 1.1.1.1.10.2 tls /* 249 1.1.1.1.10.2 tls * Table options 250 1.1.1.1.10.2 tls */ 251 1.1.1.1.10.2 tls case 'a': /* Get table by physical address */ 252 1.1.1.1.10.2 tls 253 1.1.1.1.10.2 tls ApInsertAction (AcpiGbl_Optarg, AP_DUMP_TABLE_BY_ADDRESS); 254 1.1.1.1.10.2 tls break; 255 1.1.1.1.10.2 tls 256 1.1.1.1.10.2 tls case 'f': /* Get table from a file */ 257 1.1.1.1.10.2 tls 258 1.1.1.1.10.2 tls ApInsertAction (AcpiGbl_Optarg, AP_DUMP_TABLE_BY_FILE); 259 1.1.1.1.10.2 tls break; 260 1.1.1.1.10.2 tls 261 1.1.1.1.10.2 tls case 'n': /* Get table by input name (signature) */ 262 1.1.1.1.10.2 tls 263 1.1.1.1.10.2 tls ApInsertAction (AcpiGbl_Optarg, AP_DUMP_TABLE_BY_NAME); 264 1.1.1.1.10.2 tls break; 265 1.1.1.1.10.2 tls 266 1.1.1.1.10.2 tls default: 267 1.1.1.1.10.2 tls 268 1.1.1.1.10.2 tls ApDisplayUsage (); 269 1.1.1.1.10.2 tls exit (-1); 270 1.1.1.1.10.2 tls } 271 1.1.1.1.10.2 tls 272 1.1.1.1.10.2 tls /* If there are no actions, this means "get/dump all tables" */ 273 1.1.1.1.10.2 tls 274 1.1.1.1.10.2 tls if (CurrentAction == 0) 275 1.1.1.1.10.2 tls { 276 1.1.1.1.10.2 tls ApInsertAction (NULL, AP_DUMP_ALL_TABLES); 277 1.1.1.1.10.2 tls } 278 1.1.1.1.10.2 tls 279 1.1.1.1.10.2 tls return (0); 280 1.1.1.1.10.2 tls } 281 1.1.1.1.10.2 tls 282 1.1.1.1.10.2 tls 283 1.1.1.1.10.2 tls /****************************************************************************** 284 1.1.1.1.10.2 tls * 285 1.1.1.1.10.2 tls * FUNCTION: main 286 1.1.1.1.10.2 tls * 287 1.1.1.1.10.2 tls * PARAMETERS: argc/argv - Standard argc/argv 288 1.1.1.1.10.2 tls * 289 1.1.1.1.10.2 tls * RETURN: Status 290 1.1.1.1.10.2 tls * 291 1.1.1.1.10.2 tls * DESCRIPTION: C main function for acpidump utility 292 1.1.1.1.10.2 tls * 293 1.1.1.1.10.2 tls ******************************************************************************/ 294 1.1.1.1.10.2 tls 295 1.1.1.1.10.2 tls int ACPI_SYSTEM_XFACE 296 1.1.1.1.10.2 tls main ( 297 1.1.1.1.10.2 tls int argc, 298 1.1.1.1.10.2 tls char *argv[]) 299 1.1.1.1.10.2 tls { 300 1.1.1.1.10.2 tls int Status = 0; 301 1.1.1.1.10.2 tls AP_DUMP_ACTION *Action; 302 1.1.1.1.10.2 tls UINT32 FileSize; 303 1.1.1.1.10.2 tls UINT32 i; 304 1.1.1.1.10.2 tls 305 1.1.1.1.10.2 tls 306 1.1.1.1.10.2 tls ACPI_DEBUG_INITIALIZE (); /* For debug version only */ 307 1.1.1.1.10.2 tls 308 1.1.1.1.10.2 tls /* Process command line options */ 309 1.1.1.1.10.2 tls 310 1.1.1.1.10.2 tls if (ApDoOptions (argc, argv)) 311 1.1.1.1.10.2 tls { 312 1.1.1.1.10.2 tls return (-1); 313 1.1.1.1.10.2 tls } 314 1.1.1.1.10.2 tls 315 1.1.1.1.10.2 tls /* Get/dump ACPI table(s) as requested */ 316 1.1.1.1.10.2 tls 317 1.1.1.1.10.2 tls for (i = 0; i < CurrentAction; i++) 318 1.1.1.1.10.2 tls { 319 1.1.1.1.10.2 tls Action = &ActionTable[i]; 320 1.1.1.1.10.2 tls switch (Action->ToBeDone) 321 1.1.1.1.10.2 tls { 322 1.1.1.1.10.2 tls case AP_DUMP_ALL_TABLES: 323 1.1.1.1.10.2 tls 324 1.1.1.1.10.2 tls Status = ApDumpAllTables (); 325 1.1.1.1.10.2 tls break; 326 1.1.1.1.10.2 tls 327 1.1.1.1.10.2 tls case AP_DUMP_TABLE_BY_ADDRESS: 328 1.1.1.1.10.2 tls 329 1.1.1.1.10.2 tls Status = ApDumpTableByAddress (Action->Argument); 330 1.1.1.1.10.2 tls break; 331 1.1.1.1.10.2 tls 332 1.1.1.1.10.2 tls case AP_DUMP_TABLE_BY_NAME: 333 1.1.1.1.10.2 tls 334 1.1.1.1.10.2 tls Status = ApDumpTableByName (Action->Argument); 335 1.1.1.1.10.2 tls break; 336 1.1.1.1.10.2 tls 337 1.1.1.1.10.2 tls case AP_DUMP_TABLE_BY_FILE: 338 1.1.1.1.10.2 tls 339 1.1.1.1.10.2 tls Status = ApDumpTableFromFile (Action->Argument); 340 1.1.1.1.10.2 tls break; 341 1.1.1.1.10.2 tls 342 1.1.1.1.10.2 tls default: 343 1.1.1.1.10.2 tls 344 1.1.1.1.10.2 tls fprintf (stderr, "Internal error, invalid action: 0x%X\n", 345 1.1.1.1.10.2 tls Action->ToBeDone); 346 1.1.1.1.10.2 tls return (-1); 347 1.1.1.1.10.2 tls } 348 1.1.1.1.10.2 tls 349 1.1.1.1.10.2 tls if (Status) 350 1.1.1.1.10.2 tls { 351 1.1.1.1.10.2 tls return (Status); 352 1.1.1.1.10.2 tls } 353 1.1.1.1.10.2 tls } 354 1.1.1.1.10.2 tls 355 1.1.1.1.10.2 tls if (Gbl_OutputFile) 356 1.1.1.1.10.2 tls { 357 1.1.1.1.10.2 tls if (Gbl_VerboseMode) 358 1.1.1.1.10.2 tls { 359 1.1.1.1.10.2 tls /* Summary for the output file */ 360 1.1.1.1.10.2 tls 361 1.1.1.1.10.2 tls FileSize = ApGetFileSize (Gbl_OutputFile); 362 1.1.1.1.10.2 tls fprintf (stderr, "Output file %s contains 0x%X (%u) bytes\n\n", 363 1.1.1.1.10.2 tls Gbl_OutputFilename, FileSize, FileSize); 364 1.1.1.1.10.2 tls } 365 1.1.1.1.10.2 tls 366 1.1.1.1.10.2 tls fclose (Gbl_OutputFile); 367 1.1.1.1.10.2 tls } 368 1.1.1.1.10.2 tls 369 1.1.1.1.10.2 tls return (Status); 370 1.1.1.1.10.2 tls } 371
Indexes created Thu Oct 16 14:10:15 GMT 2025