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