1 /******************************************************************************
2 *
3 * Module Name: utpredef - support functions for predefined names
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 "acpi.h"
153 #include "accommon.h"
154 #include "acpredef.h"
155
156
157 #define _COMPONENT ACPI_UTILITIES
158 ACPI_MODULE_NAME ("utpredef")
159
160
161 /*
162 * Names for the types that can be returned by the predefined objects.
163 * Used for warning messages. Must be in the same order as the ACPI_RTYPEs
164 */
165 static const char *UtRtypeNames[] =
166 {
167 "/Integer",
168 "/String",
169 "/Buffer",
170 "/Package",
171 "/Reference",
172 };
173
174
175 /*******************************************************************************
176 *
177 * FUNCTION: AcpiUtGetNextPredefinedMethod
178 *
179 * PARAMETERS: ThisName - Entry in the predefined method/name table
180 *
181 * RETURN: Pointer to next entry in predefined table.
182 *
183 * DESCRIPTION: Get the next entry in the predefine method table. Handles the
184 * cases where a package info entry follows a method name that
185 * returns a package.
186 *
187 ******************************************************************************/
188
189 const ACPI_PREDEFINED_INFO *
AcpiUtGetNextPredefinedMethod(const ACPI_PREDEFINED_INFO * ThisName)190 AcpiUtGetNextPredefinedMethod (
191 const ACPI_PREDEFINED_INFO *ThisName)
192 {
193
194 /*
195 * Skip next entry in the table if this name returns a Package
196 * (next entry contains the package info)
197 */
198 if ((ThisName->Info.ExpectedBtypes & ACPI_RTYPE_PACKAGE) &&
199 (ThisName->Info.ExpectedBtypes != ACPI_RTYPE_ALL))
200 {
201 ThisName++;
202 }
203
204 ThisName++;
205 return (ThisName);
206 }
207
208
209 /*******************************************************************************
210 *
211 * FUNCTION: AcpiUtMatchPredefinedMethod
212 *
213 * PARAMETERS: Name - Name to find
214 *
215 * RETURN: Pointer to entry in predefined table. NULL indicates not found.
216 *
217 * DESCRIPTION: Check an object name against the predefined object list.
218 *
219 ******************************************************************************/
220
221 const ACPI_PREDEFINED_INFO *
AcpiUtMatchPredefinedMethod(char * Name)222 AcpiUtMatchPredefinedMethod (
223 char *Name)
224 {
225 const ACPI_PREDEFINED_INFO *ThisName;
226
227
228 /* Quick check for a predefined name, first character must be underscore */
229
230 if (Name[0] != '_')
231 {
232 return (NULL);
233 }
234
235 /* Search info table for a predefined method/object name */
236
237 ThisName = AcpiGbl_PredefinedMethods;
238 while (ThisName->Info.Name[0])
239 {
240 if (ACPI_COMPARE_NAMESEG (Name, ThisName->Info.Name))
241 {
242 return (ThisName);
243 }
244
245 ThisName = AcpiUtGetNextPredefinedMethod (ThisName);
246 }
247
248 return (NULL); /* Not found */
249 }
250
251
252 /*******************************************************************************
253 *
254 * FUNCTION: AcpiUtGetExpectedReturnTypes
255 *
256 * PARAMETERS: Buffer - Where the formatted string is returned
257 * ExpectedBTypes - Bitfield of expected data types
258 *
259 * RETURN: Formatted string in Buffer.
260 *
261 * DESCRIPTION: Format the expected object types into a printable string.
262 *
263 ******************************************************************************/
264
265 void
AcpiUtGetExpectedReturnTypes(char * Buffer,UINT32 ExpectedBtypes)266 AcpiUtGetExpectedReturnTypes (
267 char *Buffer,
268 UINT32 ExpectedBtypes)
269 {
270 UINT32 ThisRtype;
271 UINT32 i;
272 UINT32 j;
273
274
275 if (!ExpectedBtypes)
276 {
277 strcpy (Buffer, "NONE");
278 return;
279 }
280
281 j = 1;
282 Buffer[0] = 0;
283 ThisRtype = ACPI_RTYPE_INTEGER;
284
285 for (i = 0; i < ACPI_NUM_RTYPES; i++)
286 {
287 /* If one of the expected types, concatenate the name of this type */
288
289 if (ExpectedBtypes & ThisRtype)
290 {
291 strcat (Buffer, &UtRtypeNames[i][j]);
292 j = 0; /* Use name separator from now on */
293 }
294
295 ThisRtype <<= 1; /* Next Rtype */
296 }
297 }
298
299
300 /*******************************************************************************
301 *
302 * The remaining functions are used by iASL and AcpiHelp only
303 *
304 ******************************************************************************/
305
306 #if (defined ACPI_ASL_COMPILER || defined ACPI_HELP_APP)
307
308 /* Local prototypes */
309
310 static UINT32
311 AcpiUtGetArgumentTypes (
312 char *Buffer,
313 UINT16 ArgumentTypes);
314
315
316 /* Types that can be returned externally by a predefined name */
317
318 static const char *UtExternalTypeNames[] = /* Indexed by ACPI_TYPE_* */
319 {
320 ", Type_ANY",
321 ", Integer",
322 ", String",
323 ", Buffer",
324 ", Package"
325 };
326
327 /* Bit widths for resource descriptor predefined names */
328
329 static const char *UtResourceTypeNames[] =
330 {
331 "/1",
332 "/2",
333 "/3",
334 "/8",
335 "/16",
336 "/32",
337 "/64",
338 "/variable",
339 };
340
341
342 /*******************************************************************************
343 *
344 * FUNCTION: AcpiUtMatchResourceName
345 *
346 * PARAMETERS: Name - Name to find
347 *
348 * RETURN: Pointer to entry in the resource table. NULL indicates not
349 * found.
350 *
351 * DESCRIPTION: Check an object name against the predefined resource
352 * descriptor object list.
353 *
354 ******************************************************************************/
355
356 const ACPI_PREDEFINED_INFO *
AcpiUtMatchResourceName(char * Name)357 AcpiUtMatchResourceName (
358 char *Name)
359 {
360 const ACPI_PREDEFINED_INFO *ThisName;
361
362
363 /*
364 * Quick check for a predefined name, first character must
365 * be underscore
366 */
367 if (Name[0] != '_')
368 {
369 return (NULL);
370 }
371
372 /* Search info table for a predefined method/object name */
373
374 ThisName = AcpiGbl_ResourceNames;
375 while (ThisName->Info.Name[0])
376 {
377 if (ACPI_COMPARE_NAMESEG (Name, ThisName->Info.Name))
378 {
379 return (ThisName);
380 }
381
382 ThisName++;
383 }
384
385 return (NULL); /* Not found */
386 }
387
388
389 /*******************************************************************************
390 *
391 * FUNCTION: AcpiUtDisplayPredefinedMethod
392 *
393 * PARAMETERS: Buffer - Scratch buffer for this function
394 * ThisName - Entry in the predefined method/name table
395 * MultiLine - TRUE if output should be on >1 line
396 *
397 * RETURN: None
398 *
399 * DESCRIPTION: Display information about a predefined method. Number and
400 * type of the input arguments, and expected type(s) for the
401 * return value, if any.
402 *
403 ******************************************************************************/
404
405 void
AcpiUtDisplayPredefinedMethod(char * Buffer,const ACPI_PREDEFINED_INFO * ThisName,BOOLEAN MultiLine)406 AcpiUtDisplayPredefinedMethod (
407 char *Buffer,
408 const ACPI_PREDEFINED_INFO *ThisName,
409 BOOLEAN MultiLine)
410 {
411 UINT32 ArgCount;
412
413 /*
414 * Get the argument count and the string buffer
415 * containing all argument types
416 */
417 ArgCount = AcpiUtGetArgumentTypes (Buffer,
418 ThisName->Info.ArgumentList);
419
420 if (MultiLine)
421 {
422 printf (" ");
423 }
424
425 printf ("%4.4s Requires %s%u argument%s",
426 ThisName->Info.Name,
427 (ThisName->Info.ArgumentList & ARG_COUNT_IS_MINIMUM) ?
428 "(at least) " : "",
429 ArgCount, ArgCount != 1 ? "s" : "");
430
431 /* Display the types for any arguments */
432
433 if (ArgCount > 0)
434 {
435 printf (" (%s)", Buffer);
436 }
437
438 if (MultiLine)
439 {
440 printf ("\n ");
441 }
442
443 /* Get the return value type(s) allowed */
444
445 if (ThisName->Info.ExpectedBtypes)
446 {
447 AcpiUtGetExpectedReturnTypes (Buffer, ThisName->Info.ExpectedBtypes);
448 printf (" Return value types: %s\n", Buffer);
449 }
450 else
451 {
452 printf (" No return value\n");
453 }
454 }
455
456
457 /*******************************************************************************
458 *
459 * FUNCTION: AcpiUtGetArgumentTypes
460 *
461 * PARAMETERS: Buffer - Where to return the formatted types
462 * ArgumentTypes - Types field for this method
463 *
464 * RETURN: Count - the number of arguments required for this method
465 *
466 * DESCRIPTION: Format the required data types for this method (Integer,
467 * String, Buffer, or Package) and return the required argument
468 * count.
469 *
470 ******************************************************************************/
471
472 static UINT32
AcpiUtGetArgumentTypes(char * Buffer,UINT16 ArgumentTypes)473 AcpiUtGetArgumentTypes (
474 char *Buffer,
475 UINT16 ArgumentTypes)
476 {
477 UINT16 ThisArgumentType;
478 UINT16 SubIndex;
479 UINT16 ArgCount;
480 UINT32 i;
481
482
483 *Buffer = 0;
484 SubIndex = 2;
485
486 /* First field in the types list is the count of args to follow */
487
488 ArgCount = METHOD_GET_ARG_COUNT (ArgumentTypes);
489 if (ArgCount > METHOD_PREDEF_ARGS_MAX)
490 {
491 printf ("**** Invalid argument count (%u) "
492 "in predefined info structure\n", ArgCount);
493 return (ArgCount);
494 }
495
496 /* Get each argument from the list, convert to ascii, store to buffer */
497
498 for (i = 0; i < ArgCount; i++)
499 {
500 ThisArgumentType = METHOD_GET_NEXT_TYPE (ArgumentTypes);
501
502 if (ThisArgumentType > METHOD_MAX_ARG_TYPE)
503 {
504 printf ("**** Invalid argument type (%u) "
505 "in predefined info structure\n", ThisArgumentType);
506 return (ArgCount);
507 }
508
509 strcat (Buffer, UtExternalTypeNames[ThisArgumentType] + SubIndex);
510 SubIndex = 0;
511 }
512
513 return (ArgCount);
514 }
515
516
517 /*******************************************************************************
518 *
519 * FUNCTION: AcpiUtGetResourceBitWidth
520 *
521 * PARAMETERS: Buffer - Where the formatted string is returned
522 * Types - Bitfield of expected data types
523 *
524 * RETURN: Count of return types. Formatted string in Buffer.
525 *
526 * DESCRIPTION: Format the resource bit widths into a printable string.
527 *
528 ******************************************************************************/
529
530 UINT32
AcpiUtGetResourceBitWidth(char * Buffer,UINT16 Types)531 AcpiUtGetResourceBitWidth (
532 char *Buffer,
533 UINT16 Types)
534 {
535 UINT32 i;
536 UINT16 SubIndex;
537 UINT32 Found;
538
539
540 *Buffer = 0;
541 SubIndex = 1;
542 Found = 0;
543
544 for (i = 0; i < NUM_RESOURCE_WIDTHS; i++)
545 {
546 if (Types & 1)
547 {
548 strcat (Buffer, &(UtResourceTypeNames[i][SubIndex]));
549 SubIndex = 0;
550 Found++;
551 }
552
553 Types >>= 1;
554 }
555
556 return (Found);
557 }
558 #endif
559
