sys/contrib/dev/acpica-unix-20050309/include/acevents.h

   1 /******************************************************************************
   2  *
   3  * Name: acevents.h - Event subcomponent prototypes and defines
   4  *       $Revision: 97 $
   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  * 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 #ifndef __ACEVENTS_H__
 118 #define __ACEVENTS_H__
 119
 120
 121 ACPI_STATUS
 122 AcpiEvInitializeEvents (
 123     void);
 124
 125 ACPI_STATUS
 126 AcpiEvInstallXruptHandlers (
 127     void);
 128
 129
 130 /*
 131  * Evfixed - Fixed event handling
 132  */
 133
 134 ACPI_STATUS
 135 AcpiEvFixedEventInitialize (
 136     void);
 137
 138 UINT32
 139 AcpiEvFixedEventDetect (
 140     void);
 141
 142 UINT32
 143 AcpiEvFixedEventDispatch (
 144     UINT32                  Event);
 145
 146
 147 /*
 148  * Evmisc
 149  */
 150
 151 BOOLEAN
 152 AcpiEvIsNotifyObject (
 153     ACPI_NAMESPACE_NODE     *Node);
 154
 155 ACPI_STATUS
 156 AcpiEvAcquireGlobalLock(
 157     UINT16                  Timeout);
 158
 159 ACPI_STATUS
 160 AcpiEvReleaseGlobalLock(
 161     void);
 162
 163 ACPI_STATUS
 164 AcpiEvInitGlobalLockHandler (
 165     void);
 166
 167 UINT32
 168 AcpiEvGetGpeNumberIndex (
 169     UINT32                  GpeNumber);
 170
 171 ACPI_STATUS
 172 AcpiEvQueueNotifyRequest (
 173     ACPI_NAMESPACE_NODE     *Node,
 174     UINT32                  NotifyValue);
 175
 176 void ACPI_SYSTEM_XFACE
 177 AcpiEvNotifyDispatch (
 178     void                    *Context);
 179
 180
 181 /*
 182  * Evgpe - GPE handling and dispatch
 183  */
 184
 185 ACPI_STATUS
 186 AcpiEvWalkGpeList (
 187     ACPI_GPE_CALLBACK       GpeWalkCallback,
 188     UINT32                  Flags);
 189
 190 BOOLEAN
 191 AcpiEvValidGpeEvent (
 192     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
 193
 194 ACPI_STATUS
 195 AcpiEvUpdateGpeEnableMasks (
 196     ACPI_GPE_EVENT_INFO     *GpeEventInfo,
 197     UINT8                   Type);
 198
 199 ACPI_STATUS
 200 AcpiEvEnableGpe (
 201     ACPI_GPE_EVENT_INFO     *GpeEventInfo,
 202     BOOLEAN                 WriteToHardware);
 203
 204 ACPI_STATUS
 205 AcpiEvDisableGpe (
 206     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
 207
 208 ACPI_GPE_EVENT_INFO *
 209 AcpiEvGetGpeEventInfo (
 210     ACPI_HANDLE             GpeDevice,
 211     UINT32                  GpeNumber);
 212
 213 ACPI_STATUS
 214 AcpiEvGpeInitialize (
 215     void);
 216
 217 ACPI_STATUS
 218 AcpiEvCreateGpeBlock (
 219     ACPI_NAMESPACE_NODE     *GpeDevice,
 220     ACPI_GENERIC_ADDRESS    *GpeBlockAddress,
 221     UINT32                  RegisterCount,
 222     UINT8                   GpeBlockBaseNumber,
 223     UINT32                  InterruptLevel,
 224     ACPI_GPE_BLOCK_INFO     **ReturnGpeBlock);
 225
 226 ACPI_STATUS
 227 AcpiEvDeleteGpeBlock (
 228     ACPI_GPE_BLOCK_INFO     *GpeBlock);
 229
 230 ACPI_STATUS
 231 AcpiEvDeleteGpeHandlers (
 232     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
 233     ACPI_GPE_BLOCK_INFO     *GpeBlock);
 234
 235 UINT32
 236 AcpiEvGpeDispatch (
 237     ACPI_GPE_EVENT_INFO     *GpeEventInfo,
 238     UINT32                  GpeNumber);
 239
 240 UINT32
 241 AcpiEvGpeDetect (
 242     ACPI_GPE_XRUPT_INFO     *GpeXruptList);
 243
 244 ACPI_STATUS
 245 AcpiEvSetGpeType (
 246     ACPI_GPE_EVENT_INFO     *GpeEventInfo,
 247     UINT8                   Type);
 248
 249 ACPI_STATUS
 250 AcpiEvCheckForWakeOnlyGpe (
 251     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
 252
 253 /*
 254  * Evregion - Address Space handling
 255  */
 256
 257 ACPI_STATUS
 258 AcpiEvInstallRegionHandlers (
 259     void);
 260
 261 ACPI_STATUS
 262 AcpiEvInitializeOpRegions (
 263     void);
 264
 265 ACPI_STATUS
 266 AcpiEvAddressSpaceDispatch (
 267     ACPI_OPERAND_OBJECT    *RegionObj,
 268     UINT32                  Function,
 269     ACPI_PHYSICAL_ADDRESS   Address,
 270     UINT32                  BitWidth,
 271     void                    *Value);
 272
 273 ACPI_STATUS
 274 AcpiEvInstallHandler (
 275     ACPI_HANDLE             ObjHandle,
 276     UINT32                  Level,
 277     void                    *Context,
 278     void                    **ReturnValue);
 279
 280 ACPI_STATUS
 281 AcpiEvAttachRegion (
 282     ACPI_OPERAND_OBJECT     *HandlerObj,
 283     ACPI_OPERAND_OBJECT     *RegionObj,
 284     BOOLEAN                 AcpiNsIsLocked);
 285
 286 void
 287 AcpiEvDetachRegion (
 288     ACPI_OPERAND_OBJECT    *RegionObj,
 289     BOOLEAN                 AcpiNsIsLocked);
 290
 291 ACPI_STATUS
 292 AcpiEvInstallSpaceHandler (
 293     ACPI_NAMESPACE_NODE     *Node,
 294     ACPI_ADR_SPACE_TYPE     SpaceId,
 295     ACPI_ADR_SPACE_HANDLER  Handler,
 296     ACPI_ADR_SPACE_SETUP    Setup,
 297     void                    *Context);
 298
 299 ACPI_STATUS
 300 AcpiEvExecuteRegMethods (
 301     ACPI_NAMESPACE_NODE     *Node,
 302     ACPI_ADR_SPACE_TYPE     SpaceId);
 303
 304 ACPI_STATUS
 305 AcpiEvExecuteRegMethod (
 306     ACPI_OPERAND_OBJECT    *RegionObj,
 307     UINT32                  Function);
 308
 309 ACPI_STATUS
 310 AcpiEvRegRun (
 311     ACPI_HANDLE             ObjHandle,
 312     UINT32                  Level,
 313     void                    *Context,
 314     void                    **ReturnValue);
 315
 316 /*
 317  * Evregini - Region initialization and setup
 318  */
 319
 320 ACPI_STATUS
 321 AcpiEvSystemMemoryRegionSetup (
 322     ACPI_HANDLE             Handle,
 323     UINT32                  Function,
 324     void                    *HandlerContext,
 325     void                    **RegionContext);
 326
 327 ACPI_STATUS
 328 AcpiEvIoSpaceRegionSetup (
 329     ACPI_HANDLE             Handle,
 330     UINT32                  Function,
 331     void                    *HandlerContext,
 332     void                    **RegionContext);
 333
 334 ACPI_STATUS
 335 AcpiEvPciConfigRegionSetup (
 336     ACPI_HANDLE             Handle,
 337     UINT32                  Function,
 338     void                    *HandlerContext,
 339     void                    **RegionContext);
 340
 341 ACPI_STATUS
 342 AcpiEvCmosRegionSetup (
 343     ACPI_HANDLE             Handle,
 344     UINT32                  Function,
 345     void                    *HandlerContext,
 346     void                    **RegionContext);
 347
 348 ACPI_STATUS
 349 AcpiEvPciBarRegionSetup (
 350     ACPI_HANDLE             Handle,
 351     UINT32                  Function,
 352     void                    *HandlerContext,
 353     void                    **RegionContext);
 354
 355 ACPI_STATUS
 356 AcpiEvDefaultRegionSetup (
 357     ACPI_HANDLE             Handle,
 358     UINT32                  Function,
 359     void                    *HandlerContext,
 360     void                    **RegionContext);
 361
 362 ACPI_STATUS
 363 AcpiEvInitializeRegion (
 364     ACPI_OPERAND_OBJECT     *RegionObj,
 365     BOOLEAN                 AcpiNsLocked);
 366
 367
 368 /*
 369  * Evsci - SCI (System Control Interrupt) handling/dispatch
 370  */
 371
 372 UINT32 ACPI_SYSTEM_XFACE
 373 AcpiEvGpeXruptHandler (
 374     void                    *Context);
 375
 376 UINT32
 377 AcpiEvInstallSciHandler (
 378     void);
 379
 380 ACPI_STATUS
 381 AcpiEvRemoveSciHandler (
 382     void);
 383
 384 UINT32
 385 AcpiEvInitializeSCI (
 386     UINT32                  ProgramSCI);
 387
 388 void
 389 AcpiEvTerminate (
 390     void);
 391
 392
 393 #endif  /* __ACEVENTS_H__  */