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 /* Local prototypes */
68 static void ACPI_SYSTEM_XFACE
acpi_ev_notify_dispatch(void *context
);
70 static void ACPI_SYSTEM_XFACE
acpi_ev_global_lock_thread(void *context
);
72 static u32
acpi_ev_global_lock_handler(void *context
);
74 /*******************************************************************************
76 * FUNCTION: acpi_ev_is_notify_object
78 * PARAMETERS: Node - Node to check
80 * RETURN: TRUE if notifies allowed on this object
82 * DESCRIPTION: Check type of node for a object that supports notifies.
84 * TBD: This could be replaced by a flag bit in the node.
86 ******************************************************************************/
88 u8
acpi_ev_is_notify_object(struct acpi_namespace_node
*node
)
91 case ACPI_TYPE_DEVICE
:
92 case ACPI_TYPE_PROCESSOR
:
94 case ACPI_TYPE_THERMAL
:
96 * These are the ONLY objects that can receive ACPI notifications
105 /*******************************************************************************
107 * FUNCTION: acpi_ev_queue_notify_request
109 * PARAMETERS: Node - NS node for the notified object
110 * notify_value - Value from the Notify() request
114 * DESCRIPTION: Dispatch a device notification event to a previously
117 ******************************************************************************/
120 acpi_ev_queue_notify_request(struct acpi_namespace_node
* node
,
123 union acpi_operand_object
*obj_desc
;
124 union acpi_operand_object
*handler_obj
= NULL
;
125 union acpi_generic_state
*notify_info
;
126 acpi_status status
= AE_OK
;
128 ACPI_FUNCTION_NAME(ev_queue_notify_request
);
131 * For value 3 (Ejection Request), some device method may need to be run.
132 * For value 2 (Device Wake) if _PRW exists, the _PS0 method may need
134 * For value 0x80 (Status Change) on the power button or sleep button,
135 * initiate soft-off or sleep operation?
137 ACPI_DEBUG_PRINT((ACPI_DB_INFO
,
138 "Dispatching Notify(%X) on node %p\n", notify_value
,
141 if (notify_value
<= 7) {
142 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Notify value: %s\n",
143 acpi_notify_value_names
[notify_value
]));
145 ACPI_DEBUG_PRINT((ACPI_DB_INFO
,
146 "Notify value: 0x%2.2X **Device Specific**\n",
150 /* Get the notify object attached to the NS Node */
152 obj_desc
= acpi_ns_get_attached_object(node
);
155 /* We have the notify object, Get the right handler */
157 switch (node
->type
) {
158 case ACPI_TYPE_DEVICE
:
159 case ACPI_TYPE_THERMAL
:
160 case ACPI_TYPE_PROCESSOR
:
161 case ACPI_TYPE_POWER
:
163 if (notify_value
<= ACPI_MAX_SYS_NOTIFY
) {
165 obj_desc
->common_notify
.system_notify
;
168 obj_desc
->common_notify
.device_notify
;
173 /* All other types are not supported */
178 /* If there is any handler to run, schedule the dispatcher */
180 if ((acpi_gbl_system_notify
.handler
181 && (notify_value
<= ACPI_MAX_SYS_NOTIFY
))
182 || (acpi_gbl_device_notify
.handler
183 && (notify_value
> ACPI_MAX_SYS_NOTIFY
)) || handler_obj
) {
184 notify_info
= acpi_ut_create_generic_state();
186 return (AE_NO_MEMORY
);
189 notify_info
->common
.descriptor_type
=
190 ACPI_DESC_TYPE_STATE_NOTIFY
;
191 notify_info
->notify
.node
= node
;
192 notify_info
->notify
.value
= (u16
) notify_value
;
193 notify_info
->notify
.handler_obj
= handler_obj
;
196 acpi_os_execute(OSL_NOTIFY_HANDLER
, acpi_ev_notify_dispatch
,
198 if (ACPI_FAILURE(status
)) {
199 acpi_ut_delete_generic_state(notify_info
);
205 * There is no per-device notify handler for this device.
206 * This may or may not be a problem.
208 ACPI_DEBUG_PRINT((ACPI_DB_INFO
,
209 "No notify handler for Notify(%4.4s, %X) node %p\n",
210 acpi_ut_get_node_name(node
), notify_value
,
217 /*******************************************************************************
219 * FUNCTION: acpi_ev_notify_dispatch
221 * PARAMETERS: Context - To be passed to the notify handler
225 * DESCRIPTION: Dispatch a device notification event to a previously
228 ******************************************************************************/
230 static void ACPI_SYSTEM_XFACE
acpi_ev_notify_dispatch(void *context
)
232 union acpi_generic_state
*notify_info
=
233 (union acpi_generic_state
*)context
;
234 acpi_notify_handler global_handler
= NULL
;
235 void *global_context
= NULL
;
236 union acpi_operand_object
*handler_obj
;
238 ACPI_FUNCTION_ENTRY();
241 * We will invoke a global notify handler if installed.
242 * This is done _before_ we invoke the per-device handler attached
245 if (notify_info
->notify
.value
<= ACPI_MAX_SYS_NOTIFY
) {
247 /* Global system notification handler */
249 if (acpi_gbl_system_notify
.handler
) {
250 global_handler
= acpi_gbl_system_notify
.handler
;
251 global_context
= acpi_gbl_system_notify
.context
;
254 /* Global driver notification handler */
256 if (acpi_gbl_device_notify
.handler
) {
257 global_handler
= acpi_gbl_device_notify
.handler
;
258 global_context
= acpi_gbl_device_notify
.context
;
262 /* Invoke the system handler first, if present */
264 if (global_handler
) {
265 global_handler(notify_info
->notify
.node
,
266 notify_info
->notify
.value
, global_context
);
269 /* Now invoke the per-device handler, if present */
271 handler_obj
= notify_info
->notify
.handler_obj
;
273 handler_obj
->notify
.handler(notify_info
->notify
.node
,
274 notify_info
->notify
.value
,
275 handler_obj
->notify
.context
);
278 /* All done with the info object */
280 acpi_ut_delete_generic_state(notify_info
);
283 /*******************************************************************************
285 * FUNCTION: acpi_ev_global_lock_thread
287 * PARAMETERS: Context - From thread interface, not used
291 * DESCRIPTION: Invoked by SCI interrupt handler upon acquisition of the
292 * Global Lock. Simply signal all threads that are waiting
295 ******************************************************************************/
297 static void ACPI_SYSTEM_XFACE
acpi_ev_global_lock_thread(void *context
)
301 /* Signal threads that are waiting for the lock */
303 if (acpi_gbl_global_lock_thread_count
) {
305 /* Send sufficient units to the semaphore */
308 acpi_os_signal_semaphore(acpi_gbl_global_lock_semaphore
,
309 acpi_gbl_global_lock_thread_count
);
310 if (ACPI_FAILURE(status
)) {
312 "Could not signal Global Lock semaphore"));
317 /*******************************************************************************
319 * FUNCTION: acpi_ev_global_lock_handler
321 * PARAMETERS: Context - From thread interface, not used
323 * RETURN: ACPI_INTERRUPT_HANDLED or ACPI_INTERRUPT_NOT_HANDLED
325 * DESCRIPTION: Invoked directly from the SCI handler when a global lock
326 * release interrupt occurs. Grab the global lock and queue
327 * the global lock thread for execution
329 ******************************************************************************/
331 static u32
acpi_ev_global_lock_handler(void *context
)
336 * Attempt to get the lock
337 * If we don't get it now, it will be marked pending and we will
338 * take another interrupt when it becomes free.
340 ACPI_ACQUIRE_GLOBAL_LOCK(acpi_gbl_common_fACS
.global_lock
, acquired
);
343 /* Got the lock, now wake all threads waiting for it */
344 acpi_gbl_global_lock_acquired
= TRUE
;
345 acpi_ev_global_lock_thread(context
);
348 return (ACPI_INTERRUPT_HANDLED
);
351 /*******************************************************************************
353 * FUNCTION: acpi_ev_init_global_lock_handler
359 * DESCRIPTION: Install a handler for the global lock release event
361 ******************************************************************************/
363 acpi_status
acpi_ev_init_global_lock_handler(void)
367 ACPI_FUNCTION_TRACE(ev_init_global_lock_handler
);
369 acpi_gbl_global_lock_present
= TRUE
;
370 status
= acpi_install_fixed_event_handler(ACPI_EVENT_GLOBAL
,
371 acpi_ev_global_lock_handler
,
375 * If the global lock does not exist on this platform, the attempt
376 * to enable GBL_STATUS will fail (the GBL_ENABLE bit will not stick)
377 * Map to AE_OK, but mark global lock as not present.
378 * Any attempt to actually use the global lock will be flagged
381 if (status
== AE_NO_HARDWARE_RESPONSE
) {
383 "No response from Global Lock hardware, disabling lock"));
385 acpi_gbl_global_lock_present
= FALSE
;
389 return_ACPI_STATUS(status
);
392 /******************************************************************************
394 * FUNCTION: acpi_ev_acquire_global_lock
396 * PARAMETERS: Timeout - Max time to wait for the lock, in millisec.
400 * DESCRIPTION: Attempt to gain ownership of the Global Lock.
402 *****************************************************************************/
404 acpi_status
acpi_ev_acquire_global_lock(u16 timeout
)
406 acpi_status status
= AE_OK
;
409 ACPI_FUNCTION_TRACE(ev_acquire_global_lock
);
411 #ifndef ACPI_APPLICATION
412 /* Make sure that we actually have a global lock */
414 if (!acpi_gbl_global_lock_present
) {
415 return_ACPI_STATUS(AE_NO_GLOBAL_LOCK
);
419 /* One more thread wants the global lock */
421 acpi_gbl_global_lock_thread_count
++;
424 * If we (OS side vs. BIOS side) have the hardware lock already,
427 if (acpi_gbl_global_lock_acquired
) {
428 return_ACPI_STATUS(AE_OK
);
431 /* We must acquire the actual hardware lock */
433 ACPI_ACQUIRE_GLOBAL_LOCK(acpi_gbl_common_fACS
.global_lock
, acquired
);
436 /* We got the lock */
438 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
439 "Acquired the HW Global Lock\n"));
441 acpi_gbl_global_lock_acquired
= TRUE
;
442 return_ACPI_STATUS(AE_OK
);
446 * Did not get the lock. The pending bit was set above, and we must now
447 * wait until we get the global lock released interrupt.
449 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
, "Waiting for the HW Global Lock\n"));
452 * Acquire the global lock semaphore first.
453 * Since this wait will block, we must release the interpreter
456 acpi_ex_system_wait_semaphore(acpi_gbl_global_lock_semaphore
,
458 return_ACPI_STATUS(status
);
461 /*******************************************************************************
463 * FUNCTION: acpi_ev_release_global_lock
469 * DESCRIPTION: Releases ownership of the Global Lock.
471 ******************************************************************************/
473 acpi_status
acpi_ev_release_global_lock(void)
476 acpi_status status
= AE_OK
;
478 ACPI_FUNCTION_TRACE(ev_release_global_lock
);
480 if (!acpi_gbl_global_lock_thread_count
) {
481 ACPI_WARNING((AE_INFO
,
482 "Cannot release HW Global Lock, it has not been acquired"));
483 return_ACPI_STATUS(AE_NOT_ACQUIRED
);
486 /* One fewer thread has the global lock */
488 acpi_gbl_global_lock_thread_count
--;
489 if (acpi_gbl_global_lock_thread_count
) {
491 /* There are still some threads holding the lock, cannot release */
493 return_ACPI_STATUS(AE_OK
);
497 * No more threads holding lock, we can do the actual hardware
500 ACPI_RELEASE_GLOBAL_LOCK(acpi_gbl_common_fACS
.global_lock
, pending
);
501 acpi_gbl_global_lock_acquired
= FALSE
;
504 * If the pending bit was set, we must write GBL_RLS to the control
508 status
= acpi_set_register(ACPI_BITREG_GLOBAL_LOCK_RELEASE
,
512 return_ACPI_STATUS(status
);
515 /******************************************************************************
517 * FUNCTION: acpi_ev_terminate
523 * DESCRIPTION: Disable events and free memory allocated for table storage.
525 ******************************************************************************/
527 void acpi_ev_terminate(void)
532 ACPI_FUNCTION_TRACE(ev_terminate
);
534 if (acpi_gbl_events_initialized
) {
536 * Disable all event-related functionality.
537 * In all cases, on error, print a message but obviously we don't abort.
540 /* Disable all fixed events */
542 for (i
= 0; i
< ACPI_NUM_FIXED_EVENTS
; i
++) {
543 status
= acpi_disable_event((u32
) i
, 0);
544 if (ACPI_FAILURE(status
)) {
546 "Could not disable fixed event %d",
551 /* Disable all GPEs in all GPE blocks */
553 status
= acpi_ev_walk_gpe_list(acpi_hw_disable_gpe_block
);
555 /* Remove SCI handler */
557 status
= acpi_ev_remove_sci_handler();
558 if (ACPI_FAILURE(status
)) {
559 ACPI_ERROR((AE_INFO
, "Could not remove SCI handler"));
563 /* Deallocate all handler objects installed within GPE info structs */
565 status
= acpi_ev_walk_gpe_list(acpi_ev_delete_gpe_handlers
);
567 /* Return to original mode if necessary */
569 if (acpi_gbl_original_mode
== ACPI_SYS_MODE_LEGACY
) {
570 status
= acpi_disable();
571 if (ACPI_FAILURE(status
)) {
572 ACPI_WARNING((AE_INFO
, "AcpiDisable failed"));