sys/contrib/dev/acpica/source/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 - 2018, 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  * Alternatively, you may choose to be licensed under the terms of the
 117  * following license:
 118  *
 119  * Redistribution and use in source and binary forms, with or without
 120  * modification, are permitted provided that the following conditions
 121  * are met:
 122  * 1. Redistributions of source code must retain the above copyright
 123  *    notice, this list of conditions, and the following disclaimer,
 124  *    without modification.
 125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 126  *    substantially similar to the "NO WARRANTY" disclaimer below
 127  *    ("Disclaimer") and any redistribution must be conditioned upon
 128  *    including a substantially similar Disclaimer requirement for further
 129  *    binary redistribution.
 130  * 3. Neither the names of the above-listed copyright holders nor the names
 131  *    of any contributors may be used to endorse or promote products derived
 132  *    from this software without specific prior written permission.
 133  *
 134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 145  *
 146  * Alternatively, you may choose to be licensed under the terms of the
 147  * GNU General Public License ("GPL") version 2 as published by the Free
 148  * Software Foundation.
 149  *
 150  *****************************************************************************/
 151
 152 #ifndef __ACEVENTS_H__
 153 #define __ACEVENTS_H__
 154
 155
 156 /*
 157  * Conditions to trigger post enabling GPE polling:
 158  * It is not sufficient to trigger edge-triggered GPE with specific GPE
 159  * chips, software need to poll once after enabling.
 160  */
 161 #ifdef ACPI_USE_GPE_POLLING
 162 #define ACPI_GPE_IS_POLLING_NEEDED(__gpe__)             \
 163     ((__gpe__)->RuntimeCount == 1 &&                    \
 164      (__gpe__)->Flags & ACPI_GPE_INITIALIZED &&         \
 165      ((__gpe__)->Flags & ACPI_GPE_XRUPT_TYPE_MASK) == ACPI_GPE_EDGE_TRIGGERED)
 166 #else
 167 #define ACPI_GPE_IS_POLLING_NEEDED(__gpe__)             FALSE
 168 #endif
 169
 170
 171 /*
 172  * evevent
 173  */
 174 ACPI_STATUS
 175 AcpiEvInitializeEvents (
 176     void);
 177
 178 ACPI_STATUS
 179 AcpiEvInstallXruptHandlers (
 180     void);
 181
 182 UINT32
 183 AcpiEvFixedEventDetect (
 184     void);
 185
 186
 187 /*
 188  * evmisc
 189  */
 190 BOOLEAN
 191 AcpiEvIsNotifyObject (
 192     ACPI_NAMESPACE_NODE     *Node);
 193
 194 UINT32
 195 AcpiEvGetGpeNumberIndex (
 196     UINT32                  GpeNumber);
 197
 198 ACPI_STATUS
 199 AcpiEvQueueNotifyRequest (
 200     ACPI_NAMESPACE_NODE     *Node,
 201     UINT32                  NotifyValue);
 202
 203
 204 /*
 205  * evglock - Global Lock support
 206  */
 207 ACPI_STATUS
 208 AcpiEvInitGlobalLockHandler (
 209     void);
 210
 211 ACPI_HW_DEPENDENT_RETURN_OK (
 212 ACPI_STATUS
 213 AcpiEvAcquireGlobalLock(
 214     UINT16                  Timeout))
 215
 216 ACPI_HW_DEPENDENT_RETURN_OK (
 217 ACPI_STATUS
 218 AcpiEvReleaseGlobalLock(
 219     void))
 220
 221 ACPI_STATUS
 222 AcpiEvRemoveGlobalLockHandler (
 223     void);
 224
 225
 226 /*
 227  * evgpe - Low-level GPE support
 228  */
 229 UINT32
 230 AcpiEvGpeDetect (
 231     ACPI_GPE_XRUPT_INFO     *GpeXruptList);
 232
 233 ACPI_STATUS
 234 AcpiEvUpdateGpeEnableMask (
 235     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
 236
 237 ACPI_STATUS
 238 AcpiEvEnableGpe (
 239     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
 240
 241 ACPI_STATUS
 242 AcpiEvMaskGpe (
 243     ACPI_GPE_EVENT_INFO     *GpeEventInfo,
 244     BOOLEAN                 IsMasked);
 245
 246 ACPI_STATUS
 247 AcpiEvAddGpeReference (
 248     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
 249
 250 ACPI_STATUS
 251 AcpiEvRemoveGpeReference (
 252     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
 253
 254 ACPI_GPE_EVENT_INFO *
 255 AcpiEvGetGpeEventInfo (
 256     ACPI_HANDLE             GpeDevice,
 257     UINT32                  GpeNumber);
 258
 259 ACPI_GPE_EVENT_INFO *
 260 AcpiEvLowGetGpeInfo (
 261     UINT32                  GpeNumber,
 262     ACPI_GPE_BLOCK_INFO     *GpeBlock);
 263
 264 ACPI_STATUS
 265 AcpiEvFinishGpe (
 266     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
 267
 268 UINT32
 269 AcpiEvDetectGpe (
 270     ACPI_NAMESPACE_NODE     *GpeDevice,
 271     ACPI_GPE_EVENT_INFO     *GpeEventInfo,
 272     UINT32                  GpeNumber);
 273
 274
 275 /*
 276  * evgpeblk - Upper-level GPE block support
 277  */
 278 ACPI_STATUS
 279 AcpiEvCreateGpeBlock (
 280     ACPI_NAMESPACE_NODE     *GpeDevice,
 281     UINT64                  Address,
 282     UINT8                   SpaceId,
 283     UINT32                  RegisterCount,
 284     UINT16                  GpeBlockBaseNumber,
 285     UINT32                  InterruptNumber,
 286     ACPI_GPE_BLOCK_INFO     **ReturnGpeBlock);
 287
 288 ACPI_STATUS
 289 AcpiEvInitializeGpeBlock (
 290     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
 291     ACPI_GPE_BLOCK_INFO     *GpeBlock,
 292     void                    *Context);
 293
 294 ACPI_HW_DEPENDENT_RETURN_OK (
 295 ACPI_STATUS
 296 AcpiEvDeleteGpeBlock (
 297     ACPI_GPE_BLOCK_INFO     *GpeBlock))
 298
 299 UINT32
 300 AcpiEvGpeDispatch (
 301     ACPI_NAMESPACE_NODE     *GpeDevice,
 302     ACPI_GPE_EVENT_INFO     *GpeEventInfo,
 303     UINT32                  GpeNumber);
 304
 305
 306 /*
 307  * evgpeinit - GPE initialization and update
 308  */
 309 ACPI_STATUS
 310 AcpiEvGpeInitialize (
 311     void);
 312
 313 ACPI_HW_DEPENDENT_RETURN_VOID (
 314 void
 315 AcpiEvUpdateGpes (
 316     ACPI_OWNER_ID           TableOwnerId))
 317
 318 ACPI_STATUS
 319 AcpiEvMatchGpeMethod (
 320     ACPI_HANDLE             ObjHandle,
 321     UINT32                  Level,
 322     void                    *Context,
 323     void                    **ReturnValue);
 324
 325
 326 /*
 327  * evgpeutil - GPE utilities
 328  */
 329 ACPI_STATUS
 330 AcpiEvWalkGpeList (
 331     ACPI_GPE_CALLBACK       GpeWalkCallback,
 332     void                    *Context);
 333
 334 ACPI_STATUS
 335 AcpiEvGetGpeDevice (
 336     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
 337     ACPI_GPE_BLOCK_INFO     *GpeBlock,
 338     void                    *Context);
 339
 340 ACPI_STATUS
 341 AcpiEvGetGpeXruptBlock (
 342     UINT32                  InterruptNumber,
 343     ACPI_GPE_XRUPT_INFO     **GpeXruptBlock);
 344
 345 ACPI_STATUS
 346 AcpiEvDeleteGpeXrupt (
 347     ACPI_GPE_XRUPT_INFO     *GpeXrupt);
 348
 349 ACPI_STATUS
 350 AcpiEvDeleteGpeHandlers (
 351     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
 352     ACPI_GPE_BLOCK_INFO     *GpeBlock,
 353     void                    *Context);
 354
 355
 356 /*
 357  * evhandler - Address space handling
 358  */
 359 ACPI_OPERAND_OBJECT *
 360 AcpiEvFindRegionHandler (
 361     ACPI_ADR_SPACE_TYPE     SpaceId,
 362     ACPI_OPERAND_OBJECT     *HandlerObj);
 363
 364 BOOLEAN
 365 AcpiEvHasDefaultHandler (
 366     ACPI_NAMESPACE_NODE     *Node,
 367     ACPI_ADR_SPACE_TYPE     SpaceId);
 368
 369 ACPI_STATUS
 370 AcpiEvInstallRegionHandlers (
 371     void);
 372
 373 ACPI_STATUS
 374 AcpiEvInstallSpaceHandler (
 375     ACPI_NAMESPACE_NODE     *Node,
 376     ACPI_ADR_SPACE_TYPE     SpaceId,
 377     ACPI_ADR_SPACE_HANDLER  Handler,
 378     ACPI_ADR_SPACE_SETUP    Setup,
 379     void                    *Context);
 380
 381
 382 /*
 383  * evregion - Operation region support
 384  */
 385 ACPI_STATUS
 386 AcpiEvInitializeOpRegions (
 387     void);
 388
 389 ACPI_STATUS
 390 AcpiEvAddressSpaceDispatch (
 391     ACPI_OPERAND_OBJECT     *RegionObj,
 392     ACPI_OPERAND_OBJECT     *FieldObj,
 393     UINT32                  Function,
 394     UINT32                  RegionOffset,
 395     UINT32                  BitWidth,
 396     UINT64                  *Value);
 397
 398 ACPI_STATUS
 399 AcpiEvAttachRegion (
 400     ACPI_OPERAND_OBJECT     *HandlerObj,
 401     ACPI_OPERAND_OBJECT     *RegionObj,
 402     BOOLEAN                 AcpiNsIsLocked);
 403
 404 void
 405 AcpiEvDetachRegion (
 406     ACPI_OPERAND_OBJECT     *RegionObj,
 407     BOOLEAN                 AcpiNsIsLocked);
 408
 409 void
 410 AcpiEvExecuteRegMethods (
 411     ACPI_NAMESPACE_NODE     *Node,
 412     ACPI_ADR_SPACE_TYPE     SpaceId,
 413     UINT32                  Function);
 414
 415 ACPI_STATUS
 416 AcpiEvExecuteRegMethod (
 417     ACPI_OPERAND_OBJECT     *RegionObj,
 418     UINT32                  Function);
 419
 420
 421 /*
 422  * evregini - Region initialization and setup
 423  */
 424 ACPI_STATUS
 425 AcpiEvSystemMemoryRegionSetup (
 426     ACPI_HANDLE             Handle,
 427     UINT32                  Function,
 428     void                    *HandlerContext,
 429     void                    **RegionContext);
 430
 431 ACPI_STATUS
 432 AcpiEvIoSpaceRegionSetup (
 433     ACPI_HANDLE             Handle,
 434     UINT32                  Function,
 435     void                    *HandlerContext,
 436     void                    **RegionContext);
 437
 438 ACPI_STATUS
 439 AcpiEvPciConfigRegionSetup (
 440     ACPI_HANDLE             Handle,
 441     UINT32                  Function,
 442     void                    *HandlerContext,
 443     void                    **RegionContext);
 444
 445 ACPI_STATUS
 446 AcpiEvCmosRegionSetup (
 447     ACPI_HANDLE             Handle,
 448     UINT32                  Function,
 449     void                    *HandlerContext,
 450     void                    **RegionContext);
 451
 452 ACPI_STATUS
 453 AcpiEvPciBarRegionSetup (
 454     ACPI_HANDLE             Handle,
 455     UINT32                  Function,
 456     void                    *HandlerContext,
 457     void                    **RegionContext);
 458
 459 ACPI_STATUS
 460 AcpiEvDefaultRegionSetup (
 461     ACPI_HANDLE             Handle,
 462     UINT32                  Function,
 463     void                    *HandlerContext,
 464     void                    **RegionContext);
 465
 466 ACPI_STATUS
 467 AcpiEvInitializeRegion (
 468     ACPI_OPERAND_OBJECT     *RegionObj);
 469
 470
 471 /*
 472  * evsci - SCI (System Control Interrupt) handling/dispatch
 473  */
 474 UINT32 ACPI_SYSTEM_XFACE
 475 AcpiEvGpeXruptHandler (
 476     void                    *Context);
 477
 478 UINT32
 479 AcpiEvSciDispatch (
 480     void);
 481
 482 UINT32
 483 AcpiEvInstallSciHandler (
 484     void);
 485
 486 ACPI_STATUS
 487 AcpiEvRemoveAllSciHandlers (
 488     void);
 489
 490 ACPI_HW_DEPENDENT_RETURN_VOID (
 491 void
 492 AcpiEvTerminate (
 493     void))
 494
 495 #endif  /* __ACEVENTS_H__  */