1 /******************************************************************************
2  *
3  * Module Name: apmain - Main module for the acpidump utility
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2015, Intel Corp.
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
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.
25  *
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.
29  *
30  * NO WARRANTY
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.
42  */
43 
44 #define _DECLARE_GLOBALS
45 #include "acpidump.h"
46 #include "acapps.h"
47 
48 
49 /*
50  * acpidump - A portable utility for obtaining system ACPI tables and dumping
51  * them in an ASCII hex format suitable for binary extraction via acpixtract.
52  *
53  * Obtaining the system ACPI tables is an OS-specific operation.
54  *
55  * This utility can be ported to any host operating system by providing a
56  * module containing system-specific versions of these interfaces:
57  *
58  *      AcpiOsGetTableByAddress
59  *      AcpiOsGetTableByIndex
60  *      AcpiOsGetTableByName
61  *
62  * See the ACPICA Reference Guide for the exact definitions of these
63  * interfaces. Also, see these ACPICA source code modules for example
64  * implementations:
65  *
66  *      source/os_specific/service_layers/oswintbl.c
67  *      source/os_specific/service_layers/oslinuxtbl.c
68  */
69 
70 
71 /* Local prototypes */
72 
73 static void
74 ApDisplayUsage (
75     void);
76 
77 static int
78 ApDoOptions (
79     int                     argc,
80     char                    **argv);
81 
82 static int
83 ApInsertAction (
84     char                    *Argument,
85     UINT32                  ToBeDone);
86 
87 
88 /* Table for deferred actions from command line options */
89 
90 AP_DUMP_ACTION              ActionTable [AP_MAX_ACTIONS];
91 UINT32                      CurrentAction = 0;
92 
93 
94 #define AP_UTILITY_NAME             "ACPI Binary Table Dump Utility"
95 #define AP_SUPPORTED_OPTIONS        "?a:bc:f:hn:o:r:svxz"
96 
97 
98 /******************************************************************************
99  *
100  * FUNCTION:    ApDisplayUsage
101  *
102  * DESCRIPTION: Usage message for the AcpiDump utility
103  *
104  ******************************************************************************/
105 
106 static void
107 ApDisplayUsage (
108     void)
109 {
110 
111     ACPI_USAGE_HEADER ("acpidump [options]");
112 
113     ACPI_OPTION ("-b",                      "Dump tables to binary files");
114     ACPI_OPTION ("-h -?",                   "This help message");
115     ACPI_OPTION ("-o <File>",               "Redirect output to file");
116     ACPI_OPTION ("-r <Address>",            "Dump tables from specified RSDP");
117     ACPI_OPTION ("-s",                      "Print table summaries only");
118     ACPI_OPTION ("-v",                      "Display version information");
119     ACPI_OPTION ("-z",                      "Verbose mode");
120 
121     ACPI_USAGE_TEXT ("\nTable Options:\n");
122 
123     ACPI_OPTION ("-a <Address>",            "Get table via a physical address");
124     ACPI_OPTION ("-c <on|off>",             "Turning on/off customized table dumping");
125     ACPI_OPTION ("-f <BinaryFile>",         "Get table via a binary file");
126     ACPI_OPTION ("-n <Signature>",          "Get table via a name/signature");
127     ACPI_OPTION ("-x",                      "Do not use but dump XSDT");
128     ACPI_OPTION ("-x -x",                   "Do not use or dump XSDT");
129 
130     ACPI_USAGE_TEXT (
131         "\n"
132         "Invocation without parameters dumps all available tables\n"
133         "Multiple mixed instances of -a, -f, and -n are supported\n\n");
134 }
135 
136 
137 /******************************************************************************
138  *
139  * FUNCTION:    ApInsertAction
140  *
141  * PARAMETERS:  Argument            - Pointer to the argument for this action
142  *              ToBeDone            - What to do to process this action
143  *
144  * RETURN:      Status
145  *
146  * DESCRIPTION: Add an action item to the action table
147  *
148  ******************************************************************************/
149 
150 static int
151 ApInsertAction (
152     char                    *Argument,
153     UINT32                  ToBeDone)
154 {
155 
156     /* Insert action and check for table overflow */
157 
158     ActionTable [CurrentAction].Argument = Argument;
159     ActionTable [CurrentAction].ToBeDone = ToBeDone;
160 
161     CurrentAction++;
162     if (CurrentAction > AP_MAX_ACTIONS)
163     {
164         AcpiLogError ("Too many table options (max %u)\n", AP_MAX_ACTIONS);
165         return (-1);
166     }
167 
168     return (0);
169 }
170 
171 
172 /******************************************************************************
173  *
174  * FUNCTION:    ApDoOptions
175  *
176  * PARAMETERS:  argc/argv           - Standard argc/argv
177  *
178  * RETURN:      Status
179  *
180  * DESCRIPTION: Command line option processing. The main actions for getting
181  *              and dumping tables are deferred via the action table.
182  *
183  *****************************************************************************/
184 
185 static int
186 ApDoOptions (
187     int                     argc,
188     char                    **argv)
189 {
190     int                     j;
191     ACPI_STATUS             Status;
192 
193 
194     /* Command line options */
195 
196     while ((j = AcpiGetopt (argc, argv, AP_SUPPORTED_OPTIONS)) != ACPI_OPT_END) switch (j)
197     {
198     /*
199      * Global options
200      */
201     case 'b':   /* Dump all input tables to binary files */
202 
203         Gbl_BinaryMode = TRUE;
204         continue;
205 
206     case 'c':   /* Dump customized tables */
207 
208         if (!strcmp (AcpiGbl_Optarg, "on"))
209         {
210             Gbl_DumpCustomizedTables = TRUE;
211         }
212         else if (!strcmp (AcpiGbl_Optarg, "off"))
213         {
214             Gbl_DumpCustomizedTables = FALSE;
215         }
216         else
217         {
218             AcpiLogError ("%s: Cannot handle this switch, please use on|off\n",
219                 AcpiGbl_Optarg);
220             return (-1);
221         }
222         continue;
223 
224     case 'h':
225     case '?':
226 
227         ApDisplayUsage ();
228         return (1);
229 
230     case 'o':   /* Redirect output to a single file */
231 
232         if (ApOpenOutputFile (AcpiGbl_Optarg))
233         {
234             return (-1);
235         }
236         continue;
237 
238     case 'r':   /* Dump tables from specified RSDP */
239 
240         Status = AcpiUtStrtoul64 (AcpiGbl_Optarg, 0, &Gbl_RsdpBase);
241         if (ACPI_FAILURE (Status))
242         {
243             AcpiLogError ("%s: Could not convert to a physical address\n",
244                 AcpiGbl_Optarg);
245             return (-1);
246         }
247         continue;
248 
249     case 's':   /* Print table summaries only */
250 
251         Gbl_SummaryMode = TRUE;
252         continue;
253 
254     case 'x':   /* Do not use XSDT */
255 
256         if (!AcpiGbl_DoNotUseXsdt)
257         {
258             AcpiGbl_DoNotUseXsdt = TRUE;
259         }
260         else
261         {
262             Gbl_DoNotDumpXsdt = TRUE;
263         }
264         continue;
265 
266     case 'v':   /* Revision/version */
267 
268         AcpiOsPrintf (ACPI_COMMON_SIGNON (AP_UTILITY_NAME));
269         return (1);
270 
271     case 'z':   /* Verbose mode */
272 
273         Gbl_VerboseMode = TRUE;
274         AcpiLogError (ACPI_COMMON_SIGNON (AP_UTILITY_NAME));
275         continue;
276 
277     /*
278      * Table options
279      */
280     case 'a':   /* Get table by physical address */
281 
282         if (ApInsertAction (AcpiGbl_Optarg, AP_DUMP_TABLE_BY_ADDRESS))
283         {
284             return (-1);
285         }
286         break;
287 
288     case 'f':   /* Get table from a file */
289 
290         if (ApInsertAction (AcpiGbl_Optarg, AP_DUMP_TABLE_BY_FILE))
291         {
292             return (-1);
293         }
294         break;
295 
296     case 'n':   /* Get table by input name (signature) */
297 
298         if (ApInsertAction (AcpiGbl_Optarg, AP_DUMP_TABLE_BY_NAME))
299         {
300             return (-1);
301         }
302         break;
303 
304     default:
305 
306         ApDisplayUsage ();
307         return (-1);
308     }
309 
310     /* If there are no actions, this means "get/dump all tables" */
311 
312     if (CurrentAction == 0)
313     {
314         if (ApInsertAction (NULL, AP_DUMP_ALL_TABLES))
315         {
316             return (-1);
317         }
318     }
319 
320     return (0);
321 }
322 
323 
324 /******************************************************************************
325  *
326  * FUNCTION:    main
327  *
328  * PARAMETERS:  argc/argv           - Standard argc/argv
329  *
330  * RETURN:      Status
331  *
332  * DESCRIPTION: C main function for acpidump utility
333  *
334  ******************************************************************************/
335 
336 #ifndef _GNU_EFI
337 int ACPI_SYSTEM_XFACE
338 main (
339     int                     argc,
340     char                    *argv[])
341 #else
342 int ACPI_SYSTEM_XFACE
343 acpi_main (
344     int                     argc,
345     char                    *argv[])
346 #endif
347 {
348     int                     Status = 0;
349     AP_DUMP_ACTION          *Action;
350     UINT32                  FileSize;
351     UINT32                  i;
352 
353 
354     ACPI_DEBUG_INITIALIZE (); /* For debug version only */
355     AcpiOsInitialize ();
356     Gbl_OutputFile = ACPI_FILE_OUT;
357 
358     /* Process command line options */
359 
360     Status = ApDoOptions (argc, argv);
361     if (Status > 0)
362     {
363         return (0);
364     }
365     if (Status < 0)
366     {
367         return (Status);
368     }
369 
370     /* Get/dump ACPI table(s) as requested */
371 
372     for (i = 0; i < CurrentAction; i++)
373     {
374         Action = &ActionTable[i];
375         switch (Action->ToBeDone)
376         {
377         case AP_DUMP_ALL_TABLES:
378 
379             Status = ApDumpAllTables ();
380             break;
381 
382         case AP_DUMP_TABLE_BY_ADDRESS:
383 
384             Status = ApDumpTableByAddress (Action->Argument);
385             break;
386 
387         case AP_DUMP_TABLE_BY_NAME:
388 
389             Status = ApDumpTableByName (Action->Argument);
390             break;
391 
392         case AP_DUMP_TABLE_BY_FILE:
393 
394             Status = ApDumpTableFromFile (Action->Argument);
395             break;
396 
397         default:
398 
399             AcpiLogError ("Internal error, invalid action: 0x%X\n",
400                 Action->ToBeDone);
401             return (-1);
402         }
403 
404         if (Status)
405         {
406             return (Status);
407         }
408     }
409 
410     if (Gbl_OutputFilename)
411     {
412         if (Gbl_VerboseMode)
413         {
414             /* Summary for the output file */
415 
416             FileSize = CmGetFileSize (Gbl_OutputFile);
417             AcpiLogError ("Output file %s contains 0x%X (%u) bytes\n\n",
418                 Gbl_OutputFilename, FileSize, FileSize);
419         }
420 
421         AcpiOsCloseFile (Gbl_OutputFile);
422     }
423 
424     return (Status);
425 }
426