drivers/acpi/resources/rscreate.c

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