reactos/drivers/bus/acpi/acpica/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 - 2015, 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_HW_DEPENDENT_RETURN_OK (
 161 ACPI_STATUS
 162 AcpiEvAcquireGlobalLock(
 163     UINT16                  Timeout))
 164
 165 ACPI_HW_DEPENDENT_RETURN_OK (
 166 ACPI_STATUS
 167 AcpiEvReleaseGlobalLock(
 168     void))
 169
 170 ACPI_STATUS
 171 AcpiEvRemoveGlobalLockHandler (
 172     void);
 173
 174
 175 /*
 176  * evgpe - Low-level GPE support
 177  */
 178 UINT32
 179 AcpiEvGpeDetect (
 180     ACPI_GPE_XRUPT_INFO     *GpeXruptList);
 181
 182 ACPI_STATUS
 183 AcpiEvUpdateGpeEnableMask (
 184     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
 185
 186 ACPI_STATUS
 187 AcpiEvEnableGpe (
 188     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
 189
 190 ACPI_STATUS
 191 AcpiEvAddGpeReference (
 192     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
 193
 194 ACPI_STATUS
 195 AcpiEvRemoveGpeReference (
 196     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
 197
 198 ACPI_GPE_EVENT_INFO *
 199 AcpiEvGetGpeEventInfo (
 200     ACPI_HANDLE             GpeDevice,
 201     UINT32                  GpeNumber);
 202
 203 ACPI_GPE_EVENT_INFO *
 204 AcpiEvLowGetGpeInfo (
 205     UINT32                  GpeNumber,
 206     ACPI_GPE_BLOCK_INFO     *GpeBlock);
 207
 208 ACPI_STATUS
 209 AcpiEvFinishGpe (
 210     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
 211
 212
 213 /*
 214  * evgpeblk - Upper-level GPE block support
 215  */
 216 ACPI_STATUS
 217 AcpiEvCreateGpeBlock (
 218     ACPI_NAMESPACE_NODE     *GpeDevice,
 219     UINT64                  Address,
 220     UINT8                   SpaceId,
 221     UINT32                  RegisterCount,
 222     UINT16                  GpeBlockBaseNumber,
 223     UINT32                  InterruptNumber,
 224     ACPI_GPE_BLOCK_INFO     **ReturnGpeBlock);
 225
 226 ACPI_STATUS
 227 AcpiEvInitializeGpeBlock (
 228     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
 229     ACPI_GPE_BLOCK_INFO     *GpeBlock,
 230     void                    *Context);
 231
 232 ACPI_HW_DEPENDENT_RETURN_OK (
 233 ACPI_STATUS
 234 AcpiEvDeleteGpeBlock (
 235     ACPI_GPE_BLOCK_INFO     *GpeBlock))
 236
 237 UINT32
 238 AcpiEvGpeDispatch (
 239     ACPI_NAMESPACE_NODE     *GpeDevice,
 240     ACPI_GPE_EVENT_INFO     *GpeEventInfo,
 241     UINT32                  GpeNumber);
 242
 243
 244 /*
 245  * evgpeinit - GPE initialization and update
 246  */
 247 ACPI_STATUS
 248 AcpiEvGpeInitialize (
 249     void);
 250
 251 ACPI_HW_DEPENDENT_RETURN_VOID (
 252 void
 253 AcpiEvUpdateGpes (
 254     ACPI_OWNER_ID           TableOwnerId))
 255
 256 ACPI_STATUS
 257 AcpiEvMatchGpeMethod (
 258     ACPI_HANDLE             ObjHandle,
 259     UINT32                  Level,
 260     void                    *Context,
 261     void                    **ReturnValue);
 262
 263
 264 /*
 265  * evgpeutil - GPE utilities
 266  */
 267 ACPI_STATUS
 268 AcpiEvWalkGpeList (
 269     ACPI_GPE_CALLBACK       GpeWalkCallback,
 270     void                    *Context);
 271
 272 ACPI_STATUS
 273 AcpiEvGetGpeDevice (
 274     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
 275     ACPI_GPE_BLOCK_INFO     *GpeBlock,
 276     void                    *Context);
 277
 278 ACPI_STATUS
 279 AcpiEvGetGpeXruptBlock (
 280     UINT32                  InterruptNumber,
 281     ACPI_GPE_XRUPT_INFO     **GpeXruptBlock);
 282
 283 ACPI_STATUS
 284 AcpiEvDeleteGpeXrupt (
 285     ACPI_GPE_XRUPT_INFO     *GpeXrupt);
 286
 287 ACPI_STATUS
 288 AcpiEvDeleteGpeHandlers (
 289     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
 290     ACPI_GPE_BLOCK_INFO     *GpeBlock,
 291     void                    *Context);
 292
 293
 294 /*
 295  * evhandler - Address space handling
 296  */
 297 ACPI_OPERAND_OBJECT *
 298 AcpiEvFindRegionHandler (
 299     ACPI_ADR_SPACE_TYPE     SpaceId,
 300     ACPI_OPERAND_OBJECT     *HandlerObj);
 301
 302 BOOLEAN
 303 AcpiEvHasDefaultHandler (
 304     ACPI_NAMESPACE_NODE     *Node,
 305     ACPI_ADR_SPACE_TYPE     SpaceId);
 306
 307 ACPI_STATUS
 308 AcpiEvInstallRegionHandlers (
 309     void);
 310
 311 ACPI_STATUS
 312 AcpiEvInstallSpaceHandler (
 313     ACPI_NAMESPACE_NODE     *Node,
 314     ACPI_ADR_SPACE_TYPE     SpaceId,
 315     ACPI_ADR_SPACE_HANDLER  Handler,
 316     ACPI_ADR_SPACE_SETUP    Setup,
 317     void                    *Context);
 318
 319
 320 /*
 321  * evregion - Operation region support
 322  */
 323 ACPI_STATUS
 324 AcpiEvInitializeOpRegions (
 325     void);
 326
 327 ACPI_STATUS
 328 AcpiEvAddressSpaceDispatch (
 329     ACPI_OPERAND_OBJECT     *RegionObj,
 330     ACPI_OPERAND_OBJECT     *FieldObj,
 331     UINT32                  Function,
 332     UINT32                  RegionOffset,
 333     UINT32                  BitWidth,
 334     UINT64                  *Value);
 335
 336 ACPI_STATUS
 337 AcpiEvAttachRegion (
 338     ACPI_OPERAND_OBJECT     *HandlerObj,
 339     ACPI_OPERAND_OBJECT     *RegionObj,
 340     BOOLEAN                 AcpiNsIsLocked);
 341
 342 void
 343 AcpiEvDetachRegion (
 344     ACPI_OPERAND_OBJECT     *RegionObj,
 345     BOOLEAN                 AcpiNsIsLocked);
 346
 347 void
 348 AcpiEvAssociateRegMethod (
 349     ACPI_OPERAND_OBJECT     *RegionObj);
 350
 351 void
 352 AcpiEvExecuteRegMethods (
 353     ACPI_NAMESPACE_NODE     *Node,
 354     ACPI_ADR_SPACE_TYPE     SpaceId,
 355     UINT32                  Function);
 356
 357 ACPI_STATUS
 358 AcpiEvExecuteRegMethod (
 359     ACPI_OPERAND_OBJECT     *RegionObj,
 360     UINT32                  Function);
 361
 362
 363 /*
 364  * evregini - Region initialization and setup
 365  */
 366 ACPI_STATUS
 367 AcpiEvSystemMemoryRegionSetup (
 368     ACPI_HANDLE             Handle,
 369     UINT32                  Function,
 370     void                    *HandlerContext,
 371     void                    **RegionContext);
 372
 373 ACPI_STATUS
 374 AcpiEvIoSpaceRegionSetup (
 375     ACPI_HANDLE             Handle,
 376     UINT32                  Function,
 377     void                    *HandlerContext,
 378     void                    **RegionContext);
 379
 380 ACPI_STATUS
 381 AcpiEvPciConfigRegionSetup (
 382     ACPI_HANDLE             Handle,
 383     UINT32                  Function,
 384     void                    *HandlerContext,
 385     void                    **RegionContext);
 386
 387 ACPI_STATUS
 388 AcpiEvCmosRegionSetup (
 389     ACPI_HANDLE             Handle,
 390     UINT32                  Function,
 391     void                    *HandlerContext,
 392     void                    **RegionContext);
 393
 394 ACPI_STATUS
 395 AcpiEvPciBarRegionSetup (
 396     ACPI_HANDLE             Handle,
 397     UINT32                  Function,
 398     void                    *HandlerContext,
 399     void                    **RegionContext);
 400
 401 ACPI_STATUS
 402 AcpiEvDefaultRegionSetup (
 403     ACPI_HANDLE             Handle,
 404     UINT32                  Function,
 405     void                    *HandlerContext,
 406     void                    **RegionContext);
 407
 408 ACPI_STATUS
 409 AcpiEvInitializeRegion (
 410     ACPI_OPERAND_OBJECT     *RegionObj,
 411     BOOLEAN                 AcpiNsLocked);
 412
 413
 414 /*
 415  * evsci - SCI (System Control Interrupt) handling/dispatch
 416  */
 417 UINT32 ACPI_SYSTEM_XFACE
 418 AcpiEvGpeXruptHandler (
 419     void                    *Context);
 420
 421 UINT32
 422 AcpiEvSciDispatch (
 423     void);
 424
 425 UINT32
 426 AcpiEvInstallSciHandler (
 427     void);
 428
 429 ACPI_STATUS
 430 AcpiEvRemoveAllSciHandlers (
 431     void);
 432
 433 ACPI_HW_DEPENDENT_RETURN_VOID (
 434 void
 435 AcpiEvTerminate (
 436     void))
 437
 438 #endif  /* __ACEVENTS_H__  */