sys/contrib/dev/acpica/source/tools/acpidump/apmain.c

   1 /******************************************************************************
   2  *
   3  * Module Name: apmain - Main module for the acpidump utility
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2014, 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:bcf: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 ("-c",                      "Dump customized tables");
 115     ACPI_OPTION ("-h -?",                   "This help message");
 116     ACPI_OPTION ("-o <File>",               "Redirect output to file");
 117     ACPI_OPTION ("-r <Address>",            "Dump tables from specified RSDP");
 118     ACPI_OPTION ("-s",                      "Print table summaries only");
 119     ACPI_OPTION ("-v",                      "Display version information");
 120     ACPI_OPTION ("-z",                      "Verbose mode");
 121
 122     ACPI_USAGE_TEXT ("\nTable Options:\n");
 123
 124     ACPI_OPTION ("-a <Address>",            "Get table via a physical address");
 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         Gbl_DumpCustomizedTables = TRUE;
 209         continue;
 210
 211     case 'h':
 212     case '?':
 213
 214         ApDisplayUsage ();
 215         return (1);
 216
 217     case 'o':   /* Redirect output to a single file */
 218
 219         if (ApOpenOutputFile (AcpiGbl_Optarg))
 220         {
 221             return (-1);
 222         }
 223         continue;
 224
 225     case 'r':   /* Dump tables from specified RSDP */
 226
 227         Status = AcpiUtStrtoul64 (AcpiGbl_Optarg, 0, &Gbl_RsdpBase);
 228         if (ACPI_FAILURE (Status))
 229         {
 230             AcpiLogError ("%s: Could not convert to a physical address\n",
 231                 AcpiGbl_Optarg);
 232             return (-1);
 233         }
 234         continue;
 235
 236     case 's':   /* Print table summaries only */
 237
 238         Gbl_SummaryMode = TRUE;
 239         continue;
 240
 241     case 'x':   /* Do not use XSDT */
 242
 243         if (!AcpiGbl_DoNotUseXsdt)
 244         {
 245             AcpiGbl_DoNotUseXsdt = TRUE;
 246         }
 247         else
 248         {
 249             Gbl_DoNotDumpXsdt = TRUE;
 250         }
 251         continue;
 252
 253     case 'v':   /* Revision/version */
 254
 255         AcpiOsPrintf (ACPI_COMMON_SIGNON (AP_UTILITY_NAME));
 256         return (1);
 257
 258     case 'z':   /* Verbose mode */
 259
 260         Gbl_VerboseMode = TRUE;
 261         AcpiLogError (ACPI_COMMON_SIGNON (AP_UTILITY_NAME));
 262         continue;
 263
 264     /*
 265      * Table options
 266      */
 267     case 'a':   /* Get table by physical address */
 268
 269         if (ApInsertAction (AcpiGbl_Optarg, AP_DUMP_TABLE_BY_ADDRESS))
 270         {
 271             return (-1);
 272         }
 273         break;
 274
 275     case 'f':   /* Get table from a file */
 276
 277         if (ApInsertAction (AcpiGbl_Optarg, AP_DUMP_TABLE_BY_FILE))
 278         {
 279             return (-1);
 280         }
 281         break;
 282
 283     case 'n':   /* Get table by input name (signature) */
 284
 285         if (ApInsertAction (AcpiGbl_Optarg, AP_DUMP_TABLE_BY_NAME))
 286         {
 287             return (-1);
 288         }
 289         break;
 290
 291     default:
 292
 293         ApDisplayUsage ();
 294         return (-1);
 295     }
 296
 297     /* If there are no actions, this means "get/dump all tables" */
 298
 299     if (CurrentAction == 0)
 300     {
 301         if (ApInsertAction (NULL, AP_DUMP_ALL_TABLES))
 302         {
 303             return (-1);
 304         }
 305     }
 306
 307     return (0);
 308 }
 309
 310
 311 /******************************************************************************
 312  *
 313  * FUNCTION:    main
 314  *
 315  * PARAMETERS:  argc/argv           - Standard argc/argv
 316  *
 317  * RETURN:      Status
 318  *
 319  * DESCRIPTION: C main function for acpidump utility
 320  *
 321  ******************************************************************************/
 322
 323 #ifndef _GNU_EFI
 324 int ACPI_SYSTEM_XFACE
 325 main (
 326     int                     argc,
 327     char                    *argv[])
 328 #else
 329 int ACPI_SYSTEM_XFACE
 330 acpi_main (
 331     int                     argc,
 332     char                    *argv[])
 333 #endif
 334 {
 335     int                     Status = 0;
 336     AP_DUMP_ACTION          *Action;
 337     UINT32                  FileSize;
 338     UINT32                  i;
 339
 340
 341     ACPI_DEBUG_INITIALIZE (); /* For debug version only */
 342     AcpiOsInitialize ();
 343     Gbl_OutputFile = ACPI_FILE_OUT;
 344
 345     /* Process command line options */
 346
 347     Status = ApDoOptions (argc, argv);
 348     if (Status > 0)
 349     {
 350         return (0);
 351     }
 352     if (Status < 0)
 353     {
 354         return (Status);
 355     }
 356
 357     /* Get/dump ACPI table(s) as requested */
 358
 359     for (i = 0; i < CurrentAction; i++)
 360     {
 361         Action = &ActionTable[i];
 362         switch (Action->ToBeDone)
 363         {
 364         case AP_DUMP_ALL_TABLES:
 365
 366             Status = ApDumpAllTables ();
 367             break;
 368
 369         case AP_DUMP_TABLE_BY_ADDRESS:
 370
 371             Status = ApDumpTableByAddress (Action->Argument);
 372             break;
 373
 374         case AP_DUMP_TABLE_BY_NAME:
 375
 376             Status = ApDumpTableByName (Action->Argument);
 377             break;
 378
 379         case AP_DUMP_TABLE_BY_FILE:
 380
 381             Status = ApDumpTableFromFile (Action->Argument);
 382             break;
 383
 384         default:
 385
 386             AcpiLogError ("Internal error, invalid action: 0x%X\n",
 387                 Action->ToBeDone);
 388             return (-1);
 389         }
 390
 391         if (Status)
 392         {
 393             return (Status);
 394         }
 395     }
 396
 397     if (Gbl_OutputFilename)
 398     {
 399         if (Gbl_VerboseMode)
 400         {
 401             /* Summary for the output file */
 402
 403             FileSize = CmGetFileSize (Gbl_OutputFile);
 404             AcpiLogError ("Output file %s contains 0x%X (%u) bytes\n\n",
 405                 Gbl_OutputFilename, FileSize, FileSize);
 406         }
 407
 408         AcpiOsCloseFile (Gbl_OutputFile);
 409     }
 410
 411     return (Status);
 412 }