1 /******************************************************************************
3 * Module Name: evmisc - Miscellaneous event manager support functions
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2006, 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 /*******************************************************************************
78 * FUNCTION: acpi_ev_is_notify_object
80 * PARAMETERS: Node - Node to check
82 * RETURN: TRUE if notifies allowed on this object
84 * DESCRIPTION: Check type of node for a object that supports notifies.
86 * TBD: This could be replaced by a flag bit in the node.
88 ******************************************************************************/
90 u8 acpi_ev_is_notify_object(struct acpi_namespace_node *node)
93 case ACPI_TYPE_DEVICE:
94 case ACPI_TYPE_PROCESSOR:
96 case ACPI_TYPE_THERMAL:
98 * These are the ONLY objects that can receive ACPI notifications
107 /*******************************************************************************
109 * FUNCTION: acpi_ev_queue_notify_request
111 * PARAMETERS: Node - NS node for the notified object
112 * notify_value - Value from the Notify() request
116 * DESCRIPTION: Dispatch a device notification event to a previously
119 ******************************************************************************/
122 acpi_ev_queue_notify_request(struct acpi_namespace_node * node,
125 union acpi_operand_object *obj_desc;
126 union acpi_operand_object *handler_obj = NULL;
127 union acpi_generic_state *notify_info;
128 acpi_status status = AE_OK;
130 ACPI_FUNCTION_NAME(ev_queue_notify_request);
133 * For value 3 (Ejection Request), some device method may need to be run.
134 * For value 2 (Device Wake) if _PRW exists, the _PS0 method may need
136 * For value 0x80 (Status Change) on the power button or sleep button,
137 * initiate soft-off or sleep operation?
139 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
140 "Dispatching Notify(%X) on node %p\n", notify_value,
143 if (notify_value <= 7) {
144 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Notify value: %s\n",
145 acpi_notify_value_names[notify_value]));
147 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
148 "Notify value: 0x%2.2X **Device Specific**\n",
152 /* Get the notify object attached to the NS Node */
154 obj_desc = acpi_ns_get_attached_object(node);
157 /* We have the notify object, Get the right handler */
159 switch (node->type) {
160 case ACPI_TYPE_DEVICE:
161 case ACPI_TYPE_THERMAL:
162 case ACPI_TYPE_PROCESSOR:
163 case ACPI_TYPE_POWER:
165 if (notify_value <= ACPI_MAX_SYS_NOTIFY) {
167 obj_desc->common_notify.system_notify;
170 obj_desc->common_notify.device_notify;
175 /* All other types are not supported */
180 /* If there is any handler to run, schedule the dispatcher */
182 if ((acpi_gbl_system_notify.handler
183 && (notify_value <= ACPI_MAX_SYS_NOTIFY))
184 || (acpi_gbl_device_notify.handler
185 && (notify_value > ACPI_MAX_SYS_NOTIFY)) || handler_obj) {
186 notify_info = acpi_ut_create_generic_state();
188 return (AE_NO_MEMORY);
191 notify_info->common.descriptor_type =
192 ACPI_DESC_TYPE_STATE_NOTIFY;
193 notify_info->notify.node = node;
194 notify_info->notify.value = (u16) notify_value;
195 notify_info->notify.handler_obj = handler_obj;
198 acpi_os_execute(OSL_NOTIFY_HANDLER, acpi_ev_notify_dispatch,
200 if (ACPI_FAILURE(status)) {
201 acpi_ut_delete_generic_state(notify_info);
207 * There is no per-device notify handler for this device.
208 * This may or may not be a problem.
210 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
211 "No notify handler for Notify(%4.4s, %X) node %p\n",
212 acpi_ut_get_node_name(node), notify_value,
219 /*******************************************************************************
221 * FUNCTION: acpi_ev_notify_dispatch
223 * PARAMETERS: Context - To be passed to the notify handler
227 * DESCRIPTION: Dispatch a device notification event to a previously
230 ******************************************************************************/
232 static void ACPI_SYSTEM_XFACE acpi_ev_notify_dispatch(void *context)
234 union acpi_generic_state *notify_info =
235 (union acpi_generic_state *)context;
236 acpi_notify_handler global_handler = NULL;
237 void *global_context = NULL;
238 union acpi_operand_object *handler_obj;
240 ACPI_FUNCTION_ENTRY();
243 * We will invoke a global notify handler if installed.
244 * This is done _before_ we invoke the per-device handler attached
247 if (notify_info->notify.value <= ACPI_MAX_SYS_NOTIFY) {
249 /* Global system notification handler */
251 if (acpi_gbl_system_notify.handler) {
252 global_handler = acpi_gbl_system_notify.handler;
253 global_context = acpi_gbl_system_notify.context;
256 /* Global driver notification handler */
258 if (acpi_gbl_device_notify.handler) {
259 global_handler = acpi_gbl_device_notify.handler;
260 global_context = acpi_gbl_device_notify.context;
264 /* Invoke the system handler first, if present */
266 if (global_handler) {
267 global_handler(notify_info->notify.node,
268 notify_info->notify.value, global_context);
271 /* Now invoke the per-device handler, if present */
273 handler_obj = notify_info->notify.handler_obj;
275 handler_obj->notify.handler(notify_info->notify.node,
276 notify_info->notify.value,
277 handler_obj->notify.context);
280 /* All done with the info object */
282 acpi_ut_delete_generic_state(notify_info);
285 /*******************************************************************************
287 * FUNCTION: acpi_ev_global_lock_handler
289 * PARAMETERS: Context - From thread interface, not used
291 * RETURN: ACPI_INTERRUPT_HANDLED
293 * DESCRIPTION: Invoked directly from the SCI handler when a global lock
294 * release interrupt occurs. Attempt to acquire the global lock,
295 * if successful, signal the thread waiting for the lock.
297 * NOTE: Assumes that the semaphore can be signaled from interrupt level. If
298 * this is not possible for some reason, a separate thread will have to be
299 * scheduled to do this.
301 ******************************************************************************/
303 static u32 acpi_ev_global_lock_handler(void *context)
308 * Attempt to get the lock.
310 * If we don't get it now, it will be marked pending and we will
311 * take another interrupt when it becomes free.
313 ACPI_ACQUIRE_GLOBAL_LOCK(facs, acquired);
316 /* Got the lock, now wake all threads waiting for it */
318 acpi_gbl_global_lock_acquired = TRUE;
319 /* Send a unit to the semaphore */
321 if (ACPI_FAILURE(acpi_os_signal_semaphore(
322 acpi_gbl_global_lock_semaphore, 1))) {
324 "Could not signal Global Lock semaphore"));
328 return (ACPI_INTERRUPT_HANDLED);
331 /*******************************************************************************
333 * FUNCTION: acpi_ev_init_global_lock_handler
339 * DESCRIPTION: Install a handler for the global lock release event
341 ******************************************************************************/
343 acpi_status acpi_ev_init_global_lock_handler(void)
347 ACPI_FUNCTION_TRACE(ev_init_global_lock_handler);
350 acpi_get_table_by_index(ACPI_TABLE_INDEX_FACS,
351 (struct acpi_table_header **)&facs);
352 if (ACPI_FAILURE(status)) {
353 return_ACPI_STATUS(status);
356 acpi_gbl_global_lock_present = TRUE;
357 status = acpi_install_fixed_event_handler(ACPI_EVENT_GLOBAL,
358 acpi_ev_global_lock_handler,
362 * If the global lock does not exist on this platform, the attempt
363 * to enable GBL_STATUS will fail (the GBL_ENABLE bit will not stick)
364 * Map to AE_OK, but mark global lock as not present.
365 * Any attempt to actually use the global lock will be flagged
368 if (status == AE_NO_HARDWARE_RESPONSE) {
370 "No response from Global Lock hardware, disabling lock"));
372 acpi_gbl_global_lock_present = FALSE;
376 return_ACPI_STATUS(status);
379 /******************************************************************************
381 * FUNCTION: acpi_ev_acquire_global_lock
383 * PARAMETERS: Timeout - Max time to wait for the lock, in millisec.
387 * DESCRIPTION: Attempt to gain ownership of the Global Lock.
389 * MUTEX: Interpreter must be locked
391 * Note: The original implementation allowed multiple threads to "acquire" the
392 * Global Lock, and the OS would hold the lock until the last thread had
393 * released it. However, this could potentially starve the BIOS out of the
394 * lock, especially in the case where there is a tight handshake between the
395 * Embedded Controller driver and the BIOS. Therefore, this implementation
396 * allows only one thread to acquire the HW Global Lock at a time, and makes
397 * the global lock appear as a standard mutex on the OS side.
399 *****************************************************************************/
401 acpi_status acpi_ev_acquire_global_lock(u16 timeout)
403 acpi_status status = AE_OK;
406 ACPI_FUNCTION_TRACE(ev_acquire_global_lock);
409 * Only one thread can acquire the GL at a time, the global_lock_mutex
410 * enforces this. This interface releases the interpreter if we must wait.
412 status = acpi_ex_system_wait_mutex(acpi_gbl_global_lock_mutex, timeout);
413 if (ACPI_FAILURE(status)) {
414 return_ACPI_STATUS(status);
418 * Make sure that a global lock actually exists. If not, just treat
419 * the lock as a standard mutex.
421 if (!acpi_gbl_global_lock_present) {
422 acpi_gbl_global_lock_acquired = TRUE;
423 return_ACPI_STATUS(AE_OK);
426 /* Attempt to acquire the actual hardware lock */
428 ACPI_ACQUIRE_GLOBAL_LOCK(facs, acquired);
431 /* We got the lock */
433 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
434 "Acquired hardware Global Lock\n"));
436 acpi_gbl_global_lock_acquired = TRUE;
437 return_ACPI_STATUS(AE_OK);
441 * Did not get the lock. The pending bit was set above, and we must now
442 * wait until we get the global lock released interrupt.
444 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Waiting for hardware Global Lock\n"));
447 * Wait for handshake with the global lock interrupt handler.
448 * This interface releases the interpreter if we must wait.
450 status = acpi_ex_system_wait_semaphore(acpi_gbl_global_lock_semaphore,
453 return_ACPI_STATUS(status);
456 /*******************************************************************************
458 * FUNCTION: acpi_ev_release_global_lock
464 * DESCRIPTION: Releases ownership of the Global Lock.
466 ******************************************************************************/
468 acpi_status acpi_ev_release_global_lock(void)
471 acpi_status status = AE_OK;
473 ACPI_FUNCTION_TRACE(ev_release_global_lock);
475 /* Lock must be already acquired */
477 if (!acpi_gbl_global_lock_acquired) {
478 ACPI_WARNING((AE_INFO,
479 "Cannot release the ACPI Global Lock, it has not been acquired"));
480 return_ACPI_STATUS(AE_NOT_ACQUIRED);
483 if (acpi_gbl_global_lock_present) {
485 /* Allow any thread to release the lock */
487 ACPI_RELEASE_GLOBAL_LOCK(facs, pending);
490 * If the pending bit was set, we must write GBL_RLS to the control
495 acpi_set_register(ACPI_BITREG_GLOBAL_LOCK_RELEASE,
499 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
500 "Released hardware Global Lock\n"));
503 acpi_gbl_global_lock_acquired = FALSE;
505 /* Release the local GL mutex */
507 acpi_os_release_mutex(acpi_gbl_global_lock_mutex);
508 return_ACPI_STATUS(status);
511 /******************************************************************************
513 * FUNCTION: acpi_ev_terminate
519 * DESCRIPTION: Disable events and free memory allocated for table storage.
521 ******************************************************************************/
523 void acpi_ev_terminate(void)
528 ACPI_FUNCTION_TRACE(ev_terminate);
530 if (acpi_gbl_events_initialized) {
532 * Disable all event-related functionality.
533 * In all cases, on error, print a message but obviously we don't abort.
536 /* Disable all fixed events */
538 for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++) {
539 status = acpi_disable_event((u32) i, 0);
540 if (ACPI_FAILURE(status)) {
542 "Could not disable fixed event %d",
547 /* Disable all GPEs in all GPE blocks */
549 status = acpi_ev_walk_gpe_list(acpi_hw_disable_gpe_block);
551 /* Remove SCI handler */
553 status = acpi_ev_remove_sci_handler();
554 if (ACPI_FAILURE(status)) {
555 ACPI_ERROR((AE_INFO, "Could not remove SCI handler"));
559 /* Deallocate all handler objects installed within GPE info structs */
561 status = acpi_ev_walk_gpe_list(acpi_ev_delete_gpe_handlers);
563 /* Return to original mode if necessary */
565 if (acpi_gbl_original_mode == ACPI_SYS_MODE_LEGACY) {
566 status = acpi_disable();
567 if (ACPI_FAILURE(status)) {
568 ACPI_WARNING((AE_INFO, "AcpiDisable failed"));