1 /******************************************************************************
2 *
3 * Module Name: apmain - Main module for the acpidump utility
4 *
5 *****************************************************************************/
6
7 /******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2023, Intel Corp.
12 * All rights reserved.
13 *
14 * 2. License
15 *
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
19 * property rights.
20 *
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
27 *
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
36 *
37 * The above copyright and patent license is granted only if the following
38 * conditions are met:
39 *
40 * 3. Conditions
41 *
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
53 *
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
64 * make.
65 *
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
70 * distribution.
71 *
72 * 3.4. Intel retains all right, title, and interest in and to the Original
73 * Intel Code.
74 *
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
79 *
80 * 4. Disclaimer and Export Compliance
81 *
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88 * PARTICULAR PURPOSE.
89 *
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97 * LIMITED REMEDY.
98 *
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
113 *
114 *****************************************************************************
115 *
116 * Alternatively, you may choose to be licensed under the terms of the
117 * following license:
118 *
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
121 * are met:
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
133 *
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145 *
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
149 *
150 *****************************************************************************/
151
152 #define _DECLARE_GLOBALS
153 #include "acpidump.h"
154
155
156 /*
157 * acpidump - A portable utility for obtaining system ACPI tables and dumping
158 * them in an ASCII hex format suitable for binary extraction via acpixtract.
159 *
160 * Obtaining the system ACPI tables is an OS-specific operation.
161 *
162 * This utility can be ported to any host operating system by providing a
163 * module containing system-specific versions of these interfaces:
164 *
165 * AcpiOsGetTableByAddress
166 * AcpiOsGetTableByIndex
167 * AcpiOsGetTableByName
168 *
169 * See the ACPICA Reference Guide for the exact definitions of these
170 * interfaces. Also, see these ACPICA source code modules for example
171 * implementations:
172 *
173 * source/os_specific/service_layers/oswintbl.c
174 * source/os_specific/service_layers/oslinuxtbl.c
175 */
176
177
178 /* Local prototypes */
179
180 static void
181 ApDisplayUsage (
182 void);
183
184 static int
185 ApDoOptions (
186 int argc,
187 char **argv);
188
189 static int
190 ApInsertAction (
191 char *Argument,
192 UINT32 ToBeDone);
193
194
195 /* Table for deferred actions from command line options */
196
197 AP_DUMP_ACTION ActionTable [AP_MAX_ACTIONS];
198 UINT32 CurrentAction = 0;
199
200
201 #define AP_UTILITY_NAME "ACPI Binary Table Dump Utility"
202 #define AP_SUPPORTED_OPTIONS "?a:bc:f:hn:o:r:sv^xz"
203
204
205 /******************************************************************************
206 *
207 * FUNCTION: ApDisplayUsage
208 *
209 * DESCRIPTION: Usage message for the AcpiDump utility
210 *
211 ******************************************************************************/
212
213 static void
ApDisplayUsage(void)214 ApDisplayUsage (
215 void)
216 {
217
218 ACPI_USAGE_HEADER ("acpidump [options]");
219
220 ACPI_OPTION ("-b", "Dump tables to binary files");
221 ACPI_OPTION ("-h -?", "This help message");
222 ACPI_OPTION ("-o <File>", "Redirect output to file");
223 ACPI_OPTION ("-r <Address>", "Dump tables from specified RSDP");
224 ACPI_OPTION ("-s", "Print table summaries only");
225 ACPI_OPTION ("-v", "Display version information");
226 ACPI_OPTION ("-vd", "Display build date and time");
227 ACPI_OPTION ("-z", "Verbose mode");
228
229 ACPI_USAGE_TEXT ("\nTable Options:\n");
230
231 ACPI_OPTION ("-a <Address>", "Get table via a physical address");
232 ACPI_OPTION ("-c <on|off>", "Turning on/off customized table dumping");
233 ACPI_OPTION ("-f <BinaryFile>", "Get table via a binary file");
234 ACPI_OPTION ("-n <Signature>", "Get table via a name/signature");
235 ACPI_OPTION ("-x", "Use RSDT instead of XSDT");
236
237 ACPI_USAGE_TEXT (
238 "\n"
239 "Invocation without parameters dumps all available tables\n"
240 "Multiple mixed instances of -a, -f, and -n are supported\n\n");
241 }
242
243
244 /******************************************************************************
245 *
246 * FUNCTION: ApInsertAction
247 *
248 * PARAMETERS: Argument - Pointer to the argument for this action
249 * ToBeDone - What to do to process this action
250 *
251 * RETURN: Status
252 *
253 * DESCRIPTION: Add an action item to the action table
254 *
255 ******************************************************************************/
256
257 static int
ApInsertAction(char * Argument,UINT32 ToBeDone)258 ApInsertAction (
259 char *Argument,
260 UINT32 ToBeDone)
261 {
262
263 /* Insert action and check for table overflow */
264
265 ActionTable [CurrentAction].Argument = Argument;
266 ActionTable [CurrentAction].ToBeDone = ToBeDone;
267
268 CurrentAction++;
269 if (CurrentAction > AP_MAX_ACTIONS)
270 {
271 fprintf (stderr, "Too many table options (max %d)\n", AP_MAX_ACTIONS);
272 return (-1);
273 }
274
275 return (0);
276 }
277
278
279 /******************************************************************************
280 *
281 * FUNCTION: ApDoOptions
282 *
283 * PARAMETERS: argc/argv - Standard argc/argv
284 *
285 * RETURN: Status
286 *
287 * DESCRIPTION: Command line option processing. The main actions for getting
288 * and dumping tables are deferred via the action table.
289 *
290 *****************************************************************************/
291
292 static int
ApDoOptions(int argc,char ** argv)293 ApDoOptions (
294 int argc,
295 char **argv)
296 {
297 int j;
298 ACPI_STATUS Status;
299
300
301 /* Command line options */
302
303 while ((j = AcpiGetopt (argc, argv, AP_SUPPORTED_OPTIONS)) != ACPI_OPT_END) switch (j)
304 {
305 /*
306 * Global options
307 */
308 case 'b': /* Dump all input tables to binary files */
309
310 Gbl_BinaryMode = TRUE;
311 continue;
312
313 case 'c': /* Dump customized tables */
314
315 if (!strcmp (AcpiGbl_Optarg, "on"))
316 {
317 Gbl_DumpCustomizedTables = TRUE;
318 }
319 else if (!strcmp (AcpiGbl_Optarg, "off"))
320 {
321 Gbl_DumpCustomizedTables = FALSE;
322 }
323 else
324 {
325 fprintf (stderr, "%s: Cannot handle this switch, please use on|off\n",
326 AcpiGbl_Optarg);
327 return (-1);
328 }
329 continue;
330
331 case 'h':
332 case '?':
333
334 ApDisplayUsage ();
335 return (1);
336
337 case 'o': /* Redirect output to a single file */
338
339 if (ApOpenOutputFile (AcpiGbl_Optarg))
340 {
341 return (-1);
342 }
343 continue;
344
345 case 'r': /* Dump tables from specified RSDP */
346
347 Status = AcpiUtStrtoul64 (AcpiGbl_Optarg, &Gbl_RsdpBase);
348 if (ACPI_FAILURE (Status))
349 {
350 fprintf (stderr, "%s: Could not convert to a physical address\n",
351 AcpiGbl_Optarg);
352 return (-1);
353 }
354 continue;
355
356 case 's': /* Print table summaries only */
357
358 Gbl_SummaryMode = TRUE;
359 continue;
360
361 case 'x': /* Do not use XSDT */
362
363 if (!AcpiGbl_DoNotUseXsdt)
364 {
365 AcpiGbl_DoNotUseXsdt = TRUE;
366 }
367 else
368 {
369 Gbl_DoNotDumpXsdt = TRUE;
370 }
371 continue;
372
373 case 'v': /* -v: (Version): signon already emitted, just exit */
374
375 switch (AcpiGbl_Optarg[0])
376 {
377 case '^': /* -v: (Version) */
378
379 fprintf (stderr, ACPI_COMMON_SIGNON (AP_UTILITY_NAME));
380 return (1);
381
382 case 'd':
383
384 fprintf (stderr, ACPI_COMMON_SIGNON (AP_UTILITY_NAME));
385 printf (ACPI_COMMON_BUILD_TIME);
386 return (1);
387
388 default:
389
390 printf ("Unknown option: -v%s\n", AcpiGbl_Optarg);
391 return (-1);
392 }
393 break;
394
395 case 'z': /* Verbose mode */
396
397 Gbl_VerboseMode = TRUE;
398 fprintf (stderr, ACPI_COMMON_SIGNON (AP_UTILITY_NAME));
399 continue;
400
401 /*
402 * Table options
403 */
404 case 'a': /* Get table by physical address */
405
406 if (ApInsertAction (AcpiGbl_Optarg, AP_DUMP_TABLE_BY_ADDRESS))
407 {
408 return (-1);
409 }
410 break;
411
412 case 'f': /* Get table from a file */
413
414 if (ApInsertAction (AcpiGbl_Optarg, AP_DUMP_TABLE_BY_FILE))
415 {
416 return (-1);
417 }
418 break;
419
420 case 'n': /* Get table by input name (signature) */
421
422 if (ApInsertAction (AcpiGbl_Optarg, AP_DUMP_TABLE_BY_NAME))
423 {
424 return (-1);
425 }
426 break;
427
428 default:
429
430 ApDisplayUsage ();
431 return (-1);
432 }
433
434 /* If there are no actions, this means "get/dump all tables" */
435
436 if (CurrentAction == 0)
437 {
438 if (ApInsertAction (NULL, AP_DUMP_ALL_TABLES))
439 {
440 return (-1);
441 }
442 }
443
444 return (0);
445 }
446
447
448 /******************************************************************************
449 *
450 * FUNCTION: main
451 *
452 * PARAMETERS: argc/argv - Standard argc/argv
453 *
454 * RETURN: Status
455 *
456 * DESCRIPTION: C main function for acpidump utility
457 *
458 ******************************************************************************/
459
460 #if !defined(_GNU_EFI) && !defined(_EDK2_EFI)
461 int ACPI_SYSTEM_XFACE
main(int argc,char * argv[])462 main (
463 int argc,
464 char *argv[])
465 #else
466 int ACPI_SYSTEM_XFACE
467 acpi_main (
468 int argc,
469 char *argv[])
470 #endif
471 {
472 int Status = 0;
473 AP_DUMP_ACTION *Action;
474 UINT32 FileSize;
475 UINT32 i;
476
477
478 ACPI_DEBUG_INITIALIZE (); /* For debug version only */
479 AcpiOsInitialize ();
480 Gbl_OutputFile = ACPI_FILE_OUT;
481 AcpiGbl_IntegerByteWidth = 8;
482
483 /* Process command line options */
484
485 Status = ApDoOptions (argc, argv);
486 if (Status > 0)
487 {
488 return (0);
489 }
490 if (Status < 0)
491 {
492 return (Status);
493 }
494
495 /* Get/dump ACPI table(s) as requested */
496
497 for (i = 0; i < CurrentAction; i++)
498 {
499 Action = &ActionTable[i];
500 switch (Action->ToBeDone)
501 {
502 case AP_DUMP_ALL_TABLES:
503
504 Status = ApDumpAllTables ();
505 break;
506
507 case AP_DUMP_TABLE_BY_ADDRESS:
508
509 Status = ApDumpTableByAddress (Action->Argument);
510 break;
511
512 case AP_DUMP_TABLE_BY_NAME:
513
514 Status = ApDumpTableByName (Action->Argument);
515 break;
516
517 case AP_DUMP_TABLE_BY_FILE:
518
519 Status = ApDumpTableFromFile (Action->Argument);
520 break;
521
522 default:
523
524 fprintf (stderr, "Internal error, invalid action: 0x%X\n",
525 Action->ToBeDone);
526 return (-1);
527 }
528
529 if (Status)
530 {
531 return (Status);
532 }
533 }
534
535 if (Gbl_OutputFilename)
536 {
537 if (Gbl_VerboseMode)
538 {
539 /* Summary for the output file */
540
541 FileSize = CmGetFileSize (Gbl_OutputFile);
542 fprintf (stderr, "Output file %s contains 0x%X (%u) bytes\n\n",
543 Gbl_OutputFilename, FileSize, FileSize);
544 }
545
546 fclose (Gbl_OutputFile);
547 }
548
549 return (Status);
550 }
551
