1 /******************************************************************************
3 * Module Name: utpredef - support functions for predefined names
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2018, 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 <contrib/dev/acpica/include/acpi.h>
153 #include <contrib/dev/acpica/include/accommon.h>
154 #include <contrib/dev/acpica/include/acpredef.h>
157 #define _COMPONENT ACPI_UTILITIES
158 ACPI_MODULE_NAME ("utpredef")
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
165 static const char *UtRtypeNames[] =
175 /*******************************************************************************
177 * FUNCTION: AcpiUtGetNextPredefinedMethod
179 * PARAMETERS: ThisName - Entry in the predefined method/name table
181 * RETURN: Pointer to next entry in predefined table.
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
187 ******************************************************************************/
189 const ACPI_PREDEFINED_INFO *
190 AcpiUtGetNextPredefinedMethod (
191 const ACPI_PREDEFINED_INFO *ThisName)
195 * Skip next entry in the table if this name returns a Package
196 * (next entry contains the package info)
198 if ((ThisName->Info.ExpectedBtypes & ACPI_RTYPE_PACKAGE) &&
199 (ThisName->Info.ExpectedBtypes != ACPI_RTYPE_ALL))
209 /*******************************************************************************
211 * FUNCTION: AcpiUtMatchPredefinedMethod
213 * PARAMETERS: Name - Name to find
215 * RETURN: Pointer to entry in predefined table. NULL indicates not found.
217 * DESCRIPTION: Check an object name against the predefined object list.
219 ******************************************************************************/
221 const ACPI_PREDEFINED_INFO *
222 AcpiUtMatchPredefinedMethod (
225 const ACPI_PREDEFINED_INFO *ThisName;
228 /* Quick check for a predefined name, first character must be underscore */
235 /* Search info table for a predefined method/object name */
237 ThisName = AcpiGbl_PredefinedMethods;
238 while (ThisName->Info.Name[0])
240 if (ACPI_COMPARE_NAME (Name, ThisName->Info.Name))
245 ThisName = AcpiUtGetNextPredefinedMethod (ThisName);
248 return (NULL); /* Not found */
252 /*******************************************************************************
254 * FUNCTION: AcpiUtGetExpectedReturnTypes
256 * PARAMETERS: Buffer - Where the formatted string is returned
257 * ExpectedBTypes - Bitfield of expected data types
259 * RETURN: Formatted string in Buffer.
261 * DESCRIPTION: Format the expected object types into a printable string.
263 ******************************************************************************/
266 AcpiUtGetExpectedReturnTypes (
268 UINT32 ExpectedBtypes)
277 strcpy (Buffer, "NONE");
283 ThisRtype = ACPI_RTYPE_INTEGER;
285 for (i = 0; i < ACPI_NUM_RTYPES; i++)
287 /* If one of the expected types, concatenate the name of this type */
289 if (ExpectedBtypes & ThisRtype)
291 strcat (Buffer, &UtRtypeNames[i][j]);
292 j = 0; /* Use name separator from now on */
295 ThisRtype <<= 1; /* Next Rtype */
300 /*******************************************************************************
302 * The remaining functions are used by iASL and AcpiHelp only
304 ******************************************************************************/
306 #if (defined ACPI_ASL_COMPILER || defined ACPI_HELP_APP)
308 /* Local prototypes */
311 AcpiUtGetArgumentTypes (
313 UINT16 ArgumentTypes);
316 /* Types that can be returned externally by a predefined name */
318 static const char *UtExternalTypeNames[] = /* Indexed by ACPI_TYPE_* */
320 ", UNSUPPORTED-TYPE",
327 /* Bit widths for resource descriptor predefined names */
329 static const char *UtResourceTypeNames[] =
342 /*******************************************************************************
344 * FUNCTION: AcpiUtMatchResourceName
346 * PARAMETERS: Name - Name to find
348 * RETURN: Pointer to entry in the resource table. NULL indicates not
351 * DESCRIPTION: Check an object name against the predefined resource
352 * descriptor object list.
354 ******************************************************************************/
356 const ACPI_PREDEFINED_INFO *
357 AcpiUtMatchResourceName (
360 const ACPI_PREDEFINED_INFO *ThisName;
364 * Quick check for a predefined name, first character must
372 /* Search info table for a predefined method/object name */
374 ThisName = AcpiGbl_ResourceNames;
375 while (ThisName->Info.Name[0])
377 if (ACPI_COMPARE_NAME (Name, ThisName->Info.Name))
385 return (NULL); /* Not found */
389 /*******************************************************************************
391 * FUNCTION: AcpiUtDisplayPredefinedMethod
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
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.
403 ******************************************************************************/
406 AcpiUtDisplayPredefinedMethod (
408 const ACPI_PREDEFINED_INFO *ThisName,
414 * Get the argument count and the string buffer
415 * containing all argument types
417 ArgCount = AcpiUtGetArgumentTypes (Buffer,
418 ThisName->Info.ArgumentList);
425 printf ("%4.4s Requires %s%u argument%s",
427 (ThisName->Info.ArgumentList & ARG_COUNT_IS_MINIMUM) ?
429 ArgCount, ArgCount != 1 ? "s" : "");
431 /* Display the types for any arguments */
435 printf (" (%s)", Buffer);
443 /* Get the return value type(s) allowed */
445 if (ThisName->Info.ExpectedBtypes)
447 AcpiUtGetExpectedReturnTypes (Buffer, ThisName->Info.ExpectedBtypes);
448 printf (" Return value types: %s\n", Buffer);
452 printf (" No return value\n");
457 /*******************************************************************************
459 * FUNCTION: AcpiUtGetArgumentTypes
461 * PARAMETERS: Buffer - Where to return the formatted types
462 * ArgumentTypes - Types field for this method
464 * RETURN: Count - the number of arguments required for this method
466 * DESCRIPTION: Format the required data types for this method (Integer,
467 * String, Buffer, or Package) and return the required argument
470 ******************************************************************************/
473 AcpiUtGetArgumentTypes (
475 UINT16 ArgumentTypes)
477 UINT16 ThisArgumentType;
486 /* First field in the types list is the count of args to follow */
488 ArgCount = METHOD_GET_ARG_COUNT (ArgumentTypes);
489 if (ArgCount > METHOD_PREDEF_ARGS_MAX)
491 printf ("**** Invalid argument count (%u) "
492 "in predefined info structure\n", ArgCount);
496 /* Get each argument from the list, convert to ascii, store to buffer */
498 for (i = 0; i < ArgCount; i++)
500 ThisArgumentType = METHOD_GET_NEXT_TYPE (ArgumentTypes);
502 if (!ThisArgumentType || (ThisArgumentType > METHOD_MAX_ARG_TYPE))
504 printf ("**** Invalid argument type (%u) "
505 "in predefined info structure\n", ThisArgumentType);
509 strcat (Buffer, UtExternalTypeNames[ThisArgumentType] + SubIndex);
517 /*******************************************************************************
519 * FUNCTION: AcpiUtGetResourceBitWidth
521 * PARAMETERS: Buffer - Where the formatted string is returned
522 * Types - Bitfield of expected data types
524 * RETURN: Count of return types. Formatted string in Buffer.
526 * DESCRIPTION: Format the resource bit widths into a printable string.
528 ******************************************************************************/
531 AcpiUtGetResourceBitWidth (
544 for (i = 0; i < NUM_RESOURCE_WIDTHS; i++)
548 strcat (Buffer, &(UtResourceTypeNames[i][SubIndex]));