drivers/acpi/resources/rscreate.c

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