1 /******************************************************************************
2 *
3 * Module Name: ahasl - ASL operator 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 AhDisplayAslOperator (
159 const AH_ASL_OPERATOR *Op);
160
161 static void
162 AhDisplayOperatorKeywords (
163 const AH_ASL_OPERATOR *Op);
164
165 static void
166 AhDisplayAslKeyword (
167 const AH_ASL_KEYWORD *Op);
168
169
170 /*******************************************************************************
171 *
172 * FUNCTION: AhFindAslKeywords (entry point for ASL keyword search)
173 *
174 * PARAMETERS: Name - Name or prefix for an ASL keyword.
175 * NULL means "find all"
176 *
177 * RETURN: None
178 *
179 * DESCRIPTION: Find all ASL keywords that match the input Name or name
180 * prefix.
181 *
182 ******************************************************************************/
183
184 void
AhFindAslKeywords(char * Name)185 AhFindAslKeywords (
186 char *Name)
187 {
188 const AH_ASL_KEYWORD *Keyword;
189 BOOLEAN Found = FALSE;
190
191
192 AcpiUtStrupr (Name);
193
194 for (Keyword = Gbl_AslKeywordInfo; Keyword->Name; Keyword++)
195 {
196 if (!Name || (Name[0] == '*'))
197 {
198 AhDisplayAslKeyword (Keyword);
199 Found = TRUE;
200 continue;
201 }
202
203 /* Upper case the operator name before substring compare */
204
205 strcpy (Gbl_Buffer, Keyword->Name);
206 AcpiUtStrupr (Gbl_Buffer);
207
208 if (strstr (Gbl_Buffer, Name) == Gbl_Buffer)
209 {
210 AhDisplayAslKeyword (Keyword);
211 Found = TRUE;
212 }
213 }
214
215 if (!Found)
216 {
217 printf ("%s, no matching ASL keywords\n", Name);
218 }
219 }
220
221
222 /*******************************************************************************
223 *
224 * FUNCTION: AhDisplayAslKeyword
225 *
226 * PARAMETERS: Op - Pointer to ASL keyword with syntax info
227 *
228 * RETURN: None
229 *
230 * DESCRIPTION: Format and display syntax info for an ASL keyword. Splits
231 * long lines appropriately for reading.
232 *
233 ******************************************************************************/
234
235 static void
AhDisplayAslKeyword(const AH_ASL_KEYWORD * Op)236 AhDisplayAslKeyword (
237 const AH_ASL_KEYWORD *Op)
238 {
239
240 /* ASL keyword name and description */
241
242 printf ("%22s: %s\n", Op->Name, Op->Description);
243 if (!Op->KeywordList)
244 {
245 return;
246 }
247
248 /* List of actual keywords */
249
250 AhPrintOneField (24, 0, AH_MAX_ASL_LINE_LENGTH, Op->KeywordList);
251 printf ("\n");
252 }
253
254
255 /*******************************************************************************
256 *
257 * FUNCTION: AhFindAslAndAmlOperators
258 *
259 * PARAMETERS: Name - Name or prefix for an ASL operator.
260 * NULL means "find all"
261 *
262 * RETURN: None
263 *
264 * DESCRIPTION: Find all ASL operators that match the input Name or name
265 * prefix. Also displays the AML information if only one entry
266 * matches.
267 *
268 ******************************************************************************/
269
270 void
AhFindAslAndAmlOperators(char * Name)271 AhFindAslAndAmlOperators (
272 char *Name)
273 {
274 UINT32 MatchCount;
275
276
277 MatchCount = AhFindAslOperators (Name);
278 if (MatchCount == 1)
279 {
280 AhFindAmlOpcode (Name);
281 }
282 }
283
284
285 /*******************************************************************************
286 *
287 * FUNCTION: AhFindAslOperators (entry point for ASL operator search)
288 *
289 * PARAMETERS: Name - Name or prefix for an ASL operator.
290 * NULL means "find all"
291 *
292 * RETURN: Number of operators that matched the name prefix.
293 *
294 * DESCRIPTION: Find all ASL operators that match the input Name or name
295 * prefix.
296 *
297 ******************************************************************************/
298
299 UINT32
AhFindAslOperators(char * Name)300 AhFindAslOperators (
301 char *Name)
302 {
303 const AH_ASL_OPERATOR *Operator;
304 BOOLEAN MatchCount = 0;
305
306
307 AcpiUtStrupr (Name);
308
309 /* Find/display all names that match the input name prefix */
310
311 for (Operator = Gbl_AslOperatorInfo; Operator->Name; Operator++)
312 {
313 if (!Name || (Name[0] == '*'))
314 {
315 AhDisplayAslOperator (Operator);
316 MatchCount++;
317 continue;
318 }
319
320 /* Upper case the operator name before substring compare */
321
322 strcpy (Gbl_Buffer, Operator->Name);
323 AcpiUtStrupr (Gbl_Buffer);
324
325 if (strstr (Gbl_Buffer, Name) == Gbl_Buffer)
326 {
327 AhDisplayAslOperator (Operator);
328 MatchCount++;
329 }
330 }
331
332 if (!MatchCount)
333 {
334 printf ("%s, no matching ASL operators\n", Name);
335 }
336
337 return (MatchCount);
338 }
339
340
341 /*******************************************************************************
342 *
343 * FUNCTION: AhDisplayAslOperator
344 *
345 * PARAMETERS: Op - Pointer to ASL operator with syntax info
346 *
347 * RETURN: None
348 *
349 * DESCRIPTION: Format and display syntax info for an ASL operator. Splits
350 * long lines appropriately for reading.
351 *
352 ******************************************************************************/
353
354 static void
AhDisplayAslOperator(const AH_ASL_OPERATOR * Op)355 AhDisplayAslOperator (
356 const AH_ASL_OPERATOR *Op)
357 {
358
359 /* ASL operator name and description */
360
361 printf ("%16s: %s\n", Op->Name, Op->Description);
362 if (!Op->Syntax)
363 {
364 return;
365 }
366
367 /* Syntax for the operator */
368
369 AhPrintOneField (18, 0, AH_MAX_ASL_LINE_LENGTH, Op->Syntax);
370 printf ("\n");
371
372 AhDisplayOperatorKeywords (Op);
373 printf ("\n");
374 }
375
376
377 /*******************************************************************************
378 *
379 * FUNCTION: AhDisplayOperatorKeywords
380 *
381 * PARAMETERS: Op - Pointer to ASL keyword with syntax info
382 *
383 * RETURN: None
384 *
385 * DESCRIPTION: Display any/all keywords that are associated with the ASL
386 * operator.
387 *
388 ******************************************************************************/
389
390 static void
AhDisplayOperatorKeywords(const AH_ASL_OPERATOR * Op)391 AhDisplayOperatorKeywords (
392 const AH_ASL_OPERATOR *Op)
393 {
394 char *Token;
395 char *Separators = "(){}, ";
396 BOOLEAN FirstKeyword = TRUE;
397
398
399 if (!Op || !Op->Syntax)
400 {
401 return;
402 }
403
404 /*
405 * Find all parameters that have the word "keyword" within, and then
406 * display the info about that keyword
407 */
408 strcpy (Gbl_LineBuffer, Op->Syntax);
409 Token = strtok (Gbl_LineBuffer, Separators);
410 while (Token)
411 {
412 if (strstr (Token, "Keyword"))
413 {
414 if (FirstKeyword)
415 {
416 printf ("\n");
417 FirstKeyword = FALSE;
418 }
419
420 /* Found a keyword, display keyword information */
421
422 AhFindAslKeywords (Token);
423 }
424
425 Token = strtok (NULL, Separators);
426 }
427 }
428
