blob: f4725212eb488fd1b37a3c2cc21735dbeb2282ad [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/******************************************************************************
2 *
3 * Module Name: evgpe - General Purpose Event handling and dispatch
4 *
5 *****************************************************************************/
6
7/*
Bob Mooreb4e104e2011-01-17 11:05:40 +08008 * Copyright (C) 2000 - 2011, Intel Corp.
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 * 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>
Len Browne2f7a772009-01-09 00:30:03 -050045#include "accommon.h"
46#include "acevents.h"
47#include "acnamesp.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070048
49#define _COMPONENT ACPI_EVENTS
Len Brown4be44fc2005-08-05 00:44:28 -040050ACPI_MODULE_NAME("evgpe")
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
Robert Moore44f6c012005-04-18 22:49:35 -040052/* Local prototypes */
Len Brown4be44fc2005-08-05 00:44:28 -040053static void ACPI_SYSTEM_XFACE acpi_ev_asynch_execute_gpe_method(void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Lin Ming5a284cd2010-12-13 13:39:07 +080055static void ACPI_SYSTEM_XFACE acpi_ev_asynch_enable_gpe(void *context);
56
Linus Torvalds1da177e2005-04-16 15:20:36 -070057/*******************************************************************************
58 *
Rafael J. Wysockia44061a2010-07-01 10:11:45 +080059 * FUNCTION: acpi_ev_update_gpe_enable_mask
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 *
61 * PARAMETERS: gpe_event_info - GPE to update
Linus Torvalds1da177e2005-04-16 15:20:36 -070062 *
63 * RETURN: Status
64 *
Rafael J. Wysockia44061a2010-07-01 10:11:45 +080065 * DESCRIPTION: Updates GPE register enable mask based upon whether there are
66 * runtime references to this GPE
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 *
68 ******************************************************************************/
69
70acpi_status
Rafael J. Wysockia44061a2010-07-01 10:11:45 +080071acpi_ev_update_gpe_enable_mask(struct acpi_gpe_event_info *gpe_event_info)
Linus Torvalds1da177e2005-04-16 15:20:36 -070072{
Len Brown4be44fc2005-08-05 00:44:28 -040073 struct acpi_gpe_register_info *gpe_register_info;
Rafael J. Wysockie4e9a732010-06-08 10:48:26 +020074 u32 register_bit;
Linus Torvalds1da177e2005-04-16 15:20:36 -070075
Rafael J. Wysockia44061a2010-07-01 10:11:45 +080076 ACPI_FUNCTION_TRACE(ev_update_gpe_enable_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -070077
78 gpe_register_info = gpe_event_info->register_info;
79 if (!gpe_register_info) {
Len Brown4be44fc2005-08-05 00:44:28 -040080 return_ACPI_STATUS(AE_NOT_EXIST);
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 }
Bob Moored4913dc2009-03-06 10:05:18 +080082
Lin Mingb76df672010-07-01 10:07:17 +080083 register_bit = acpi_hw_get_gpe_register_bit(gpe_event_info,
Rafael J. Wysockie4e9a732010-06-08 10:48:26 +020084 gpe_register_info);
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
Rafael J. Wysockia44061a2010-07-01 10:11:45 +080086 /* Clear the run bit up front */
Lin Ming0f849d22010-04-06 14:52:37 +080087
Rafael J. Wysocki9630bdd2010-02-17 23:41:07 +010088 ACPI_CLEAR_BIT(gpe_register_info->enable_for_run, register_bit);
Linus Torvalds1da177e2005-04-16 15:20:36 -070089
Rafael J. Wysockia44061a2010-07-01 10:11:45 +080090 /* Set the mask bit only if there are references to this GPE */
Linus Torvalds1da177e2005-04-16 15:20:36 -070091
Lin Ming0f849d22010-04-06 14:52:37 +080092 if (gpe_event_info->runtime_count) {
Rafael J. Wysockia44061a2010-07-01 10:11:45 +080093 ACPI_SET_BIT(gpe_register_info->enable_for_run, (u8)register_bit);
Lin Ming0f849d22010-04-06 14:52:37 +080094 }
Linus Torvalds1da177e2005-04-16 15:20:36 -070095
Len Brown4be44fc2005-08-05 00:44:28 -040096 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -070097}
98
Rafael J. Wysocki3bd741b2010-07-01 11:01:12 +080099/*******************************************************************************
100 *
101 * FUNCTION: acpi_ev_enable_gpe
102 *
103 * PARAMETERS: gpe_event_info - GPE to enable
104 *
105 * RETURN: Status
106 *
Lin Mingda503372010-12-13 13:39:37 +0800107 * DESCRIPTION: Clear a GPE of stale events and enable it.
Rafael J. Wysocki3bd741b2010-07-01 11:01:12 +0800108 *
109 ******************************************************************************/
110acpi_status
111acpi_ev_enable_gpe(struct acpi_gpe_event_info *gpe_event_info)
112{
113 acpi_status status;
114
115 ACPI_FUNCTION_TRACE(ev_enable_gpe);
116
117 /*
Lin Mingbba63a22010-12-13 13:39:17 +0800118 * We will only allow a GPE to be enabled if it has either an associated
119 * method (_Lxx/_Exx) or a handler, or is using the implicit notify
120 * feature. Otherwise, the GPE will be immediately disabled by
121 * acpi_ev_gpe_dispatch the first time it fires.
Rafael J. Wysocki3bd741b2010-07-01 11:01:12 +0800122 */
Lin Mingbba63a22010-12-13 13:39:17 +0800123 if ((gpe_event_info->flags & ACPI_GPE_DISPATCH_MASK) ==
124 ACPI_GPE_DISPATCH_NONE) {
Rafael J. Wysocki3bd741b2010-07-01 11:01:12 +0800125 return_ACPI_STATUS(AE_NO_HANDLER);
126 }
127
128 /* Clear the GPE (of stale events) */
129 status = acpi_hw_clear_gpe(gpe_event_info);
130 if (ACPI_FAILURE(status)) {
131 return_ACPI_STATUS(status);
132 }
133
134 /* Enable the requested GPE */
135 status = acpi_hw_low_set_gpe(gpe_event_info, ACPI_GPE_ENABLE);
136
137 return_ACPI_STATUS(status);
138}
139
Lin Ming0f849d22010-04-06 14:52:37 +0800140
141/*******************************************************************************
142 *
Lin Ming3a378982010-12-13 13:36:15 +0800143 * FUNCTION: acpi_ev_add_gpe_reference
Rafael J. Wysocki28f4f8a2010-08-03 23:55:14 +0200144 *
Lin Mingda503372010-12-13 13:39:37 +0800145 * PARAMETERS: gpe_event_info - Add a reference to this GPE
Rafael J. Wysocki28f4f8a2010-08-03 23:55:14 +0200146 *
147 * RETURN: Status
148 *
149 * DESCRIPTION: Add a reference to a GPE. On the first reference, the GPE is
150 * hardware-enabled.
151 *
152 ******************************************************************************/
153
Lin Ming3a378982010-12-13 13:36:15 +0800154acpi_status acpi_ev_add_gpe_reference(struct acpi_gpe_event_info *gpe_event_info)
Rafael J. Wysocki28f4f8a2010-08-03 23:55:14 +0200155{
156 acpi_status status = AE_OK;
157
Lin Ming3a378982010-12-13 13:36:15 +0800158 ACPI_FUNCTION_TRACE(ev_add_gpe_reference);
159
Rafael J. Wysocki28f4f8a2010-08-03 23:55:14 +0200160 if (gpe_event_info->runtime_count == ACPI_UINT8_MAX) {
161 return_ACPI_STATUS(AE_LIMIT);
162 }
163
164 gpe_event_info->runtime_count++;
165 if (gpe_event_info->runtime_count == 1) {
Lin Mingda503372010-12-13 13:39:37 +0800166
167 /* Enable on first reference */
168
Rafael J. Wysocki28f4f8a2010-08-03 23:55:14 +0200169 status = acpi_ev_update_gpe_enable_mask(gpe_event_info);
170 if (ACPI_SUCCESS(status)) {
171 status = acpi_ev_enable_gpe(gpe_event_info);
172 }
173
174 if (ACPI_FAILURE(status)) {
175 gpe_event_info->runtime_count--;
176 }
177 }
178
179 return_ACPI_STATUS(status);
180}
181
182/*******************************************************************************
183 *
Lin Ming3a378982010-12-13 13:36:15 +0800184 * FUNCTION: acpi_ev_remove_gpe_reference
Rafael J. Wysocki28f4f8a2010-08-03 23:55:14 +0200185 *
Lin Mingda503372010-12-13 13:39:37 +0800186 * PARAMETERS: gpe_event_info - Remove a reference to this GPE
Rafael J. Wysocki28f4f8a2010-08-03 23:55:14 +0200187 *
188 * RETURN: Status
189 *
190 * DESCRIPTION: Remove a reference to a GPE. When the last reference is
191 * removed, the GPE is hardware-disabled.
192 *
193 ******************************************************************************/
194
Lin Ming3a378982010-12-13 13:36:15 +0800195acpi_status acpi_ev_remove_gpe_reference(struct acpi_gpe_event_info *gpe_event_info)
Rafael J. Wysocki28f4f8a2010-08-03 23:55:14 +0200196{
197 acpi_status status = AE_OK;
198
Lin Ming3a378982010-12-13 13:36:15 +0800199 ACPI_FUNCTION_TRACE(ev_remove_gpe_reference);
200
Rafael J. Wysocki28f4f8a2010-08-03 23:55:14 +0200201 if (!gpe_event_info->runtime_count) {
202 return_ACPI_STATUS(AE_LIMIT);
203 }
204
205 gpe_event_info->runtime_count--;
206 if (!gpe_event_info->runtime_count) {
Lin Mingda503372010-12-13 13:39:37 +0800207
208 /* Disable on last reference */
209
Rafael J. Wysocki28f4f8a2010-08-03 23:55:14 +0200210 status = acpi_ev_update_gpe_enable_mask(gpe_event_info);
211 if (ACPI_SUCCESS(status)) {
212 status = acpi_hw_low_set_gpe(gpe_event_info,
213 ACPI_GPE_DISABLE);
214 }
215
216 if (ACPI_FAILURE(status)) {
217 gpe_event_info->runtime_count++;
218 }
219 }
220
221 return_ACPI_STATUS(status);
222}
223
224/*******************************************************************************
225 *
Lin Ming0f849d22010-04-06 14:52:37 +0800226 * FUNCTION: acpi_ev_low_get_gpe_info
227 *
228 * PARAMETERS: gpe_number - Raw GPE number
229 * gpe_block - A GPE info block
230 *
231 * RETURN: A GPE event_info struct. NULL if not a valid GPE (The gpe_number
232 * is not within the specified GPE block)
233 *
234 * DESCRIPTION: Returns the event_info struct associated with this GPE. This is
235 * the low-level implementation of ev_get_gpe_event_info.
236 *
237 ******************************************************************************/
238
239struct acpi_gpe_event_info *acpi_ev_low_get_gpe_info(u32 gpe_number,
240 struct acpi_gpe_block_info
241 *gpe_block)
242{
243 u32 gpe_index;
244
245 /*
246 * Validate that the gpe_number is within the specified gpe_block.
247 * (Two steps)
248 */
249 if (!gpe_block || (gpe_number < gpe_block->block_base_number)) {
250 return (NULL);
251 }
252
253 gpe_index = gpe_number - gpe_block->block_base_number;
254 if (gpe_index >= gpe_block->gpe_count) {
255 return (NULL);
256 }
257
258 return (&gpe_block->event_info[gpe_index]);
259}
260
261
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262/*******************************************************************************
263 *
264 * FUNCTION: acpi_ev_get_gpe_event_info
265 *
Bob Moore9f15fc62008-11-12 16:01:56 +0800266 * PARAMETERS: gpe_device - Device node. NULL for GPE0/GPE1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 * gpe_number - Raw GPE number
268 *
269 * RETURN: A GPE event_info struct. NULL if not a valid GPE
270 *
271 * DESCRIPTION: Returns the event_info struct associated with this GPE.
272 * Validates the gpe_block and the gpe_number
273 *
274 * Should be called only when the GPE lists are semaphore locked
275 * and not subject to change.
276 *
277 ******************************************************************************/
278
Len Brown4be44fc2005-08-05 00:44:28 -0400279struct acpi_gpe_event_info *acpi_ev_get_gpe_event_info(acpi_handle gpe_device,
280 u32 gpe_number)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281{
Len Brown4be44fc2005-08-05 00:44:28 -0400282 union acpi_operand_object *obj_desc;
Lin Ming0f849d22010-04-06 14:52:37 +0800283 struct acpi_gpe_event_info *gpe_info;
Bob Moore67a119f2008-06-10 13:42:13 +0800284 u32 i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285
Len Brown4be44fc2005-08-05 00:44:28 -0400286 ACPI_FUNCTION_ENTRY();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287
Bob Moore186c3072010-04-27 11:32:28 +0800288 /* A NULL gpe_device means use the FADT-defined GPE block(s) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289
290 if (!gpe_device) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400291
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292 /* Examine GPE Block 0 and 1 (These blocks are permanent) */
293
294 for (i = 0; i < ACPI_MAX_GPE_BLOCKS; i++) {
Lin Ming0f849d22010-04-06 14:52:37 +0800295 gpe_info = acpi_ev_low_get_gpe_info(gpe_number,
296 acpi_gbl_gpe_fadt_blocks
297 [i]);
298 if (gpe_info) {
299 return (gpe_info);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300 }
301 }
302
303 /* The gpe_number was not in the range of either FADT GPE block */
304
305 return (NULL);
306 }
307
308 /* A Non-NULL gpe_device means this is a GPE Block Device */
309
Len Brownfd350942007-05-09 23:34:35 -0400310 obj_desc = acpi_ns_get_attached_object((struct acpi_namespace_node *)
311 gpe_device);
Len Brown4be44fc2005-08-05 00:44:28 -0400312 if (!obj_desc || !obj_desc->device.gpe_block) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 return (NULL);
314 }
315
Lin Ming0f849d22010-04-06 14:52:37 +0800316 return (acpi_ev_low_get_gpe_info
317 (gpe_number, obj_desc->device.gpe_block));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318}
319
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320/*******************************************************************************
321 *
322 * FUNCTION: acpi_ev_gpe_detect
323 *
324 * PARAMETERS: gpe_xrupt_list - Interrupt block for this interrupt.
325 * Can have multiple GPE blocks attached.
326 *
327 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
328 *
Bob Moore9f15fc62008-11-12 16:01:56 +0800329 * DESCRIPTION: Detect if any GP events have occurred. This function is
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 * executed at interrupt level.
331 *
332 ******************************************************************************/
333
Len Brown4be44fc2005-08-05 00:44:28 -0400334u32 acpi_ev_gpe_detect(struct acpi_gpe_xrupt_info * gpe_xrupt_list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335{
Len Brown4be44fc2005-08-05 00:44:28 -0400336 acpi_status status;
337 struct acpi_gpe_block_info *gpe_block;
Bob Moore08978312005-10-21 00:00:00 -0400338 struct acpi_gpe_register_info *gpe_register_info;
339 u32 int_status = ACPI_INTERRUPT_NOT_HANDLED;
340 u8 enabled_status_byte;
341 u32 status_reg;
342 u32 enable_reg;
Bob Mooreb8e4d892006-01-27 16:43:00 -0500343 acpi_cpu_flags flags;
Bob Moore67a119f2008-06-10 13:42:13 +0800344 u32 i;
345 u32 j;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346
Bob Mooreb229cf92006-04-21 17:15:00 -0400347 ACPI_FUNCTION_NAME(ev_gpe_detect);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348
349 /* Check for the case where there are no GPEs */
350
351 if (!gpe_xrupt_list) {
352 return (int_status);
353 }
354
Bob Moore967440e32006-06-23 17:04:00 -0400355 /*
356 * We need to obtain the GPE lock for both the data structs and registers
Bob Moore9f15fc62008-11-12 16:01:56 +0800357 * Note: Not necessary to obtain the hardware lock, since the GPE
358 * registers are owned by the gpe_lock.
Bob Moore967440e32006-06-23 17:04:00 -0400359 */
Len Brown4be44fc2005-08-05 00:44:28 -0400360 flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
Bob Moore4c90ece2006-06-08 16:29:00 -0400361
362 /* Examine all GPE blocks attached to this interrupt level */
363
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 gpe_block = gpe_xrupt_list->gpe_block_list_head;
365 while (gpe_block) {
366 /*
Bob Moore9f15fc62008-11-12 16:01:56 +0800367 * Read all of the 8-bit GPE status and enable registers in this GPE
368 * block, saving all of them. Find all currently active GP events.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 */
370 for (i = 0; i < gpe_block->register_count; i++) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400371
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 /* Get the next status/enable pair */
373
374 gpe_register_info = &gpe_block->register_info[i];
375
376 /* Read the Status Register */
377
Len Brown4be44fc2005-08-05 00:44:28 -0400378 status =
Bob Moorec6b57742009-06-24 09:44:06 +0800379 acpi_hw_read(&status_reg,
380 &gpe_register_info->status_address);
Len Brown4be44fc2005-08-05 00:44:28 -0400381 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382 goto unlock_and_exit;
383 }
384
385 /* Read the Enable Register */
386
Len Brown4be44fc2005-08-05 00:44:28 -0400387 status =
Bob Moorec6b57742009-06-24 09:44:06 +0800388 acpi_hw_read(&enable_reg,
389 &gpe_register_info->enable_address);
Len Brown4be44fc2005-08-05 00:44:28 -0400390 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391 goto unlock_and_exit;
392 }
393
Len Brown4be44fc2005-08-05 00:44:28 -0400394 ACPI_DEBUG_PRINT((ACPI_DB_INTERRUPTS,
Lin Mingda503372010-12-13 13:39:37 +0800395 "Read GPE Register at GPE%02X: Status=%02X, Enable=%02X\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400396 gpe_register_info->base_gpe_number,
397 status_reg, enable_reg));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398
Robert Moore44f6c012005-04-18 22:49:35 -0400399 /* Check if there is anything active at all in this register */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400
401 enabled_status_byte = (u8) (status_reg & enable_reg);
402 if (!enabled_status_byte) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400403
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 /* No active GPEs in this register, move on */
405
406 continue;
407 }
408
409 /* Now look at the individual GPEs in this byte register */
410
411 for (j = 0; j < ACPI_GPE_REGISTER_WIDTH; j++) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400412
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 /* Examine one GPE bit */
414
Alexey Starikovskiy69874162007-02-02 19:48:19 +0300415 if (enabled_status_byte & (1 << j)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416 /*
417 * Found an active GPE. Dispatch the event to a handler
418 * or method.
419 */
Len Brown4be44fc2005-08-05 00:44:28 -0400420 int_status |=
Lin Ming8b6cd8a2010-12-13 13:38:46 +0800421 acpi_ev_gpe_dispatch(gpe_block->
422 node,
423 &gpe_block->
Bob Moore67a119f2008-06-10 13:42:13 +0800424 event_info[((acpi_size) i * ACPI_GPE_REGISTER_WIDTH) + j], j + gpe_register_info->base_gpe_number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 }
426 }
427 }
428
429 gpe_block = gpe_block->next;
430 }
431
Len Brown4be44fc2005-08-05 00:44:28 -0400432 unlock_and_exit:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433
Len Brown4be44fc2005-08-05 00:44:28 -0400434 acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 return (int_status);
436}
437
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438/*******************************************************************************
439 *
440 * FUNCTION: acpi_ev_asynch_execute_gpe_method
441 *
442 * PARAMETERS: Context (gpe_event_info) - Info for this GPE
443 *
444 * RETURN: None
445 *
Bob Moore41195322006-05-26 16:36:00 -0400446 * DESCRIPTION: Perform the actual execution of a GPE control method. This
447 * function is called from an invocation of acpi_os_execute and
448 * therefore does NOT execute at interrupt level - so that
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 * the control method itself is not executed in the context of
450 * an interrupt handler.
451 *
452 ******************************************************************************/
453
Len Brown4be44fc2005-08-05 00:44:28 -0400454static void ACPI_SYSTEM_XFACE acpi_ev_asynch_execute_gpe_method(void *context)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455{
Lin Ming5a284cd2010-12-13 13:39:07 +0800456 struct acpi_gpe_event_info *gpe_event_info = context;
Len Brown4be44fc2005-08-05 00:44:28 -0400457 acpi_status status;
Lin Ming5a284cd2010-12-13 13:39:07 +0800458 struct acpi_gpe_event_info *local_gpe_event_info;
Bob Moore41195322006-05-26 16:36:00 -0400459 struct acpi_evaluate_info *info;
Rafael J. Wysocki981858b2011-02-24 19:59:21 +0100460 struct acpi_gpe_notify_object *notify_object;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461
Bob Mooreb229cf92006-04-21 17:15:00 -0400462 ACPI_FUNCTION_TRACE(ev_asynch_execute_gpe_method);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463
Lin Ming5a284cd2010-12-13 13:39:07 +0800464 /* Allocate a local GPE block */
465
466 local_gpe_event_info =
467 ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_gpe_event_info));
468 if (!local_gpe_event_info) {
469 ACPI_EXCEPTION((AE_INFO, AE_NO_MEMORY, "while handling a GPE"));
470 return_VOID;
471 }
472
Len Brown4be44fc2005-08-05 00:44:28 -0400473 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
474 if (ACPI_FAILURE(status)) {
Jesper Juhlbe33b762011-01-16 20:37:52 +0100475 ACPI_FREE(local_gpe_event_info);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 return_VOID;
477 }
478
479 /* Must revalidate the gpe_number/gpe_block */
480
Len Brown4be44fc2005-08-05 00:44:28 -0400481 if (!acpi_ev_valid_gpe_event(gpe_event_info)) {
482 status = acpi_ut_release_mutex(ACPI_MTX_EVENTS);
Jesper Juhlbe33b762011-01-16 20:37:52 +0100483 ACPI_FREE(local_gpe_event_info);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484 return_VOID;
485 }
486
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 /*
Bob Moore9f15fc62008-11-12 16:01:56 +0800488 * Take a snapshot of the GPE info for this level - we copy the info to
489 * prevent a race condition with remove_handler/remove_block.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 */
Lin Ming5a284cd2010-12-13 13:39:07 +0800491 ACPI_MEMCPY(local_gpe_event_info, gpe_event_info,
Len Brown4be44fc2005-08-05 00:44:28 -0400492 sizeof(struct acpi_gpe_event_info));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493
Len Brown4be44fc2005-08-05 00:44:28 -0400494 status = acpi_ut_release_mutex(ACPI_MTX_EVENTS);
495 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496 return_VOID;
497 }
498
Lin Mingbba63a22010-12-13 13:39:17 +0800499 /* Do the correct dispatch - normal method or implicit notify */
500
501 switch (local_gpe_event_info->flags & ACPI_GPE_DISPATCH_MASK) {
502 case ACPI_GPE_DISPATCH_NOTIFY:
503
504 /*
505 * Implicit notify.
506 * Dispatch a DEVICE_WAKE notify to the appropriate handler.
507 * NOTE: the request is queued for execution after this method
508 * completes. The notify handlers are NOT invoked synchronously
509 * from this thread -- because handlers may in turn run other
510 * control methods.
511 */
Rafael J. Wysocki981858b2011-02-24 19:59:21 +0100512 status = acpi_ev_queue_notify_request(
513 local_gpe_event_info->dispatch.device.node,
514 ACPI_NOTIFY_DEVICE_WAKE);
515
516 notify_object = local_gpe_event_info->dispatch.device.next;
517 while (ACPI_SUCCESS(status) && notify_object) {
518 status = acpi_ev_queue_notify_request(
519 notify_object->node,
520 ACPI_NOTIFY_DEVICE_WAKE);
521 notify_object = notify_object->next;
522 }
523
Lin Mingbba63a22010-12-13 13:39:17 +0800524 break;
525
526 case ACPI_GPE_DISPATCH_METHOD:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527
Bob Moore41195322006-05-26 16:36:00 -0400528 /* Allocate the evaluation information block */
529
530 info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
531 if (!info) {
532 status = AE_NO_MEMORY;
533 } else {
534 /*
535 * Invoke the GPE Method (_Lxx, _Exx) i.e., evaluate the _Lxx/_Exx
536 * control method that corresponds to this GPE
537 */
538 info->prefix_node =
Lin Ming5a284cd2010-12-13 13:39:07 +0800539 local_gpe_event_info->dispatch.method_node;
Bob Moore41195322006-05-26 16:36:00 -0400540 info->flags = ACPI_IGNORE_RETURN_VALUE;
541
542 status = acpi_ns_evaluate(info);
543 ACPI_FREE(info);
544 }
545
Len Brown4be44fc2005-08-05 00:44:28 -0400546 if (ACPI_FAILURE(status)) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500547 ACPI_EXCEPTION((AE_INFO, status,
Bob Moore2e420052007-02-02 19:48:18 +0300548 "while evaluating GPE method [%4.4s]",
Bob Mooreb8e4d892006-01-27 16:43:00 -0500549 acpi_ut_get_node_name
Lin Ming5a284cd2010-12-13 13:39:07 +0800550 (local_gpe_event_info->dispatch.
Bob Moore4c90ece2006-06-08 16:29:00 -0400551 method_node)));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 }
Lin Mingbba63a22010-12-13 13:39:17 +0800553
554 break;
555
556 default:
557 return_VOID; /* Should never happen */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 }
Lin Ming5a284cd2010-12-13 13:39:07 +0800559
Alexey Starikovskiy17bc54e2007-11-13 13:05:45 +0300560 /* Defer enabling of GPE until all notify handlers are done */
Lin Ming5a284cd2010-12-13 13:39:07 +0800561
562 status = acpi_os_execute(OSL_NOTIFY_HANDLER,
563 acpi_ev_asynch_enable_gpe,
564 local_gpe_event_info);
565 if (ACPI_FAILURE(status)) {
566 ACPI_FREE(local_gpe_event_info);
567 }
Alexey Starikovskiy17bc54e2007-11-13 13:05:45 +0300568 return_VOID;
569}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570
Lin Mingbba63a22010-12-13 13:39:17 +0800571
Lin Ming5a284cd2010-12-13 13:39:07 +0800572/*******************************************************************************
573 *
574 * FUNCTION: acpi_ev_asynch_enable_gpe
575 *
576 * PARAMETERS: Context (gpe_event_info) - Info for this GPE
577 * Callback from acpi_os_execute
578 *
579 * RETURN: None
580 *
581 * DESCRIPTION: Asynchronous clear/enable for GPE. This allows the GPE to
Lin Mingbba63a22010-12-13 13:39:17 +0800582 * complete (i.e., finish execution of Notify)
Lin Ming5a284cd2010-12-13 13:39:07 +0800583 *
584 ******************************************************************************/
585
586static void ACPI_SYSTEM_XFACE acpi_ev_asynch_enable_gpe(void *context)
Alexey Starikovskiy17bc54e2007-11-13 13:05:45 +0300587{
588 struct acpi_gpe_event_info *gpe_event_info = context;
Lin Mingbba63a22010-12-13 13:39:17 +0800589
590 (void)acpi_ev_finish_gpe(gpe_event_info);
591
592 ACPI_FREE(gpe_event_info);
593 return;
594}
595
596
597/*******************************************************************************
598 *
599 * FUNCTION: acpi_ev_finish_gpe
600 *
601 * PARAMETERS: gpe_event_info - Info for this GPE
602 *
603 * RETURN: Status
604 *
605 * DESCRIPTION: Clear/Enable a GPE. Common code that is used after execution
606 * of a GPE method or a synchronous or asynchronous GPE handler.
607 *
608 ******************************************************************************/
609
610acpi_status acpi_ev_finish_gpe(struct acpi_gpe_event_info *gpe_event_info)
611{
Alexey Starikovskiy17bc54e2007-11-13 13:05:45 +0300612 acpi_status status;
Lin Ming5a284cd2010-12-13 13:39:07 +0800613
Alexey Starikovskiy17bc54e2007-11-13 13:05:45 +0300614 if ((gpe_event_info->flags & ACPI_GPE_XRUPT_TYPE_MASK) ==
Len Brown4be44fc2005-08-05 00:44:28 -0400615 ACPI_GPE_LEVEL_TRIGGERED) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 /*
Lin Mingbba63a22010-12-13 13:39:17 +0800617 * GPE is level-triggered, we clear the GPE status bit after
618 * handling the event.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 */
Alexey Starikovskiy17bc54e2007-11-13 13:05:45 +0300620 status = acpi_hw_clear_gpe(gpe_event_info);
Len Brown4be44fc2005-08-05 00:44:28 -0400621 if (ACPI_FAILURE(status)) {
Lin Mingbba63a22010-12-13 13:39:17 +0800622 return (status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623 }
624 }
625
Bob Moorede5668f2010-07-06 10:30:37 +0800626 /*
Lin Mingbba63a22010-12-13 13:39:17 +0800627 * Enable this GPE, conditionally. This means that the GPE will
628 * only be physically enabled if the enable_for_run bit is set
629 * in the event_info.
Bob Moorede5668f2010-07-06 10:30:37 +0800630 */
Lin Ming3a378982010-12-13 13:36:15 +0800631 (void)acpi_hw_low_set_gpe(gpe_event_info, ACPI_GPE_CONDITIONAL_ENABLE);
Lin Mingbba63a22010-12-13 13:39:17 +0800632 return (AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633}
634
Lin Mingbba63a22010-12-13 13:39:17 +0800635
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636/*******************************************************************************
637 *
638 * FUNCTION: acpi_ev_gpe_dispatch
639 *
Lin Ming8b6cd8a2010-12-13 13:38:46 +0800640 * PARAMETERS: gpe_device - Device node. NULL for GPE0/GPE1
641 * gpe_event_info - Info for this GPE
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 * gpe_number - Number relative to the parent GPE block
643 *
644 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
645 *
646 * DESCRIPTION: Dispatch a General Purpose Event to either a function (e.g. EC)
647 * or method (e.g. _Lxx/_Exx) handler.
648 *
649 * This function executes at interrupt level.
650 *
651 ******************************************************************************/
652
653u32
Lin Ming8b6cd8a2010-12-13 13:38:46 +0800654acpi_ev_gpe_dispatch(struct acpi_namespace_node *gpe_device,
655 struct acpi_gpe_event_info *gpe_event_info, u32 gpe_number)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656{
Len Brown4be44fc2005-08-05 00:44:28 -0400657 acpi_status status;
Lin Mingbba63a22010-12-13 13:39:17 +0800658 u32 return_value;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659
Bob Mooreb229cf92006-04-21 17:15:00 -0400660 ACPI_FUNCTION_TRACE(ev_gpe_dispatch);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661
Lin Minga0fcdb22010-12-13 13:39:26 +0800662 /* Invoke global event handler if present */
663
664 acpi_gpe_count++;
665 if (acpi_gbl_global_event_handler) {
666 acpi_gbl_global_event_handler(ACPI_EVENT_TYPE_GPE, gpe_device,
667 gpe_number,
668 acpi_gbl_global_event_handler_context);
669 }
Bob Moorefdffb722007-02-02 19:48:19 +0300670
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671 /*
Bob Moore9f15fc62008-11-12 16:01:56 +0800672 * If edge-triggered, clear the GPE status bit now. Note that
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673 * level-triggered events are cleared after the GPE is serviced.
674 */
Robert Moore44f6c012005-04-18 22:49:35 -0400675 if ((gpe_event_info->flags & ACPI_GPE_XRUPT_TYPE_MASK) ==
Len Brown4be44fc2005-08-05 00:44:28 -0400676 ACPI_GPE_EDGE_TRIGGERED) {
677 status = acpi_hw_clear_gpe(gpe_event_info);
678 if (ACPI_FAILURE(status)) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500679 ACPI_EXCEPTION((AE_INFO, status,
Lin Mingda503372010-12-13 13:39:37 +0800680 "Unable to clear GPE%02X", gpe_number));
Bob Moore50eca3e2005-09-30 19:03:00 -0400681 return_UINT32(ACPI_INTERRUPT_NOT_HANDLED);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 }
683 }
684
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685 /*
Lin Mingbba63a22010-12-13 13:39:17 +0800686 * Always disable the GPE so that it does not keep firing before
687 * any asynchronous activity completes (either from the execution
688 * of a GPE method or an asynchronous GPE handler.)
689 *
690 * If there is no handler or method to run, just disable the
691 * GPE and leave it disabled permanently to prevent further such
692 * pointless events from firing.
693 */
694 status = acpi_hw_low_set_gpe(gpe_event_info, ACPI_GPE_DISABLE);
695 if (ACPI_FAILURE(status)) {
696 ACPI_EXCEPTION((AE_INFO, status,
697 "Unable to disable GPE%02X", gpe_number));
698 return_UINT32(ACPI_INTERRUPT_NOT_HANDLED);
699 }
700
701 /*
702 * Dispatch the GPE to either an installed handler or the control
703 * method associated with this GPE (_Lxx or _Exx). If a handler
704 * exists, we invoke it and do not attempt to run the method.
705 * If there is neither a handler nor a method, leave the GPE
706 * disabled.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707 */
708 switch (gpe_event_info->flags & ACPI_GPE_DISPATCH_MASK) {
709 case ACPI_GPE_DISPATCH_HANDLER:
710
Lin Mingbba63a22010-12-13 13:39:17 +0800711 /* Invoke the installed handler (at interrupt level) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712
Lin Mingbba63a22010-12-13 13:39:17 +0800713 return_value =
714 gpe_event_info->dispatch.handler->address(gpe_device,
715 gpe_number,
716 gpe_event_info->
717 dispatch.handler->
718 context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719
Lin Mingbba63a22010-12-13 13:39:17 +0800720 /* If requested, clear (if level-triggered) and reenable the GPE */
721
722 if (return_value & ACPI_REENABLE_GPE) {
723 (void)acpi_ev_finish_gpe(gpe_event_info);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 }
725 break;
726
727 case ACPI_GPE_DISPATCH_METHOD:
Lin Mingbba63a22010-12-13 13:39:17 +0800728 case ACPI_GPE_DISPATCH_NOTIFY:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729
730 /*
731 * Execute the method associated with the GPE
732 * NOTE: Level-triggered GPEs are cleared after the method completes.
733 */
Bob Moore958dd242006-05-12 17:12:00 -0400734 status = acpi_os_execute(OSL_GPE_HANDLER,
735 acpi_ev_asynch_execute_gpe_method,
736 gpe_event_info);
Len Brown4be44fc2005-08-05 00:44:28 -0400737 if (ACPI_FAILURE(status)) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500738 ACPI_EXCEPTION((AE_INFO, status,
Lin Mingda503372010-12-13 13:39:37 +0800739 "Unable to queue handler for GPE%2X - event disabled",
Bob Mooreb8e4d892006-01-27 16:43:00 -0500740 gpe_number));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 }
742 break;
743
744 default:
745
Lin Ming0f849d22010-04-06 14:52:37 +0800746 /*
747 * No handler or method to run!
748 * 03/2010: This case should no longer be possible. We will not allow
749 * a GPE to be enabled if it has no handler or method.
750 */
Bob Mooreb8e4d892006-01-27 16:43:00 -0500751 ACPI_ERROR((AE_INFO,
Lin Mingda503372010-12-13 13:39:37 +0800752 "No handler or method for GPE%02X, disabling event",
Bob Mooreb8e4d892006-01-27 16:43:00 -0500753 gpe_number));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 break;
756 }
757
Bob Moore50eca3e2005-09-30 19:03:00 -0400758 return_UINT32(ACPI_INTERRUPT_HANDLED);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759}