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