drivers/acpi/acpica/nspredef.c

   1 /******************************************************************************
   2  *
   3  * Module Name: nspredef - Validation of ACPI predefined methods and objects
   4  *              $Revision: 1.1 $
   5  *
   6  *****************************************************************************/
   7
   8 /*
   9  * Copyright (C) 2000 - 2008, Intel Corp.
  10  * All rights reserved.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions, and the following disclaimer,
  17  *    without modification.
  18  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  19  *    substantially similar to the "NO WARRANTY" disclaimer below
  20  *    ("Disclaimer") and any redistribution must be conditioned upon
  21  *    including a substantially similar Disclaimer requirement for further
  22  *    binary redistribution.
  23  * 3. Neither the names of the above-listed copyright holders nor the names
  24  *    of any contributors may be used to endorse or promote products derived
  25  *    from this software without specific prior written permission.
  26  *
  27  * Alternatively, this software may be distributed under the terms of the
  28  * GNU General Public License ("GPL") version 2 as published by the Free
  29  * Software Foundation.
  30  *
  31  * NO WARRANTY
  32  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  33  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  34  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  35  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  36  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  37  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  38  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  39  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  40  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  41  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  42  * POSSIBILITY OF SUCH DAMAGES.
  43  */
  44
  45 #define ACPI_CREATE_PREDEFINED_TABLE
  46
  47 #include <acpi/acpi.h>
  48 #include "accommon.h"
  49 #include "acnamesp.h"
  50 #include "acpredef.h"
  51
  52 #define _COMPONENT          ACPI_NAMESPACE
  53 ACPI_MODULE_NAME("nspredef")
  54
  55 /*******************************************************************************
  56  *
  57  * This module validates predefined ACPI objects that appear in the namespace,
  58  * at the time they are evaluated (via acpi_evaluate_object). The purpose of this
  59  * validation is to detect problems with BIOS-exposed predefined ACPI objects
  60  * before the results are returned to the ACPI-related drivers.
  61  *
  62  * There are several areas that are validated:
  63  *
  64  *  1) The number of input arguments as defined by the method/object in the
  65  *      ASL is validated against the ACPI specification.
  66  *  2) The type of the return object (if any) is validated against the ACPI
  67  *      specification.
  68  *  3) For returned package objects, the count of package elements is
  69  *      validated, as well as the type of each package element. Nested
  70  *      packages are supported.
  71  *
  72  * For any problems found, a warning message is issued.
  73  *
  74  ******************************************************************************/
  75 /* Local prototypes */
  76 static acpi_status
  77 acpi_ns_check_package(struct acpi_predefined_data *data,
  78                       union acpi_operand_object **return_object_ptr);
  79
  80 static acpi_status
  81 acpi_ns_check_package_list(struct acpi_predefined_data *data,
  82                            const union acpi_predefined_info *package,
  83                            union acpi_operand_object **elements, u32 count);
  84
  85 static acpi_status
  86 acpi_ns_check_package_elements(struct acpi_predefined_data *data,
  87                                union acpi_operand_object **elements,
  88                                u8 type1,
  89                                u32 count1,
  90                                u8 type2, u32 count2, u32 start_index);
  91
  92 static acpi_status
  93 acpi_ns_check_object_type(struct acpi_predefined_data *data,
  94                           union acpi_operand_object **return_object_ptr,
  95                           u32 expected_btypes, u32 package_index);
  96
  97 static acpi_status
  98 acpi_ns_check_reference(struct acpi_predefined_data *data,
  99                         union acpi_operand_object *return_object);
 100
 101 static void acpi_ns_get_expected_types(char *buffer, u32 expected_btypes);
 102
 103 /*
 104  * Names for the types that can be returned by the predefined objects.
 105  * Used for warning messages. Must be in the same order as the ACPI_RTYPEs
 106  */
 107 static const char *acpi_rtype_names[] = {
 108         "/Integer",
 109         "/String",
 110         "/Buffer",
 111         "/Package",
 112         "/Reference",
 113 };
 114
 115 /*******************************************************************************
 116  *
 117  * FUNCTION:    acpi_ns_check_predefined_names
 118  *
 119  * PARAMETERS:  Node            - Namespace node for the method/object
 120  *              user_param_count - Number of parameters actually passed
 121  *              return_status   - Status from the object evaluation
 122  *              return_object_ptr - Pointer to the object returned from the
 123  *                                evaluation of a method or object
 124  *
 125  * RETURN:      Status
 126  *
 127  * DESCRIPTION: Check an ACPI name for a match in the predefined name list.
 128  *
 129  ******************************************************************************/
 130
 131 acpi_status
 132 acpi_ns_check_predefined_names(struct acpi_namespace_node *node,
 133                                u32 user_param_count,
 134                                acpi_status return_status,
 135                                union acpi_operand_object **return_object_ptr)
 136 {
 137         union acpi_operand_object *return_object = *return_object_ptr;
 138         acpi_status status = AE_OK;
 139         const union acpi_predefined_info *predefined;
 140         char *pathname;
 141         struct acpi_predefined_data *data;
 142
 143         /* Match the name for this method/object against the predefined list */
 144
 145         predefined = acpi_ns_check_for_predefined_name(node);
 146
 147         /* Get the full pathname to the object, for use in warning messages */
 148
 149         pathname = acpi_ns_get_external_pathname(node);
 150         if (!pathname) {
 151                 return AE_OK;   /* Could not get pathname, ignore */
 152         }
 153
 154         /*
 155          * Check that the parameter count for this method matches the ASL
 156          * definition. For predefined names, ensure that both the caller and
 157          * the method itself are in accordance with the ACPI specification.
 158          */
 159         acpi_ns_check_parameter_count(pathname, node, user_param_count,
 160                                       predefined);
 161
 162         /* If not a predefined name, we cannot validate the return object */
 163
 164         if (!predefined) {
 165                 goto cleanup;
 166         }
 167
 168         /*
 169          * If the method failed or did not actually return an object, we cannot
 170          * validate the return object
 171          */
 172         if ((return_status != AE_OK) && (return_status != AE_CTRL_RETURN_VALUE)) {
 173                 goto cleanup;
 174         }
 175
 176         /*
 177          * If there is no return value, check if we require a return value for
 178          * this predefined name. Either one return value is expected, or none,
 179          * for both methods and other objects.
 180          *
 181          * Exit now if there is no return object. Warning if one was expected.
 182          */
 183         if (!return_object) {
 184                 if ((predefined->info.expected_btypes) &&
 185                     (!(predefined->info.expected_btypes & ACPI_RTYPE_NONE))) {
 186                         ACPI_WARN_PREDEFINED((AE_INFO, pathname,
 187                                               ACPI_WARN_ALWAYS,
 188                                               "Missing expected return value"));
 189
 190                         status = AE_AML_NO_RETURN_VALUE;
 191                 }
 192                 goto cleanup;
 193         }
 194
 195         /*
 196          * 1) We have a return value, but if one wasn't expected, just exit, this is
 197          * not a problem. For example, if the "Implicit Return" feature is
 198          * enabled, methods will always return a value.
 199          *
 200          * 2) If the return value can be of any type, then we cannot perform any
 201          * validation, exit.
 202          */
 203         if ((!predefined->info.expected_btypes) ||
 204             (predefined->info.expected_btypes == ACPI_RTYPE_ALL)) {
 205                 goto cleanup;
 206         }
 207
 208         /* Create the parameter data block for object validation */
 209
 210         data = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_predefined_data));
 211         if (!data) {
 212                 goto cleanup;
 213         }
 214         data->predefined = predefined;
 215         data->node_flags = node->flags;
 216         data->pathname = pathname;
 217
 218         /*
 219          * Check that the type of the return object is what is expected for
 220          * this predefined name
 221          */
 222         status = acpi_ns_check_object_type(data, return_object_ptr,
 223                                            predefined->info.expected_btypes,
 224                                            ACPI_NOT_PACKAGE_ELEMENT);
 225         if (ACPI_SUCCESS(status)) {
 226
 227                 /* For returned Package objects, check the type of all sub-objects */
 228
 229                 if (return_object->common.type == ACPI_TYPE_PACKAGE) {
 230                         status = acpi_ns_check_package(data, return_object_ptr);
 231                 }
 232         }
 233
 234         /*
 235          * Perform additional, more complicated repairs on a per-name
 236          * basis. Do this regardless of the status from above.
 237          */
 238         status = acpi_ns_complex_repairs(data, node, status, return_object_ptr);
 239
 240         /*
 241          * If the object validation failed or if we successfully repaired one
 242          * or more objects, mark the parent node to suppress further warning
 243          * messages during the next evaluation of the same method/object.
 244          */
 245         if (ACPI_FAILURE(status) || (data->flags & ACPI_OBJECT_REPAIRED)) {
 246                 node->flags |= ANOBJ_EVALUATED;
 247         }
 248         ACPI_FREE(data);
 249
 250 cleanup:
 251         ACPI_FREE(pathname);
 252         return (status);
 253 }
 254
 255 /*******************************************************************************
 256  *
 257  * FUNCTION:    acpi_ns_check_parameter_count
 258  *
 259  * PARAMETERS:  Pathname        - Full pathname to the node (for error msgs)
 260  *              Node            - Namespace node for the method/object
 261  *              user_param_count - Number of args passed in by the caller
 262  *              Predefined      - Pointer to entry in predefined name table
 263  *
 264  * RETURN:      None
 265  *
 266  * DESCRIPTION: Check that the declared (in ASL/AML) parameter count for a
 267  *              predefined name is what is expected (i.e., what is defined in
 268  *              the ACPI specification for this predefined name.)
 269  *
 270  ******************************************************************************/
 271
 272 void
 273 acpi_ns_check_parameter_count(char *pathname,
 274                               struct acpi_namespace_node *node,
 275                               u32 user_param_count,
 276                               const union acpi_predefined_info *predefined)
 277 {
 278         u32 param_count;
 279         u32 required_params_current;
 280         u32 required_params_old;
 281
 282         /* Methods have 0-7 parameters. All other types have zero. */
 283
 284         param_count = 0;
 285         if (node->type == ACPI_TYPE_METHOD) {
 286                 param_count = node->object->method.param_count;
 287         }
 288
 289         if (!predefined) {
 290                 /*
 291                  * Check the parameter count for non-predefined methods/objects.
 292                  *
 293                  * Warning if too few or too many arguments have been passed by the
 294                  * caller. An incorrect number of arguments may not cause the method
 295                  * to fail. However, the method will fail if there are too few
 296                  * arguments and the method attempts to use one of the missing ones.
 297                  */
 298                 if (user_param_count < param_count) {
 299                         ACPI_WARN_PREDEFINED((AE_INFO, pathname,
 300                                               ACPI_WARN_ALWAYS,
 301                                               "Insufficient arguments - needs %u, found %u",
 302                                               param_count, user_param_count));
 303                 } else if (user_param_count > param_count) {
 304                         ACPI_WARN_PREDEFINED((AE_INFO, pathname,
 305                                               ACPI_WARN_ALWAYS,
 306                                               "Excess arguments - needs %u, found %u",
 307                                               param_count, user_param_count));
 308                 }
 309                 return;
 310         }
 311
 312         /*
 313          * Validate the user-supplied parameter count.
 314          * Allow two different legal argument counts (_SCP, etc.)
 315          */
 316         required_params_current = predefined->info.param_count & 0x0F;
 317         required_params_old = predefined->info.param_count >> 4;
 318
 319         if (user_param_count != ACPI_UINT32_MAX) {
 320                 if ((user_param_count != required_params_current) &&
 321                     (user_param_count != required_params_old)) {
 322                         ACPI_WARN_PREDEFINED((AE_INFO, pathname,
 323                                               ACPI_WARN_ALWAYS,
 324                                               "Parameter count mismatch - "
 325                                               "caller passed %u, ACPI requires %u",
 326                                               user_param_count,
 327                                               required_params_current));
 328                 }
 329         }
 330
 331         /*
 332          * Check that the ASL-defined parameter count is what is expected for
 333          * this predefined name (parameter count as defined by the ACPI
 334          * specification)
 335          */
 336         if ((param_count != required_params_current) &&
 337             (param_count != required_params_old)) {
 338                 ACPI_WARN_PREDEFINED((AE_INFO, pathname, node->flags,
 339                                       "Parameter count mismatch - ASL declared %u, ACPI requires %u",
 340                                       param_count, required_params_current));
 341         }
 342 }
 343
 344 /*******************************************************************************
 345  *
 346  * FUNCTION:    acpi_ns_check_for_predefined_name
 347  *
 348  * PARAMETERS:  Node            - Namespace node for the method/object
 349  *
 350  * RETURN:      Pointer to entry in predefined table. NULL indicates not found.
 351  *
 352  * DESCRIPTION: Check an object name against the predefined object list.
 353  *
 354  ******************************************************************************/
 355
 356 const union acpi_predefined_info *acpi_ns_check_for_predefined_name(struct
 357                                                                     acpi_namespace_node
 358                                                                     *node)
 359 {
 360         const union acpi_predefined_info *this_name;
 361
 362         /* Quick check for a predefined name, first character must be underscore */
 363
 364         if (node->name.ascii[0] != '_') {
 365                 return (NULL);
 366         }
 367
 368         /* Search info table for a predefined method/object name */
 369
 370         this_name = predefined_names;
 371         while (this_name->info.name[0]) {
 372                 if (ACPI_COMPARE_NAME(node->name.ascii, this_name->info.name)) {
 373                         return (this_name);
 374                 }
 375
 376                 /*
 377                  * Skip next entry in the table if this name returns a Package
 378                  * (next entry contains the package info)
 379                  */
 380                 if (this_name->info.expected_btypes & ACPI_RTYPE_PACKAGE) {
 381                         this_name++;
 382                 }
 383
 384                 this_name++;
 385         }
 386
 387         return (NULL);          /* Not found */
 388 }
 389
 390 /*******************************************************************************
 391  *
 392  * FUNCTION:    acpi_ns_check_package
 393  *
 394  * PARAMETERS:  Data            - Pointer to validation data structure
 395  *              return_object_ptr - Pointer to the object returned from the
 396  *                                evaluation of a method or object
 397  *
 398  * RETURN:      Status
 399  *
 400  * DESCRIPTION: Check a returned package object for the correct count and
 401  *              correct type of all sub-objects.
 402  *
 403  ******************************************************************************/
 404
 405 static acpi_status
 406 acpi_ns_check_package(struct acpi_predefined_data *data,
 407                       union acpi_operand_object **return_object_ptr)
 408 {
 409         union acpi_operand_object *return_object = *return_object_ptr;
 410         const union acpi_predefined_info *package;
 411         union acpi_operand_object **elements;
 412         acpi_status status = AE_OK;
 413         u32 expected_count;
 414         u32 count;
 415         u32 i;
 416
 417         ACPI_FUNCTION_NAME(ns_check_package);
 418
 419         /* The package info for this name is in the next table entry */
 420
 421         package = data->predefined + 1;
 422
 423         ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
 424                           "%s Validating return Package of Type %X, Count %X\n",
 425                           data->pathname, package->ret_info.type,
 426                           return_object->package.count));
 427
 428         /* Extract package count and elements array */
 429
 430         elements = return_object->package.elements;
 431         count = return_object->package.count;
 432
 433         /* The package must have at least one element, else invalid */
 434
 435         if (!count) {
 436                 ACPI_WARN_PREDEFINED((AE_INFO, data->pathname, data->node_flags,
 437                                       "Return Package has no elements (empty)"));
 438
 439                 return (AE_AML_OPERAND_VALUE);
 440         }
 441
 442         /*
 443          * Decode the type of the expected package contents
 444          *
 445          * PTYPE1 packages contain no subpackages
 446          * PTYPE2 packages contain sub-packages
 447          */
 448         switch (package->ret_info.type) {
 449         case ACPI_PTYPE1_FIXED:
 450
 451                 /*
 452                  * The package count is fixed and there are no sub-packages
 453                  *
 454                  * If package is too small, exit.
 455                  * If package is larger than expected, issue warning but continue
 456                  */
 457                 expected_count =
 458                     package->ret_info.count1 + package->ret_info.count2;
 459                 if (count < expected_count) {
 460                         goto package_too_small;
 461                 } else if (count > expected_count) {
 462                         ACPI_WARN_PREDEFINED((AE_INFO, data->pathname,
 463                                               data->node_flags,
 464                                               "Return Package is larger than needed - "
 465                                               "found %u, expected %u", count,
 466                                               expected_count));
 467                 }
 468
 469                 /* Validate all elements of the returned package */
 470
 471                 status = acpi_ns_check_package_elements(data, elements,
 472                                                         package->ret_info.
 473                                                         object_type1,
 474                                                         package->ret_info.
 475                                                         count1,
 476                                                         package->ret_info.
 477                                                         object_type2,
 478                                                         package->ret_info.
 479                                                         count2, 0);
 480                 break;
 481
 482         case ACPI_PTYPE1_VAR:
 483
 484                 /*
 485                  * The package count is variable, there are no sub-packages, and all
 486                  * elements must be of the same type
 487                  */
 488                 for (i = 0; i < count; i++) {
 489                         status = acpi_ns_check_object_type(data, elements,
 490                                                            package->ret_info.
 491                                                            object_type1, i);
 492                         if (ACPI_FAILURE(status)) {
 493                                 return (status);
 494                         }
 495                         elements++;
 496                 }
 497                 break;
 498
 499         case ACPI_PTYPE1_OPTION:
 500
 501                 /*
 502                  * The package count is variable, there are no sub-packages. There are
 503                  * a fixed number of required elements, and a variable number of
 504                  * optional elements.
 505                  *
 506                  * Check if package is at least as large as the minimum required
 507                  */
 508                 expected_count = package->ret_info3.count;
 509                 if (count < expected_count) {
 510                         goto package_too_small;
 511                 }
 512
 513                 /* Variable number of sub-objects */
 514
 515                 for (i = 0; i < count; i++) {
 516                         if (i < package->ret_info3.count) {
 517
 518                                 /* These are the required package elements (0, 1, or 2) */
 519
 520                                 status =
 521                                     acpi_ns_check_object_type(data, elements,
 522                                                               package->
 523                                                               ret_info3.
 524                                                               object_type[i],
 525                                                               i);
 526                                 if (ACPI_FAILURE(status)) {
 527                                         return (status);
 528                                 }
 529                         } else {
 530                                 /* These are the optional package elements */
 531
 532                                 status =
 533                                     acpi_ns_check_object_type(data, elements,
 534                                                               package->
 535                                                               ret_info3.
 536                                                               tail_object_type,
 537                                                               i);
 538                                 if (ACPI_FAILURE(status)) {
 539                                         return (status);
 540                                 }
 541                         }
 542                         elements++;
 543                 }
 544                 break;
 545
 546         case ACPI_PTYPE2_REV_FIXED:
 547
 548                 /* First element is the (Integer) revision */
 549
 550                 status = acpi_ns_check_object_type(data, elements,
 551                                                    ACPI_RTYPE_INTEGER, 0);
 552                 if (ACPI_FAILURE(status)) {
 553                         return (status);
 554                 }
 555
 556                 elements++;
 557                 count--;
 558
 559                 /* Examine the sub-packages */
 560
 561                 status =
 562                     acpi_ns_check_package_list(data, package, elements, count);
 563                 break;
 564
 565         case ACPI_PTYPE2_PKG_COUNT:
 566
 567                 /* First element is the (Integer) count of sub-packages to follow */
 568
 569                 status = acpi_ns_check_object_type(data, elements,
 570                                                    ACPI_RTYPE_INTEGER, 0);
 571                 if (ACPI_FAILURE(status)) {
 572                         return (status);
 573                 }
 574
 575                 /*
 576                  * Count cannot be larger than the parent package length, but allow it
 577                  * to be smaller. The >= accounts for the Integer above.
 578                  */
 579                 expected_count = (u32) (*elements)->integer.value;
 580                 if (expected_count >= count) {
 581                         goto package_too_small;
 582                 }
 583
 584                 count = expected_count;
 585                 elements++;
 586
 587                 /* Examine the sub-packages */
 588
 589                 status =
 590                     acpi_ns_check_package_list(data, package, elements, count);
 591                 break;
 592
 593         case ACPI_PTYPE2:
 594         case ACPI_PTYPE2_FIXED:
 595         case ACPI_PTYPE2_MIN:
 596         case ACPI_PTYPE2_COUNT:
 597
 598                 /*
 599                  * These types all return a single Package that consists of a
 600                  * variable number of sub-Packages.
 601                  *
 602                  * First, ensure that the first element is a sub-Package. If not,
 603                  * the BIOS may have incorrectly returned the object as a single
 604                  * package instead of a Package of Packages (a common error if
 605                  * there is only one entry). We may be able to repair this by
 606                  * wrapping the returned Package with a new outer Package.
 607                  */
 608                 if (*elements
 609                     && ((*elements)->common.type != ACPI_TYPE_PACKAGE)) {
 610
 611                         /* Create the new outer package and populate it */
 612
 613                         status =
 614                             acpi_ns_repair_package_list(data,
 615                                                         return_object_ptr);
 616                         if (ACPI_FAILURE(status)) {
 617                                 return (status);
 618                         }
 619
 620                         /* Update locals to point to the new package (of 1 element) */
 621
 622                         return_object = *return_object_ptr;
 623                         elements = return_object->package.elements;
 624                         count = 1;
 625                 }
 626
 627                 /* Examine the sub-packages */
 628
 629                 status =
 630                     acpi_ns_check_package_list(data, package, elements, count);
 631                 break;
 632
 633         default:
 634
 635                 /* Should not get here if predefined info table is correct */
 636
 637                 ACPI_WARN_PREDEFINED((AE_INFO, data->pathname, data->node_flags,
 638                                       "Invalid internal return type in table entry: %X",
 639                                       package->ret_info.type));
 640
 641                 return (AE_AML_INTERNAL);
 642         }
 643
 644         return (status);
 645
 646 package_too_small:
 647
 648         /* Error exit for the case with an incorrect package count */
 649
 650         ACPI_WARN_PREDEFINED((AE_INFO, data->pathname, data->node_flags,
 651                               "Return Package is too small - found %u elements, expected %u",
 652                               count, expected_count));
 653
 654         return (AE_AML_OPERAND_VALUE);
 655 }
 656
 657 /*******************************************************************************
 658  *
 659  * FUNCTION:    acpi_ns_check_package_list
 660  *
 661  * PARAMETERS:  Data            - Pointer to validation data structure
 662  *              Package         - Pointer to package-specific info for method
 663  *              Elements        - Element list of parent package. All elements
 664  *                                of this list should be of type Package.
 665  *              Count           - Count of subpackages
 666  *
 667  * RETURN:      Status
 668  *
 669  * DESCRIPTION: Examine a list of subpackages
 670  *
 671  ******************************************************************************/
 672
 673 static acpi_status
 674 acpi_ns_check_package_list(struct acpi_predefined_data *data,
 675                            const union acpi_predefined_info *package,
 676                            union acpi_operand_object **elements, u32 count)
 677 {
 678         union acpi_operand_object *sub_package;
 679         union acpi_operand_object **sub_elements;
 680         acpi_status status;
 681         u8 non_trailing_null = FALSE;
 682         u32 expected_count;
 683         u32 i;
 684         u32 j;
 685
 686         /* Validate each sub-Package in the parent Package */
 687
 688         for (i = 0; i < count; i++) {
 689                 /*
 690                  * Handling for NULL package elements. For now, we will simply allow
 691                  * a parent package with trailing NULL elements. This can happen if
 692                  * the package was defined to be longer than the initializer list.
 693                  * This is legal as per the ACPI specification. It is often used
 694                  * to allow for dynamic initialization of a Package.
 695                  *
 696                  * A future enhancement may be to simply truncate the package to
 697                  * remove the trailing NULL elements.
 698                  */
 699                 if (!(*elements)) {
 700                         if (!non_trailing_null) {
 701
 702                                 /* Ensure the remaining elements are all NULL */
 703
 704                                 for (j = 1; j < (count - i + 1); j++) {
 705                                         if (elements[j]) {
 706                                                 non_trailing_null = TRUE;
 707                                         }
 708                                 }
 709
 710                                 if (!non_trailing_null) {
 711
 712                                         /* Ignore the trailing NULL elements */
 713
 714                                         return (AE_OK);
 715                                 }
 716                         }
 717
 718                         /* There are trailing non-null elements, issue warning */
 719
 720                         ACPI_WARN_PREDEFINED((AE_INFO, data->pathname,
 721                                               data->node_flags,
 722                                               "Found NULL element at package index %u",
 723                                               i));
 724                         elements++;
 725                         continue;
 726                 }
 727
 728                 sub_package = *elements;
 729                 sub_elements = sub_package->package.elements;
 730
 731                 /* Each sub-object must be of type Package */
 732
 733                 status = acpi_ns_check_object_type(data, &sub_package,
 734                                                    ACPI_RTYPE_PACKAGE, i);
 735                 if (ACPI_FAILURE(status)) {
 736                         return (status);
 737                 }
 738
 739                 /* Examine the different types of expected sub-packages */
 740
 741                 switch (package->ret_info.type) {
 742                 case ACPI_PTYPE2:
 743                 case ACPI_PTYPE2_PKG_COUNT:
 744                 case ACPI_PTYPE2_REV_FIXED:
 745
 746                         /* Each subpackage has a fixed number of elements */
 747
 748                         expected_count =
 749                             package->ret_info.count1 + package->ret_info.count2;
 750                         if (sub_package->package.count < expected_count) {
 751                                 goto package_too_small;
 752                         }
 753
 754                         status =
 755                             acpi_ns_check_package_elements(data, sub_elements,
 756                                                            package->ret_info.
 757                                                            object_type1,
 758                                                            package->ret_info.
 759                                                            count1,
 760                                                            package->ret_info.
 761                                                            object_type2,
 762                                                            package->ret_info.
 763                                                            count2, 0);
 764                         if (ACPI_FAILURE(status)) {
 765                                 return (status);
 766                         }
 767                         break;
 768
 769                 case ACPI_PTYPE2_FIXED:
 770
 771                         /* Each sub-package has a fixed length */
 772
 773                         expected_count = package->ret_info2.count;
 774                         if (sub_package->package.count < expected_count) {
 775                                 goto package_too_small;
 776                         }
 777
 778                         /* Check the type of each sub-package element */
 779
 780                         for (j = 0; j < expected_count; j++) {
 781                                 status =
 782                                     acpi_ns_check_object_type(data,
 783                                                               &sub_elements[j],
 784                                                               package->
 785                                                               ret_info2.
 786                                                               object_type[j],
 787                                                               j);
 788                                 if (ACPI_FAILURE(status)) {
 789                                         return (status);
 790                                 }
 791                         }
 792                         break;
 793
 794                 case ACPI_PTYPE2_MIN:
 795
 796                         /* Each sub-package has a variable but minimum length */
 797
 798                         expected_count = package->ret_info.count1;
 799                         if (sub_package->package.count < expected_count) {
 800                                 goto package_too_small;
 801                         }
 802
 803                         /* Check the type of each sub-package element */
 804
 805                         status =
 806                             acpi_ns_check_package_elements(data, sub_elements,
 807                                                            package->ret_info.
 808                                                            object_type1,
 809                                                            sub_package->package.
 810                                                            count, 0, 0, 0);
 811                         if (ACPI_FAILURE(status)) {
 812                                 return (status);
 813                         }
 814                         break;
 815
 816                 case ACPI_PTYPE2_COUNT:
 817
 818                         /*
 819                          * First element is the (Integer) count of elements, including
 820                          * the count field.
 821                          */
 822                         status = acpi_ns_check_object_type(data, sub_elements,
 823                                                            ACPI_RTYPE_INTEGER,
 824                                                            0);
 825                         if (ACPI_FAILURE(status)) {
 826                                 return (status);
 827                         }
 828
 829                         /*
 830                          * Make sure package is large enough for the Count and is
 831                          * is as large as the minimum size
 832                          */
 833                         expected_count = (u32)(*sub_elements)->integer.value;
 834                         if (sub_package->package.count < expected_count) {
 835                                 goto package_too_small;
 836                         }
 837                         if (sub_package->package.count <
 838                             package->ret_info.count1) {
 839                                 expected_count = package->ret_info.count1;
 840                                 goto package_too_small;
 841                         }
 842
 843                         /* Check the type of each sub-package element */
 844
 845                         status =
 846                             acpi_ns_check_package_elements(data,
 847                                                            (sub_elements + 1),
 848                                                            package->ret_info.
 849                                                            object_type1,
 850                                                            (expected_count - 1),
 851                                                            0, 0, 1);
 852                         if (ACPI_FAILURE(status)) {
 853                                 return (status);
 854                         }
 855                         break;
 856
 857                 default:        /* Should not get here, type was validated by caller */
 858
 859                         return (AE_AML_INTERNAL);
 860                 }
 861
 862                 elements++;
 863         }
 864
 865         return (AE_OK);
 866
 867 package_too_small:
 868
 869         /* The sub-package count was smaller than required */
 870
 871         ACPI_WARN_PREDEFINED((AE_INFO, data->pathname, data->node_flags,
 872                               "Return Sub-Package[%u] is too small - found %u elements, expected %u",
 873                               i, sub_package->package.count, expected_count));
 874
 875         return (AE_AML_OPERAND_VALUE);
 876 }
 877
 878 /*******************************************************************************
 879  *
 880  * FUNCTION:    acpi_ns_check_package_elements
 881  *
 882  * PARAMETERS:  Data            - Pointer to validation data structure
 883  *              Elements        - Pointer to the package elements array
 884  *              Type1           - Object type for first group
 885  *              Count1          - Count for first group
 886  *              Type2           - Object type for second group
 887  *              Count2          - Count for second group
 888  *              start_index     - Start of the first group of elements
 889  *
 890  * RETURN:      Status
 891  *
 892  * DESCRIPTION: Check that all elements of a package are of the correct object
 893  *              type. Supports up to two groups of different object types.
 894  *
 895  ******************************************************************************/
 896
 897 static acpi_status
 898 acpi_ns_check_package_elements(struct acpi_predefined_data *data,
 899                                union acpi_operand_object **elements,
 900                                u8 type1,
 901                                u32 count1,
 902                                u8 type2, u32 count2, u32 start_index)
 903 {
 904         union acpi_operand_object **this_element = elements;
 905         acpi_status status;
 906         u32 i;
 907
 908         /*
 909          * Up to two groups of package elements are supported by the data
 910          * structure. All elements in each group must be of the same type.
 911          * The second group can have a count of zero.
 912          */
 913         for (i = 0; i < count1; i++) {
 914                 status = acpi_ns_check_object_type(data, this_element,
 915                                                    type1, i + start_index);
 916                 if (ACPI_FAILURE(status)) {
 917                         return (status);
 918                 }
 919                 this_element++;
 920         }
 921
 922         for (i = 0; i < count2; i++) {
 923                 status = acpi_ns_check_object_type(data, this_element,
 924                                                    type2,
 925                                                    (i + count1 + start_index));
 926                 if (ACPI_FAILURE(status)) {
 927                         return (status);
 928                 }
 929                 this_element++;
 930         }
 931
 932         return (AE_OK);
 933 }
 934
 935 /*******************************************************************************
 936  *
 937  * FUNCTION:    acpi_ns_check_object_type
 938  *
 939  * PARAMETERS:  Data            - Pointer to validation data structure
 940  *              return_object_ptr - Pointer to the object returned from the
 941  *                                evaluation of a method or object
 942  *              expected_btypes - Bitmap of expected return type(s)
 943  *              package_index   - Index of object within parent package (if
 944  *                                applicable - ACPI_NOT_PACKAGE_ELEMENT
 945  *                                otherwise)
 946  *
 947  * RETURN:      Status
 948  *
 949  * DESCRIPTION: Check the type of the return object against the expected object
 950  *              type(s). Use of Btype allows multiple expected object types.
 951  *
 952  ******************************************************************************/
 953
 954 static acpi_status
 955 acpi_ns_check_object_type(struct acpi_predefined_data *data,
 956                           union acpi_operand_object **return_object_ptr,
 957                           u32 expected_btypes, u32 package_index)
 958 {
 959         union acpi_operand_object *return_object = *return_object_ptr;
 960         acpi_status status = AE_OK;
 961         u32 return_btype;
 962         char type_buffer[48];   /* Room for 5 types */
 963
 964         /*
 965          * If we get a NULL return_object here, it is a NULL package element,
 966          * and this is always an error.
 967          */
 968         if (!return_object) {
 969                 goto type_error_exit;
 970         }
 971
 972         /* A Namespace node should not get here, but make sure */
 973
 974         if (ACPI_GET_DESCRIPTOR_TYPE(return_object) == ACPI_DESC_TYPE_NAMED) {
 975                 ACPI_WARN_PREDEFINED((AE_INFO, data->pathname, data->node_flags,
 976                                       "Invalid return type - Found a Namespace node [%4.4s] type %s",
 977                                       return_object->node.name.ascii,
 978                                       acpi_ut_get_type_name(return_object->node.
 979                                                             type)));
 980                 return (AE_AML_OPERAND_TYPE);
 981         }
 982
 983         /*
 984          * Convert the object type (ACPI_TYPE_xxx) to a bitmapped object type.
 985          * The bitmapped type allows multiple possible return types.
 986          *
 987          * Note, the cases below must handle all of the possible types returned
 988          * from all of the predefined names (including elements of returned
 989          * packages)
 990          */
 991         switch (return_object->common.type) {
 992         case ACPI_TYPE_INTEGER:
 993                 return_btype = ACPI_RTYPE_INTEGER;
 994                 break;
 995
 996         case ACPI_TYPE_BUFFER:
 997                 return_btype = ACPI_RTYPE_BUFFER;
 998                 break;
 999
1000         case ACPI_TYPE_STRING:
1001                 return_btype = ACPI_RTYPE_STRING;
1002                 break;
1003
1004         case ACPI_TYPE_PACKAGE:
1005                 return_btype = ACPI_RTYPE_PACKAGE;
1006                 break;
1007
1008         case ACPI_TYPE_LOCAL_REFERENCE:
1009                 return_btype = ACPI_RTYPE_REFERENCE;
1010                 break;
1011
1012         default:
1013                 /* Not one of the supported objects, must be incorrect */
1014
1015                 goto type_error_exit;
1016         }
1017
1018         /* Is the object one of the expected types? */
1019
1020         if (!(return_btype & expected_btypes)) {
1021
1022                 /* Type mismatch -- attempt repair of the returned object */
1023
1024                 status = acpi_ns_repair_object(data, expected_btypes,
1025                                                package_index,
1026                                                return_object_ptr);
1027                 if (ACPI_SUCCESS(status)) {
1028                         return (AE_OK); /* Repair was successful */
1029                 }
1030                 goto type_error_exit;
1031         }
1032
1033         /* For reference objects, check that the reference type is correct */
1034
1035         if (return_object->common.type == ACPI_TYPE_LOCAL_REFERENCE) {
1036                 status = acpi_ns_check_reference(data, return_object);
1037         }
1038
1039         return (status);
1040
1041       type_error_exit:
1042
1043         /* Create a string with all expected types for this predefined object */
1044
1045         acpi_ns_get_expected_types(type_buffer, expected_btypes);
1046
1047         if (package_index == ACPI_NOT_PACKAGE_ELEMENT) {
1048                 ACPI_WARN_PREDEFINED((AE_INFO, data->pathname, data->node_flags,
1049                                       "Return type mismatch - found %s, expected %s",
1050                                       acpi_ut_get_object_type_name
1051                                       (return_object), type_buffer));
1052         } else {
1053                 ACPI_WARN_PREDEFINED((AE_INFO, data->pathname, data->node_flags,
1054                                       "Return Package type mismatch at index %u - "
1055                                       "found %s, expected %s", package_index,
1056                                       acpi_ut_get_object_type_name
1057                                       (return_object), type_buffer));
1058         }
1059
1060         return (AE_AML_OPERAND_TYPE);
1061 }
1062
1063 /*******************************************************************************
1064  *
1065  * FUNCTION:    acpi_ns_check_reference
1066  *
1067  * PARAMETERS:  Data            - Pointer to validation data structure
1068  *              return_object   - Object returned from the evaluation of a
1069  *                                method or object
1070  *
1071  * RETURN:      Status
1072  *
1073  * DESCRIPTION: Check a returned reference object for the correct reference
1074  *              type. The only reference type that can be returned from a
1075  *              predefined method is a named reference. All others are invalid.
1076  *
1077  ******************************************************************************/
1078
1079 static acpi_status
1080 acpi_ns_check_reference(struct acpi_predefined_data *data,
1081                         union acpi_operand_object *return_object)
1082 {
1083
1084         /*
1085          * Check the reference object for the correct reference type (opcode).
1086          * The only type of reference that can be converted to an union acpi_object is
1087          * a reference to a named object (reference class: NAME)
1088          */
1089         if (return_object->reference.class == ACPI_REFCLASS_NAME) {
1090                 return (AE_OK);
1091         }
1092
1093         ACPI_WARN_PREDEFINED((AE_INFO, data->pathname, data->node_flags,
1094                               "Return type mismatch - unexpected reference object type [%s] %2.2X",
1095                               acpi_ut_get_reference_name(return_object),
1096                               return_object->reference.class));
1097
1098         return (AE_AML_OPERAND_TYPE);
1099 }
1100
1101 /*******************************************************************************
1102  *
1103  * FUNCTION:    acpi_ns_get_expected_types
1104  *
1105  * PARAMETERS:  Buffer          - Pointer to where the string is returned
1106  *              expected_btypes - Bitmap of expected return type(s)
1107  *
1108  * RETURN:      Buffer is populated with type names.
1109  *
1110  * DESCRIPTION: Translate the expected types bitmap into a string of ascii
1111  *              names of expected types, for use in warning messages.
1112  *
1113  ******************************************************************************/
1114
1115 static void acpi_ns_get_expected_types(char *buffer, u32 expected_btypes)
1116 {
1117         u32 this_rtype;
1118         u32 i;
1119         u32 j;
1120
1121         j = 1;
1122         buffer[0] = 0;
1123         this_rtype = ACPI_RTYPE_INTEGER;
1124
1125         for (i = 0; i < ACPI_NUM_RTYPES; i++) {
1126
1127                 /* If one of the expected types, concatenate the name of this type */
1128
1129                 if (expected_btypes & this_rtype) {
1130                         ACPI_STRCAT(buffer, &acpi_rtype_names[i][j]);
1131                         j = 0;  /* Use name separator from now on */
1132                 }
1133                 this_rtype <<= 1;       /* Next Rtype */
1134         }
1135 }