Back to home page

Quest Cross Reference

 
 

    


Warning, cross-references for /kernel/drivers/acpica/evevent.c need to be fixed.

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 - 2009, 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 #include "acpi.h"
0117 #include "accommon.h"
0118 #include "acevents.h"
0119 
0120 #define _COMPONENT          ACPI_EVENTS
0121         ACPI_MODULE_NAME    ("evevent")
0122 
0123 /* Local prototypes */
0124 
0125 static ACPI_STATUS
0126 AcpiEvFixedEventInitialize (
0127     void);
0128 
0129 static UINT32
0130 AcpiEvFixedEventDispatch (
0131     UINT32                  Event);
0132 
0133 
0134 /*******************************************************************************
0135  *
0136  * FUNCTION:    AcpiEvInitializeEvents
0137  *
0138  * PARAMETERS:  None
0139  *
0140  * RETURN:      Status
0141  *
0142  * DESCRIPTION: Initialize global data structures for ACPI events (Fixed, GPE)
0143  *
0144  ******************************************************************************/
0145 
0146 ACPI_STATUS
0147 AcpiEvInitializeEvents (
0148     void)
0149 {
0150     ACPI_STATUS             Status;
0151 
0152 
0153     ACPI_FUNCTION_TRACE (EvInitializeEvents);
0154 
0155 
0156     /*
0157      * Initialize the Fixed and General Purpose Events. This is done prior to
0158      * enabling SCIs to prevent interrupts from occurring before the handlers
0159      * are installed.
0160      */
0161     Status = AcpiEvFixedEventInitialize ();
0162     if (ACPI_FAILURE (Status))
0163     {
0164         ACPI_EXCEPTION ((AE_INFO, Status,
0165             "Unable to initialize fixed events"));
0166         return_ACPI_STATUS (Status);
0167     }
0168 
0169     Status = AcpiEvGpeInitialize ();
0170     if (ACPI_FAILURE (Status))
0171     {
0172         ACPI_EXCEPTION ((AE_INFO, Status,
0173             "Unable to initialize general purpose events"));
0174         return_ACPI_STATUS (Status);
0175     }
0176 
0177     return_ACPI_STATUS (Status);
0178 }
0179 
0180 
0181 /*******************************************************************************
0182  *
0183  * FUNCTION:    AcpiEvInstallFadtGpes
0184  *
0185  * PARAMETERS:  None
0186  *
0187  * RETURN:      Status
0188  *
0189  * DESCRIPTION: Completes initialization of the FADT-defined GPE blocks
0190  *              (0 and 1). This causes the _PRW methods to be run, so the HW
0191  *              must be fully initialized at this point, including global lock
0192  *              support.
0193  *
0194  ******************************************************************************/
0195 
0196 ACPI_STATUS
0197 AcpiEvInstallFadtGpes (
0198     void)
0199 {
0200     ACPI_STATUS             Status;
0201 
0202 
0203     ACPI_FUNCTION_TRACE (EvInstallFadtGpes);
0204 
0205 
0206     /* Namespace must be locked */
0207 
0208     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
0209     if (ACPI_FAILURE (Status))
0210     {
0211         return (Status);
0212     }
0213 
0214     /* FADT GPE Block 0 */
0215 
0216     (void) AcpiEvInitializeGpeBlock (
0217                 AcpiGbl_FadtGpeDevice, AcpiGbl_GpeFadtBlocks[0]);
0218 
0219     /* FADT GPE Block 1 */
0220 
0221     (void) AcpiEvInitializeGpeBlock (
0222                 AcpiGbl_FadtGpeDevice, AcpiGbl_GpeFadtBlocks[1]);
0223 
0224     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
0225     return_ACPI_STATUS (AE_OK);
0226 }
0227 
0228 
0229 /*******************************************************************************
0230  *
0231  * FUNCTION:    AcpiEvInstallXruptHandlers
0232  *
0233  * PARAMETERS:  None
0234  *
0235  * RETURN:      Status
0236  *
0237  * DESCRIPTION: Install interrupt handlers for the SCI and Global Lock
0238  *
0239  ******************************************************************************/
0240 
0241 ACPI_STATUS
0242 AcpiEvInstallXruptHandlers (
0243     void)
0244 {
0245     ACPI_STATUS             Status;
0246 
0247 
0248     ACPI_FUNCTION_TRACE (EvInstallXruptHandlers);
0249 
0250 
0251     /* Install the SCI handler */
0252 
0253     Status = AcpiEvInstallSciHandler ();
0254     if (ACPI_FAILURE (Status))
0255     {
0256         ACPI_EXCEPTION ((AE_INFO, Status,
0257             "Unable to install System Control Interrupt handler"));
0258         return_ACPI_STATUS (Status);
0259     }
0260 
0261     /* Install the handler for the Global Lock */
0262 
0263     Status = AcpiEvInitGlobalLockHandler ();
0264     if (ACPI_FAILURE (Status))
0265     {
0266         ACPI_EXCEPTION ((AE_INFO, Status,
0267             "Unable to initialize Global Lock handler"));
0268         return_ACPI_STATUS (Status);
0269     }
0270 
0271     AcpiGbl_EventsInitialized = TRUE;
0272     return_ACPI_STATUS (Status);
0273 }
0274 
0275 
0276 /*******************************************************************************
0277  *
0278  * FUNCTION:    AcpiEvFixedEventInitialize
0279  *
0280  * PARAMETERS:  None
0281  *
0282  * RETURN:      Status
0283  *
0284  * DESCRIPTION: Install the fixed event handlers and disable all fixed events.
0285  *
0286  ******************************************************************************/
0287 
0288 static ACPI_STATUS
0289 AcpiEvFixedEventInitialize (
0290     void)
0291 {
0292     UINT32                  i;
0293     ACPI_STATUS             Status;
0294 
0295 
0296     /*
0297      * Initialize the structure that keeps track of fixed event handlers and
0298      * enable the fixed events.
0299      */
0300     for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++)
0301     {
0302         AcpiGbl_FixedEventHandlers[i].Handler = NULL;
0303         AcpiGbl_FixedEventHandlers[i].Context = NULL;
0304 
0305         /* Disable the fixed event */
0306 
0307         if (AcpiGbl_FixedEventInfo[i].EnableRegisterId != 0xFF)
0308         {
0309             Status = AcpiWriteBitRegister (
0310                         AcpiGbl_FixedEventInfo[i].EnableRegisterId,
0311                         ACPI_DISABLE_EVENT);
0312             if (ACPI_FAILURE (Status))
0313             {
0314                 return (Status);
0315             }
0316         }
0317     }
0318 
0319     return (AE_OK);
0320 }
0321 
0322 
0323 /*******************************************************************************
0324  *
0325  * FUNCTION:    AcpiEvFixedEventDetect
0326  *
0327  * PARAMETERS:  None
0328  *
0329  * RETURN:      INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
0330  *
0331  * DESCRIPTION: Checks the PM status register for active fixed events
0332  *
0333  ******************************************************************************/
0334 
0335 UINT32
0336 AcpiEvFixedEventDetect (
0337     void)
0338 {
0339     UINT32                  IntStatus = ACPI_INTERRUPT_NOT_HANDLED;
0340     UINT32                  FixedStatus;
0341     UINT32                  FixedEnable;
0342     UINT32                  i;
0343 
0344 
0345     ACPI_FUNCTION_NAME (EvFixedEventDetect);
0346 
0347 
0348     /*
0349      * Read the fixed feature status and enable registers, as all the cases
0350      * depend on their values. Ignore errors here.
0351      */
0352     (void) AcpiHwRegisterRead (ACPI_REGISTER_PM1_STATUS, &FixedStatus);
0353     (void) AcpiHwRegisterRead (ACPI_REGISTER_PM1_ENABLE, &FixedEnable);
0354 
0355     ACPI_DEBUG_PRINT ((ACPI_DB_INTERRUPTS,
0356         "Fixed Event Block: Enable %08X Status %08X\n",
0357         FixedEnable, FixedStatus));
0358 
0359     /*
0360      * Check for all possible Fixed Events and dispatch those that are active
0361      */
0362     for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++)
0363     {
0364         /* Both the status and enable bits must be on for this event */
0365 
0366         if ((FixedStatus & AcpiGbl_FixedEventInfo[i].StatusBitMask) &&
0367             (FixedEnable & AcpiGbl_FixedEventInfo[i].EnableBitMask))
0368         {
0369             /* Found an active (signalled) event */
0370 
0371             AcpiFixedEventCount[i]++;
0372             IntStatus |= AcpiEvFixedEventDispatch (i);
0373         }
0374     }
0375 
0376     return (IntStatus);
0377 }
0378 
0379 
0380 /*******************************************************************************
0381  *
0382  * FUNCTION:    AcpiEvFixedEventDispatch
0383  *
0384  * PARAMETERS:  Event               - Event type
0385  *
0386  * RETURN:      INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
0387  *
0388  * DESCRIPTION: Clears the status bit for the requested event, calls the
0389  *              handler that previously registered for the event.
0390  *
0391  ******************************************************************************/
0392 
0393 static UINT32
0394 AcpiEvFixedEventDispatch (
0395     UINT32                  Event)
0396 {
0397 
0398     ACPI_FUNCTION_ENTRY ();
0399 
0400 
0401     /* Clear the status bit */
0402 
0403     (void) AcpiWriteBitRegister (
0404             AcpiGbl_FixedEventInfo[Event].StatusRegisterId,
0405             ACPI_CLEAR_STATUS);
0406 
0407     /*
0408      * Make sure we've got a handler. If not, report an error. The event is
0409      * disabled to prevent further interrupts.
0410      */
0411     if (NULL == AcpiGbl_FixedEventHandlers[Event].Handler)
0412     {
0413         (void) AcpiWriteBitRegister (
0414                 AcpiGbl_FixedEventInfo[Event].EnableRegisterId,
0415                 ACPI_DISABLE_EVENT);
0416 
0417         ACPI_ERROR ((AE_INFO,
0418             "No installed handler for fixed event [%08X]",
0419             Event));
0420 
0421         return (ACPI_INTERRUPT_NOT_HANDLED);
0422     }
0423 
0424     /* Invoke the Fixed Event handler */
0425 
0426     return ((AcpiGbl_FixedEventHandlers[Event].Handler)(
0427                 AcpiGbl_FixedEventHandlers[Event].Context));
0428 }
0429 
0430