blob: 9522c643b88b51545dc4c594c2d8c9dab2a74270 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/******************************************************************************
2 *
3 * Module Name: evevent - Fixed Event handling and dispatch
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2005, R. Byron Moore
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
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.
25 *
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.
29 *
30 * NO WARRANTY
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.
42 */
43
44#include <acpi/acpi.h>
45#include <acpi/acevents.h>
46
47#define _COMPONENT ACPI_EVENTS
Len Brown4be44fc2005-08-05 00:44:28 -040048ACPI_MODULE_NAME("evevent")
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
Robert Moore44f6c012005-04-18 22:49:35 -040050/* Local prototypes */
Len Brown4be44fc2005-08-05 00:44:28 -040051static acpi_status acpi_ev_fixed_event_initialize(void);
Robert Moore44f6c012005-04-18 22:49:35 -040052
Len Brown4be44fc2005-08-05 00:44:28 -040053static u32 acpi_ev_fixed_event_dispatch(u32 event);
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
55/*******************************************************************************
56 *
57 * FUNCTION: acpi_ev_initialize_events
58 *
59 * PARAMETERS: None
60 *
61 * RETURN: Status
62 *
Robert Moore44f6c012005-04-18 22:49:35 -040063 * DESCRIPTION: Initialize global data structures for ACPI events (Fixed, GPE)
Linus Torvalds1da177e2005-04-16 15:20:36 -070064 *
65 ******************************************************************************/
66
Len Brown4be44fc2005-08-05 00:44:28 -040067acpi_status acpi_ev_initialize_events(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -070068{
Len Brown4be44fc2005-08-05 00:44:28 -040069 acpi_status status;
Linus Torvalds1da177e2005-04-16 15:20:36 -070070
Len Brown4be44fc2005-08-05 00:44:28 -040071 ACPI_FUNCTION_TRACE("ev_initialize_events");
Linus Torvalds1da177e2005-04-16 15:20:36 -070072
73 /* Make sure we have ACPI tables */
74
75 if (!acpi_gbl_DSDT) {
Len Brown4be44fc2005-08-05 00:44:28 -040076 ACPI_DEBUG_PRINT((ACPI_DB_WARN, "No ACPI tables present!\n"));
77 return_ACPI_STATUS(AE_NO_ACPI_TABLES);
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 }
79
80 /*
Robert Moore44f6c012005-04-18 22:49:35 -040081 * Initialize the Fixed and General Purpose Events. This is done prior to
82 * enabling SCIs to prevent interrupts from occurring before the handlers are
83 * installed.
Linus Torvalds1da177e2005-04-16 15:20:36 -070084 */
Len Brown4be44fc2005-08-05 00:44:28 -040085 status = acpi_ev_fixed_event_initialize();
86 if (ACPI_FAILURE(status)) {
87 ACPI_REPORT_ERROR(("Unable to initialize fixed events, %s\n",
88 acpi_format_exception(status)));
89 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -070090 }
91
Len Brown4be44fc2005-08-05 00:44:28 -040092 status = acpi_ev_gpe_initialize();
93 if (ACPI_FAILURE(status)) {
94 ACPI_REPORT_ERROR(("Unable to initialize general purpose events, %s\n", acpi_format_exception(status)));
95 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 }
97
Len Brown4be44fc2005-08-05 00:44:28 -040098 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -070099}
100
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101/*******************************************************************************
102 *
Bob Moore96db2552005-11-02 00:00:00 -0500103 * FUNCTION: acpi_ev_install_fadt_gpes
104 *
105 * PARAMETERS: None
106 *
107 * RETURN: Status
108 *
109 * DESCRIPTION: Completes initialization of the FADT-defined GPE blocks
110 * (0 and 1). This causes the _PRW methods to be run, so the HW
111 * must be fully initialized at this point, including global lock
112 * support.
113 *
114 ******************************************************************************/
115
116acpi_status acpi_ev_install_fadt_gpes(void)
117{
118 acpi_status status;
119
120 ACPI_FUNCTION_TRACE("ev_install_fadt_gpes");
121
122 /* Namespace must be locked */
123
124 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
125 if (ACPI_FAILURE(status)) {
126 return (status);
127 }
128
129 /* FADT GPE Block 0 */
130
131 (void)acpi_ev_initialize_gpe_block(acpi_gbl_fadt_gpe_device,
132 acpi_gbl_gpe_fadt_blocks[0]);
133
134 /* FADT GPE Block 1 */
135
136 (void)acpi_ev_initialize_gpe_block(acpi_gbl_fadt_gpe_device,
137 acpi_gbl_gpe_fadt_blocks[1]);
138
139 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
140 return_ACPI_STATUS(AE_OK);
141}
142
143/*******************************************************************************
144 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 * FUNCTION: acpi_ev_install_xrupt_handlers
146 *
147 * PARAMETERS: None
148 *
149 * RETURN: Status
150 *
151 * DESCRIPTION: Install interrupt handlers for the SCI and Global Lock
152 *
153 ******************************************************************************/
154
Len Brown4be44fc2005-08-05 00:44:28 -0400155acpi_status acpi_ev_install_xrupt_handlers(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156{
Len Brown4be44fc2005-08-05 00:44:28 -0400157 acpi_status status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158
Len Brown4be44fc2005-08-05 00:44:28 -0400159 ACPI_FUNCTION_TRACE("ev_install_xrupt_handlers");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160
161 /* Install the SCI handler */
162
Len Brown4be44fc2005-08-05 00:44:28 -0400163 status = acpi_ev_install_sci_handler();
164 if (ACPI_FAILURE(status)) {
165 ACPI_REPORT_ERROR(("Unable to install System Control Interrupt Handler, %s\n", acpi_format_exception(status)));
166 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 }
168
169 /* Install the handler for the Global Lock */
170
Len Brown4be44fc2005-08-05 00:44:28 -0400171 status = acpi_ev_init_global_lock_handler();
172 if (ACPI_FAILURE(status)) {
173 ACPI_REPORT_ERROR(("Unable to initialize Global Lock handler, %s\n", acpi_format_exception(status)));
174 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 }
176
177 acpi_gbl_events_initialized = TRUE;
Len Brown4be44fc2005-08-05 00:44:28 -0400178 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179}
180
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181/*******************************************************************************
182 *
183 * FUNCTION: acpi_ev_fixed_event_initialize
184 *
185 * PARAMETERS: None
186 *
187 * RETURN: Status
188 *
189 * DESCRIPTION: Install the fixed event handlers and enable the fixed events.
190 *
191 ******************************************************************************/
192
Len Brown4be44fc2005-08-05 00:44:28 -0400193static acpi_status acpi_ev_fixed_event_initialize(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194{
Len Brown4be44fc2005-08-05 00:44:28 -0400195 acpi_native_uint i;
196 acpi_status status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197
198 /*
199 * Initialize the structure that keeps track of fixed event handlers
200 * and enable the fixed events.
201 */
202 for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++) {
203 acpi_gbl_fixed_event_handlers[i].handler = NULL;
204 acpi_gbl_fixed_event_handlers[i].context = NULL;
205
206 /* Enable the fixed event */
207
208 if (acpi_gbl_fixed_event_info[i].enable_register_id != 0xFF) {
Len Brown4be44fc2005-08-05 00:44:28 -0400209 status =
210 acpi_set_register(acpi_gbl_fixed_event_info[i].
211 enable_register_id, 0,
212 ACPI_MTX_LOCK);
213 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 return (status);
215 }
216 }
217 }
218
219 return (AE_OK);
220}
221
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222/*******************************************************************************
223 *
224 * FUNCTION: acpi_ev_fixed_event_detect
225 *
226 * PARAMETERS: None
227 *
228 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
229 *
Robert Moore44f6c012005-04-18 22:49:35 -0400230 * DESCRIPTION: Checks the PM status register for active fixed events
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 *
232 ******************************************************************************/
233
Len Brown4be44fc2005-08-05 00:44:28 -0400234u32 acpi_ev_fixed_event_detect(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235{
Len Brown4be44fc2005-08-05 00:44:28 -0400236 u32 int_status = ACPI_INTERRUPT_NOT_HANDLED;
237 u32 fixed_status;
238 u32 fixed_enable;
239 acpi_native_uint i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240
Len Brown4be44fc2005-08-05 00:44:28 -0400241 ACPI_FUNCTION_NAME("ev_fixed_event_detect");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242
243 /*
244 * Read the fixed feature status and enable registers, as all the cases
245 * depend on their values. Ignore errors here.
246 */
Len Brown4be44fc2005-08-05 00:44:28 -0400247 (void)acpi_hw_register_read(ACPI_MTX_DO_NOT_LOCK,
248 ACPI_REGISTER_PM1_STATUS, &fixed_status);
249 (void)acpi_hw_register_read(ACPI_MTX_DO_NOT_LOCK,
250 ACPI_REGISTER_PM1_ENABLE, &fixed_enable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251
Len Brown4be44fc2005-08-05 00:44:28 -0400252 ACPI_DEBUG_PRINT((ACPI_DB_INTERRUPTS,
253 "Fixed Event Block: Enable %08X Status %08X\n",
254 fixed_enable, fixed_status));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255
256 /*
257 * Check for all possible Fixed Events and dispatch those that are active
258 */
259 for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++) {
260 /* Both the status and enable bits must be on for this event */
261
Len Brown4be44fc2005-08-05 00:44:28 -0400262 if ((fixed_status & acpi_gbl_fixed_event_info[i].
263 status_bit_mask)
264 && (fixed_enable & acpi_gbl_fixed_event_info[i].
265 enable_bit_mask)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 /* Found an active (signalled) event */
267
Len Brown4be44fc2005-08-05 00:44:28 -0400268 int_status |= acpi_ev_fixed_event_dispatch((u32) i);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 }
270 }
271
272 return (int_status);
273}
274
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275/*******************************************************************************
276 *
277 * FUNCTION: acpi_ev_fixed_event_dispatch
278 *
279 * PARAMETERS: Event - Event type
280 *
281 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
282 *
283 * DESCRIPTION: Clears the status bit for the requested event, calls the
284 * handler that previously registered for the event.
285 *
286 ******************************************************************************/
287
Len Brown4be44fc2005-08-05 00:44:28 -0400288static u32 acpi_ev_fixed_event_dispatch(u32 event)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289{
290
Len Brown4be44fc2005-08-05 00:44:28 -0400291 ACPI_FUNCTION_ENTRY();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292
293 /* Clear the status bit */
294
Len Brown4be44fc2005-08-05 00:44:28 -0400295 (void)acpi_set_register(acpi_gbl_fixed_event_info[event].
296 status_register_id, 1, ACPI_MTX_DO_NOT_LOCK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297
298 /*
299 * Make sure we've got a handler. If not, report an error.
300 * The event is disabled to prevent further interrupts.
301 */
302 if (NULL == acpi_gbl_fixed_event_handlers[event].handler) {
Len Brown4be44fc2005-08-05 00:44:28 -0400303 (void)acpi_set_register(acpi_gbl_fixed_event_info[event].
304 enable_register_id, 0,
305 ACPI_MTX_DO_NOT_LOCK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306
Len Brown4be44fc2005-08-05 00:44:28 -0400307 ACPI_REPORT_ERROR(("No installed handler for fixed event [%08X]\n", event));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308
309 return (ACPI_INTERRUPT_NOT_HANDLED);
310 }
311
312 /* Invoke the Fixed Event handler */
313
Len Brown4be44fc2005-08-05 00:44:28 -0400314 return ((acpi_gbl_fixed_event_handlers[event].
315 handler) (acpi_gbl_fixed_event_handlers[event].context));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316}