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