drivers/acpi/resources/rsxface.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: rsxface - Public interfaces to the resource manager
   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/acnamesp.h>
  47
  48 #define _COMPONENT          ACPI_RESOURCES
  49 ACPI_MODULE_NAME("rsxface")
  50
  51 /* Local macros for 16,32-bit to 64-bit conversion */
  52 #define ACPI_COPY_FIELD(out, in, field)  ((out)->field = (in)->field)
  53 #define ACPI_COPY_ADDRESS(out, in)                      \
  54         ACPI_COPY_FIELD(out, in, resource_type);             \
  55         ACPI_COPY_FIELD(out, in, producer_consumer);         \
  56         ACPI_COPY_FIELD(out, in, decode);                    \
  57         ACPI_COPY_FIELD(out, in, min_address_fixed);         \
  58         ACPI_COPY_FIELD(out, in, max_address_fixed);         \
  59         ACPI_COPY_FIELD(out, in, info);                      \
  60         ACPI_COPY_FIELD(out, in, granularity);               \
  61         ACPI_COPY_FIELD(out, in, minimum);                   \
  62         ACPI_COPY_FIELD(out, in, maximum);                   \
  63         ACPI_COPY_FIELD(out, in, translation_offset);        \
  64         ACPI_COPY_FIELD(out, in, address_length);            \
  65         ACPI_COPY_FIELD(out, in, resource_source);
  66 /* Local prototypes */
  67 static acpi_status
  68 acpi_rs_match_vendor_resource(struct acpi_resource *resource, void *context);
  69
  70 static acpi_status
  71 acpi_rs_validate_parameters(acpi_handle device_handle,
  72                             struct acpi_buffer *buffer,
  73                             struct acpi_namespace_node **return_node);
  74
  75 /*******************************************************************************
  76  *
  77  * FUNCTION:    acpi_rs_validate_parameters
  78  *
  79  * PARAMETERS:  device_handle   - Handle to a device
  80  *              Buffer          - Pointer to a data buffer
  81  *              return_node     - Pointer to where the device node is returned
  82  *
  83  * RETURN:      Status
  84  *
  85  * DESCRIPTION: Common parameter validation for resource interfaces
  86  *
  87  ******************************************************************************/
  88
  89 static acpi_status
  90 acpi_rs_validate_parameters(acpi_handle device_handle,
  91                             struct acpi_buffer *buffer,
  92                             struct acpi_namespace_node **return_node)
  93 {
  94         acpi_status status;
  95         struct acpi_namespace_node *node;
  96
  97         ACPI_FUNCTION_TRACE(rs_validate_parameters);
  98
  99         /*
 100          * Must have a valid handle to an ACPI device
 101          */
 102         if (!device_handle) {
 103                 return_ACPI_STATUS(AE_BAD_PARAMETER);
 104         }
 105
 106         node = acpi_ns_map_handle_to_node(device_handle);
 107         if (!node) {
 108                 return_ACPI_STATUS(AE_BAD_PARAMETER);
 109         }
 110
 111         if (node->type != ACPI_TYPE_DEVICE) {
 112                 return_ACPI_STATUS(AE_TYPE);
 113         }
 114
 115         /*
 116          * Validate the user buffer object
 117          *
 118          * if there is a non-zero buffer length we also need a valid pointer in
 119          * the buffer. If it's a zero buffer length, we'll be returning the
 120          * needed buffer size (later), so keep going.
 121          */
 122         status = acpi_ut_validate_buffer(buffer);
 123         if (ACPI_FAILURE(status)) {
 124                 return_ACPI_STATUS(status);
 125         }
 126
 127         *return_node = node;
 128         return_ACPI_STATUS(AE_OK);
 129 }
 130
 131 /*******************************************************************************
 132  *
 133  * FUNCTION:    acpi_get_irq_routing_table
 134  *
 135  * PARAMETERS:  device_handle   - Handle to the Bus device we are querying
 136  *              ret_buffer      - Pointer to a buffer to receive the
 137  *                                current resources for the device
 138  *
 139  * RETURN:      Status
 140  *
 141  * DESCRIPTION: This function is called to get the IRQ routing table for a
 142  *              specific bus. The caller must first acquire a handle for the
 143  *              desired bus. The routine table is placed in the buffer pointed
 144  *              to by the ret_buffer variable parameter.
 145  *
 146  *              If the function fails an appropriate status will be returned
 147  *              and the value of ret_buffer is undefined.
 148  *
 149  *              This function attempts to execute the _PRT method contained in
 150  *              the object indicated by the passed device_handle.
 151  *
 152  ******************************************************************************/
 153
 154 acpi_status
 155 acpi_get_irq_routing_table(acpi_handle device_handle,
 156                            struct acpi_buffer *ret_buffer)
 157 {
 158         acpi_status status;
 159         struct acpi_namespace_node *node;
 160
 161         ACPI_FUNCTION_TRACE(acpi_get_irq_routing_table);
 162
 163         /* Validate parameters then dispatch to internal routine */
 164
 165         status = acpi_rs_validate_parameters(device_handle, ret_buffer, &node);
 166         if (ACPI_FAILURE(status)) {
 167                 return_ACPI_STATUS(status);
 168         }
 169
 170         status = acpi_rs_get_prt_method_data(node, ret_buffer);
 171         return_ACPI_STATUS(status);
 172 }
 173
 174 ACPI_EXPORT_SYMBOL(acpi_get_irq_routing_table)
 175
 176 /*******************************************************************************
 177  *
 178  * FUNCTION:    acpi_get_current_resources
 179  *
 180  * PARAMETERS:  device_handle   - Handle to the device object for the
 181  *                                device we are querying
 182  *              ret_buffer      - Pointer to a buffer to receive the
 183  *                                current resources for the device
 184  *
 185  * RETURN:      Status
 186  *
 187  * DESCRIPTION: This function is called to get the current resources for a
 188  *              specific device. The caller must first acquire a handle for
 189  *              the desired device. The resource data is placed in the buffer
 190  *              pointed to by the ret_buffer variable parameter.
 191  *
 192  *              If the function fails an appropriate status will be returned
 193  *              and the value of ret_buffer is undefined.
 194  *
 195  *              This function attempts to execute the _CRS method contained in
 196  *              the object indicated by the passed device_handle.
 197  *
 198  ******************************************************************************/
 199 acpi_status
 200 acpi_get_current_resources(acpi_handle device_handle,
 201                            struct acpi_buffer *ret_buffer)
 202 {
 203         acpi_status status;
 204         struct acpi_namespace_node *node;
 205
 206         ACPI_FUNCTION_TRACE(acpi_get_current_resources);
 207
 208         /* Validate parameters then dispatch to internal routine */
 209
 210         status = acpi_rs_validate_parameters(device_handle, ret_buffer, &node);
 211         if (ACPI_FAILURE(status)) {
 212                 return_ACPI_STATUS(status);
 213         }
 214
 215         status = acpi_rs_get_crs_method_data(node, ret_buffer);
 216         return_ACPI_STATUS(status);
 217 }
 218
 219 ACPI_EXPORT_SYMBOL(acpi_get_current_resources)
 220
 221 #ifdef ACPI_FUTURE_USAGE
 222 /*******************************************************************************
 223  *
 224  * FUNCTION:    acpi_get_possible_resources
 225  *
 226  * PARAMETERS:  device_handle   - Handle to the device object for the
 227  *                                device we are querying
 228  *              ret_buffer      - Pointer to a buffer to receive the
 229  *                                resources for the device
 230  *
 231  * RETURN:      Status
 232  *
 233  * DESCRIPTION: This function is called to get a list of the possible resources
 234  *              for a specific device. The caller must first acquire a handle
 235  *              for the desired device. The resource data is placed in the
 236  *              buffer pointed to by the ret_buffer variable.
 237  *
 238  *              If the function fails an appropriate status will be returned
 239  *              and the value of ret_buffer is undefined.
 240  *
 241  ******************************************************************************/
 242 acpi_status
 243 acpi_get_possible_resources(acpi_handle device_handle,
 244                             struct acpi_buffer *ret_buffer)
 245 {
 246         acpi_status status;
 247         struct acpi_namespace_node *node;
 248
 249         ACPI_FUNCTION_TRACE(acpi_get_possible_resources);
 250
 251         /* Validate parameters then dispatch to internal routine */
 252
 253         status = acpi_rs_validate_parameters(device_handle, ret_buffer, &node);
 254         if (ACPI_FAILURE(status)) {
 255                 return_ACPI_STATUS(status);
 256         }
 257
 258         status = acpi_rs_get_prs_method_data(node, ret_buffer);
 259         return_ACPI_STATUS(status);
 260 }
 261
 262 ACPI_EXPORT_SYMBOL(acpi_get_possible_resources)
 263 #endif                          /*  ACPI_FUTURE_USAGE  */
 264
 265 /*******************************************************************************
 266  *
 267  * FUNCTION:    acpi_set_current_resources
 268  *
 269  * PARAMETERS:  device_handle   - Handle to the device object for the
 270  *                                device we are setting resources
 271  *              in_buffer       - Pointer to a buffer containing the
 272  *                                resources to be set for the device
 273  *
 274  * RETURN:      Status
 275  *
 276  * DESCRIPTION: This function is called to set the current resources for a
 277  *              specific device. The caller must first acquire a handle for
 278  *              the desired device. The resource data is passed to the routine
 279  *              the buffer pointed to by the in_buffer variable.
 280  *
 281  ******************************************************************************/
 282 acpi_status
 283 acpi_set_current_resources(acpi_handle device_handle,
 284                            struct acpi_buffer *in_buffer)
 285 {
 286         acpi_status status;
 287         struct acpi_namespace_node *node;
 288
 289         ACPI_FUNCTION_TRACE(acpi_set_current_resources);
 290
 291         /* Validate the buffer, don't allow zero length */
 292
 293         if ((!in_buffer) || (!in_buffer->pointer) || (!in_buffer->length)) {
 294                 return_ACPI_STATUS(AE_BAD_PARAMETER);
 295         }
 296
 297         /* Validate parameters then dispatch to internal routine */
 298
 299         status = acpi_rs_validate_parameters(device_handle, in_buffer, &node);
 300         if (ACPI_FAILURE(status)) {
 301                 return_ACPI_STATUS(status);
 302         }
 303
 304         status = acpi_rs_set_srs_method_data(node, in_buffer);
 305         return_ACPI_STATUS(status);
 306 }
 307
 308 ACPI_EXPORT_SYMBOL(acpi_set_current_resources)
 309
 310 /******************************************************************************
 311  *
 312  * FUNCTION:    acpi_resource_to_address64
 313  *
 314  * PARAMETERS:  Resource        - Pointer to a resource
 315  *              Out             - Pointer to the users's return buffer
 316  *                                (a struct acpi_resource_address64)
 317  *
 318  * RETURN:      Status
 319  *
 320  * DESCRIPTION: If the resource is an address16, address32, or address64,
 321  *              copy it to the address64 return buffer. This saves the
 322  *              caller from having to duplicate code for different-sized
 323  *              addresses.
 324  *
 325  ******************************************************************************/
 326 acpi_status
 327 acpi_resource_to_address64(struct acpi_resource *resource,
 328                            struct acpi_resource_address64 *out)
 329 {
 330         struct acpi_resource_address16 *address16;
 331         struct acpi_resource_address32 *address32;
 332
 333         if (!resource || !out) {
 334                 return (AE_BAD_PARAMETER);
 335         }
 336
 337         /* Convert 16 or 32 address descriptor to 64 */
 338
 339         switch (resource->type) {
 340         case ACPI_RESOURCE_TYPE_ADDRESS16:
 341
 342                 address16 = (struct acpi_resource_address16 *)&resource->data;
 343                 ACPI_COPY_ADDRESS(out, address16);
 344                 break;
 345
 346         case ACPI_RESOURCE_TYPE_ADDRESS32:
 347
 348                 address32 = (struct acpi_resource_address32 *)&resource->data;
 349                 ACPI_COPY_ADDRESS(out, address32);
 350                 break;
 351
 352         case ACPI_RESOURCE_TYPE_ADDRESS64:
 353
 354                 /* Simple copy for 64 bit source */
 355
 356                 ACPI_MEMCPY(out, &resource->data,
 357                             sizeof(struct acpi_resource_address64));
 358                 break;
 359
 360         default:
 361                 return (AE_BAD_PARAMETER);
 362         }
 363
 364         return (AE_OK);
 365 }
 366
 367 ACPI_EXPORT_SYMBOL(acpi_resource_to_address64)
 368
 369 /*******************************************************************************
 370  *
 371  * FUNCTION:    acpi_get_vendor_resource
 372  *
 373  * PARAMETERS:  device_handle   - Handle for the parent device object
 374  *              Name            - Method name for the parent resource
 375  *                                (METHOD_NAME__CRS or METHOD_NAME__PRS)
 376  *              Uuid            - Pointer to the UUID to be matched.
 377  *                                includes both subtype and 16-byte UUID
 378  *              ret_buffer      - Where the vendor resource is returned
 379  *
 380  * RETURN:      Status
 381  *
 382  * DESCRIPTION: Walk a resource template for the specified evice to find a
 383  *              vendor-defined resource that matches the supplied UUID and
 384  *              UUID subtype. Returns a struct acpi_resource of type Vendor.
 385  *
 386  ******************************************************************************/
 387 acpi_status
 388 acpi_get_vendor_resource(acpi_handle device_handle,
 389                          char *name,
 390                          struct acpi_vendor_uuid * uuid,
 391                          struct acpi_buffer * ret_buffer)
 392 {
 393         struct acpi_vendor_walk_info info;
 394         acpi_status status;
 395
 396         /* Other parameters are validated by acpi_walk_resources */
 397
 398         if (!uuid || !ret_buffer) {
 399                 return (AE_BAD_PARAMETER);
 400         }
 401
 402         info.uuid = uuid;
 403         info.buffer = ret_buffer;
 404         info.status = AE_NOT_EXIST;
 405
 406         /* Walk the _CRS or _PRS resource list for this device */
 407
 408         status =
 409             acpi_walk_resources(device_handle, name,
 410                                 acpi_rs_match_vendor_resource, &info);
 411         if (ACPI_FAILURE(status)) {
 412                 return (status);
 413         }
 414
 415         return (info.status);
 416 }
 417
 418 ACPI_EXPORT_SYMBOL(acpi_get_vendor_resource)
 419
 420 /*******************************************************************************
 421  *
 422  * FUNCTION:    acpi_rs_match_vendor_resource
 423  *
 424  * PARAMETERS:  acpi_walk_resource_callback
 425  *
 426  * RETURN:      Status
 427  *
 428  * DESCRIPTION: Match a vendor resource via the ACPI 3.0 UUID
 429  *
 430  ******************************************************************************/
 431 static acpi_status
 432 acpi_rs_match_vendor_resource(struct acpi_resource *resource, void *context)
 433 {
 434         struct acpi_vendor_walk_info *info = context;
 435         struct acpi_resource_vendor_typed *vendor;
 436         struct acpi_buffer *buffer;
 437         acpi_status status;
 438
 439         /* Ignore all descriptors except Vendor */
 440
 441         if (resource->type != ACPI_RESOURCE_TYPE_VENDOR) {
 442                 return (AE_OK);
 443         }
 444
 445         vendor = &resource->data.vendor_typed;
 446
 447         /*
 448          * For a valid match, these conditions must hold:
 449          *
 450          * 1) Length of descriptor data must be at least as long as a UUID struct
 451          * 2) The UUID subtypes must match
 452          * 3) The UUID data must match
 453          */
 454         if ((vendor->byte_length < (ACPI_UUID_LENGTH + 1)) ||
 455             (vendor->uuid_subtype != info->uuid->subtype) ||
 456             (ACPI_MEMCMP(vendor->uuid, info->uuid->data, ACPI_UUID_LENGTH))) {
 457                 return (AE_OK);
 458         }
 459
 460         /* Validate/Allocate/Clear caller buffer */
 461
 462         buffer = info->buffer;
 463         status = acpi_ut_initialize_buffer(buffer, resource->length);
 464         if (ACPI_FAILURE(status)) {
 465                 return (status);
 466         }
 467
 468         /* Found the correct resource, copy and return it */
 469
 470         ACPI_MEMCPY(buffer->pointer, resource, resource->length);
 471         buffer->length = resource->length;
 472
 473         /* Found the desired descriptor, terminate resource walk */
 474
 475         info->status = AE_OK;
 476         return (AE_CTRL_TERMINATE);
 477 }
 478
 479 ACPI_EXPORT_SYMBOL(acpi_rs_match_vendor_resource)
 480
 481 /*******************************************************************************
 482  *
 483  * FUNCTION:    acpi_walk_resources
 484  *
 485  * PARAMETERS:  device_handle   - Handle to the device object for the
 486  *                                device we are querying
 487  *              Name            - Method name of the resources we want
 488  *                                (METHOD_NAME__CRS or METHOD_NAME__PRS)
 489  *              user_function   - Called for each resource
 490  *              Context         - Passed to user_function
 491  *
 492  * RETURN:      Status
 493  *
 494  * DESCRIPTION: Retrieves the current or possible resource list for the
 495  *              specified device. The user_function is called once for
 496  *              each resource in the list.
 497  *
 498  ******************************************************************************/
 499
 500 acpi_status
 501 acpi_walk_resources(acpi_handle device_handle,
 502                     char *name,
 503                     acpi_walk_resource_callback user_function, void *context)
 504 {
 505         acpi_status status;
 506         struct acpi_buffer buffer;
 507         struct acpi_resource *resource;
 508         struct acpi_resource *resource_end;
 509
 510         ACPI_FUNCTION_TRACE(acpi_walk_resources);
 511
 512         /* Parameter validation */
 513
 514         if (!device_handle || !user_function || !name ||
 515             (!ACPI_COMPARE_NAME(name, METHOD_NAME__CRS) &&
 516              !ACPI_COMPARE_NAME(name, METHOD_NAME__PRS))) {
 517                 return_ACPI_STATUS(AE_BAD_PARAMETER);
 518         }
 519
 520         /* Get the _CRS or _PRS resource list */
 521
 522         buffer.length = ACPI_ALLOCATE_LOCAL_BUFFER;
 523         status = acpi_rs_get_method_data(device_handle, name, &buffer);
 524         if (ACPI_FAILURE(status)) {
 525                 return_ACPI_STATUS(status);
 526         }
 527
 528         /* Buffer now contains the resource list */
 529
 530         resource = ACPI_CAST_PTR(struct acpi_resource, buffer.pointer);
 531         resource_end =
 532             ACPI_ADD_PTR(struct acpi_resource, buffer.pointer, buffer.length);
 533
 534         /* Walk the resource list until the end_tag is found (or buffer end) */
 535
 536         while (resource < resource_end) {
 537
 538                 /* Sanity check the resource */
 539
 540                 if (resource->type > ACPI_RESOURCE_TYPE_MAX) {
 541                         status = AE_AML_INVALID_RESOURCE_TYPE;
 542                         break;
 543                 }
 544
 545                 /* Invoke the user function, abort on any error returned */
 546
 547                 status = user_function(resource, context);
 548                 if (ACPI_FAILURE(status)) {
 549                         if (status == AE_CTRL_TERMINATE) {
 550
 551                                 /* This is an OK termination by the user function */
 552
 553                                 status = AE_OK;
 554                         }
 555                         break;
 556                 }
 557
 558                 /* end_tag indicates end-of-list */
 559
 560                 if (resource->type == ACPI_RESOURCE_TYPE_END_TAG) {
 561                         break;
 562                 }
 563
 564                 /* Get the next resource descriptor */
 565
 566                 resource =
 567                     ACPI_ADD_PTR(struct acpi_resource, resource,
 568                                  resource->length);
 569         }
 570
 571         ACPI_FREE(buffer.pointer);
 572         return_ACPI_STATUS(status);
 573 }
 574
 575 ACPI_EXPORT_SYMBOL(acpi_walk_resources)