1 /******************************************************************************
3 * Module Name: evevent - Fixed Event handling and dispatch
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2007, Intel Corp.
13 * All rights reserved.
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
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
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;
38 * The above copyright and patent license is granted only if the following
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.
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
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
73 * 3.4. Intel retains all right, title, and interest in and to the Original
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
81 * 4. Disclaimer and Export Compliance
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
115 *****************************************************************************/
118 #include "acevents.h"
120 #define _COMPONENT ACPI_EVENTS
121 ACPI_MODULE_NAME ("evevent")
123 /* Local prototypes */
126 AcpiEvFixedEventInitialize (
130 AcpiEvFixedEventDispatch (
134 /*******************************************************************************
136 * FUNCTION: AcpiEvInitializeEvents
142 * DESCRIPTION: Initialize global data structures for ACPI events (Fixed, GPE)
144 ******************************************************************************/
147 AcpiEvInitializeEvents (
153 ACPI_FUNCTION_TRACE (EvInitializeEvents);
157 * Initialize the Fixed and General Purpose Events. This is done prior to
158 * enabling SCIs to prevent interrupts from occurring before the handlers are
161 Status = AcpiEvFixedEventInitialize ();
162 if (ACPI_FAILURE (Status))
164 ACPI_EXCEPTION ((AE_INFO, Status,
165 "Unable to initialize fixed events"));
166 return_ACPI_STATUS (Status);
169 Status = AcpiEvGpeInitialize ();
170 if (ACPI_FAILURE (Status))
172 ACPI_EXCEPTION ((AE_INFO, Status,
173 "Unable to initialize general purpose events"));
174 return_ACPI_STATUS (Status);
177 return_ACPI_STATUS (Status);
181 /*******************************************************************************
183 * FUNCTION: AcpiEvInstallFadtGpes
189 * DESCRIPTION: Completes initialization of the FADT-defined GPE blocks
190 * (0 and 1). This causes the _PRW methods to be run, so the HW
191 * must be fully initialized at this point, including global lock
194 ******************************************************************************/
197 AcpiEvInstallFadtGpes (
203 ACPI_FUNCTION_TRACE (EvInstallFadtGpes);
206 /* Namespace must be locked */
208 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
209 if (ACPI_FAILURE (Status))
214 /* FADT GPE Block 0 */
216 (void) AcpiEvInitializeGpeBlock (
217 AcpiGbl_FadtGpeDevice, AcpiGbl_GpeFadtBlocks[0]);
219 /* FADT GPE Block 1 */
221 (void) AcpiEvInitializeGpeBlock (
222 AcpiGbl_FadtGpeDevice, AcpiGbl_GpeFadtBlocks[1]);
224 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
225 return_ACPI_STATUS (AE_OK);
229 /*******************************************************************************
231 * FUNCTION: AcpiEvInstallXruptHandlers
237 * DESCRIPTION: Install interrupt handlers for the SCI and Global Lock
239 ******************************************************************************/
242 AcpiEvInstallXruptHandlers (
248 ACPI_FUNCTION_TRACE (EvInstallXruptHandlers);
251 /* Install the SCI handler */
253 Status = AcpiEvInstallSciHandler ();
254 if (ACPI_FAILURE (Status))
256 ACPI_EXCEPTION ((AE_INFO, Status,
257 "Unable to install System Control Interrupt handler"));
258 return_ACPI_STATUS (Status);
261 /* Install the handler for the Global Lock */
263 Status = AcpiEvInitGlobalLockHandler ();
264 if (ACPI_FAILURE (Status))
266 ACPI_EXCEPTION ((AE_INFO, Status,
267 "Unable to initialize Global Lock handler"));
268 return_ACPI_STATUS (Status);
271 AcpiGbl_EventsInitialized = TRUE;
272 return_ACPI_STATUS (Status);
276 /*******************************************************************************
278 * FUNCTION: AcpiEvFixedEventInitialize
284 * DESCRIPTION: Install the fixed event handlers and enable the fixed events.
286 ******************************************************************************/
289 AcpiEvFixedEventInitialize (
297 * Initialize the structure that keeps track of fixed event handlers
298 * and enable the fixed events.
300 for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++)
302 AcpiGbl_FixedEventHandlers[i].Handler = NULL;
303 AcpiGbl_FixedEventHandlers[i].Context = NULL;
305 /* Enable the fixed event */
307 if (AcpiGbl_FixedEventInfo[i].EnableRegisterId != 0xFF)
309 Status = AcpiSetRegister (
310 AcpiGbl_FixedEventInfo[i].EnableRegisterId, 0);
311 if (ACPI_FAILURE (Status))
322 /*******************************************************************************
324 * FUNCTION: AcpiEvFixedEventDetect
328 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
330 * DESCRIPTION: Checks the PM status register for active fixed events
332 ******************************************************************************/
335 AcpiEvFixedEventDetect (
338 UINT32 IntStatus = ACPI_INTERRUPT_NOT_HANDLED;
344 ACPI_FUNCTION_NAME (EvFixedEventDetect);
348 * Read the fixed feature status and enable registers, as all the cases
349 * depend on their values. Ignore errors here.
351 (void) AcpiHwRegisterRead (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1_STATUS,
353 (void) AcpiHwRegisterRead (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1_ENABLE,
356 ACPI_DEBUG_PRINT ((ACPI_DB_INTERRUPTS,
357 "Fixed Event Block: Enable %08X Status %08X\n",
358 FixedEnable, FixedStatus));
361 * Check for all possible Fixed Events and dispatch those that are active
363 for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++)
365 /* Both the status and enable bits must be on for this event */
367 if ((FixedStatus & AcpiGbl_FixedEventInfo[i].StatusBitMask) &&
368 (FixedEnable & AcpiGbl_FixedEventInfo[i].EnableBitMask))
370 /* Found an active (signalled) event */
372 IntStatus |= AcpiEvFixedEventDispatch ((UINT32) i);
380 /*******************************************************************************
382 * FUNCTION: AcpiEvFixedEventDispatch
384 * PARAMETERS: Event - Event type
386 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
388 * DESCRIPTION: Clears the status bit for the requested event, calls the
389 * handler that previously registered for the event.
391 ******************************************************************************/
394 AcpiEvFixedEventDispatch (
399 ACPI_FUNCTION_ENTRY ();
402 /* Clear the status bit */
404 (void) AcpiSetRegister (AcpiGbl_FixedEventInfo[Event].StatusRegisterId, 1);
407 * Make sure we've got a handler. If not, report an error.
408 * The event is disabled to prevent further interrupts.
410 if (NULL == AcpiGbl_FixedEventHandlers[Event].Handler)
412 (void) AcpiSetRegister (AcpiGbl_FixedEventInfo[Event].EnableRegisterId, 0);
414 ACPI_ERROR ((AE_INFO,
415 "No installed handler for fixed event [%08X]",
418 return (ACPI_INTERRUPT_NOT_HANDLED);
421 /* Invoke the Fixed Event handler */
423 return ((AcpiGbl_FixedEventHandlers[Event].Handler)(
424 AcpiGbl_FixedEventHandlers[Event].Context));