Home | History | Annotate | Line # | Download | only in include
acevents.h revision 1.1.1.5
      1      1.1    jruoho /******************************************************************************
      2      1.1    jruoho  *
      3      1.1    jruoho  * Name: acevents.h - Event subcomponent prototypes and defines
      4      1.1    jruoho  *
      5      1.1    jruoho  *****************************************************************************/
      6      1.1    jruoho 
      7  1.1.1.2    jruoho /*
      8  1.1.1.5  christos  * Copyright (C) 2000 - 2014, Intel Corp.
      9      1.1    jruoho  * All rights reserved.
     10      1.1    jruoho  *
     11  1.1.1.2    jruoho  * Redistribution and use in source and binary forms, with or without
     12  1.1.1.2    jruoho  * modification, are permitted provided that the following conditions
     13  1.1.1.2    jruoho  * are met:
     14  1.1.1.2    jruoho  * 1. Redistributions of source code must retain the above copyright
     15  1.1.1.2    jruoho  *    notice, this list of conditions, and the following disclaimer,
     16  1.1.1.2    jruoho  *    without modification.
     17  1.1.1.2    jruoho  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
     18  1.1.1.2    jruoho  *    substantially similar to the "NO WARRANTY" disclaimer below
     19  1.1.1.2    jruoho  *    ("Disclaimer") and any redistribution must be conditioned upon
     20  1.1.1.2    jruoho  *    including a substantially similar Disclaimer requirement for further
     21  1.1.1.2    jruoho  *    binary redistribution.
     22  1.1.1.2    jruoho  * 3. Neither the names of the above-listed copyright holders nor the names
     23  1.1.1.2    jruoho  *    of any contributors may be used to endorse or promote products derived
     24  1.1.1.2    jruoho  *    from this software without specific prior written permission.
     25  1.1.1.2    jruoho  *
     26  1.1.1.2    jruoho  * Alternatively, this software may be distributed under the terms of the
     27  1.1.1.2    jruoho  * GNU General Public License ("GPL") version 2 as published by the Free
     28  1.1.1.2    jruoho  * Software Foundation.
     29  1.1.1.2    jruoho  *
     30  1.1.1.2    jruoho  * NO WARRANTY
     31  1.1.1.2    jruoho  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     32  1.1.1.2    jruoho  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     33  1.1.1.2    jruoho  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
     34  1.1.1.2    jruoho  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     35  1.1.1.2    jruoho  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     36  1.1.1.2    jruoho  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     37  1.1.1.2    jruoho  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     38  1.1.1.2    jruoho  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
     39  1.1.1.2    jruoho  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
     40  1.1.1.2    jruoho  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     41  1.1.1.2    jruoho  * POSSIBILITY OF SUCH DAMAGES.
     42  1.1.1.2    jruoho  */
     43      1.1    jruoho 
     44      1.1    jruoho #ifndef __ACEVENTS_H__
     45      1.1    jruoho #define __ACEVENTS_H__
     46      1.1    jruoho 
     47      1.1    jruoho 
     48      1.1    jruoho /*
     49      1.1    jruoho  * evevent
     50      1.1    jruoho  */
     51      1.1    jruoho ACPI_STATUS
     52      1.1    jruoho AcpiEvInitializeEvents (
     53      1.1    jruoho     void);
     54      1.1    jruoho 
     55      1.1    jruoho ACPI_STATUS
     56      1.1    jruoho AcpiEvInstallXruptHandlers (
     57      1.1    jruoho     void);
     58      1.1    jruoho 
     59      1.1    jruoho UINT32
     60      1.1    jruoho AcpiEvFixedEventDetect (
     61      1.1    jruoho     void);
     62      1.1    jruoho 
     63      1.1    jruoho 
     64      1.1    jruoho /*
     65      1.1    jruoho  * evmisc
     66      1.1    jruoho  */
     67      1.1    jruoho BOOLEAN
     68      1.1    jruoho AcpiEvIsNotifyObject (
     69      1.1    jruoho     ACPI_NAMESPACE_NODE     *Node);
     70      1.1    jruoho 
     71  1.1.1.3    jruoho UINT32
     72  1.1.1.3    jruoho AcpiEvGetGpeNumberIndex (
     73  1.1.1.3    jruoho     UINT32                  GpeNumber);
     74  1.1.1.3    jruoho 
     75  1.1.1.3    jruoho ACPI_STATUS
     76  1.1.1.3    jruoho AcpiEvQueueNotifyRequest (
     77  1.1.1.3    jruoho     ACPI_NAMESPACE_NODE     *Node,
     78  1.1.1.3    jruoho     UINT32                  NotifyValue);
     79  1.1.1.3    jruoho 
     80  1.1.1.3    jruoho 
     81  1.1.1.3    jruoho /*
     82  1.1.1.3    jruoho  * evglock - Global Lock support
     83  1.1.1.3    jruoho  */
     84  1.1.1.3    jruoho ACPI_STATUS
     85  1.1.1.3    jruoho AcpiEvInitGlobalLockHandler (
     86  1.1.1.3    jruoho     void);
     87  1.1.1.3    jruoho 
     88  1.1.1.4  christos ACPI_HW_DEPENDENT_RETURN_OK (
     89      1.1    jruoho ACPI_STATUS
     90      1.1    jruoho AcpiEvAcquireGlobalLock(
     91  1.1.1.4  christos     UINT16                  Timeout))
     92      1.1    jruoho 
     93  1.1.1.4  christos ACPI_HW_DEPENDENT_RETURN_OK (
     94      1.1    jruoho ACPI_STATUS
     95      1.1    jruoho AcpiEvReleaseGlobalLock(
     96  1.1.1.4  christos     void))
     97      1.1    jruoho 
     98      1.1    jruoho ACPI_STATUS
     99  1.1.1.3    jruoho AcpiEvRemoveGlobalLockHandler (
    100      1.1    jruoho     void);
    101      1.1    jruoho 
    102      1.1    jruoho 
    103      1.1    jruoho /*
    104      1.1    jruoho  * evgpe - Low-level GPE support
    105      1.1    jruoho  */
    106      1.1    jruoho UINT32
    107      1.1    jruoho AcpiEvGpeDetect (
    108      1.1    jruoho     ACPI_GPE_XRUPT_INFO     *GpeXruptList);
    109      1.1    jruoho 
    110      1.1    jruoho ACPI_STATUS
    111  1.1.1.2    jruoho AcpiEvUpdateGpeEnableMask (
    112      1.1    jruoho     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
    113      1.1    jruoho 
    114      1.1    jruoho ACPI_STATUS
    115      1.1    jruoho AcpiEvEnableGpe (
    116      1.1    jruoho     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
    117      1.1    jruoho 
    118      1.1    jruoho ACPI_STATUS
    119  1.1.1.2    jruoho AcpiEvAddGpeReference (
    120  1.1.1.2    jruoho     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
    121  1.1.1.2    jruoho 
    122  1.1.1.2    jruoho ACPI_STATUS
    123  1.1.1.2    jruoho AcpiEvRemoveGpeReference (
    124      1.1    jruoho     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
    125      1.1    jruoho 
    126      1.1    jruoho ACPI_GPE_EVENT_INFO *
    127      1.1    jruoho AcpiEvGetGpeEventInfo (
    128      1.1    jruoho     ACPI_HANDLE             GpeDevice,
    129      1.1    jruoho     UINT32                  GpeNumber);
    130      1.1    jruoho 
    131      1.1    jruoho ACPI_GPE_EVENT_INFO *
    132      1.1    jruoho AcpiEvLowGetGpeInfo (
    133      1.1    jruoho     UINT32                  GpeNumber,
    134      1.1    jruoho     ACPI_GPE_BLOCK_INFO     *GpeBlock);
    135      1.1    jruoho 
    136  1.1.1.2    jruoho ACPI_STATUS
    137  1.1.1.2    jruoho AcpiEvFinishGpe (
    138  1.1.1.2    jruoho     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
    139  1.1.1.2    jruoho 
    140      1.1    jruoho 
    141      1.1    jruoho /*
    142      1.1    jruoho  * evgpeblk - Upper-level GPE block support
    143      1.1    jruoho  */
    144      1.1    jruoho ACPI_STATUS
    145      1.1    jruoho AcpiEvCreateGpeBlock (
    146      1.1    jruoho     ACPI_NAMESPACE_NODE     *GpeDevice,
    147  1.1.1.5  christos     UINT64                  Address,
    148  1.1.1.5  christos     UINT8                   SpaceId,
    149      1.1    jruoho     UINT32                  RegisterCount,
    150  1.1.1.5  christos     UINT16                  GpeBlockBaseNumber,
    151      1.1    jruoho     UINT32                  InterruptNumber,
    152      1.1    jruoho     ACPI_GPE_BLOCK_INFO     **ReturnGpeBlock);
    153      1.1    jruoho 
    154      1.1    jruoho ACPI_STATUS
    155      1.1    jruoho AcpiEvInitializeGpeBlock (
    156  1.1.1.2    jruoho     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
    157  1.1.1.2    jruoho     ACPI_GPE_BLOCK_INFO     *GpeBlock,
    158  1.1.1.2    jruoho     void                    *Context);
    159      1.1    jruoho 
    160  1.1.1.4  christos ACPI_HW_DEPENDENT_RETURN_OK (
    161      1.1    jruoho ACPI_STATUS
    162      1.1    jruoho AcpiEvDeleteGpeBlock (
    163  1.1.1.4  christos     ACPI_GPE_BLOCK_INFO     *GpeBlock))
    164      1.1    jruoho 
    165      1.1    jruoho UINT32
    166      1.1    jruoho AcpiEvGpeDispatch (
    167  1.1.1.2    jruoho     ACPI_NAMESPACE_NODE     *GpeDevice,
    168      1.1    jruoho     ACPI_GPE_EVENT_INFO     *GpeEventInfo,
    169      1.1    jruoho     UINT32                  GpeNumber);
    170      1.1    jruoho 
    171  1.1.1.4  christos 
    172      1.1    jruoho /*
    173      1.1    jruoho  * evgpeinit - GPE initialization and update
    174      1.1    jruoho  */
    175      1.1    jruoho ACPI_STATUS
    176      1.1    jruoho AcpiEvGpeInitialize (
    177      1.1    jruoho     void);
    178      1.1    jruoho 
    179  1.1.1.4  christos ACPI_HW_DEPENDENT_RETURN_VOID (
    180      1.1    jruoho void
    181      1.1    jruoho AcpiEvUpdateGpes (
    182  1.1.1.4  christos     ACPI_OWNER_ID           TableOwnerId))
    183      1.1    jruoho 
    184      1.1    jruoho ACPI_STATUS
    185      1.1    jruoho AcpiEvMatchGpeMethod (
    186      1.1    jruoho     ACPI_HANDLE             ObjHandle,
    187      1.1    jruoho     UINT32                  Level,
    188      1.1    jruoho     void                    *Context,
    189      1.1    jruoho     void                    **ReturnValue);
    190      1.1    jruoho 
    191  1.1.1.4  christos 
    192      1.1    jruoho /*
    193      1.1    jruoho  * evgpeutil - GPE utilities
    194      1.1    jruoho  */
    195      1.1    jruoho ACPI_STATUS
    196      1.1    jruoho AcpiEvWalkGpeList (
    197      1.1    jruoho     ACPI_GPE_CALLBACK       GpeWalkCallback,
    198      1.1    jruoho     void                    *Context);
    199      1.1    jruoho 
    200      1.1    jruoho BOOLEAN
    201      1.1    jruoho AcpiEvValidGpeEvent (
    202      1.1    jruoho     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
    203      1.1    jruoho 
    204  1.1.1.2    jruoho ACPI_STATUS
    205  1.1.1.2    jruoho AcpiEvGetGpeDevice (
    206  1.1.1.2    jruoho     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
    207  1.1.1.2    jruoho     ACPI_GPE_BLOCK_INFO     *GpeBlock,
    208  1.1.1.2    jruoho     void                    *Context);
    209  1.1.1.2    jruoho 
    210  1.1.1.4  christos ACPI_STATUS
    211      1.1    jruoho AcpiEvGetGpeXruptBlock (
    212  1.1.1.4  christos     UINT32                  InterruptNumber,
    213  1.1.1.4  christos     ACPI_GPE_XRUPT_INFO     **GpeXruptBlock);
    214      1.1    jruoho 
    215      1.1    jruoho ACPI_STATUS
    216      1.1    jruoho AcpiEvDeleteGpeXrupt (
    217      1.1    jruoho     ACPI_GPE_XRUPT_INFO     *GpeXrupt);
    218      1.1    jruoho 
    219      1.1    jruoho ACPI_STATUS
    220      1.1    jruoho AcpiEvDeleteGpeHandlers (
    221      1.1    jruoho     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
    222      1.1    jruoho     ACPI_GPE_BLOCK_INFO     *GpeBlock,
    223      1.1    jruoho     void                    *Context);
    224      1.1    jruoho 
    225      1.1    jruoho 
    226      1.1    jruoho /*
    227  1.1.1.4  christos  * evhandler - Address space handling
    228      1.1    jruoho  */
    229  1.1.1.4  christos BOOLEAN
    230  1.1.1.4  christos AcpiEvHasDefaultHandler (
    231  1.1.1.4  christos     ACPI_NAMESPACE_NODE     *Node,
    232  1.1.1.4  christos     ACPI_ADR_SPACE_TYPE     SpaceId);
    233  1.1.1.4  christos 
    234      1.1    jruoho ACPI_STATUS
    235      1.1    jruoho AcpiEvInstallRegionHandlers (
    236      1.1    jruoho     void);
    237      1.1    jruoho 
    238      1.1    jruoho ACPI_STATUS
    239  1.1.1.4  christos AcpiEvInstallSpaceHandler (
    240  1.1.1.4  christos     ACPI_NAMESPACE_NODE     *Node,
    241  1.1.1.4  christos     ACPI_ADR_SPACE_TYPE     SpaceId,
    242  1.1.1.4  christos     ACPI_ADR_SPACE_HANDLER  Handler,
    243  1.1.1.4  christos     ACPI_ADR_SPACE_SETUP    Setup,
    244  1.1.1.4  christos     void                    *Context);
    245  1.1.1.4  christos 
    246  1.1.1.4  christos 
    247  1.1.1.4  christos /*
    248  1.1.1.4  christos  * evregion - Operation region support
    249  1.1.1.4  christos  */
    250  1.1.1.4  christos ACPI_STATUS
    251      1.1    jruoho AcpiEvInitializeOpRegions (
    252      1.1    jruoho     void);
    253      1.1    jruoho 
    254      1.1    jruoho ACPI_STATUS
    255      1.1    jruoho AcpiEvAddressSpaceDispatch (
    256  1.1.1.4  christos     ACPI_OPERAND_OBJECT     *RegionObj,
    257  1.1.1.4  christos     ACPI_OPERAND_OBJECT     *FieldObj,
    258      1.1    jruoho     UINT32                  Function,
    259      1.1    jruoho     UINT32                  RegionOffset,
    260      1.1    jruoho     UINT32                  BitWidth,
    261      1.1    jruoho     UINT64                  *Value);
    262      1.1    jruoho 
    263      1.1    jruoho ACPI_STATUS
    264      1.1    jruoho AcpiEvAttachRegion (
    265      1.1    jruoho     ACPI_OPERAND_OBJECT     *HandlerObj,
    266      1.1    jruoho     ACPI_OPERAND_OBJECT     *RegionObj,
    267      1.1    jruoho     BOOLEAN                 AcpiNsIsLocked);
    268      1.1    jruoho 
    269      1.1    jruoho void
    270      1.1    jruoho AcpiEvDetachRegion (
    271      1.1    jruoho     ACPI_OPERAND_OBJECT    *RegionObj,
    272      1.1    jruoho     BOOLEAN                 AcpiNsIsLocked);
    273      1.1    jruoho 
    274      1.1    jruoho ACPI_STATUS
    275      1.1    jruoho AcpiEvExecuteRegMethods (
    276      1.1    jruoho     ACPI_NAMESPACE_NODE     *Node,
    277      1.1    jruoho     ACPI_ADR_SPACE_TYPE     SpaceId);
    278      1.1    jruoho 
    279      1.1    jruoho ACPI_STATUS
    280      1.1    jruoho AcpiEvExecuteRegMethod (
    281      1.1    jruoho     ACPI_OPERAND_OBJECT    *RegionObj,
    282      1.1    jruoho     UINT32                  Function);
    283      1.1    jruoho 
    284      1.1    jruoho 
    285      1.1    jruoho /*
    286      1.1    jruoho  * evregini - Region initialization and setup
    287      1.1    jruoho  */
    288      1.1    jruoho ACPI_STATUS
    289      1.1    jruoho AcpiEvSystemMemoryRegionSetup (
    290      1.1    jruoho     ACPI_HANDLE             Handle,
    291      1.1    jruoho     UINT32                  Function,
    292      1.1    jruoho     void                    *HandlerContext,
    293      1.1    jruoho     void                    **RegionContext);
    294      1.1    jruoho 
    295      1.1    jruoho ACPI_STATUS
    296      1.1    jruoho AcpiEvIoSpaceRegionSetup (
    297      1.1    jruoho     ACPI_HANDLE             Handle,
    298      1.1    jruoho     UINT32                  Function,
    299      1.1    jruoho     void                    *HandlerContext,
    300      1.1    jruoho     void                    **RegionContext);
    301      1.1    jruoho 
    302      1.1    jruoho ACPI_STATUS
    303      1.1    jruoho AcpiEvPciConfigRegionSetup (
    304      1.1    jruoho     ACPI_HANDLE             Handle,
    305      1.1    jruoho     UINT32                  Function,
    306      1.1    jruoho     void                    *HandlerContext,
    307      1.1    jruoho     void                    **RegionContext);
    308      1.1    jruoho 
    309      1.1    jruoho ACPI_STATUS
    310      1.1    jruoho AcpiEvCmosRegionSetup (
    311      1.1    jruoho     ACPI_HANDLE             Handle,
    312      1.1    jruoho     UINT32                  Function,
    313      1.1    jruoho     void                    *HandlerContext,
    314      1.1    jruoho     void                    **RegionContext);
    315      1.1    jruoho 
    316      1.1    jruoho ACPI_STATUS
    317      1.1    jruoho AcpiEvPciBarRegionSetup (
    318      1.1    jruoho     ACPI_HANDLE             Handle,
    319      1.1    jruoho     UINT32                  Function,
    320      1.1    jruoho     void                    *HandlerContext,
    321      1.1    jruoho     void                    **RegionContext);
    322      1.1    jruoho 
    323      1.1    jruoho ACPI_STATUS
    324      1.1    jruoho AcpiEvDefaultRegionSetup (
    325      1.1    jruoho     ACPI_HANDLE             Handle,
    326      1.1    jruoho     UINT32                  Function,
    327      1.1    jruoho     void                    *HandlerContext,
    328      1.1    jruoho     void                    **RegionContext);
    329      1.1    jruoho 
    330      1.1    jruoho ACPI_STATUS
    331      1.1    jruoho AcpiEvInitializeRegion (
    332      1.1    jruoho     ACPI_OPERAND_OBJECT     *RegionObj,
    333      1.1    jruoho     BOOLEAN                 AcpiNsLocked);
    334      1.1    jruoho 
    335      1.1    jruoho 
    336      1.1    jruoho /*
    337      1.1    jruoho  * evsci - SCI (System Control Interrupt) handling/dispatch
    338      1.1    jruoho  */
    339      1.1    jruoho UINT32 ACPI_SYSTEM_XFACE
    340      1.1    jruoho AcpiEvGpeXruptHandler (
    341      1.1    jruoho     void                    *Context);
    342      1.1    jruoho 
    343      1.1    jruoho UINT32
    344  1.1.1.4  christos AcpiEvSciDispatch (
    345  1.1.1.4  christos     void);
    346  1.1.1.4  christos 
    347  1.1.1.4  christos UINT32
    348      1.1    jruoho AcpiEvInstallSciHandler (
    349      1.1    jruoho     void);
    350      1.1    jruoho 
    351      1.1    jruoho ACPI_STATUS
    352  1.1.1.4  christos AcpiEvRemoveAllSciHandlers (
    353      1.1    jruoho     void);
    354      1.1    jruoho 
    355  1.1.1.4  christos ACPI_HW_DEPENDENT_RETURN_VOID (
    356      1.1    jruoho void
    357      1.1    jruoho AcpiEvTerminate (
    358  1.1.1.4  christos     void))
    359      1.1    jruoho 
    360      1.1    jruoho #endif  /* __ACEVENTS_H__  */
    361