1 /******************************************************************************
3 * Module Name: evmisc - Miscellaneous event manager support functions
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2004, Intel Corp.
13 * All rights reserved.
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights. You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code. No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
38 * The above copyright and patent license is granted only if the following
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision. In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change. Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee. Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution. In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
73 * 3.4. Intel retains all right, title, and interest in and to the Original
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
81 * 4. Disclaimer and Export Compliance
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
115 *****************************************************************************/
118 #include "acevents.h"
119 #include "acnamesp.h"
120 #include "acinterp.h"
122 #define _COMPONENT ACPI_EVENTS
123 ACPI_MODULE_NAME ("evmisc")
126 /*******************************************************************************
128 * FUNCTION: AcpiEvIsNotifyObject
130 * PARAMETERS: Node - Node to check
132 * RETURN: TRUE if notifies allowed on this object
134 * DESCRIPTION: Check type of node for a object that supports notifies.
136 * TBD: This could be replaced by a flag bit in the node.
138 ******************************************************************************/
141 AcpiEvIsNotifyObject (
142 ACPI_NAMESPACE_NODE *Node)
146 case ACPI_TYPE_DEVICE:
147 case ACPI_TYPE_PROCESSOR:
148 case ACPI_TYPE_POWER:
149 case ACPI_TYPE_THERMAL:
151 * These are the ONLY objects that can receive ACPI notifications
161 /*******************************************************************************
163 * FUNCTION: AcpiEvQueueNotifyRequest
169 * DESCRIPTION: Dispatch a device notification event to a previously
172 ******************************************************************************/
174 #ifdef ACPI_DEBUG_OUTPUT
175 static const char *AcpiNotifyValueNames[] =
181 "Device Check Light",
182 "Frequency Mismatch",
189 AcpiEvQueueNotifyRequest (
190 ACPI_NAMESPACE_NODE *Node,
193 ACPI_OPERAND_OBJECT *ObjDesc;
194 ACPI_OPERAND_OBJECT *HandlerObj = NULL;
195 ACPI_GENERIC_STATE *NotifyInfo;
196 ACPI_STATUS Status = AE_OK;
199 ACPI_FUNCTION_NAME ("EvQueueNotifyRequest");
203 * For value 3 (Ejection Request), some device method may need to be run.
204 * For value 2 (Device Wake) if _PRW exists, the _PS0 method may need to be run.
205 * For value 0x80 (Status Change) on the power button or sleep button,
206 * initiate soft-off or sleep operation?
208 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
209 "Dispatching Notify(%X) on node %p\n", NotifyValue, Node));
211 if (NotifyValue <= 7)
213 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Notify value: %s\n",
214 AcpiNotifyValueNames[NotifyValue]));
218 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Notify value: 0x%2.2X **Device Specific**\n",
223 * Get the notify object attached to the NS Node
225 ObjDesc = AcpiNsGetAttachedObject (Node);
228 /* We have the notify object, Get the right handler */
232 case ACPI_TYPE_DEVICE:
233 case ACPI_TYPE_THERMAL:
234 case ACPI_TYPE_PROCESSOR:
235 case ACPI_TYPE_POWER:
237 if (NotifyValue <= ACPI_MAX_SYS_NOTIFY)
239 HandlerObj = ObjDesc->CommonNotify.SystemNotify;
243 HandlerObj = ObjDesc->CommonNotify.DeviceNotify;
248 /* All other types are not supported */
253 /* If there is any handler to run, schedule the dispatcher */
255 if ((AcpiGbl_SystemNotify.Handler && (NotifyValue <= ACPI_MAX_SYS_NOTIFY)) ||
256 (AcpiGbl_DeviceNotify.Handler && (NotifyValue > ACPI_MAX_SYS_NOTIFY)) ||
259 NotifyInfo = AcpiUtCreateGenericState ();
262 return (AE_NO_MEMORY);
265 NotifyInfo->Common.DataType = ACPI_DESC_TYPE_STATE_NOTIFY;
266 NotifyInfo->Notify.Node = Node;
267 NotifyInfo->Notify.Value = (UINT16) NotifyValue;
268 NotifyInfo->Notify.HandlerObj = HandlerObj;
270 Status = AcpiOsQueueForExecution (OSD_PRIORITY_HIGH,
271 AcpiEvNotifyDispatch, NotifyInfo);
272 if (ACPI_FAILURE (Status))
274 AcpiUtDeleteGenericState (NotifyInfo);
280 /* There is no per-device notify handler for this device */
282 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
283 "No notify handler for Notify(%4.4s, %X) node %p\n",
284 AcpiUtGetNodeName (Node), NotifyValue, Node));
291 /*******************************************************************************
293 * FUNCTION: AcpiEvNotifyDispatch
299 * DESCRIPTION: Dispatch a device notification event to a previously
302 ******************************************************************************/
304 void ACPI_SYSTEM_XFACE
305 AcpiEvNotifyDispatch (
308 ACPI_GENERIC_STATE *NotifyInfo = (ACPI_GENERIC_STATE *) Context;
309 ACPI_NOTIFY_HANDLER GlobalHandler = NULL;
310 void *GlobalContext = NULL;
311 ACPI_OPERAND_OBJECT *HandlerObj;
314 ACPI_FUNCTION_ENTRY ();
318 * We will invoke a global notify handler if installed.
319 * This is done _before_ we invoke the per-device handler attached to the device.
321 if (NotifyInfo->Notify.Value <= ACPI_MAX_SYS_NOTIFY)
323 /* Global system notification handler */
325 if (AcpiGbl_SystemNotify.Handler)
327 GlobalHandler = AcpiGbl_SystemNotify.Handler;
328 GlobalContext = AcpiGbl_SystemNotify.Context;
333 /* Global driver notification handler */
335 if (AcpiGbl_DeviceNotify.Handler)
337 GlobalHandler = AcpiGbl_DeviceNotify.Handler;
338 GlobalContext = AcpiGbl_DeviceNotify.Context;
342 /* Invoke the system handler first, if present */
346 GlobalHandler (NotifyInfo->Notify.Node, NotifyInfo->Notify.Value, GlobalContext);
349 /* Now invoke the per-device handler, if present */
351 HandlerObj = NotifyInfo->Notify.HandlerObj;
354 HandlerObj->Notify.Handler (NotifyInfo->Notify.Node, NotifyInfo->Notify.Value,
355 HandlerObj->Notify.Context);
358 /* All done with the info object */
360 AcpiUtDeleteGenericState (NotifyInfo);
364 /*******************************************************************************
366 * FUNCTION: AcpiEvGlobalLockThread
370 * DESCRIPTION: Invoked by SCI interrupt handler upon acquisition of the
371 * Global Lock. Simply signal all threads that are waiting
374 ******************************************************************************/
376 static void ACPI_SYSTEM_XFACE
377 AcpiEvGlobalLockThread (
383 /* Signal threads that are waiting for the lock */
385 if (AcpiGbl_GlobalLockThreadCount)
387 /* Send sufficient units to the semaphore */
389 Status = AcpiOsSignalSemaphore (AcpiGbl_GlobalLockSemaphore,
390 AcpiGbl_GlobalLockThreadCount);
391 if (ACPI_FAILURE (Status))
393 ACPI_REPORT_ERROR (("Could not signal Global Lock semaphore\n"));
399 /*******************************************************************************
401 * FUNCTION: AcpiEvGlobalLockHandler
405 * DESCRIPTION: Invoked directly from the SCI handler when a global lock
406 * release interrupt occurs. Grab the global lock and queue
407 * the global lock thread for execution
409 ******************************************************************************/
412 AcpiEvGlobalLockHandler (
415 BOOLEAN Acquired = FALSE;
420 * Attempt to get the lock
421 * If we don't get it now, it will be marked pending and we will
422 * take another interrupt when it becomes free.
424 ACPI_ACQUIRE_GLOBAL_LOCK (AcpiGbl_CommonFACS.GlobalLock, Acquired);
427 /* Got the lock, now wake all threads waiting for it */
429 AcpiGbl_GlobalLockAcquired = TRUE;
431 /* Run the Global Lock thread which will signal all waiting threads */
433 Status = AcpiOsQueueForExecution (OSD_PRIORITY_HIGH,
434 AcpiEvGlobalLockThread, Context);
435 if (ACPI_FAILURE (Status))
437 ACPI_REPORT_ERROR (("Could not queue Global Lock thread, %s\n",
438 AcpiFormatException (Status)));
440 return (ACPI_INTERRUPT_NOT_HANDLED);
444 return (ACPI_INTERRUPT_HANDLED);
448 /*******************************************************************************
450 * FUNCTION: AcpiEvInitGlobalLockHandler
454 * DESCRIPTION: Install a handler for the global lock release event
456 ******************************************************************************/
459 AcpiEvInitGlobalLockHandler (void)
464 ACPI_FUNCTION_TRACE ("EvInitGlobalLockHandler");
467 AcpiGbl_GlobalLockPresent = TRUE;
468 Status = AcpiInstallFixedEventHandler (ACPI_EVENT_GLOBAL,
469 AcpiEvGlobalLockHandler, NULL);
472 * If the global lock does not exist on this platform, the attempt
473 * to enable GBL_STATUS will fail (the GBL_ENABLE bit will not stick)
474 * Map to AE_OK, but mark global lock as not present.
475 * Any attempt to actually use the global lock will be flagged
478 if (Status == AE_NO_HARDWARE_RESPONSE)
480 AcpiGbl_GlobalLockPresent = FALSE;
484 return_ACPI_STATUS (Status);
488 /******************************************************************************
490 * FUNCTION: AcpiEvAcquireGlobalLock
494 * DESCRIPTION: Attempt to gain ownership of the Global Lock.
496 *****************************************************************************/
499 AcpiEvAcquireGlobalLock (
502 ACPI_STATUS Status = AE_OK;
503 BOOLEAN Acquired = FALSE;
506 ACPI_FUNCTION_TRACE ("EvAcquireGlobalLock");
509 #ifndef ACPI_APPLICATION
510 /* Make sure that we actually have a global lock */
512 if (!AcpiGbl_GlobalLockPresent)
514 return_ACPI_STATUS (AE_NO_GLOBAL_LOCK);
518 /* One more thread wants the global lock */
520 AcpiGbl_GlobalLockThreadCount++;
522 /* If we (OS side vs. BIOS side) have the hardware lock already, we are done */
524 if (AcpiGbl_GlobalLockAcquired)
526 return_ACPI_STATUS (AE_OK);
529 /* We must acquire the actual hardware lock */
531 ACPI_ACQUIRE_GLOBAL_LOCK (AcpiGbl_CommonFACS.GlobalLock, Acquired);
534 /* We got the lock */
536 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Acquired the HW Global Lock\n"));
538 AcpiGbl_GlobalLockAcquired = TRUE;
539 return_ACPI_STATUS (AE_OK);
543 * Did not get the lock. The pending bit was set above, and we must now
544 * wait until we get the global lock released interrupt.
546 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Waiting for the HW Global Lock\n"));
549 * Acquire the global lock semaphore first.
550 * Since this wait will block, we must release the interpreter
552 Status = AcpiExSystemWaitSemaphore (AcpiGbl_GlobalLockSemaphore,
554 return_ACPI_STATUS (Status);
558 /*******************************************************************************
560 * FUNCTION: AcpiEvReleaseGlobalLock
562 * DESCRIPTION: Releases ownership of the Global Lock.
564 ******************************************************************************/
567 AcpiEvReleaseGlobalLock (void)
569 BOOLEAN Pending = FALSE;
570 ACPI_STATUS Status = AE_OK;
573 ACPI_FUNCTION_TRACE ("EvReleaseGlobalLock");
576 if (!AcpiGbl_GlobalLockThreadCount)
578 ACPI_REPORT_WARNING(("Cannot release HW Global Lock, it has not been acquired\n"));
579 return_ACPI_STATUS (AE_NOT_ACQUIRED);
582 /* One fewer thread has the global lock */
584 AcpiGbl_GlobalLockThreadCount--;
585 if (AcpiGbl_GlobalLockThreadCount)
587 /* There are still some threads holding the lock, cannot release */
589 return_ACPI_STATUS (AE_OK);
593 * No more threads holding lock, we can do the actual hardware
596 ACPI_RELEASE_GLOBAL_LOCK (AcpiGbl_CommonFACS.GlobalLock, Pending);
597 AcpiGbl_GlobalLockAcquired = FALSE;
600 * If the pending bit was set, we must write GBL_RLS to the control
605 Status = AcpiSetRegister (ACPI_BITREG_GLOBAL_LOCK_RELEASE, 1, ACPI_MTX_LOCK);
608 return_ACPI_STATUS (Status);
612 /******************************************************************************
614 * FUNCTION: AcpiEvTerminate
620 * DESCRIPTION: Disable events and free memory allocated for table storage.
622 ******************************************************************************/
625 AcpiEvTerminate (void)
631 ACPI_FUNCTION_TRACE ("EvTerminate");
634 if (AcpiGbl_EventsInitialized)
637 * Disable all event-related functionality.
638 * In all cases, on error, print a message but obviously we don't abort.
641 /* Disable all fixed events */
643 for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++)
645 Status = AcpiDisableEvent ((UINT32) i, 0);
646 if (ACPI_FAILURE (Status))
648 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Could not disable fixed event %d\n", (UINT32) i));
652 /* Disable all GPEs in all GPE blocks */
654 Status = AcpiEvWalkGpeList (AcpiHwDisableGpeBlock);
656 /* Remove SCI handler */
658 Status = AcpiEvRemoveSciHandler ();
659 if (ACPI_FAILURE(Status))
661 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Could not remove SCI handler\n"));
665 /* Deallocate all handler objects installed within GPE info structs */
667 Status = AcpiEvWalkGpeList (AcpiEvDeleteGpeHandlers);
669 /* Return to original mode if necessary */
671 if (AcpiGbl_OriginalMode == ACPI_SYS_MODE_LEGACY)
673 Status = AcpiDisable ();
674 if (ACPI_FAILURE (Status))
676 ACPI_DEBUG_PRINT ((ACPI_DB_WARN, "AcpiDisable failed\n"));