1 /******************************************************************************
2 *
3 * Module Name: ahaml - AML opcode decoding for acpihelp utility
4 *
5 *****************************************************************************/
6
7 /******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2023, 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 #include "acpihelp.h"
153
154
155 /* Local prototypes */
156
157 static void
158 AhDisplayAmlOpcode (
159 const AH_AML_OPCODE *Op);
160
161 static void
162 AhDisplayAmlType (
163 const AH_AML_TYPE *Op);
164
165
166 /*******************************************************************************
167 *
168 * FUNCTION: AhFindAmlOpcode (entry point for AML opcode name search)
169 *
170 * PARAMETERS: Name - Name or prefix for an AML opcode.
171 * NULL means "find all"
172 *
173 * RETURN: None
174 *
175 * DESCRIPTION: Find all AML opcodes that match the input Name or name
176 * prefix.
177 *
178 ******************************************************************************/
179
180 void
AhFindAmlOpcode(char * Name)181 AhFindAmlOpcode (
182 char *Name)
183 {
184 const AH_AML_OPCODE *Op;
185 BOOLEAN Found = FALSE;
186
187
188 AcpiUtStrupr (Name);
189
190 /* Find/display all opcode names that match the input name prefix */
191
192 for (Op = Gbl_AmlOpcodeInfo; Op->OpcodeString; Op++)
193 {
194 if (!Op->OpcodeName) /* Unused opcodes */
195 {
196 continue;
197 }
198
199 if (!Name || (Name[0] == '*'))
200 {
201 AhDisplayAmlOpcode (Op);
202 Found = TRUE;
203 continue;
204 }
205
206 /* Upper case the opcode name before substring compare */
207
208 strcpy (Gbl_Buffer, Op->OpcodeName);
209 AcpiUtStrupr (Gbl_Buffer);
210
211 if (strstr (Gbl_Buffer, Name) == Gbl_Buffer)
212 {
213 AhDisplayAmlOpcode (Op);
214 Found = TRUE;
215 }
216 }
217
218 if (!Found && Name)
219 {
220 printf ("%s, no matching AML opcodes\n", Name);
221 }
222 }
223
224
225 /*******************************************************************************
226 *
227 * FUNCTION: AhDecodeAmlOpcode (entry point for AML opcode search)
228 *
229 * PARAMETERS: OpcodeString - String version of AML opcode
230 *
231 * RETURN: None
232 *
233 * DESCRIPTION: Display information about the input AML opcode
234 *
235 ******************************************************************************/
236
237 void
AhDecodeAmlOpcode(char * OpcodeString)238 AhDecodeAmlOpcode (
239 char *OpcodeString)
240 {
241 const AH_AML_OPCODE *Op;
242 UINT32 Opcode;
243 UINT8 Prefix;
244
245
246 if (!OpcodeString)
247 {
248 AhFindAmlOpcode (NULL);
249 return;
250 }
251
252 Opcode = strtoul (OpcodeString, NULL, 16);
253 if (Opcode > ACPI_UINT16_MAX)
254 {
255 printf ("Invalid opcode (more than 16 bits)\n");
256 return;
257 }
258
259 /* Only valid opcode extension is 0x5B */
260
261 Prefix = (Opcode & 0x0000FF00) >> 8;
262 if (Prefix && (Prefix != 0x5B))
263 {
264 printf ("Invalid opcode (invalid extension prefix 0x%X)\n",
265 Prefix);
266 return;
267 }
268
269 /* Find/Display the opcode. May fall within an opcode range */
270
271 for (Op = Gbl_AmlOpcodeInfo; Op->OpcodeString; Op++)
272 {
273 if ((Opcode >= Op->OpcodeRangeStart) &&
274 (Opcode <= Op->OpcodeRangeEnd))
275 {
276 AhDisplayAmlOpcode (Op);
277 }
278 }
279 }
280
281
282 /*******************************************************************************
283 *
284 * FUNCTION: AhDisplayAmlOpcode
285 *
286 * PARAMETERS: Op - An opcode info struct
287 *
288 * RETURN: None
289 *
290 * DESCRIPTION: Display the contents of an AML opcode information struct
291 *
292 ******************************************************************************/
293
294 static void
AhDisplayAmlOpcode(const AH_AML_OPCODE * Op)295 AhDisplayAmlOpcode (
296 const AH_AML_OPCODE *Op)
297 {
298
299 if (!Op->OpcodeName)
300 {
301 printf ("%18s: Opcode=%-9s\n", "Reserved opcode", Op->OpcodeString);
302 return;
303 }
304
305 /* Opcode name and value(s) */
306
307 printf ("%18s: Opcode=%-9s Type (%s)",
308 Op->OpcodeName, Op->OpcodeString, Op->Type);
309
310 /* Optional fixed/static arguments */
311
312 if (Op->FixedArguments)
313 {
314 printf (" FixedArgs (");
315 AhPrintOneField (37, 36 + 7 + strlen (Op->Type) + 12,
316 AH_MAX_AML_LINE_LENGTH, Op->FixedArguments);
317 printf (")");
318 }
319
320 /* Optional variable-length argument list */
321
322 if (Op->VariableArguments)
323 {
324 if (Op->FixedArguments)
325 {
326 printf ("\n%*s", 36, " ");
327 }
328 printf (" VariableArgs (");
329 AhPrintOneField (37, 15, AH_MAX_AML_LINE_LENGTH, Op->VariableArguments);
330 printf (")");
331 }
332 printf ("\n");
333
334 /* Grammar specification */
335
336 if (Op->Grammar)
337 {
338 AhPrintOneField (37, 0, AH_MAX_AML_LINE_LENGTH, Op->Grammar);
339 printf ("\n");
340 }
341 }
342
343
344 /*******************************************************************************
345 *
346 * FUNCTION: AhFindAmlTypes (entry point for AML grammar keyword search)
347 *
348 * PARAMETERS: Name - Name or prefix for an AML grammar element.
349 * NULL means "find all"
350 *
351 * RETURN: None
352 *
353 * DESCRIPTION: Find all AML grammar keywords that match the input Name or name
354 * prefix.
355 *
356 ******************************************************************************/
357
358 void
AhFindAmlTypes(char * Name)359 AhFindAmlTypes (
360 char *Name)
361 {
362 const AH_AML_TYPE *Keyword;
363 BOOLEAN Found = FALSE;
364
365
366 AcpiUtStrupr (Name);
367
368 for (Keyword = Gbl_AmlTypesInfo; Keyword->Name; Keyword++)
369 {
370 if (!Name)
371 {
372 printf (" %s\n", Keyword->Name);
373 Found = TRUE;
374 continue;
375 }
376
377 if (*Name == '*')
378 {
379 AhDisplayAmlType (Keyword);
380 Found = TRUE;
381 continue;
382 }
383
384 /* Upper case the operator name before substring compare */
385
386 strcpy (Gbl_Buffer, Keyword->Name);
387 AcpiUtStrupr (Gbl_Buffer);
388
389 if (strstr (Gbl_Buffer, Name) == Gbl_Buffer)
390 {
391 AhDisplayAmlType (Keyword);
392 Found = TRUE;
393 }
394 }
395
396 if (!Found)
397 {
398 printf ("%s, no matching AML grammar type\n", Name);
399 }
400 }
401
402
403 /*******************************************************************************
404 *
405 * FUNCTION: AhDisplayAmlType
406 *
407 * PARAMETERS: Op - Pointer to AML grammar info
408 *
409 * RETURN: None
410 *
411 * DESCRIPTION: Format and display info for an AML grammar element.
412 *
413 ******************************************************************************/
414
415 static void
AhDisplayAmlType(const AH_AML_TYPE * Op)416 AhDisplayAmlType (
417 const AH_AML_TYPE *Op)
418 {
419 char *Description;
420
421
422 Description = Op->Description;
423 printf ("%4s", " "); /* Primary indent */
424
425 /* Emit the entire description string */
426
427 while (*Description)
428 {
429 /* Description can be multiple lines, must indent each */
430
431 while (*Description != '\n')
432 {
433 printf ("%c", *Description);
434 Description++;
435 }
436
437 printf ("\n");
438 Description++;
439
440 /* Do indent */
441
442 if (*Description)
443 {
444 printf ("%8s", " "); /* Secondary indent */
445
446 /* Index extra for a comment */
447
448 if ((Description[0] == '/') &&
449 (Description[1] == '/'))
450 {
451 printf ("%4s", " ");
452 }
453 }
454 }
455
456 printf ("\n");
457 }
458
