xref: /illumos-gate/usr/src/cmd/acpi/acpixtract/axmain.c (revision d17be682a2c70b4505d43c830bbd2603da11918d)
1 /******************************************************************************
2  *
3  * Module Name: axmain - main module for acpixtract utility
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12  * All rights reserved.
13  *
14  * 2. License
15  *
16  * 2.1. This is your license from Intel Corp. under its intellectual property
17  * rights. You may have additional license terms from the party that provided
18  * you this software, covering your right to use that party's intellectual
19  * property rights.
20  *
21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22  * copy of the source code appearing in this file ("Covered Code") an
23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24  * base code distributed originally by Intel ("Original Intel Code") to copy,
25  * make derivatives, distribute, use and display any portion of the Covered
26  * Code in any form, with the right to sublicense such rights; and
27  *
28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29  * license (with the right to sublicense), under only those claims of Intel
30  * patents that are infringed by the Original Intel Code, to make, use, sell,
31  * offer to sell, and import the Covered Code and derivative works thereof
32  * solely to the minimum extent necessary to exercise the above copyright
33  * license, and in no event shall the patent license extend to any additions
34  * to or modifications of the Original Intel Code. No other license or right
35  * is granted directly or by implication, estoppel or otherwise;
36  *
37  * The above copyright and patent license is granted only if the following
38  * conditions are met:
39  *
40  * 3. Conditions
41  *
42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43  * Redistribution of source code of any substantial portion of the Covered
44  * Code or modification with rights to further distribute source must include
45  * the above Copyright Notice, the above License, this list of Conditions,
46  * and the following Disclaimer and Export Compliance provision. In addition,
47  * Licensee must cause all Covered Code to which Licensee contributes to
48  * contain a file documenting the changes Licensee made to create that Covered
49  * Code and the date of any change. Licensee must include in that file the
50  * documentation of any changes made by any predecessor Licensee. Licensee
51  * must include a prominent statement that the modification is derived,
52  * directly or indirectly, from Original Intel Code.
53  *
54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55  * Redistribution of source code of any substantial portion of the Covered
56  * Code or modification without rights to further distribute source must
57  * include the following Disclaimer and Export Compliance provision in the
58  * documentation and/or other materials provided with distribution. In
59  * addition, Licensee may not authorize further sublicense of source of any
60  * portion of the Covered Code, and must include terms to the effect that the
61  * license from Licensee to its licensee is limited to the intellectual
62  * property embodied in the software Licensee provides to its licensee, and
63  * not to intellectual property embodied in modifications its licensee may
64  * make.
65  *
66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67  * substantial portion of the Covered Code or modification must reproduce the
68  * above Copyright Notice, and the following Disclaimer and Export Compliance
69  * provision in the documentation and/or other materials provided with the
70  * distribution.
71  *
72  * 3.4. Intel retains all right, title, and interest in and to the Original
73  * Intel Code.
74  *
75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76  * Intel shall be used in advertising or otherwise to promote the sale, use or
77  * other dealings in products derived from or relating to the Covered Code
78  * without prior written authorization from Intel.
79  *
80  * 4. Disclaimer and Export Compliance
81  *
82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88  * PARTICULAR PURPOSE.
89  *
90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97  * LIMITED REMEDY.
98  *
99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100  * software or system incorporating such software without first obtaining any
101  * required license or other approval from the U. S. Department of Commerce or
102  * any other agency or department of the United States Government. In the
103  * event Licensee exports any such software from the United States or
104  * re-exports any such software from a foreign destination, Licensee shall
105  * ensure that the distribution and export/re-export of the software is in
106  * compliance with all laws, regulations, orders, or other restrictions of the
107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108  * any of its subsidiaries will export/re-export any technical data, process,
109  * software, or service, directly or indirectly, to any country for which the
110  * United States government or any agency thereof requires an export license,
111  * other governmental approval, or letter of assurance, without first obtaining
112  * such license, approval or letter.
113  *
114  *****************************************************************************
115  *
116  * Alternatively, you may choose to be licensed under the terms of the
117  * following license:
118  *
119  * Redistribution and use in source and binary forms, with or without
120  * modification, are permitted provided that the following conditions
121  * are met:
122  * 1. Redistributions of source code must retain the above copyright
123  *    notice, this list of conditions, and the following disclaimer,
124  *    without modification.
125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126  *    substantially similar to the "NO WARRANTY" disclaimer below
127  *    ("Disclaimer") and any redistribution must be conditioned upon
128  *    including a substantially similar Disclaimer requirement for further
129  *    binary redistribution.
130  * 3. Neither the names of the above-listed copyright holders nor the names
131  *    of any contributors may be used to endorse or promote products derived
132  *    from this software without specific prior written permission.
133  *
134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145  *
146  * Alternatively, you may choose to be licensed under the terms of the
147  * GNU General Public License ("GPL") version 2 as published by the Free
148  * Software Foundation.
149  *
150  *****************************************************************************/
151 
152 #define DEFINE_ACPIXTRACT_GLOBALS
153 #include "acpixtract.h"
154 
155 
156 /* Local prototypes */
157 
158 static void
159 DisplayUsage (
160     void);
161 
162 
163 /******************************************************************************
164  *
165  * FUNCTION:    DisplayUsage
166  *
167  * DESCRIPTION: Usage message
168  *
169  ******************************************************************************/
170 
171 static void
172 DisplayUsage (
173     void)
174 {
175 
176     ACPI_USAGE_HEADER ("acpixtract [option] <InputFile>");
177 
178     ACPI_OPTION ("-a",                  "Extract all tables, not just DSDT/SSDT");
179     ACPI_OPTION ("-f",                  "Force extraction, even if there are errors");
180     ACPI_OPTION ("-l",                  "List table summaries, do not extract");
181     ACPI_OPTION ("-m",                  "Extract multiple DSDT/SSDTs to a single file");
182     ACPI_OPTION ("-s <signature>",      "Extract all tables with <signature>");
183     ACPI_OPTION ("-v",                  "Display version information");
184     ACPI_OPTION ("-vd",                 "Display build date and time");
185 
186     ACPI_USAGE_TEXT ("\nExtract binary ACPI tables from text acpidump output\n");
187     ACPI_USAGE_TEXT ("Default invocation extracts the DSDT and all SSDTs\n");
188 }
189 
190 
191 /******************************************************************************
192  *
193  * FUNCTION:    main
194  *
195  * DESCRIPTION: C main function
196  *
197  ******************************************************************************/
198 
199 int
200 main (
201     int                     argc,
202     char                    *argv[])
203 {
204     char                    *Filename;
205     int                     AxAction;
206     int                     Status;
207     int                     j;
208 
209 
210     Gbl_TableCount = 0;
211     Gbl_TableListHead = NULL;
212     Gbl_ForceExtraction = FALSE;
213     AxAction = AX_EXTRACT_AML_TABLES; /* Default: DSDT & SSDTs */
214 
215     ACPI_DEBUG_INITIALIZE (); /* For debug version only */
216     AcpiOsInitialize ();
217     printf (ACPI_COMMON_SIGNON (AX_UTILITY_NAME));
218 
219     if (argc < 2)
220     {
221         DisplayUsage ();
222         return (0);
223     }
224 
225     /* Command line options */
226 
227     while ((j = AcpiGetopt (argc, argv, AX_SUPPORTED_OPTIONS)) != ACPI_OPT_END) switch (j)
228     {
229     case 'a':
230 
231         AxAction = AX_EXTRACT_ALL;          /* Extract all tables found */
232         break;
233 
234     case 'f':
235 
236         Gbl_ForceExtraction = TRUE;           /* Ignore errors */
237         break;
238 
239     case 'l':
240 
241         AxAction = AX_LIST_ALL;             /* List tables only, do not extract */
242         break;
243 
244     case 'm':
245 
246         AxAction = AX_EXTRACT_MULTI_TABLE;  /* Make single file for all DSDT/SSDTs */
247         break;
248 
249     case 's':
250 
251         AxAction = AX_EXTRACT_SIGNATURE;    /* Extract only tables with this sig */
252         break;
253 
254     case 'v':
255 
256         switch (AcpiGbl_Optarg[0])
257         {
258         case '^':  /* -v: (Version): signon already emitted, just exit */
259 
260             exit (0);
261 
262         case 'd':
263 
264             printf (ACPI_COMMON_BUILD_TIME);
265             return (0);
266 
267         default:
268 
269             printf ("Unknown option: -v%s\n", AcpiGbl_Optarg);
270             return (-1);
271         }
272         break;
273 
274     case 'h':
275     default:
276 
277         DisplayUsage ();
278         return (0);
279     }
280 
281     /* Input filename is always required */
282 
283     Filename = argv[AcpiGbl_Optind];
284     if (!Filename)
285     {
286         printf ("Missing required input filename\n");
287         return (-1);
288     }
289 
290     /* Perform requested action */
291 
292     switch (AxAction)
293     {
294     case AX_EXTRACT_ALL:
295 
296         Status = AxExtractTables (Filename, NULL, AX_OPTIONAL_TABLES);
297         break;
298 
299     case AX_EXTRACT_MULTI_TABLE:
300 
301         Status = AxExtractToMultiAmlFile (Filename);
302         break;
303 
304     case AX_LIST_ALL:
305 
306         Status = AxListAllTables (Filename);
307         break;
308 
309     case AX_EXTRACT_SIGNATURE:
310 
311         Status = AxExtractTables (Filename, AcpiGbl_Optarg, AX_REQUIRED_TABLE);
312         break;
313 
314     default:
315         /*
316          * Default output is the DSDT and all SSDTs. One DSDT is required,
317          * any SSDTs are optional.
318          */
319         Status = AxExtractTables (Filename, "DSDT", AX_REQUIRED_TABLE);
320         if (Status)
321         {
322             return (Status);
323         }
324 
325         Status = AxExtractTables (Filename, "SSDT", AX_OPTIONAL_TABLES);
326         break;
327     }
328 
329     return (Status);
330 }
331