SAFE public projects git trees. - safe/jmp/linux-2.6/blob - drivers/acpi/resources/rscreate.c

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