reactos/drivers/bus/acpi/acpica/events/evsci.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: evsci - System Control Interrupt configuration and
   4  *                      legacy to ACPI mode state transition functions
   5  *
   6  ******************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2015, Intel Corp.
  13  * All rights reserved.
  14  *
  15  * 2. License
  16  *
  17  * 2.1. This is your license from Intel Corp. under its intellectual property
  18  * rights. You may have additional license terms from the party that provided
  19  * you this software, covering your right to use that party's intellectual
  20  * property rights.
  21  *
  22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  23  * copy of the source code appearing in this file ("Covered Code") an
  24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  25  * base code distributed originally by Intel ("Original Intel Code") to copy,
  26  * make derivatives, distribute, use and display any portion of the Covered
  27  * Code in any form, with the right to sublicense such rights; and
  28  *
  29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  30  * license (with the right to sublicense), under only those claims of Intel
  31  * patents that are infringed by the Original Intel Code, to make, use, sell,
  32  * offer to sell, and import the Covered Code and derivative works thereof
  33  * solely to the minimum extent necessary to exercise the above copyright
  34  * license, and in no event shall the patent license extend to any additions
  35  * to or modifications of the Original Intel Code. No other license or right
  36  * is granted directly or by implication, estoppel or otherwise;
  37  *
  38  * The above copyright and patent license is granted only if the following
  39  * conditions are met:
  40  *
  41  * 3. Conditions
  42  *
  43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  44  * Redistribution of source code of any substantial portion of the Covered
  45  * Code or modification with rights to further distribute source must include
  46  * the above Copyright Notice, the above License, this list of Conditions,
  47  * and the following Disclaimer and Export Compliance provision. In addition,
  48  * Licensee must cause all Covered Code to which Licensee contributes to
  49  * contain a file documenting the changes Licensee made to create that Covered
  50  * Code and the date of any change. Licensee must include in that file the
  51  * documentation of any changes made by any predecessor Licensee. Licensee
  52  * must include a prominent statement that the modification is derived,
  53  * directly or indirectly, from Original Intel Code.
  54  *
  55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  56  * Redistribution of source code of any substantial portion of the Covered
  57  * Code or modification without rights to further distribute source must
  58  * include the following Disclaimer and Export Compliance provision in the
  59  * documentation and/or other materials provided with distribution. In
  60  * addition, Licensee may not authorize further sublicense of source of any
  61  * portion of the Covered Code, and must include terms to the effect that the
  62  * license from Licensee to its licensee is limited to the intellectual
  63  * property embodied in the software Licensee provides to its licensee, and
  64  * not to intellectual property embodied in modifications its licensee may
  65
  66  * make.
  67  *
  68  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  69  * substantial portion of the Covered Code or modification must reproduce the
  70  * above Copyright Notice, and the following Disclaimer and Export Compliance
  71  * provision in the documentation and/or other materials provided with the
  72  * distribution.
  73  *
  74  * 3.4. Intel retains all right, title, and interest in and to the Original
  75  * Intel Code.
  76  *
  77  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  78  * Intel shall be used in advertising or otherwise to promote the sale, use or
  79  * other dealings in products derived from or relating to the Covered Code
  80  * without prior written authorization from Intel.
  81  *
  82  * 4. Disclaimer and Export Compliance
  83  *
  84  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  85  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  86  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
  87  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
  88  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
  89  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  90  * PARTICULAR PURPOSE.
  91  *
  92  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  93  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  94  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  95  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  96  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  97  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
  98  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  99  * LIMITED REMEDY.
 100  *
 101  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 102  * software or system incorporating such software without first obtaining any
 103  * required license or other approval from the U. S. Department of Commerce or
 104  * any other agency or department of the United States Government. In the
 105  * event Licensee exports any such software from the United States or
 106  * re-exports any such software from a foreign destination, Licensee shall
 107  * ensure that the distribution and export/re-export of the software is in
 108  * compliance with all laws, regulations, orders, or other restrictions of the
 109  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 110  * any of its subsidiaries will export/re-export any technical data, process,
 111  * software, or service, directly or indirectly, to any country for which the
 112  * United States government or any agency thereof requires an export license,
 113  * other governmental approval, or letter of assurance, without first obtaining
 114  * such license, approval or letter.
 115  *
 116  *****************************************************************************/
 117
 118 #include "acpi.h"
 119 #include "accommon.h"
 120 #include "acevents.h"
 121
 122
 123 #define _COMPONENT          ACPI_EVENTS
 124         ACPI_MODULE_NAME    ("evsci")
 125
 126 #if (!ACPI_REDUCED_HARDWARE) /* Entire module */
 127
 128 /* Local prototypes */
 129
 130 static UINT32 ACPI_SYSTEM_XFACE
 131 AcpiEvSciXruptHandler (
 132     void                    *Context);
 133
 134
 135 /*******************************************************************************
 136  *
 137  * FUNCTION:    AcpiEvSciDispatch
 138  *
 139  * PARAMETERS:  None
 140  *
 141  * RETURN:      Status code indicates whether interrupt was handled.
 142  *
 143  * DESCRIPTION: Dispatch the SCI to all host-installed SCI handlers.
 144  *
 145  ******************************************************************************/
 146
 147 UINT32
 148 AcpiEvSciDispatch (
 149     void)
 150 {
 151     ACPI_SCI_HANDLER_INFO   *SciHandler;
 152     ACPI_CPU_FLAGS          Flags;
 153     UINT32                  IntStatus = ACPI_INTERRUPT_NOT_HANDLED;
 154
 155
 156     ACPI_FUNCTION_NAME (EvSciDispatch);
 157
 158
 159     /* Are there any host-installed SCI handlers? */
 160
 161     if (!AcpiGbl_SciHandlerList)
 162     {
 163         return (IntStatus);
 164     }
 165
 166     Flags = AcpiOsAcquireLock (AcpiGbl_GpeLock);
 167
 168     /* Invoke all host-installed SCI handlers */
 169
 170     SciHandler = AcpiGbl_SciHandlerList;
 171     while (SciHandler)
 172     {
 173         /* Invoke the installed handler (at interrupt level) */
 174
 175         IntStatus |= SciHandler->Address (
 176             SciHandler->Context);
 177
 178         SciHandler = SciHandler->Next;
 179     }
 180
 181     AcpiOsReleaseLock (AcpiGbl_GpeLock, Flags);
 182     return (IntStatus);
 183 }
 184
 185
 186 /*******************************************************************************
 187  *
 188  * FUNCTION:    AcpiEvSciXruptHandler
 189  *
 190  * PARAMETERS:  Context   - Calling Context
 191  *
 192  * RETURN:      Status code indicates whether interrupt was handled.
 193  *
 194  * DESCRIPTION: Interrupt handler that will figure out what function or
 195  *              control method to call to deal with a SCI.
 196  *
 197  ******************************************************************************/
 198
 199 static UINT32 ACPI_SYSTEM_XFACE
 200 AcpiEvSciXruptHandler (
 201     void                    *Context)
 202 {
 203     ACPI_GPE_XRUPT_INFO     *GpeXruptList = Context;
 204     UINT32                  InterruptHandled = ACPI_INTERRUPT_NOT_HANDLED;
 205
 206
 207     ACPI_FUNCTION_TRACE (EvSciXruptHandler);
 208
 209
 210     /*
 211      * We are guaranteed by the ACPICA initialization/shutdown code that
 212      * if this interrupt handler is installed, ACPI is enabled.
 213      */
 214
 215     /*
 216      * Fixed Events:
 217      * Check for and dispatch any Fixed Events that have occurred
 218      */
 219     InterruptHandled |= AcpiEvFixedEventDetect ();
 220
 221     /*
 222      * General Purpose Events:
 223      * Check for and dispatch any GPEs that have occurred
 224      */
 225     InterruptHandled |= AcpiEvGpeDetect (GpeXruptList);
 226
 227     /* Invoke all host-installed SCI handlers */
 228
 229     InterruptHandled |= AcpiEvSciDispatch ();
 230
 231     AcpiSciCount++;
 232     return_UINT32 (InterruptHandled);
 233 }
 234
 235
 236 /*******************************************************************************
 237  *
 238  * FUNCTION:    AcpiEvGpeXruptHandler
 239  *
 240  * PARAMETERS:  Context   - Calling Context
 241  *
 242  * RETURN:      Status code indicates whether interrupt was handled.
 243  *
 244  * DESCRIPTION: Handler for GPE Block Device interrupts
 245  *
 246  ******************************************************************************/
 247
 248 UINT32 ACPI_SYSTEM_XFACE
 249 AcpiEvGpeXruptHandler (
 250     void                    *Context)
 251 {
 252     ACPI_GPE_XRUPT_INFO     *GpeXruptList = Context;
 253     UINT32                  InterruptHandled = ACPI_INTERRUPT_NOT_HANDLED;
 254
 255
 256     ACPI_FUNCTION_TRACE (EvGpeXruptHandler);
 257
 258
 259     /*
 260      * We are guaranteed by the ACPICA initialization/shutdown code that
 261      * if this interrupt handler is installed, ACPI is enabled.
 262      */
 263
 264     /* GPEs: Check for and dispatch any GPEs that have occurred */
 265
 266     InterruptHandled |= AcpiEvGpeDetect (GpeXruptList);
 267     return_UINT32 (InterruptHandled);
 268 }
 269
 270
 271 /******************************************************************************
 272  *
 273  * FUNCTION:    AcpiEvInstallSciHandler
 274  *
 275  * PARAMETERS:  none
 276  *
 277  * RETURN:      Status
 278  *
 279  * DESCRIPTION: Installs SCI handler.
 280  *
 281  ******************************************************************************/
 282
 283 UINT32
 284 AcpiEvInstallSciHandler (
 285     void)
 286 {
 287     UINT32                  Status = AE_OK;
 288
 289
 290     ACPI_FUNCTION_TRACE (EvInstallSciHandler);
 291
 292
 293     Status = AcpiOsInstallInterruptHandler ((UINT32) AcpiGbl_FADT.SciInterrupt,
 294                 AcpiEvSciXruptHandler, AcpiGbl_GpeXruptListHead);
 295     return_ACPI_STATUS (Status);
 296 }
 297
 298
 299 /******************************************************************************
 300  *
 301  * FUNCTION:    AcpiEvRemoveAllSciHandlers
 302  *
 303  * PARAMETERS:  none
 304  *
 305  * RETURN:      AE_OK if handler uninstalled, AE_ERROR if handler was not
 306  *              installed to begin with
 307  *
 308  * DESCRIPTION: Remove the SCI interrupt handler. No further SCIs will be
 309  *              taken. Remove all host-installed SCI handlers.
 310  *
 311  * Note:  It doesn't seem important to disable all events or set the event
 312  *        enable registers to their original values. The OS should disable
 313  *        the SCI interrupt level when the handler is removed, so no more
 314  *        events will come in.
 315  *
 316  ******************************************************************************/
 317
 318 ACPI_STATUS
 319 AcpiEvRemoveAllSciHandlers (
 320     void)
 321 {
 322     ACPI_SCI_HANDLER_INFO   *SciHandler;
 323     ACPI_CPU_FLAGS          Flags;
 324     ACPI_STATUS             Status;
 325
 326
 327     ACPI_FUNCTION_TRACE (EvRemoveAllSciHandlers);
 328
 329
 330     /* Just let the OS remove the handler and disable the level */
 331
 332     Status = AcpiOsRemoveInterruptHandler ((UINT32) AcpiGbl_FADT.SciInterrupt,
 333                 AcpiEvSciXruptHandler);
 334
 335     if (!AcpiGbl_SciHandlerList)
 336     {
 337         return (Status);
 338     }
 339
 340     Flags = AcpiOsAcquireLock (AcpiGbl_GpeLock);
 341
 342     /* Free all host-installed SCI handlers */
 343
 344     while (AcpiGbl_SciHandlerList)
 345     {
 346         SciHandler = AcpiGbl_SciHandlerList;
 347         AcpiGbl_SciHandlerList = SciHandler->Next;
 348         ACPI_FREE (SciHandler);
 349     }
 350
 351     AcpiOsReleaseLock (AcpiGbl_GpeLock, Flags);
 352     return_ACPI_STATUS (Status);
 353 }
 354
 355 #endif /* !ACPI_REDUCED_HARDWARE */