1 /******************************************************************************
3 * Module Name: evevent - Fixed Event handling and dispatch
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2007, R. Byron Moore
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 #include <acpi/acpi.h>
45 #include <acpi/acevents.h>
47 #define _COMPONENT ACPI_EVENTS
48 ACPI_MODULE_NAME("evevent")
50 /* Local prototypes */
51 static acpi_status acpi_ev_fixed_event_initialize(void);
53 static u32 acpi_ev_fixed_event_dispatch(u32 event);
55 /*******************************************************************************
57 * FUNCTION: acpi_ev_initialize_events
63 * DESCRIPTION: Initialize global data structures for ACPI events (Fixed, GPE)
65 ******************************************************************************/
67 acpi_status acpi_ev_initialize_events(void)
71 ACPI_FUNCTION_TRACE(ev_initialize_events);
74 * Initialize the Fixed and General Purpose Events. This is done prior to
75 * enabling SCIs to prevent interrupts from occurring before the handlers are
78 status = acpi_ev_fixed_event_initialize();
79 if (ACPI_FAILURE(status)) {
80 ACPI_EXCEPTION((AE_INFO, status,
81 "Unable to initialize fixed events"));
82 return_ACPI_STATUS(status);
85 status = acpi_ev_gpe_initialize();
86 if (ACPI_FAILURE(status)) {
87 ACPI_EXCEPTION((AE_INFO, status,
88 "Unable to initialize general purpose events"));
89 return_ACPI_STATUS(status);
92 return_ACPI_STATUS(status);
95 /*******************************************************************************
97 * FUNCTION: acpi_ev_install_fadt_gpes
103 * DESCRIPTION: Completes initialization of the FADT-defined GPE blocks
104 * (0 and 1). This causes the _PRW methods to be run, so the HW
105 * must be fully initialized at this point, including global lock
108 ******************************************************************************/
110 acpi_status acpi_ev_install_fadt_gpes(void)
114 ACPI_FUNCTION_TRACE(ev_install_fadt_gpes);
116 /* Namespace must be locked */
118 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
119 if (ACPI_FAILURE(status)) {
123 /* FADT GPE Block 0 */
125 (void)acpi_ev_initialize_gpe_block(acpi_gbl_fadt_gpe_device,
126 acpi_gbl_gpe_fadt_blocks[0]);
128 /* FADT GPE Block 1 */
130 (void)acpi_ev_initialize_gpe_block(acpi_gbl_fadt_gpe_device,
131 acpi_gbl_gpe_fadt_blocks[1]);
133 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
134 return_ACPI_STATUS(AE_OK);
137 /*******************************************************************************
139 * FUNCTION: acpi_ev_install_xrupt_handlers
145 * DESCRIPTION: Install interrupt handlers for the SCI and Global Lock
147 ******************************************************************************/
149 acpi_status acpi_ev_install_xrupt_handlers(void)
153 ACPI_FUNCTION_TRACE(ev_install_xrupt_handlers);
155 /* Install the SCI handler */
157 status = acpi_ev_install_sci_handler();
158 if (ACPI_FAILURE(status)) {
159 ACPI_EXCEPTION((AE_INFO, status,
160 "Unable to install System Control Interrupt handler"));
161 return_ACPI_STATUS(status);
164 /* Install the handler for the Global Lock */
166 status = acpi_ev_init_global_lock_handler();
167 if (ACPI_FAILURE(status)) {
168 ACPI_EXCEPTION((AE_INFO, status,
169 "Unable to initialize Global Lock handler"));
170 return_ACPI_STATUS(status);
173 acpi_gbl_events_initialized = TRUE;
174 return_ACPI_STATUS(status);
177 /*******************************************************************************
179 * FUNCTION: acpi_ev_fixed_event_initialize
185 * DESCRIPTION: Install the fixed event handlers and enable the fixed events.
187 ******************************************************************************/
189 static acpi_status acpi_ev_fixed_event_initialize(void)
195 * Initialize the structure that keeps track of fixed event handlers
196 * and enable the fixed events.
198 for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++) {
199 acpi_gbl_fixed_event_handlers[i].handler = NULL;
200 acpi_gbl_fixed_event_handlers[i].context = NULL;
202 /* Enable the fixed event */
204 if (acpi_gbl_fixed_event_info[i].enable_register_id != 0xFF) {
206 acpi_set_register(acpi_gbl_fixed_event_info[i].
207 enable_register_id, 0);
208 if (ACPI_FAILURE(status)) {
217 /*******************************************************************************
219 * FUNCTION: acpi_ev_fixed_event_detect
223 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
225 * DESCRIPTION: Checks the PM status register for active fixed events
227 ******************************************************************************/
229 u32 acpi_ev_fixed_event_detect(void)
231 u32 int_status = ACPI_INTERRUPT_NOT_HANDLED;
236 ACPI_FUNCTION_NAME(ev_fixed_event_detect);
239 * Read the fixed feature status and enable registers, as all the cases
240 * depend on their values. Ignore errors here.
242 (void)acpi_hw_register_read(ACPI_MTX_DO_NOT_LOCK,
243 ACPI_REGISTER_PM1_STATUS, &fixed_status);
244 (void)acpi_hw_register_read(ACPI_MTX_DO_NOT_LOCK,
245 ACPI_REGISTER_PM1_ENABLE, &fixed_enable);
247 ACPI_DEBUG_PRINT((ACPI_DB_INTERRUPTS,
248 "Fixed Event Block: Enable %08X Status %08X\n",
249 fixed_enable, fixed_status));
252 * Check for all possible Fixed Events and dispatch those that are active
254 for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++) {
256 /* Both the status and enable bits must be on for this event */
258 if ((fixed_status & acpi_gbl_fixed_event_info[i].
260 && (fixed_enable & acpi_gbl_fixed_event_info[i].
263 /* Found an active (signalled) event */
265 int_status |= acpi_ev_fixed_event_dispatch((u32) i);
272 /*******************************************************************************
274 * FUNCTION: acpi_ev_fixed_event_dispatch
276 * PARAMETERS: Event - Event type
278 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
280 * DESCRIPTION: Clears the status bit for the requested event, calls the
281 * handler that previously registered for the event.
283 ******************************************************************************/
285 static u32 acpi_ev_fixed_event_dispatch(u32 event)
288 ACPI_FUNCTION_ENTRY();
290 /* Clear the status bit */
292 (void)acpi_set_register(acpi_gbl_fixed_event_info[event].
293 status_register_id, 1);
296 * Make sure we've got a handler. If not, report an error.
297 * The event is disabled to prevent further interrupts.
299 if (NULL == acpi_gbl_fixed_event_handlers[event].handler) {
300 (void)acpi_set_register(acpi_gbl_fixed_event_info[event].
301 enable_register_id, 0);
304 "No installed handler for fixed event [%08X]",
307 return (ACPI_INTERRUPT_NOT_HANDLED);
310 /* Invoke the Fixed Event handler */
312 return ((acpi_gbl_fixed_event_handlers[event].
313 handler) (acpi_gbl_fixed_event_handlers[event].context));