sys/contrib/dev/acpica-unix-20061109/include/acpixf.h

   1
   2 /******************************************************************************
   3  *
   4  * Name: acpixf.h - External interfaces to the ACPI subsystem
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2006, 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 #ifndef __ACXFACE_H__
 119 #define __ACXFACE_H__
 120
 121 #include "actypes.h"
 122 #include "actbl.h"
 123
 124
 125 /*
 126  * Global interfaces
 127  */
 128 ACPI_STATUS
 129 AcpiInitializeTables (
 130     ACPI_TABLE_DESC         *InitialStorage,
 131     UINT32                  InitialTableCount,
 132     BOOLEAN                 AllowResize);
 133
 134 ACPI_STATUS
 135 AcpiInitializeSubsystem (
 136     void);
 137
 138 ACPI_STATUS
 139 AcpiEnableSubsystem (
 140     UINT32                  Flags);
 141
 142 ACPI_STATUS
 143 AcpiInitializeObjects (
 144     UINT32                  Flags);
 145
 146 ACPI_STATUS
 147 AcpiTerminate (
 148     void);
 149
 150 ACPI_STATUS
 151 AcpiSubsystemStatus (
 152     void);
 153
 154 ACPI_STATUS
 155 AcpiEnable (
 156     void);
 157
 158 ACPI_STATUS
 159 AcpiDisable (
 160     void);
 161
 162 ACPI_STATUS
 163 AcpiGetSystemInfo (
 164     ACPI_BUFFER             *RetBuffer);
 165
 166 const char *
 167 AcpiFormatException (
 168     ACPI_STATUS             Exception);
 169
 170 ACPI_STATUS
 171 AcpiPurgeCachedObjects (
 172     void);
 173
 174 ACPI_STATUS
 175 AcpiInstallInitializationHandler (
 176     ACPI_INIT_HANDLER       Handler,
 177     UINT32                  Function);
 178
 179 /*
 180  * ACPI Memory managment
 181  */
 182 void *
 183 AcpiAllocate (
 184     UINT32                  Size);
 185
 186 void *
 187 AcpiCallocate (
 188     UINT32                  Size);
 189
 190 void
 191 AcpiFree (
 192     void                    *Address);
 193
 194
 195 /*
 196  * ACPI table manipulation interfaces
 197  */
 198 ACPI_STATUS
 199 AcpiReallocateRootTable (
 200     void);
 201
 202 ACPI_STATUS
 203 AcpiFindRootPointer (
 204     ACPI_NATIVE_UINT        *RsdpAddress);
 205
 206 ACPI_STATUS
 207 AcpiLoadTables (
 208     void);
 209
 210 ACPI_STATUS
 211 AcpiGetTableHeader (
 212     ACPI_STRING             Signature,
 213     ACPI_NATIVE_UINT        Instance,
 214     ACPI_TABLE_HEADER       *OutTableHeader);
 215
 216 ACPI_STATUS
 217 AcpiGetTable (
 218     ACPI_STRING             Signature,
 219     ACPI_NATIVE_UINT        Instance,
 220     ACPI_TABLE_HEADER       **OutTable);
 221
 222 ACPI_STATUS
 223 AcpiGetTableByIndex (
 224     ACPI_NATIVE_UINT        TableIndex,
 225     ACPI_TABLE_HEADER       **OutTable);
 226
 227
 228 /*
 229  * Namespace and name interfaces
 230  */
 231 ACPI_STATUS
 232 AcpiWalkNamespace (
 233     ACPI_OBJECT_TYPE        Type,
 234     ACPI_HANDLE             StartObject,
 235     UINT32                  MaxDepth,
 236     ACPI_WALK_CALLBACK      UserFunction,
 237     void                    *Context,
 238     void                    **ReturnValue);
 239
 240 ACPI_STATUS
 241 AcpiGetDevices (
 242     char                    *HID,
 243     ACPI_WALK_CALLBACK      UserFunction,
 244     void                    *Context,
 245     void                    **ReturnValue);
 246
 247 ACPI_STATUS
 248 AcpiGetName (
 249     ACPI_HANDLE             Handle,
 250     UINT32                  NameType,
 251     ACPI_BUFFER             *RetPathPtr);
 252
 253 ACPI_STATUS
 254 AcpiGetHandle (
 255     ACPI_HANDLE             Parent,
 256     ACPI_STRING             Pathname,
 257     ACPI_HANDLE             *RetHandle);
 258
 259 ACPI_STATUS
 260 AcpiAttachData (
 261     ACPI_HANDLE             ObjHandle,
 262     ACPI_OBJECT_HANDLER     Handler,
 263     void                    *Data);
 264
 265 ACPI_STATUS
 266 AcpiDetachData (
 267     ACPI_HANDLE             ObjHandle,
 268     ACPI_OBJECT_HANDLER     Handler);
 269
 270 ACPI_STATUS
 271 AcpiGetData (
 272     ACPI_HANDLE             ObjHandle,
 273     ACPI_OBJECT_HANDLER     Handler,
 274     void                    **Data);
 275
 276 ACPI_STATUS
 277 AcpiDebugTrace (
 278     char                    *Name,
 279     UINT32                  DebugLevel,
 280     UINT32                  DebugLayer,
 281     UINT32                  Flags);
 282
 283
 284 /*
 285  * Object manipulation and enumeration
 286  */
 287 ACPI_STATUS
 288 AcpiEvaluateObject (
 289     ACPI_HANDLE             Object,
 290     ACPI_STRING             Pathname,
 291     ACPI_OBJECT_LIST        *ParameterObjects,
 292     ACPI_BUFFER             *ReturnObjectBuffer);
 293
 294 ACPI_STATUS
 295 AcpiEvaluateObjectTyped (
 296     ACPI_HANDLE             Object,
 297     ACPI_STRING             Pathname,
 298     ACPI_OBJECT_LIST        *ExternalParams,
 299     ACPI_BUFFER             *ReturnBuffer,
 300     ACPI_OBJECT_TYPE        ReturnType);
 301
 302 ACPI_STATUS
 303 AcpiGetObjectInfo (
 304     ACPI_HANDLE             Handle,
 305     ACPI_BUFFER             *ReturnBuffer);
 306
 307 ACPI_STATUS
 308 AcpiGetNextObject (
 309     ACPI_OBJECT_TYPE        Type,
 310     ACPI_HANDLE             Parent,
 311     ACPI_HANDLE             Child,
 312     ACPI_HANDLE             *OutHandle);
 313
 314 ACPI_STATUS
 315 AcpiGetType (
 316     ACPI_HANDLE             Object,
 317     ACPI_OBJECT_TYPE        *OutType);
 318
 319 ACPI_STATUS
 320 AcpiGetParent (
 321     ACPI_HANDLE             Object,
 322     ACPI_HANDLE             *OutHandle);
 323
 324
 325 /*
 326  * Event handler interfaces
 327  */
 328 ACPI_STATUS
 329 AcpiInstallFixedEventHandler (
 330     UINT32                  AcpiEvent,
 331     ACPI_EVENT_HANDLER      Handler,
 332     void                    *Context);
 333
 334 ACPI_STATUS
 335 AcpiRemoveFixedEventHandler (
 336     UINT32                  AcpiEvent,
 337     ACPI_EVENT_HANDLER      Handler);
 338
 339 ACPI_STATUS
 340 AcpiInstallNotifyHandler (
 341     ACPI_HANDLE             Device,
 342     UINT32                  HandlerType,
 343     ACPI_NOTIFY_HANDLER     Handler,
 344     void                    *Context);
 345
 346 ACPI_STATUS
 347 AcpiRemoveNotifyHandler (
 348     ACPI_HANDLE             Device,
 349     UINT32                  HandlerType,
 350     ACPI_NOTIFY_HANDLER     Handler);
 351
 352 ACPI_STATUS
 353 AcpiInstallAddressSpaceHandler (
 354     ACPI_HANDLE             Device,
 355     ACPI_ADR_SPACE_TYPE     SpaceId,
 356     ACPI_ADR_SPACE_HANDLER  Handler,
 357     ACPI_ADR_SPACE_SETUP    Setup,
 358     void                    *Context);
 359
 360 ACPI_STATUS
 361 AcpiRemoveAddressSpaceHandler (
 362     ACPI_HANDLE             Device,
 363     ACPI_ADR_SPACE_TYPE     SpaceId,
 364     ACPI_ADR_SPACE_HANDLER  Handler);
 365
 366 ACPI_STATUS
 367 AcpiInstallGpeHandler (
 368     ACPI_HANDLE             GpeDevice,
 369     UINT32                  GpeNumber,
 370     UINT32                  Type,
 371     ACPI_EVENT_HANDLER      Address,
 372     void                    *Context);
 373
 374 ACPI_STATUS
 375 AcpiInstallExceptionHandler (
 376     ACPI_EXCEPTION_HANDLER  Handler);
 377
 378
 379 /*
 380  * Event interfaces
 381  */
 382 ACPI_STATUS
 383 AcpiAcquireGlobalLock (
 384     UINT16                  Timeout,
 385     UINT32                  *Handle);
 386
 387 ACPI_STATUS
 388 AcpiReleaseGlobalLock (
 389     UINT32                  Handle);
 390
 391 ACPI_STATUS
 392 AcpiRemoveGpeHandler (
 393     ACPI_HANDLE             GpeDevice,
 394     UINT32                  GpeNumber,
 395     ACPI_EVENT_HANDLER      Address);
 396
 397 ACPI_STATUS
 398 AcpiEnableEvent (
 399     UINT32                  Event,
 400     UINT32                  Flags);
 401
 402 ACPI_STATUS
 403 AcpiDisableEvent (
 404     UINT32                  Event,
 405     UINT32                  Flags);
 406
 407 ACPI_STATUS
 408 AcpiClearEvent (
 409     UINT32                  Event);
 410
 411 ACPI_STATUS
 412 AcpiGetEventStatus (
 413     UINT32                  Event,
 414     ACPI_EVENT_STATUS       *EventStatus);
 415
 416 ACPI_STATUS
 417 AcpiSetGpeType (
 418     ACPI_HANDLE             GpeDevice,
 419     UINT32                  GpeNumber,
 420     UINT8                   Type);
 421
 422 ACPI_STATUS
 423 AcpiEnableGpe (
 424     ACPI_HANDLE             GpeDevice,
 425     UINT32                  GpeNumber,
 426     UINT32                  Flags);
 427
 428 ACPI_STATUS
 429 AcpiDisableGpe (
 430     ACPI_HANDLE             GpeDevice,
 431     UINT32                  GpeNumber,
 432     UINT32                  Flags);
 433
 434 ACPI_STATUS
 435 AcpiClearGpe (
 436     ACPI_HANDLE             GpeDevice,
 437     UINT32                  GpeNumber,
 438     UINT32                  Flags);
 439
 440 ACPI_STATUS
 441 AcpiGetGpeStatus (
 442     ACPI_HANDLE             GpeDevice,
 443     UINT32                  GpeNumber,
 444     UINT32                  Flags,
 445     ACPI_EVENT_STATUS       *EventStatus);
 446
 447 ACPI_STATUS
 448 AcpiInstallGpeBlock (
 449     ACPI_HANDLE             GpeDevice,
 450     ACPI_GENERIC_ADDRESS    *GpeBlockAddress,
 451     UINT32                  RegisterCount,
 452     UINT32                  InterruptNumber);
 453
 454 ACPI_STATUS
 455 AcpiRemoveGpeBlock (
 456     ACPI_HANDLE             GpeDevice);
 457
 458
 459 /*
 460  * Resource interfaces
 461  */
 462 typedef
 463 ACPI_STATUS (*ACPI_WALK_RESOURCE_CALLBACK) (
 464     ACPI_RESOURCE           *Resource,
 465     void                    *Context);
 466
 467 ACPI_STATUS
 468 AcpiGetVendorResource (
 469     ACPI_HANDLE             DeviceHandle,
 470     char                    *Name,
 471     ACPI_VENDOR_UUID        *Uuid,
 472     ACPI_BUFFER             *RetBuffer);
 473
 474 ACPI_STATUS
 475 AcpiGetCurrentResources(
 476     ACPI_HANDLE             DeviceHandle,
 477     ACPI_BUFFER             *RetBuffer);
 478
 479 ACPI_STATUS
 480 AcpiGetPossibleResources(
 481     ACPI_HANDLE             DeviceHandle,
 482     ACPI_BUFFER             *RetBuffer);
 483
 484 ACPI_STATUS
 485 AcpiWalkResources (
 486     ACPI_HANDLE                 DeviceHandle,
 487     char                        *Name,
 488     ACPI_WALK_RESOURCE_CALLBACK UserFunction,
 489     void                        *Context);
 490
 491 ACPI_STATUS
 492 AcpiSetCurrentResources (
 493     ACPI_HANDLE             DeviceHandle,
 494     ACPI_BUFFER             *InBuffer);
 495
 496 ACPI_STATUS
 497 AcpiGetIrqRoutingTable  (
 498     ACPI_HANDLE             BusDeviceHandle,
 499     ACPI_BUFFER             *RetBuffer);
 500
 501 ACPI_STATUS
 502 AcpiResourceToAddress64 (
 503     ACPI_RESOURCE           *Resource,
 504     ACPI_RESOURCE_ADDRESS64 *Out);
 505
 506 /*
 507  * Hardware (ACPI device) interfaces
 508  */
 509 ACPI_STATUS
 510 AcpiGetRegister (
 511     UINT32                  RegisterId,
 512     UINT32                  *ReturnValue);
 513
 514 ACPI_STATUS
 515 AcpiSetRegister (
 516     UINT32                  RegisterId,
 517     UINT32                  Value);
 518
 519 ACPI_STATUS
 520 AcpiSetFirmwareWakingVector (
 521     ACPI_PHYSICAL_ADDRESS   PhysicalAddress);
 522
 523 ACPI_STATUS
 524 AcpiGetFirmwareWakingVector (
 525     ACPI_PHYSICAL_ADDRESS   *PhysicalAddress);
 526
 527 ACPI_STATUS
 528 AcpiGetSleepTypeData (
 529     UINT8                   SleepState,
 530     UINT8                   *Slp_TypA,
 531     UINT8                   *Slp_TypB);
 532
 533 ACPI_STATUS
 534 AcpiEnterSleepStatePrep (
 535     UINT8                   SleepState);
 536
 537 ACPI_STATUS
 538 AcpiEnterSleepState (
 539     UINT8                   SleepState);
 540
 541 ACPI_STATUS
 542 AcpiEnterSleepStateS4bios (
 543     void);
 544
 545 ACPI_STATUS
 546 AcpiLeaveSleepState (
 547     UINT8                   SleepState);
 548
 549
 550 #endif /* __ACXFACE_H__ */