abmain.c revision 1.1.1.8 1 /******************************************************************************
2 *
3 * Module Name: abmain - Main module for the acpi binary utility
4 *
5 *****************************************************************************/
6
7 /*
8 * Copyright (C) 2000 - 2017, 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 "acpibin.h"
46
47 /* Local prototypes */
48
49 static void
50 AbDisplayUsage (
51 UINT8 OptionCount);
52
53
54 #define AB_UTILITY_NAME "ACPI Binary Table Dump Utility"
55 #define AB_SUPPORTED_OPTIONS "a:c:d:h:o:s:tv^"
56
57
58 /******************************************************************************
59 *
60 * FUNCTION: AbDisplayUsage
61 *
62 * DESCRIPTION: Usage message
63 *
64 ******************************************************************************/
65
66 static void
67 AbDisplayUsage (
68 UINT8 OptionCount)
69 {
70
71 if (OptionCount)
72 {
73 printf ("Option requires %u arguments\n\n", OptionCount);
74 }
75
76 ACPI_USAGE_HEADER ("acpibin [options]");
77
78 ACPI_OPTION ("-a <File1> <File2>", "Compare two binary AML files, dump all mismatches");
79 ACPI_OPTION ("-c <File1> <File2>", "Compare two binary AML files, dump first 100 mismatches");
80 ACPI_OPTION ("-d <In> <Out>", "Dump AML binary to text file");
81 ACPI_OPTION ("-e <Sig> <In> <Out>", "Extract binary AML table from acpidump file");
82 ACPI_OPTION ("-o <Value>", "Start comparison at this offset into second file");
83 ACPI_OPTION ("-h <File>", "Display table header for binary AML file");
84 ACPI_OPTION ("-s <File>", "Update checksum for binary AML file");
85 ACPI_OPTION ("-t", "Terse mode");
86 ACPI_OPTION ("-v", "Display version information");
87 ACPI_OPTION ("-vd", "Display build date and time");
88 }
89
90
91 /******************************************************************************
92 *
93 * FUNCTION: main
94 *
95 * DESCRIPTION: C main function
96 *
97 ******************************************************************************/
98
99 int ACPI_SYSTEM_XFACE
100 main (
101 int argc,
102 char *argv[])
103 {
104 int j;
105 int Status = AE_OK;
106
107
108 ACPI_DEBUG_INITIALIZE (); /* For debug version only */
109
110 AcpiGbl_DebugFile = NULL;
111 AcpiGbl_DbOutputFlags = DB_CONSOLE_OUTPUT;
112
113 AcpiOsInitialize ();
114 printf (ACPI_COMMON_SIGNON (AB_UTILITY_NAME));
115
116 if (argc < 2)
117 {
118 AbDisplayUsage (0);
119 return (0);
120 }
121
122 /* Command line options */
123
124 while ((j = AcpiGetopt (argc, argv, AB_SUPPORTED_OPTIONS)) != ACPI_OPT_END) switch(j)
125 {
126 case 'a': /* Compare Files, display all differences */
127
128 AbGbl_DisplayAllMiscompares = TRUE;
129
130 /* Fallthrough */
131
132 case 'c': /* Compare Files */
133
134 if (argc < 4)
135 {
136 AbDisplayUsage (2);
137 return (-1);
138 }
139
140 Status = AbCompareAmlFiles (AcpiGbl_Optarg, argv[AcpiGbl_Optind]);
141 break;
142
143 case 'd': /* Dump AML file */
144
145 if (argc < 4)
146 {
147 AbDisplayUsage (2);
148 return (-1);
149 }
150
151 Status = AbDumpAmlFile (AcpiGbl_Optarg, argv[AcpiGbl_Optind]);
152 break;
153
154 case 'h': /* Display ACPI table header */
155
156 if (argc < 3)
157 {
158 AbDisplayUsage (1);
159 return (-1);
160 }
161
162 AbDisplayHeader (AcpiGbl_Optarg);
163 return (0);
164
165 case 'o':
166
167 AbGbl_CompareOffset = atoi (AcpiGbl_Optarg);
168 continue;
169
170 case 's': /* Compute/update checksum */
171
172 if (argc < 3)
173 {
174 AbDisplayUsage (1);
175 return (-1);
176 }
177
178 AbComputeChecksum (AcpiGbl_Optarg);
179 return (0);
180
181 case 't': /* Enable terse mode */
182
183 Gbl_TerseMode = TRUE;
184 break;
185
186 case 'v': /* -v: (Version): signon already emitted, just exit */
187
188 switch (AcpiGbl_Optarg[0])
189 {
190 case '^': /* -v: (Version): signon already emitted, just exit */
191
192 return (1);
193
194 case 'd':
195
196 printf (ACPI_COMMON_BUILD_TIME);
197 return (1);
198
199 default:
200
201 printf ("Unknown option: -v%s\n", AcpiGbl_Optarg);
202 return (-1);
203 }
204 break;
205
206 default:
207
208 AbDisplayUsage (0);
209 return (-1);
210 }
211
212 return (Status);
213 }
214