sys/contrib/dev/acpica/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 - 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/acpixf.h,v 1.1 2003/09/24 03:32:15 drhodus Exp $                                                               */
 117
 118
 119 #ifndef __ACXFACE_H__
 120 #define __ACXFACE_H__
 121
 122 #include "actypes.h"
 123 #include "actbl.h"
 124
 125
 126  /*
 127  * Global interfaces
 128  */
 129
 130 ACPI_STATUS
 131 AcpiInitializeSubsystem (
 132     void);
 133
 134 ACPI_STATUS
 135 AcpiEnableSubsystem (
 136     UINT32                  Flags);
 137
 138 ACPI_STATUS
 139 AcpiInitializeObjects (
 140     UINT32                  Flags);
 141
 142 ACPI_STATUS
 143 AcpiTerminate (
 144     void);
 145
 146 ACPI_STATUS
 147 AcpiSubsystemStatus (
 148     void);
 149
 150 ACPI_STATUS
 151 AcpiEnable (
 152     void);
 153
 154 ACPI_STATUS
 155 AcpiDisable (
 156     void);
 157
 158 ACPI_STATUS
 159 AcpiGetSystemInfo (
 160     ACPI_BUFFER             *RetBuffer);
 161
 162 const char *
 163 AcpiFormatException (
 164     ACPI_STATUS             Exception);
 165
 166 ACPI_STATUS
 167 AcpiPurgeCachedObjects (
 168     void);
 169
 170 ACPI_STATUS
 171 AcpiInstallInitializationHandler (
 172     ACPI_INIT_HANDLER       Handler,
 173     UINT32                  Function);
 174
 175 /*
 176  * ACPI Memory manager
 177  */
 178
 179 void *
 180 AcpiAllocate (
 181     UINT32                  Size);
 182
 183 void *
 184 AcpiCallocate (
 185     UINT32                  Size);
 186
 187 void
 188 AcpiFree (
 189     void                    *Address);
 190
 191
 192 /*
 193  * ACPI table manipulation interfaces
 194  */
 195
 196 ACPI_STATUS
 197 AcpiFindRootPointer (
 198     UINT32                  Flags,
 199     ACPI_POINTER            *RsdpAddress);
 200
 201 ACPI_STATUS
 202 AcpiLoadTables (
 203     void);
 204
 205 ACPI_STATUS
 206 AcpiLoadTable (
 207     ACPI_TABLE_HEADER       *TablePtr);
 208
 209 ACPI_STATUS
 210 AcpiUnloadTable (
 211     ACPI_TABLE_TYPE         TableType);
 212
 213 ACPI_STATUS
 214 AcpiGetTableHeader (
 215     ACPI_TABLE_TYPE         TableType,
 216     UINT32                  Instance,
 217     ACPI_TABLE_HEADER       *OutTableHeader);
 218
 219 ACPI_STATUS
 220 AcpiGetTable (
 221     ACPI_TABLE_TYPE         TableType,
 222     UINT32                  Instance,
 223     ACPI_BUFFER             *RetBuffer);
 224
 225 ACPI_STATUS
 226 AcpiGetFirmwareTable (
 227     ACPI_STRING             Signature,
 228     UINT32                  Instance,
 229     UINT32                  Flags,
 230     ACPI_TABLE_HEADER       **TablePointer);
 231
 232
 233 /*
 234  * Namespace and name interfaces
 235  */
 236
 237 ACPI_STATUS
 238 AcpiWalkNamespace (
 239     ACPI_OBJECT_TYPE        Type,
 240     ACPI_HANDLE             StartObject,
 241     UINT32                  MaxDepth,
 242     ACPI_WALK_CALLBACK      UserFunction,
 243     void                    *Context,
 244     void                    **ReturnValue);
 245
 246 ACPI_STATUS
 247 AcpiGetDevices (
 248     char                    *HID,
 249     ACPI_WALK_CALLBACK      UserFunction,
 250     void                    *Context,
 251     void                    **ReturnValue);
 252
 253 ACPI_STATUS
 254 AcpiGetName (
 255     ACPI_HANDLE             Handle,
 256     UINT32                  NameType,
 257     ACPI_BUFFER             *RetPathPtr);
 258
 259 ACPI_STATUS
 260 AcpiGetHandle (
 261     ACPI_HANDLE             Parent,
 262     ACPI_STRING             Pathname,
 263     ACPI_HANDLE             *RetHandle);
 264
 265 ACPI_STATUS
 266 AcpiAttachData (
 267     ACPI_HANDLE             ObjHandle,
 268     ACPI_OBJECT_HANDLER     Handler,
 269     void                    *Data);
 270
 271 ACPI_STATUS
 272 AcpiDetachData (
 273     ACPI_HANDLE             ObjHandle,
 274     ACPI_OBJECT_HANDLER     Handler);
 275
 276 ACPI_STATUS
 277 AcpiGetData (
 278     ACPI_HANDLE             ObjHandle,
 279     ACPI_OBJECT_HANDLER     Handler,
 280     void                    **Data);
 281
 282
 283 /*
 284  * Object manipulation and enumeration
 285  */
 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             Device,
 305     ACPI_DEVICE_INFO        *Info);
 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
 329 ACPI_STATUS
 330 AcpiInstallFixedEventHandler (
 331     UINT32                  AcpiEvent,
 332     ACPI_EVENT_HANDLER      Handler,
 333     void                    *Context);
 334
 335 ACPI_STATUS
 336 AcpiRemoveFixedEventHandler (
 337     UINT32                  AcpiEvent,
 338     ACPI_EVENT_HANDLER      Handler);
 339
 340 ACPI_STATUS
 341 AcpiInstallNotifyHandler (
 342     ACPI_HANDLE             Device,
 343     UINT32                  HandlerType,
 344     ACPI_NOTIFY_HANDLER     Handler,
 345     void                    *Context);
 346
 347 ACPI_STATUS
 348 AcpiRemoveNotifyHandler (
 349     ACPI_HANDLE             Device,
 350     UINT32                  HandlerType,
 351     ACPI_NOTIFY_HANDLER     Handler);
 352
 353 ACPI_STATUS
 354 AcpiInstallAddressSpaceHandler (
 355     ACPI_HANDLE             Device,
 356     ACPI_ADR_SPACE_TYPE     SpaceId,
 357     ACPI_ADR_SPACE_HANDLER  Handler,
 358     ACPI_ADR_SPACE_SETUP    Setup,
 359     void                    *Context);
 360
 361 ACPI_STATUS
 362 AcpiRemoveAddressSpaceHandler (
 363     ACPI_HANDLE             Device,
 364     ACPI_ADR_SPACE_TYPE     SpaceId,
 365     ACPI_ADR_SPACE_HANDLER  Handler);
 366
 367 ACPI_STATUS
 368 AcpiInstallGpeHandler (
 369     UINT32                  GpeNumber,
 370     UINT32                  Type,
 371     ACPI_GPE_HANDLER        Handler,
 372     void                    *Context);
 373
 374 ACPI_STATUS
 375 AcpiAcquireGlobalLock (
 376     UINT16                  Timeout,
 377     UINT32                  *Handle);
 378
 379 ACPI_STATUS
 380 AcpiReleaseGlobalLock (
 381     UINT32                  Handle);
 382
 383 ACPI_STATUS
 384 AcpiRemoveGpeHandler (
 385     UINT32                  GpeNumber,
 386     ACPI_GPE_HANDLER        Handler);
 387
 388 ACPI_STATUS
 389 AcpiEnableEvent (
 390     UINT32                  AcpiEvent,
 391     UINT32                  Type,
 392     UINT32                  Flags);
 393
 394 ACPI_STATUS
 395 AcpiDisableEvent (
 396     UINT32                  AcpiEvent,
 397     UINT32                  Type,
 398     UINT32                  Flags);
 399
 400 ACPI_STATUS
 401 AcpiClearEvent (
 402     UINT32                  AcpiEvent,
 403     UINT32                  Type);
 404
 405 ACPI_STATUS
 406 AcpiGetEventStatus (
 407     UINT32                  AcpiEvent,
 408     UINT32                  Type,
 409     ACPI_EVENT_STATUS       *EventStatus);
 410
 411 /*
 412  * Resource interfaces
 413  */
 414
 415 typedef
 416 ACPI_STATUS (*ACPI_WALK_RESOURCE_CALLBACK) (
 417     ACPI_RESOURCE           *Resource,
 418     void                    *Context);
 419
 420
 421 ACPI_STATUS
 422 AcpiGetCurrentResources(
 423     ACPI_HANDLE             DeviceHandle,
 424     ACPI_BUFFER             *RetBuffer);
 425
 426 ACPI_STATUS
 427 AcpiGetPossibleResources(
 428     ACPI_HANDLE             DeviceHandle,
 429     ACPI_BUFFER             *RetBuffer);
 430
 431 ACPI_STATUS
 432 AcpiWalkResources (
 433     ACPI_HANDLE                     DeviceHandle,
 434     char                            *Path,
 435     ACPI_WALK_RESOURCE_CALLBACK     UserFunction,
 436     void                            *Context);
 437
 438 ACPI_STATUS
 439 AcpiSetCurrentResources (
 440     ACPI_HANDLE             DeviceHandle,
 441     ACPI_BUFFER             *InBuffer);
 442
 443 ACPI_STATUS
 444 AcpiGetIrqRoutingTable  (
 445     ACPI_HANDLE             BusDeviceHandle,
 446     ACPI_BUFFER             *RetBuffer);
 447
 448 ACPI_STATUS
 449 AcpiResourceToAddress64 (
 450     ACPI_RESOURCE           *Resource,
 451     ACPI_RESOURCE_ADDRESS64 *Out);
 452
 453 /*
 454  * Hardware (ACPI device) interfaces
 455  */
 456
 457 ACPI_STATUS
 458 AcpiGetRegister (
 459     UINT32                  RegisterId,
 460     UINT32                  *ReturnValue,
 461     UINT32                  Flags);
 462
 463 ACPI_STATUS
 464 AcpiSetRegister (
 465     UINT32                  RegisterId,
 466     UINT32                  Value,
 467     UINT32                  Flags);
 468
 469 ACPI_STATUS
 470 AcpiSetFirmwareWakingVector (
 471     ACPI_PHYSICAL_ADDRESS   PhysicalAddress);
 472
 473 ACPI_STATUS
 474 AcpiGetFirmwareWakingVector (
 475     ACPI_PHYSICAL_ADDRESS   *PhysicalAddress);
 476
 477 ACPI_STATUS
 478 AcpiGetSleepTypeData (
 479     UINT8                   SleepState,
 480     UINT8                   *Slp_TypA,
 481     UINT8                   *Slp_TypB);
 482
 483 ACPI_STATUS
 484 AcpiEnterSleepStatePrep (
 485     UINT8                   SleepState);
 486
 487 ACPI_STATUS
 488 AcpiEnterSleepState (
 489     UINT8                   SleepState);
 490
 491 ACPI_STATUS
 492 AcpiEnterSleepStateS4bios (
 493     void);
 494
 495 ACPI_STATUS
 496 AcpiLeaveSleepState (
 497     UINT8                   SleepState);
 498
 499
 500 #endif /* __ACXFACE_H__ */