ahaml.c revision 1.1.1.1.2.2 1 1.1.1.1.2.2 skrll /******************************************************************************
2 1.1.1.1.2.2 skrll *
3 1.1.1.1.2.2 skrll * Module Name: ahaml - AML opcode decoding for acpihelp utility
4 1.1.1.1.2.2 skrll *
5 1.1.1.1.2.2 skrll *****************************************************************************/
6 1.1.1.1.2.2 skrll
7 1.1.1.1.2.2 skrll /*
8 1.1.1.1.2.2 skrll * Copyright (C) 2000 - 2017, Intel Corp.
9 1.1.1.1.2.2 skrll * All rights reserved.
10 1.1.1.1.2.2 skrll *
11 1.1.1.1.2.2 skrll * Redistribution and use in source and binary forms, with or without
12 1.1.1.1.2.2 skrll * modification, are permitted provided that the following conditions
13 1.1.1.1.2.2 skrll * are met:
14 1.1.1.1.2.2 skrll * 1. Redistributions of source code must retain the above copyright
15 1.1.1.1.2.2 skrll * notice, this list of conditions, and the following disclaimer,
16 1.1.1.1.2.2 skrll * without modification.
17 1.1.1.1.2.2 skrll * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 1.1.1.1.2.2 skrll * substantially similar to the "NO WARRANTY" disclaimer below
19 1.1.1.1.2.2 skrll * ("Disclaimer") and any redistribution must be conditioned upon
20 1.1.1.1.2.2 skrll * including a substantially similar Disclaimer requirement for further
21 1.1.1.1.2.2 skrll * binary redistribution.
22 1.1.1.1.2.2 skrll * 3. Neither the names of the above-listed copyright holders nor the names
23 1.1.1.1.2.2 skrll * of any contributors may be used to endorse or promote products derived
24 1.1.1.1.2.2 skrll * from this software without specific prior written permission.
25 1.1.1.1.2.2 skrll *
26 1.1.1.1.2.2 skrll * Alternatively, this software may be distributed under the terms of the
27 1.1.1.1.2.2 skrll * GNU General Public License ("GPL") version 2 as published by the Free
28 1.1.1.1.2.2 skrll * Software Foundation.
29 1.1.1.1.2.2 skrll *
30 1.1.1.1.2.2 skrll * NO WARRANTY
31 1.1.1.1.2.2 skrll * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 1.1.1.1.2.2 skrll * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 1.1.1.1.2.2 skrll * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 1.1.1.1.2.2 skrll * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 1.1.1.1.2.2 skrll * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 1.1.1.1.2.2 skrll * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 1.1.1.1.2.2 skrll * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 1.1.1.1.2.2 skrll * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 1.1.1.1.2.2 skrll * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 1.1.1.1.2.2 skrll * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 1.1.1.1.2.2 skrll * POSSIBILITY OF SUCH DAMAGES.
42 1.1.1.1.2.2 skrll */
43 1.1.1.1.2.2 skrll
44 1.1.1.1.2.2 skrll #include "acpihelp.h"
45 1.1.1.1.2.2 skrll
46 1.1.1.1.2.2 skrll
47 1.1.1.1.2.2 skrll /* Local prototypes */
48 1.1.1.1.2.2 skrll
49 1.1.1.1.2.2 skrll static void
50 1.1.1.1.2.2 skrll AhDisplayAmlOpcode (
51 1.1.1.1.2.2 skrll const AH_AML_OPCODE *Op);
52 1.1.1.1.2.2 skrll
53 1.1.1.1.2.2 skrll static void
54 1.1.1.1.2.2 skrll AhDisplayAmlType (
55 1.1.1.1.2.2 skrll const AH_AML_TYPE *Op);
56 1.1.1.1.2.2 skrll
57 1.1.1.1.2.2 skrll
58 1.1.1.1.2.2 skrll /*******************************************************************************
59 1.1.1.1.2.2 skrll *
60 1.1.1.1.2.2 skrll * FUNCTION: AhFindAmlOpcode (entry point for AML opcode name search)
61 1.1.1.1.2.2 skrll *
62 1.1.1.1.2.2 skrll * PARAMETERS: Name - Name or prefix for an AML opcode.
63 1.1.1.1.2.2 skrll * NULL means "find all"
64 1.1.1.1.2.2 skrll *
65 1.1.1.1.2.2 skrll * RETURN: None
66 1.1.1.1.2.2 skrll *
67 1.1.1.1.2.2 skrll * DESCRIPTION: Find all AML opcodes that match the input Name or name
68 1.1.1.1.2.2 skrll * prefix.
69 1.1.1.1.2.2 skrll *
70 1.1.1.1.2.2 skrll ******************************************************************************/
71 1.1.1.1.2.2 skrll
72 1.1.1.1.2.2 skrll void
73 1.1.1.1.2.2 skrll AhFindAmlOpcode (
74 1.1.1.1.2.2 skrll char *Name)
75 1.1.1.1.2.2 skrll {
76 1.1.1.1.2.2 skrll const AH_AML_OPCODE *Op;
77 1.1.1.1.2.2 skrll BOOLEAN Found = FALSE;
78 1.1.1.1.2.2 skrll
79 1.1.1.1.2.2 skrll
80 1.1.1.1.2.2 skrll AcpiUtStrupr (Name);
81 1.1.1.1.2.2 skrll
82 1.1.1.1.2.2 skrll /* Find/display all opcode names that match the input name prefix */
83 1.1.1.1.2.2 skrll
84 1.1.1.1.2.2 skrll for (Op = Gbl_AmlOpcodeInfo; Op->OpcodeString; Op++)
85 1.1.1.1.2.2 skrll {
86 1.1.1.1.2.2 skrll if (!Op->OpcodeName) /* Unused opcodes */
87 1.1.1.1.2.2 skrll {
88 1.1.1.1.2.2 skrll continue;
89 1.1.1.1.2.2 skrll }
90 1.1.1.1.2.2 skrll
91 1.1.1.1.2.2 skrll if (!Name || (Name[0] == '*'))
92 1.1.1.1.2.2 skrll {
93 1.1.1.1.2.2 skrll AhDisplayAmlOpcode (Op);
94 1.1.1.1.2.2 skrll Found = TRUE;
95 1.1.1.1.2.2 skrll continue;
96 1.1.1.1.2.2 skrll }
97 1.1.1.1.2.2 skrll
98 1.1.1.1.2.2 skrll /* Upper case the opcode name before substring compare */
99 1.1.1.1.2.2 skrll
100 1.1.1.1.2.2 skrll strcpy (Gbl_Buffer, Op->OpcodeName);
101 1.1.1.1.2.2 skrll AcpiUtStrupr (Gbl_Buffer);
102 1.1.1.1.2.2 skrll
103 1.1.1.1.2.2 skrll if (strstr (Gbl_Buffer, Name) == Gbl_Buffer)
104 1.1.1.1.2.2 skrll {
105 1.1.1.1.2.2 skrll AhDisplayAmlOpcode (Op);
106 1.1.1.1.2.2 skrll Found = TRUE;
107 1.1.1.1.2.2 skrll }
108 1.1.1.1.2.2 skrll }
109 1.1.1.1.2.2 skrll
110 1.1.1.1.2.2 skrll if (!Found)
111 1.1.1.1.2.2 skrll {
112 1.1.1.1.2.2 skrll printf ("%s, no matching AML operators\n", Name);
113 1.1.1.1.2.2 skrll }
114 1.1.1.1.2.2 skrll }
115 1.1.1.1.2.2 skrll
116 1.1.1.1.2.2 skrll
117 1.1.1.1.2.2 skrll /*******************************************************************************
118 1.1.1.1.2.2 skrll *
119 1.1.1.1.2.2 skrll * FUNCTION: AhDecodeAmlOpcode (entry point for AML opcode search)
120 1.1.1.1.2.2 skrll *
121 1.1.1.1.2.2 skrll * PARAMETERS: OpcodeString - String version of AML opcode
122 1.1.1.1.2.2 skrll *
123 1.1.1.1.2.2 skrll * RETURN: None
124 1.1.1.1.2.2 skrll *
125 1.1.1.1.2.2 skrll * DESCRIPTION: Display information about the input AML opcode
126 1.1.1.1.2.2 skrll *
127 1.1.1.1.2.2 skrll ******************************************************************************/
128 1.1.1.1.2.2 skrll
129 1.1.1.1.2.2 skrll void
130 1.1.1.1.2.2 skrll AhDecodeAmlOpcode (
131 1.1.1.1.2.2 skrll char *OpcodeString)
132 1.1.1.1.2.2 skrll {
133 1.1.1.1.2.2 skrll const AH_AML_OPCODE *Op;
134 1.1.1.1.2.2 skrll UINT32 Opcode;
135 1.1.1.1.2.2 skrll UINT8 Prefix;
136 1.1.1.1.2.2 skrll
137 1.1.1.1.2.2 skrll
138 1.1.1.1.2.2 skrll if (!OpcodeString)
139 1.1.1.1.2.2 skrll {
140 1.1.1.1.2.2 skrll AhFindAmlOpcode (NULL);
141 1.1.1.1.2.2 skrll return;
142 1.1.1.1.2.2 skrll }
143 1.1.1.1.2.2 skrll
144 1.1.1.1.2.2 skrll Opcode = strtoul (OpcodeString, NULL, 16);
145 1.1.1.1.2.2 skrll if (Opcode > ACPI_UINT16_MAX)
146 1.1.1.1.2.2 skrll {
147 1.1.1.1.2.2 skrll printf ("Invalid opcode (more than 16 bits)\n");
148 1.1.1.1.2.2 skrll return;
149 1.1.1.1.2.2 skrll }
150 1.1.1.1.2.2 skrll
151 1.1.1.1.2.2 skrll /* Only valid opcode extension is 0x5B */
152 1.1.1.1.2.2 skrll
153 1.1.1.1.2.2 skrll Prefix = (Opcode & 0x0000FF00) >> 8;
154 1.1.1.1.2.2 skrll if (Prefix && (Prefix != 0x5B))
155 1.1.1.1.2.2 skrll {
156 1.1.1.1.2.2 skrll printf ("Invalid opcode (invalid extension prefix 0x%X)\n",
157 1.1.1.1.2.2 skrll Prefix);
158 1.1.1.1.2.2 skrll return;
159 1.1.1.1.2.2 skrll }
160 1.1.1.1.2.2 skrll
161 1.1.1.1.2.2 skrll /* Find/Display the opcode. May fall within an opcode range */
162 1.1.1.1.2.2 skrll
163 1.1.1.1.2.2 skrll for (Op = Gbl_AmlOpcodeInfo; Op->OpcodeString; Op++)
164 1.1.1.1.2.2 skrll {
165 1.1.1.1.2.2 skrll if ((Opcode >= Op->OpcodeRangeStart) &&
166 1.1.1.1.2.2 skrll (Opcode <= Op->OpcodeRangeEnd))
167 1.1.1.1.2.2 skrll {
168 1.1.1.1.2.2 skrll AhDisplayAmlOpcode (Op);
169 1.1.1.1.2.2 skrll }
170 1.1.1.1.2.2 skrll }
171 1.1.1.1.2.2 skrll }
172 1.1.1.1.2.2 skrll
173 1.1.1.1.2.2 skrll
174 1.1.1.1.2.2 skrll /*******************************************************************************
175 1.1.1.1.2.2 skrll *
176 1.1.1.1.2.2 skrll * FUNCTION: AhDisplayAmlOpcode
177 1.1.1.1.2.2 skrll *
178 1.1.1.1.2.2 skrll * PARAMETERS: Op - An opcode info struct
179 1.1.1.1.2.2 skrll *
180 1.1.1.1.2.2 skrll * RETURN: None
181 1.1.1.1.2.2 skrll *
182 1.1.1.1.2.2 skrll * DESCRIPTION: Display the contents of an AML opcode information struct
183 1.1.1.1.2.2 skrll *
184 1.1.1.1.2.2 skrll ******************************************************************************/
185 1.1.1.1.2.2 skrll
186 1.1.1.1.2.2 skrll static void
187 1.1.1.1.2.2 skrll AhDisplayAmlOpcode (
188 1.1.1.1.2.2 skrll const AH_AML_OPCODE *Op)
189 1.1.1.1.2.2 skrll {
190 1.1.1.1.2.2 skrll
191 1.1.1.1.2.2 skrll if (!Op->OpcodeName)
192 1.1.1.1.2.2 skrll {
193 1.1.1.1.2.2 skrll printf ("%18s: Opcode=%-9s\n", "Reserved opcode", Op->OpcodeString);
194 1.1.1.1.2.2 skrll return;
195 1.1.1.1.2.2 skrll }
196 1.1.1.1.2.2 skrll
197 1.1.1.1.2.2 skrll /* Opcode name and value(s) */
198 1.1.1.1.2.2 skrll
199 1.1.1.1.2.2 skrll printf ("%18s: Opcode=%-9s Type (%s)",
200 1.1.1.1.2.2 skrll Op->OpcodeName, Op->OpcodeString, Op->Type);
201 1.1.1.1.2.2 skrll
202 1.1.1.1.2.2 skrll /* Optional fixed/static arguments */
203 1.1.1.1.2.2 skrll
204 1.1.1.1.2.2 skrll if (Op->FixedArguments)
205 1.1.1.1.2.2 skrll {
206 1.1.1.1.2.2 skrll printf (" FixedArgs (");
207 1.1.1.1.2.2 skrll AhPrintOneField (37, 36 + 7 + strlen (Op->Type) + 12,
208 1.1.1.1.2.2 skrll AH_MAX_AML_LINE_LENGTH, Op->FixedArguments);
209 1.1.1.1.2.2 skrll printf (")");
210 1.1.1.1.2.2 skrll }
211 1.1.1.1.2.2 skrll
212 1.1.1.1.2.2 skrll /* Optional variable-length argument list */
213 1.1.1.1.2.2 skrll
214 1.1.1.1.2.2 skrll if (Op->VariableArguments)
215 1.1.1.1.2.2 skrll {
216 1.1.1.1.2.2 skrll if (Op->FixedArguments)
217 1.1.1.1.2.2 skrll {
218 1.1.1.1.2.2 skrll printf ("\n%*s", 36, " ");
219 1.1.1.1.2.2 skrll }
220 1.1.1.1.2.2 skrll printf (" VariableArgs (");
221 1.1.1.1.2.2 skrll AhPrintOneField (37, 15, AH_MAX_AML_LINE_LENGTH, Op->VariableArguments);
222 1.1.1.1.2.2 skrll printf (")");
223 1.1.1.1.2.2 skrll }
224 1.1.1.1.2.2 skrll printf ("\n");
225 1.1.1.1.2.2 skrll
226 1.1.1.1.2.2 skrll /* Grammar specification */
227 1.1.1.1.2.2 skrll
228 1.1.1.1.2.2 skrll if (Op->Grammar)
229 1.1.1.1.2.2 skrll {
230 1.1.1.1.2.2 skrll AhPrintOneField (37, 0, AH_MAX_AML_LINE_LENGTH, Op->Grammar);
231 1.1.1.1.2.2 skrll printf ("\n");
232 1.1.1.1.2.2 skrll }
233 1.1.1.1.2.2 skrll }
234 1.1.1.1.2.2 skrll
235 1.1.1.1.2.2 skrll
236 1.1.1.1.2.2 skrll /*******************************************************************************
237 1.1.1.1.2.2 skrll *
238 1.1.1.1.2.2 skrll * FUNCTION: AhFindAmlTypes (entry point for AML grammar keyword search)
239 1.1.1.1.2.2 skrll *
240 1.1.1.1.2.2 skrll * PARAMETERS: Name - Name or prefix for an AML grammar element.
241 1.1.1.1.2.2 skrll * NULL means "find all"
242 1.1.1.1.2.2 skrll *
243 1.1.1.1.2.2 skrll * RETURN: None
244 1.1.1.1.2.2 skrll *
245 1.1.1.1.2.2 skrll * DESCRIPTION: Find all AML grammar keywords that match the input Name or name
246 1.1.1.1.2.2 skrll * prefix.
247 1.1.1.1.2.2 skrll *
248 1.1.1.1.2.2 skrll ******************************************************************************/
249 1.1.1.1.2.2 skrll
250 1.1.1.1.2.2 skrll void
251 1.1.1.1.2.2 skrll AhFindAmlTypes (
252 1.1.1.1.2.2 skrll char *Name)
253 1.1.1.1.2.2 skrll {
254 1.1.1.1.2.2 skrll const AH_AML_TYPE *Keyword;
255 1.1.1.1.2.2 skrll BOOLEAN Found = FALSE;
256 1.1.1.1.2.2 skrll
257 1.1.1.1.2.2 skrll
258 1.1.1.1.2.2 skrll AcpiUtStrupr (Name);
259 1.1.1.1.2.2 skrll
260 1.1.1.1.2.2 skrll for (Keyword = Gbl_AmlTypesInfo; Keyword->Name; Keyword++)
261 1.1.1.1.2.2 skrll {
262 1.1.1.1.2.2 skrll if (!Name)
263 1.1.1.1.2.2 skrll {
264 1.1.1.1.2.2 skrll printf (" %s\n", Keyword->Name);
265 1.1.1.1.2.2 skrll Found = TRUE;
266 1.1.1.1.2.2 skrll continue;
267 1.1.1.1.2.2 skrll }
268 1.1.1.1.2.2 skrll
269 1.1.1.1.2.2 skrll if (*Name == '*')
270 1.1.1.1.2.2 skrll {
271 1.1.1.1.2.2 skrll AhDisplayAmlType (Keyword);
272 1.1.1.1.2.2 skrll Found = TRUE;
273 1.1.1.1.2.2 skrll continue;
274 1.1.1.1.2.2 skrll }
275 1.1.1.1.2.2 skrll
276 1.1.1.1.2.2 skrll /* Upper case the operator name before substring compare */
277 1.1.1.1.2.2 skrll
278 1.1.1.1.2.2 skrll strcpy (Gbl_Buffer, Keyword->Name);
279 1.1.1.1.2.2 skrll AcpiUtStrupr (Gbl_Buffer);
280 1.1.1.1.2.2 skrll
281 1.1.1.1.2.2 skrll if (strstr (Gbl_Buffer, Name) == Gbl_Buffer)
282 1.1.1.1.2.2 skrll {
283 1.1.1.1.2.2 skrll AhDisplayAmlType (Keyword);
284 1.1.1.1.2.2 skrll Found = TRUE;
285 1.1.1.1.2.2 skrll }
286 1.1.1.1.2.2 skrll }
287 1.1.1.1.2.2 skrll
288 1.1.1.1.2.2 skrll if (!Found)
289 1.1.1.1.2.2 skrll {
290 1.1.1.1.2.2 skrll printf ("%s, no matching AML grammar type\n", Name);
291 1.1.1.1.2.2 skrll }
292 1.1.1.1.2.2 skrll }
293 1.1.1.1.2.2 skrll
294 1.1.1.1.2.2 skrll
295 1.1.1.1.2.2 skrll /*******************************************************************************
296 1.1.1.1.2.2 skrll *
297 1.1.1.1.2.2 skrll * FUNCTION: AhDisplayAmlType
298 1.1.1.1.2.2 skrll *
299 1.1.1.1.2.2 skrll * PARAMETERS: Op - Pointer to AML grammar info
300 1.1.1.1.2.2 skrll *
301 1.1.1.1.2.2 skrll * RETURN: None
302 1.1.1.1.2.2 skrll *
303 1.1.1.1.2.2 skrll * DESCRIPTION: Format and display info for an AML grammar element.
304 1.1.1.1.2.2 skrll *
305 1.1.1.1.2.2 skrll ******************************************************************************/
306 1.1.1.1.2.2 skrll
307 1.1.1.1.2.2 skrll static void
308 1.1.1.1.2.2 skrll AhDisplayAmlType (
309 1.1.1.1.2.2 skrll const AH_AML_TYPE *Op)
310 1.1.1.1.2.2 skrll {
311 1.1.1.1.2.2 skrll char *Description;
312 1.1.1.1.2.2 skrll
313 1.1.1.1.2.2 skrll
314 1.1.1.1.2.2 skrll Description = Op->Description;
315 1.1.1.1.2.2 skrll printf ("%4s", " "); /* Primary indent */
316 1.1.1.1.2.2 skrll
317 1.1.1.1.2.2 skrll /* Emit the entire description string */
318 1.1.1.1.2.2 skrll
319 1.1.1.1.2.2 skrll while (*Description)
320 1.1.1.1.2.2 skrll {
321 1.1.1.1.2.2 skrll /* Description can be multiple lines, must indent each */
322 1.1.1.1.2.2 skrll
323 1.1.1.1.2.2 skrll while (*Description != '\n')
324 1.1.1.1.2.2 skrll {
325 1.1.1.1.2.2 skrll printf ("%c", *Description);
326 1.1.1.1.2.2 skrll Description++;
327 1.1.1.1.2.2 skrll }
328 1.1.1.1.2.2 skrll
329 1.1.1.1.2.2 skrll printf ("\n");
330 1.1.1.1.2.2 skrll Description++;
331 1.1.1.1.2.2 skrll
332 1.1.1.1.2.2 skrll /* Do indent */
333 1.1.1.1.2.2 skrll
334 1.1.1.1.2.2 skrll if (*Description)
335 1.1.1.1.2.2 skrll {
336 1.1.1.1.2.2 skrll printf ("%8s", " "); /* Secondary indent */
337 1.1.1.1.2.2 skrll
338 1.1.1.1.2.2 skrll /* Index extra for a comment */
339 1.1.1.1.2.2 skrll
340 1.1.1.1.2.2 skrll if ((Description[0] == '/') &&
341 1.1.1.1.2.2 skrll (Description[1] == '/'))
342 1.1.1.1.2.2 skrll {
343 1.1.1.1.2.2 skrll printf ("%4s", " ");
344 1.1.1.1.2.2 skrll }
345 1.1.1.1.2.2 skrll }
346 1.1.1.1.2.2 skrll }
347 1.1.1.1.2.2 skrll
348 1.1.1.1.2.2 skrll printf ("\n");
349 1.1.1.1.2.2 skrll }
350