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