acpica/events/evevent.c

0001 /******************************************************************************
0002  *
0003  * Module Name: evevent - Fixed Event handling and dispatch
0004  *
0005  *****************************************************************************/
0006
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights. You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code. No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision. In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change. Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee. Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution. In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
0086  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
0087  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0088  * PARTICULAR PURPOSE.
0089  *
0090  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0091  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0092  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0093  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0094  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0095  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
0096  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0097  * LIMITED REMEDY.
0098  *
0099  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0100  * software or system incorporating such software without first obtaining any
0101  * required license or other approval from the U. S. Department of Commerce or
0102  * any other agency or department of the United States Government. In the
0103  * event Licensee exports any such software from the United States or
0104  * re-exports any such software from a foreign destination, Licensee shall
0105  * ensure that the distribution and export/re-export of the software is in
0106  * compliance with all laws, regulations, orders, or other restrictions of the
0107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0108  * any of its subsidiaries will export/re-export any technical data, process,
0109  * software, or service, directly or indirectly, to any country for which the
0110  * United States government or any agency thereof requires an export license,
0111  * other governmental approval, or letter of assurance, without first obtaining
0112  * such license, approval or letter.
0113  *
0114  *****************************************************************************
0115  *
0116  * Alternatively, you may choose to be licensed under the terms of the
0117  * following license:
0118  *
0119  * Redistribution and use in source and binary forms, with or without
0120  * modification, are permitted provided that the following conditions
0121  * are met:
0122  * 1. Redistributions of source code must retain the above copyright
0123  *    notice, this list of conditions, and the following disclaimer,
0124  *    without modification.
0125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
0126  *    substantially similar to the "NO WARRANTY" disclaimer below
0127  *    ("Disclaimer") and any redistribution must be conditioned upon
0128  *    including a substantially similar Disclaimer requirement for further
0129  *    binary redistribution.
0130  * 3. Neither the names of the above-listed copyright holders nor the names
0131  *    of any contributors may be used to endorse or promote products derived
0132  *    from this software without specific prior written permission.
0133  *
0134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0145  *
0146  * Alternatively, you may choose to be licensed under the terms of the
0147  * GNU General Public License ("GPL") version 2 as published by the Free
0148  * Software Foundation.
0149  *
0150  *****************************************************************************/
0151
0152 #include "acpi.h"
0153 #include "accommon.h"
0154 #include "acevents.h"
0155
0156 #define _COMPONENT          ACPI_EVENTS
0157         ACPI_MODULE_NAME    ("evevent")
0158
0159 #if (!ACPI_REDUCED_HARDWARE) /* Entire module */
0160
0161 /* Local prototypes */
0162
0163 static ACPI_STATUS
0164 AcpiEvFixedEventInitialize (
0165     void);
0166
0167 static UINT32
0168 AcpiEvFixedEventDispatch (
0169     UINT32                  Event);
0170
0171
0172 /*******************************************************************************
0173  *
0174  * FUNCTION:    AcpiEvInitializeEvents
0175  *
0176  * PARAMETERS:  None
0177  *
0178  * RETURN:      Status
0179  *
0180  * DESCRIPTION: Initialize global data structures for ACPI events (Fixed, GPE)
0181  *
0182  ******************************************************************************/
0183
0184 ACPI_STATUS
0185 AcpiEvInitializeEvents (
0186     void)
0187 {
0188     ACPI_STATUS             Status;
0189
0190
0191     ACPI_FUNCTION_TRACE (EvInitializeEvents);
0192
0193
0194     /* If Hardware Reduced flag is set, there are no fixed events */
0195
0196     if (AcpiGbl_ReducedHardware)
0197     {
0198         return_ACPI_STATUS (AE_OK);
0199     }
0200
0201     /*
0202      * Initialize the Fixed and General Purpose Events. This is done prior to
0203      * enabling SCIs to prevent interrupts from occurring before the handlers
0204      * are installed.
0205      */
0206     Status = AcpiEvFixedEventInitialize ();
0207     if (ACPI_FAILURE (Status))
0208     {
0209         ACPI_EXCEPTION ((AE_INFO, Status,
0210             "Unable to initialize fixed events"));
0211         return_ACPI_STATUS (Status);
0212     }
0213
0214     Status = AcpiEvGpeInitialize ();
0215     if (ACPI_FAILURE (Status))
0216     {
0217         ACPI_EXCEPTION ((AE_INFO, Status,
0218             "Unable to initialize general purpose events"));
0219         return_ACPI_STATUS (Status);
0220     }
0221
0222     return_ACPI_STATUS (Status);
0223 }
0224
0225
0226 /*******************************************************************************
0227  *
0228  * FUNCTION:    AcpiEvInstallXruptHandlers
0229  *
0230  * PARAMETERS:  None
0231  *
0232  * RETURN:      Status
0233  *
0234  * DESCRIPTION: Install interrupt handlers for the SCI and Global Lock
0235  *
0236  ******************************************************************************/
0237
0238 ACPI_STATUS
0239 AcpiEvInstallXruptHandlers (
0240     void)
0241 {
0242     ACPI_STATUS             Status;
0243
0244
0245     ACPI_FUNCTION_TRACE (EvInstallXruptHandlers);
0246
0247
0248     /* If Hardware Reduced flag is set, there is no ACPI h/w */
0249
0250     if (AcpiGbl_ReducedHardware)
0251     {
0252         return_ACPI_STATUS (AE_OK);
0253     }
0254
0255     /* Install the SCI handler */
0256
0257     Status = AcpiEvInstallSciHandler ();
0258     if (ACPI_FAILURE (Status))
0259     {
0260         ACPI_EXCEPTION ((AE_INFO, Status,
0261             "Unable to install System Control Interrupt handler"));
0262         return_ACPI_STATUS (Status);
0263     }
0264
0265     /* Install the handler for the Global Lock */
0266
0267     Status = AcpiEvInitGlobalLockHandler ();
0268     if (ACPI_FAILURE (Status))
0269     {
0270         ACPI_EXCEPTION ((AE_INFO, Status,
0271             "Unable to initialize Global Lock handler"));
0272         return_ACPI_STATUS (Status);
0273     }
0274
0275     AcpiGbl_EventsInitialized = TRUE;
0276     return_ACPI_STATUS (Status);
0277 }
0278
0279
0280 /*******************************************************************************
0281  *
0282  * FUNCTION:    AcpiEvFixedEventInitialize
0283  *
0284  * PARAMETERS:  None
0285  *
0286  * RETURN:      Status
0287  *
0288  * DESCRIPTION: Install the fixed event handlers and disable all fixed events.
0289  *
0290  ******************************************************************************/
0291
0292 static ACPI_STATUS
0293 AcpiEvFixedEventInitialize (
0294     void)
0295 {
0296     UINT32                  i;
0297     ACPI_STATUS             Status;
0298
0299
0300     /*
0301      * Initialize the structure that keeps track of fixed event handlers and
0302      * disable all of the fixed events.
0303      */
0304     for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++)
0305     {
0306         AcpiGbl_FixedEventHandlers[i].Handler = NULL;
0307         AcpiGbl_FixedEventHandlers[i].Context = NULL;
0308
0309         /* Disable the fixed event */
0310
0311         if (AcpiGbl_FixedEventInfo[i].EnableRegisterId != 0xFF)
0312         {
0313             Status = AcpiWriteBitRegister (
0314                 AcpiGbl_FixedEventInfo[i].EnableRegisterId,
0315                 ACPI_DISABLE_EVENT);
0316             if (ACPI_FAILURE (Status))
0317             {
0318                 return (Status);
0319             }
0320         }
0321     }
0322
0323     return (AE_OK);
0324 }
0325
0326
0327 /*******************************************************************************
0328  *
0329  * FUNCTION:    AcpiEvFixedEventDetect
0330  *
0331  * PARAMETERS:  None
0332  *
0333  * RETURN:      INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
0334  *
0335  * DESCRIPTION: Checks the PM status register for active fixed events
0336  *
0337  ******************************************************************************/
0338
0339 UINT32
0340 AcpiEvFixedEventDetect (
0341     void)
0342 {
0343     UINT32                  IntStatus = ACPI_INTERRUPT_NOT_HANDLED;
0344     UINT32                  FixedStatus;
0345     UINT32                  FixedEnable;
0346     UINT32                  i;
0347     ACPI_STATUS             Status;
0348
0349
0350     ACPI_FUNCTION_NAME (EvFixedEventDetect);
0351
0352
0353     /*
0354      * Read the fixed feature status and enable registers, as all the cases
0355      * depend on their values. Ignore errors here.
0356      */
0357     Status = AcpiHwRegisterRead (ACPI_REGISTER_PM1_STATUS, &FixedStatus);
0358     Status |= AcpiHwRegisterRead (ACPI_REGISTER_PM1_ENABLE, &FixedEnable);
0359     if (ACPI_FAILURE (Status))
0360     {
0361         return (IntStatus);
0362     }
0363
0364     ACPI_DEBUG_PRINT ((ACPI_DB_INTERRUPTS,
0365         "Fixed Event Block: Enable %08X Status %08X\n",
0366         FixedEnable, FixedStatus));
0367
0368     /*
0369      * Check for all possible Fixed Events and dispatch those that are active
0370      */
0371     for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++)
0372     {
0373         /* Both the status and enable bits must be on for this event */
0374
0375         if ((FixedStatus & AcpiGbl_FixedEventInfo[i].StatusBitMask) &&
0376             (FixedEnable & AcpiGbl_FixedEventInfo[i].EnableBitMask))
0377         {
0378             /*
0379              * Found an active (signalled) event. Invoke global event
0380              * handler if present.
0381              */
0382             AcpiFixedEventCount[i]++;
0383             if (AcpiGbl_GlobalEventHandler)
0384             {
0385                 AcpiGbl_GlobalEventHandler (ACPI_EVENT_TYPE_FIXED, NULL,
0386                      i, AcpiGbl_GlobalEventHandlerContext);
0387             }
0388
0389             IntStatus |= AcpiEvFixedEventDispatch (i);
0390         }
0391     }
0392
0393     return (IntStatus);
0394 }
0395
0396
0397 /*******************************************************************************
0398  *
0399  * FUNCTION:    AcpiEvFixedEventDispatch
0400  *
0401  * PARAMETERS:  Event               - Event type
0402  *
0403  * RETURN:      INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
0404  *
0405  * DESCRIPTION: Clears the status bit for the requested event, calls the
0406  *              handler that previously registered for the event.
0407  *              NOTE: If there is no handler for the event, the event is
0408  *              disabled to prevent further interrupts.
0409  *
0410  ******************************************************************************/
0411
0412 static UINT32
0413 AcpiEvFixedEventDispatch (
0414     UINT32                  Event)
0415 {
0416
0417     ACPI_FUNCTION_ENTRY ();
0418
0419
0420     /* Clear the status bit */
0421
0422     (void) AcpiWriteBitRegister (
0423         AcpiGbl_FixedEventInfo[Event].StatusRegisterId,
0424         ACPI_CLEAR_STATUS);
0425
0426     /*
0427      * Make sure that a handler exists. If not, report an error
0428      * and disable the event to prevent further interrupts.
0429      */
0430     if (!AcpiGbl_FixedEventHandlers[Event].Handler)
0431     {
0432         (void) AcpiWriteBitRegister (
0433             AcpiGbl_FixedEventInfo[Event].EnableRegisterId,
0434             ACPI_DISABLE_EVENT);
0435
0436         ACPI_ERROR ((AE_INFO,
0437             "No installed handler for fixed event - %s (%u), disabling",
0438             AcpiUtGetEventName (Event), Event));
0439
0440         return (ACPI_INTERRUPT_NOT_HANDLED);
0441     }
0442
0443     /* Invoke the Fixed Event handler */
0444
0445     return ((AcpiGbl_FixedEventHandlers[Event].Handler)(
0446         AcpiGbl_FixedEventHandlers[Event].Context));
0447 }
0448
0449 #endif /* !ACPI_REDUCED_HARDWARE */