drivers/acpi/resources/rscreate.c

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