1 /******************************************************************************
3 * Module Name: evevent - Fixed Event handling and dispatch
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2005, 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")
124 /*******************************************************************************
126 * FUNCTION: AcpiEvInitializeEvents
132 * DESCRIPTION: Initialize global data structures for events.
134 ******************************************************************************/
137 AcpiEvInitializeEvents (
143 ACPI_FUNCTION_TRACE ("EvInitializeEvents");
146 /* Make sure we have ACPI tables */
150 ACPI_DEBUG_PRINT ((ACPI_DB_WARN
, "No ACPI tables present!\n"));
151 return_ACPI_STATUS (AE_NO_ACPI_TABLES
);
155 * Initialize the Fixed and General Purpose Events. This is
156 * done prior to enabling SCIs to prevent interrupts from
157 * occurring before handers are installed.
159 Status
= AcpiEvFixedEventInitialize ();
160 if (ACPI_FAILURE (Status
))
163 "Unable to initialize fixed events, %s\n",
164 AcpiFormatException (Status
)));
165 return_ACPI_STATUS (Status
);
168 Status
= AcpiEvGpeInitialize ();
169 if (ACPI_FAILURE (Status
))
172 "Unable to initialize general purpose events, %s\n",
173 AcpiFormatException (Status
)));
174 return_ACPI_STATUS (Status
);
177 return_ACPI_STATUS (Status
);
181 /*******************************************************************************
183 * FUNCTION: AcpiEvInstallXruptHandlers
189 * DESCRIPTION: Install interrupt handlers for the SCI and Global Lock
191 ******************************************************************************/
194 AcpiEvInstallXruptHandlers (
200 ACPI_FUNCTION_TRACE ("EvInstallXruptHandlers");
203 /* Install the SCI handler */
205 Status
= AcpiEvInstallSciHandler ();
206 if (ACPI_FAILURE (Status
))
209 "Unable to install System Control Interrupt Handler, %s\n",
210 AcpiFormatException (Status
)));
211 return_ACPI_STATUS (Status
);
214 /* Install the handler for the Global Lock */
216 Status
= AcpiEvInitGlobalLockHandler ();
217 if (ACPI_FAILURE (Status
))
220 "Unable to initialize Global Lock handler, %s\n",
221 AcpiFormatException (Status
)));
222 return_ACPI_STATUS (Status
);
225 AcpiGbl_EventsInitialized
= TRUE
;
226 return_ACPI_STATUS (Status
);
230 /*******************************************************************************
232 * FUNCTION: AcpiEvFixedEventInitialize
238 * DESCRIPTION: Install the fixed event handlers and enable the fixed events.
240 ******************************************************************************/
243 AcpiEvFixedEventInitialize (
251 * Initialize the structure that keeps track of fixed event handlers
252 * and enable the fixed events.
254 for (i
= 0; i
< ACPI_NUM_FIXED_EVENTS
; i
++)
256 AcpiGbl_FixedEventHandlers
[i
].Handler
= NULL
;
257 AcpiGbl_FixedEventHandlers
[i
].Context
= NULL
;
259 /* Enable the fixed event */
261 if (AcpiGbl_FixedEventInfo
[i
].EnableRegisterId
!= 0xFF)
263 Status
= AcpiSetRegister (AcpiGbl_FixedEventInfo
[i
].EnableRegisterId
,
265 if (ACPI_FAILURE (Status
))
276 /*******************************************************************************
278 * FUNCTION: AcpiEvFixedEventDetect
282 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
284 * DESCRIPTION: Checks the PM status register for fixed events
286 ******************************************************************************/
289 AcpiEvFixedEventDetect (
292 UINT32 IntStatus
= ACPI_INTERRUPT_NOT_HANDLED
;
298 ACPI_FUNCTION_NAME ("EvFixedEventDetect");
302 * Read the fixed feature status and enable registers, as all the cases
303 * depend on their values. Ignore errors here.
305 (void) AcpiHwRegisterRead (ACPI_MTX_DO_NOT_LOCK
, ACPI_REGISTER_PM1_STATUS
, &FixedStatus
);
306 (void) AcpiHwRegisterRead (ACPI_MTX_DO_NOT_LOCK
, ACPI_REGISTER_PM1_ENABLE
, &FixedEnable
);
308 ACPI_DEBUG_PRINT ((ACPI_DB_INTERRUPTS
,
309 "Fixed Event Block: Enable %08X Status %08X\n",
310 FixedEnable
, FixedStatus
));
313 * Check for all possible Fixed Events and dispatch those that are active
315 for (i
= 0; i
< ACPI_NUM_FIXED_EVENTS
; i
++)
317 /* Both the status and enable bits must be on for this event */
319 if ((FixedStatus
& AcpiGbl_FixedEventInfo
[i
].StatusBitMask
) &&
320 (FixedEnable
& AcpiGbl_FixedEventInfo
[i
].EnableBitMask
))
322 /* Found an active (signalled) event */
324 IntStatus
|= AcpiEvFixedEventDispatch ((UINT32
) i
);
332 /*******************************************************************************
334 * FUNCTION: AcpiEvFixedEventDispatch
336 * PARAMETERS: Event - Event type
338 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
340 * DESCRIPTION: Clears the status bit for the requested event, calls the
341 * handler that previously registered for the event.
343 ******************************************************************************/
346 AcpiEvFixedEventDispatch (
351 ACPI_FUNCTION_ENTRY ();
354 /* Clear the status bit */
356 (void) AcpiSetRegister (AcpiGbl_FixedEventInfo
[Event
].StatusRegisterId
,
357 1, ACPI_MTX_DO_NOT_LOCK
);
360 * Make sure we've got a handler. If not, report an error.
361 * The event is disabled to prevent further interrupts.
363 if (NULL
== AcpiGbl_FixedEventHandlers
[Event
].Handler
)
365 (void) AcpiSetRegister (AcpiGbl_FixedEventInfo
[Event
].EnableRegisterId
,
366 0, ACPI_MTX_DO_NOT_LOCK
);
369 ("No installed handler for fixed event [%08X]\n",
372 return (ACPI_INTERRUPT_NOT_HANDLED
);
375 /* Invoke the Fixed Event handler */
377 return ((AcpiGbl_FixedEventHandlers
[Event
].Handler
)(
378 AcpiGbl_FixedEventHandlers
[Event
].Context
));