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, 2000, 2001, 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  * Global interfaces
 126  */
 127
 128 ACPI_STATUS
 129 AcpiInitializeSubsystem (
 130     void);
 131
 132 ACPI_STATUS
 133 AcpiEnableSubsystem (
 134     UINT32                  Flags);
 135
 136 ACPI_STATUS
 137 AcpiTerminate (
 138     void);
 139
 140 ACPI_STATUS
 141 AcpiEnable (
 142     void);
 143
 144 ACPI_STATUS
 145 AcpiDisable (
 146     void);
 147
 148 ACPI_STATUS
 149 AcpiGetSystemInfo(
 150     ACPI_BUFFER             *RetBuffer);
 151
 152 ACPI_STATUS
 153 AcpiFormatException (
 154     ACPI_STATUS             Exception,
 155     ACPI_BUFFER             *OutBuffer);
 156
 157
 158 /*
 159  * ACPI table manipulation interfaces
 160  */
 161
 162 ACPI_STATUS
 163 AcpiFindRootPointer (
 164     ACPI_PHYSICAL_ADDRESS   *RsdpPhysicalAddress);
 165
 166 ACPI_STATUS
 167 AcpiLoadTables (
 168     ACPI_PHYSICAL_ADDRESS   RsdpPhysicalAddress);
 169
 170 ACPI_STATUS
 171 AcpiLoadTable (
 172     ACPI_TABLE_HEADER       *TablePtr);
 173
 174 ACPI_STATUS
 175 AcpiUnloadTable (
 176     ACPI_TABLE_TYPE         TableType);
 177
 178 ACPI_STATUS
 179 AcpiGetTableHeader (
 180     ACPI_TABLE_TYPE         TableType,
 181     UINT32                  Instance,
 182     ACPI_TABLE_HEADER       *OutTableHeader);
 183
 184 ACPI_STATUS
 185 AcpiGetTable (
 186     ACPI_TABLE_TYPE         TableType,
 187     UINT32                  Instance,
 188     ACPI_BUFFER             *RetBuffer);
 189
 190
 191 /*
 192  * Namespace and name interfaces
 193  */
 194
 195 ACPI_STATUS
 196 AcpiWalkNamespace (
 197     ACPI_OBJECT_TYPE        Type,
 198     ACPI_HANDLE             StartObject,
 199     UINT32                  MaxDepth,
 200     WALK_CALLBACK           UserFunction,
 201     void                    *Context,
 202     void *                  *ReturnValue);
 203
 204 ACPI_STATUS
 205 AcpiGetDevices (
 206     NATIVE_CHAR             *HID,
 207     WALK_CALLBACK           UserFunction,
 208     void                    *Context,
 209     void                    **ReturnValue);
 210
 211 ACPI_STATUS
 212 AcpiGetName (
 213     ACPI_HANDLE             Handle,
 214     UINT32                  NameType,
 215     ACPI_BUFFER             *RetPathPtr);
 216
 217 ACPI_STATUS
 218 AcpiGetHandle (
 219     ACPI_HANDLE             Parent,
 220     ACPI_STRING             Pathname,
 221     ACPI_HANDLE             *RetHandle);
 222
 223
 224 /*
 225  * Object manipulation and enumeration
 226  */
 227
 228 ACPI_STATUS
 229 AcpiEvaluateObject (
 230     ACPI_HANDLE             Object,
 231     ACPI_STRING             Pathname,
 232     ACPI_OBJECT_LIST        *ParameterObjects,
 233     ACPI_BUFFER             *ReturnObjectBuffer);
 234
 235 ACPI_STATUS
 236 AcpiGetObjectInfo (
 237     ACPI_HANDLE             Device,
 238     ACPI_DEVICE_INFO        *Info);
 239
 240 ACPI_STATUS
 241 AcpiGetNextObject (
 242     ACPI_OBJECT_TYPE        Type,
 243     ACPI_HANDLE             Parent,
 244     ACPI_HANDLE             Child,
 245     ACPI_HANDLE             *OutHandle);
 246
 247 ACPI_STATUS
 248 AcpiGetType (
 249     ACPI_HANDLE             Object,
 250     ACPI_OBJECT_TYPE        *OutType);
 251
 252 ACPI_STATUS
 253 AcpiGetParent (
 254     ACPI_HANDLE             Object,
 255     ACPI_HANDLE             *OutHandle);
 256
 257
 258 /*
 259  * AcpiEvent handler interfaces
 260  */
 261
 262 ACPI_STATUS
 263 AcpiInstallFixedEventHandler (
 264     UINT32                  AcpiEvent,
 265     FIXED_EVENT_HANDLER     Handler,
 266     void                    *Context);
 267
 268 ACPI_STATUS
 269 AcpiRemoveFixedEventHandler (
 270     UINT32                  AcpiEvent,
 271     FIXED_EVENT_HANDLER     Handler);
 272
 273 ACPI_STATUS
 274 AcpiInstallNotifyHandler (
 275     ACPI_HANDLE             Device,
 276     UINT32                  HandlerType,
 277     NOTIFY_HANDLER          Handler,
 278     void                    *Context);
 279
 280 ACPI_STATUS
 281 AcpiRemoveNotifyHandler (
 282     ACPI_HANDLE             Device,
 283     UINT32                  HandlerType,
 284     NOTIFY_HANDLER          Handler);
 285
 286 ACPI_STATUS
 287 AcpiInstallAddressSpaceHandler (
 288     ACPI_HANDLE             Device,
 289     ACPI_ADDRESS_SPACE_TYPE SpaceId,
 290     ADDRESS_SPACE_HANDLER   Handler,
 291     ADDRESS_SPACE_SETUP     Setup,
 292     void                    *Context);
 293
 294 ACPI_STATUS
 295 AcpiRemoveAddressSpaceHandler (
 296     ACPI_HANDLE             Device,
 297     ACPI_ADDRESS_SPACE_TYPE SpaceId,
 298     ADDRESS_SPACE_HANDLER   Handler);
 299
 300 ACPI_STATUS
 301 AcpiInstallGpeHandler (
 302     UINT32                  GpeNumber,
 303     UINT32                  Type,
 304     GPE_HANDLER             Handler,
 305     void                    *Context);
 306
 307 ACPI_STATUS
 308 AcpiAcquireGlobalLock (
 309     void);
 310
 311 ACPI_STATUS
 312 AcpiReleaseGlobalLock (
 313     void);
 314
 315 ACPI_STATUS
 316 AcpiRemoveGpeHandler (
 317     UINT32                  GpeNumber,
 318     GPE_HANDLER             Handler);
 319
 320 ACPI_STATUS
 321 AcpiEnableEvent (
 322     UINT32                  AcpiEvent,
 323     UINT32                  Type);
 324
 325 ACPI_STATUS
 326 AcpiDisableEvent (
 327     UINT32                  AcpiEvent,
 328     UINT32                  Type);
 329
 330 ACPI_STATUS
 331 AcpiClearEvent (
 332     UINT32                  AcpiEvent,
 333     UINT32                  Type);
 334
 335 ACPI_STATUS
 336 AcpiGetEventStatus (
 337     UINT32                  AcpiEvent,
 338     UINT32                  Type,
 339     ACPI_EVENT_STATUS       *EventStatus);
 340
 341 /*
 342  * Resource interfaces
 343  */
 344
 345 ACPI_STATUS
 346 AcpiGetCurrentResources(
 347     ACPI_HANDLE             DeviceHandle,
 348     ACPI_BUFFER             *RetBuffer);
 349
 350 ACPI_STATUS
 351 AcpiGetPossibleResources(
 352     ACPI_HANDLE             DeviceHandle,
 353     ACPI_BUFFER             *RetBuffer);
 354
 355 ACPI_STATUS
 356 AcpiSetCurrentResources (
 357     ACPI_HANDLE             DeviceHandle,
 358     ACPI_BUFFER             *InBuffer);
 359
 360 ACPI_STATUS
 361 AcpiGetIrqRoutingTable  (
 362     ACPI_HANDLE             BusDeviceHandle,
 363     ACPI_BUFFER             *RetBuffer);
 364
 365
 366 /*
 367  * Hardware (ACPI device) interfaces
 368  */
 369
 370 ACPI_STATUS
 371 AcpiSetFirmwareWakingVector (
 372     ACPI_PHYSICAL_ADDRESS   PhysicalAddress);
 373
 374 ACPI_STATUS
 375 AcpiGetFirmwareWakingVector (
 376     ACPI_PHYSICAL_ADDRESS   *PhysicalAddress);
 377
 378 ACPI_STATUS
 379 AcpiEnterSleepState (
 380     UINT8 SleepState);
 381
 382 ACPI_STATUS
 383 AcpiGetProcessorThrottlingInfo (
 384     ACPI_HANDLE             ProcessorHandle,
 385     ACPI_BUFFER             *UserBuffer);
 386
 387 ACPI_STATUS
 388 AcpiSetProcessorThrottlingState (
 389     ACPI_HANDLE             ProcessorHandle,
 390     UINT32                  ThrottleState);
 391
 392 ACPI_STATUS
 393 AcpiGetProcessorThrottlingState (
 394     ACPI_HANDLE             ProcessorHandle,
 395     UINT32                  *ThrottleState);
 396
 397 ACPI_STATUS
 398 AcpiGetProcessorCxInfo (
 399     ACPI_HANDLE             ProcessorHandle,
 400     ACPI_BUFFER             *UserBuffer);
 401
 402 ACPI_STATUS
 403 AcpiSetProcessorSleepState (
 404     ACPI_HANDLE             ProcessorHandle,
 405     UINT32                  CxState);
 406
 407 ACPI_STATUS
 408 AcpiProcessorSleep (
 409     ACPI_HANDLE             ProcessorHandle,
 410     UINT32                  *PmTimerTicks);
 411
 412
 413 #endif /* __ACXFACE_H__ */