tools/acpixtract/axmain.c

   1 /******************************************************************************
   2  *
   3  * Module Name: axmain - main module for acpixtract utility
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2012, 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 #include "acpi.h"
  45 #include "accommon.h"
  46 #include "acapps.h"
  47 #include <stdio.h>
  48
  49
  50 static void
  51 DisplayUsage (
  52     void);
  53
  54 int
  55 AxExtractTables (
  56     char                    *InputPathname,
  57     char                    *Signature,
  58     unsigned int            MinimumInstances);
  59
  60 int
  61 AxListTables (
  62     char                    *InputPathname);
  63
  64
  65 /* Options */
  66
  67 #define AX_EXTRACT_ALL          0
  68 #define AX_LIST_ALL             1
  69 #define AX_EXTRACT_SIGNATURE    2
  70 #define AX_EXTRACT_AML_TABLES   3
  71
  72 static int          AxAction = AX_EXTRACT_AML_TABLES; /* DSDT & SSDTs */
  73
  74 #define AX_OPTIONAL_TABLES      0
  75 #define AX_REQUIRED_TABLE       1
  76
  77
  78 /******************************************************************************
  79  *
  80  * FUNCTION:    DisplayUsage
  81  *
  82  * DESCRIPTION: Usage message
  83  *
  84  ******************************************************************************/
  85
  86 static void
  87 DisplayUsage (
  88     void)
  89 {
  90
  91     ACPI_USAGE_HEADER ("acpixtract [option] <InputFile>");
  92
  93     ACPI_OPTION ("-a",                  "Extract all tables, not just DSDT/SSDT");
  94     ACPI_OPTION ("-l",                  "List table summaries, do not extract");
  95     ACPI_OPTION ("-s <signature>",      "Extract all tables with <signature>");
  96
  97     printf ("\nExtract binary ACPI tables from text acpidump output\n");
  98     printf ("Default invocation extracts the DSDT and all SSDTs\n");
  99 }
 100
 101
 102 /******************************************************************************
 103  *
 104  * FUNCTION:    main
 105  *
 106  * DESCRIPTION: C main function
 107  *
 108  ******************************************************************************/
 109
 110 int
 111 main (
 112     int                     argc,
 113     char                    *argv[])
 114 {
 115     char                    *Filename;
 116     int                     Status;
 117     int                     j;
 118
 119
 120     printf (ACPI_COMMON_SIGNON ("ACPI Binary Table Extraction Utility"));
 121
 122     if (argc < 2)
 123     {
 124         DisplayUsage ();
 125         return (0);
 126     }
 127
 128     /* Command line options */
 129
 130     while ((j = AcpiGetopt (argc, argv, "ahls:")) != EOF) switch (j)
 131     {
 132     case 'a':
 133         AxAction = AX_EXTRACT_ALL;          /* Extract all tables found */
 134         break;
 135
 136     case 'l':
 137         AxAction = AX_LIST_ALL;             /* List tables only, do not extract */
 138         break;
 139
 140     case 's':
 141         AxAction = AX_EXTRACT_SIGNATURE;    /* Extract only tables with this sig */
 142         break;
 143
 144     case 'h':
 145     default:
 146         DisplayUsage ();
 147         return (0);
 148     }
 149
 150     /* Input filename is always required */
 151
 152     Filename = argv[AcpiGbl_Optind];
 153     if (!Filename)
 154     {
 155         printf ("Missing required input filename\n");
 156         return (-1);
 157     }
 158
 159     /* Perform requested action */
 160
 161     switch (AxAction)
 162     {
 163     case AX_EXTRACT_ALL:
 164         Status = AxExtractTables (Filename, NULL, AX_OPTIONAL_TABLES);
 165         break;
 166
 167     case AX_LIST_ALL:
 168         Status = AxListTables (Filename);
 169         break;
 170
 171     case AX_EXTRACT_SIGNATURE:
 172         Status = AxExtractTables (Filename, AcpiGbl_Optarg, AX_REQUIRED_TABLE);
 173         break;
 174
 175     default:
 176         /*
 177          * Default output is the DSDT and all SSDTs. One DSDT is required,
 178          * any SSDTs are optional.
 179          */
 180         Status = AxExtractTables (Filename, "DSDT", AX_REQUIRED_TABLE);
 181         if (Status)
 182         {
 183             return (Status);
 184         }
 185
 186         Status = AxExtractTables (Filename, "SSDT", AX_OPTIONAL_TABLES);
 187         break;
 188     }
 189
 190     return (Status);
 191 }