[ACPI] ACPICA 20050729 from Bob Moore
[deliverable/linux.git] / drivers / acpi / events / evmisc.c
CommitLineData
1da177e4
LT
1/******************************************************************************
2 *
3 * Module Name: evmisc - Miscellaneous event manager support functions
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#include <acpi/acnamesp.h>
47#include <acpi/acinterp.h>
48
49#define _COMPONENT ACPI_EVENTS
50 ACPI_MODULE_NAME ("evmisc")
51
52
44f6c012
RM
53#ifdef ACPI_DEBUG_OUTPUT
54static const char *acpi_notify_value_names[] =
55{
56 "Bus Check",
57 "Device Check",
58 "Device Wake",
59 "Eject request",
60 "Device Check Light",
61 "Frequency Mismatch",
62 "Bus Mode Mismatch",
63 "Power Fault"
64};
65#endif
66
67/* Local prototypes */
68
69static void ACPI_SYSTEM_XFACE
70acpi_ev_notify_dispatch (
71 void *context);
72
73static void ACPI_SYSTEM_XFACE
74acpi_ev_global_lock_thread (
75 void *context);
76
77static u32
78acpi_ev_global_lock_handler (
79 void *context);
80
81
1da177e4
LT
82/*******************************************************************************
83 *
84 * FUNCTION: acpi_ev_is_notify_object
85 *
86 * PARAMETERS: Node - Node to check
87 *
88 * RETURN: TRUE if notifies allowed on this object
89 *
90 * DESCRIPTION: Check type of node for a object that supports notifies.
91 *
92 * TBD: This could be replaced by a flag bit in the node.
93 *
94 ******************************************************************************/
95
96u8
97acpi_ev_is_notify_object (
98 struct acpi_namespace_node *node)
99{
100 switch (node->type) {
101 case ACPI_TYPE_DEVICE:
102 case ACPI_TYPE_PROCESSOR:
103 case ACPI_TYPE_POWER:
104 case ACPI_TYPE_THERMAL:
105 /*
106 * These are the ONLY objects that can receive ACPI notifications
107 */
108 return (TRUE);
109
110 default:
111 return (FALSE);
112 }
113}
114
115
116/*******************************************************************************
117 *
118 * FUNCTION: acpi_ev_queue_notify_request
119 *
120 * PARAMETERS: Node - NS node for the notified object
121 * notify_value - Value from the Notify() request
122 *
123 * RETURN: Status
124 *
125 * DESCRIPTION: Dispatch a device notification event to a previously
126 * installed handler.
127 *
128 ******************************************************************************/
129
1da177e4
LT
130acpi_status
131acpi_ev_queue_notify_request (
132 struct acpi_namespace_node *node,
133 u32 notify_value)
134{
135 union acpi_operand_object *obj_desc;
136 union acpi_operand_object *handler_obj = NULL;
137 union acpi_generic_state *notify_info;
138 acpi_status status = AE_OK;
139
140
141 ACPI_FUNCTION_NAME ("ev_queue_notify_request");
142
143
144 /*
145 * For value 3 (Ejection Request), some device method may need to be run.
44f6c012
RM
146 * For value 2 (Device Wake) if _PRW exists, the _PS0 method may need
147 * to be run.
1da177e4 148 * For value 0x80 (Status Change) on the power button or sleep button,
44f6c012 149 * initiate soft-off or sleep operation?
1da177e4
LT
150 */
151 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
152 "Dispatching Notify(%X) on node %p\n", notify_value, node));
153
154 if (notify_value <= 7) {
155 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Notify value: %s\n",
156 acpi_notify_value_names[notify_value]));
157 }
158 else {
44f6c012
RM
159 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
160 "Notify value: 0x%2.2X **Device Specific**\n",
161 notify_value));
1da177e4
LT
162 }
163
164 /* Get the notify object attached to the NS Node */
165
166 obj_desc = acpi_ns_get_attached_object (node);
167 if (obj_desc) {
168 /* We have the notify object, Get the right handler */
169
170 switch (node->type) {
171 case ACPI_TYPE_DEVICE:
172 case ACPI_TYPE_THERMAL:
173 case ACPI_TYPE_PROCESSOR:
174 case ACPI_TYPE_POWER:
175
176 if (notify_value <= ACPI_MAX_SYS_NOTIFY) {
177 handler_obj = obj_desc->common_notify.system_notify;
178 }
179 else {
180 handler_obj = obj_desc->common_notify.device_notify;
181 }
182 break;
183
184 default:
185 /* All other types are not supported */
186 return (AE_TYPE);
187 }
188 }
189
190 /* If there is any handler to run, schedule the dispatcher */
191
192 if ((acpi_gbl_system_notify.handler && (notify_value <= ACPI_MAX_SYS_NOTIFY)) ||
193 (acpi_gbl_device_notify.handler && (notify_value > ACPI_MAX_SYS_NOTIFY)) ||
194 handler_obj) {
195 notify_info = acpi_ut_create_generic_state ();
196 if (!notify_info) {
197 return (AE_NO_MEMORY);
198 }
199
200 notify_info->common.data_type = ACPI_DESC_TYPE_STATE_NOTIFY;
201 notify_info->notify.node = node;
202 notify_info->notify.value = (u16) notify_value;
203 notify_info->notify.handler_obj = handler_obj;
204
205 status = acpi_os_queue_for_execution (OSD_PRIORITY_HIGH,
206 acpi_ev_notify_dispatch, notify_info);
207 if (ACPI_FAILURE (status)) {
208 acpi_ut_delete_generic_state (notify_info);
209 }
210 }
211
212 if (!handler_obj) {
213 /*
214 * There is no per-device notify handler for this device.
215 * This may or may not be a problem.
216 */
217 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
218 "No notify handler for Notify(%4.4s, %X) node %p\n",
219 acpi_ut_get_node_name (node), notify_value, node));
220 }
221
222 return (status);
223}
224
225
226/*******************************************************************************
227 *
228 * FUNCTION: acpi_ev_notify_dispatch
229 *
44f6c012 230 * PARAMETERS: Context - To be passed to the notify handler
1da177e4
LT
231 *
232 * RETURN: None.
233 *
234 * DESCRIPTION: Dispatch a device notification event to a previously
235 * installed handler.
236 *
237 ******************************************************************************/
238
44f6c012 239static void ACPI_SYSTEM_XFACE
1da177e4
LT
240acpi_ev_notify_dispatch (
241 void *context)
242{
243 union acpi_generic_state *notify_info = (union acpi_generic_state *) context;
244 acpi_notify_handler global_handler = NULL;
245 void *global_context = NULL;
246 union acpi_operand_object *handler_obj;
247
248
249 ACPI_FUNCTION_ENTRY ();
250
251
252 /*
253 * We will invoke a global notify handler if installed.
44f6c012
RM
254 * This is done _before_ we invoke the per-device handler attached
255 * to the device.
1da177e4
LT
256 */
257 if (notify_info->notify.value <= ACPI_MAX_SYS_NOTIFY) {
258 /* Global system notification handler */
259
260 if (acpi_gbl_system_notify.handler) {
261 global_handler = acpi_gbl_system_notify.handler;
262 global_context = acpi_gbl_system_notify.context;
263 }
264 }
265 else {
266 /* Global driver notification handler */
267
268 if (acpi_gbl_device_notify.handler) {
269 global_handler = acpi_gbl_device_notify.handler;
270 global_context = acpi_gbl_device_notify.context;
271 }
272 }
273
274 /* Invoke the system handler first, if present */
275
276 if (global_handler) {
44f6c012
RM
277 global_handler (notify_info->notify.node, notify_info->notify.value,
278 global_context);
1da177e4
LT
279 }
280
281 /* Now invoke the per-device handler, if present */
282
283 handler_obj = notify_info->notify.handler_obj;
284 if (handler_obj) {
44f6c012
RM
285 handler_obj->notify.handler (notify_info->notify.node,
286 notify_info->notify.value,
287 handler_obj->notify.context);
1da177e4
LT
288 }
289
290 /* All done with the info object */
291
292 acpi_ut_delete_generic_state (notify_info);
293}
294
295
296/*******************************************************************************
297 *
298 * FUNCTION: acpi_ev_global_lock_thread
299 *
300 * PARAMETERS: Context - From thread interface, not used
301 *
302 * RETURN: None
303 *
304 * DESCRIPTION: Invoked by SCI interrupt handler upon acquisition of the
305 * Global Lock. Simply signal all threads that are waiting
306 * for the lock.
307 *
308 ******************************************************************************/
309
310static void ACPI_SYSTEM_XFACE
311acpi_ev_global_lock_thread (
312 void *context)
313{
314 acpi_status status;
315
316
317 /* Signal threads that are waiting for the lock */
318
319 if (acpi_gbl_global_lock_thread_count) {
320 /* Send sufficient units to the semaphore */
321
322 status = acpi_os_signal_semaphore (acpi_gbl_global_lock_semaphore,
323 acpi_gbl_global_lock_thread_count);
324 if (ACPI_FAILURE (status)) {
325 ACPI_REPORT_ERROR (("Could not signal Global Lock semaphore\n"));
326 }
327 }
328}
329
330
331/*******************************************************************************
332 *
333 * FUNCTION: acpi_ev_global_lock_handler
334 *
335 * PARAMETERS: Context - From thread interface, not used
336 *
337 * RETURN: ACPI_INTERRUPT_HANDLED or ACPI_INTERRUPT_NOT_HANDLED
338 *
339 * DESCRIPTION: Invoked directly from the SCI handler when a global lock
340 * release interrupt occurs. Grab the global lock and queue
341 * the global lock thread for execution
342 *
343 ******************************************************************************/
344
345static u32
346acpi_ev_global_lock_handler (
347 void *context)
348{
349 u8 acquired = FALSE;
350 acpi_status status;
351
352
353 /*
354 * Attempt to get the lock
355 * If we don't get it now, it will be marked pending and we will
356 * take another interrupt when it becomes free.
357 */
358 ACPI_ACQUIRE_GLOBAL_LOCK (acpi_gbl_common_fACS.global_lock, acquired);
359 if (acquired) {
360 /* Got the lock, now wake all threads waiting for it */
361
362 acpi_gbl_global_lock_acquired = TRUE;
363
364 /* Run the Global Lock thread which will signal all waiting threads */
365
366 status = acpi_os_queue_for_execution (OSD_PRIORITY_HIGH,
367 acpi_ev_global_lock_thread, context);
368 if (ACPI_FAILURE (status)) {
369 ACPI_REPORT_ERROR (("Could not queue Global Lock thread, %s\n",
370 acpi_format_exception (status)));
371
372 return (ACPI_INTERRUPT_NOT_HANDLED);
373 }
374 }
375
376 return (ACPI_INTERRUPT_HANDLED);
377}
378
379
380/*******************************************************************************
381 *
382 * FUNCTION: acpi_ev_init_global_lock_handler
383 *
384 * PARAMETERS: None
385 *
386 * RETURN: Status
387 *
388 * DESCRIPTION: Install a handler for the global lock release event
389 *
390 ******************************************************************************/
391
392acpi_status
44f6c012
RM
393acpi_ev_init_global_lock_handler (
394 void)
1da177e4
LT
395{
396 acpi_status status;
397
398
399 ACPI_FUNCTION_TRACE ("ev_init_global_lock_handler");
400
401
402 acpi_gbl_global_lock_present = TRUE;
403 status = acpi_install_fixed_event_handler (ACPI_EVENT_GLOBAL,
44f6c012 404 acpi_ev_global_lock_handler, NULL);
1da177e4
LT
405
406 /*
407 * If the global lock does not exist on this platform, the attempt
408 * to enable GBL_STATUS will fail (the GBL_ENABLE bit will not stick)
409 * Map to AE_OK, but mark global lock as not present.
410 * Any attempt to actually use the global lock will be flagged
411 * with an error.
412 */
413 if (status == AE_NO_HARDWARE_RESPONSE) {
0c9938cc
RM
414 ACPI_REPORT_ERROR ((
415 "No response from Global Lock hardware, disabling lock\n"));
416
1da177e4
LT
417 acpi_gbl_global_lock_present = FALSE;
418 status = AE_OK;
419 }
420
421 return_ACPI_STATUS (status);
422}
423
424
425/******************************************************************************
426 *
427 * FUNCTION: acpi_ev_acquire_global_lock
428 *
429 * PARAMETERS: Timeout - Max time to wait for the lock, in millisec.
430 *
431 * RETURN: Status
432 *
433 * DESCRIPTION: Attempt to gain ownership of the Global Lock.
434 *
435 *****************************************************************************/
436
437acpi_status
438acpi_ev_acquire_global_lock (
439 u16 timeout)
440{
441 acpi_status status = AE_OK;
442 u8 acquired = FALSE;
443
444
445 ACPI_FUNCTION_TRACE ("ev_acquire_global_lock");
446
447
448#ifndef ACPI_APPLICATION
449 /* Make sure that we actually have a global lock */
450
451 if (!acpi_gbl_global_lock_present) {
452 return_ACPI_STATUS (AE_NO_GLOBAL_LOCK);
453 }
454#endif
455
456 /* One more thread wants the global lock */
457
458 acpi_gbl_global_lock_thread_count++;
459
44f6c012
RM
460 /*
461 * If we (OS side vs. BIOS side) have the hardware lock already,
462 * we are done
463 */
1da177e4
LT
464 if (acpi_gbl_global_lock_acquired) {
465 return_ACPI_STATUS (AE_OK);
466 }
467
468 /* We must acquire the actual hardware lock */
469
470 ACPI_ACQUIRE_GLOBAL_LOCK (acpi_gbl_common_fACS.global_lock, acquired);
471 if (acquired) {
472 /* We got the lock */
473
474 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Acquired the HW Global Lock\n"));
475
476 acpi_gbl_global_lock_acquired = TRUE;
477 return_ACPI_STATUS (AE_OK);
478 }
479
480 /*
481 * Did not get the lock. The pending bit was set above, and we must now
482 * wait until we get the global lock released interrupt.
483 */
484 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Waiting for the HW Global Lock\n"));
485
486 /*
487 * Acquire the global lock semaphore first.
488 * Since this wait will block, we must release the interpreter
489 */
490 status = acpi_ex_system_wait_semaphore (acpi_gbl_global_lock_semaphore,
491 timeout);
492 return_ACPI_STATUS (status);
493}
494
495
496/*******************************************************************************
497 *
498 * FUNCTION: acpi_ev_release_global_lock
499 *
500 * PARAMETERS: None
501 *
502 * RETURN: Status
503 *
504 * DESCRIPTION: Releases ownership of the Global Lock.
505 *
506 ******************************************************************************/
507
508acpi_status
44f6c012
RM
509acpi_ev_release_global_lock (
510 void)
1da177e4
LT
511{
512 u8 pending = FALSE;
513 acpi_status status = AE_OK;
514
515
516 ACPI_FUNCTION_TRACE ("ev_release_global_lock");
517
518
519 if (!acpi_gbl_global_lock_thread_count) {
44f6c012
RM
520 ACPI_REPORT_WARNING((
521 "Cannot release HW Global Lock, it has not been acquired\n"));
1da177e4
LT
522 return_ACPI_STATUS (AE_NOT_ACQUIRED);
523 }
524
525 /* One fewer thread has the global lock */
526
527 acpi_gbl_global_lock_thread_count--;
528 if (acpi_gbl_global_lock_thread_count) {
529 /* There are still some threads holding the lock, cannot release */
530
531 return_ACPI_STATUS (AE_OK);
532 }
533
534 /*
535 * No more threads holding lock, we can do the actual hardware
536 * release
537 */
538 ACPI_RELEASE_GLOBAL_LOCK (acpi_gbl_common_fACS.global_lock, pending);
539 acpi_gbl_global_lock_acquired = FALSE;
540
541 /*
542 * If the pending bit was set, we must write GBL_RLS to the control
543 * register
544 */
545 if (pending) {
44f6c012
RM
546 status = acpi_set_register (ACPI_BITREG_GLOBAL_LOCK_RELEASE,
547 1, ACPI_MTX_LOCK);
1da177e4
LT
548 }
549
550 return_ACPI_STATUS (status);
551}
552
553
554/******************************************************************************
555 *
556 * FUNCTION: acpi_ev_terminate
557 *
558 * PARAMETERS: none
559 *
560 * RETURN: none
561 *
562 * DESCRIPTION: Disable events and free memory allocated for table storage.
563 *
564 ******************************************************************************/
565
566void
44f6c012
RM
567acpi_ev_terminate (
568 void)
1da177e4
LT
569{
570 acpi_native_uint i;
571 acpi_status status;
572
573
574 ACPI_FUNCTION_TRACE ("ev_terminate");
575
576
577 if (acpi_gbl_events_initialized) {
578 /*
579 * Disable all event-related functionality.
580 * In all cases, on error, print a message but obviously we don't abort.
581 */
582
583 /* Disable all fixed events */
584
585 for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++) {
586 status = acpi_disable_event ((u32) i, 0);
587 if (ACPI_FAILURE (status)) {
44f6c012
RM
588 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
589 "Could not disable fixed event %d\n", (u32) i));
1da177e4
LT
590 }
591 }
592
593 /* Disable all GPEs in all GPE blocks */
594
73459f73 595 status = acpi_ev_walk_gpe_list (acpi_hw_disable_gpe_block);
1da177e4
LT
596
597 /* Remove SCI handler */
598
599 status = acpi_ev_remove_sci_handler ();
600 if (ACPI_FAILURE(status)) {
44f6c012
RM
601 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
602 "Could not remove SCI handler\n"));
1da177e4
LT
603 }
604 }
605
606 /* Deallocate all handler objects installed within GPE info structs */
607
73459f73 608 status = acpi_ev_walk_gpe_list (acpi_ev_delete_gpe_handlers);
1da177e4
LT
609
610 /* Return to original mode if necessary */
611
612 if (acpi_gbl_original_mode == ACPI_SYS_MODE_LEGACY) {
613 status = acpi_disable ();
614 if (ACPI_FAILURE (status)) {
615 ACPI_DEBUG_PRINT ((ACPI_DB_WARN, "acpi_disable failed\n"));
616 }
617 }
618 return_VOID;
619}
620
This page took 0.063449 seconds and 5 git commands to generate.