sys/contrib/dev/acpica-unix-20050211/include/acresrc.h

   1 /******************************************************************************
   2  *
   3  * Name: acresrc.h - Resource Manager function prototypes
   4  *       $Revision: 39 $
   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
  27  * make derivatives, distribute, use and display any portion of the Covered
  28  * Code in any form, with the right to sublicense such rights; and
  29  *
  30  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  31  * license (with the right to sublicense), under only those claims of Intel
  32  * patents that are infringed by the Original Intel Code, to make, use, sell,
  33  * offer to sell, and import the Covered Code and derivative works thereof
  34  * solely to the minimum extent necessary to exercise the above copyright
  35  * license, and in no event shall the patent license extend to any additions
  36  * to or modifications of the Original Intel Code.  No other license or right
  37  * is granted directly or by implication, estoppel or otherwise;
  38  *
  39  * The above copyright and patent license is granted only if the following
  40  * conditions are met:
  41  *
  42  * 3. Conditions
  43  *
  44  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  45  * Redistribution of source code of any substantial portion of the Covered
  46  * Code or modification with rights to further distribute source must include
  47  * the above Copyright Notice, the above License, this list of Conditions,
  48  * and the following Disclaimer and Export Compliance provision.  In addition,
  49  * Licensee must cause all Covered Code to which Licensee contributes to
  50  * contain a file documenting the changes Licensee made to create that Covered
  51  * Code and the date of any change.  Licensee must include in that file the
  52  * documentation of any changes made by any predecessor Licensee.  Licensee
  53  * must include a prominent statement that the modification is derived,
  54  * directly or indirectly, from Original Intel Code.
  55  *
  56  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  57  * Redistribution of source code of any substantial portion of the Covered
  58  * Code or modification without rights to further distribute source must
  59  * include the following Disclaimer and Export Compliance provision in the
  60  * documentation and/or other materials provided with distribution.  In
  61  * addition, Licensee may not authorize further sublicense of source of any
  62  * portion of the Covered Code, and must include terms to the effect that the
  63  * license from Licensee to its licensee is limited to the intellectual
  64  * property embodied in the software Licensee provides to its licensee, and
  65  * not to intellectual property embodied in modifications its licensee may
  66  * make.
  67  *
  68  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  69  * substantial portion of the Covered Code or modification must reproduce the
  70  * above Copyright Notice, and the following Disclaimer and Export Compliance
  71  * provision in the documentation and/or other materials provided with the
  72  * distribution.
  73  *
  74  * 3.4. Intel retains all right, title, and interest in and to the Original
  75  * Intel Code.
  76  *
  77  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  78  * Intel shall be used in advertising or otherwise to promote the sale, use or
  79  * other dealings in products derived from or relating to the Covered Code
  80  * without prior written authorization from Intel.
  81  *
  82  * 4. Disclaimer and Export Compliance
  83  *
  84  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  85  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  86  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  87  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  88  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  89  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  90  * PARTICULAR PURPOSE.
  91  *
  92  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  93  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  94  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  95  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  96  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  97  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  98  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  99  * LIMITED REMEDY.
 100  *
 101  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 102  * software or system incorporating such software without first obtaining any
 103  * required license or other approval from the U. S. Department of Commerce or
 104  * any other agency or department of the United States Government.  In the
 105  * event Licensee exports any such software from the United States or
 106  * re-exports any such software from a foreign destination, Licensee shall
 107  * ensure that the distribution and export/re-export of the software is in
 108  * compliance with all laws, regulations, orders, or other restrictions of the
 109  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 110  * any of its subsidiaries will export/re-export any technical data, process,
 111  * software, or service, directly or indirectly, to any country for which the
 112  * United States government or any agency thereof requires an export license,
 113  * other governmental approval, or letter of assurance, without first obtaining
 114  * such license, approval or letter.
 115  *
 116  *****************************************************************************/
 117
 118 #ifndef __ACRESRC_H__
 119 #define __ACRESRC_H__
 120
 121
 122 /*
 123  *  Function prototypes called from Acpi* APIs
 124  */
 125
 126 ACPI_STATUS
 127 AcpiRsGetPrtMethodData (
 128     ACPI_HANDLE             Handle,
 129     ACPI_BUFFER             *RetBuffer);
 130
 131
 132 ACPI_STATUS
 133 AcpiRsGetCrsMethodData (
 134     ACPI_HANDLE             Handle,
 135     ACPI_BUFFER             *RetBuffer);
 136
 137 ACPI_STATUS
 138 AcpiRsGetPrsMethodData (
 139     ACPI_HANDLE             Handle,
 140     ACPI_BUFFER             *RetBuffer);
 141
 142 ACPI_STATUS
 143 AcpiRsGetMethodData (
 144     ACPI_HANDLE             Handle,
 145     char                    *Path,
 146     ACPI_BUFFER             *RetBuffer);
 147
 148 ACPI_STATUS
 149 AcpiRsSetSrsMethodData (
 150     ACPI_HANDLE             Handle,
 151     ACPI_BUFFER             *RetBuffer);
 152
 153 ACPI_STATUS
 154 AcpiRsCreateResourceList (
 155     ACPI_OPERAND_OBJECT     *ByteStreamBuffer,
 156     ACPI_BUFFER             *OutputBuffer);
 157
 158 ACPI_STATUS
 159 AcpiRsCreateByteStream (
 160     ACPI_RESOURCE           *LinkedListBuffer,
 161     ACPI_BUFFER             *OutputBuffer);
 162
 163 ACPI_STATUS
 164 AcpiRsCreatePciRoutingTable (
 165     ACPI_OPERAND_OBJECT     *PackageObject,
 166     ACPI_BUFFER             *OutputBuffer);
 167
 168
 169 /*
 170  * Function prototypes called from AcpiRsCreate*
 171  */
 172 void
 173 AcpiRsDumpIrq (
 174     ACPI_RESOURCE_DATA      *Data);
 175
 176 void
 177 AcpiRsDumpAddress16 (
 178     ACPI_RESOURCE_DATA      *Data);
 179
 180 void
 181 AcpiRsDumpAddress32 (
 182     ACPI_RESOURCE_DATA      *Data);
 183
 184 void
 185 AcpiRsDumpAddress64 (
 186     ACPI_RESOURCE_DATA      *Data);
 187
 188 void
 189 AcpiRsDumpDma (
 190     ACPI_RESOURCE_DATA      *Data);
 191
 192 void
 193 AcpiRsDumpIo (
 194     ACPI_RESOURCE_DATA      *Data);
 195
 196 void
 197 AcpiRsDumpExtendedIrq (
 198     ACPI_RESOURCE_DATA      *Data);
 199
 200 void
 201 AcpiRsDumpFixedIo (
 202     ACPI_RESOURCE_DATA      *Data);
 203
 204 void
 205 AcpiRsDumpFixedMemory32 (
 206     ACPI_RESOURCE_DATA      *Data);
 207
 208 void
 209 AcpiRsDumpMemory24 (
 210     ACPI_RESOURCE_DATA      *Data);
 211
 212 void
 213 AcpiRsDumpMemory32 (
 214     ACPI_RESOURCE_DATA      *Data);
 215
 216 void
 217 AcpiRsDumpStartDependFns (
 218     ACPI_RESOURCE_DATA      *Data);
 219
 220 void
 221 AcpiRsDumpVendorSpecific (
 222     ACPI_RESOURCE_DATA      *Data);
 223
 224 void
 225 AcpiRsDumpResourceList (
 226     ACPI_RESOURCE           *Resource);
 227
 228 void
 229 AcpiRsDumpIrqList (
 230     UINT8                   *RouteTable);
 231
 232 ACPI_STATUS
 233 AcpiRsGetByteStreamStart (
 234     UINT8                   *ByteStreamBuffer,
 235     UINT8                   **ByteStreamStart,
 236     UINT32                  *Size);
 237
 238 ACPI_STATUS
 239 AcpiRsGetListLength (
 240     UINT8                   *ByteStreamBuffer,
 241     UINT32                  ByteStreamBufferLength,
 242     ACPI_SIZE               *SizeNeeded);
 243
 244 ACPI_STATUS
 245 AcpiRsGetByteStreamLength (
 246     ACPI_RESOURCE           *LinkedListBuffer,
 247     ACPI_SIZE               *SizeNeeded);
 248
 249 ACPI_STATUS
 250 AcpiRsGetPciRoutingTableLength (
 251     ACPI_OPERAND_OBJECT     *PackageObject,
 252     ACPI_SIZE               *BufferSizeNeeded);
 253
 254 ACPI_STATUS
 255 AcpiRsByteStreamToList (
 256     UINT8                   *ByteStreamBuffer,
 257     UINT32                  ByteStreamBufferLength,
 258     UINT8                   *OutputBuffer);
 259
 260 ACPI_STATUS
 261 AcpiRsListToByteStream (
 262     ACPI_RESOURCE           *LinkedList,
 263     ACPI_SIZE               ByteStreamSizeNeeded,
 264     UINT8                   *OutputBuffer);
 265
 266 ACPI_STATUS
 267 AcpiRsIoResource (
 268     UINT8                   *ByteStreamBuffer,
 269     ACPI_SIZE               *BytesConsumed,
 270     UINT8                   **OutputBuffer,
 271     ACPI_SIZE               *StructureSize);
 272
 273 ACPI_STATUS
 274 AcpiRsFixedIoResource (
 275     UINT8                   *ByteStreamBuffer,
 276     ACPI_SIZE               *BytesConsumed,
 277     UINT8                   **OutputBuffer,
 278     ACPI_SIZE               *StructureSize);
 279
 280 ACPI_STATUS
 281 AcpiRsIoStream (
 282     ACPI_RESOURCE           *LinkedList,
 283     UINT8                   **OutputBuffer,
 284     ACPI_SIZE               *BytesConsumed);
 285
 286 ACPI_STATUS
 287 AcpiRsFixedIoStream (
 288     ACPI_RESOURCE           *LinkedList,
 289     UINT8                   **OutputBuffer,
 290     ACPI_SIZE               *BytesConsumed);
 291
 292 ACPI_STATUS
 293 AcpiRsIrqResource (
 294     UINT8                   *ByteStreamBuffer,
 295     ACPI_SIZE               *BytesConsumed,
 296     UINT8                   **OutputBuffer,
 297     ACPI_SIZE               *StructureSize);
 298
 299 ACPI_STATUS
 300 AcpiRsIrqStream (
 301     ACPI_RESOURCE           *LinkedList,
 302     UINT8                   **OutputBuffer,
 303     ACPI_SIZE               *BytesConsumed);
 304
 305 ACPI_STATUS
 306 AcpiRsDmaResource (
 307     UINT8                   *ByteStreamBuffer,
 308     ACPI_SIZE               *BytesConsumed,
 309     UINT8                   **OutputBuffer,
 310     ACPI_SIZE               *StructureSize);
 311
 312 ACPI_STATUS
 313 AcpiRsDmaStream (
 314     ACPI_RESOURCE           *LinkedList,
 315     UINT8                   **OutputBuffer,
 316     ACPI_SIZE               *BytesConsumed);
 317
 318 ACPI_STATUS
 319 AcpiRsAddress16Resource (
 320     UINT8                   *ByteStreamBuffer,
 321     ACPI_SIZE               *BytesConsumed,
 322     UINT8                   **OutputBuffer,
 323     ACPI_SIZE               *StructureSize);
 324
 325 ACPI_STATUS
 326 AcpiRsAddress16Stream (
 327     ACPI_RESOURCE           *LinkedList,
 328     UINT8                   **OutputBuffer,
 329     ACPI_SIZE               *BytesConsumed);
 330
 331 ACPI_STATUS
 332 AcpiRsAddress32Resource (
 333     UINT8                   *ByteStreamBuffer,
 334     ACPI_SIZE               *BytesConsumed,
 335     UINT8                   **OutputBuffer,
 336     ACPI_SIZE               *StructureSize);
 337
 338 ACPI_STATUS
 339 AcpiRsAddress32Stream (
 340     ACPI_RESOURCE           *LinkedList,
 341     UINT8                   **OutputBuffer,
 342     ACPI_SIZE               *BytesConsumed);
 343
 344 ACPI_STATUS
 345 AcpiRsAddress64Resource (
 346     UINT8                   *ByteStreamBuffer,
 347     ACPI_SIZE               *BytesConsumed,
 348     UINT8                   **OutputBuffer,
 349     ACPI_SIZE               *StructureSize);
 350
 351 ACPI_STATUS
 352 AcpiRsAddress64Stream (
 353     ACPI_RESOURCE           *LinkedList,
 354     UINT8                   **OutputBuffer,
 355     ACPI_SIZE               *BytesConsumed);
 356
 357 ACPI_STATUS
 358 AcpiRsStartDependFnsResource (
 359     UINT8                   *ByteStreamBuffer,
 360     ACPI_SIZE               *BytesConsumed,
 361     UINT8                   **OutputBuffer,
 362     ACPI_SIZE               *StructureSize);
 363
 364 ACPI_STATUS
 365 AcpiRsEndDependFnsResource (
 366     UINT8                   *ByteStreamBuffer,
 367     ACPI_SIZE               *BytesConsumed,
 368     UINT8                   **OutputBuffer,
 369     ACPI_SIZE               *StructureSize);
 370
 371 ACPI_STATUS
 372 AcpiRsStartDependFnsStream (
 373     ACPI_RESOURCE           *LinkedList,
 374     UINT8                   **OutputBuffer,
 375     ACPI_SIZE               *BytesConsumed);
 376
 377 ACPI_STATUS
 378 AcpiRsEndDependFnsStream (
 379     ACPI_RESOURCE           *LinkedList,
 380     UINT8                   **OutputBuffer,
 381     ACPI_SIZE               *BytesConsumed);
 382
 383 ACPI_STATUS
 384 AcpiRsMemory24Resource (
 385     UINT8                   *ByteStreamBuffer,
 386     ACPI_SIZE               *BytesConsumed,
 387     UINT8                   **OutputBuffer,
 388     ACPI_SIZE               *StructureSize);
 389
 390 ACPI_STATUS
 391 AcpiRsMemory24Stream (
 392     ACPI_RESOURCE           *LinkedList,
 393     UINT8                   **OutputBuffer,
 394     ACPI_SIZE               *BytesConsumed);
 395
 396 ACPI_STATUS
 397 AcpiRsMemory32RangeResource (
 398     UINT8                   *ByteStreamBuffer,
 399     ACPI_SIZE               *BytesConsumed,
 400     UINT8                   **OutputBuffer,
 401     ACPI_SIZE               *StructureSize);
 402
 403 ACPI_STATUS
 404 AcpiRsFixedMemory32Resource (
 405     UINT8                   *ByteStreamBuffer,
 406     ACPI_SIZE               *BytesConsumed,
 407     UINT8                   **OutputBuffer,
 408     ACPI_SIZE               *StructureSize);
 409
 410 ACPI_STATUS
 411 AcpiRsMemory32RangeStream (
 412     ACPI_RESOURCE           *LinkedList,
 413     UINT8                   **OutputBuffer,
 414     ACPI_SIZE               *BytesConsumed);
 415
 416 ACPI_STATUS
 417 AcpiRsFixedMemory32Stream (
 418     ACPI_RESOURCE           *LinkedList,
 419     UINT8                   **OutputBuffer,
 420     ACPI_SIZE               *BytesConsumed);
 421
 422 ACPI_STATUS
 423 AcpiRsExtendedIrqResource (
 424     UINT8                   *ByteStreamBuffer,
 425     ACPI_SIZE               *BytesConsumed,
 426     UINT8                   **OutputBuffer,
 427     ACPI_SIZE               *StructureSize);
 428
 429 ACPI_STATUS
 430 AcpiRsExtendedIrqStream (
 431     ACPI_RESOURCE           *LinkedList,
 432     UINT8                   **OutputBuffer,
 433     ACPI_SIZE               *BytesConsumed);
 434
 435 ACPI_STATUS
 436 AcpiRsEndTagResource (
 437     UINT8                   *ByteStreamBuffer,
 438     ACPI_SIZE               *BytesConsumed,
 439     UINT8                   **OutputBuffer,
 440     ACPI_SIZE               *StructureSize);
 441
 442 ACPI_STATUS
 443 AcpiRsEndTagStream (
 444     ACPI_RESOURCE           *LinkedList,
 445     UINT8                   **OutputBuffer,
 446     ACPI_SIZE               *BytesConsumed);
 447
 448 ACPI_STATUS
 449 AcpiRsVendorResource (
 450     UINT8                   *ByteStreamBuffer,
 451     ACPI_SIZE               *BytesConsumed,
 452     UINT8                   **OutputBuffer,
 453     ACPI_SIZE               *StructureSize);
 454
 455 ACPI_STATUS
 456 AcpiRsVendorStream (
 457     ACPI_RESOURCE           *LinkedList,
 458     UINT8                   **OutputBuffer,
 459     ACPI_SIZE               *BytesConsumed);
 460
 461 UINT8
 462 AcpiRsGetResourceType (
 463     UINT8                   ResourceStartByte);
 464
 465 #endif  /* __ACRESRC_H__ */