1 /******************************************************************************
3 * Module Name: apmain - Main module for the acpidump utility
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2017, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
44 #define _DECLARE_GLOBALS
49 * acpidump - A portable utility for obtaining system ACPI tables and dumping
50 * them in an ASCII hex format suitable for binary extraction via acpixtract.
52 * Obtaining the system ACPI tables is an OS-specific operation.
54 * This utility can be ported to any host operating system by providing a
55 * module containing system-specific versions of these interfaces:
57 * AcpiOsGetTableByAddress
58 * AcpiOsGetTableByIndex
59 * AcpiOsGetTableByName
61 * See the ACPICA Reference Guide for the exact definitions of these
62 * interfaces. Also, see these ACPICA source code modules for example
65 * source/os_specific/service_layers/oswintbl.c
66 * source/os_specific/service_layers/oslinuxtbl.c
70 /* Local prototypes */
87 /* Table for deferred actions from command line options */
89 AP_DUMP_ACTION ActionTable [AP_MAX_ACTIONS];
90 UINT32 CurrentAction = 0;
93 #define AP_UTILITY_NAME "ACPI Binary Table Dump Utility"
94 #define AP_SUPPORTED_OPTIONS "?a:bc:f:hn:o:r:svxz"
97 /******************************************************************************
99 * FUNCTION: ApDisplayUsage
101 * DESCRIPTION: Usage message for the AcpiDump utility
103 ******************************************************************************/
110 ACPI_USAGE_HEADER ("acpidump [options]");
112 ACPI_OPTION ("-b", "Dump tables to binary files");
113 ACPI_OPTION ("-h -?", "This help message");
114 ACPI_OPTION ("-o <File>", "Redirect output to file");
115 ACPI_OPTION ("-r <Address>", "Dump tables from specified RSDP");
116 ACPI_OPTION ("-s", "Print table summaries only");
117 ACPI_OPTION ("-v", "Display version information");
118 ACPI_OPTION ("-z", "Verbose mode");
120 ACPI_USAGE_TEXT ("\nTable Options:\n");
122 ACPI_OPTION ("-a <Address>", "Get table via a physical address");
123 ACPI_OPTION ("-c <on|off>", "Turning on/off customized table dumping");
124 ACPI_OPTION ("-f <BinaryFile>", "Get table via a binary file");
125 ACPI_OPTION ("-n <Signature>", "Get table via a name/signature");
126 ACPI_OPTION ("-x", "Do not use but dump XSDT");
127 ACPI_OPTION ("-x -x", "Do not use or dump XSDT");
131 "Invocation without parameters dumps all available tables\n"
132 "Multiple mixed instances of -a, -f, and -n are supported\n\n");
136 /******************************************************************************
138 * FUNCTION: ApInsertAction
140 * PARAMETERS: Argument - Pointer to the argument for this action
141 * ToBeDone - What to do to process this action
145 * DESCRIPTION: Add an action item to the action table
147 ******************************************************************************/
155 /* Insert action and check for table overflow */
157 ActionTable [CurrentAction].Argument = Argument;
158 ActionTable [CurrentAction].ToBeDone = ToBeDone;
161 if (CurrentAction > AP_MAX_ACTIONS)
163 fprintf (stderr, "Too many table options (max %u)\n", AP_MAX_ACTIONS);
171 /******************************************************************************
173 * FUNCTION: ApDoOptions
175 * PARAMETERS: argc/argv - Standard argc/argv
179 * DESCRIPTION: Command line option processing. The main actions for getting
180 * and dumping tables are deferred via the action table.
182 *****************************************************************************/
193 /* Command line options */
195 while ((j = AcpiGetopt (argc, argv, AP_SUPPORTED_OPTIONS)) != ACPI_OPT_END) switch (j)
200 case 'b': /* Dump all input tables to binary files */
202 Gbl_BinaryMode = TRUE;
205 case 'c': /* Dump customized tables */
207 if (!strcmp (AcpiGbl_Optarg, "on"))
209 Gbl_DumpCustomizedTables = TRUE;
211 else if (!strcmp (AcpiGbl_Optarg, "off"))
213 Gbl_DumpCustomizedTables = FALSE;
217 fprintf (stderr, "%s: Cannot handle this switch, please use on|off\n",
229 case 'o': /* Redirect output to a single file */
231 if (ApOpenOutputFile (AcpiGbl_Optarg))
237 case 'r': /* Dump tables from specified RSDP */
239 Status = AcpiUtStrtoul64 (AcpiGbl_Optarg, ACPI_STRTOUL_64BIT,
241 if (ACPI_FAILURE (Status))
243 fprintf (stderr, "%s: Could not convert to a physical address\n",
249 case 's': /* Print table summaries only */
251 Gbl_SummaryMode = TRUE;
254 case 'x': /* Do not use XSDT */
256 if (!AcpiGbl_DoNotUseXsdt)
258 AcpiGbl_DoNotUseXsdt = TRUE;
262 Gbl_DoNotDumpXsdt = TRUE;
266 case 'v': /* Revision/version */
268 AcpiOsPrintf (ACPI_COMMON_SIGNON (AP_UTILITY_NAME));
271 case 'z': /* Verbose mode */
273 Gbl_VerboseMode = TRUE;
274 fprintf (stderr, ACPI_COMMON_SIGNON (AP_UTILITY_NAME));
280 case 'a': /* Get table by physical address */
282 if (ApInsertAction (AcpiGbl_Optarg, AP_DUMP_TABLE_BY_ADDRESS))
288 case 'f': /* Get table from a file */
290 if (ApInsertAction (AcpiGbl_Optarg, AP_DUMP_TABLE_BY_FILE))
296 case 'n': /* Get table by input name (signature) */
298 if (ApInsertAction (AcpiGbl_Optarg, AP_DUMP_TABLE_BY_NAME))
310 /* If there are no actions, this means "get/dump all tables" */
312 if (CurrentAction == 0)
314 if (ApInsertAction (NULL, AP_DUMP_ALL_TABLES))
324 /******************************************************************************
328 * PARAMETERS: argc/argv - Standard argc/argv
332 * DESCRIPTION: C main function for acpidump utility
334 ******************************************************************************/
337 int ACPI_SYSTEM_XFACE
342 int ACPI_SYSTEM_XFACE
349 AP_DUMP_ACTION *Action;
354 ACPI_DEBUG_INITIALIZE (); /* For debug version only */
356 Gbl_OutputFile = ACPI_FILE_OUT;
357 AcpiGbl_IntegerByteWidth = 8;
359 /* Process command line options */
361 Status = ApDoOptions (argc, argv);
371 /* Get/dump ACPI table(s) as requested */
373 for (i = 0; i < CurrentAction; i++)
375 Action = &ActionTable[i];
376 switch (Action->ToBeDone)
378 case AP_DUMP_ALL_TABLES:
380 Status = ApDumpAllTables ();
383 case AP_DUMP_TABLE_BY_ADDRESS:
385 Status = ApDumpTableByAddress (Action->Argument);
388 case AP_DUMP_TABLE_BY_NAME:
390 Status = ApDumpTableByName (Action->Argument);
393 case AP_DUMP_TABLE_BY_FILE:
395 Status = ApDumpTableFromFile (Action->Argument);
400 fprintf (stderr, "Internal error, invalid action: 0x%X\n",
411 if (Gbl_OutputFilename)
415 /* Summary for the output file */
417 FileSize = CmGetFileSize (Gbl_OutputFile);
418 fprintf (stderr, "Output file %s contains 0x%X (%u) bytes\n\n",
419 Gbl_OutputFilename, FileSize, FileSize);
422 fclose (Gbl_OutputFile);