sys/contrib/dev/acpica/rsxface.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: rsxface - Public interfaces to the resource manager
   4  *              $Revision: 24 $
   5  *
   6  ******************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2003, 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 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/rsxface.c,v 1.1 2003/09/24 03:32:16 drhodus Exp $                                                               */
 117
 118
 119 #define __RSXFACE_C__
 120
 121 #include "acpi.h"
 122 #include "acresrc.h"
 123
 124 #define _COMPONENT          ACPI_RESOURCES
 125         ACPI_MODULE_NAME    ("rsxface")
 126
 127
 128 /*******************************************************************************
 129  *
 130  * FUNCTION:    AcpiGetIrqRoutingTable
 131  *
 132  * PARAMETERS:  DeviceHandle    - a handle to the Bus device we are querying
 133  *              RetBuffer       - a pointer to a buffer to receive the
 134  *                                current resources for the device
 135  *
 136  * RETURN:      Status
 137  *
 138  * DESCRIPTION: This function is called to get the IRQ routing table for a
 139  *              specific bus.  The caller must first acquire a handle for the
 140  *              desired bus.  The routine table is placed in the buffer pointed
 141  *              to by the RetBuffer variable parameter.
 142  *
 143  *              If the function fails an appropriate status will be returned
 144  *              and the value of RetBuffer is undefined.
 145  *
 146  *              This function attempts to execute the _PRT method contained in
 147  *              the object indicated by the passed DeviceHandle.
 148  *
 149  ******************************************************************************/
 150
 151 ACPI_STATUS
 152 AcpiGetIrqRoutingTable  (
 153     ACPI_HANDLE             DeviceHandle,
 154     ACPI_BUFFER             *RetBuffer)
 155 {
 156     ACPI_STATUS             Status;
 157
 158
 159     ACPI_FUNCTION_TRACE ("AcpiGetIrqRoutingTable ");
 160
 161
 162     /*
 163      * Must have a valid handle and buffer, So we have to have a handle
 164      * and a return buffer structure, and if there is a non-zero buffer length
 165      * we also need a valid pointer in the buffer. If it's a zero buffer length,
 166      * we'll be returning the needed buffer size, so keep going.
 167      */
 168     if (!DeviceHandle)
 169     {
 170         return_ACPI_STATUS (AE_BAD_PARAMETER);
 171     }
 172
 173     Status = AcpiUtValidateBuffer (RetBuffer);
 174     if (ACPI_FAILURE (Status))
 175     {
 176         return_ACPI_STATUS (Status);
 177     }
 178
 179     Status = AcpiRsGetPrtMethodData (DeviceHandle, RetBuffer);
 180     return_ACPI_STATUS (Status);
 181 }
 182
 183
 184 /*******************************************************************************
 185  *
 186  * FUNCTION:    AcpiGetCurrentResources
 187  *
 188  * PARAMETERS:  DeviceHandle    - a handle to the device object for the
 189  *                                device we are querying
 190  *              RetBuffer       - a pointer to a buffer to receive the
 191  *                                current resources for the device
 192  *
 193  * RETURN:      Status
 194  *
 195  * DESCRIPTION: This function is called to get the current resources for a
 196  *              specific device.  The caller must first acquire a handle for
 197  *              the desired device.  The resource data is placed in the buffer
 198  *              pointed to by the RetBuffer variable parameter.
 199  *
 200  *              If the function fails an appropriate status will be returned
 201  *              and the value of RetBuffer is undefined.
 202  *
 203  *              This function attempts to execute the _CRS method contained in
 204  *              the object indicated by the passed DeviceHandle.
 205  *
 206  ******************************************************************************/
 207
 208 ACPI_STATUS
 209 AcpiGetCurrentResources (
 210     ACPI_HANDLE             DeviceHandle,
 211     ACPI_BUFFER             *RetBuffer)
 212 {
 213     ACPI_STATUS             Status;
 214
 215
 216     ACPI_FUNCTION_TRACE ("AcpiGetCurrentResources");
 217
 218
 219     /*
 220      * Must have a valid handle and buffer, So we have to have a handle
 221      * and a return buffer structure, and if there is a non-zero buffer length
 222      * we also need a valid pointer in the buffer. If it's a zero buffer length,
 223      * we'll be returning the needed buffer size, so keep going.
 224      */
 225     if (!DeviceHandle)
 226     {
 227         return_ACPI_STATUS (AE_BAD_PARAMETER);
 228     }
 229
 230     Status = AcpiUtValidateBuffer (RetBuffer);
 231     if (ACPI_FAILURE (Status))
 232     {
 233         return_ACPI_STATUS (Status);
 234     }
 235
 236     Status = AcpiRsGetCrsMethodData (DeviceHandle, RetBuffer);
 237     return_ACPI_STATUS (Status);
 238 }
 239
 240
 241 /*******************************************************************************
 242  *
 243  * FUNCTION:    AcpiGetPossibleResources
 244  *
 245  * PARAMETERS:  DeviceHandle    - a handle to the device object for the
 246  *                                device we are querying
 247  *              RetBuffer       - a pointer to a buffer to receive the
 248  *                                resources for the device
 249  *
 250  * RETURN:      Status
 251  *
 252  * DESCRIPTION: This function is called to get a list of the possible resources
 253  *              for a specific device.  The caller must first acquire a handle
 254  *              for the desired device.  The resource data is placed in the
 255  *              buffer pointed to by the RetBuffer variable.
 256  *
 257  *              If the function fails an appropriate status will be returned
 258  *              and the value of RetBuffer is undefined.
 259  *
 260  ******************************************************************************/
 261
 262 ACPI_STATUS
 263 AcpiGetPossibleResources (
 264     ACPI_HANDLE             DeviceHandle,
 265     ACPI_BUFFER             *RetBuffer)
 266 {
 267     ACPI_STATUS             Status;
 268
 269
 270     ACPI_FUNCTION_TRACE ("AcpiGetPossibleResources");
 271
 272
 273     /*
 274      * Must have a valid handle and buffer, So we have to have a handle
 275      * and a return buffer structure, and if there is a non-zero buffer length
 276      * we also need a valid pointer in the buffer. If it's a zero buffer length,
 277      * we'll be returning the needed buffer size, so keep going.
 278      */
 279     if (!DeviceHandle)
 280     {
 281         return_ACPI_STATUS (AE_BAD_PARAMETER);
 282     }
 283
 284     Status = AcpiUtValidateBuffer (RetBuffer);
 285     if (ACPI_FAILURE (Status))
 286     {
 287         return_ACPI_STATUS (Status);
 288     }
 289
 290     Status = AcpiRsGetPrsMethodData (DeviceHandle, RetBuffer);
 291     return_ACPI_STATUS (Status);
 292 }
 293
 294
 295 /*******************************************************************************
 296  *
 297  * FUNCTION:    AcpiWalkResources
 298  *
 299  * PARAMETERS:  DeviceHandle    - a handle to the device object for the
 300  *                                device we are querying
 301  *              Path            - method name of the resources we want
 302  *                                (METHOD_NAME__CRS or METHOD_NAME__PRS)
 303  *              UserFunction    - called for each resource
 304  *              Context         - passed to UserFunction
 305  *
 306  * RETURN:      Status
 307  *
 308  * DESCRIPTION: Retrieves the current or possible resource list for the
 309  *              specified device.  The UserFunction is called once for
 310  *              each resource in the list.
 311  *
 312  ******************************************************************************/
 313
 314 ACPI_STATUS
 315 AcpiWalkResources (
 316     ACPI_HANDLE                     DeviceHandle,
 317     char                            *Path,
 318     ACPI_WALK_RESOURCE_CALLBACK     UserFunction,
 319     void                            *Context)
 320 {
 321     ACPI_STATUS                 Status;
 322     ACPI_BUFFER                 Buffer = {ACPI_ALLOCATE_BUFFER, NULL};
 323     ACPI_RESOURCE               *Resource;
 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     Resource = (ACPI_RESOURCE *) Buffer.Pointer;
 343     for (;;)
 344     {
 345         if (!Resource || Resource->Id == ACPI_RSTYPE_END_TAG)
 346         {
 347             break;
 348         }
 349
 350         Status = UserFunction (Resource, Context);
 351
 352         switch (Status)
 353         {
 354         case AE_OK:
 355         case AE_CTRL_DEPTH:
 356
 357             /* Just keep going */
 358             Status = AE_OK;
 359             break;
 360
 361         case AE_CTRL_TERMINATE:
 362
 363             /* Exit now, with OK stats */
 364
 365             Status = AE_OK;
 366             goto Cleanup;
 367
 368         default:
 369
 370             /* All others are valid exceptions */
 371
 372             goto Cleanup;
 373         }
 374
 375         Resource = ACPI_NEXT_RESOURCE (Resource);
 376     }
 377
 378 Cleanup:
 379
 380     AcpiOsFree (Buffer.Pointer);
 381     return_ACPI_STATUS (Status);
 382 }
 383
 384
 385 /*******************************************************************************
 386  *
 387  * FUNCTION:    AcpiSetCurrentResources
 388  *
 389  * PARAMETERS:  DeviceHandle    - a handle to the device object for the
 390  *                                device we are changing the resources of
 391  *              InBuffer        - a pointer to a buffer containing the
 392  *                                resources to be set for the device
 393  *
 394  * RETURN:      Status
 395  *
 396  * DESCRIPTION: This function is called to set the current resources for a
 397  *              specific device.  The caller must first acquire a handle for
 398  *              the desired device.  The resource data is passed to the routine
 399  *              the buffer pointed to by the InBuffer variable.
 400  *
 401  ******************************************************************************/
 402
 403 ACPI_STATUS
 404 AcpiSetCurrentResources (
 405     ACPI_HANDLE             DeviceHandle,
 406     ACPI_BUFFER             *InBuffer)
 407 {
 408     ACPI_STATUS             Status;
 409
 410
 411     ACPI_FUNCTION_TRACE ("AcpiSetCurrentResources");
 412
 413
 414     /*
 415      * Must have a valid handle and buffer
 416      */
 417     if ((!DeviceHandle)       ||
 418         (!InBuffer)           ||
 419         (!InBuffer->Pointer)  ||
 420         (!InBuffer->Length))
 421     {
 422         return_ACPI_STATUS (AE_BAD_PARAMETER);
 423     }
 424
 425     Status = AcpiRsSetSrsMethodData (DeviceHandle, InBuffer);
 426     return_ACPI_STATUS (Status);
 427 }
 428
 429
 430
 431 #define COPY_FIELD(Out, In, Field)  Out->Field = In->Field
 432 #define COPY_ADDRESS(Out, In)                      \
 433     COPY_FIELD(Out, In, ResourceType);              \
 434     COPY_FIELD(Out, In, ProducerConsumer);          \
 435     COPY_FIELD(Out, In, Decode);                    \
 436     COPY_FIELD(Out, In, MinAddressFixed);           \
 437     COPY_FIELD(Out, In, MaxAddressFixed);           \
 438     COPY_FIELD(Out, In, Attribute);                 \
 439     COPY_FIELD(Out, In, Granularity);               \
 440     COPY_FIELD(Out, In, MinAddressRange);           \
 441     COPY_FIELD(Out, In, MaxAddressRange);           \
 442     COPY_FIELD(Out, In, AddressTranslationOffset);  \
 443     COPY_FIELD(Out, In, AddressLength);             \
 444     COPY_FIELD(Out, In, ResourceSource);
 445
 446 /******************************************************************************
 447  *
 448  * FUNCTION:    AcpiResourceToAddress64
 449  *
 450  * PARAMETERS:  resource                - Pointer to a resource
 451  *              out                     - Pointer to the users's return
 452  *                                        buffer (a struct
 453  *                                        acpi_resource_address64)
 454  *
 455  * RETURN:      Status
 456  *
 457  * DESCRIPTION: If the resource is an address16, address32, or address64,
 458  *              copy it to the address64 return buffer.  This saves the
 459  *              caller from having to duplicate code for different-sized
 460  *              addresses.
 461  *
 462  ******************************************************************************/
 463
 464 ACPI_STATUS
 465 AcpiResourceToAddress64 (
 466     ACPI_RESOURCE               *Resource,
 467     ACPI_RESOURCE_ADDRESS64     *Out)
 468 {
 469     ACPI_RESOURCE_ADDRESS16     *Address16;
 470     ACPI_RESOURCE_ADDRESS32     *Address32;
 471     ACPI_RESOURCE_ADDRESS64     *Address64;
 472
 473
 474     switch (Resource->Id) {
 475     case ACPI_RSTYPE_ADDRESS16:
 476         Address16 = (ACPI_RESOURCE_ADDRESS16 *) &Resource->Data;
 477         COPY_ADDRESS(Out, Address16);
 478         break;
 479
 480     case ACPI_RSTYPE_ADDRESS32:
 481         Address32 = (ACPI_RESOURCE_ADDRESS32 *) &Resource->Data;
 482         COPY_ADDRESS(Out, Address32);
 483         break;
 484
 485     case ACPI_RSTYPE_ADDRESS64:
 486         Address64 = (ACPI_RESOURCE_ADDRESS64 *) &Resource->Data;
 487         COPY_ADDRESS(Out, Address64);
 488         break;
 489
 490     default:
 491         return (AE_BAD_PARAMETER);
 492     }
 493
 494     return (AE_OK);
 495 }