1 /******************************************************************************
3 * Module Name: ahaml - AML opcode decoding for acpihelp utility
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2020, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
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.
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.
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.
150 *****************************************************************************/
152 #include "acpihelp.h"
155 /* Local prototypes */
159 const AH_AML_OPCODE *Op);
163 const AH_AML_TYPE *Op);
166 /*******************************************************************************
168 * FUNCTION: AhFindAmlOpcode (entry point for AML opcode name search)
170 * PARAMETERS: Name - Name or prefix for an AML opcode.
171 * NULL means "find all"
175 * DESCRIPTION: Find all AML opcodes that match the input Name or name
178 ******************************************************************************/
184 const AH_AML_OPCODE *Op;
185 BOOLEAN Found = FALSE;
190 /* Find/display all opcode names that match the input name prefix */
192 for (Op = Gbl_AmlOpcodeInfo; Op->OpcodeString; Op++)
194 if (!Op->OpcodeName) /* Unused opcodes */
199 if (!Name || (Name[0] == '*'))
201 AhDisplayAmlOpcode (Op);
206 /* Upper case the opcode name before substring compare */
208 strcpy (Gbl_Buffer, Op->OpcodeName);
209 AcpiUtStrupr (Gbl_Buffer);
211 if (strstr (Gbl_Buffer, Name) == Gbl_Buffer)
213 AhDisplayAmlOpcode (Op);
220 printf ("%s, no matching AML opcodes\n", Name);
225 /*******************************************************************************
227 * FUNCTION: AhDecodeAmlOpcode (entry point for AML opcode search)
229 * PARAMETERS: OpcodeString - String version of AML opcode
233 * DESCRIPTION: Display information about the input AML opcode
235 ******************************************************************************/
241 const AH_AML_OPCODE *Op;
248 AhFindAmlOpcode (NULL);
252 Opcode = strtoul (OpcodeString, NULL, 16);
253 if (Opcode > ACPI_UINT16_MAX)
255 printf ("Invalid opcode (more than 16 bits)\n");
259 /* Only valid opcode extension is 0x5B */
261 Prefix = (Opcode & 0x0000FF00) >> 8;
262 if (Prefix && (Prefix != 0x5B))
264 printf ("Invalid opcode (invalid extension prefix 0x%X)\n",
269 /* Find/Display the opcode. May fall within an opcode range */
271 for (Op = Gbl_AmlOpcodeInfo; Op->OpcodeString; Op++)
273 if ((Opcode >= Op->OpcodeRangeStart) &&
274 (Opcode <= Op->OpcodeRangeEnd))
276 AhDisplayAmlOpcode (Op);
282 /*******************************************************************************
284 * FUNCTION: AhDisplayAmlOpcode
286 * PARAMETERS: Op - An opcode info struct
290 * DESCRIPTION: Display the contents of an AML opcode information struct
292 ******************************************************************************/
296 const AH_AML_OPCODE *Op)
301 printf ("%18s: Opcode=%-9s\n", "Reserved opcode", Op->OpcodeString);
305 /* Opcode name and value(s) */
307 printf ("%18s: Opcode=%-9s Type (%s)",
308 Op->OpcodeName, Op->OpcodeString, Op->Type);
310 /* Optional fixed/static arguments */
312 if (Op->FixedArguments)
314 printf (" FixedArgs (");
315 AhPrintOneField (37, 36 + 7 + strlen (Op->Type) + 12,
316 AH_MAX_AML_LINE_LENGTH, Op->FixedArguments);
320 /* Optional variable-length argument list */
322 if (Op->VariableArguments)
324 if (Op->FixedArguments)
326 printf ("\n%*s", 36, " ");
328 printf (" VariableArgs (");
329 AhPrintOneField (37, 15, AH_MAX_AML_LINE_LENGTH, Op->VariableArguments);
334 /* Grammar specification */
338 AhPrintOneField (37, 0, AH_MAX_AML_LINE_LENGTH, Op->Grammar);
344 /*******************************************************************************
346 * FUNCTION: AhFindAmlTypes (entry point for AML grammar keyword search)
348 * PARAMETERS: Name - Name or prefix for an AML grammar element.
349 * NULL means "find all"
353 * DESCRIPTION: Find all AML grammar keywords that match the input Name or name
356 ******************************************************************************/
362 const AH_AML_TYPE *Keyword;
363 BOOLEAN Found = FALSE;
368 for (Keyword = Gbl_AmlTypesInfo; Keyword->Name; Keyword++)
372 printf (" %s\n", Keyword->Name);
379 AhDisplayAmlType (Keyword);
384 /* Upper case the operator name before substring compare */
386 strcpy (Gbl_Buffer, Keyword->Name);
387 AcpiUtStrupr (Gbl_Buffer);
389 if (strstr (Gbl_Buffer, Name) == Gbl_Buffer)
391 AhDisplayAmlType (Keyword);
398 printf ("%s, no matching AML grammar type\n", Name);
403 /*******************************************************************************
405 * FUNCTION: AhDisplayAmlType
407 * PARAMETERS: Op - Pointer to AML grammar info
411 * DESCRIPTION: Format and display info for an AML grammar element.
413 ******************************************************************************/
417 const AH_AML_TYPE *Op)
422 Description = Op->Description;
423 printf ("%4s", " "); /* Primary indent */
425 /* Emit the entire description string */
429 /* Description can be multiple lines, must indent each */
431 while (*Description != '\n')
433 printf ("%c", *Description);
444 printf ("%8s", " "); /* Secondary indent */
446 /* Index extra for a comment */
448 if ((Description[0] == '/') &&
449 (Description[1] == '/'))