1 /******************************************************************************
3 * Module Name: utpredef - support functions for predefined names
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2015, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 #include <contrib/dev/acpica/include/acpi.h>
45 #include <contrib/dev/acpica/include/accommon.h>
46 #include <contrib/dev/acpica/include/acpredef.h>
49 #define _COMPONENT ACPI_UTILITIES
50 ACPI_MODULE_NAME ("utpredef")
54 * Names for the types that can be returned by the predefined objects.
55 * Used for warning messages. Must be in the same order as the ACPI_RTYPEs
57 static const char *UtRtypeNames[] =
67 /*******************************************************************************
69 * FUNCTION: AcpiUtGetNextPredefinedMethod
71 * PARAMETERS: ThisName - Entry in the predefined method/name table
73 * RETURN: Pointer to next entry in predefined table.
75 * DESCRIPTION: Get the next entry in the predefine method table. Handles the
76 * cases where a package info entry follows a method name that
79 ******************************************************************************/
81 const ACPI_PREDEFINED_INFO *
82 AcpiUtGetNextPredefinedMethod (
83 const ACPI_PREDEFINED_INFO *ThisName)
87 * Skip next entry in the table if this name returns a Package
88 * (next entry contains the package info)
90 if ((ThisName->Info.ExpectedBtypes & ACPI_RTYPE_PACKAGE) &&
91 (ThisName->Info.ExpectedBtypes != ACPI_RTYPE_ALL))
101 /*******************************************************************************
103 * FUNCTION: AcpiUtMatchPredefinedMethod
105 * PARAMETERS: Name - Name to find
107 * RETURN: Pointer to entry in predefined table. NULL indicates not found.
109 * DESCRIPTION: Check an object name against the predefined object list.
111 ******************************************************************************/
113 const ACPI_PREDEFINED_INFO *
114 AcpiUtMatchPredefinedMethod (
117 const ACPI_PREDEFINED_INFO *ThisName;
120 /* Quick check for a predefined name, first character must be underscore */
127 /* Search info table for a predefined method/object name */
129 ThisName = AcpiGbl_PredefinedMethods;
130 while (ThisName->Info.Name[0])
132 if (ACPI_COMPARE_NAME (Name, ThisName->Info.Name))
137 ThisName = AcpiUtGetNextPredefinedMethod (ThisName);
140 return (NULL); /* Not found */
144 /*******************************************************************************
146 * FUNCTION: AcpiUtGetExpectedReturnTypes
148 * PARAMETERS: Buffer - Where the formatted string is returned
149 * ExpectedBTypes - Bitfield of expected data types
151 * RETURN: Formatted string in Buffer.
153 * DESCRIPTION: Format the expected object types into a printable string.
155 ******************************************************************************/
158 AcpiUtGetExpectedReturnTypes (
160 UINT32 ExpectedBtypes)
169 ACPI_STRCPY (Buffer, "NONE");
175 ThisRtype = ACPI_RTYPE_INTEGER;
177 for (i = 0; i < ACPI_NUM_RTYPES; i++)
179 /* If one of the expected types, concatenate the name of this type */
181 if (ExpectedBtypes & ThisRtype)
183 ACPI_STRCAT (Buffer, &UtRtypeNames[i][j]);
184 j = 0; /* Use name separator from now on */
187 ThisRtype <<= 1; /* Next Rtype */
192 /*******************************************************************************
194 * The remaining functions are used by iASL and AcpiHelp only
196 ******************************************************************************/
198 #if (defined ACPI_ASL_COMPILER || defined ACPI_HELP_APP)
202 /* Local prototypes */
205 AcpiUtGetArgumentTypes (
207 UINT16 ArgumentTypes);
210 /* Types that can be returned externally by a predefined name */
212 static const char *UtExternalTypeNames[] = /* Indexed by ACPI_TYPE_* */
214 ", UNSUPPORTED-TYPE",
221 /* Bit widths for resource descriptor predefined names */
223 static const char *UtResourceTypeNames[] =
236 /*******************************************************************************
238 * FUNCTION: AcpiUtMatchResourceName
240 * PARAMETERS: Name - Name to find
242 * RETURN: Pointer to entry in the resource table. NULL indicates not
245 * DESCRIPTION: Check an object name against the predefined resource
246 * descriptor object list.
248 ******************************************************************************/
250 const ACPI_PREDEFINED_INFO *
251 AcpiUtMatchResourceName (
254 const ACPI_PREDEFINED_INFO *ThisName;
257 /* Quick check for a predefined name, first character must be underscore */
264 /* Search info table for a predefined method/object name */
266 ThisName = AcpiGbl_ResourceNames;
267 while (ThisName->Info.Name[0])
269 if (ACPI_COMPARE_NAME (Name, ThisName->Info.Name))
277 return (NULL); /* Not found */
281 /*******************************************************************************
283 * FUNCTION: AcpiUtDisplayPredefinedMethod
285 * PARAMETERS: Buffer - Scratch buffer for this function
286 * ThisName - Entry in the predefined method/name table
287 * MultiLine - TRUE if output should be on >1 line
291 * DESCRIPTION: Display information about a predefined method. Number and
292 * type of the input arguments, and expected type(s) for the
293 * return value, if any.
295 ******************************************************************************/
298 AcpiUtDisplayPredefinedMethod (
300 const ACPI_PREDEFINED_INFO *ThisName,
306 * Get the argument count and the string buffer
307 * containing all argument types
309 ArgCount = AcpiUtGetArgumentTypes (Buffer,
310 ThisName->Info.ArgumentList);
317 printf ("%4.4s Requires %s%u argument%s",
319 (ThisName->Info.ArgumentList & ARG_COUNT_IS_MINIMUM) ?
321 ArgCount, ArgCount != 1 ? "s" : "");
323 /* Display the types for any arguments */
327 printf (" (%s)", Buffer);
335 /* Get the return value type(s) allowed */
337 if (ThisName->Info.ExpectedBtypes)
339 AcpiUtGetExpectedReturnTypes (Buffer, ThisName->Info.ExpectedBtypes);
340 printf (" Return value types: %s\n", Buffer);
344 printf (" No return value\n");
349 /*******************************************************************************
351 * FUNCTION: AcpiUtGetArgumentTypes
353 * PARAMETERS: Buffer - Where to return the formatted types
354 * ArgumentTypes - Types field for this method
356 * RETURN: Count - the number of arguments required for this method
358 * DESCRIPTION: Format the required data types for this method (Integer,
359 * String, Buffer, or Package) and return the required argument
362 ******************************************************************************/
365 AcpiUtGetArgumentTypes (
367 UINT16 ArgumentTypes)
369 UINT16 ThisArgumentType;
378 /* First field in the types list is the count of args to follow */
380 ArgCount = METHOD_GET_ARG_COUNT (ArgumentTypes);
381 if (ArgCount > METHOD_PREDEF_ARGS_MAX)
383 printf ("**** Invalid argument count (%u) "
384 "in predefined info structure\n", ArgCount);
388 /* Get each argument from the list, convert to ascii, store to buffer */
390 for (i = 0; i < ArgCount; i++)
392 ThisArgumentType = METHOD_GET_NEXT_TYPE (ArgumentTypes);
394 if (!ThisArgumentType || (ThisArgumentType > METHOD_MAX_ARG_TYPE))
396 printf ("**** Invalid argument type (%u) "
397 "in predefined info structure\n", ThisArgumentType);
401 strcat (Buffer, UtExternalTypeNames[ThisArgumentType] + SubIndex);
409 /*******************************************************************************
411 * FUNCTION: AcpiUtGetResourceBitWidth
413 * PARAMETERS: Buffer - Where the formatted string is returned
414 * Types - Bitfield of expected data types
416 * RETURN: Count of return types. Formatted string in Buffer.
418 * DESCRIPTION: Format the resource bit widths into a printable string.
420 ******************************************************************************/
423 AcpiUtGetResourceBitWidth (
436 for (i = 0; i < NUM_RESOURCE_WIDTHS; i++)
440 strcat (Buffer, &(UtResourceTypeNames[i][SubIndex]));