Pull acpica into test branch
[linux-2.6] / drivers / acpi / events / evevent.c
1 /******************************************************************************
2  *
3  * Module Name: evevent - Fixed Event handling and dispatch
4  *
5  *****************************************************************************/
6
7 /*
8  * Copyright (C) 2000 - 2007, 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
48 ACPI_MODULE_NAME("evevent")
49
50 /* Local prototypes */
51 static acpi_status acpi_ev_fixed_event_initialize(void);
52
53 static u32 acpi_ev_fixed_event_dispatch(u32 event);
54
55 /*******************************************************************************
56  *
57  * FUNCTION:    acpi_ev_initialize_events
58  *
59  * PARAMETERS:  None
60  *
61  * RETURN:      Status
62  *
63  * DESCRIPTION: Initialize global data structures for ACPI events (Fixed, GPE)
64  *
65  ******************************************************************************/
66
67 acpi_status acpi_ev_initialize_events(void)
68 {
69         acpi_status status;
70
71         ACPI_FUNCTION_TRACE(ev_initialize_events);
72
73         /*
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
76          * installed.
77          */
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);
83         }
84
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);
90         }
91
92         return_ACPI_STATUS(status);
93 }
94
95 /*******************************************************************************
96  *
97  * FUNCTION:    acpi_ev_install_fadt_gpes
98  *
99  * PARAMETERS:  None
100  *
101  * RETURN:      Status
102  *
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
106  *              support.
107  *
108  ******************************************************************************/
109
110 acpi_status acpi_ev_install_fadt_gpes(void)
111 {
112         acpi_status status;
113
114         ACPI_FUNCTION_TRACE(ev_install_fadt_gpes);
115
116         /* Namespace must be locked */
117
118         status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
119         if (ACPI_FAILURE(status)) {
120                 return (status);
121         }
122
123         /* FADT GPE Block 0 */
124
125         (void)acpi_ev_initialize_gpe_block(acpi_gbl_fadt_gpe_device,
126                                            acpi_gbl_gpe_fadt_blocks[0]);
127
128         /* FADT GPE Block 1 */
129
130         (void)acpi_ev_initialize_gpe_block(acpi_gbl_fadt_gpe_device,
131                                            acpi_gbl_gpe_fadt_blocks[1]);
132
133         (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
134         return_ACPI_STATUS(AE_OK);
135 }
136
137 /*******************************************************************************
138  *
139  * FUNCTION:    acpi_ev_install_xrupt_handlers
140  *
141  * PARAMETERS:  None
142  *
143  * RETURN:      Status
144  *
145  * DESCRIPTION: Install interrupt handlers for the SCI and Global Lock
146  *
147  ******************************************************************************/
148
149 acpi_status acpi_ev_install_xrupt_handlers(void)
150 {
151         acpi_status status;
152
153         ACPI_FUNCTION_TRACE(ev_install_xrupt_handlers);
154
155         /* Install the SCI handler */
156
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);
162         }
163
164         /* Install the handler for the Global Lock */
165
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);
171         }
172
173         acpi_gbl_events_initialized = TRUE;
174         return_ACPI_STATUS(status);
175 }
176
177 /*******************************************************************************
178  *
179  * FUNCTION:    acpi_ev_fixed_event_initialize
180  *
181  * PARAMETERS:  None
182  *
183  * RETURN:      Status
184  *
185  * DESCRIPTION: Install the fixed event handlers and enable the fixed events.
186  *
187  ******************************************************************************/
188
189 static acpi_status acpi_ev_fixed_event_initialize(void)
190 {
191         acpi_native_uint i;
192         acpi_status status;
193
194         /*
195          * Initialize the structure that keeps track of fixed event handlers
196          * and enable the fixed events.
197          */
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;
201
202                 /* Enable the fixed event */
203
204                 if (acpi_gbl_fixed_event_info[i].enable_register_id != 0xFF) {
205                         status =
206                             acpi_set_register(acpi_gbl_fixed_event_info[i].
207                                               enable_register_id, 0);
208                         if (ACPI_FAILURE(status)) {
209                                 return (status);
210                         }
211                 }
212         }
213
214         return (AE_OK);
215 }
216
217 /*******************************************************************************
218  *
219  * FUNCTION:    acpi_ev_fixed_event_detect
220  *
221  * PARAMETERS:  None
222  *
223  * RETURN:      INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
224  *
225  * DESCRIPTION: Checks the PM status register for active fixed events
226  *
227  ******************************************************************************/
228
229 u32 acpi_ev_fixed_event_detect(void)
230 {
231         u32 int_status = ACPI_INTERRUPT_NOT_HANDLED;
232         u32 fixed_status;
233         u32 fixed_enable;
234         acpi_native_uint i;
235
236         ACPI_FUNCTION_NAME(ev_fixed_event_detect);
237
238         /*
239          * Read the fixed feature status and enable registers, as all the cases
240          * depend on their values.  Ignore errors here.
241          */
242         (void)acpi_hw_register_read(ACPI_REGISTER_PM1_STATUS, &fixed_status);
243         (void)acpi_hw_register_read(ACPI_REGISTER_PM1_ENABLE, &fixed_enable);
244
245         ACPI_DEBUG_PRINT((ACPI_DB_INTERRUPTS,
246                           "Fixed Event Block: Enable %08X Status %08X\n",
247                           fixed_enable, fixed_status));
248
249         /*
250          * Check for all possible Fixed Events and dispatch those that are active
251          */
252         for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++) {
253
254                 /* Both the status and enable bits must be on for this event */
255
256                 if ((fixed_status & acpi_gbl_fixed_event_info[i].
257                      status_bit_mask)
258                     && (fixed_enable & acpi_gbl_fixed_event_info[i].
259                         enable_bit_mask)) {
260
261                         /* Found an active (signalled) event */
262
263                         int_status |= acpi_ev_fixed_event_dispatch((u32) i);
264                 }
265         }
266
267         return (int_status);
268 }
269
270 /*******************************************************************************
271  *
272  * FUNCTION:    acpi_ev_fixed_event_dispatch
273  *
274  * PARAMETERS:  Event               - Event type
275  *
276  * RETURN:      INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
277  *
278  * DESCRIPTION: Clears the status bit for the requested event, calls the
279  *              handler that previously registered for the event.
280  *
281  ******************************************************************************/
282
283 static u32 acpi_ev_fixed_event_dispatch(u32 event)
284 {
285
286         ACPI_FUNCTION_ENTRY();
287
288         /* Clear the status bit */
289
290         (void)acpi_set_register(acpi_gbl_fixed_event_info[event].
291                                 status_register_id, 1);
292
293         /*
294          * Make sure we've got a handler.  If not, report an error.
295          * The event is disabled to prevent further interrupts.
296          */
297         if (NULL == acpi_gbl_fixed_event_handlers[event].handler) {
298                 (void)acpi_set_register(acpi_gbl_fixed_event_info[event].
299                                         enable_register_id, 0);
300
301                 ACPI_ERROR((AE_INFO,
302                             "No installed handler for fixed event [%08X]",
303                             event));
304
305                 return (ACPI_INTERRUPT_NOT_HANDLED);
306         }
307
308         /* Invoke the Fixed Event handler */
309
310         return ((acpi_gbl_fixed_event_handlers[event].
311                  handler) (acpi_gbl_fixed_event_handlers[event].context));
312 }