drivers/acpi/resources/rscalc.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: rscalc - Calculate stream and list lengths
   4  *
   5  ******************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2005, R. Byron Moore
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions, and the following disclaimer,
  16  *    without modification.
  17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  18  *    substantially similar to the "NO WARRANTY" disclaimer below
  19  *    ("Disclaimer") and any redistribution must be conditioned upon
  20  *    including a substantially similar Disclaimer requirement for further
  21  *    binary redistribution.
  22  * 3. Neither the names of the above-listed copyright holders nor the names
  23  *    of any contributors may be used to endorse or promote products derived
  24  *    from this software without specific prior written permission.
  25  *
  26  * Alternatively, this software may be distributed under the terms of the
  27  * GNU General Public License ("GPL") version 2 as published by the Free
  28  * Software Foundation.
  29  *
  30  * NO WARRANTY
  31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  41  * POSSIBILITY OF SUCH DAMAGES.
  42  */
  43
  44 #include <acpi/acpi.h>
  45 #include <acpi/acresrc.h>
  46 #include <acpi/amlcode.h>
  47 #include <acpi/acnamesp.h>
  48
  49 #define _COMPONENT          ACPI_RESOURCES
  50 ACPI_MODULE_NAME("rscalc")
  51
  52 /* Local prototypes */
  53 static u8 acpi_rs_count_set_bits(u16 bit_field);
  54
  55 static acpi_size
  56 acpi_rs_struct_option_length(struct acpi_resource_source *resource_source);
  57
  58 static u32
  59 acpi_rs_stream_option_length(u32 resource_length, u32 minimum_total_length);
  60
  61 /*******************************************************************************
  62  *
  63  * FUNCTION:    acpi_rs_count_set_bits
  64  *
  65  * PARAMETERS:  bit_field       - Field in which to count bits
  66  *
  67  * RETURN:      Number of bits set within the field
  68  *
  69  * DESCRIPTION: Count the number of bits set in a resource field. Used for
  70  *              (Short descriptor) interrupt and DMA lists.
  71  *
  72  ******************************************************************************/
  73
  74 static u8 acpi_rs_count_set_bits(u16 bit_field)
  75 {
  76         u8 bits_set;
  77
  78         ACPI_FUNCTION_ENTRY();
  79
  80         for (bits_set = 0; bit_field; bits_set++) {
  81                 /* Zero the least significant bit that is set */
  82
  83                 bit_field &= (bit_field - 1);
  84         }
  85
  86         return (bits_set);
  87 }
  88
  89 /*******************************************************************************
  90  *
  91  * FUNCTION:    acpi_rs_struct_option_length
  92  *
  93  * PARAMETERS:  resource_source     - Pointer to optional descriptor field
  94  *
  95  * RETURN:      Status
  96  *
  97  * DESCRIPTION: Common code to handle optional resource_source_index and
  98  *              resource_source fields in some Large descriptors. Used during
  99  *              list-to-stream conversion
 100  *
 101  ******************************************************************************/
 102
 103 static acpi_size
 104 acpi_rs_struct_option_length(struct acpi_resource_source *resource_source)
 105 {
 106         ACPI_FUNCTION_ENTRY();
 107
 108         /*
 109          * If the resource_source string is valid, return the size of the string
 110          * (string_length includes the NULL terminator) plus the size of the
 111          * resource_source_index (1).
 112          */
 113         if (resource_source->string_ptr) {
 114                 return ((acpi_size) resource_source->string_length + 1);
 115         }
 116
 117         return (0);
 118 }
 119
 120 /*******************************************************************************
 121  *
 122  * FUNCTION:    acpi_rs_stream_option_length
 123  *
 124  * PARAMETERS:  resource_length     - Length from the resource header
 125  *              minimum_total_length - Minimum length of this resource, before
 126  *                                    any optional fields. Includes header size
 127  *
 128  * RETURN:      Length of optional string (0 if no string present)
 129  *
 130  * DESCRIPTION: Common code to handle optional resource_source_index and
 131  *              resource_source fields in some Large descriptors. Used during
 132  *              stream-to-list conversion
 133  *
 134  ******************************************************************************/
 135
 136 static u32
 137 acpi_rs_stream_option_length(u32 resource_length,
 138                              u32 minimum_aml_resource_length)
 139 {
 140         u32 string_length = 0;
 141
 142         ACPI_FUNCTION_ENTRY();
 143
 144         /*
 145          * The resource_source_index and resource_source are optional elements of some
 146          * Large-type resource descriptors.
 147          */
 148
 149         /*
 150          * If the length of the actual resource descriptor is greater than the ACPI
 151          * spec-defined minimum length, it means that a resource_source_index exists
 152          * and is followed by a (required) null terminated string. The string length
 153          * (including the null terminator) is the resource length minus the minimum
 154          * length, minus one byte for the resource_source_index itself.
 155          */
 156         if (resource_length > minimum_aml_resource_length) {
 157                 /* Compute the length of the optional string */
 158
 159                 string_length =
 160                     resource_length - minimum_aml_resource_length - 1;
 161         }
 162
 163         /* Round up length to 32 bits for internal structure alignment */
 164
 165         return (ACPI_ROUND_UP_to_32_bITS(string_length));
 166 }
 167
 168 /*******************************************************************************
 169  *
 170  * FUNCTION:    acpi_rs_get_aml_length
 171  *
 172  * PARAMETERS:  Resource            - Pointer to the resource linked list
 173  *              size_needed         - Where the required size is returned
 174  *
 175  * RETURN:      Status
 176  *
 177  * DESCRIPTION: Takes a linked list of internal resource descriptors and
 178  *              calculates the size buffer needed to hold the corresponding
 179  *              external resource byte stream.
 180  *
 181  ******************************************************************************/
 182
 183 acpi_status
 184 acpi_rs_get_aml_length(struct acpi_resource * resource, acpi_size * size_needed)
 185 {
 186         acpi_size aml_size_needed = 0;
 187         acpi_size segment_size;
 188
 189         ACPI_FUNCTION_TRACE("rs_get_aml_length");
 190
 191         /* Traverse entire list of internal resource descriptors */
 192
 193         while (resource) {
 194                 /* Validate the descriptor type */
 195
 196                 if (resource->type > ACPI_RESOURCE_TYPE_MAX) {
 197                         return_ACPI_STATUS(AE_AML_INVALID_RESOURCE_TYPE);
 198                 }
 199
 200                 /* Get the base size of the (external stream) resource descriptor */
 201
 202                 segment_size = acpi_gbl_aml_resource_sizes[resource->type];
 203
 204                 /*
 205                  * Augment the base size for descriptors with optional and/or
 206                  * variable-length fields
 207                  */
 208                 switch (resource->type) {
 209                 case ACPI_RESOURCE_TYPE_VENDOR:
 210                         /*
 211                          * Vendor Defined Resource:
 212                          * For a Vendor Specific resource, if the Length is between 1 and 7
 213                          * it will be created as a Small Resource data type, otherwise it
 214                          * is a Large Resource data type.
 215                          */
 216                         if (resource->data.vendor.byte_length > 7) {
 217                                 /* Base size of a Large resource descriptor */
 218
 219                                 segment_size =
 220                                     sizeof(struct aml_resource_large_header);
 221                         }
 222
 223                         /* Add the size of the vendor-specific data */
 224
 225                         segment_size += resource->data.vendor.byte_length;
 226                         break;
 227
 228                 case ACPI_RESOURCE_TYPE_END_TAG:
 229                         /*
 230                          * End Tag:
 231                          * We are done -- return the accumulated total size.
 232                          */
 233                         *size_needed = aml_size_needed + segment_size;
 234
 235                         /* Normal exit */
 236
 237                         return_ACPI_STATUS(AE_OK);
 238
 239                 case ACPI_RESOURCE_TYPE_ADDRESS16:
 240                         /*
 241                          * 16-Bit Address Resource:
 242                          * Add the size of the optional resource_source info
 243                          */
 244                         segment_size +=
 245                             acpi_rs_struct_option_length(&resource->data.
 246                                                          address16.
 247                                                          resource_source);
 248                         break;
 249
 250                 case ACPI_RESOURCE_TYPE_ADDRESS32:
 251                         /*
 252                          * 32-Bit Address Resource:
 253                          * Add the size of the optional resource_source info
 254                          */
 255                         segment_size +=
 256                             acpi_rs_struct_option_length(&resource->data.
 257                                                          address32.
 258                                                          resource_source);
 259                         break;
 260
 261                 case ACPI_RESOURCE_TYPE_ADDRESS64:
 262                         /*
 263                          * 64-Bit Address Resource:
 264                          * Add the size of the optional resource_source info
 265                          */
 266                         segment_size +=
 267                             acpi_rs_struct_option_length(&resource->data.
 268                                                          address64.
 269                                                          resource_source);
 270                         break;
 271
 272                 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
 273                         /*
 274                          * Extended IRQ Resource:
 275                          * Add the size of each additional optional interrupt beyond the
 276                          * required 1 (4 bytes for each u32 interrupt number)
 277                          */
 278                         segment_size += (((acpi_size)
 279                                           resource->data.extended_irq.
 280                                           interrupt_count - 1) * 4);
 281
 282                         /* Add the size of the optional resource_source info */
 283
 284                         segment_size +=
 285                             acpi_rs_struct_option_length(&resource->data.
 286                                                          extended_irq.
 287                                                          resource_source);
 288                         break;
 289
 290                 default:
 291                         break;
 292                 }
 293
 294                 /* Update the total */
 295
 296                 aml_size_needed += segment_size;
 297
 298                 /* Point to the next object */
 299
 300                 resource = ACPI_PTR_ADD(struct acpi_resource,
 301                                         resource, resource->length);
 302         }
 303
 304         /* Did not find an END_TAG descriptor */
 305
 306         return_ACPI_STATUS(AE_AML_INVALID_RESOURCE_TYPE);
 307 }
 308
 309 /*******************************************************************************
 310  *
 311  * FUNCTION:    acpi_rs_get_list_length
 312  *
 313  * PARAMETERS:  aml_buffer          - Pointer to the resource byte stream
 314  *              aml_buffer_length   - Size of aml_buffer
 315  *              size_needed         - Where the size needed is returned
 316  *
 317  * RETURN:      Status
 318  *
 319  * DESCRIPTION: Takes an external resource byte stream and calculates the size
 320  *              buffer needed to hold the corresponding internal resource
 321  *              descriptor linked list.
 322  *
 323  ******************************************************************************/
 324
 325 acpi_status
 326 acpi_rs_get_list_length(u8 * aml_buffer,
 327                         u32 aml_buffer_length, acpi_size * size_needed)
 328 {
 329         u8 *buffer;
 330         struct acpi_resource_info *resource_info;
 331         u32 buffer_size = 0;
 332         u32 bytes_parsed = 0;
 333         u8 resource_type;
 334         u16 temp16;
 335         u16 resource_length;
 336         u16 header_length;
 337         u32 extra_struct_bytes;
 338
 339         ACPI_FUNCTION_TRACE("rs_get_list_length");
 340
 341         while (bytes_parsed < aml_buffer_length) {
 342                 /* The next byte in the stream is the resource descriptor type */
 343
 344                 resource_type = acpi_rs_get_resource_type(*aml_buffer);
 345
 346                 /* Get the base stream size and structure sizes for the descriptor */
 347
 348                 resource_info = acpi_rs_get_resource_info(resource_type);
 349                 if (!resource_info) {
 350                         return_ACPI_STATUS(AE_AML_INVALID_RESOURCE_TYPE);
 351                 }
 352
 353                 /* Get the Length field from the input resource descriptor */
 354
 355                 resource_length =
 356                     acpi_rs_get_resource_length(ACPI_CAST_PTR
 357                                                 (union aml_resource,
 358                                                  aml_buffer));
 359
 360                 /* Augment the size for descriptors with optional fields */
 361
 362                 extra_struct_bytes = 0;
 363
 364                 if (!(resource_type & ACPI_RESOURCE_NAME_LARGE)) {
 365                         /*
 366                          * Small resource descriptors
 367                          */
 368                         header_length =
 369                             sizeof(struct aml_resource_small_header);
 370                         buffer = aml_buffer + header_length;
 371
 372                         switch (resource_type) {
 373                         case ACPI_RESOURCE_NAME_IRQ:
 374                                 /*
 375                                  * IRQ Resource:
 376                                  * Get the number of bits set in the IRQ word
 377                                  */
 378                                 ACPI_MOVE_16_TO_16(&temp16, buffer);
 379                                 extra_struct_bytes =
 380                                     (acpi_rs_count_set_bits(temp16) *
 381                                      sizeof(u32));
 382                                 break;
 383
 384                         case ACPI_RESOURCE_NAME_DMA:
 385                                 /*
 386                                  * DMA Resource:
 387                                  * Get the number of bits set in the DMA channels byte
 388                                  */
 389                                 ACPI_MOVE_16_TO_16(&temp16, buffer);
 390                                 extra_struct_bytes =
 391                                     (acpi_rs_count_set_bits(temp16) *
 392                                      sizeof(u32));
 393                                 break;
 394
 395                         case ACPI_RESOURCE_NAME_VENDOR_SMALL:
 396                                 /*
 397                                  * Vendor Specific Resource:
 398                                  * Ensure a 32-bit boundary for the structure
 399                                  */
 400                                 extra_struct_bytes =
 401                                     ACPI_ROUND_UP_to_32_bITS(resource_length);
 402                                 break;
 403
 404                         case ACPI_RESOURCE_NAME_END_TAG:
 405                                 /*
 406                                  * End Tag:
 407                                  * Terminate the loop now
 408                                  */
 409                                 aml_buffer_length = bytes_parsed;
 410                                 break;
 411
 412                         default:
 413                                 break;
 414                         }
 415                 } else {
 416                         /*
 417                          * Large resource descriptors
 418                          */
 419                         header_length =
 420                             sizeof(struct aml_resource_large_header);
 421                         buffer = aml_buffer + header_length;
 422
 423                         switch (resource_type) {
 424                         case ACPI_RESOURCE_NAME_VENDOR_LARGE:
 425                                 /*
 426                                  * Vendor Defined Resource:
 427                                  * Add vendor data and ensure a 32-bit boundary for the structure
 428                                  */
 429                                 extra_struct_bytes =
 430                                     ACPI_ROUND_UP_to_32_bITS(resource_length);
 431                                 break;
 432
 433                         case ACPI_RESOURCE_NAME_ADDRESS32:
 434                         case ACPI_RESOURCE_NAME_ADDRESS16:
 435                                 /*
 436                                  * 32-Bit or 16-bit Address Resource:
 437                                  * Add the size of any optional data (resource_source)
 438                                  */
 439                                 extra_struct_bytes =
 440                                     acpi_rs_stream_option_length
 441                                     (resource_length,
 442                                      resource_info->
 443                                      minimum_aml_resource_length);
 444                                 break;
 445
 446                         case ACPI_RESOURCE_NAME_EXTENDED_IRQ:
 447                                 /*
 448                                  * Extended IRQ:
 449                                  * Point past the interrupt_vector_flags to get the
 450                                  * interrupt_table_length.
 451                                  */
 452                                 buffer++;
 453
 454                                 /*
 455                                  * Add 4 bytes for each additional interrupt. Note: at least one
 456                                  * interrupt is required and is included in the minimum
 457                                  * descriptor size
 458                                  */
 459                                 extra_struct_bytes =
 460                                     ((*buffer - 1) * sizeof(u32));
 461
 462                                 /* Add the size of any optional data (resource_source) */
 463
 464                                 extra_struct_bytes +=
 465                                     acpi_rs_stream_option_length(resource_length
 466                                                                  -
 467                                                                  extra_struct_bytes,
 468                                                                  resource_info->
 469                                                                  minimum_aml_resource_length);
 470                                 break;
 471
 472                         case ACPI_RESOURCE_NAME_ADDRESS64:
 473                                 /*
 474                                  * 64-Bit Address Resource:
 475                                  * Add the size of any optional data (resource_source)
 476                                  * Ensure a 64-bit boundary for the structure
 477                                  */
 478                                 extra_struct_bytes =
 479                                     ACPI_ROUND_UP_to_64_bITS
 480                                     (acpi_rs_stream_option_length
 481                                      (resource_length,
 482                                       resource_info->
 483                                       minimum_aml_resource_length));
 484                                 break;
 485
 486                         default:
 487                                 break;
 488                         }
 489                 }
 490
 491                 /* Update the required buffer size for the internal descriptor structs */
 492
 493                 temp16 =
 494                     (u16) (resource_info->minimum_internal_struct_length +
 495                            extra_struct_bytes);
 496                 buffer_size += (u32) ACPI_ALIGN_RESOURCE_SIZE(temp16);
 497
 498                 /*
 499                  * Update byte count and point to the next resource within the stream
 500                  * using the size of the header plus the length contained in the header
 501                  */
 502                 temp16 = (u16) (header_length + resource_length);
 503                 bytes_parsed += temp16;
 504                 aml_buffer += temp16;
 505         }
 506
 507         /* This is the data the caller needs */
 508
 509         *size_needed = buffer_size;
 510         return_ACPI_STATUS(AE_OK);
 511 }
 512
 513 /*******************************************************************************
 514  *
 515  * FUNCTION:    acpi_rs_get_pci_routing_table_length
 516  *
 517  * PARAMETERS:  package_object          - Pointer to the package object
 518  *              buffer_size_needed      - u32 pointer of the size buffer
 519  *                                        needed to properly return the
 520  *                                        parsed data
 521  *
 522  * RETURN:      Status
 523  *
 524  * DESCRIPTION: Given a package representing a PCI routing table, this
 525  *              calculates the size of the corresponding linked list of
 526  *              descriptions.
 527  *
 528  ******************************************************************************/
 529
 530 acpi_status
 531 acpi_rs_get_pci_routing_table_length(union acpi_operand_object *package_object,
 532                                      acpi_size * buffer_size_needed)
 533 {
 534         u32 number_of_elements;
 535         acpi_size temp_size_needed = 0;
 536         union acpi_operand_object **top_object_list;
 537         u32 index;
 538         union acpi_operand_object *package_element;
 539         union acpi_operand_object **sub_object_list;
 540         u8 name_found;
 541         u32 table_index;
 542
 543         ACPI_FUNCTION_TRACE("rs_get_pci_routing_table_length");
 544
 545         number_of_elements = package_object->package.count;
 546
 547         /*
 548          * Calculate the size of the return buffer.
 549          * The base size is the number of elements * the sizes of the
 550          * structures.  Additional space for the strings is added below.
 551          * The minus one is to subtract the size of the u8 Source[1]
 552          * member because it is added below.
 553          *
 554          * But each PRT_ENTRY structure has a pointer to a string and
 555          * the size of that string must be found.
 556          */
 557         top_object_list = package_object->package.elements;
 558
 559         for (index = 0; index < number_of_elements; index++) {
 560                 /* Dereference the sub-package */
 561
 562                 package_element = *top_object_list;
 563
 564                 /*
 565                  * The sub_object_list will now point to an array of the
 566                  * four IRQ elements: Address, Pin, Source and source_index
 567                  */
 568                 sub_object_list = package_element->package.elements;
 569
 570                 /* Scan the irq_table_elements for the Source Name String */
 571
 572                 name_found = FALSE;
 573
 574                 for (table_index = 0; table_index < 4 && !name_found;
 575                      table_index++) {
 576                         if ((ACPI_TYPE_STRING ==
 577                              ACPI_GET_OBJECT_TYPE(*sub_object_list))
 578                             ||
 579                             ((ACPI_TYPE_LOCAL_REFERENCE ==
 580                               ACPI_GET_OBJECT_TYPE(*sub_object_list))
 581                              && ((*sub_object_list)->reference.opcode ==
 582                                  AML_INT_NAMEPATH_OP))) {
 583                                 name_found = TRUE;
 584                         } else {
 585                                 /* Look at the next element */
 586
 587                                 sub_object_list++;
 588                         }
 589                 }
 590
 591                 temp_size_needed += (sizeof(struct acpi_pci_routing_table) - 4);
 592
 593                 /* Was a String type found? */
 594
 595                 if (name_found) {
 596                         if (ACPI_GET_OBJECT_TYPE(*sub_object_list) ==
 597                             ACPI_TYPE_STRING) {
 598                                 /*
 599                                  * The length String.Length field does not include the
 600                                  * terminating NULL, add 1
 601                                  */
 602                                 temp_size_needed += ((acpi_size)
 603                                                      (*sub_object_list)->string.
 604                                                      length + 1);
 605                         } else {
 606                                 temp_size_needed += acpi_ns_get_pathname_length((*sub_object_list)->reference.node);
 607                         }
 608                 } else {
 609                         /*
 610                          * If no name was found, then this is a NULL, which is
 611                          * translated as a u32 zero.
 612                          */
 613                         temp_size_needed += sizeof(u32);
 614                 }
 615
 616                 /* Round up the size since each element must be aligned */
 617
 618                 temp_size_needed = ACPI_ROUND_UP_to_64_bITS(temp_size_needed);
 619
 620                 /* Point to the next union acpi_operand_object */
 621
 622                 top_object_list++;
 623         }
 624
 625         /*
 626          * Adding an extra element to the end of the list, essentially a
 627          * NULL terminator
 628          */
 629         *buffer_size_needed =
 630             temp_size_needed + sizeof(struct acpi_pci_routing_table);
 631         return_ACPI_STATUS(AE_OK);
 632 }