1 /******************************************************************************
3 * Module Name: evxface - External interfaces for ACPI events
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2003, 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 prton 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 #define __EVXFACE_C__
121 #include "acnamesp.h"
122 #include "acevents.h"
123 #include "acinterp.h"
125 #define _COMPONENT ACPI_EVENTS
126 ACPI_MODULE_NAME ("evxface")
129 /*******************************************************************************
131 * FUNCTION: AcpiInstallFixedEventHandler
133 * PARAMETERS: Event - Event type to enable.
134 * Handler - Pointer to the handler function for the
136 * Context - Value passed to the handler on each GPE
140 * DESCRIPTION: Saves the pointer to the handler function and then enables the
143 ******************************************************************************/
146 AcpiInstallFixedEventHandler (
148 ACPI_EVENT_HANDLER Handler,
154 ACPI_FUNCTION_TRACE ("AcpiInstallFixedEventHandler");
157 /* Parameter validation */
159 if (Event > ACPI_EVENT_MAX)
161 return_ACPI_STATUS (AE_BAD_PARAMETER);
164 Status = AcpiUtAcquireMutex (ACPI_MTX_EVENTS);
165 if (ACPI_FAILURE (Status))
167 return_ACPI_STATUS (Status);
170 /* Don't allow two handlers. */
172 if (NULL != AcpiGbl_FixedEventHandlers[Event].Handler)
174 Status = AE_ALREADY_EXISTS;
178 /* Install the handler before enabling the event */
180 AcpiGbl_FixedEventHandlers[Event].Handler = Handler;
181 AcpiGbl_FixedEventHandlers[Event].Context = Context;
183 Status = AcpiEnableEvent (Event, 0);
184 if (ACPI_FAILURE (Status))
186 ACPI_DEBUG_PRINT ((ACPI_DB_WARN, "Could not enable fixed event.\n"));
188 /* Remove the handler */
190 AcpiGbl_FixedEventHandlers[Event].Handler = NULL;
191 AcpiGbl_FixedEventHandlers[Event].Context = NULL;
195 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
196 "Enabled fixed event %X, Handler=%p\n", Event, Handler));
201 (void) AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
202 return_ACPI_STATUS (Status);
206 /*******************************************************************************
208 * FUNCTION: AcpiRemoveFixedEventHandler
210 * PARAMETERS: Event - Event type to disable.
211 * Handler - Address of the handler
215 * DESCRIPTION: Disables the event and unregisters the event handler.
217 ******************************************************************************/
220 AcpiRemoveFixedEventHandler (
222 ACPI_EVENT_HANDLER Handler)
224 ACPI_STATUS Status = AE_OK;
227 ACPI_FUNCTION_TRACE ("AcpiRemoveFixedEventHandler");
230 /* Parameter validation */
232 if (Event > ACPI_EVENT_MAX)
234 return_ACPI_STATUS (AE_BAD_PARAMETER);
237 Status = AcpiUtAcquireMutex (ACPI_MTX_EVENTS);
238 if (ACPI_FAILURE (Status))
240 return_ACPI_STATUS (Status);
243 /* Disable the event before removing the handler */
245 Status = AcpiDisableEvent (Event, 0);
247 /* Always Remove the handler */
249 AcpiGbl_FixedEventHandlers[Event].Handler = NULL;
250 AcpiGbl_FixedEventHandlers[Event].Context = NULL;
252 if (ACPI_FAILURE (Status))
254 ACPI_DEBUG_PRINT ((ACPI_DB_WARN,
255 "Could not write to fixed event enable register.\n"));
259 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Disabled fixed event %X.\n", Event));
262 (void) AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
263 return_ACPI_STATUS (Status);
267 /*******************************************************************************
269 * FUNCTION: AcpiInstallNotifyHandler
271 * PARAMETERS: Device - The device for which notifies will be handled
272 * HandlerType - The type of handler:
273 * ACPI_SYSTEM_NOTIFY: SystemHandler (00-7f)
274 * ACPI_DEVICE_NOTIFY: DriverHandler (80-ff)
275 * Handler - Address of the handler
276 * Context - Value passed to the handler on each GPE
280 * DESCRIPTION: Install a handler for notifies on an ACPI device
282 ******************************************************************************/
285 AcpiInstallNotifyHandler (
288 ACPI_NOTIFY_HANDLER Handler,
291 ACPI_OPERAND_OBJECT *ObjDesc;
292 ACPI_OPERAND_OBJECT *NotifyObj;
293 ACPI_NAMESPACE_NODE *Node;
297 ACPI_FUNCTION_TRACE ("AcpiInstallNotifyHandler");
300 /* Parameter validation */
304 (HandlerType > ACPI_MAX_NOTIFY_HANDLER_TYPE))
306 return_ACPI_STATUS (AE_BAD_PARAMETER);
309 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
310 if (ACPI_FAILURE (Status))
312 return_ACPI_STATUS (Status);
315 /* Convert and validate the device handle */
317 Node = AcpiNsMapHandleToNode (Device);
320 Status = AE_BAD_PARAMETER;
326 * Registering a notify handler on the root object indicates that the
327 * caller wishes to receive notifications for all objects. Note that
328 * only one <external> global handler can be regsitered (per notify type).
330 if (Device == ACPI_ROOT_OBJECT)
332 /* Make sure the handler is not already installed */
334 if (((HandlerType == ACPI_SYSTEM_NOTIFY) &&
335 AcpiGbl_SystemNotify.Handler) ||
336 ((HandlerType == ACPI_DEVICE_NOTIFY) &&
337 AcpiGbl_DeviceNotify.Handler))
339 Status = AE_ALREADY_EXISTS;
343 if (HandlerType == ACPI_SYSTEM_NOTIFY)
345 AcpiGbl_SystemNotify.Node = Node;
346 AcpiGbl_SystemNotify.Handler = Handler;
347 AcpiGbl_SystemNotify.Context = Context;
349 else /* ACPI_DEVICE_NOTIFY */
351 AcpiGbl_DeviceNotify.Node = Node;
352 AcpiGbl_DeviceNotify.Handler = Handler;
353 AcpiGbl_DeviceNotify.Context = Context;
356 /* Global notify handler installed */
361 * Caller will only receive notifications specific to the target object.
362 * Note that only certain object types can receive notifications.
366 /* Notifies allowed on this object? */
368 if (!AcpiEvIsNotifyObject (Node))
374 /* Check for an existing internal object */
376 ObjDesc = AcpiNsGetAttachedObject (Node);
379 /* Object exists - make sure there's no handler */
381 if (((HandlerType == ACPI_SYSTEM_NOTIFY) &&
382 ObjDesc->CommonNotify.SystemNotify) ||
383 ((HandlerType == ACPI_DEVICE_NOTIFY) &&
384 ObjDesc->CommonNotify.DeviceNotify))
386 Status = AE_ALREADY_EXISTS;
392 /* Create a new object */
394 ObjDesc = AcpiUtCreateInternalObject (Node->Type);
397 Status = AE_NO_MEMORY;
401 /* Attach new object to the Node */
403 Status = AcpiNsAttachObject (Device, ObjDesc, Node->Type);
405 /* Remove local reference to the object */
407 AcpiUtRemoveReference (ObjDesc);
409 if (ACPI_FAILURE (Status))
415 /* Install the handler */
417 NotifyObj = AcpiUtCreateInternalObject (ACPI_TYPE_LOCAL_NOTIFY);
420 Status = AE_NO_MEMORY;
424 NotifyObj->Notify.Node = Node;
425 NotifyObj->Notify.Handler = Handler;
426 NotifyObj->Notify.Context = Context;
428 if (HandlerType == ACPI_SYSTEM_NOTIFY)
430 ObjDesc->CommonNotify.SystemNotify = NotifyObj;
432 else /* ACPI_DEVICE_NOTIFY */
434 ObjDesc->CommonNotify.DeviceNotify = NotifyObj;
440 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
441 return_ACPI_STATUS (Status);
445 /*******************************************************************************
447 * FUNCTION: AcpiRemoveNotifyHandler
449 * PARAMETERS: Device - The device for which notifies will be handled
450 * HandlerType - The type of handler:
451 * ACPI_SYSTEM_NOTIFY: SystemHandler (00-7f)
452 * ACPI_DEVICE_NOTIFY: DriverHandler (80-ff)
453 * Handler - Address of the handler
456 * DESCRIPTION: Remove a handler for notifies on an ACPI device
458 ******************************************************************************/
461 AcpiRemoveNotifyHandler (
464 ACPI_NOTIFY_HANDLER Handler)
466 ACPI_OPERAND_OBJECT *NotifyObj;
467 ACPI_OPERAND_OBJECT *ObjDesc;
468 ACPI_NAMESPACE_NODE *Node;
472 ACPI_FUNCTION_TRACE ("AcpiRemoveNotifyHandler");
475 /* Parameter validation */
479 (HandlerType > ACPI_MAX_NOTIFY_HANDLER_TYPE))
481 return_ACPI_STATUS (AE_BAD_PARAMETER);
484 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
485 if (ACPI_FAILURE (Status))
487 return_ACPI_STATUS (Status);
490 /* Convert and validate the device handle */
492 Node = AcpiNsMapHandleToNode (Device);
495 Status = AE_BAD_PARAMETER;
502 if (Device == ACPI_ROOT_OBJECT)
504 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Removing notify handler for ROOT object.\n"));
506 if (((HandlerType == ACPI_SYSTEM_NOTIFY) &&
507 !AcpiGbl_SystemNotify.Handler) ||
508 ((HandlerType == ACPI_DEVICE_NOTIFY) &&
509 !AcpiGbl_DeviceNotify.Handler))
511 Status = AE_NOT_EXIST;
515 if (HandlerType == ACPI_SYSTEM_NOTIFY)
517 AcpiGbl_SystemNotify.Node = NULL;
518 AcpiGbl_SystemNotify.Handler = NULL;
519 AcpiGbl_SystemNotify.Context = NULL;
523 AcpiGbl_DeviceNotify.Node = NULL;
524 AcpiGbl_DeviceNotify.Handler = NULL;
525 AcpiGbl_DeviceNotify.Context = NULL;
534 /* Notifies allowed on this object? */
536 if (!AcpiEvIsNotifyObject (Node))
542 /* Check for an existing internal object */
544 ObjDesc = AcpiNsGetAttachedObject (Node);
547 Status = AE_NOT_EXIST;
551 /* Object exists - make sure there's an existing handler */
553 if (HandlerType == ACPI_SYSTEM_NOTIFY)
555 NotifyObj = ObjDesc->CommonNotify.SystemNotify;
559 NotifyObj = ObjDesc->CommonNotify.DeviceNotify;
563 (NotifyObj->Notify.Handler != Handler))
565 Status = AE_BAD_PARAMETER;
569 /* Remove the handler */
571 if (HandlerType == ACPI_SYSTEM_NOTIFY)
573 ObjDesc->CommonNotify.SystemNotify = NULL;
577 ObjDesc->CommonNotify.DeviceNotify = NULL;
580 AcpiUtRemoveReference (NotifyObj);
585 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
586 return_ACPI_STATUS (Status);
590 /*******************************************************************************
592 * FUNCTION: AcpiInstallGpeHandler
594 * PARAMETERS: GpeNumber - The GPE number within the GPE block
595 * GpeBlock - GPE block (NULL == FADT GPEs)
596 * Type - Whether this GPE should be treated as an
597 * edge- or level-triggered interrupt.
598 * Handler - Address of the handler
599 * Context - Value passed to the handler on each GPE
603 * DESCRIPTION: Install a handler for a General Purpose Event.
605 ******************************************************************************/
608 AcpiInstallGpeHandler (
609 ACPI_HANDLE GpeDevice,
612 ACPI_GPE_HANDLER Handler,
616 ACPI_GPE_EVENT_INFO *GpeEventInfo;
619 ACPI_FUNCTION_TRACE ("AcpiInstallGpeHandler");
622 /* Parameter validation */
626 return_ACPI_STATUS (AE_BAD_PARAMETER);
629 Status = AcpiUtAcquireMutex (ACPI_MTX_EVENTS);
630 if (ACPI_FAILURE (Status))
632 return_ACPI_STATUS (Status);
635 /* Ensure that we have a valid GPE number */
637 GpeEventInfo = AcpiEvGetGpeEventInfo (GpeDevice, GpeNumber);
640 Status = AE_BAD_PARAMETER;
644 /* Make sure that there isn't a handler there already */
646 if (GpeEventInfo->Handler)
648 Status = AE_ALREADY_EXISTS;
652 /* Install the handler */
654 AcpiOsAcquireLock (AcpiGbl_GpeLock, ACPI_NOT_ISR);
655 GpeEventInfo->Handler = Handler;
656 GpeEventInfo->Context = Context;
657 GpeEventInfo->Flags = (UINT8) Type;
658 AcpiOsReleaseLock (AcpiGbl_GpeLock, ACPI_NOT_ISR);
660 /* Clear the GPE (of stale events), the enable it */
662 Status = AcpiHwClearGpe (GpeEventInfo);
663 if (ACPI_FAILURE (Status))
668 Status = AcpiHwEnableGpe (GpeEventInfo);
672 (void) AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
673 return_ACPI_STATUS (Status);
677 /*******************************************************************************
679 * FUNCTION: AcpiRemoveGpeHandler
681 * PARAMETERS: GpeNumber - The event to remove a handler
682 * GpeBlock - GPE block (NULL == FADT GPEs)
683 * Handler - Address of the handler
687 * DESCRIPTION: Remove a handler for a General Purpose AcpiEvent.
689 ******************************************************************************/
692 AcpiRemoveGpeHandler (
693 ACPI_HANDLE GpeDevice,
695 ACPI_GPE_HANDLER Handler)
698 ACPI_GPE_EVENT_INFO *GpeEventInfo;
701 ACPI_FUNCTION_TRACE ("AcpiRemoveGpeHandler");
704 /* Parameter validation */
708 return_ACPI_STATUS (AE_BAD_PARAMETER);
711 Status = AcpiUtAcquireMutex (ACPI_MTX_EVENTS);
712 if (ACPI_FAILURE (Status))
714 return_ACPI_STATUS (Status);
717 /* Ensure that we have a valid GPE number */
719 GpeEventInfo = AcpiEvGetGpeEventInfo (GpeDevice, GpeNumber);
722 Status = AE_BAD_PARAMETER;
726 /* Disable the GPE before removing the handler */
728 Status = AcpiHwDisableGpe (GpeEventInfo);
729 if (ACPI_FAILURE (Status))
734 /* Make sure that the installed handler is the same */
736 if (GpeEventInfo->Handler != Handler)
738 (void) AcpiHwEnableGpe (GpeEventInfo);
739 Status = AE_BAD_PARAMETER;
743 /* Remove the handler */
745 AcpiOsAcquireLock (AcpiGbl_GpeLock, ACPI_NOT_ISR);
746 GpeEventInfo->Handler = NULL;
747 GpeEventInfo->Context = NULL;
748 AcpiOsReleaseLock (AcpiGbl_GpeLock, ACPI_NOT_ISR);
752 (void) AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
753 return_ACPI_STATUS (Status);
757 /*******************************************************************************
759 * FUNCTION: AcpiAcquireGlobalLock
761 * PARAMETERS: Timeout - How long the caller is willing to wait
762 * OutHandle - A handle to the lock if acquired
766 * DESCRIPTION: Acquire the ACPI Global Lock
768 ******************************************************************************/
771 AcpiAcquireGlobalLock (
780 return (AE_BAD_PARAMETER);
783 Status = AcpiExEnterInterpreter ();
784 if (ACPI_FAILURE (Status))
789 Status = AcpiEvAcquireGlobalLock (Timeout);
790 AcpiExExitInterpreter ();
792 if (ACPI_SUCCESS (Status))
794 AcpiGbl_GlobalLockHandle++;
795 *Handle = AcpiGbl_GlobalLockHandle;
802 /*******************************************************************************
804 * FUNCTION: AcpiReleaseGlobalLock
806 * PARAMETERS: Handle - Returned from AcpiAcquireGlobalLock
810 * DESCRIPTION: Release the ACPI Global Lock
812 ******************************************************************************/
815 AcpiReleaseGlobalLock (
821 if (Handle != AcpiGbl_GlobalLockHandle)
823 return (AE_NOT_ACQUIRED);
826 Status = AcpiEvReleaseGlobalLock ();