drivers/acpi/acpica/rscreate.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: rscreate - Create resource lists/tables
   4  *
   5  ******************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2011, Intel Corp.
   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 "accommon.h"
  46 #include "acresrc.h"
  47 #include "acnamesp.h"
  48
  49 #define _COMPONENT          ACPI_RESOURCES
  50 ACPI_MODULE_NAME("rscreate")
  51
  52 /*******************************************************************************
  53  *
  54  * FUNCTION:    acpi_rs_create_resource_list
  55  *
  56  * PARAMETERS:  aml_buffer          - Pointer to the resource byte stream
  57  *              output_buffer       - Pointer to the user's buffer
  58  *
  59  * RETURN:      Status: AE_OK if okay, else a valid acpi_status code
  60  *              If output_buffer is not large enough, output_buffer_length
  61  *              indicates how large output_buffer should be, else it
  62  *              indicates how may u8 elements of output_buffer are valid.
  63  *
  64  * DESCRIPTION: Takes the byte stream returned from a _CRS, _PRS control method
  65  *              execution and parses the stream to create a linked list
  66  *              of device resources.
  67  *
  68  ******************************************************************************/
  69
  70 acpi_status
  71 acpi_rs_create_resource_list(union acpi_operand_object *aml_buffer,
  72                              struct acpi_buffer * output_buffer)
  73 {
  74
  75         acpi_status status;
  76         u8 *aml_start;
  77         acpi_size list_size_needed = 0;
  78         u32 aml_buffer_length;
  79         void *resource;
  80
  81         ACPI_FUNCTION_TRACE(rs_create_resource_list);
  82
  83         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "AmlBuffer = %p\n", aml_buffer));
  84
  85         /* Params already validated, so we don't re-validate here */
  86
  87         aml_buffer_length = aml_buffer->buffer.length;
  88         aml_start = aml_buffer->buffer.pointer;
  89
  90         /*
  91          * Pass the aml_buffer into a module that can calculate
  92          * the buffer size needed for the linked list
  93          */
  94         status = acpi_rs_get_list_length(aml_start, aml_buffer_length,
  95                                          &list_size_needed);
  96
  97         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Status=%X ListSizeNeeded=%X\n",
  98                           status, (u32) list_size_needed));
  99         if (ACPI_FAILURE(status)) {
 100                 return_ACPI_STATUS(status);
 101         }
 102
 103         /* Validate/Allocate/Clear caller buffer */
 104
 105         status = acpi_ut_initialize_buffer(output_buffer, list_size_needed);
 106         if (ACPI_FAILURE(status)) {
 107                 return_ACPI_STATUS(status);
 108         }
 109
 110         /* Do the conversion */
 111
 112         resource = output_buffer->pointer;
 113         status = acpi_ut_walk_aml_resources(aml_start, aml_buffer_length,
 114                                             acpi_rs_convert_aml_to_resources,
 115                                             &resource);
 116         if (ACPI_FAILURE(status)) {
 117                 return_ACPI_STATUS(status);
 118         }
 119
 120         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "OutputBuffer %p Length %X\n",
 121                           output_buffer->pointer, (u32) output_buffer->length));
 122         return_ACPI_STATUS(AE_OK);
 123 }
 124
 125 /*******************************************************************************
 126  *
 127  * FUNCTION:    acpi_rs_create_pci_routing_table
 128  *
 129  * PARAMETERS:  package_object          - Pointer to a union acpi_operand_object
 130  *                                        package
 131  *              output_buffer           - Pointer to the user's buffer
 132  *
 133  * RETURN:      Status  AE_OK if okay, else a valid acpi_status code.
 134  *              If the output_buffer is too small, the error will be
 135  *              AE_BUFFER_OVERFLOW and output_buffer->Length will point
 136  *              to the size buffer needed.
 137  *
 138  * DESCRIPTION: Takes the union acpi_operand_object    package and creates a
 139  *              linked list of PCI interrupt descriptions
 140  *
 141  * NOTE: It is the caller's responsibility to ensure that the start of the
 142  * output buffer is aligned properly (if necessary).
 143  *
 144  ******************************************************************************/
 145
 146 acpi_status
 147 acpi_rs_create_pci_routing_table(union acpi_operand_object *package_object,
 148                                  struct acpi_buffer *output_buffer)
 149 {
 150         u8 *buffer;
 151         union acpi_operand_object **top_object_list;
 152         union acpi_operand_object **sub_object_list;
 153         union acpi_operand_object *obj_desc;
 154         acpi_size buffer_size_needed = 0;
 155         u32 number_of_elements;
 156         u32 index;
 157         struct acpi_pci_routing_table *user_prt;
 158         struct acpi_namespace_node *node;
 159         acpi_status status;
 160         struct acpi_buffer path_buffer;
 161
 162         ACPI_FUNCTION_TRACE(rs_create_pci_routing_table);
 163
 164         /* Params already validated, so we don't re-validate here */
 165
 166         /* Get the required buffer length */
 167
 168         status = acpi_rs_get_pci_routing_table_length(package_object,
 169                                                       &buffer_size_needed);
 170         if (ACPI_FAILURE(status)) {
 171                 return_ACPI_STATUS(status);
 172         }
 173
 174         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "BufferSizeNeeded = %X\n",
 175                           (u32) buffer_size_needed));
 176
 177         /* Validate/Allocate/Clear caller buffer */
 178
 179         status = acpi_ut_initialize_buffer(output_buffer, buffer_size_needed);
 180         if (ACPI_FAILURE(status)) {
 181                 return_ACPI_STATUS(status);
 182         }
 183
 184         /*
 185          * Loop through the ACPI_INTERNAL_OBJECTS - Each object should be a
 186          * package that in turn contains an u64 Address, a u8 Pin,
 187          * a Name, and a u8 source_index.
 188          */
 189         top_object_list = package_object->package.elements;
 190         number_of_elements = package_object->package.count;
 191         buffer = output_buffer->pointer;
 192         user_prt = ACPI_CAST_PTR(struct acpi_pci_routing_table, buffer);
 193
 194         for (index = 0; index < number_of_elements; index++) {
 195
 196                 /*
 197                  * Point user_prt past this current structure
 198                  *
 199                  * NOTE: On the first iteration, user_prt->Length will
 200                  * be zero because we cleared the return buffer earlier
 201                  */
 202                 buffer += user_prt->length;
 203                 user_prt = ACPI_CAST_PTR(struct acpi_pci_routing_table, buffer);
 204
 205                 /*
 206                  * Fill in the Length field with the information we have at this point.
 207                  * The minus four is to subtract the size of the u8 Source[4] member
 208                  * because it is added below.
 209                  */
 210                 user_prt->length = (sizeof(struct acpi_pci_routing_table) - 4);
 211
 212                 /* Each element of the top-level package must also be a package */
 213
 214                 if ((*top_object_list)->common.type != ACPI_TYPE_PACKAGE) {
 215                         ACPI_ERROR((AE_INFO,
 216                                     "(PRT[%u]) Need sub-package, found %s",
 217                                     index,
 218                                     acpi_ut_get_object_type_name
 219                                     (*top_object_list)));
 220                         return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
 221                 }
 222
 223                 /* Each sub-package must be of length 4 */
 224
 225                 if ((*top_object_list)->package.count != 4) {
 226                         ACPI_ERROR((AE_INFO,
 227                                     "(PRT[%u]) Need package of length 4, found length %u",
 228                                     index, (*top_object_list)->package.count));
 229                         return_ACPI_STATUS(AE_AML_PACKAGE_LIMIT);
 230                 }
 231
 232                 /*
 233                  * Dereference the sub-package.
 234                  * The sub_object_list will now point to an array of the four IRQ
 235                  * elements: [Address, Pin, Source, source_index]
 236                  */
 237                 sub_object_list = (*top_object_list)->package.elements;
 238
 239                 /* 1) First subobject: Dereference the PRT.Address */
 240
 241                 obj_desc = sub_object_list[0];
 242                 if (obj_desc->common.type != ACPI_TYPE_INTEGER) {
 243                         ACPI_ERROR((AE_INFO,
 244                                     "(PRT[%u].Address) Need Integer, found %s",
 245                                     index,
 246                                     acpi_ut_get_object_type_name(obj_desc)));
 247                         return_ACPI_STATUS(AE_BAD_DATA);
 248                 }
 249
 250                 user_prt->address = obj_desc->integer.value;
 251
 252                 /* 2) Second subobject: Dereference the PRT.Pin */
 253
 254                 obj_desc = sub_object_list[1];
 255                 if (obj_desc->common.type != ACPI_TYPE_INTEGER) {
 256                         ACPI_ERROR((AE_INFO,
 257                                     "(PRT[%u].Pin) Need Integer, found %s",
 258                                     index,
 259                                     acpi_ut_get_object_type_name(obj_desc)));
 260                         return_ACPI_STATUS(AE_BAD_DATA);
 261                 }
 262
 263                 user_prt->pin = (u32) obj_desc->integer.value;
 264
 265                 /*
 266                  * If the BIOS has erroneously reversed the _PRT source_name (index 2)
 267                  * and the source_index (index 3), fix it. _PRT is important enough to
 268                  * workaround this BIOS error. This also provides compatibility with
 269                  * other ACPI implementations.
 270                  */
 271                 obj_desc = sub_object_list[3];
 272                 if (!obj_desc || (obj_desc->common.type != ACPI_TYPE_INTEGER)) {
 273                         sub_object_list[3] = sub_object_list[2];
 274                         sub_object_list[2] = obj_desc;
 275
 276                         ACPI_WARNING((AE_INFO,
 277                                       "(PRT[%X].Source) SourceName and SourceIndex are reversed, fixed",
 278                                       index));
 279                 }
 280
 281                 /*
 282                  * 3) Third subobject: Dereference the PRT.source_name
 283                  * The name may be unresolved (slack mode), so allow a null object
 284                  */
 285                 obj_desc = sub_object_list[2];
 286                 if (obj_desc) {
 287                         switch (obj_desc->common.type) {
 288                         case ACPI_TYPE_LOCAL_REFERENCE:
 289
 290                                 if (obj_desc->reference.class !=
 291                                     ACPI_REFCLASS_NAME) {
 292                                         ACPI_ERROR((AE_INFO,
 293                                                     "(PRT[%u].Source) Need name, found Reference Class 0x%X",
 294                                                     index,
 295                                                     obj_desc->reference.class));
 296                                         return_ACPI_STATUS(AE_BAD_DATA);
 297                                 }
 298
 299                                 node = obj_desc->reference.node;
 300
 301                                 /* Use *remaining* length of the buffer as max for pathname */
 302
 303                                 path_buffer.length = output_buffer->length -
 304                                     (u32) ((u8 *) user_prt->source -
 305                                            (u8 *) output_buffer->pointer);
 306                                 path_buffer.pointer = user_prt->source;
 307
 308                                 status =
 309                                     acpi_ns_handle_to_pathname((acpi_handle)
 310                                                                node,
 311                                                                &path_buffer);
 312
 313                                 /* +1 to include null terminator */
 314
 315                                 user_prt->length +=
 316                                     (u32) ACPI_STRLEN(user_prt->source) + 1;
 317                                 break;
 318
 319                         case ACPI_TYPE_STRING:
 320
 321                                 ACPI_STRCPY(user_prt->source,
 322                                             obj_desc->string.pointer);
 323
 324                                 /*
 325                                  * Add to the Length field the length of the string
 326                                  * (add 1 for terminator)
 327                                  */
 328                                 user_prt->length += obj_desc->string.length + 1;
 329                                 break;
 330
 331                         case ACPI_TYPE_INTEGER:
 332                                 /*
 333                                  * If this is a number, then the Source Name is NULL, since the
 334                                  * entire buffer was zeroed out, we can leave this alone.
 335                                  *
 336                                  * Add to the Length field the length of the u32 NULL
 337                                  */
 338                                 user_prt->length += sizeof(u32);
 339                                 break;
 340
 341                         default:
 342
 343                                 ACPI_ERROR((AE_INFO,
 344                                             "(PRT[%u].Source) Need Ref/String/Integer, found %s",
 345                                             index,
 346                                             acpi_ut_get_object_type_name
 347                                             (obj_desc)));
 348                                 return_ACPI_STATUS(AE_BAD_DATA);
 349                         }
 350                 }
 351
 352                 /* Now align the current length */
 353
 354                 user_prt->length =
 355                     (u32) ACPI_ROUND_UP_TO_64BIT(user_prt->length);
 356
 357                 /* 4) Fourth subobject: Dereference the PRT.source_index */
 358
 359                 obj_desc = sub_object_list[3];
 360                 if (obj_desc->common.type != ACPI_TYPE_INTEGER) {
 361                         ACPI_ERROR((AE_INFO,
 362                                     "(PRT[%u].SourceIndex) Need Integer, found %s",
 363                                     index,
 364                                     acpi_ut_get_object_type_name(obj_desc)));
 365                         return_ACPI_STATUS(AE_BAD_DATA);
 366                 }
 367
 368                 user_prt->source_index = (u32) obj_desc->integer.value;
 369
 370                 /* Point to the next union acpi_operand_object in the top level package */
 371
 372                 top_object_list++;
 373         }
 374
 375         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "OutputBuffer %p Length %X\n",
 376                           output_buffer->pointer, (u32) output_buffer->length));
 377         return_ACPI_STATUS(AE_OK);
 378 }
 379
 380 /*******************************************************************************
 381  *
 382  * FUNCTION:    acpi_rs_create_aml_resources
 383  *
 384  * PARAMETERS:  linked_list_buffer      - Pointer to the resource linked list
 385  *              output_buffer           - Pointer to the user's buffer
 386  *
 387  * RETURN:      Status  AE_OK if okay, else a valid acpi_status code.
 388  *              If the output_buffer is too small, the error will be
 389  *              AE_BUFFER_OVERFLOW and output_buffer->Length will point
 390  *              to the size buffer needed.
 391  *
 392  * DESCRIPTION: Takes the linked list of device resources and
 393  *              creates a bytestream to be used as input for the
 394  *              _SRS control method.
 395  *
 396  ******************************************************************************/
 397
 398 acpi_status
 399 acpi_rs_create_aml_resources(struct acpi_resource *linked_list_buffer,
 400                              struct acpi_buffer *output_buffer)
 401 {
 402         acpi_status status;
 403         acpi_size aml_size_needed = 0;
 404
 405         ACPI_FUNCTION_TRACE(rs_create_aml_resources);
 406
 407         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "LinkedListBuffer = %p\n",
 408                           linked_list_buffer));
 409
 410         /*
 411          * Params already validated, so we don't re-validate here
 412          *
 413          * Pass the linked_list_buffer into a module that calculates
 414          * the buffer size needed for the byte stream.
 415          */
 416         status = acpi_rs_get_aml_length(linked_list_buffer, &aml_size_needed);
 417
 418         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "AmlSizeNeeded=%X, %s\n",
 419                           (u32) aml_size_needed,
 420                           acpi_format_exception(status)));
 421         if (ACPI_FAILURE(status)) {
 422                 return_ACPI_STATUS(status);
 423         }
 424
 425         /* Validate/Allocate/Clear caller buffer */
 426
 427         status = acpi_ut_initialize_buffer(output_buffer, aml_size_needed);
 428         if (ACPI_FAILURE(status)) {
 429                 return_ACPI_STATUS(status);
 430         }
 431
 432         /* Do the conversion */
 433
 434         status =
 435             acpi_rs_convert_resources_to_aml(linked_list_buffer,
 436                                              aml_size_needed,
 437                                              output_buffer->pointer);
 438         if (ACPI_FAILURE(status)) {
 439                 return_ACPI_STATUS(status);
 440         }
 441
 442         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "OutputBuffer %p Length %X\n",
 443                           output_buffer->pointer, (u32) output_buffer->length));
 444         return_ACPI_STATUS(AE_OK);
 445 }