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

   1 /******************************************************************************
   2  *
   3  * Name: acevents.h - Event subcomponent prototypes and defines
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2011, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  16  * 2.1. This is your license from Intel Corp. under its intellectual property
  17  * rights.  You may have additional license terms from the party that provided
  18  * you this software, covering your right to use that party's intellectual
  19  * property rights.
  20  *
  21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  22  * copy of the source code appearing in this file ("Covered Code") an
  23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  24  * base code distributed originally by Intel ("Original Intel Code") to copy,
  25  * make derivatives, distribute, use and display any portion of the Covered
  26  * Code in any form, with the right to sublicense such rights; and
  27  *
  28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  29  * license (with the right to sublicense), under only those claims of Intel
  30  * patents that are infringed by the Original Intel Code, to make, use, sell,
  31  * offer to sell, and import the Covered Code and derivative works thereof
  32  * solely to the minimum extent necessary to exercise the above copyright
  33  * license, and in no event shall the patent license extend to any additions
  34  * to or modifications of the Original Intel Code.  No other license or right
  35  * is granted directly or by implication, estoppel or otherwise;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  43  * Redistribution of source code of any substantial portion of the Covered
  44  * Code or modification with rights to further distribute source must include
  45  * the above Copyright Notice, the above License, this list of Conditions,
  46  * and the following Disclaimer and Export Compliance provision.  In addition,
  47  * Licensee must cause all Covered Code to which Licensee contributes to
  48  * contain a file documenting the changes Licensee made to create that Covered
  49  * Code and the date of any change.  Licensee must include in that file the
  50  * documentation of any changes made by any predecessor Licensee.  Licensee
  51  * must include a prominent statement that the modification is derived,
  52  * directly or indirectly, from Original Intel Code.
  53  *
  54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  55  * Redistribution of source code of any substantial portion of the Covered
  56  * Code or modification without rights to further distribute source must
  57  * include the following Disclaimer and Export Compliance provision in the
  58  * documentation and/or other materials provided with distribution.  In
  59  * addition, Licensee may not authorize further sublicense of source of any
  60  * portion of the Covered Code, and must include terms to the effect that the
  61  * license from Licensee to its licensee is limited to the intellectual
  62  * property embodied in the software Licensee provides to its licensee, and
  63  * not to intellectual property embodied in modifications its licensee may
  64  * make.
  65  *
  66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  67  * substantial portion of the Covered Code or modification must reproduce the
  68  * above Copyright Notice, and the following Disclaimer and Export Compliance
  69  * provision in the documentation and/or other materials provided with the
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  76  * Intel shall be used in advertising or otherwise to promote the sale, use or
  77  * other dealings in products derived from or relating to the Covered Code
  78  * without prior written authorization from Intel.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  83  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  85  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  86  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  88  * PARTICULAR PURPOSE.
  89  *
  90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  97  * LIMITED REMEDY.
  98  *
  99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 100  * software or system incorporating such software without first obtaining any
 101  * required license or other approval from the U. S. Department of Commerce or
 102  * any other agency or department of the United States Government.  In the
 103  * event Licensee exports any such software from the United States or
 104  * re-exports any such software from a foreign destination, Licensee shall
 105  * ensure that the distribution and export/re-export of the software is in
 106  * compliance with all laws, regulations, orders, or other restrictions of the
 107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 108  * any of its subsidiaries will export/re-export any technical data, process,
 109  * software, or service, directly or indirectly, to any country for which the
 110  * United States government or any agency thereof requires an export license,
 111  * other governmental approval, or letter of assurance, without first obtaining
 112  * such license, approval or letter.
 113  *
 114  *****************************************************************************/
 115
 116 #ifndef __ACEVENTS_H__
 117 #define __ACEVENTS_H__
 118
 119
 120 /*
 121  * evevent
 122  */
 123 ACPI_STATUS
 124 AcpiEvInitializeEvents (
 125     void);
 126
 127 ACPI_STATUS
 128 AcpiEvInstallXruptHandlers (
 129     void);
 130
 131 UINT32
 132 AcpiEvFixedEventDetect (
 133     void);
 134
 135
 136 /*
 137  * evmisc
 138  */
 139 BOOLEAN
 140 AcpiEvIsNotifyObject (
 141     ACPI_NAMESPACE_NODE     *Node);
 142
 143 UINT32
 144 AcpiEvGetGpeNumberIndex (
 145     UINT32                  GpeNumber);
 146
 147 ACPI_STATUS
 148 AcpiEvQueueNotifyRequest (
 149     ACPI_NAMESPACE_NODE     *Node,
 150     UINT32                  NotifyValue);
 151
 152
 153 /*
 154  * evglock - Global Lock support
 155  */
 156 ACPI_STATUS
 157 AcpiEvInitGlobalLockHandler (
 158     void);
 159
 160 ACPI_STATUS
 161 AcpiEvAcquireGlobalLock(
 162     UINT16                  Timeout);
 163
 164 ACPI_STATUS
 165 AcpiEvReleaseGlobalLock(
 166     void);
 167
 168 ACPI_STATUS
 169 AcpiEvRemoveGlobalLockHandler (
 170     void);
 171
 172
 173 /*
 174  * evgpe - Low-level GPE support
 175  */
 176 UINT32
 177 AcpiEvGpeDetect (
 178     ACPI_GPE_XRUPT_INFO     *GpeXruptList);
 179
 180 ACPI_STATUS
 181 AcpiEvUpdateGpeEnableMask (
 182     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
 183
 184 ACPI_STATUS
 185 AcpiEvEnableGpe (
 186     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
 187
 188 ACPI_STATUS
 189 AcpiEvAddGpeReference (
 190     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
 191
 192 ACPI_STATUS
 193 AcpiEvRemoveGpeReference (
 194     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
 195
 196 ACPI_GPE_EVENT_INFO *
 197 AcpiEvGetGpeEventInfo (
 198     ACPI_HANDLE             GpeDevice,
 199     UINT32                  GpeNumber);
 200
 201 ACPI_GPE_EVENT_INFO *
 202 AcpiEvLowGetGpeInfo (
 203     UINT32                  GpeNumber,
 204     ACPI_GPE_BLOCK_INFO     *GpeBlock);
 205
 206 ACPI_STATUS
 207 AcpiEvFinishGpe (
 208     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
 209
 210
 211 /*
 212  * evgpeblk - Upper-level GPE block support
 213  */
 214 ACPI_STATUS
 215 AcpiEvCreateGpeBlock (
 216     ACPI_NAMESPACE_NODE     *GpeDevice,
 217     ACPI_GENERIC_ADDRESS    *GpeBlockAddress,
 218     UINT32                  RegisterCount,
 219     UINT8                   GpeBlockBaseNumber,
 220     UINT32                  InterruptNumber,
 221     ACPI_GPE_BLOCK_INFO     **ReturnGpeBlock);
 222
 223 ACPI_STATUS
 224 AcpiEvInitializeGpeBlock (
 225     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
 226     ACPI_GPE_BLOCK_INFO     *GpeBlock,
 227     void                    *Context);
 228
 229 ACPI_STATUS
 230 AcpiEvDeleteGpeBlock (
 231     ACPI_GPE_BLOCK_INFO     *GpeBlock);
 232
 233 UINT32
 234 AcpiEvGpeDispatch (
 235     ACPI_NAMESPACE_NODE     *GpeDevice,
 236     ACPI_GPE_EVENT_INFO     *GpeEventInfo,
 237     UINT32                  GpeNumber);
 238
 239 /*
 240  * evgpeinit - GPE initialization and update
 241  */
 242 ACPI_STATUS
 243 AcpiEvGpeInitialize (
 244     void);
 245
 246 void
 247 AcpiEvUpdateGpes (
 248     ACPI_OWNER_ID           TableOwnerId);
 249
 250 ACPI_STATUS
 251 AcpiEvMatchGpeMethod (
 252     ACPI_HANDLE             ObjHandle,
 253     UINT32                  Level,
 254     void                    *Context,
 255     void                    **ReturnValue);
 256
 257 /*
 258  * evgpeutil - GPE utilities
 259  */
 260 ACPI_STATUS
 261 AcpiEvWalkGpeList (
 262     ACPI_GPE_CALLBACK       GpeWalkCallback,
 263     void                    *Context);
 264
 265 BOOLEAN
 266 AcpiEvValidGpeEvent (
 267     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
 268
 269 ACPI_STATUS
 270 AcpiEvGetGpeDevice (
 271     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
 272     ACPI_GPE_BLOCK_INFO     *GpeBlock,
 273     void                    *Context);
 274
 275 ACPI_GPE_XRUPT_INFO *
 276 AcpiEvGetGpeXruptBlock (
 277     UINT32                  InterruptNumber);
 278
 279 ACPI_STATUS
 280 AcpiEvDeleteGpeXrupt (
 281     ACPI_GPE_XRUPT_INFO     *GpeXrupt);
 282
 283 ACPI_STATUS
 284 AcpiEvDeleteGpeHandlers (
 285     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
 286     ACPI_GPE_BLOCK_INFO     *GpeBlock,
 287     void                    *Context);
 288
 289
 290 /*
 291  * evregion - Address Space handling
 292  */
 293 ACPI_STATUS
 294 AcpiEvInstallRegionHandlers (
 295     void);
 296
 297 ACPI_STATUS
 298 AcpiEvInitializeOpRegions (
 299     void);
 300
 301 ACPI_STATUS
 302 AcpiEvAddressSpaceDispatch (
 303     ACPI_OPERAND_OBJECT    *RegionObj,
 304     UINT32                  Function,
 305     UINT32                  RegionOffset,
 306     UINT32                  BitWidth,
 307     UINT64                  *Value);
 308
 309 ACPI_STATUS
 310 AcpiEvAttachRegion (
 311     ACPI_OPERAND_OBJECT     *HandlerObj,
 312     ACPI_OPERAND_OBJECT     *RegionObj,
 313     BOOLEAN                 AcpiNsIsLocked);
 314
 315 void
 316 AcpiEvDetachRegion (
 317     ACPI_OPERAND_OBJECT    *RegionObj,
 318     BOOLEAN                 AcpiNsIsLocked);
 319
 320 ACPI_STATUS
 321 AcpiEvInstallSpaceHandler (
 322     ACPI_NAMESPACE_NODE     *Node,
 323     ACPI_ADR_SPACE_TYPE     SpaceId,
 324     ACPI_ADR_SPACE_HANDLER  Handler,
 325     ACPI_ADR_SPACE_SETUP    Setup,
 326     void                    *Context);
 327
 328 ACPI_STATUS
 329 AcpiEvExecuteRegMethods (
 330     ACPI_NAMESPACE_NODE     *Node,
 331     ACPI_ADR_SPACE_TYPE     SpaceId);
 332
 333 ACPI_STATUS
 334 AcpiEvExecuteRegMethod (
 335     ACPI_OPERAND_OBJECT    *RegionObj,
 336     UINT32                  Function);
 337
 338
 339 /*
 340  * evregini - Region initialization and setup
 341  */
 342 ACPI_STATUS
 343 AcpiEvSystemMemoryRegionSetup (
 344     ACPI_HANDLE             Handle,
 345     UINT32                  Function,
 346     void                    *HandlerContext,
 347     void                    **RegionContext);
 348
 349 ACPI_STATUS
 350 AcpiEvIoSpaceRegionSetup (
 351     ACPI_HANDLE             Handle,
 352     UINT32                  Function,
 353     void                    *HandlerContext,
 354     void                    **RegionContext);
 355
 356 ACPI_STATUS
 357 AcpiEvPciConfigRegionSetup (
 358     ACPI_HANDLE             Handle,
 359     UINT32                  Function,
 360     void                    *HandlerContext,
 361     void                    **RegionContext);
 362
 363 ACPI_STATUS
 364 AcpiEvCmosRegionSetup (
 365     ACPI_HANDLE             Handle,
 366     UINT32                  Function,
 367     void                    *HandlerContext,
 368     void                    **RegionContext);
 369
 370 ACPI_STATUS
 371 AcpiEvPciBarRegionSetup (
 372     ACPI_HANDLE             Handle,
 373     UINT32                  Function,
 374     void                    *HandlerContext,
 375     void                    **RegionContext);
 376
 377 ACPI_STATUS
 378 AcpiEvDefaultRegionSetup (
 379     ACPI_HANDLE             Handle,
 380     UINT32                  Function,
 381     void                    *HandlerContext,
 382     void                    **RegionContext);
 383
 384 ACPI_STATUS
 385 AcpiEvInitializeRegion (
 386     ACPI_OPERAND_OBJECT     *RegionObj,
 387     BOOLEAN                 AcpiNsLocked);
 388
 389
 390 /*
 391  * evsci - SCI (System Control Interrupt) handling/dispatch
 392  */
 393 UINT32 ACPI_SYSTEM_XFACE
 394 AcpiEvGpeXruptHandler (
 395     void                    *Context);
 396
 397 UINT32
 398 AcpiEvInstallSciHandler (
 399     void);
 400
 401 ACPI_STATUS
 402 AcpiEvRemoveSciHandler (
 403     void);
 404
 405 UINT32
 406 AcpiEvInitializeSCI (
 407     UINT32                  ProgramSCI);
 408
 409 void
 410 AcpiEvTerminate (
 411     void);
 412
 413
 414 #endif  /* __ACEVENTS_H__  */