sys/contrib/dev/acpica/acresrc.h

   1 /******************************************************************************
   2  *
   3  * Name: acresrc.h - Resource Manager function prototypes
   4  *       $Revision: 37 $
   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
  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 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/acresrc.h,v 1.1 2003/09/24 03:32:15 drhodus Exp $                                                               */
 118
 119 #ifndef __ACRESRC_H__
 120 #define __ACRESRC_H__
 121
 122
 123 /*
 124  *  Function prototypes called from Acpi* APIs
 125  */
 126
 127 ACPI_STATUS
 128 AcpiRsGetPrtMethodData (
 129     ACPI_HANDLE             Handle,
 130     ACPI_BUFFER             *RetBuffer);
 131
 132
 133 ACPI_STATUS
 134 AcpiRsGetCrsMethodData (
 135     ACPI_HANDLE             Handle,
 136     ACPI_BUFFER             *RetBuffer);
 137
 138 ACPI_STATUS
 139 AcpiRsGetPrsMethodData (
 140     ACPI_HANDLE             Handle,
 141     ACPI_BUFFER             *RetBuffer);
 142
 143 ACPI_STATUS
 144 AcpiRsGetMethodData (
 145     ACPI_HANDLE             Handle,
 146     char                    *Path,
 147     ACPI_BUFFER             *RetBuffer);
 148
 149 ACPI_STATUS
 150 AcpiRsSetSrsMethodData (
 151     ACPI_HANDLE             Handle,
 152     ACPI_BUFFER             *RetBuffer);
 153
 154 ACPI_STATUS
 155 AcpiRsCreateResourceList (
 156     ACPI_OPERAND_OBJECT     *ByteStreamBuffer,
 157     ACPI_BUFFER             *OutputBuffer);
 158
 159 ACPI_STATUS
 160 AcpiRsCreateByteStream (
 161     ACPI_RESOURCE           *LinkedListBuffer,
 162     ACPI_BUFFER             *OutputBuffer);
 163
 164 ACPI_STATUS
 165 AcpiRsCreatePciRoutingTable (
 166     ACPI_OPERAND_OBJECT     *PackageObject,
 167     ACPI_BUFFER             *OutputBuffer);
 168
 169
 170 /*
 171  * Function prototypes called from AcpiRsCreate*
 172  */
 173 void
 174 AcpiRsDumpIrq (
 175     ACPI_RESOURCE_DATA      *Data);
 176
 177 void
 178 AcpiRsDumpAddress16 (
 179     ACPI_RESOURCE_DATA      *Data);
 180
 181 void
 182 AcpiRsDumpAddress32 (
 183     ACPI_RESOURCE_DATA      *Data);
 184
 185 void
 186 AcpiRsDumpAddress64 (
 187     ACPI_RESOURCE_DATA      *Data);
 188
 189 void
 190 AcpiRsDumpDma (
 191     ACPI_RESOURCE_DATA      *Data);
 192
 193 void
 194 AcpiRsDumpIo (
 195     ACPI_RESOURCE_DATA      *Data);
 196
 197 void
 198 AcpiRsDumpExtendedIrq (
 199     ACPI_RESOURCE_DATA      *Data);
 200
 201 void
 202 AcpiRsDumpFixedIo (
 203     ACPI_RESOURCE_DATA      *Data);
 204
 205 void
 206 AcpiRsDumpFixedMemory32 (
 207     ACPI_RESOURCE_DATA      *Data);
 208
 209 void
 210 AcpiRsDumpMemory24 (
 211     ACPI_RESOURCE_DATA      *Data);
 212
 213 void
 214 AcpiRsDumpMemory32 (
 215     ACPI_RESOURCE_DATA      *Data);
 216
 217 void
 218 AcpiRsDumpStartDependFns (
 219     ACPI_RESOURCE_DATA      *Data);
 220
 221 void
 222 AcpiRsDumpVendorSpecific (
 223     ACPI_RESOURCE_DATA      *Data);
 224
 225 void
 226 AcpiRsDumpResourceList (
 227     ACPI_RESOURCE           *Resource);
 228
 229 void
 230 AcpiRsDumpIrqList (
 231     UINT8                   *RouteTable);
 232
 233 ACPI_STATUS
 234 AcpiRsGetByteStreamStart (
 235     UINT8                   *ByteStreamBuffer,
 236     UINT8                   **ByteStreamStart,
 237     UINT32                  *Size);
 238
 239 ACPI_STATUS
 240 AcpiRsGetListLength (
 241     UINT8                   *ByteStreamBuffer,
 242     UINT32                  ByteStreamBufferLength,
 243     ACPI_SIZE               *SizeNeeded);
 244
 245 ACPI_STATUS
 246 AcpiRsGetByteStreamLength (
 247     ACPI_RESOURCE           *LinkedListBuffer,
 248     ACPI_SIZE               *SizeNeeded);
 249
 250 ACPI_STATUS
 251 AcpiRsGetPciRoutingTableLength (
 252     ACPI_OPERAND_OBJECT     *PackageObject,
 253     ACPI_SIZE               *BufferSizeNeeded);
 254
 255 ACPI_STATUS
 256 AcpiRsByteStreamToList (
 257     UINT8                   *ByteStreamBuffer,
 258     UINT32                  ByteStreamBufferLength,
 259     UINT8                   *OutputBuffer);
 260
 261 ACPI_STATUS
 262 AcpiRsListToByteStream (
 263     ACPI_RESOURCE           *LinkedList,
 264     ACPI_SIZE               ByteStreamSizeNeeded,
 265     UINT8                   *OutputBuffer);
 266
 267 ACPI_STATUS
 268 AcpiRsIoResource (
 269     UINT8                   *ByteStreamBuffer,
 270     ACPI_SIZE               *BytesConsumed,
 271     UINT8                   **OutputBuffer,
 272     ACPI_SIZE               *StructureSize);
 273
 274 ACPI_STATUS
 275 AcpiRsFixedIoResource (
 276     UINT8                   *ByteStreamBuffer,
 277     ACPI_SIZE               *BytesConsumed,
 278     UINT8                   **OutputBuffer,
 279     ACPI_SIZE               *StructureSize);
 280
 281 ACPI_STATUS
 282 AcpiRsIoStream (
 283     ACPI_RESOURCE           *LinkedList,
 284     UINT8                   **OutputBuffer,
 285     ACPI_SIZE               *BytesConsumed);
 286
 287 ACPI_STATUS
 288 AcpiRsFixedIoStream (
 289     ACPI_RESOURCE           *LinkedList,
 290     UINT8                   **OutputBuffer,
 291     ACPI_SIZE               *BytesConsumed);
 292
 293 ACPI_STATUS
 294 AcpiRsIrqResource (
 295     UINT8                   *ByteStreamBuffer,
 296     ACPI_SIZE               *BytesConsumed,
 297     UINT8                   **OutputBuffer,
 298     ACPI_SIZE               *StructureSize);
 299
 300 ACPI_STATUS
 301 AcpiRsIrqStream (
 302     ACPI_RESOURCE           *LinkedList,
 303     UINT8                   **OutputBuffer,
 304     ACPI_SIZE               *BytesConsumed);
 305
 306 ACPI_STATUS
 307 AcpiRsDmaResource (
 308     UINT8                   *ByteStreamBuffer,
 309     ACPI_SIZE               *BytesConsumed,
 310     UINT8                   **OutputBuffer,
 311     ACPI_SIZE               *StructureSize);
 312
 313 ACPI_STATUS
 314 AcpiRsDmaStream (
 315     ACPI_RESOURCE           *LinkedList,
 316     UINT8                   **OutputBuffer,
 317     ACPI_SIZE               *BytesConsumed);
 318
 319 ACPI_STATUS
 320 AcpiRsAddress16Resource (
 321     UINT8                   *ByteStreamBuffer,
 322     ACPI_SIZE               *BytesConsumed,
 323     UINT8                   **OutputBuffer,
 324     ACPI_SIZE               *StructureSize);
 325
 326 ACPI_STATUS
 327 AcpiRsAddress16Stream (
 328     ACPI_RESOURCE           *LinkedList,
 329     UINT8                   **OutputBuffer,
 330     ACPI_SIZE               *BytesConsumed);
 331
 332 ACPI_STATUS
 333 AcpiRsAddress32Resource (
 334     UINT8                   *ByteStreamBuffer,
 335     ACPI_SIZE               *BytesConsumed,
 336     UINT8                   **OutputBuffer,
 337     ACPI_SIZE               *StructureSize);
 338
 339 ACPI_STATUS
 340 AcpiRsAddress32Stream (
 341     ACPI_RESOURCE           *LinkedList,
 342     UINT8                   **OutputBuffer,
 343     ACPI_SIZE               *BytesConsumed);
 344
 345 ACPI_STATUS
 346 AcpiRsAddress64Resource (
 347     UINT8                   *ByteStreamBuffer,
 348     ACPI_SIZE               *BytesConsumed,
 349     UINT8                   **OutputBuffer,
 350     ACPI_SIZE               *StructureSize);
 351
 352 ACPI_STATUS
 353 AcpiRsAddress64Stream (
 354     ACPI_RESOURCE           *LinkedList,
 355     UINT8                   **OutputBuffer,
 356     ACPI_SIZE               *BytesConsumed);
 357
 358 ACPI_STATUS
 359 AcpiRsStartDependFnsResource (
 360     UINT8                   *ByteStreamBuffer,
 361     ACPI_SIZE               *BytesConsumed,
 362     UINT8                   **OutputBuffer,
 363     ACPI_SIZE               *StructureSize);
 364
 365 ACPI_STATUS
 366 AcpiRsEndDependFnsResource (
 367     UINT8                   *ByteStreamBuffer,
 368     ACPI_SIZE               *BytesConsumed,
 369     UINT8                   **OutputBuffer,
 370     ACPI_SIZE               *StructureSize);
 371
 372 ACPI_STATUS
 373 AcpiRsStartDependFnsStream (
 374     ACPI_RESOURCE           *LinkedList,
 375     UINT8                   **OutputBuffer,
 376     ACPI_SIZE               *BytesConsumed);
 377
 378 ACPI_STATUS
 379 AcpiRsEndDependFnsStream (
 380     ACPI_RESOURCE           *LinkedList,
 381     UINT8                   **OutputBuffer,
 382     ACPI_SIZE               *BytesConsumed);
 383
 384 ACPI_STATUS
 385 AcpiRsMemory24Resource (
 386     UINT8                   *ByteStreamBuffer,
 387     ACPI_SIZE               *BytesConsumed,
 388     UINT8                   **OutputBuffer,
 389     ACPI_SIZE               *StructureSize);
 390
 391 ACPI_STATUS
 392 AcpiRsMemory24Stream (
 393     ACPI_RESOURCE           *LinkedList,
 394     UINT8                   **OutputBuffer,
 395     ACPI_SIZE               *BytesConsumed);
 396
 397 ACPI_STATUS
 398 AcpiRsMemory32RangeResource (
 399     UINT8                   *ByteStreamBuffer,
 400     ACPI_SIZE               *BytesConsumed,
 401     UINT8                   **OutputBuffer,
 402     ACPI_SIZE               *StructureSize);
 403
 404 ACPI_STATUS
 405 AcpiRsFixedMemory32Resource (
 406     UINT8                   *ByteStreamBuffer,
 407     ACPI_SIZE               *BytesConsumed,
 408     UINT8                   **OutputBuffer,
 409     ACPI_SIZE               *StructureSize);
 410
 411 ACPI_STATUS
 412 AcpiRsMemory32RangeStream (
 413     ACPI_RESOURCE           *LinkedList,
 414     UINT8                   **OutputBuffer,
 415     ACPI_SIZE               *BytesConsumed);
 416
 417 ACPI_STATUS
 418 AcpiRsFixedMemory32Stream (
 419     ACPI_RESOURCE           *LinkedList,
 420     UINT8                   **OutputBuffer,
 421     ACPI_SIZE               *BytesConsumed);
 422
 423 ACPI_STATUS
 424 AcpiRsExtendedIrqResource (
 425     UINT8                   *ByteStreamBuffer,
 426     ACPI_SIZE               *BytesConsumed,
 427     UINT8                   **OutputBuffer,
 428     ACPI_SIZE               *StructureSize);
 429
 430 ACPI_STATUS
 431 AcpiRsExtendedIrqStream (
 432     ACPI_RESOURCE           *LinkedList,
 433     UINT8                   **OutputBuffer,
 434     ACPI_SIZE               *BytesConsumed);
 435
 436 ACPI_STATUS
 437 AcpiRsEndTagResource (
 438     UINT8                   *ByteStreamBuffer,
 439     ACPI_SIZE               *BytesConsumed,
 440     UINT8                   **OutputBuffer,
 441     ACPI_SIZE               *StructureSize);
 442
 443 ACPI_STATUS
 444 AcpiRsEndTagStream (
 445     ACPI_RESOURCE           *LinkedList,
 446     UINT8                   **OutputBuffer,
 447     ACPI_SIZE               *BytesConsumed);
 448
 449 ACPI_STATUS
 450 AcpiRsVendorResource (
 451     UINT8                   *ByteStreamBuffer,
 452     ACPI_SIZE               *BytesConsumed,
 453     UINT8                   **OutputBuffer,
 454     ACPI_SIZE               *StructureSize);
 455
 456 ACPI_STATUS
 457 AcpiRsVendorStream (
 458     ACPI_RESOURCE           *LinkedList,
 459     UINT8                   **OutputBuffer,
 460     ACPI_SIZE               *BytesConsumed);
 461
 462 UINT8
 463 AcpiRsGetResourceType (
 464     UINT8                   ResourceStartByte);
 465
 466 #endif  /* __ACRESRC_H__ */