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 - 2016, 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#define _DECLARE_GLOBALS
117#include "acpidump.h"
118#include "acapps.h"
119
120
121/*
122 * acpidump - A portable utility for obtaining system ACPI tables and dumping
123 * them in an ASCII hex format suitable for binary extraction via acpixtract.
124 *
125 * Obtaining the system ACPI tables is an OS-specific operation.
126 *
127 * This utility can be ported to any host operating system by providing a
128 * module containing system-specific versions of these interfaces:
129 *
130 *      AcpiOsGetTableByAddress
131 *      AcpiOsGetTableByIndex
132 *      AcpiOsGetTableByName
133 *
134 * See the ACPICA Reference Guide for the exact definitions of these
135 * interfaces. Also, see these ACPICA source code modules for example
136 * implementations:
137 *
138 *      source/os_specific/service_layers/oswintbl.c
139 *      source/os_specific/service_layers/oslinuxtbl.c
140 */
141
142
143/* Local prototypes */
144
145static void
146ApDisplayUsage (
147    void);
148
149static int
150ApDoOptions (
151    int                     argc,
152    char                    **argv);
153
154static int
155ApInsertAction (
156    char                    *Argument,
157    UINT32                  ToBeDone);
158
159
160/* Table for deferred actions from command line options */
161
162AP_DUMP_ACTION              ActionTable [AP_MAX_ACTIONS];
163UINT32                      CurrentAction = 0;
164
165
166#define AP_UTILITY_NAME             "ACPI Binary Table Dump Utility"
167#define AP_SUPPORTED_OPTIONS        "?a:bc:f:hn:o:r:svxz"
168
169
170/******************************************************************************
171 *
172 * FUNCTION:    ApDisplayUsage
173 *
174 * DESCRIPTION: Usage message for the AcpiDump utility
175 *
176 ******************************************************************************/
177
178static void
179ApDisplayUsage (
180    void)
181{
182
183    ACPI_USAGE_HEADER ("acpidump [options]");
184
185    ACPI_OPTION ("-b",                      "Dump tables to binary files");
186    ACPI_OPTION ("-h -?",                   "This help message");
187    ACPI_OPTION ("-o <File>",               "Redirect output to file");
188    ACPI_OPTION ("-r <Address>",            "Dump tables from specified RSDP");
189    ACPI_OPTION ("-s",                      "Print table summaries only");
190    ACPI_OPTION ("-v",                      "Display version information");
191    ACPI_OPTION ("-z",                      "Verbose mode");
192
193    ACPI_USAGE_TEXT ("\nTable Options:\n");
194
195    ACPI_OPTION ("-a <Address>",            "Get table via a physical address");
196    ACPI_OPTION ("-c <on|off>",             "Turning on/off customized table dumping");
197    ACPI_OPTION ("-f <BinaryFile>",         "Get table via a binary file");
198    ACPI_OPTION ("-n <Signature>",          "Get table via a name/signature");
199    ACPI_OPTION ("-x",                      "Do not use but dump XSDT");
200    ACPI_OPTION ("-x -x",                   "Do not use or dump XSDT");
201
202    ACPI_USAGE_TEXT (
203        "\n"
204        "Invocation without parameters dumps all available tables\n"
205        "Multiple mixed instances of -a, -f, and -n are supported\n\n");
206}
207
208
209/******************************************************************************
210 *
211 * FUNCTION:    ApInsertAction
212 *
213 * PARAMETERS:  Argument            - Pointer to the argument for this action
214 *              ToBeDone            - What to do to process this action
215 *
216 * RETURN:      Status
217 *
218 * DESCRIPTION: Add an action item to the action table
219 *
220 ******************************************************************************/
221
222static int
223ApInsertAction (
224    char                    *Argument,
225    UINT32                  ToBeDone)
226{
227
228    /* Insert action and check for table overflow */
229
230    ActionTable [CurrentAction].Argument = Argument;
231    ActionTable [CurrentAction].ToBeDone = ToBeDone;
232
233    CurrentAction++;
234    if (CurrentAction > AP_MAX_ACTIONS)
235    {
236        AcpiLogError ("Too many table options (max %u)\n", AP_MAX_ACTIONS);
237        return (-1);
238    }
239
240    return (0);
241}
242
243
244/******************************************************************************
245 *
246 * FUNCTION:    ApDoOptions
247 *
248 * PARAMETERS:  argc/argv           - Standard argc/argv
249 *
250 * RETURN:      Status
251 *
252 * DESCRIPTION: Command line option processing. The main actions for getting
253 *              and dumping tables are deferred via the action table.
254 *
255 *****************************************************************************/
256
257static int
258ApDoOptions (
259    int                     argc,
260    char                    **argv)
261{
262    int                     j;
263    ACPI_STATUS             Status;
264
265
266    /* Command line options */
267
268    while ((j = AcpiGetopt (argc, argv, AP_SUPPORTED_OPTIONS)) != ACPI_OPT_END) switch (j)
269    {
270    /*
271     * Global options
272     */
273    case 'b':   /* Dump all input tables to binary files */
274
275        Gbl_BinaryMode = TRUE;
276        continue;
277
278    case 'c':   /* Dump customized tables */
279
280        if (!strcmp (AcpiGbl_Optarg, "on"))
281        {
282            Gbl_DumpCustomizedTables = TRUE;
283        }
284        else if (!strcmp (AcpiGbl_Optarg, "off"))
285        {
286            Gbl_DumpCustomizedTables = FALSE;
287        }
288        else
289        {
290            AcpiLogError ("%s: Cannot handle this switch, please use on|off\n",
291                AcpiGbl_Optarg);
292            return (-1);
293        }
294        continue;
295
296    case 'h':
297    case '?':
298
299        ApDisplayUsage ();
300        return (1);
301
302    case 'o':   /* Redirect output to a single file */
303
304        if (ApOpenOutputFile (AcpiGbl_Optarg))
305        {
306            return (-1);
307        }
308        continue;
309
310    case 'r':   /* Dump tables from specified RSDP */
311
312        Status = AcpiUtStrtoul64 (AcpiGbl_Optarg, ACPI_ANY_BASE,
313            ACPI_MAX64_BYTE_WIDTH, &Gbl_RsdpBase);
314        if (ACPI_FAILURE (Status))
315        {
316            AcpiLogError ("%s: Could not convert to a physical address\n",
317                AcpiGbl_Optarg);
318            return (-1);
319        }
320        continue;
321
322    case 's':   /* Print table summaries only */
323
324        Gbl_SummaryMode = TRUE;
325        continue;
326
327    case 'x':   /* Do not use XSDT */
328
329        if (!AcpiGbl_DoNotUseXsdt)
330        {
331            AcpiGbl_DoNotUseXsdt = TRUE;
332        }
333        else
334        {
335            Gbl_DoNotDumpXsdt = TRUE;
336        }
337        continue;
338
339    case 'v':   /* Revision/version */
340
341        AcpiOsPrintf (ACPI_COMMON_SIGNON (AP_UTILITY_NAME));
342        return (1);
343
344    case 'z':   /* Verbose mode */
345
346        Gbl_VerboseMode = TRUE;
347        AcpiLogError (ACPI_COMMON_SIGNON (AP_UTILITY_NAME));
348        continue;
349
350    /*
351     * Table options
352     */
353    case 'a':   /* Get table by physical address */
354
355        if (ApInsertAction (AcpiGbl_Optarg, AP_DUMP_TABLE_BY_ADDRESS))
356        {
357            return (-1);
358        }
359        break;
360
361    case 'f':   /* Get table from a file */
362
363        if (ApInsertAction (AcpiGbl_Optarg, AP_DUMP_TABLE_BY_FILE))
364        {
365            return (-1);
366        }
367        break;
368
369    case 'n':   /* Get table by input name (signature) */
370
371        if (ApInsertAction (AcpiGbl_Optarg, AP_DUMP_TABLE_BY_NAME))
372        {
373            return (-1);
374        }
375        break;
376
377    default:
378
379        ApDisplayUsage ();
380        return (-1);
381    }
382
383    /* If there are no actions, this means "get/dump all tables" */
384
385    if (CurrentAction == 0)
386    {
387        if (ApInsertAction (NULL, AP_DUMP_ALL_TABLES))
388        {
389            return (-1);
390        }
391    }
392
393    return (0);
394}
395
396
397/******************************************************************************
398 *
399 * FUNCTION:    main
400 *
401 * PARAMETERS:  argc/argv           - Standard argc/argv
402 *
403 * RETURN:      Status
404 *
405 * DESCRIPTION: C main function for acpidump utility
406 *
407 ******************************************************************************/
408
409#ifndef _GNU_EFI
410int ACPI_SYSTEM_XFACE
411main (
412    int                     argc,
413    char                    *argv[])
414#else
415int ACPI_SYSTEM_XFACE
416acpi_main (
417    int                     argc,
418    char                    *argv[])
419#endif
420{
421    int                     Status = 0;
422    AP_DUMP_ACTION          *Action;
423    UINT32                  FileSize;
424    UINT32                  i;
425
426
427    ACPI_DEBUG_INITIALIZE (); /* For debug version only */
428    AcpiOsInitialize ();
429    Gbl_OutputFile = ACPI_FILE_OUT;
430
431    /* Process command line options */
432
433    Status = ApDoOptions (argc, argv);
434    if (Status > 0)
435    {
436        return (0);
437    }
438    if (Status < 0)
439    {
440        return (Status);
441    }
442
443    /* Get/dump ACPI table(s) as requested */
444
445    for (i = 0; i < CurrentAction; i++)
446    {
447        Action = &ActionTable[i];
448        switch (Action->ToBeDone)
449        {
450        case AP_DUMP_ALL_TABLES:
451
452            Status = ApDumpAllTables ();
453            break;
454
455        case AP_DUMP_TABLE_BY_ADDRESS:
456
457            Status = ApDumpTableByAddress (Action->Argument);
458            break;
459
460        case AP_DUMP_TABLE_BY_NAME:
461
462            Status = ApDumpTableByName (Action->Argument);
463            break;
464
465        case AP_DUMP_TABLE_BY_FILE:
466
467            Status = ApDumpTableFromFile (Action->Argument);
468            break;
469
470        default:
471
472            AcpiLogError ("Internal error, invalid action: 0x%X\n",
473                Action->ToBeDone);
474            return (-1);
475        }
476
477        if (Status)
478        {
479            return (Status);
480        }
481    }
482
483    if (Gbl_OutputFilename)
484    {
485        if (Gbl_VerboseMode)
486        {
487            /* Summary for the output file */
488
489            FileSize = CmGetFileSize (Gbl_OutputFile);
490            AcpiLogError ("Output file %s contains 0x%X (%u) bytes\n\n",
491                Gbl_OutputFilename, FileSize, FileSize);
492        }
493
494        AcpiOsCloseFile (Gbl_OutputFile);
495    }
496
497    return (Status);
498}
499