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 *****************************************************************************/
116 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/evxface.c,v 1.1 2003/09/24 03:32:15 drhodus Exp $ */
119 #define __EVXFACE_C__
122 #include "acnamesp.h"
123 #include "acevents.h"
124 #include "acinterp.h"
126 #define _COMPONENT ACPI_EVENTS
127 ACPI_MODULE_NAME ("evxface")
130 /*******************************************************************************
132 * FUNCTION: AcpiInstallFixedEventHandler
134 * PARAMETERS: Event - Event type to enable.
135 * Handler - Pointer to the handler function for the
137 * Context - Value passed to the handler on each GPE
141 * DESCRIPTION: Saves the pointer to the handler function and then enables the
144 ******************************************************************************/
147 AcpiInstallFixedEventHandler (
149 ACPI_EVENT_HANDLER Handler,
155 ACPI_FUNCTION_TRACE ("AcpiInstallFixedEventHandler");
158 /* Parameter validation */
160 if (Event > ACPI_EVENT_MAX)
162 return_ACPI_STATUS (AE_BAD_PARAMETER);
165 Status = AcpiUtAcquireMutex (ACPI_MTX_EVENTS);
166 if (ACPI_FAILURE (Status))
168 return_ACPI_STATUS (Status);
171 /* Don't allow two handlers. */
173 if (NULL != AcpiGbl_FixedEventHandlers[Event].Handler)
175 Status = AE_ALREADY_EXISTS;
179 /* Install the handler before enabling the event */
181 AcpiGbl_FixedEventHandlers[Event].Handler = Handler;
182 AcpiGbl_FixedEventHandlers[Event].Context = Context;
184 Status = AcpiEnableEvent (Event, ACPI_EVENT_FIXED, 0);
185 if (ACPI_FAILURE (Status))
187 ACPI_DEBUG_PRINT ((ACPI_DB_WARN, "Could not enable fixed event.\n"));
189 /* Remove the handler */
191 AcpiGbl_FixedEventHandlers[Event].Handler = NULL;
192 AcpiGbl_FixedEventHandlers[Event].Context = NULL;
196 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
197 "Enabled fixed event %X, Handler=%p\n", Event, Handler));
202 (void) AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
203 return_ACPI_STATUS (Status);
207 /*******************************************************************************
209 * FUNCTION: AcpiRemoveFixedEventHandler
211 * PARAMETERS: Event - Event type to disable.
212 * Handler - Address of the handler
216 * DESCRIPTION: Disables the event and unregisters the event handler.
218 ******************************************************************************/
221 AcpiRemoveFixedEventHandler (
223 ACPI_EVENT_HANDLER Handler)
225 ACPI_STATUS Status = AE_OK;
228 ACPI_FUNCTION_TRACE ("AcpiRemoveFixedEventHandler");
231 /* Parameter validation */
233 if (Event > ACPI_EVENT_MAX)
235 return_ACPI_STATUS (AE_BAD_PARAMETER);
238 Status = AcpiUtAcquireMutex (ACPI_MTX_EVENTS);
239 if (ACPI_FAILURE (Status))
241 return_ACPI_STATUS (Status);
244 /* Disable the event before removing the handler */
246 Status = AcpiDisableEvent(Event, ACPI_EVENT_FIXED, 0);
248 /* Always Remove the handler */
250 AcpiGbl_FixedEventHandlers[Event].Handler = NULL;
251 AcpiGbl_FixedEventHandlers[Event].Context = NULL;
253 if (ACPI_FAILURE (Status))
255 ACPI_DEBUG_PRINT ((ACPI_DB_WARN,
256 "Could not write to fixed event enable register.\n"));
260 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Disabled fixed event %X.\n", Event));
263 (void) AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
264 return_ACPI_STATUS (Status);
268 /*******************************************************************************
270 * FUNCTION: AcpiInstallNotifyHandler
272 * PARAMETERS: Device - The device for which notifies will be handled
273 * HandlerType - The type of handler:
274 * ACPI_SYSTEM_NOTIFY: SystemHandler (00-7f)
275 * ACPI_DEVICE_NOTIFY: DriverHandler (80-ff)
276 * Handler - Address of the handler
277 * Context - Value passed to the handler on each GPE
281 * DESCRIPTION: Install a handler for notifies on an ACPI device
283 ******************************************************************************/
286 AcpiInstallNotifyHandler (
289 ACPI_NOTIFY_HANDLER Handler,
292 ACPI_OPERAND_OBJECT *ObjDesc;
293 ACPI_OPERAND_OBJECT *NotifyObj;
294 ACPI_NAMESPACE_NODE *Node;
298 ACPI_FUNCTION_TRACE ("AcpiInstallNotifyHandler");
301 /* Parameter validation */
305 (HandlerType > ACPI_MAX_NOTIFY_HANDLER_TYPE))
307 return_ACPI_STATUS (AE_BAD_PARAMETER);
310 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
311 if (ACPI_FAILURE (Status))
313 return_ACPI_STATUS (Status);
316 /* Convert and validate the device handle */
318 Node = AcpiNsMapHandleToNode (Device);
321 Status = AE_BAD_PARAMETER;
327 * Registering a notify handler on the root object indicates that the
328 * caller wishes to receive notifications for all objects. Note that
329 * only one <external> global handler can be regsitered (per notify type).
331 if (Device == ACPI_ROOT_OBJECT)
333 /* Make sure the handler is not already installed */
335 if (((HandlerType == ACPI_SYSTEM_NOTIFY) &&
336 AcpiGbl_SysNotify.Handler) ||
337 ((HandlerType == ACPI_DEVICE_NOTIFY) &&
338 AcpiGbl_DrvNotify.Handler))
340 Status = AE_ALREADY_EXISTS;
344 if (HandlerType == ACPI_SYSTEM_NOTIFY)
346 AcpiGbl_SysNotify.Node = Node;
347 AcpiGbl_SysNotify.Handler = Handler;
348 AcpiGbl_SysNotify.Context = Context;
350 else /* ACPI_DEVICE_NOTIFY */
352 AcpiGbl_DrvNotify.Node = Node;
353 AcpiGbl_DrvNotify.Handler = Handler;
354 AcpiGbl_DrvNotify.Context = Context;
357 /* Global notify handler installed */
362 * Caller will only receive notifications specific to the target object.
363 * Note that only certain object types can receive notifications.
367 /* Notifies allowed on this object? */
369 if (!AcpiEvIsNotifyObject (Node))
375 /* Check for an existing internal object */
377 ObjDesc = AcpiNsGetAttachedObject (Node);
381 /* Object exists - make sure there's no handler */
383 if (((HandlerType == ACPI_SYSTEM_NOTIFY) &&
384 ObjDesc->CommonNotify.SysHandler) ||
385 ((HandlerType == ACPI_DEVICE_NOTIFY) &&
386 ObjDesc->CommonNotify.DrvHandler))
388 Status = AE_ALREADY_EXISTS;
394 /* Create a new object */
396 ObjDesc = AcpiUtCreateInternalObject (Node->Type);
399 Status = AE_NO_MEMORY;
403 /* Attach new object to the Node */
405 Status = AcpiNsAttachObject (Device, ObjDesc, Node->Type);
406 if (ACPI_FAILURE (Status))
412 /* Install the handler */
414 NotifyObj = AcpiUtCreateInternalObject (ACPI_TYPE_LOCAL_NOTIFY);
417 Status = AE_NO_MEMORY;
421 NotifyObj->NotifyHandler.Node = Node;
422 NotifyObj->NotifyHandler.Handler = Handler;
423 NotifyObj->NotifyHandler.Context = Context;
425 if (HandlerType == ACPI_SYSTEM_NOTIFY)
427 ObjDesc->CommonNotify.SysHandler = NotifyObj;
429 else /* ACPI_DEVICE_NOTIFY */
431 ObjDesc->CommonNotify.DrvHandler = NotifyObj;
437 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
438 return_ACPI_STATUS (Status);
442 /*******************************************************************************
444 * FUNCTION: AcpiRemoveNotifyHandler
446 * PARAMETERS: Device - The device for which notifies will be handled
447 * HandlerType - The type of handler:
448 * ACPI_SYSTEM_NOTIFY: SystemHandler (00-7f)
449 * ACPI_DEVICE_NOTIFY: DriverHandler (80-ff)
450 * Handler - Address of the handler
453 * DESCRIPTION: Remove a handler for notifies on an ACPI device
455 ******************************************************************************/
458 AcpiRemoveNotifyHandler (
461 ACPI_NOTIFY_HANDLER Handler)
463 ACPI_OPERAND_OBJECT *NotifyObj;
464 ACPI_OPERAND_OBJECT *ObjDesc;
465 ACPI_NAMESPACE_NODE *Node;
469 ACPI_FUNCTION_TRACE ("AcpiRemoveNotifyHandler");
472 /* Parameter validation */
476 (HandlerType > ACPI_MAX_NOTIFY_HANDLER_TYPE))
478 return_ACPI_STATUS (AE_BAD_PARAMETER);
481 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
482 if (ACPI_FAILURE (Status))
484 return_ACPI_STATUS (Status);
487 /* Convert and validate the device handle */
489 Node = AcpiNsMapHandleToNode (Device);
492 Status = AE_BAD_PARAMETER;
499 if (Device == ACPI_ROOT_OBJECT)
501 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Removing notify handler for ROOT object.\n"));
503 if (((HandlerType == ACPI_SYSTEM_NOTIFY) &&
504 !AcpiGbl_SysNotify.Handler) ||
505 ((HandlerType == ACPI_DEVICE_NOTIFY) &&
506 !AcpiGbl_DrvNotify.Handler))
508 Status = AE_NOT_EXIST;
512 if (HandlerType == ACPI_SYSTEM_NOTIFY)
514 AcpiGbl_SysNotify.Node = NULL;
515 AcpiGbl_SysNotify.Handler = NULL;
516 AcpiGbl_SysNotify.Context = NULL;
520 AcpiGbl_DrvNotify.Node = NULL;
521 AcpiGbl_DrvNotify.Handler = NULL;
522 AcpiGbl_DrvNotify.Context = NULL;
531 /* Notifies allowed on this object? */
533 if (!AcpiEvIsNotifyObject (Node))
539 /* Check for an existing internal object */
541 ObjDesc = AcpiNsGetAttachedObject (Node);
544 Status = AE_NOT_EXIST;
548 /* Object exists - make sure there's an existing handler */
550 if (HandlerType == ACPI_SYSTEM_NOTIFY)
552 NotifyObj = ObjDesc->CommonNotify.SysHandler;
556 NotifyObj = ObjDesc->CommonNotify.DrvHandler;
560 (NotifyObj->NotifyHandler.Handler != Handler))
562 Status = AE_BAD_PARAMETER;
566 /* Remove the handler */
568 if (HandlerType == ACPI_SYSTEM_NOTIFY)
570 ObjDesc->CommonNotify.SysHandler = NULL;
574 ObjDesc->CommonNotify.DrvHandler = NULL;
577 AcpiUtRemoveReference (NotifyObj);
582 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
583 return_ACPI_STATUS (Status);
587 /*******************************************************************************
589 * FUNCTION: AcpiInstallGpeHandler
591 * PARAMETERS: GpeNumber - The GPE number. The numbering scheme is
592 * bank 0 first, then bank 1.
593 * Type - Whether this GPE should be treated as an
594 * edge- or level-triggered interrupt.
595 * Handler - Address of the handler
596 * Context - Value passed to the handler on each GPE
600 * DESCRIPTION: Install a handler for a General Purpose Event.
602 ******************************************************************************/
605 AcpiInstallGpeHandler (
608 ACPI_GPE_HANDLER Handler,
612 ACPI_GPE_EVENT_INFO *GpeEventInfo;
615 ACPI_FUNCTION_TRACE ("AcpiInstallGpeHandler");
618 /* Parameter validation */
622 return_ACPI_STATUS (AE_BAD_PARAMETER);
625 /* Ensure that we have a valid GPE number */
627 GpeEventInfo = AcpiEvGetGpeEventInfo (GpeNumber);
630 return_ACPI_STATUS (AE_BAD_PARAMETER);
633 Status = AcpiUtAcquireMutex (ACPI_MTX_EVENTS);
634 if (ACPI_FAILURE (Status))
636 return_ACPI_STATUS (Status);
639 /* Make sure that there isn't a handler there already */
641 if (GpeEventInfo->Handler)
643 Status = AE_ALREADY_EXISTS;
647 /* Install the handler */
649 GpeEventInfo->Handler = Handler;
650 GpeEventInfo->Context = Context;
651 GpeEventInfo->Type = (UINT8) Type;
653 /* Clear the GPE (of stale events), the enable it */
655 Status = AcpiHwClearGpe (GpeEventInfo);
656 if (ACPI_FAILURE (Status))
661 Status = AcpiHwEnableGpe (GpeEventInfo);
665 (void) AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
666 return_ACPI_STATUS (Status);
670 /*******************************************************************************
672 * FUNCTION: AcpiRemoveGpeHandler
674 * PARAMETERS: GpeNumber - The event to remove a handler
675 * Handler - Address of the handler
679 * DESCRIPTION: Remove a handler for a General Purpose AcpiEvent.
681 ******************************************************************************/
684 AcpiRemoveGpeHandler (
686 ACPI_GPE_HANDLER Handler)
689 ACPI_GPE_EVENT_INFO *GpeEventInfo;
692 ACPI_FUNCTION_TRACE ("AcpiRemoveGpeHandler");
695 /* Parameter validation */
699 return_ACPI_STATUS (AE_BAD_PARAMETER);
702 /* Ensure that we have a valid GPE number */
704 GpeEventInfo = AcpiEvGetGpeEventInfo (GpeNumber);
707 return_ACPI_STATUS (AE_BAD_PARAMETER);
710 /* Disable the GPE before removing the handler */
712 Status = AcpiHwDisableGpe (GpeEventInfo);
713 if (ACPI_FAILURE (Status))
715 return_ACPI_STATUS (Status);
718 Status = AcpiUtAcquireMutex (ACPI_MTX_EVENTS);
719 if (ACPI_FAILURE (Status))
721 return_ACPI_STATUS (Status);
724 /* Make sure that the installed handler is the same */
726 if (GpeEventInfo->Handler != Handler)
728 (void) AcpiHwEnableGpe (GpeEventInfo);
729 Status = AE_BAD_PARAMETER;
733 /* Remove the handler */
735 GpeEventInfo->Handler = NULL;
736 GpeEventInfo->Context = NULL;
740 (void) AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
741 return_ACPI_STATUS (Status);
745 /*******************************************************************************
747 * FUNCTION: AcpiAcquireGlobalLock
749 * PARAMETERS: Timeout - How long the caller is willing to wait
750 * OutHandle - A handle to the lock if acquired
754 * DESCRIPTION: Acquire the ACPI Global Lock
756 ******************************************************************************/
759 AcpiAcquireGlobalLock (
768 return (AE_BAD_PARAMETER);
771 Status = AcpiExEnterInterpreter ();
772 if (ACPI_FAILURE (Status))
777 Status = AcpiEvAcquireGlobalLock (Timeout);
778 AcpiExExitInterpreter ();
780 if (ACPI_SUCCESS (Status))
782 AcpiGbl_GlobalLockHandle++;
783 *Handle = AcpiGbl_GlobalLockHandle;
790 /*******************************************************************************
792 * FUNCTION: AcpiReleaseGlobalLock
794 * PARAMETERS: Handle - Returned from AcpiAcquireGlobalLock
798 * DESCRIPTION: Release the ACPI Global Lock
800 ******************************************************************************/
803 AcpiReleaseGlobalLock (
809 if (Handle != AcpiGbl_GlobalLockHandle)
811 return (AE_NOT_ACQUIRED);
814 Status = AcpiEvReleaseGlobalLock ();