sys/contrib/dev/acpica-unix-20050211/resources/rsxface.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: rsxface - Public interfaces to the resource manager
   4  *              $Revision: 32 $
   5  *
   6  ******************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp.
  13  * All rights reserved.
  14  *
  15  * 2. License
  16  *
  17  * 2.1. This is your license from Intel Corp. under its intellectual property
  18  * rights.  You may have additional license terms from the party that provided
  19  * you this software, covering your right to use that party's intellectual
  20  * property rights.
  21  *
  22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  23  * copy of the source code appearing in this file ("Covered Code") an
  24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  25  * base code distributed originally by Intel ("Original Intel Code") to copy,
  26  * make derivatives, distribute, use and display any portion of the Covered
  27  * Code in any form, with the right to sublicense such rights; and
  28  *
  29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  30  * license (with the right to sublicense), under only those claims of Intel
  31  * patents that are infringed by the Original Intel Code, to make, use, sell,
  32  * offer to sell, and import the Covered Code and derivative works thereof
  33  * solely to the minimum extent necessary to exercise the above copyright
  34  * license, and in no event shall the patent license extend to any additions
  35  * to or modifications of the Original Intel Code.  No other license or right
  36  * is granted directly or by implication, estoppel or otherwise;
  37  *
  38  * The above copyright and patent license is granted only if the following
  39  * conditions are met:
  40  *
  41  * 3. Conditions
  42  *
  43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  44  * Redistribution of source code of any substantial portion of the Covered
  45  * Code or modification with rights to further distribute source must include
  46  * the above Copyright Notice, the above License, this list of Conditions,
  47  * and the following Disclaimer and Export Compliance provision.  In addition,
  48  * Licensee must cause all Covered Code to which Licensee contributes to
  49  * contain a file documenting the changes Licensee made to create that Covered
  50  * Code and the date of any change.  Licensee must include in that file the
  51  * documentation of any changes made by any predecessor Licensee.  Licensee
  52  * must include a prominent statement that the modification is derived,
  53  * directly or indirectly, from Original Intel Code.
  54  *
  55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  56  * Redistribution of source code of any substantial portion of the Covered
  57  * Code or modification without rights to further distribute source must
  58  * include the following Disclaimer and Export Compliance provision in the
  59  * documentation and/or other materials provided with distribution.  In
  60  * addition, Licensee may not authorize further sublicense of source of any
  61  * portion of the Covered Code, and must include terms to the effect that the
  62  * license from Licensee to its licensee is limited to the intellectual
  63  * property embodied in the software Licensee provides to its licensee, and
  64  * not to intellectual property embodied in modifications its licensee may
  65  * make.
  66  *
  67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  68  * substantial portion of the Covered Code or modification must reproduce the
  69  * above Copyright Notice, and the following Disclaimer and Export Compliance
  70  * provision in the documentation and/or other materials provided with the
  71  * distribution.
  72  *
  73  * 3.4. Intel retains all right, title, and interest in and to the Original
  74  * Intel Code.
  75  *
  76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  77  * Intel shall be used in advertising or otherwise to promote the sale, use or
  78  * other dealings in products derived from or relating to the Covered Code
  79  * without prior written authorization from Intel.
  80  *
  81  * 4. Disclaimer and Export Compliance
  82  *
  83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  84  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  86  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  87  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  89  * PARTICULAR PURPOSE.
  90  *
  91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  98  * LIMITED REMEDY.
  99  *
 100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 101  * software or system incorporating such software without first obtaining any
 102  * required license or other approval from the U. S. Department of Commerce or
 103  * any other agency or department of the United States Government.  In the
 104  * event Licensee exports any such software from the United States or
 105  * re-exports any such software from a foreign destination, Licensee shall
 106  * ensure that the distribution and export/re-export of the software is in
 107  * compliance with all laws, regulations, orders, or other restrictions of the
 108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 109  * any of its subsidiaries will export/re-export any technical data, process,
 110  * software, or service, directly or indirectly, to any country for which the
 111  * United States government or any agency thereof requires an export license,
 112  * other governmental approval, or letter of assurance, without first obtaining
 113  * such license, approval or letter.
 114  *
 115  *****************************************************************************/
 116
 117
 118 #define __RSXFACE_C__
 119
 120 #include "acpi.h"
 121 #include "acresrc.h"
 122
 123 #define _COMPONENT          ACPI_RESOURCES
 124         ACPI_MODULE_NAME    ("rsxface")
 125
 126
 127 /*******************************************************************************
 128  *
 129  * FUNCTION:    AcpiGetIrqRoutingTable
 130  *
 131  * PARAMETERS:  DeviceHandle    - a handle to the Bus device we are querying
 132  *              RetBuffer       - a pointer to a buffer to receive the
 133  *                                current resources for the device
 134  *
 135  * RETURN:      Status
 136  *
 137  * DESCRIPTION: This function is called to get the IRQ routing table for a
 138  *              specific bus.  The caller must first acquire a handle for the
 139  *              desired bus.  The routine table is placed in the buffer pointed
 140  *              to by the RetBuffer variable parameter.
 141  *
 142  *              If the function fails an appropriate status will be returned
 143  *              and the value of RetBuffer is undefined.
 144  *
 145  *              This function attempts to execute the _PRT method contained in
 146  *              the object indicated by the passed DeviceHandle.
 147  *
 148  ******************************************************************************/
 149
 150 ACPI_STATUS
 151 AcpiGetIrqRoutingTable  (
 152     ACPI_HANDLE             DeviceHandle,
 153     ACPI_BUFFER             *RetBuffer)
 154 {
 155     ACPI_STATUS             Status;
 156
 157
 158     ACPI_FUNCTION_TRACE ("AcpiGetIrqRoutingTable ");
 159
 160
 161     /*
 162      * Must have a valid handle and buffer, So we have to have a handle
 163      * and a return buffer structure, and if there is a non-zero buffer length
 164      * we also need a valid pointer in the buffer. If it's a zero buffer length,
 165      * we'll be returning the needed buffer size, so keep going.
 166      */
 167     if (!DeviceHandle)
 168     {
 169         return_ACPI_STATUS (AE_BAD_PARAMETER);
 170     }
 171
 172     Status = AcpiUtValidateBuffer (RetBuffer);
 173     if (ACPI_FAILURE (Status))
 174     {
 175         return_ACPI_STATUS (Status);
 176     }
 177
 178     Status = AcpiRsGetPrtMethodData (DeviceHandle, RetBuffer);
 179     return_ACPI_STATUS (Status);
 180 }
 181
 182
 183 /*******************************************************************************
 184  *
 185  * FUNCTION:    AcpiGetCurrentResources
 186  *
 187  * PARAMETERS:  DeviceHandle    - a handle to the device object for the
 188  *                                device we are querying
 189  *              RetBuffer       - a pointer to a buffer to receive the
 190  *                                current resources for the device
 191  *
 192  * RETURN:      Status
 193  *
 194  * DESCRIPTION: This function is called to get the current resources for a
 195  *              specific device.  The caller must first acquire a handle for
 196  *              the desired device.  The resource data is placed in the buffer
 197  *              pointed to by the RetBuffer variable parameter.
 198  *
 199  *              If the function fails an appropriate status will be returned
 200  *              and the value of RetBuffer is undefined.
 201  *
 202  *              This function attempts to execute the _CRS method contained in
 203  *              the object indicated by the passed DeviceHandle.
 204  *
 205  ******************************************************************************/
 206
 207 ACPI_STATUS
 208 AcpiGetCurrentResources (
 209     ACPI_HANDLE             DeviceHandle,
 210     ACPI_BUFFER             *RetBuffer)
 211 {
 212     ACPI_STATUS             Status;
 213
 214
 215     ACPI_FUNCTION_TRACE ("AcpiGetCurrentResources");
 216
 217
 218     /*
 219      * Must have a valid handle and buffer, So we have to have a handle
 220      * and a return buffer structure, and if there is a non-zero buffer length
 221      * we also need a valid pointer in the buffer. If it's a zero buffer length,
 222      * we'll be returning the needed buffer size, so keep going.
 223      */
 224     if (!DeviceHandle)
 225     {
 226         return_ACPI_STATUS (AE_BAD_PARAMETER);
 227     }
 228
 229     Status = AcpiUtValidateBuffer (RetBuffer);
 230     if (ACPI_FAILURE (Status))
 231     {
 232         return_ACPI_STATUS (Status);
 233     }
 234
 235     Status = AcpiRsGetCrsMethodData (DeviceHandle, RetBuffer);
 236     return_ACPI_STATUS (Status);
 237 }
 238
 239
 240 /*******************************************************************************
 241  *
 242  * FUNCTION:    AcpiGetPossibleResources
 243  *
 244  * PARAMETERS:  DeviceHandle    - a handle to the device object for the
 245  *                                device we are querying
 246  *              RetBuffer       - a pointer to a buffer to receive the
 247  *                                resources for the device
 248  *
 249  * RETURN:      Status
 250  *
 251  * DESCRIPTION: This function is called to get a list of the possible resources
 252  *              for a specific device.  The caller must first acquire a handle
 253  *              for the desired device.  The resource data is placed in the
 254  *              buffer pointed to by the RetBuffer variable.
 255  *
 256  *              If the function fails an appropriate status will be returned
 257  *              and the value of RetBuffer is undefined.
 258  *
 259  ******************************************************************************/
 260
 261 ACPI_STATUS
 262 AcpiGetPossibleResources (
 263     ACPI_HANDLE             DeviceHandle,
 264     ACPI_BUFFER             *RetBuffer)
 265 {
 266     ACPI_STATUS             Status;
 267
 268
 269     ACPI_FUNCTION_TRACE ("AcpiGetPossibleResources");
 270
 271
 272     /*
 273      * Must have a valid handle and buffer, So we have to have a handle
 274      * and a return buffer structure, and if there is a non-zero buffer length
 275      * we also need a valid pointer in the buffer. If it's a zero buffer length,
 276      * we'll be returning the needed buffer size, so keep going.
 277      */
 278     if (!DeviceHandle)
 279     {
 280         return_ACPI_STATUS (AE_BAD_PARAMETER);
 281     }
 282
 283     Status = AcpiUtValidateBuffer (RetBuffer);
 284     if (ACPI_FAILURE (Status))
 285     {
 286         return_ACPI_STATUS (Status);
 287     }
 288
 289     Status = AcpiRsGetPrsMethodData (DeviceHandle, RetBuffer);
 290     return_ACPI_STATUS (Status);
 291 }
 292
 293
 294 /*******************************************************************************
 295  *
 296  * FUNCTION:    AcpiWalkResources
 297  *
 298  * PARAMETERS:  DeviceHandle    - a handle to the device object for the
 299  *                                device we are querying
 300  *              Path            - method name of the resources we want
 301  *                                (METHOD_NAME__CRS or METHOD_NAME__PRS)
 302  *              UserFunction    - called for each resource
 303  *              Context         - passed to UserFunction
 304  *
 305  * RETURN:      Status
 306  *
 307  * DESCRIPTION: Retrieves the current or possible resource list for the
 308  *              specified device.  The UserFunction is called once for
 309  *              each resource in the list.
 310  *
 311  ******************************************************************************/
 312
 313 ACPI_STATUS
 314 AcpiWalkResources (
 315     ACPI_HANDLE                     DeviceHandle,
 316     char                            *Path,
 317     ACPI_WALK_RESOURCE_CALLBACK     UserFunction,
 318     void                            *Context)
 319 {
 320     ACPI_STATUS                 Status;
 321     ACPI_BUFFER                 Buffer = {ACPI_ALLOCATE_BUFFER, NULL};
 322     ACPI_RESOURCE               *Resource;
 323     ACPI_RESOURCE               *BufferEnd;
 324
 325
 326     ACPI_FUNCTION_TRACE ("AcpiWalkResources");
 327
 328
 329     if (!DeviceHandle ||
 330         (ACPI_STRNCMP (Path, METHOD_NAME__CRS, sizeof (METHOD_NAME__CRS)) &&
 331          ACPI_STRNCMP (Path, METHOD_NAME__PRS, sizeof (METHOD_NAME__PRS))))
 332     {
 333         return_ACPI_STATUS (AE_BAD_PARAMETER);
 334     }
 335
 336     Status = AcpiRsGetMethodData (DeviceHandle, Path, &Buffer);
 337     if (ACPI_FAILURE (Status))
 338     {
 339         return_ACPI_STATUS (Status);
 340     }
 341
 342     /* Setup pointers */
 343
 344     Resource  = (ACPI_RESOURCE *) Buffer.Pointer;
 345     BufferEnd = ACPI_CAST_PTR (ACPI_RESOURCE,
 346                     ((UINT8 *) Buffer.Pointer + Buffer.Length));
 347
 348     /* Walk the resource list */
 349
 350     for (;;)
 351     {
 352         if (!Resource || Resource->Id == ACPI_RSTYPE_END_TAG)
 353         {
 354             break;
 355         }
 356
 357         Status = UserFunction (Resource, Context);
 358
 359         switch (Status)
 360         {
 361         case AE_OK:
 362         case AE_CTRL_DEPTH:
 363
 364             /* Just keep going */
 365
 366             Status = AE_OK;
 367             break;
 368
 369         case AE_CTRL_TERMINATE:
 370
 371             /* Exit now, with OK stats */
 372
 373             Status = AE_OK;
 374             goto Cleanup;
 375
 376         default:
 377
 378             /* All others are valid exceptions */
 379
 380             goto Cleanup;
 381         }
 382
 383         /* Get the next resource descriptor */
 384
 385         Resource = ACPI_NEXT_RESOURCE (Resource);
 386
 387         /* Check for end-of-buffer */
 388
 389         if (Resource >= BufferEnd)
 390         {
 391             goto Cleanup;
 392         }
 393     }
 394
 395 Cleanup:
 396
 397     AcpiOsFree (Buffer.Pointer);
 398     return_ACPI_STATUS (Status);
 399 }
 400
 401
 402 /*******************************************************************************
 403  *
 404  * FUNCTION:    AcpiSetCurrentResources
 405  *
 406  * PARAMETERS:  DeviceHandle    - a handle to the device object for the
 407  *                                device we are changing the resources of
 408  *              InBuffer        - a pointer to a buffer containing the
 409  *                                resources to be set for the device
 410  *
 411  * RETURN:      Status
 412  *
 413  * DESCRIPTION: This function is called to set the current resources for a
 414  *              specific device.  The caller must first acquire a handle for
 415  *              the desired device.  The resource data is passed to the routine
 416  *              the buffer pointed to by the InBuffer variable.
 417  *
 418  ******************************************************************************/
 419
 420 ACPI_STATUS
 421 AcpiSetCurrentResources (
 422     ACPI_HANDLE             DeviceHandle,
 423     ACPI_BUFFER             *InBuffer)
 424 {
 425     ACPI_STATUS             Status;
 426
 427
 428     ACPI_FUNCTION_TRACE ("AcpiSetCurrentResources");
 429
 430
 431     /*
 432      * Must have a valid handle and buffer
 433      */
 434     if ((!DeviceHandle)       ||
 435         (!InBuffer)           ||
 436         (!InBuffer->Pointer)  ||
 437         (!InBuffer->Length))
 438     {
 439         return_ACPI_STATUS (AE_BAD_PARAMETER);
 440     }
 441
 442     Status = AcpiRsSetSrsMethodData (DeviceHandle, InBuffer);
 443     return_ACPI_STATUS (Status);
 444 }
 445
 446
 447 #define ACPI_COPY_FIELD(Out, In, Field)  ((Out)->Field = (In)->Field)
 448 #define ACPI_COPY_ADDRESS(Out, In)                      \
 449     ACPI_COPY_FIELD(Out, In, ResourceType);              \
 450     ACPI_COPY_FIELD(Out, In, ProducerConsumer);          \
 451     ACPI_COPY_FIELD(Out, In, Decode);                    \
 452     ACPI_COPY_FIELD(Out, In, MinAddressFixed);           \
 453     ACPI_COPY_FIELD(Out, In, MaxAddressFixed);           \
 454     ACPI_COPY_FIELD(Out, In, Attribute);                 \
 455     ACPI_COPY_FIELD(Out, In, Granularity);               \
 456     ACPI_COPY_FIELD(Out, In, MinAddressRange);           \
 457     ACPI_COPY_FIELD(Out, In, MaxAddressRange);           \
 458     ACPI_COPY_FIELD(Out, In, AddressTranslationOffset);  \
 459     ACPI_COPY_FIELD(Out, In, AddressLength);             \
 460     ACPI_COPY_FIELD(Out, In, ResourceSource);
 461
 462 /******************************************************************************
 463  *
 464  * FUNCTION:    AcpiResourceToAddress64
 465  *
 466  * PARAMETERS:  resource                - Pointer to a resource
 467  *              out                     - Pointer to the users's return
 468  *                                        buffer (a struct
 469  *                                        acpi_resource_address64)
 470  *
 471  * RETURN:      Status
 472  *
 473  * DESCRIPTION: If the resource is an address16, address32, or address64,
 474  *              copy it to the address64 return buffer.  This saves the
 475  *              caller from having to duplicate code for different-sized
 476  *              addresses.
 477  *
 478  ******************************************************************************/
 479
 480 ACPI_STATUS
 481 AcpiResourceToAddress64 (
 482     ACPI_RESOURCE               *Resource,
 483     ACPI_RESOURCE_ADDRESS64     *Out)
 484 {
 485     ACPI_RESOURCE_ADDRESS16     *Address16;
 486     ACPI_RESOURCE_ADDRESS32     *Address32;
 487
 488
 489     switch (Resource->Id) {
 490     case ACPI_RSTYPE_ADDRESS16:
 491
 492         Address16 = (ACPI_RESOURCE_ADDRESS16 *) &Resource->Data;
 493         ACPI_COPY_ADDRESS(Out, Address16);
 494         break;
 495
 496
 497     case ACPI_RSTYPE_ADDRESS32:
 498
 499         Address32 = (ACPI_RESOURCE_ADDRESS32 *) &Resource->Data;
 500         ACPI_COPY_ADDRESS(Out, Address32);
 501         break;
 502
 503
 504     case ACPI_RSTYPE_ADDRESS64:
 505
 506         /* Simple copy for 64 bit source */
 507
 508         ACPI_MEMCPY (Out, &Resource->Data, sizeof (ACPI_RESOURCE_ADDRESS64));
 509         break;
 510
 511
 512     default:
 513         return (AE_BAD_PARAMETER);
 514     }
 515
 516     return (AE_OK);
 517 }