1 /******************************************************************************
3 * Module Name: evmisc - Miscellaneous event manager support functions
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2007, 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")
52 /* Names for Notify() values, used for debug output */
53 #ifdef ACPI_DEBUG_OUTPUT
54 static const char *acpi_notify_value_names[] = {
66 /* Pointer to FACS needed for the Global Lock */
68 static struct acpi_table_facs *facs = NULL;
70 /* Local prototypes */
72 static void ACPI_SYSTEM_XFACE acpi_ev_notify_dispatch(void *context);
74 static u32 acpi_ev_global_lock_handler(void *context);
76 static acpi_status acpi_ev_remove_global_lock_handler(void);
78 /*******************************************************************************
80 * FUNCTION: acpi_ev_is_notify_object
82 * PARAMETERS: Node - Node to check
84 * RETURN: TRUE if notifies allowed on this object
86 * DESCRIPTION: Check type of node for a object that supports notifies.
88 * TBD: This could be replaced by a flag bit in the node.
90 ******************************************************************************/
92 u8 acpi_ev_is_notify_object(struct acpi_namespace_node *node)
95 case ACPI_TYPE_DEVICE:
96 case ACPI_TYPE_PROCESSOR:
98 case ACPI_TYPE_THERMAL:
100 * These are the ONLY objects that can receive ACPI notifications
109 /*******************************************************************************
111 * FUNCTION: acpi_ev_queue_notify_request
113 * PARAMETERS: Node - NS node for the notified object
114 * notify_value - Value from the Notify() request
118 * DESCRIPTION: Dispatch a device notification event to a previously
121 ******************************************************************************/
124 acpi_ev_queue_notify_request(struct acpi_namespace_node * node,
127 union acpi_operand_object *obj_desc;
128 union acpi_operand_object *handler_obj = NULL;
129 union acpi_generic_state *notify_info;
130 acpi_status status = AE_OK;
132 ACPI_FUNCTION_NAME(ev_queue_notify_request);
135 * For value 3 (Ejection Request), some device method may need to be run.
136 * For value 2 (Device Wake) if _PRW exists, the _PS0 method may need
138 * For value 0x80 (Status Change) on the power button or sleep button,
139 * initiate soft-off or sleep operation?
141 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
142 "Dispatching Notify(%X) on node %p\n", notify_value,
145 if (notify_value <= 7) {
146 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Notify value: %s\n",
147 acpi_notify_value_names[notify_value]));
149 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
150 "Notify value: 0x%2.2X **Device Specific**\n",
154 /* Get the notify object attached to the NS Node */
156 obj_desc = acpi_ns_get_attached_object(node);
159 /* We have the notify object, Get the right handler */
161 switch (node->type) {
162 case ACPI_TYPE_DEVICE:
163 case ACPI_TYPE_THERMAL:
164 case ACPI_TYPE_PROCESSOR:
165 case ACPI_TYPE_POWER:
167 if (notify_value <= ACPI_MAX_SYS_NOTIFY) {
169 obj_desc->common_notify.system_notify;
172 obj_desc->common_notify.device_notify;
177 /* All other types are not supported */
182 /* If there is any handler to run, schedule the dispatcher */
184 if ((acpi_gbl_system_notify.handler
185 && (notify_value <= ACPI_MAX_SYS_NOTIFY))
186 || (acpi_gbl_device_notify.handler
187 && (notify_value > ACPI_MAX_SYS_NOTIFY)) || handler_obj) {
188 notify_info = acpi_ut_create_generic_state();
190 return (AE_NO_MEMORY);
193 notify_info->common.descriptor_type =
194 ACPI_DESC_TYPE_STATE_NOTIFY;
195 notify_info->notify.node = node;
196 notify_info->notify.value = (u16) notify_value;
197 notify_info->notify.handler_obj = handler_obj;
200 acpi_os_execute(OSL_NOTIFY_HANDLER, acpi_ev_notify_dispatch,
202 if (ACPI_FAILURE(status)) {
203 acpi_ut_delete_generic_state(notify_info);
209 * There is no per-device notify handler for this device.
210 * This may or may not be a problem.
212 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
213 "No notify handler for Notify(%4.4s, %X) node %p\n",
214 acpi_ut_get_node_name(node), notify_value,
221 /*******************************************************************************
223 * FUNCTION: acpi_ev_notify_dispatch
225 * PARAMETERS: Context - To be passed to the notify handler
229 * DESCRIPTION: Dispatch a device notification event to a previously
232 ******************************************************************************/
234 static void ACPI_SYSTEM_XFACE acpi_ev_notify_dispatch(void *context)
236 union acpi_generic_state *notify_info =
237 (union acpi_generic_state *)context;
238 acpi_notify_handler global_handler = NULL;
239 void *global_context = NULL;
240 union acpi_operand_object *handler_obj;
242 ACPI_FUNCTION_ENTRY();
245 * We will invoke a global notify handler if installed.
246 * This is done _before_ we invoke the per-device handler attached
249 if (notify_info->notify.value <= ACPI_MAX_SYS_NOTIFY) {
251 /* Global system notification handler */
253 if (acpi_gbl_system_notify.handler) {
254 global_handler = acpi_gbl_system_notify.handler;
255 global_context = acpi_gbl_system_notify.context;
258 /* Global driver notification handler */
260 if (acpi_gbl_device_notify.handler) {
261 global_handler = acpi_gbl_device_notify.handler;
262 global_context = acpi_gbl_device_notify.context;
266 /* Invoke the system handler first, if present */
268 if (global_handler) {
269 global_handler(notify_info->notify.node,
270 notify_info->notify.value, global_context);
273 /* Now invoke the per-device handler, if present */
275 handler_obj = notify_info->notify.handler_obj;
277 handler_obj->notify.handler(notify_info->notify.node,
278 notify_info->notify.value,
279 handler_obj->notify.context);
282 /* All done with the info object */
284 acpi_ut_delete_generic_state(notify_info);
287 /*******************************************************************************
289 * FUNCTION: acpi_ev_global_lock_handler
291 * PARAMETERS: Context - From thread interface, not used
293 * RETURN: ACPI_INTERRUPT_HANDLED
295 * DESCRIPTION: Invoked directly from the SCI handler when a global lock
296 * release interrupt occurs. Attempt to acquire the global lock,
297 * if successful, signal the thread waiting for the lock.
299 * NOTE: Assumes that the semaphore can be signaled from interrupt level. If
300 * this is not possible for some reason, a separate thread will have to be
301 * scheduled to do this.
303 ******************************************************************************/
305 static u32 acpi_ev_global_lock_handler(void *context)
310 * Attempt to get the lock.
312 * If we don't get it now, it will be marked pending and we will
313 * take another interrupt when it becomes free.
315 ACPI_ACQUIRE_GLOBAL_LOCK(facs, acquired);
318 /* Got the lock, now wake all threads waiting for it */
320 acpi_gbl_global_lock_acquired = TRUE;
321 /* Send a unit to the semaphore */
324 (acpi_os_signal_semaphore
325 (acpi_gbl_global_lock_semaphore, 1))) {
327 "Could not signal Global Lock semaphore"));
331 return (ACPI_INTERRUPT_HANDLED);
334 /*******************************************************************************
336 * FUNCTION: acpi_ev_init_global_lock_handler
342 * DESCRIPTION: Install a handler for the global lock release event
344 ******************************************************************************/
346 acpi_status acpi_ev_init_global_lock_handler(void)
350 ACPI_FUNCTION_TRACE(ev_init_global_lock_handler);
352 status = acpi_get_table_by_index(ACPI_TABLE_INDEX_FACS,
353 ACPI_CAST_INDIRECT_PTR(struct
356 if (ACPI_FAILURE(status)) {
357 return_ACPI_STATUS(status);
360 acpi_gbl_global_lock_present = TRUE;
361 status = acpi_install_fixed_event_handler(ACPI_EVENT_GLOBAL,
362 acpi_ev_global_lock_handler,
366 * If the global lock does not exist on this platform, the attempt
367 * to enable GBL_STATUS will fail (the GBL_ENABLE bit will not stick)
368 * Map to AE_OK, but mark global lock as not present.
369 * Any attempt to actually use the global lock will be flagged
372 if (status == AE_NO_HARDWARE_RESPONSE) {
374 "No response from Global Lock hardware, disabling lock"));
376 acpi_gbl_global_lock_present = FALSE;
380 return_ACPI_STATUS(status);
383 /*******************************************************************************
385 * FUNCTION: acpi_ev_remove_global_lock_handler
391 * DESCRIPTION: Remove the handler for the Global Lock
393 ******************************************************************************/
395 static acpi_status acpi_ev_remove_global_lock_handler(void)
399 ACPI_FUNCTION_TRACE(ev_remove_global_lock_handler);
401 acpi_gbl_global_lock_present = FALSE;
402 status = acpi_remove_fixed_event_handler(ACPI_EVENT_GLOBAL,
403 acpi_ev_global_lock_handler);
405 return_ACPI_STATUS(status);
408 /******************************************************************************
410 * FUNCTION: acpi_ev_acquire_global_lock
412 * PARAMETERS: Timeout - Max time to wait for the lock, in millisec.
416 * DESCRIPTION: Attempt to gain ownership of the Global Lock.
418 * MUTEX: Interpreter must be locked
420 * Note: The original implementation allowed multiple threads to "acquire" the
421 * Global Lock, and the OS would hold the lock until the last thread had
422 * released it. However, this could potentially starve the BIOS out of the
423 * lock, especially in the case where there is a tight handshake between the
424 * Embedded Controller driver and the BIOS. Therefore, this implementation
425 * allows only one thread to acquire the HW Global Lock at a time, and makes
426 * the global lock appear as a standard mutex on the OS side.
428 *****************************************************************************/
429 static acpi_thread_id acpi_ev_global_lock_thread_id;
430 static int acpi_ev_global_lock_acquired;
432 acpi_status acpi_ev_acquire_global_lock(u16 timeout)
434 acpi_status status = AE_OK;
437 ACPI_FUNCTION_TRACE(ev_acquire_global_lock);
440 * Only one thread can acquire the GL at a time, the global_lock_mutex
441 * enforces this. This interface releases the interpreter if we must wait.
443 status = acpi_ex_system_wait_mutex(
444 acpi_gbl_global_lock_mutex->mutex.os_mutex, 0);
445 if (status == AE_TIME) {
446 if (acpi_ev_global_lock_thread_id == acpi_os_get_thread_id()) {
447 acpi_ev_global_lock_acquired++;
452 if (ACPI_FAILURE(status)) {
453 status = acpi_ex_system_wait_mutex(
454 acpi_gbl_global_lock_mutex->mutex.os_mutex,
457 if (ACPI_FAILURE(status)) {
458 return_ACPI_STATUS(status);
461 acpi_ev_global_lock_thread_id = acpi_os_get_thread_id();
462 acpi_ev_global_lock_acquired++;
465 * Update the global lock handle and check for wraparound. The handle is
466 * only used for the external global lock interfaces, but it is updated
467 * here to properly handle the case where a single thread may acquire the
468 * lock via both the AML and the acpi_acquire_global_lock interfaces. The
469 * handle is therefore updated on the first acquire from a given thread
470 * regardless of where the acquisition request originated.
472 acpi_gbl_global_lock_handle++;
473 if (acpi_gbl_global_lock_handle == 0) {
474 acpi_gbl_global_lock_handle = 1;
478 * Make sure that a global lock actually exists. If not, just treat
479 * the lock as a standard mutex.
481 if (!acpi_gbl_global_lock_present) {
482 acpi_gbl_global_lock_acquired = TRUE;
483 return_ACPI_STATUS(AE_OK);
486 /* Attempt to acquire the actual hardware lock */
488 ACPI_ACQUIRE_GLOBAL_LOCK(facs, acquired);
491 /* We got the lock */
493 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
494 "Acquired hardware Global Lock\n"));
496 acpi_gbl_global_lock_acquired = TRUE;
497 return_ACPI_STATUS(AE_OK);
501 * Did not get the lock. The pending bit was set above, and we must now
502 * wait until we get the global lock released interrupt.
504 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Waiting for hardware Global Lock\n"));
507 * Wait for handshake with the global lock interrupt handler.
508 * This interface releases the interpreter if we must wait.
510 status = acpi_ex_system_wait_semaphore(acpi_gbl_global_lock_semaphore,
513 return_ACPI_STATUS(status);
516 /*******************************************************************************
518 * FUNCTION: acpi_ev_release_global_lock
524 * DESCRIPTION: Releases ownership of the Global Lock.
526 ******************************************************************************/
528 acpi_status acpi_ev_release_global_lock(void)
531 acpi_status status = AE_OK;
533 ACPI_FUNCTION_TRACE(ev_release_global_lock);
535 /* Lock must be already acquired */
537 if (!acpi_gbl_global_lock_acquired) {
538 ACPI_WARNING((AE_INFO,
539 "Cannot release the ACPI Global Lock, it has not been acquired"));
540 return_ACPI_STATUS(AE_NOT_ACQUIRED);
543 acpi_ev_global_lock_acquired--;
544 if (acpi_ev_global_lock_acquired > 0) {
548 if (acpi_gbl_global_lock_present) {
550 /* Allow any thread to release the lock */
552 ACPI_RELEASE_GLOBAL_LOCK(facs, pending);
555 * If the pending bit was set, we must write GBL_RLS to the control
560 acpi_set_register(ACPI_BITREG_GLOBAL_LOCK_RELEASE,
564 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
565 "Released hardware Global Lock\n"));
568 acpi_gbl_global_lock_acquired = FALSE;
570 /* Release the local GL mutex */
571 acpi_ev_global_lock_thread_id = NULL;
572 acpi_ev_global_lock_acquired = 0;
573 acpi_os_release_mutex(acpi_gbl_global_lock_mutex->mutex.os_mutex);
574 return_ACPI_STATUS(status);
577 /******************************************************************************
579 * FUNCTION: acpi_ev_terminate
585 * DESCRIPTION: Disable events and free memory allocated for table storage.
587 ******************************************************************************/
589 void acpi_ev_terminate(void)
594 ACPI_FUNCTION_TRACE(ev_terminate);
596 if (acpi_gbl_events_initialized) {
598 * Disable all event-related functionality.
599 * In all cases, on error, print a message but obviously we don't abort.
602 /* Disable all fixed events */
604 for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++) {
605 status = acpi_disable_event((u32) i, 0);
606 if (ACPI_FAILURE(status)) {
608 "Could not disable fixed event %d",
613 /* Disable all GPEs in all GPE blocks */
615 status = acpi_ev_walk_gpe_list(acpi_hw_disable_gpe_block);
617 /* Remove SCI handler */
619 status = acpi_ev_remove_sci_handler();
620 if (ACPI_FAILURE(status)) {
621 ACPI_ERROR((AE_INFO, "Could not remove SCI handler"));
624 status = acpi_ev_remove_global_lock_handler();
625 if (ACPI_FAILURE(status)) {
627 "Could not remove Global Lock handler"));
631 /* Deallocate all handler objects installed within GPE info structs */
633 status = acpi_ev_walk_gpe_list(acpi_ev_delete_gpe_handlers);
635 /* Return to original mode if necessary */
637 if (acpi_gbl_original_mode == ACPI_SYS_MODE_LEGACY) {
638 status = acpi_disable();
639 if (ACPI_FAILURE(status)) {
640 ACPI_WARNING((AE_INFO, "AcpiDisable failed"));