summaryrefslogtreecommitdiffstats
path: root/source/tools/acpidump/apmain.c
diff options
context:
space:
mode:
authorjkim <jkim@FreeBSD.org>2013-05-17 23:13:40 +0000
committerjkim <jkim@FreeBSD.org>2013-05-17 23:13:40 +0000
commitaf69f95bba3597db53a980597cfd371c9f6ee7cf (patch)
tree740dae2325e162bb086ea6e7e5d481c4b669e232 /source/tools/acpidump/apmain.c
parent00f95aec269522bc092cf85fe57fcfc19efecec9 (diff)
downloadFreeBSD-src-af69f95bba3597db53a980597cfd371c9f6ee7cf.zip
FreeBSD-src-af69f95bba3597db53a980597cfd371c9f6ee7cf.tar.gz
Import ACPICA 20130517.
Diffstat (limited to 'source/tools/acpidump/apmain.c')
-rw-r--r--source/tools/acpidump/apmain.c351
1 files changed, 351 insertions, 0 deletions
diff --git a/source/tools/acpidump/apmain.c b/source/tools/acpidump/apmain.c
new file mode 100644
index 0000000..9ee4f46
--- /dev/null
+++ b/source/tools/acpidump/apmain.c
@@ -0,0 +1,351 @@
+/******************************************************************************
+ *
+ * Module Name: apmain - Main module for the acpidump utility
+ *
+ *****************************************************************************/
+
+/*
+ * Copyright (C) 2000 - 2013, Intel Corp.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions, and the following disclaimer,
+ * without modification.
+ * 2. Redistributions in binary form must reproduce at minimum a disclaimer
+ * substantially similar to the "NO WARRANTY" disclaimer below
+ * ("Disclaimer") and any redistribution must be conditioned upon
+ * including a substantially similar Disclaimer requirement for further
+ * binary redistribution.
+ * 3. Neither the names of the above-listed copyright holders nor the names
+ * of any contributors may be used to endorse or promote products derived
+ * from this software without specific prior written permission.
+ *
+ * Alternatively, this software may be distributed under the terms of the
+ * GNU General Public License ("GPL") version 2 as published by the Free
+ * Software Foundation.
+ *
+ * NO WARRANTY
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGES.
+ */
+
+#define _DECLARE_GLOBALS
+#include "acpidump.h"
+#include "acapps.h"
+
+
+/*
+ * acpidump - A portable utility for obtaining system ACPI tables and dumping
+ * them in an ASCII hex format suitable for binary extraction via acpixtract.
+ *
+ * Obtaining the system ACPI tables is an OS-specific operation.
+ *
+ * This utility can be ported to any host operating system by providing a
+ * module containing system-specific versions of these interfaces:
+ *
+ * AcpiOsGetTableByAddress
+ * AcpiOsGetTableByIndex
+ * AcpiOsGetTableByName
+ *
+ * See the ACPICA Reference Guide for the exact definitions of these
+ * interfaces. Also, see these ACPICA source code modules for example
+ * implementations:
+ *
+ * source/os_specific/service_layers/oswintbl.c
+ * source/os_specific/service_layers/oslinuxtbl.c
+ */
+
+
+/* Local prototypes */
+
+static void
+ApDisplayUsage (
+ void);
+
+static int
+ApDoOptions (
+ int argc,
+ char **argv);
+
+static void
+ApInsertAction (
+ char *Argument,
+ UINT32 ToBeDone);
+
+
+/* Table for deferred actions from command line options */
+
+AP_DUMP_ACTION ActionTable [AP_MAX_ACTIONS];
+UINT32 CurrentAction = 0;
+
+
+#define AP_UTILITY_NAME "ACPI Binary Table Dump Utility"
+#define AP_SUPPORTED_OPTIONS "?a:bf:hn:o:rsv"
+
+
+/******************************************************************************
+ *
+ * FUNCTION: ApDisplayUsage
+ *
+ * DESCRIPTION: Usage message for the AcpiDump utility
+ *
+ ******************************************************************************/
+
+static void
+ApDisplayUsage (
+ void)
+{
+
+ ACPI_USAGE_HEADER ("acpidump [options]");
+
+ ACPI_OPTION ("-b", "Dump tables to binary files");
+ ACPI_OPTION ("-h -?", "This help message");
+ ACPI_OPTION ("-o <File>", "Redirect output to file");
+ ACPI_OPTION ("-r", "Revision (version)");
+ ACPI_OPTION ("-s", "Print table summaries only");
+ ACPI_OPTION ("-v", "Verbose mode");
+
+ printf ("\nTable Options:\n");
+
+ ACPI_OPTION ("-a <Address>", "Get table via physical address");
+ ACPI_OPTION ("-f <BinaryFile>", "Get table via binary file");
+ ACPI_OPTION ("-n <Signature>", "Get table via name/signature");
+
+ printf (
+ "\n"
+ "Invocation without parameters dumps all available tables\n"
+ "Multiple mixed instances of -a, -f, and -n are supported\n\n");
+}
+
+
+/******************************************************************************
+ *
+ * FUNCTION: ApInsertAction
+ *
+ * PARAMETERS: Argument - Pointer to the argument for this action
+ * ToBeDone - What to do to process this action
+ *
+ * RETURN: None. Exits program if action table becomes full.
+ *
+ * DESCRIPTION: Add an action item to the action table
+ *
+ ******************************************************************************/
+
+static void
+ApInsertAction (
+ char *Argument,
+ UINT32 ToBeDone)
+{
+
+ /* Insert action and check for table overflow */
+
+ ActionTable [CurrentAction].Argument = Argument;
+ ActionTable [CurrentAction].ToBeDone = ToBeDone;
+
+ CurrentAction++;
+ if (CurrentAction > AP_MAX_ACTIONS)
+ {
+ fprintf (stderr, "Too many table options (max %u)\n", AP_MAX_ACTIONS);
+ exit (-1);
+ }
+}
+
+
+/******************************************************************************
+ *
+ * FUNCTION: ApDoOptions
+ *
+ * PARAMETERS: argc/argv - Standard argc/argv
+ *
+ * RETURN: Status
+ *
+ * DESCRIPTION: Command line option processing. The main actions for getting
+ * and dumping tables are deferred via the action table.
+ *
+ *****************************************************************************/
+
+static int
+ApDoOptions (
+ int argc,
+ char **argv)
+{
+ int j;
+
+
+ /* Command line options */
+
+ while ((j = AcpiGetopt (argc, argv, AP_SUPPORTED_OPTIONS)) != EOF) switch (j)
+ {
+ /*
+ * Global options
+ */
+ case 'b': /* Dump all input tables to binary files */
+
+ Gbl_BinaryMode = TRUE;
+ continue;
+
+ case 'h':
+ case '?':
+
+ ApDisplayUsage ();
+ exit (0);
+
+ case 'o': /* Redirect output to a single file */
+
+ if (ApOpenOutputFile (AcpiGbl_Optarg))
+ {
+ exit (-1);
+ }
+ continue;
+
+ case 'r': /* Revision/version */
+
+ printf (ACPI_COMMON_SIGNON (AP_UTILITY_NAME));
+ exit (0);
+
+ case 's': /* Print table summaries only */
+
+ Gbl_SummaryMode = TRUE;
+ continue;
+
+ case 'v': /* Verbose mode */
+
+ Gbl_VerboseMode = TRUE;
+ fprintf (stderr, ACPI_COMMON_SIGNON (AP_UTILITY_NAME));
+ continue;
+
+ /*
+ * Table options
+ */
+ case 'a': /* Get table by physical address */
+
+ ApInsertAction (AcpiGbl_Optarg, AP_DUMP_TABLE_BY_ADDRESS);
+ break;
+
+ case 'f': /* Get table from a file */
+
+ ApInsertAction (AcpiGbl_Optarg, AP_DUMP_TABLE_BY_FILE);
+ break;
+
+ case 'n': /* Get table by input name (signature) */
+
+ ApInsertAction (AcpiGbl_Optarg, AP_DUMP_TABLE_BY_NAME);
+ break;
+
+ default:
+
+ ApDisplayUsage ();
+ exit (-1);
+ }
+
+ /* If there are no actions, this means "get/dump all tables" */
+
+ if (CurrentAction == 0)
+ {
+ ApInsertAction (NULL, AP_DUMP_ALL_TABLES);
+ }
+
+ return (0);
+}
+
+
+/******************************************************************************
+ *
+ * FUNCTION: main
+ *
+ * PARAMETERS: argc/argv - Standard argc/argv
+ *
+ * RETURN: Status
+ *
+ * DESCRIPTION: C main function for acpidump utility
+ *
+ ******************************************************************************/
+
+int ACPI_SYSTEM_XFACE
+main (
+ int argc,
+ char *argv[])
+{
+ int Status = 0;
+ AP_DUMP_ACTION *Action;
+ UINT32 FileSize;
+ UINT32 i;
+
+
+ ACPI_DEBUG_INITIALIZE (); /* For debug version only */
+
+ /* Process command line options */
+
+ if (ApDoOptions (argc, argv))
+ {
+ return (-1);
+ }
+
+ /* Get/dump ACPI table(s) as requested */
+
+ for (i = 0; i < CurrentAction; i++)
+ {
+ Action = &ActionTable[i];
+ switch (Action->ToBeDone)
+ {
+ case AP_DUMP_ALL_TABLES:
+
+ Status = ApDumpAllTables ();
+ break;
+
+ case AP_DUMP_TABLE_BY_ADDRESS:
+
+ Status = ApDumpTableByAddress (Action->Argument);
+ break;
+
+ case AP_DUMP_TABLE_BY_NAME:
+
+ Status = ApDumpTableByName (Action->Argument);
+ break;
+
+ case AP_DUMP_TABLE_BY_FILE:
+
+ Status = ApDumpTableFromFile (Action->Argument);
+ break;
+
+ default:
+
+ fprintf (stderr, "Internal error, invalid action: 0x%X\n",
+ Action->ToBeDone);
+ return (-1);
+ }
+
+ if (Status)
+ {
+ return (Status);
+ }
+ }
+
+ if (Gbl_OutputFile)
+ {
+ if (Gbl_VerboseMode)
+ {
+ /* Summary for the output file */
+
+ FileSize = ApGetFileSize (Gbl_OutputFile);
+ fprintf (stderr, "Output file %s contains 0x%X (%u) bytes\n\n",
+ Gbl_OutputFilename, FileSize, FileSize);
+ }
+
+ fclose (Gbl_OutputFile);
+ }
+
+ return (Status);
+}
OpenPOWER on IntegriCloud