1 /******************************************************************************
3 * Module Name: apmain - Main module for the acpidump utility
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2016, 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 * acpi_os_get_table_by_address
58 * acpi_os_get_table_by_index
59 * acpi_os_get_table_by_name
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
69 /* Local prototypes */
71 static void ap_display_usage(void);
73 static int ap_do_options(int argc
, char **argv
);
75 static int ap_insert_action(char *argument
, u32 to_be_done
);
77 /* Table for deferred actions from command line options */
79 struct ap_dump_action action_table
[AP_MAX_ACTIONS
];
80 u32 current_action
= 0;
82 #define AP_UTILITY_NAME "ACPI Binary Table Dump Utility"
83 #define AP_SUPPORTED_OPTIONS "?a:bc:f:hn:o:r:svxz"
85 /******************************************************************************
87 * FUNCTION: ap_display_usage
89 * DESCRIPTION: Usage message for the acpi_dump utility
91 ******************************************************************************/
93 static void ap_display_usage(void)
96 ACPI_USAGE_HEADER("acpidump [options]");
98 ACPI_OPTION("-b", "Dump tables to binary files");
99 ACPI_OPTION("-h -?", "This help message");
100 ACPI_OPTION("-o <File>", "Redirect output to file");
101 ACPI_OPTION("-r <Address>", "Dump tables from specified RSDP");
102 ACPI_OPTION("-s", "Print table summaries only");
103 ACPI_OPTION("-v", "Display version information");
104 ACPI_OPTION("-z", "Verbose mode");
106 ACPI_USAGE_TEXT("\nTable Options:\n");
108 ACPI_OPTION("-a <Address>", "Get table via a physical address");
109 ACPI_OPTION("-c <on|off>", "Turning on/off customized table dumping");
110 ACPI_OPTION("-f <BinaryFile>", "Get table via a binary file");
111 ACPI_OPTION("-n <Signature>", "Get table via a name/signature");
112 ACPI_OPTION("-x", "Do not use but dump XSDT");
113 ACPI_OPTION("-x -x", "Do not use or dump XSDT");
116 "Invocation without parameters dumps all available tables\n"
117 "Multiple mixed instances of -a, -f, and -n are supported\n\n");
120 /******************************************************************************
122 * FUNCTION: ap_insert_action
124 * PARAMETERS: argument - Pointer to the argument for this action
125 * to_be_done - What to do to process this action
129 * DESCRIPTION: Add an action item to the action table
131 ******************************************************************************/
133 static int ap_insert_action(char *argument
, u32 to_be_done
)
136 /* Insert action and check for table overflow */
138 action_table
[current_action
].argument
= argument
;
139 action_table
[current_action
].to_be_done
= to_be_done
;
142 if (current_action
> AP_MAX_ACTIONS
) {
143 acpi_log_error("Too many table options (max %u)\n",
151 /******************************************************************************
153 * FUNCTION: ap_do_options
155 * PARAMETERS: argc/argv - Standard argc/argv
159 * DESCRIPTION: Command line option processing. The main actions for getting
160 * and dumping tables are deferred via the action table.
162 *****************************************************************************/
164 static int ap_do_options(int argc
, char **argv
)
169 /* Command line options */
172 acpi_getopt(argc
, argv
, AP_SUPPORTED_OPTIONS
)) != ACPI_OPT_END
)
177 case 'b': /* Dump all input tables to binary files */
179 gbl_binary_mode
= TRUE
;
182 case 'c': /* Dump customized tables */
184 if (!strcmp(acpi_gbl_optarg
, "on")) {
185 gbl_dump_customized_tables
= TRUE
;
186 } else if (!strcmp(acpi_gbl_optarg
, "off")) {
187 gbl_dump_customized_tables
= FALSE
;
190 ("%s: Cannot handle this switch, please use on|off\n",
202 case 'o': /* Redirect output to a single file */
204 if (ap_open_output_file(acpi_gbl_optarg
)) {
209 case 'r': /* Dump tables from specified RSDP */
212 acpi_ut_strtoul64(acpi_gbl_optarg
, 0,
214 if (ACPI_FAILURE(status
)) {
216 ("%s: Could not convert to a physical address\n",
222 case 's': /* Print table summaries only */
224 gbl_summary_mode
= TRUE
;
227 case 'x': /* Do not use XSDT */
229 if (!acpi_gbl_do_not_use_xsdt
) {
230 acpi_gbl_do_not_use_xsdt
= TRUE
;
232 gbl_do_not_dump_xsdt
= TRUE
;
236 case 'v': /* Revision/version */
238 acpi_os_printf(ACPI_COMMON_SIGNON(AP_UTILITY_NAME
));
241 case 'z': /* Verbose mode */
243 gbl_verbose_mode
= TRUE
;
244 acpi_log_error(ACPI_COMMON_SIGNON(AP_UTILITY_NAME
));
250 case 'a': /* Get table by physical address */
253 (acpi_gbl_optarg
, AP_DUMP_TABLE_BY_ADDRESS
)) {
258 case 'f': /* Get table from a file */
261 (acpi_gbl_optarg
, AP_DUMP_TABLE_BY_FILE
)) {
266 case 'n': /* Get table by input name (signature) */
269 (acpi_gbl_optarg
, AP_DUMP_TABLE_BY_NAME
)) {
280 /* If there are no actions, this means "get/dump all tables" */
282 if (current_action
== 0) {
283 if (ap_insert_action(NULL
, AP_DUMP_ALL_TABLES
)) {
291 /******************************************************************************
295 * PARAMETERS: argc/argv - Standard argc/argv
299 * DESCRIPTION: C main function for acpidump utility
301 ******************************************************************************/
304 int ACPI_SYSTEM_XFACE
main(int argc
, char *argv
[])
306 int ACPI_SYSTEM_XFACE
acpi_main(int argc
, char *argv
[])
310 struct ap_dump_action
*action
;
314 ACPI_DEBUG_INITIALIZE(); /* For debug version only */
315 acpi_os_initialize();
316 gbl_output_file
= ACPI_FILE_OUT
;
318 /* Process command line options */
320 status
= ap_do_options(argc
, argv
);
328 /* Get/dump ACPI table(s) as requested */
330 for (i
= 0; i
< current_action
; i
++) {
331 action
= &action_table
[i
];
332 switch (action
->to_be_done
) {
333 case AP_DUMP_ALL_TABLES
:
335 status
= ap_dump_all_tables();
338 case AP_DUMP_TABLE_BY_ADDRESS
:
340 status
= ap_dump_table_by_address(action
->argument
);
343 case AP_DUMP_TABLE_BY_NAME
:
345 status
= ap_dump_table_by_name(action
->argument
);
348 case AP_DUMP_TABLE_BY_FILE
:
350 status
= ap_dump_table_from_file(action
->argument
);
355 acpi_log_error("Internal error, invalid action: 0x%X\n",
365 if (gbl_output_filename
) {
366 if (gbl_verbose_mode
) {
368 /* Summary for the output file */
370 file_size
= cm_get_file_size(gbl_output_file
);
372 ("Output file %s contains 0x%X (%u) bytes\n\n",
373 gbl_output_filename
, file_size
, file_size
);
376 acpi_os_close_file(gbl_output_file
);