sys/contrib/dev/acpica-unix/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 - 2011, 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 /* Local prototypes */
 127
 128 static UINT32 ACPI_SYSTEM_XFACE
 129 AcpiEvSciXruptHandler (
 130     void                    *Context);
 131
 132
 133 /*******************************************************************************
 134  *
 135  * FUNCTION:    AcpiEvSciXruptHandler
 136  *
 137  * PARAMETERS:  Context   - Calling Context
 138  *
 139  * RETURN:      Status code indicates whether interrupt was handled.
 140  *
 141  * DESCRIPTION: Interrupt handler that will figure out what function or
 142  *              control method to call to deal with a SCI.
 143  *
 144  ******************************************************************************/
 145
 146 static UINT32 ACPI_SYSTEM_XFACE
 147 AcpiEvSciXruptHandler (
 148     void                    *Context)
 149 {
 150     ACPI_GPE_XRUPT_INFO     *GpeXruptList = Context;
 151     UINT32                  InterruptHandled = ACPI_INTERRUPT_NOT_HANDLED;
 152
 153
 154     ACPI_FUNCTION_TRACE (EvSciXruptHandler);
 155
 156
 157     /*
 158      * We are guaranteed by the ACPI CA initialization/shutdown code that
 159      * if this interrupt handler is installed, ACPI is enabled.
 160      */
 161
 162     /*
 163      * Fixed Events:
 164      * Check for and dispatch any Fixed Events that have occurred
 165      */
 166     InterruptHandled |= AcpiEvFixedEventDetect ();
 167
 168     /*
 169      * General Purpose Events:
 170      * Check for and dispatch any GPEs that have occurred
 171      */
 172     InterruptHandled |= AcpiEvGpeDetect (GpeXruptList);
 173
 174     AcpiSciCount++;
 175     return_UINT32 (InterruptHandled);
 176 }
 177
 178
 179 /*******************************************************************************
 180  *
 181  * FUNCTION:    AcpiEvGpeXruptHandler
 182  *
 183  * PARAMETERS:  Context   - Calling Context
 184  *
 185  * RETURN:      Status code indicates whether interrupt was handled.
 186  *
 187  * DESCRIPTION: Handler for GPE Block Device interrupts
 188  *
 189  ******************************************************************************/
 190
 191 UINT32 ACPI_SYSTEM_XFACE
 192 AcpiEvGpeXruptHandler (
 193     void                    *Context)
 194 {
 195     ACPI_GPE_XRUPT_INFO     *GpeXruptList = Context;
 196     UINT32                  InterruptHandled = ACPI_INTERRUPT_NOT_HANDLED;
 197
 198
 199     ACPI_FUNCTION_TRACE (EvGpeXruptHandler);
 200
 201
 202     /*
 203      * We are guaranteed by the ACPI CA initialization/shutdown code that
 204      * if this interrupt handler is installed, ACPI is enabled.
 205      */
 206
 207     /* GPEs: Check for and dispatch any GPEs that have occurred */
 208
 209     InterruptHandled |= AcpiEvGpeDetect (GpeXruptList);
 210
 211     return_UINT32 (InterruptHandled);
 212 }
 213
 214
 215 /******************************************************************************
 216  *
 217  * FUNCTION:    AcpiEvInstallSciHandler
 218  *
 219  * PARAMETERS:  none
 220  *
 221  * RETURN:      Status
 222  *
 223  * DESCRIPTION: Installs SCI handler.
 224  *
 225  ******************************************************************************/
 226
 227 UINT32
 228 AcpiEvInstallSciHandler (
 229     void)
 230 {
 231     UINT32                  Status = AE_OK;
 232
 233
 234     ACPI_FUNCTION_TRACE (EvInstallSciHandler);
 235
 236
 237     Status = AcpiOsInstallInterruptHandler ((UINT32) AcpiGbl_FADT.SciInterrupt,
 238                 AcpiEvSciXruptHandler, AcpiGbl_GpeXruptListHead);
 239     return_ACPI_STATUS (Status);
 240 }
 241
 242
 243 /******************************************************************************
 244  *
 245  * FUNCTION:    AcpiEvRemoveSciHandler
 246  *
 247  * PARAMETERS:  none
 248  *
 249  * RETURN:      E_OK if handler uninstalled OK, E_ERROR if handler was not
 250  *              installed to begin with
 251  *
 252  * DESCRIPTION: Remove the SCI interrupt handler. No further SCIs will be
 253  *              taken.
 254  *
 255  * Note:  It doesn't seem important to disable all events or set the event
 256  *        enable registers to their original values. The OS should disable
 257  *        the SCI interrupt level when the handler is removed, so no more
 258  *        events will come in.
 259  *
 260  ******************************************************************************/
 261
 262 ACPI_STATUS
 263 AcpiEvRemoveSciHandler (
 264     void)
 265 {
 266     ACPI_STATUS             Status;
 267
 268
 269     ACPI_FUNCTION_TRACE (EvRemoveSciHandler);
 270
 271
 272     /* Just let the OS remove the handler and disable the level */
 273
 274     Status = AcpiOsRemoveInterruptHandler ((UINT32) AcpiGbl_FADT.SciInterrupt,
 275                 AcpiEvSciXruptHandler);
 276
 277     return_ACPI_STATUS (Status);
 278 }
 279
 280