drivers/acpi/acpica/nsrepair2.c

   1 /******************************************************************************
   2  *
   3  * Module Name: nsrepair2 - Repair for objects returned by specific
   4  *                          predefined methods
   5  *
   6  *****************************************************************************/
   7
   8 /*
   9  * Copyright (C) 2000 - 2011, 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 #include <acpi/acpi.h>
  46 #include "accommon.h"
  47 #include "acnamesp.h"
  48
  49 #define _COMPONENT          ACPI_NAMESPACE
  50 ACPI_MODULE_NAME("nsrepair2")
  51
  52 /*
  53  * Information structure and handler for ACPI predefined names that can
  54  * be repaired on a per-name basis.
  55  */
  56 typedef
  57 acpi_status(*acpi_repair_function) (struct acpi_predefined_data *data,
  58                                     union acpi_operand_object **return_object_ptr);
  59
  60 typedef struct acpi_repair_info {
  61         char name[ACPI_NAME_SIZE];
  62         acpi_repair_function repair_function;
  63
  64 } acpi_repair_info;
  65
  66 /* Local prototypes */
  67
  68 static const struct acpi_repair_info *acpi_ns_match_repairable_name(struct
  69                                                                     acpi_namespace_node
  70                                                                     *node);
  71
  72 static acpi_status
  73 acpi_ns_repair_ALR(struct acpi_predefined_data *data,
  74                    union acpi_operand_object **return_object_ptr);
  75
  76 static acpi_status
  77 acpi_ns_repair_CID(struct acpi_predefined_data *data,
  78                    union acpi_operand_object **return_object_ptr);
  79
  80 static acpi_status
  81 acpi_ns_repair_FDE(struct acpi_predefined_data *data,
  82                    union acpi_operand_object **return_object_ptr);
  83
  84 static acpi_status
  85 acpi_ns_repair_HID(struct acpi_predefined_data *data,
  86                    union acpi_operand_object **return_object_ptr);
  87
  88 static acpi_status
  89 acpi_ns_repair_PSS(struct acpi_predefined_data *data,
  90                    union acpi_operand_object **return_object_ptr);
  91
  92 static acpi_status
  93 acpi_ns_repair_TSS(struct acpi_predefined_data *data,
  94                    union acpi_operand_object **return_object_ptr);
  95
  96 static acpi_status
  97 acpi_ns_check_sorted_list(struct acpi_predefined_data *data,
  98                           union acpi_operand_object *return_object,
  99                           u32 expected_count,
 100                           u32 sort_index,
 101                           u8 sort_direction, char *sort_key_name);
 102
 103 static void
 104 acpi_ns_sort_list(union acpi_operand_object **elements,
 105                   u32 count, u32 index, u8 sort_direction);
 106
 107 /* Values for sort_direction above */
 108
 109 #define ACPI_SORT_ASCENDING     0
 110 #define ACPI_SORT_DESCENDING    1
 111
 112 /*
 113  * This table contains the names of the predefined methods for which we can
 114  * perform more complex repairs.
 115  *
 116  * As necessary:
 117  *
 118  * _ALR: Sort the list ascending by ambient_illuminance
 119  * _CID: Strings: uppercase all, remove any leading asterisk
 120  * _FDE: Convert Buffer of BYTEs to a Buffer of DWORDs
 121  * _GTM: Convert Buffer of BYTEs to a Buffer of DWORDs
 122  * _HID: Strings: uppercase all, remove any leading asterisk
 123  * _PSS: Sort the list descending by Power
 124  * _TSS: Sort the list descending by Power
 125  *
 126  * Names that must be packages, but cannot be sorted:
 127  *
 128  * _BCL: Values are tied to the Package index where they appear, and cannot
 129  * be moved or sorted. These index values are used for _BQC and _BCM.
 130  * However, we can fix the case where a buffer is returned, by converting
 131  * it to a Package of integers.
 132  */
 133 static const struct acpi_repair_info acpi_ns_repairable_names[] = {
 134         {"_ALR", acpi_ns_repair_ALR},
 135         {"_CID", acpi_ns_repair_CID},
 136         {"_FDE", acpi_ns_repair_FDE},
 137         {"_GTM", acpi_ns_repair_FDE},   /* _GTM has same repair as _FDE */
 138         {"_HID", acpi_ns_repair_HID},
 139         {"_PSS", acpi_ns_repair_PSS},
 140         {"_TSS", acpi_ns_repair_TSS},
 141         {{0, 0, 0, 0}, NULL}    /* Table terminator */
 142 };
 143
 144 #define ACPI_FDE_FIELD_COUNT        5
 145 #define ACPI_FDE_BYTE_BUFFER_SIZE   5
 146 #define ACPI_FDE_DWORD_BUFFER_SIZE  (ACPI_FDE_FIELD_COUNT * sizeof (u32))
 147
 148 /******************************************************************************
 149  *
 150  * FUNCTION:    acpi_ns_complex_repairs
 151  *
 152  * PARAMETERS:  Data                - Pointer to validation data structure
 153  *              Node                - Namespace node for the method/object
 154  *              validate_status     - Original status of earlier validation
 155  *              return_object_ptr   - Pointer to the object returned from the
 156  *                                    evaluation of a method or object
 157  *
 158  * RETURN:      Status. AE_OK if repair was successful. If name is not
 159  *              matched, validate_status is returned.
 160  *
 161  * DESCRIPTION: Attempt to repair/convert a return object of a type that was
 162  *              not expected.
 163  *
 164  *****************************************************************************/
 165
 166 acpi_status
 167 acpi_ns_complex_repairs(struct acpi_predefined_data *data,
 168                         struct acpi_namespace_node *node,
 169                         acpi_status validate_status,
 170                         union acpi_operand_object **return_object_ptr)
 171 {
 172         const struct acpi_repair_info *predefined;
 173         acpi_status status;
 174
 175         /* Check if this name is in the list of repairable names */
 176
 177         predefined = acpi_ns_match_repairable_name(node);
 178         if (!predefined) {
 179                 return (validate_status);
 180         }
 181
 182         status = predefined->repair_function(data, return_object_ptr);
 183         return (status);
 184 }
 185
 186 /******************************************************************************
 187  *
 188  * FUNCTION:    acpi_ns_match_repairable_name
 189  *
 190  * PARAMETERS:  Node                - Namespace node for the method/object
 191  *
 192  * RETURN:      Pointer to entry in repair table. NULL indicates not found.
 193  *
 194  * DESCRIPTION: Check an object name against the repairable object list.
 195  *
 196  *****************************************************************************/
 197
 198 static const struct acpi_repair_info *acpi_ns_match_repairable_name(struct
 199                                                                     acpi_namespace_node
 200                                                                     *node)
 201 {
 202         const struct acpi_repair_info *this_name;
 203
 204         /* Search info table for a repairable predefined method/object name */
 205
 206         this_name = acpi_ns_repairable_names;
 207         while (this_name->repair_function) {
 208                 if (ACPI_COMPARE_NAME(node->name.ascii, this_name->name)) {
 209                         return (this_name);
 210                 }
 211                 this_name++;
 212         }
 213
 214         return (NULL);          /* Not found */
 215 }
 216
 217 /******************************************************************************
 218  *
 219  * FUNCTION:    acpi_ns_repair_ALR
 220  *
 221  * PARAMETERS:  Data                - Pointer to validation data structure
 222  *              return_object_ptr   - Pointer to the object returned from the
 223  *                                    evaluation of a method or object
 224  *
 225  * RETURN:      Status. AE_OK if object is OK or was repaired successfully
 226  *
 227  * DESCRIPTION: Repair for the _ALR object. If necessary, sort the object list
 228  *              ascending by the ambient illuminance values.
 229  *
 230  *****************************************************************************/
 231
 232 static acpi_status
 233 acpi_ns_repair_ALR(struct acpi_predefined_data *data,
 234                    union acpi_operand_object **return_object_ptr)
 235 {
 236         union acpi_operand_object *return_object = *return_object_ptr;
 237         acpi_status status;
 238
 239         status = acpi_ns_check_sorted_list(data, return_object, 2, 1,
 240                                            ACPI_SORT_ASCENDING,
 241                                            "AmbientIlluminance");
 242
 243         return (status);
 244 }
 245
 246 /******************************************************************************
 247  *
 248  * FUNCTION:    acpi_ns_repair_FDE
 249  *
 250  * PARAMETERS:  Data                - Pointer to validation data structure
 251  *              return_object_ptr   - Pointer to the object returned from the
 252  *                                    evaluation of a method or object
 253  *
 254  * RETURN:      Status. AE_OK if object is OK or was repaired successfully
 255  *
 256  * DESCRIPTION: Repair for the _FDE and _GTM objects. The expected return
 257  *              value is a Buffer of 5 DWORDs. This function repairs a common
 258  *              problem where the return value is a Buffer of BYTEs, not
 259  *              DWORDs.
 260  *
 261  *****************************************************************************/
 262
 263 static acpi_status
 264 acpi_ns_repair_FDE(struct acpi_predefined_data *data,
 265                    union acpi_operand_object **return_object_ptr)
 266 {
 267         union acpi_operand_object *return_object = *return_object_ptr;
 268         union acpi_operand_object *buffer_object;
 269         u8 *byte_buffer;
 270         u32 *dword_buffer;
 271         u32 i;
 272
 273         ACPI_FUNCTION_NAME(ns_repair_FDE);
 274
 275         switch (return_object->common.type) {
 276         case ACPI_TYPE_BUFFER:
 277
 278                 /* This is the expected type. Length should be (at least) 5 DWORDs */
 279
 280                 if (return_object->buffer.length >= ACPI_FDE_DWORD_BUFFER_SIZE) {
 281                         return (AE_OK);
 282                 }
 283
 284                 /* We can only repair if we have exactly 5 BYTEs */
 285
 286                 if (return_object->buffer.length != ACPI_FDE_BYTE_BUFFER_SIZE) {
 287                         ACPI_WARN_PREDEFINED((AE_INFO, data->pathname,
 288                                               data->node_flags,
 289                                               "Incorrect return buffer length %u, expected %u",
 290                                               return_object->buffer.length,
 291                                               ACPI_FDE_DWORD_BUFFER_SIZE));
 292
 293                         return (AE_AML_OPERAND_TYPE);
 294                 }
 295
 296                 /* Create the new (larger) buffer object */
 297
 298                 buffer_object =
 299                     acpi_ut_create_buffer_object(ACPI_FDE_DWORD_BUFFER_SIZE);
 300                 if (!buffer_object) {
 301                         return (AE_NO_MEMORY);
 302                 }
 303
 304                 /* Expand each byte to a DWORD */
 305
 306                 byte_buffer = return_object->buffer.pointer;
 307                 dword_buffer =
 308                     ACPI_CAST_PTR(u32, buffer_object->buffer.pointer);
 309
 310                 for (i = 0; i < ACPI_FDE_FIELD_COUNT; i++) {
 311                         *dword_buffer = (u32) *byte_buffer;
 312                         dword_buffer++;
 313                         byte_buffer++;
 314                 }
 315
 316                 ACPI_DEBUG_PRINT((ACPI_DB_REPAIR,
 317                                   "%s Expanded Byte Buffer to expected DWord Buffer\n",
 318                                   data->pathname));
 319                 break;
 320
 321         default:
 322                 return (AE_AML_OPERAND_TYPE);
 323         }
 324
 325         /* Delete the original return object, return the new buffer object */
 326
 327         acpi_ut_remove_reference(return_object);
 328         *return_object_ptr = buffer_object;
 329
 330         data->flags |= ACPI_OBJECT_REPAIRED;
 331         return (AE_OK);
 332 }
 333
 334 /******************************************************************************
 335  *
 336  * FUNCTION:    acpi_ns_repair_CID
 337  *
 338  * PARAMETERS:  Data                - Pointer to validation data structure
 339  *              return_object_ptr   - Pointer to the object returned from the
 340  *                                    evaluation of a method or object
 341  *
 342  * RETURN:      Status. AE_OK if object is OK or was repaired successfully
 343  *
 344  * DESCRIPTION: Repair for the _CID object. If a string, ensure that all
 345  *              letters are uppercase and that there is no leading asterisk.
 346  *              If a Package, ensure same for all string elements.
 347  *
 348  *****************************************************************************/
 349
 350 static acpi_status
 351 acpi_ns_repair_CID(struct acpi_predefined_data *data,
 352                    union acpi_operand_object **return_object_ptr)
 353 {
 354         acpi_status status;
 355         union acpi_operand_object *return_object = *return_object_ptr;
 356         union acpi_operand_object **element_ptr;
 357         union acpi_operand_object *original_element;
 358         u16 original_ref_count;
 359         u32 i;
 360
 361         /* Check for _CID as a simple string */
 362
 363         if (return_object->common.type == ACPI_TYPE_STRING) {
 364                 status = acpi_ns_repair_HID(data, return_object_ptr);
 365                 return (status);
 366         }
 367
 368         /* Exit if not a Package */
 369
 370         if (return_object->common.type != ACPI_TYPE_PACKAGE) {
 371                 return (AE_OK);
 372         }
 373
 374         /* Examine each element of the _CID package */
 375
 376         element_ptr = return_object->package.elements;
 377         for (i = 0; i < return_object->package.count; i++) {
 378                 original_element = *element_ptr;
 379                 original_ref_count = original_element->common.reference_count;
 380
 381                 status = acpi_ns_repair_HID(data, element_ptr);
 382                 if (ACPI_FAILURE(status)) {
 383                         return (status);
 384                 }
 385
 386                 /* Take care with reference counts */
 387
 388                 if (original_element != *element_ptr) {
 389
 390                         /* Element was replaced */
 391
 392                         (*element_ptr)->common.reference_count =
 393                             original_ref_count;
 394
 395                         acpi_ut_remove_reference(original_element);
 396                 }
 397
 398                 element_ptr++;
 399         }
 400
 401         return (AE_OK);
 402 }
 403
 404 /******************************************************************************
 405  *
 406  * FUNCTION:    acpi_ns_repair_HID
 407  *
 408  * PARAMETERS:  Data                - Pointer to validation data structure
 409  *              return_object_ptr   - Pointer to the object returned from the
 410  *                                    evaluation of a method or object
 411  *
 412  * RETURN:      Status. AE_OK if object is OK or was repaired successfully
 413  *
 414  * DESCRIPTION: Repair for the _HID object. If a string, ensure that all
 415  *              letters are uppercase and that there is no leading asterisk.
 416  *
 417  *****************************************************************************/
 418
 419 static acpi_status
 420 acpi_ns_repair_HID(struct acpi_predefined_data *data,
 421                    union acpi_operand_object **return_object_ptr)
 422 {
 423         union acpi_operand_object *return_object = *return_object_ptr;
 424         union acpi_operand_object *new_string;
 425         char *source;
 426         char *dest;
 427
 428         ACPI_FUNCTION_NAME(ns_repair_HID);
 429
 430         /* We only care about string _HID objects (not integers) */
 431
 432         if (return_object->common.type != ACPI_TYPE_STRING) {
 433                 return (AE_OK);
 434         }
 435
 436         if (return_object->string.length == 0) {
 437                 ACPI_WARN_PREDEFINED((AE_INFO, data->pathname, data->node_flags,
 438                                       "Invalid zero-length _HID or _CID string"));
 439
 440                 /* Return AE_OK anyway, let driver handle it */
 441
 442                 data->flags |= ACPI_OBJECT_REPAIRED;
 443                 return (AE_OK);
 444         }
 445
 446         /* It is simplest to always create a new string object */
 447
 448         new_string = acpi_ut_create_string_object(return_object->string.length);
 449         if (!new_string) {
 450                 return (AE_NO_MEMORY);
 451         }
 452
 453         /*
 454          * Remove a leading asterisk if present. For some unknown reason, there
 455          * are many machines in the field that contains IDs like this.
 456          *
 457          * Examples: "*PNP0C03", "*ACPI0003"
 458          */
 459         source = return_object->string.pointer;
 460         if (*source == '*') {
 461                 source++;
 462                 new_string->string.length--;
 463
 464                 ACPI_DEBUG_PRINT((ACPI_DB_REPAIR,
 465                                   "%s: Removed invalid leading asterisk\n",
 466                                   data->pathname));
 467         }
 468
 469         /*
 470          * Copy and uppercase the string. From the ACPI specification:
 471          *
 472          * A valid PNP ID must be of the form "AAA####" where A is an uppercase
 473          * letter and # is a hex digit. A valid ACPI ID must be of the form
 474          * "ACPI####" where # is a hex digit.
 475          */
 476         for (dest = new_string->string.pointer; *source; dest++, source++) {
 477                 *dest = (char)ACPI_TOUPPER(*source);
 478         }
 479
 480         acpi_ut_remove_reference(return_object);
 481         *return_object_ptr = new_string;
 482         return (AE_OK);
 483 }
 484
 485 /******************************************************************************
 486  *
 487  * FUNCTION:    acpi_ns_repair_TSS
 488  *
 489  * PARAMETERS:  Data                - Pointer to validation data structure
 490  *              return_object_ptr   - Pointer to the object returned from the
 491  *                                    evaluation of a method or object
 492  *
 493  * RETURN:      Status. AE_OK if object is OK or was repaired successfully
 494  *
 495  * DESCRIPTION: Repair for the _TSS object. If necessary, sort the object list
 496  *              descending by the power dissipation values.
 497  *
 498  *****************************************************************************/
 499
 500 static acpi_status
 501 acpi_ns_repair_TSS(struct acpi_predefined_data *data,
 502                    union acpi_operand_object **return_object_ptr)
 503 {
 504         union acpi_operand_object *return_object = *return_object_ptr;
 505         acpi_status status;
 506         struct acpi_namespace_node *node;
 507
 508         /*
 509          * We can only sort the _TSS return package if there is no _PSS in the
 510          * same scope. This is because if _PSS is present, the ACPI specification
 511          * dictates that the _TSS Power Dissipation field is to be ignored, and
 512          * therefore some BIOSs leave garbage values in the _TSS Power field(s).
 513          * In this case, it is best to just return the _TSS package as-is.
 514          * (May, 2011)
 515          */
 516         status =
 517             acpi_ns_get_node(data->node, "^_PSS", ACPI_NS_NO_UPSEARCH, &node);
 518         if (ACPI_SUCCESS(status)) {
 519                 return (AE_OK);
 520         }
 521
 522         status = acpi_ns_check_sorted_list(data, return_object, 5, 1,
 523                                            ACPI_SORT_DESCENDING,
 524                                            "PowerDissipation");
 525
 526         return (status);
 527 }
 528
 529 /******************************************************************************
 530  *
 531  * FUNCTION:    acpi_ns_repair_PSS
 532  *
 533  * PARAMETERS:  Data                - Pointer to validation data structure
 534  *              return_object_ptr   - Pointer to the object returned from the
 535  *                                    evaluation of a method or object
 536  *
 537  * RETURN:      Status. AE_OK if object is OK or was repaired successfully
 538  *
 539  * DESCRIPTION: Repair for the _PSS object. If necessary, sort the object list
 540  *              by the CPU frequencies. Check that the power dissipation values
 541  *              are all proportional to CPU frequency (i.e., sorting by
 542  *              frequency should be the same as sorting by power.)
 543  *
 544  *****************************************************************************/
 545
 546 static acpi_status
 547 acpi_ns_repair_PSS(struct acpi_predefined_data *data,
 548                    union acpi_operand_object **return_object_ptr)
 549 {
 550         union acpi_operand_object *return_object = *return_object_ptr;
 551         union acpi_operand_object **outer_elements;
 552         u32 outer_element_count;
 553         union acpi_operand_object **elements;
 554         union acpi_operand_object *obj_desc;
 555         u32 previous_value;
 556         acpi_status status;
 557         u32 i;
 558
 559         /*
 560          * Entries (sub-packages) in the _PSS Package must be sorted by power
 561          * dissipation, in descending order. If it appears that the list is
 562          * incorrectly sorted, sort it. We sort by cpu_frequency, since this
 563          * should be proportional to the power.
 564          */
 565         status = acpi_ns_check_sorted_list(data, return_object, 6, 0,
 566                                            ACPI_SORT_DESCENDING,
 567                                            "CpuFrequency");
 568         if (ACPI_FAILURE(status)) {
 569                 return (status);
 570         }
 571
 572         /*
 573          * We now know the list is correctly sorted by CPU frequency. Check if
 574          * the power dissipation values are proportional.
 575          */
 576         previous_value = ACPI_UINT32_MAX;
 577         outer_elements = return_object->package.elements;
 578         outer_element_count = return_object->package.count;
 579
 580         for (i = 0; i < outer_element_count; i++) {
 581                 elements = (*outer_elements)->package.elements;
 582                 obj_desc = elements[1]; /* Index1 = power_dissipation */
 583
 584                 if ((u32) obj_desc->integer.value > previous_value) {
 585                         ACPI_WARN_PREDEFINED((AE_INFO, data->pathname,
 586                                               data->node_flags,
 587                                               "SubPackage[%u,%u] - suspicious power dissipation values",
 588                                               i - 1, i));
 589                 }
 590
 591                 previous_value = (u32) obj_desc->integer.value;
 592                 outer_elements++;
 593         }
 594
 595         return (AE_OK);
 596 }
 597
 598 /******************************************************************************
 599  *
 600  * FUNCTION:    acpi_ns_check_sorted_list
 601  *
 602  * PARAMETERS:  Data                - Pointer to validation data structure
 603  *              return_object       - Pointer to the top-level returned object
 604  *              expected_count      - Minimum length of each sub-package
 605  *              sort_index          - Sub-package entry to sort on
 606  *              sort_direction      - Ascending or descending
 607  *              sort_key_name       - Name of the sort_index field
 608  *
 609  * RETURN:      Status. AE_OK if the list is valid and is sorted correctly or
 610  *              has been repaired by sorting the list.
 611  *
 612  * DESCRIPTION: Check if the package list is valid and sorted correctly by the
 613  *              sort_index. If not, then sort the list.
 614  *
 615  *****************************************************************************/
 616
 617 static acpi_status
 618 acpi_ns_check_sorted_list(struct acpi_predefined_data *data,
 619                           union acpi_operand_object *return_object,
 620                           u32 expected_count,
 621                           u32 sort_index,
 622                           u8 sort_direction, char *sort_key_name)
 623 {
 624         u32 outer_element_count;
 625         union acpi_operand_object **outer_elements;
 626         union acpi_operand_object **elements;
 627         union acpi_operand_object *obj_desc;
 628         u32 i;
 629         u32 previous_value;
 630
 631         ACPI_FUNCTION_NAME(ns_check_sorted_list);
 632
 633         /* The top-level object must be a package */
 634
 635         if (return_object->common.type != ACPI_TYPE_PACKAGE) {
 636                 return (AE_AML_OPERAND_TYPE);
 637         }
 638
 639         /*
 640          * NOTE: assumes list of sub-packages contains no NULL elements.
 641          * Any NULL elements should have been removed by earlier call
 642          * to acpi_ns_remove_null_elements.
 643          */
 644         outer_elements = return_object->package.elements;
 645         outer_element_count = return_object->package.count;
 646         if (!outer_element_count) {
 647                 return (AE_AML_PACKAGE_LIMIT);
 648         }
 649
 650         previous_value = 0;
 651         if (sort_direction == ACPI_SORT_DESCENDING) {
 652                 previous_value = ACPI_UINT32_MAX;
 653         }
 654
 655         /* Examine each subpackage */
 656
 657         for (i = 0; i < outer_element_count; i++) {
 658
 659                 /* Each element of the top-level package must also be a package */
 660
 661                 if ((*outer_elements)->common.type != ACPI_TYPE_PACKAGE) {
 662                         return (AE_AML_OPERAND_TYPE);
 663                 }
 664
 665                 /* Each sub-package must have the minimum length */
 666
 667                 if ((*outer_elements)->package.count < expected_count) {
 668                         return (AE_AML_PACKAGE_LIMIT);
 669                 }
 670
 671                 elements = (*outer_elements)->package.elements;
 672                 obj_desc = elements[sort_index];
 673
 674                 if (obj_desc->common.type != ACPI_TYPE_INTEGER) {
 675                         return (AE_AML_OPERAND_TYPE);
 676                 }
 677
 678                 /*
 679                  * The list must be sorted in the specified order. If we detect a
 680                  * discrepancy, sort the entire list.
 681                  */
 682                 if (((sort_direction == ACPI_SORT_ASCENDING) &&
 683                      (obj_desc->integer.value < previous_value)) ||
 684                     ((sort_direction == ACPI_SORT_DESCENDING) &&
 685                      (obj_desc->integer.value > previous_value))) {
 686                         acpi_ns_sort_list(return_object->package.elements,
 687                                           outer_element_count, sort_index,
 688                                           sort_direction);
 689
 690                         data->flags |= ACPI_OBJECT_REPAIRED;
 691
 692                         ACPI_DEBUG_PRINT((ACPI_DB_REPAIR,
 693                                           "%s: Repaired unsorted list - now sorted by %s\n",
 694                                           data->pathname, sort_key_name));
 695                         return (AE_OK);
 696                 }
 697
 698                 previous_value = (u32) obj_desc->integer.value;
 699                 outer_elements++;
 700         }
 701
 702         return (AE_OK);
 703 }
 704
 705 /******************************************************************************
 706  *
 707  * FUNCTION:    acpi_ns_sort_list
 708  *
 709  * PARAMETERS:  Elements            - Package object element list
 710  *              Count               - Element count for above
 711  *              Index               - Sort by which package element
 712  *              sort_direction      - Ascending or Descending sort
 713  *
 714  * RETURN:      None
 715  *
 716  * DESCRIPTION: Sort the objects that are in a package element list.
 717  *
 718  * NOTE: Assumes that all NULL elements have been removed from the package,
 719  *       and that all elements have been verified to be of type Integer.
 720  *
 721  *****************************************************************************/
 722
 723 static void
 724 acpi_ns_sort_list(union acpi_operand_object **elements,
 725                   u32 count, u32 index, u8 sort_direction)
 726 {
 727         union acpi_operand_object *obj_desc1;
 728         union acpi_operand_object *obj_desc2;
 729         union acpi_operand_object *temp_obj;
 730         u32 i;
 731         u32 j;
 732
 733         /* Simple bubble sort */
 734
 735         for (i = 1; i < count; i++) {
 736                 for (j = (count - 1); j >= i; j--) {
 737                         obj_desc1 = elements[j - 1]->package.elements[index];
 738                         obj_desc2 = elements[j]->package.elements[index];
 739
 740                         if (((sort_direction == ACPI_SORT_ASCENDING) &&
 741                              (obj_desc1->integer.value >
 742                               obj_desc2->integer.value))
 743                             || ((sort_direction == ACPI_SORT_DESCENDING)
 744                                 && (obj_desc1->integer.value <
 745                                     obj_desc2->integer.value))) {
 746                                 temp_obj = elements[j - 1];
 747                                 elements[j - 1] = elements[j];
 748                                 elements[j] = temp_obj;
 749                         }
 750                 }
 751         }
 752 }