1 /******************************************************************************
3 * Module Name: evmisc - Miscellaneous event manager support functions
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2005, 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>
46 #include <acpi/acnamesp.h>
47 #include <acpi/acinterp.h>
49 #define _COMPONENT ACPI_EVENTS
50 ACPI_MODULE_NAME ("evmisc")
53 #ifdef ACPI_DEBUG_OUTPUT
54 static const char *acpi_notify_value_names[] =
67 /* Local prototypes */
69 static void ACPI_SYSTEM_XFACE
70 acpi_ev_notify_dispatch (
73 static void ACPI_SYSTEM_XFACE
74 acpi_ev_global_lock_thread (
78 acpi_ev_global_lock_handler (
82 /*******************************************************************************
84 * FUNCTION: acpi_ev_is_notify_object
86 * PARAMETERS: Node - Node to check
88 * RETURN: TRUE if notifies allowed on this object
90 * DESCRIPTION: Check type of node for a object that supports notifies.
92 * TBD: This could be replaced by a flag bit in the node.
94 ******************************************************************************/
97 acpi_ev_is_notify_object (
98 struct acpi_namespace_node *node)
100 switch (node->type) {
101 case ACPI_TYPE_DEVICE:
102 case ACPI_TYPE_PROCESSOR:
103 case ACPI_TYPE_POWER:
104 case ACPI_TYPE_THERMAL:
106 * These are the ONLY objects that can receive ACPI notifications
116 /*******************************************************************************
118 * FUNCTION: acpi_ev_queue_notify_request
120 * PARAMETERS: Node - NS node for the notified object
121 * notify_value - Value from the Notify() request
125 * DESCRIPTION: Dispatch a device notification event to a previously
128 ******************************************************************************/
131 acpi_ev_queue_notify_request (
132 struct acpi_namespace_node *node,
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;
141 ACPI_FUNCTION_NAME ("ev_queue_notify_request");
145 * For value 3 (Ejection Request), some device method may need to be run.
146 * For value 2 (Device Wake) if _PRW exists, the _PS0 method may need
148 * For value 0x80 (Status Change) on the power button or sleep button,
149 * initiate soft-off or sleep operation?
151 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
152 "Dispatching Notify(%X) on node %p\n", notify_value, node));
154 if (notify_value <= 7) {
155 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Notify value: %s\n",
156 acpi_notify_value_names[notify_value]));
159 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
160 "Notify value: 0x%2.2X **Device Specific**\n",
164 /* Get the notify object attached to the NS Node */
166 obj_desc = acpi_ns_get_attached_object (node);
168 /* We have the notify object, Get the right handler */
170 switch (node->type) {
171 case ACPI_TYPE_DEVICE:
172 case ACPI_TYPE_THERMAL:
173 case ACPI_TYPE_PROCESSOR:
174 case ACPI_TYPE_POWER:
176 if (notify_value <= ACPI_MAX_SYS_NOTIFY) {
177 handler_obj = obj_desc->common_notify.system_notify;
180 handler_obj = obj_desc->common_notify.device_notify;
185 /* All other types are not supported */
190 /* If there is any handler to run, schedule the dispatcher */
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)) ||
195 notify_info = acpi_ut_create_generic_state ();
197 return (AE_NO_MEMORY);
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;
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);
214 * There is no per-device notify handler for this device.
215 * This may or may not be a problem.
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));
226 /*******************************************************************************
228 * FUNCTION: acpi_ev_notify_dispatch
230 * PARAMETERS: Context - To be passed to the notify handler
234 * DESCRIPTION: Dispatch a device notification event to a previously
237 ******************************************************************************/
239 static void ACPI_SYSTEM_XFACE
240 acpi_ev_notify_dispatch (
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;
249 ACPI_FUNCTION_ENTRY ();
253 * We will invoke a global notify handler if installed.
254 * This is done _before_ we invoke the per-device handler attached
257 if (notify_info->notify.value <= ACPI_MAX_SYS_NOTIFY) {
258 /* Global system notification handler */
260 if (acpi_gbl_system_notify.handler) {
261 global_handler = acpi_gbl_system_notify.handler;
262 global_context = acpi_gbl_system_notify.context;
266 /* Global driver notification handler */
268 if (acpi_gbl_device_notify.handler) {
269 global_handler = acpi_gbl_device_notify.handler;
270 global_context = acpi_gbl_device_notify.context;
274 /* Invoke the system handler first, if present */
276 if (global_handler) {
277 global_handler (notify_info->notify.node, notify_info->notify.value,
281 /* Now invoke the per-device handler, if present */
283 handler_obj = notify_info->notify.handler_obj;
285 handler_obj->notify.handler (notify_info->notify.node,
286 notify_info->notify.value,
287 handler_obj->notify.context);
290 /* All done with the info object */
292 acpi_ut_delete_generic_state (notify_info);
296 /*******************************************************************************
298 * FUNCTION: acpi_ev_global_lock_thread
300 * PARAMETERS: Context - From thread interface, not used
304 * DESCRIPTION: Invoked by SCI interrupt handler upon acquisition of the
305 * Global Lock. Simply signal all threads that are waiting
308 ******************************************************************************/
310 static void ACPI_SYSTEM_XFACE
311 acpi_ev_global_lock_thread (
317 /* Signal threads that are waiting for the lock */
319 if (acpi_gbl_global_lock_thread_count) {
320 /* Send sufficient units to the semaphore */
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"));
331 /*******************************************************************************
333 * FUNCTION: acpi_ev_global_lock_handler
335 * PARAMETERS: Context - From thread interface, not used
337 * RETURN: ACPI_INTERRUPT_HANDLED or ACPI_INTERRUPT_NOT_HANDLED
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
343 ******************************************************************************/
346 acpi_ev_global_lock_handler (
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.
358 ACPI_ACQUIRE_GLOBAL_LOCK (acpi_gbl_common_fACS.global_lock, acquired);
360 /* Got the lock, now wake all threads waiting for it */
362 acpi_gbl_global_lock_acquired = TRUE;
364 /* Run the Global Lock thread which will signal all waiting threads */
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)));
372 return (ACPI_INTERRUPT_NOT_HANDLED);
376 return (ACPI_INTERRUPT_HANDLED);
380 /*******************************************************************************
382 * FUNCTION: acpi_ev_init_global_lock_handler
388 * DESCRIPTION: Install a handler for the global lock release event
390 ******************************************************************************/
393 acpi_ev_init_global_lock_handler (
399 ACPI_FUNCTION_TRACE ("ev_init_global_lock_handler");
402 acpi_gbl_global_lock_present = TRUE;
403 status = acpi_install_fixed_event_handler (ACPI_EVENT_GLOBAL,
404 acpi_ev_global_lock_handler, NULL);
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
413 if (status == AE_NO_HARDWARE_RESPONSE) {
414 acpi_gbl_global_lock_present = FALSE;
418 return_ACPI_STATUS (status);
422 /******************************************************************************
424 * FUNCTION: acpi_ev_acquire_global_lock
426 * PARAMETERS: Timeout - Max time to wait for the lock, in millisec.
430 * DESCRIPTION: Attempt to gain ownership of the Global Lock.
432 *****************************************************************************/
435 acpi_ev_acquire_global_lock (
438 acpi_status status = AE_OK;
442 ACPI_FUNCTION_TRACE ("ev_acquire_global_lock");
445 #ifndef ACPI_APPLICATION
446 /* Make sure that we actually have a global lock */
448 if (!acpi_gbl_global_lock_present) {
449 return_ACPI_STATUS (AE_NO_GLOBAL_LOCK);
453 /* One more thread wants the global lock */
455 acpi_gbl_global_lock_thread_count++;
458 * If we (OS side vs. BIOS side) have the hardware lock already,
461 if (acpi_gbl_global_lock_acquired) {
462 return_ACPI_STATUS (AE_OK);
465 /* We must acquire the actual hardware lock */
467 ACPI_ACQUIRE_GLOBAL_LOCK (acpi_gbl_common_fACS.global_lock, acquired);
469 /* We got the lock */
471 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Acquired the HW Global Lock\n"));
473 acpi_gbl_global_lock_acquired = TRUE;
474 return_ACPI_STATUS (AE_OK);
478 * Did not get the lock. The pending bit was set above, and we must now
479 * wait until we get the global lock released interrupt.
481 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Waiting for the HW Global Lock\n"));
484 * Acquire the global lock semaphore first.
485 * Since this wait will block, we must release the interpreter
487 status = acpi_ex_system_wait_semaphore (acpi_gbl_global_lock_semaphore,
489 return_ACPI_STATUS (status);
493 /*******************************************************************************
495 * FUNCTION: acpi_ev_release_global_lock
501 * DESCRIPTION: Releases ownership of the Global Lock.
503 ******************************************************************************/
506 acpi_ev_release_global_lock (
510 acpi_status status = AE_OK;
513 ACPI_FUNCTION_TRACE ("ev_release_global_lock");
516 if (!acpi_gbl_global_lock_thread_count) {
517 ACPI_REPORT_WARNING((
518 "Cannot release HW Global Lock, it has not been acquired\n"));
519 return_ACPI_STATUS (AE_NOT_ACQUIRED);
522 /* One fewer thread has the global lock */
524 acpi_gbl_global_lock_thread_count--;
525 if (acpi_gbl_global_lock_thread_count) {
526 /* There are still some threads holding the lock, cannot release */
528 return_ACPI_STATUS (AE_OK);
532 * No more threads holding lock, we can do the actual hardware
535 ACPI_RELEASE_GLOBAL_LOCK (acpi_gbl_common_fACS.global_lock, pending);
536 acpi_gbl_global_lock_acquired = FALSE;
539 * If the pending bit was set, we must write GBL_RLS to the control
543 status = acpi_set_register (ACPI_BITREG_GLOBAL_LOCK_RELEASE,
547 return_ACPI_STATUS (status);
551 /******************************************************************************
553 * FUNCTION: acpi_ev_terminate
559 * DESCRIPTION: Disable events and free memory allocated for table storage.
561 ******************************************************************************/
571 ACPI_FUNCTION_TRACE ("ev_terminate");
574 if (acpi_gbl_events_initialized) {
576 * Disable all event-related functionality.
577 * In all cases, on error, print a message but obviously we don't abort.
580 /* Disable all fixed events */
582 for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++) {
583 status = acpi_disable_event ((u32) i, 0);
584 if (ACPI_FAILURE (status)) {
585 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
586 "Could not disable fixed event %d\n", (u32) i));
590 /* Disable all GPEs in all GPE blocks */
592 status = acpi_ev_walk_gpe_list (acpi_hw_disable_gpe_block);
594 /* Remove SCI handler */
596 status = acpi_ev_remove_sci_handler ();
597 if (ACPI_FAILURE(status)) {
598 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
599 "Could not remove SCI handler\n"));
603 /* Deallocate all handler objects installed within GPE info structs */
605 status = acpi_ev_walk_gpe_list (acpi_ev_delete_gpe_handlers);
607 /* Return to original mode if necessary */
609 if (acpi_gbl_original_mode == ACPI_SYS_MODE_LEGACY) {
610 status = acpi_disable ();
611 if (ACPI_FAILURE (status)) {
612 ACPI_DEBUG_PRINT ((ACPI_DB_WARN, "acpi_disable failed\n"));