1 /****************************************************************************** 2 * 3 * Module Name: nspredef - Validation of ACPI predefined methods and objects 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2009, 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 ACPI_CREATE_PREDEFINED_TABLE 117 118 #include "acpi.h" 119 #include "accommon.h" 120 #include "acnamesp.h" 121 #include "acpredef.h" 122 123 124 #define _COMPONENT ACPI_NAMESPACE 125 ACPI_MODULE_NAME ("nspredef") 126 127 128 /******************************************************************************* 129 * 130 * This module validates predefined ACPI objects that appear in the namespace, 131 * at the time they are evaluated (via AcpiEvaluateObject). The purpose of this 132 * validation is to detect problems with BIOS-exposed predefined ACPI objects 133 * before the results are returned to the ACPI-related drivers. 134 * 135 * There are several areas that are validated: 136 * 137 * 1) The number of input arguments as defined by the method/object in the 138 * ASL is validated against the ACPI specification. 139 * 2) The type of the return object (if any) is validated against the ACPI 140 * specification. 141 * 3) For returned package objects, the count of package elements is 142 * validated, as well as the type of each package element. Nested 143 * packages are supported. 144 * 145 * For any problems found, a warning message is issued. 146 * 147 ******************************************************************************/ 148 149 150 /* Local prototypes */ 151 152 static ACPI_STATUS 153 AcpiNsCheckPackage ( 154 ACPI_PREDEFINED_DATA *Data, 155 ACPI_OPERAND_OBJECT **ReturnObjectPtr); 156 157 static ACPI_STATUS 158 AcpiNsCheckPackageList ( 159 ACPI_PREDEFINED_DATA *Data, 160 const ACPI_PREDEFINED_INFO *Package, 161 ACPI_OPERAND_OBJECT **Elements, 162 UINT32 Count); 163 164 static ACPI_STATUS 165 AcpiNsCheckPackageElements ( 166 ACPI_PREDEFINED_DATA *Data, 167 ACPI_OPERAND_OBJECT **Elements, 168 UINT8 Type1, 169 UINT32 Count1, 170 UINT8 Type2, 171 UINT32 Count2, 172 UINT32 StartIndex); 173 174 static ACPI_STATUS 175 AcpiNsCheckObjectType ( 176 ACPI_PREDEFINED_DATA *Data, 177 ACPI_OPERAND_OBJECT **ReturnObjectPtr, 178 UINT32 ExpectedBtypes, 179 UINT32 PackageIndex); 180 181 static ACPI_STATUS 182 AcpiNsCheckReference ( 183 ACPI_PREDEFINED_DATA *Data, 184 ACPI_OPERAND_OBJECT *ReturnObject); 185 186 static void 187 AcpiNsGetExpectedTypes ( 188 char *Buffer, 189 UINT32 ExpectedBtypes); 190 191 /* 192 * Names for the types that can be returned by the predefined objects. 193 * Used for warning messages. Must be in the same order as the ACPI_RTYPEs 194 */ 195 static const char *AcpiRtypeNames[] = 196 { 197 "/Integer", 198 "/String", 199 "/Buffer", 200 "/Package", 201 "/Reference", 202 }; 203 204 205 /******************************************************************************* 206 * 207 * FUNCTION: AcpiNsCheckPredefinedNames 208 * 209 * PARAMETERS: Node - Namespace node for the method/object 210 * UserParamCount - Number of parameters actually passed 211 * ReturnStatus - Status from the object evaluation 212 * ReturnObjectPtr - Pointer to the object returned from the 213 * evaluation of a method or object 214 * 215 * RETURN: Status 216 * 217 * DESCRIPTION: Check an ACPI name for a match in the predefined name list. 218 * 219 ******************************************************************************/ 220 221 ACPI_STATUS 222 AcpiNsCheckPredefinedNames ( 223 ACPI_NAMESPACE_NODE *Node, 224 UINT32 UserParamCount, 225 ACPI_STATUS ReturnStatus, 226 ACPI_OPERAND_OBJECT **ReturnObjectPtr) 227 { 228 ACPI_OPERAND_OBJECT *ReturnObject = *ReturnObjectPtr; 229 ACPI_STATUS Status = AE_OK; 230 const ACPI_PREDEFINED_INFO *Predefined; 231 char *Pathname; 232 ACPI_PREDEFINED_DATA *Data; 233 234 235 /* Match the name for this method/object against the predefined list */ 236 237 Predefined = AcpiNsCheckForPredefinedName (Node); 238 239 /* Get the full pathname to the object, for use in warning messages */ 240 241 Pathname = AcpiNsGetExternalPathname (Node); 242 if (!Pathname) 243 { 244 return (AE_OK); /* Could not get pathname, ignore */ 245 } 246 247 /* 248 * Check that the parameter count for this method matches the ASL 249 * definition. For predefined names, ensure that both the caller and 250 * the method itself are in accordance with the ACPI specification. 251 */ 252 AcpiNsCheckParameterCount (Pathname, Node, UserParamCount, Predefined); 253 254 /* If not a predefined name, we cannot validate the return object */ 255 256 if (!Predefined) 257 { 258 goto Cleanup; 259 } 260 261 /* 262 * If the method failed or did not actually return an object, we cannot 263 * validate the return object 264 */ 265 if ((ReturnStatus != AE_OK) && (ReturnStatus != AE_CTRL_RETURN_VALUE)) 266 { 267 goto Cleanup; 268 } 269 270 /* 271 * If there is no return value, check if we require a return value for 272 * this predefined name. Either one return value is expected, or none, 273 * for both methods and other objects. 274 * 275 * Exit now if there is no return object. Warning if one was expected. 276 */ 277 if (!ReturnObject) 278 { 279 if ((Predefined->Info.ExpectedBtypes) && 280 (!(Predefined->Info.ExpectedBtypes & ACPI_RTYPE_NONE))) 281 { 282 ACPI_WARN_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS, 283 "Missing expected return value")); 284 285 Status = AE_AML_NO_RETURN_VALUE; 286 } 287 goto Cleanup; 288 } 289 290 /* 291 * 1) We have a return value, but if one wasn't expected, just exit, this is 292 * not a problem. For example, if the "Implicit Return" feature is 293 * enabled, methods will always return a value. 294 * 295 * 2) If the return value can be of any type, then we cannot perform any 296 * validation, exit. 297 */ 298 if ((!Predefined->Info.ExpectedBtypes) || 299 (Predefined->Info.ExpectedBtypes == ACPI_RTYPE_ALL)) 300 { 301 goto Cleanup; 302 } 303 304 /* Create the parameter data block for object validation */ 305 306 Data = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_PREDEFINED_DATA)); 307 if (!Data) 308 { 309 goto Cleanup; 310 } 311 Data->Predefined = Predefined; 312 Data->NodeFlags = Node->Flags; 313 Data->Pathname = Pathname; 314 315 /* 316 * Check that the type of the return object is what is expected for 317 * this predefined name 318 */ 319 Status = AcpiNsCheckObjectType (Data, ReturnObjectPtr, 320 Predefined->Info.ExpectedBtypes, ACPI_NOT_PACKAGE_ELEMENT); 321 if (ACPI_FAILURE (Status)) 322 { 323 goto CheckValidationStatus; 324 } 325 326 /* For returned Package objects, check the type of all sub-objects */ 327 328 if (ReturnObject->Common.Type == ACPI_TYPE_PACKAGE) 329 { 330 Status = AcpiNsCheckPackage (Data, ReturnObjectPtr); 331 } 332 333 /* 334 * Perform additional, more complicated repairs on a per-name 335 * basis. 336 */ 337 Status = AcpiNsComplexRepairs (Data, Node, Status, ReturnObjectPtr); 338 339 340 CheckValidationStatus: 341 /* 342 * If the object validation failed or if we successfully repaired one 343 * or more objects, mark the parent node to suppress further warning 344 * messages during the next evaluation of the same method/object. 345 */ 346 if (ACPI_FAILURE (Status) || (Data->Flags & ACPI_OBJECT_REPAIRED)) 347 { 348 Node->Flags |= ANOBJ_EVALUATED; 349 } 350 ACPI_FREE (Data); 351 352 353 Cleanup: 354 ACPI_FREE (Pathname); 355 return (Status); 356 } 357 358 359 /******************************************************************************* 360 * 361 * FUNCTION: AcpiNsCheckParameterCount 362 * 363 * PARAMETERS: Pathname - Full pathname to the node (for error msgs) 364 * Node - Namespace node for the method/object 365 * UserParamCount - Number of args passed in by the caller 366 * Predefined - Pointer to entry in predefined name table 367 * 368 * RETURN: None 369 * 370 * DESCRIPTION: Check that the declared (in ASL/AML) parameter count for a 371 * predefined name is what is expected (i.e., what is defined in 372 * the ACPI specification for this predefined name.) 373 * 374 ******************************************************************************/ 375 376 void 377 AcpiNsCheckParameterCount ( 378 char *Pathname, 379 ACPI_NAMESPACE_NODE *Node, 380 UINT32 UserParamCount, 381 const ACPI_PREDEFINED_INFO *Predefined) 382 { 383 UINT32 ParamCount; 384 UINT32 RequiredParamsCurrent; 385 UINT32 RequiredParamsOld; 386 387 388 /* Methods have 0-7 parameters. All other types have zero. */ 389 390 ParamCount = 0; 391 if (Node->Type == ACPI_TYPE_METHOD) 392 { 393 ParamCount = Node->Object->Method.ParamCount; 394 } 395 396 if (!Predefined) 397 { 398 /* 399 * Check the parameter count for non-predefined methods/objects. 400 * 401 * Warning if too few or too many arguments have been passed by the 402 * caller. An incorrect number of arguments may not cause the method 403 * to fail. However, the method will fail if there are too few 404 * arguments and the method attempts to use one of the missing ones. 405 */ 406 if (UserParamCount < ParamCount) 407 { 408 ACPI_WARN_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS, 409 "Insufficient arguments - needs %u, found %u", 410 ParamCount, UserParamCount)); 411 } 412 else if (UserParamCount > ParamCount) 413 { 414 ACPI_WARN_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS, 415 "Excess arguments - needs %u, found %u", 416 ParamCount, UserParamCount)); 417 } 418 return; 419 } 420 421 /* 422 * Validate the user-supplied parameter count. 423 * Allow two different legal argument counts (_SCP, etc.) 424 */ 425 RequiredParamsCurrent = Predefined->Info.ParamCount & 0x0F; 426 RequiredParamsOld = Predefined->Info.ParamCount >> 4; 427 428 if (UserParamCount != ACPI_UINT32_MAX) 429 { 430 if ((UserParamCount != RequiredParamsCurrent) && 431 (UserParamCount != RequiredParamsOld)) 432 { 433 ACPI_WARN_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS, 434 "Parameter count mismatch - " 435 "caller passed %u, ACPI requires %u", 436 UserParamCount, RequiredParamsCurrent)); 437 } 438 } 439 440 /* 441 * Check that the ASL-defined parameter count is what is expected for 442 * this predefined name (parameter count as defined by the ACPI 443 * specification) 444 */ 445 if ((ParamCount != RequiredParamsCurrent) && 446 (ParamCount != RequiredParamsOld)) 447 { 448 ACPI_WARN_PREDEFINED ((AE_INFO, Pathname, Node->Flags, 449 "Parameter count mismatch - ASL declared %u, ACPI requires %u", 450 ParamCount, RequiredParamsCurrent)); 451 } 452 } 453 454 455 /******************************************************************************* 456 * 457 * FUNCTION: AcpiNsCheckForPredefinedName 458 * 459 * PARAMETERS: Node - Namespace node for the method/object 460 * 461 * RETURN: Pointer to entry in predefined table. NULL indicates not found. 462 * 463 * DESCRIPTION: Check an object name against the predefined object list. 464 * 465 ******************************************************************************/ 466 467 const ACPI_PREDEFINED_INFO * 468 AcpiNsCheckForPredefinedName ( 469 ACPI_NAMESPACE_NODE *Node) 470 { 471 const ACPI_PREDEFINED_INFO *ThisName; 472 473 474 /* Quick check for a predefined name, first character must be underscore */ 475 476 if (Node->Name.Ascii[0] != '_') 477 { 478 return (NULL); 479 } 480 481 /* Search info table for a predefined method/object name */ 482 483 ThisName = PredefinedNames; 484 while (ThisName->Info.Name[0]) 485 { 486 if (ACPI_COMPARE_NAME (Node->Name.Ascii, ThisName->Info.Name)) 487 { 488 return (ThisName); 489 } 490 491 /* 492 * Skip next entry in the table if this name returns a Package 493 * (next entry contains the package info) 494 */ 495 if (ThisName->Info.ExpectedBtypes & ACPI_RTYPE_PACKAGE) 496 { 497 ThisName++; 498 } 499 500 ThisName++; 501 } 502 503 return (NULL); /* Not found */ 504 } 505 506 507 /******************************************************************************* 508 * 509 * FUNCTION: AcpiNsCheckPackage 510 * 511 * PARAMETERS: Data - Pointer to validation data structure 512 * ReturnObjectPtr - Pointer to the object returned from the 513 * evaluation of a method or object 514 * 515 * RETURN: Status 516 * 517 * DESCRIPTION: Check a returned package object for the correct count and 518 * correct type of all sub-objects. 519 * 520 ******************************************************************************/ 521 522 static ACPI_STATUS 523 AcpiNsCheckPackage ( 524 ACPI_PREDEFINED_DATA *Data, 525 ACPI_OPERAND_OBJECT **ReturnObjectPtr) 526 { 527 ACPI_OPERAND_OBJECT *ReturnObject = *ReturnObjectPtr; 528 const ACPI_PREDEFINED_INFO *Package; 529 ACPI_OPERAND_OBJECT **Elements; 530 ACPI_STATUS Status = AE_OK; 531 UINT32 ExpectedCount; 532 UINT32 Count; 533 UINT32 i; 534 535 536 ACPI_FUNCTION_NAME (NsCheckPackage); 537 538 539 /* The package info for this name is in the next table entry */ 540 541 Package = Data->Predefined + 1; 542 543 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, 544 "%s Validating return Package of Type %X, Count %X\n", 545 Data->Pathname, Package->RetInfo.Type, ReturnObject->Package.Count)); 546 547 /* Extract package count and elements array */ 548 549 Elements = ReturnObject->Package.Elements; 550 Count = ReturnObject->Package.Count; 551 552 /* The package must have at least one element, else invalid */ 553 554 if (!Count) 555 { 556 ACPI_WARN_PREDEFINED ((AE_INFO, Data->Pathname, Data->NodeFlags, 557 "Return Package has no elements (empty)")); 558 559 return (AE_AML_OPERAND_VALUE); 560 } 561 562 /* 563 * Decode the type of the expected package contents 564 * 565 * PTYPE1 packages contain no subpackages 566 * PTYPE2 packages contain sub-packages 567 */ 568 switch (Package->RetInfo.Type) 569 { 570 case ACPI_PTYPE1_FIXED: 571 572 /* 573 * The package count is fixed and there are no sub-packages 574 * 575 * If package is too small, exit. 576 * If package is larger than expected, issue warning but continue 577 */ 578 ExpectedCount = Package->RetInfo.Count1 + Package->RetInfo.Count2; 579 if (Count < ExpectedCount) 580 { 581 goto PackageTooSmall; 582 } 583 else if (Count > ExpectedCount) 584 { 585 ACPI_WARN_PREDEFINED ((AE_INFO, Data->Pathname, Data->NodeFlags, 586 "Return Package is larger than needed - " 587 "found %u, expected %u", Count, ExpectedCount)); 588 } 589 590 /* Validate all elements of the returned package */ 591 592 Status = AcpiNsCheckPackageElements (Data, Elements, 593 Package->RetInfo.ObjectType1, Package->RetInfo.Count1, 594 Package->RetInfo.ObjectType2, Package->RetInfo.Count2, 0); 595 break; 596 597 598 case ACPI_PTYPE1_VAR: 599 600 /* 601 * The package count is variable, there are no sub-packages, and all 602 * elements must be of the same type 603 */ 604 for (i = 0; i < Count; i++) 605 { 606 Status = AcpiNsCheckObjectType (Data, Elements, 607 Package->RetInfo.ObjectType1, i); 608 if (ACPI_FAILURE (Status)) 609 { 610 return (Status); 611 } 612 Elements++; 613 } 614 break; 615 616 617 case ACPI_PTYPE1_OPTION: 618 619 /* 620 * The package count is variable, there are no sub-packages. There are 621 * a fixed number of required elements, and a variable number of 622 * optional elements. 623 * 624 * Check if package is at least as large as the minimum required 625 */ 626 ExpectedCount = Package->RetInfo3.Count; 627 if (Count < ExpectedCount) 628 { 629 goto PackageTooSmall; 630 } 631 632 /* Variable number of sub-objects */ 633 634 for (i = 0; i < Count; i++) 635 { 636 if (i < Package->RetInfo3.Count) 637 { 638 /* These are the required package elements (0, 1, or 2) */ 639 640 Status = AcpiNsCheckObjectType (Data, Elements, 641 Package->RetInfo3.ObjectType[i], i); 642 if (ACPI_FAILURE (Status)) 643 { 644 return (Status); 645 } 646 } 647 else 648 { 649 /* These are the optional package elements */ 650 651 Status = AcpiNsCheckObjectType (Data, Elements, 652 Package->RetInfo3.TailObjectType, i); 653 if (ACPI_FAILURE (Status)) 654 { 655 return (Status); 656 } 657 } 658 Elements++; 659 } 660 break; 661 662 663 case ACPI_PTYPE2_REV_FIXED: 664 665 /* First element is the (Integer) revision */ 666 667 Status = AcpiNsCheckObjectType (Data, Elements, 668 ACPI_RTYPE_INTEGER, 0); 669 if (ACPI_FAILURE (Status)) 670 { 671 return (Status); 672 } 673 674 Elements++; 675 Count--; 676 677 /* Examine the sub-packages */ 678 679 Status = AcpiNsCheckPackageList (Data, Package, Elements, Count); 680 break; 681 682 683 case ACPI_PTYPE2_PKG_COUNT: 684 685 /* First element is the (Integer) count of sub-packages to follow */ 686 687 Status = AcpiNsCheckObjectType (Data, Elements, 688 ACPI_RTYPE_INTEGER, 0); 689 if (ACPI_FAILURE (Status)) 690 { 691 return (Status); 692 } 693 694 /* 695 * Count cannot be larger than the parent package length, but allow it 696 * to be smaller. The >= accounts for the Integer above. 697 */ 698 ExpectedCount = (UINT32) (*Elements)->Integer.Value; 699 if (ExpectedCount >= Count) 700 { 701 goto PackageTooSmall; 702 } 703 704 Count = ExpectedCount; 705 Elements++; 706 707 /* Examine the sub-packages */ 708 709 Status = AcpiNsCheckPackageList (Data, Package, Elements, Count); 710 break; 711 712 713 case ACPI_PTYPE2: 714 case ACPI_PTYPE2_FIXED: 715 case ACPI_PTYPE2_MIN: 716 case ACPI_PTYPE2_COUNT: 717 718 /* 719 * These types all return a single Package that consists of a 720 * variable number of sub-Packages. 721 * 722 * First, ensure that the first element is a sub-Package. If not, 723 * the BIOS may have incorrectly returned the object as a single 724 * package instead of a Package of Packages (a common error if 725 * there is only one entry). We may be able to repair this by 726 * wrapping the returned Package with a new outer Package. 727 */ 728 if (*Elements && ((*Elements)->Common.Type != ACPI_TYPE_PACKAGE)) 729 { 730 /* Create the new outer package and populate it */ 731 732 Status = AcpiNsRepairPackageList (Data, ReturnObjectPtr); 733 if (ACPI_FAILURE (Status)) 734 { 735 return (Status); 736 } 737 738 /* Update locals to point to the new package (of 1 element) */ 739 740 ReturnObject = *ReturnObjectPtr; 741 Elements = ReturnObject->Package.Elements; 742 Count = 1; 743 } 744 745 /* Examine the sub-packages */ 746 747 Status = AcpiNsCheckPackageList (Data, Package, Elements, Count); 748 break; 749 750 751 default: 752 753 /* Should not get here if predefined info table is correct */ 754 755 ACPI_WARN_PREDEFINED ((AE_INFO, Data->Pathname, Data->NodeFlags, 756 "Invalid internal return type in table entry: %X", 757 Package->RetInfo.Type)); 758 759 return (AE_AML_INTERNAL); 760 } 761 762 return (Status); 763 764 765 PackageTooSmall: 766 767 /* Error exit for the case with an incorrect package count */ 768 769 ACPI_WARN_PREDEFINED ((AE_INFO, Data->Pathname, Data->NodeFlags, 770 "Return Package is too small - found %u elements, expected %u", 771 Count, ExpectedCount)); 772 773 return (AE_AML_OPERAND_VALUE); 774 } 775 776 777 /******************************************************************************* 778 * 779 * FUNCTION: AcpiNsCheckPackageList 780 * 781 * PARAMETERS: Data - Pointer to validation data structure 782 * Package - Pointer to package-specific info for method 783 * Elements - Element list of parent package. All elements 784 * of this list should be of type Package. 785 * Count - Count of subpackages 786 * 787 * RETURN: Status 788 * 789 * DESCRIPTION: Examine a list of subpackages 790 * 791 ******************************************************************************/ 792 793 static ACPI_STATUS 794 AcpiNsCheckPackageList ( 795 ACPI_PREDEFINED_DATA *Data, 796 const ACPI_PREDEFINED_INFO *Package, 797 ACPI_OPERAND_OBJECT **Elements, 798 UINT32 Count) 799 { 800 ACPI_OPERAND_OBJECT *SubPackage; 801 ACPI_OPERAND_OBJECT **SubElements; 802 ACPI_STATUS Status; 803 BOOLEAN NonTrailingNull = FALSE; 804 UINT32 ExpectedCount; 805 UINT32 i; 806 UINT32 j; 807 808 809 /* Validate each sub-Package in the parent Package */ 810 811 for (i = 0; i < Count; i++) 812 { 813 /* 814 * Handling for NULL package elements. For now, we will simply allow 815 * a parent package with trailing NULL elements. This can happen if 816 * the package was defined to be longer than the initializer list. 817 * This is legal as per the ACPI specification. It is often used 818 * to allow for dynamic initialization of a Package. 819 * 820 * A future enhancement may be to simply truncate the package to 821 * remove the trailing NULL elements. 822 */ 823 if (!(*Elements)) 824 { 825 if (!NonTrailingNull) 826 { 827 /* Ensure the remaining elements are all NULL */ 828 829 for (j = 1; j < (Count - i + 1); j++) 830 { 831 if (Elements[j]) 832 { 833 NonTrailingNull = TRUE; 834 } 835 } 836 837 if (!NonTrailingNull) 838 { 839 /* Ignore the trailing NULL elements */ 840 841 return (AE_OK); 842 } 843 } 844 845 /* There are trailing non-null elements, issue warning */ 846 847 ACPI_WARN_PREDEFINED ((AE_INFO, Data->Pathname, Data->NodeFlags, 848 "Found NULL element at package index %u", i)); 849 Elements++; 850 continue; 851 } 852 853 SubPackage = *Elements; 854 SubElements = SubPackage->Package.Elements; 855 856 /* Each sub-object must be of type Package */ 857 858 Status = AcpiNsCheckObjectType (Data, &SubPackage, 859 ACPI_RTYPE_PACKAGE, i); 860 if (ACPI_FAILURE (Status)) 861 { 862 return (Status); 863 } 864 865 /* Examine the different types of expected sub-packages */ 866 867 switch (Package->RetInfo.Type) 868 { 869 case ACPI_PTYPE2: 870 case ACPI_PTYPE2_PKG_COUNT: 871 case ACPI_PTYPE2_REV_FIXED: 872 873 /* Each subpackage has a fixed number of elements */ 874 875 ExpectedCount = Package->RetInfo.Count1 + Package->RetInfo.Count2; 876 if (SubPackage->Package.Count < ExpectedCount) 877 { 878 goto PackageTooSmall; 879 } 880 881 Status = AcpiNsCheckPackageElements (Data, SubElements, 882 Package->RetInfo.ObjectType1, 883 Package->RetInfo.Count1, 884 Package->RetInfo.ObjectType2, 885 Package->RetInfo.Count2, 0); 886 if (ACPI_FAILURE (Status)) 887 { 888 return (Status); 889 } 890 break; 891 892 893 case ACPI_PTYPE2_FIXED: 894 895 /* Each sub-package has a fixed length */ 896 897 ExpectedCount = Package->RetInfo2.Count; 898 if (SubPackage->Package.Count < ExpectedCount) 899 { 900 goto PackageTooSmall; 901 } 902 903 /* Check the type of each sub-package element */ 904 905 for (j = 0; j < ExpectedCount; j++) 906 { 907 Status = AcpiNsCheckObjectType (Data, &SubElements[j], 908 Package->RetInfo2.ObjectType[j], j); 909 if (ACPI_FAILURE (Status)) 910 { 911 return (Status); 912 } 913 } 914 break; 915 916 917 case ACPI_PTYPE2_MIN: 918 919 /* Each sub-package has a variable but minimum length */ 920 921 ExpectedCount = Package->RetInfo.Count1; 922 if (SubPackage->Package.Count < ExpectedCount) 923 { 924 goto PackageTooSmall; 925 } 926 927 /* Check the type of each sub-package element */ 928 929 Status = AcpiNsCheckPackageElements (Data, SubElements, 930 Package->RetInfo.ObjectType1, 931 SubPackage->Package.Count, 0, 0, 0); 932 if (ACPI_FAILURE (Status)) 933 { 934 return (Status); 935 } 936 break; 937 938 939 case ACPI_PTYPE2_COUNT: 940 941 /* 942 * First element is the (Integer) count of elements, including 943 * the count field. 944 */ 945 Status = AcpiNsCheckObjectType (Data, SubElements, 946 ACPI_RTYPE_INTEGER, 0); 947 if (ACPI_FAILURE (Status)) 948 { 949 return (Status); 950 } 951 952 /* 953 * Make sure package is large enough for the Count and is 954 * is as large as the minimum size 955 */ 956 ExpectedCount = (UINT32) (*SubElements)->Integer.Value; 957 if (SubPackage->Package.Count < ExpectedCount) 958 { 959 goto PackageTooSmall; 960 } 961 if (SubPackage->Package.Count < Package->RetInfo.Count1) 962 { 963 ExpectedCount = Package->RetInfo.Count1; 964 goto PackageTooSmall; 965 } 966 967 /* Check the type of each sub-package element */ 968 969 Status = AcpiNsCheckPackageElements (Data, (SubElements + 1), 970 Package->RetInfo.ObjectType1, 971 (ExpectedCount - 1), 0, 0, 1); 972 if (ACPI_FAILURE (Status)) 973 { 974 return (Status); 975 } 976 break; 977 978 979 default: /* Should not get here, type was validated by caller */ 980 981 return (AE_AML_INTERNAL); 982 } 983 984 Elements++; 985 } 986 987 return (AE_OK); 988 989 990 PackageTooSmall: 991 992 /* The sub-package count was smaller than required */ 993 994 ACPI_WARN_PREDEFINED ((AE_INFO, Data->Pathname, Data->NodeFlags, 995 "Return Sub-Package[%u] is too small - found %u elements, expected %u", 996 i, SubPackage->Package.Count, ExpectedCount)); 997 998 return (AE_AML_OPERAND_VALUE); 999 } 1000 1001 1002 /******************************************************************************* 1003 * 1004 * FUNCTION: AcpiNsCheckPackageElements 1005 * 1006 * PARAMETERS: Data - Pointer to validation data structure 1007 * Elements - Pointer to the package elements array 1008 * Type1 - Object type for first group 1009 * Count1 - Count for first group 1010 * Type2 - Object type for second group 1011 * Count2 - Count for second group 1012 * StartIndex - Start of the first group of elements 1013 * 1014 * RETURN: Status 1015 * 1016 * DESCRIPTION: Check that all elements of a package are of the correct object 1017 * type. Supports up to two groups of different object types. 1018 * 1019 ******************************************************************************/ 1020 1021 static ACPI_STATUS 1022 AcpiNsCheckPackageElements ( 1023 ACPI_PREDEFINED_DATA *Data, 1024 ACPI_OPERAND_OBJECT **Elements, 1025 UINT8 Type1, 1026 UINT32 Count1, 1027 UINT8 Type2, 1028 UINT32 Count2, 1029 UINT32 StartIndex) 1030 { 1031 ACPI_OPERAND_OBJECT **ThisElement = Elements; 1032 ACPI_STATUS Status; 1033 UINT32 i; 1034 1035 1036 /* 1037 * Up to two groups of package elements are supported by the data 1038 * structure. All elements in each group must be of the same type. 1039 * The second group can have a count of zero. 1040 */ 1041 for (i = 0; i < Count1; i++) 1042 { 1043 Status = AcpiNsCheckObjectType (Data, ThisElement, 1044 Type1, i + StartIndex); 1045 if (ACPI_FAILURE (Status)) 1046 { 1047 return (Status); 1048 } 1049 ThisElement++; 1050 } 1051 1052 for (i = 0; i < Count2; i++) 1053 { 1054 Status = AcpiNsCheckObjectType (Data, ThisElement, 1055 Type2, (i + Count1 + StartIndex)); 1056 if (ACPI_FAILURE (Status)) 1057 { 1058 return (Status); 1059 } 1060 ThisElement++; 1061 } 1062 1063 return (AE_OK); 1064 } 1065 1066 1067 /******************************************************************************* 1068 * 1069 * FUNCTION: AcpiNsCheckObjectType 1070 * 1071 * PARAMETERS: Data - Pointer to validation data structure 1072 * ReturnObjectPtr - Pointer to the object returned from the 1073 * evaluation of a method or object 1074 * ExpectedBtypes - Bitmap of expected return type(s) 1075 * PackageIndex - Index of object within parent package (if 1076 * applicable - ACPI_NOT_PACKAGE_ELEMENT 1077 * otherwise) 1078 * 1079 * RETURN: Status 1080 * 1081 * DESCRIPTION: Check the type of the return object against the expected object 1082 * type(s). Use of Btype allows multiple expected object types. 1083 * 1084 ******************************************************************************/ 1085 1086 static ACPI_STATUS 1087 AcpiNsCheckObjectType ( 1088 ACPI_PREDEFINED_DATA *Data, 1089 ACPI_OPERAND_OBJECT **ReturnObjectPtr, 1090 UINT32 ExpectedBtypes, 1091 UINT32 PackageIndex) 1092 { 1093 ACPI_OPERAND_OBJECT *ReturnObject = *ReturnObjectPtr; 1094 ACPI_STATUS Status = AE_OK; 1095 UINT32 ReturnBtype; 1096 char TypeBuffer[48]; /* Room for 5 types */ 1097 1098 1099 /* 1100 * If we get a NULL ReturnObject here, it is a NULL package element, 1101 * and this is always an error. 1102 */ 1103 if (!ReturnObject) 1104 { 1105 goto TypeErrorExit; 1106 } 1107 1108 /* A Namespace node should not get here, but make sure */ 1109 1110 if (ACPI_GET_DESCRIPTOR_TYPE (ReturnObject) == ACPI_DESC_TYPE_NAMED) 1111 { 1112 ACPI_WARN_PREDEFINED ((AE_INFO, Data->Pathname, Data->NodeFlags, 1113 "Invalid return type - Found a Namespace node [%4.4s] type %s", 1114 ReturnObject->Node.Name.Ascii, 1115 AcpiUtGetTypeName (ReturnObject->Node.Type))); 1116 return (AE_AML_OPERAND_TYPE); 1117 } 1118 1119 /* 1120 * Convert the object type (ACPI_TYPE_xxx) to a bitmapped object type. 1121 * The bitmapped type allows multiple possible return types. 1122 * 1123 * Note, the cases below must handle all of the possible types returned 1124 * from all of the predefined names (including elements of returned 1125 * packages) 1126 */ 1127 switch (ReturnObject->Common.Type) 1128 { 1129 case ACPI_TYPE_INTEGER: 1130 ReturnBtype = ACPI_RTYPE_INTEGER; 1131 break; 1132 1133 case ACPI_TYPE_BUFFER: 1134 ReturnBtype = ACPI_RTYPE_BUFFER; 1135 break; 1136 1137 case ACPI_TYPE_STRING: 1138 ReturnBtype = ACPI_RTYPE_STRING; 1139 break; 1140 1141 case ACPI_TYPE_PACKAGE: 1142 ReturnBtype = ACPI_RTYPE_PACKAGE; 1143 break; 1144 1145 case ACPI_TYPE_LOCAL_REFERENCE: 1146 ReturnBtype = ACPI_RTYPE_REFERENCE; 1147 break; 1148 1149 default: 1150 /* Not one of the supported objects, must be incorrect */ 1151 1152 goto TypeErrorExit; 1153 } 1154 1155 /* Is the object one of the expected types? */ 1156 1157 if (!(ReturnBtype & ExpectedBtypes)) 1158 { 1159 /* Type mismatch -- attempt repair of the returned object */ 1160 1161 Status = AcpiNsRepairObject (Data, ExpectedBtypes, 1162 PackageIndex, ReturnObjectPtr); 1163 if (ACPI_SUCCESS (Status)) 1164 { 1165 return (AE_OK); /* Repair was successful */ 1166 } 1167 goto TypeErrorExit; 1168 } 1169 1170 /* For reference objects, check that the reference type is correct */ 1171 1172 if (ReturnObject->Common.Type == ACPI_TYPE_LOCAL_REFERENCE) 1173 { 1174 Status = AcpiNsCheckReference (Data, ReturnObject); 1175 } 1176 1177 return (Status); 1178 1179 1180 TypeErrorExit: 1181 1182 /* Create a string with all expected types for this predefined object */ 1183 1184 AcpiNsGetExpectedTypes (TypeBuffer, ExpectedBtypes); 1185 1186 if (PackageIndex == ACPI_NOT_PACKAGE_ELEMENT) 1187 { 1188 ACPI_WARN_PREDEFINED ((AE_INFO, Data->Pathname, Data->NodeFlags, 1189 "Return type mismatch - found %s, expected %s", 1190 AcpiUtGetObjectTypeName (ReturnObject), TypeBuffer)); 1191 } 1192 else 1193 { 1194 ACPI_WARN_PREDEFINED ((AE_INFO, Data->Pathname, Data->NodeFlags, 1195 "Return Package type mismatch at index %u - " 1196 "found %s, expected %s", PackageIndex, 1197 AcpiUtGetObjectTypeName (ReturnObject), TypeBuffer)); 1198 } 1199 1200 return (AE_AML_OPERAND_TYPE); 1201 } 1202 1203 1204 /******************************************************************************* 1205 * 1206 * FUNCTION: AcpiNsCheckReference 1207 * 1208 * PARAMETERS: Data - Pointer to validation data structure 1209 * ReturnObject - Object returned from the evaluation of a 1210 * method or object 1211 * 1212 * RETURN: Status 1213 * 1214 * DESCRIPTION: Check a returned reference object for the correct reference 1215 * type. The only reference type that can be returned from a 1216 * predefined method is a named reference. All others are invalid. 1217 * 1218 ******************************************************************************/ 1219 1220 static ACPI_STATUS 1221 AcpiNsCheckReference ( 1222 ACPI_PREDEFINED_DATA *Data, 1223 ACPI_OPERAND_OBJECT *ReturnObject) 1224 { 1225 1226 /* 1227 * Check the reference object for the correct reference type (opcode). 1228 * The only type of reference that can be converted to an ACPI_OBJECT is 1229 * a reference to a named object (reference class: NAME) 1230 */ 1231 if (ReturnObject->Reference.Class == ACPI_REFCLASS_NAME) 1232 { 1233 return (AE_OK); 1234 } 1235 1236 ACPI_WARN_PREDEFINED ((AE_INFO, Data->Pathname, Data->NodeFlags, 1237 "Return type mismatch - unexpected reference object type [%s] %2.2X", 1238 AcpiUtGetReferenceName (ReturnObject), 1239 ReturnObject->Reference.Class)); 1240 1241 return (AE_AML_OPERAND_TYPE); 1242 } 1243 1244 1245 /******************************************************************************* 1246 * 1247 * FUNCTION: AcpiNsGetExpectedTypes 1248 * 1249 * PARAMETERS: Buffer - Pointer to where the string is returned 1250 * ExpectedBtypes - Bitmap of expected return type(s) 1251 * 1252 * RETURN: Buffer is populated with type names. 1253 * 1254 * DESCRIPTION: Translate the expected types bitmap into a string of ascii 1255 * names of expected types, for use in warning messages. 1256 * 1257 ******************************************************************************/ 1258 1259 static void 1260 AcpiNsGetExpectedTypes ( 1261 char *Buffer, 1262 UINT32 ExpectedBtypes) 1263 { 1264 UINT32 ThisRtype; 1265 UINT32 i; 1266 UINT32 j; 1267 1268 1269 j = 1; 1270 Buffer[0] = 0; 1271 ThisRtype = ACPI_RTYPE_INTEGER; 1272 1273 for (i = 0; i < ACPI_NUM_RTYPES; i++) 1274 { 1275 /* If one of the expected types, concatenate the name of this type */ 1276 1277 if (ExpectedBtypes & ThisRtype) 1278 { 1279 ACPI_STRCAT (Buffer, &AcpiRtypeNames[i][j]); 1280 j = 0; /* Use name separator from now on */ 1281 } 1282 ThisRtype <<= 1; /* Next Rtype */ 1283 } 1284 } 1285