evxface.c revision 186507a7cf6e4b4155e9ef89631777a96633ac0e
/******************************************************************************
*
* Module Name: evxface - External interfaces for ACPI events
* $Revision: 1.151 $
*
*****************************************************************************/
/******************************************************************************
*
* 1. Copyright Notice
*
* Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp.
* All rights reserved.
*
* 2. License
*
* 2.1. This is your license from Intel Corp. under its intellectual property
* rights. You may have additional license terms from the party that provided
* you this software, covering your right to use that party's intellectual
* property rights.
*
* 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
* copy of the source code appearing in this file ("Covered Code") an
* irrevocable, perpetual, worldwide license under Intel's copyrights in the
* base code distributed originally by Intel ("Original Intel Code") to copy,
* make derivatives, distribute, use and display any portion of the Covered
* Code in any form, with the right to sublicense such rights; and
*
* 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
* license (with the right to sublicense), under only those claims of Intel
* patents that are infringed by the Original Intel Code, to make, use, sell,
* offer to sell, and import the Covered Code and derivative works thereof
* solely to the minimum extent necessary to exercise the above copyright
* license, and in no event shall the patent license extend to any additions
* to or modifications of the Original Intel Code. No other license or right
* is granted directly or by implication, estoppel or otherwise;
*
* The above copyright and patent license is granted only if the following
* conditions are met:
*
* 3. Conditions
*
* 3.1. Redistribution of Source with Rights to Further Distribute Source.
* Redistribution of source code of any substantial prton of the Covered
* Code or modification with rights to further distribute source must include
* the above Copyright Notice, the above License, this list of Conditions,
* and the following Disclaimer and Export Compliance provision. In addition,
* Licensee must cause all Covered Code to which Licensee contributes to
* contain a file documenting the changes Licensee made to create that Covered
* Code and the date of any change. Licensee must include in that file the
* documentation of any changes made by any predecessor Licensee. Licensee
* must include a prominent statement that the modification is derived,
* directly or indirectly, from Original Intel Code.
*
* 3.2. Redistribution of Source with no Rights to Further Distribute Source.
* Redistribution of source code of any substantial portion of the Covered
* Code or modification without rights to further distribute source must
* include the following Disclaimer and Export Compliance provision in the
* addition, Licensee may not authorize further sublicense of source of any
* portion of the Covered Code, and must include terms to the effect that the
* license from Licensee to its licensee is limited to the intellectual
* property embodied in the software Licensee provides to its licensee, and
* not to intellectual property embodied in modifications its licensee may
* make.
*
* 3.3. Redistribution of Executable. Redistribution in executable form of any
* substantial portion of the Covered Code or modification must reproduce the
* above Copyright Notice, and the following Disclaimer and Export Compliance
* distribution.
*
* 3.4. Intel retains all right, title, and interest in and to the Original
* Intel Code.
*
* 3.5. Neither the name Intel nor any other trademark owned or controlled by
* Intel shall be used in advertising or otherwise to promote the sale, use or
* other dealings in products derived from or relating to the Covered Code
* without prior written authorization from Intel.
*
* 4. Disclaimer and Export Compliance
*
* 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
* HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
* IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
* INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
* UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
* IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
* PARTICULAR PURPOSE.
*
* 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
* OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
* COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
* SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
* CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
* HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
* SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
* LIMITED REMEDY.
*
* 4.3. Licensee shall not export, either directly or indirectly, any of this
* software or system incorporating such software without first obtaining any
* required license or other approval from the U. S. Department of Commerce or
* any other agency or department of the United States Government. In the
* event Licensee exports any such software from the United States or
* re-exports any such software from a foreign destination, Licensee shall
* compliance with all laws, regulations, orders, or other restrictions of the
* U.S. Export Administration Regulations. Licensee agrees that neither it nor
* software, or service, directly or indirectly, to any country for which the
* United States government or any agency thereof requires an export license,
* other governmental approval, or letter of assurance, without first obtaining
* such license, approval or letter.
*
*****************************************************************************/
#define __EVXFACE_C__
#include "acpi.h"
#include "acnamesp.h"
#include "acevents.h"
#include "acinterp.h"
#define _COMPONENT ACPI_EVENTS
ACPI_MODULE_NAME ("evxface")
/*******************************************************************************
*
* FUNCTION: AcpiInstallExceptionHandler
*
* PARAMETERS: Handler - Pointer to the handler function for the
* event
*
* RETURN: Status
*
* DESCRIPTION: Saves the pointer to the handler function
*
******************************************************************************/
{
ACPI_FUNCTION_TRACE ("AcpiInstallExceptionHandler");
if (ACPI_FAILURE (Status))
{
}
/* Don't allow two handlers. */
{
goto Cleanup;
}
/* Install the handler */
(void) AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
}
/*******************************************************************************
*
* FUNCTION: AcpiInstallFixedEventHandler
*
* PARAMETERS: Event - Event type to enable.
* Handler - Pointer to the handler function for the
* event
* Context - Value passed to the handler on each GPE
*
* RETURN: Status
*
* DESCRIPTION: Saves the pointer to the handler function and then enables the
* event.
*
******************************************************************************/
void *Context)
{
ACPI_FUNCTION_TRACE ("AcpiInstallFixedEventHandler");
/* Parameter validation */
if (Event > ACPI_EVENT_MAX)
{
}
if (ACPI_FAILURE (Status))
{
}
/* Don't allow two handlers. */
{
goto Cleanup;
}
/* Install the handler before enabling the event */
if (ACPI_FAILURE (Status))
{
/* Remove the handler */
}
else
{
}
(void) AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
}
/*******************************************************************************
*
* FUNCTION: AcpiRemoveFixedEventHandler
*
* PARAMETERS: Event - Event type to disable.
* Handler - Address of the handler
*
* RETURN: Status
*
* DESCRIPTION: Disables the event and unregisters the event handler.
*
******************************************************************************/
{
ACPI_FUNCTION_TRACE ("AcpiRemoveFixedEventHandler");
/* Parameter validation */
if (Event > ACPI_EVENT_MAX)
{
}
if (ACPI_FAILURE (Status))
{
}
/* Disable the event before removing the handler */
/* Always Remove the handler */
if (ACPI_FAILURE (Status))
{
"Could not write to fixed event enable register.\n"));
}
else
{
}
(void) AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
}
/*******************************************************************************
*
* FUNCTION: AcpiInstallNotifyHandler
*
* PARAMETERS: Device - The device for which notifies will be handled
* HandlerType - The type of handler:
* ACPI_SYSTEM_NOTIFY: SystemHandler (00-7f)
* ACPI_DEVICE_NOTIFY: DriverHandler (80-ff)
* ACPI_ALL_NOTIFY: both system and device
* Handler - Address of the handler
* Context - Value passed to the handler on each GPE
*
* RETURN: Status
*
* DESCRIPTION: Install a handler for notifies on an ACPI device
*
******************************************************************************/
void *Context)
{
ACPI_FUNCTION_TRACE ("AcpiInstallNotifyHandler");
/* Parameter validation */
if ((!Device) ||
(!Handler) ||
{
}
if (ACPI_FAILURE (Status))
{
}
/* Convert and validate the device handle */
if (!Node)
{
goto UnlockAndExit;
}
/*
* Root Object:
* Registering a notify handler on the root object indicates that the
* caller wishes to receive notifications for all objects. Note that
* only one <external> global handler can be regsitered (per notify type).
*/
if (Device == ACPI_ROOT_OBJECT)
{
/* Make sure the handler is not already installed */
if (((HandlerType & ACPI_SYSTEM_NOTIFY) &&
((HandlerType & ACPI_DEVICE_NOTIFY) &&
{
goto UnlockAndExit;
}
if (HandlerType & ACPI_SYSTEM_NOTIFY)
{
}
if (HandlerType & ACPI_DEVICE_NOTIFY)
{
}
/* Global notify handler installed */
}
/*
* All Other Objects:
* Caller will only receive notifications specific to the target object.
* Note that only certain object types can receive notifications.
*/
else
{
/* Notifies allowed on this object? */
if (!AcpiEvIsNotifyObject (Node))
{
goto UnlockAndExit;
}
/* Check for an existing internal object */
if (ObjDesc)
{
/* Object exists - make sure there's no handler */
if (((HandlerType & ACPI_SYSTEM_NOTIFY) &&
((HandlerType & ACPI_DEVICE_NOTIFY) &&
{
goto UnlockAndExit;
}
}
else
{
/* Create a new object */
if (!ObjDesc)
{
goto UnlockAndExit;
}
/* Attach new object to the Node */
/* Remove local reference to the object */
if (ACPI_FAILURE (Status))
{
goto UnlockAndExit;
}
}
/* Install the handler */
if (!NotifyObj)
{
goto UnlockAndExit;
}
if (HandlerType & ACPI_SYSTEM_NOTIFY)
{
}
if (HandlerType & ACPI_DEVICE_NOTIFY)
{
}
if (HandlerType == ACPI_ALL_NOTIFY)
{
/* Extra ref if installed in both */
}
}
(void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
}
/*******************************************************************************
*
* FUNCTION: AcpiRemoveNotifyHandler
*
* PARAMETERS: Device - The device for which notifies will be handled
* HandlerType - The type of handler:
* ACPI_SYSTEM_NOTIFY: SystemHandler (00-7f)
* ACPI_DEVICE_NOTIFY: DriverHandler (80-ff)
* ACPI_ALL_NOTIFY: both system and device
* Handler - Address of the handler
*
* RETURN: Status
*
* DESCRIPTION: Remove a handler for notifies on an ACPI device
*
******************************************************************************/
{
ACPI_FUNCTION_TRACE ("AcpiRemoveNotifyHandler");
/* Parameter validation */
if ((!Device) ||
(!Handler) ||
{
}
if (ACPI_FAILURE (Status))
{
}
/* Convert and validate the device handle */
if (!Node)
{
goto UnlockAndExit;
}
/* Root Object */
if (Device == ACPI_ROOT_OBJECT)
{
"Removing notify handler for ROOT object.\n"));
if (((HandlerType & ACPI_SYSTEM_NOTIFY) &&
((HandlerType & ACPI_DEVICE_NOTIFY) &&
{
goto UnlockAndExit;
}
if (HandlerType & ACPI_SYSTEM_NOTIFY)
{
}
if (HandlerType & ACPI_DEVICE_NOTIFY)
{
}
}
/* All Other Objects */
else
{
/* Notifies allowed on this object? */
if (!AcpiEvIsNotifyObject (Node))
{
goto UnlockAndExit;
}
/* Check for an existing internal object */
if (!ObjDesc)
{
goto UnlockAndExit;
}
/* Object exists - make sure there's an existing handler */
if (HandlerType & ACPI_SYSTEM_NOTIFY)
{
if ((!NotifyObj) ||
{
goto UnlockAndExit;
}
/* Remove the handler */
}
if (HandlerType & ACPI_DEVICE_NOTIFY)
{
if ((!NotifyObj) ||
{
goto UnlockAndExit;
}
/* Remove the handler */
}
}
(void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
}
/*******************************************************************************
*
* FUNCTION: AcpiInstallGpeHandler
*
* PARAMETERS: GpeDevice - Namespace node for the GPE (NULL for FADT
* defined GPEs)
* GpeNumber - The GPE number within the GPE block
* Type - Whether this GPE should be treated as an
* edge- or level-triggered interrupt.
* Address - Address of the handler
* Context - Value passed to the handler on each GPE
*
* RETURN: Status
*
* DESCRIPTION: Install a handler for a General Purpose Event.
*
******************************************************************************/
void *Context)
{
ACPI_FUNCTION_TRACE ("AcpiInstallGpeHandler");
/* Parameter validation */
{
}
if (ACPI_FAILURE (Status))
{
}
/* Ensure that we have a valid GPE number */
if (!GpeEventInfo)
{
goto UnlockAndExit;
}
/* Make sure that there isn't a handler there already */
{
goto UnlockAndExit;
}
/* Allocate and init handler object */
if (!Handler)
{
goto UnlockAndExit;
}
/* Disable the GPE before installing the handler */
if (ACPI_FAILURE (Status))
{
goto UnlockAndExit;
}
/* Install the handler */
/* Setup up dispatch flags to indicate handler (vs. method) */
(void) AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
}
/*******************************************************************************
*
* FUNCTION: AcpiRemoveGpeHandler
*
* PARAMETERS: GpeDevice - Namespace node for the GPE (NULL for FADT
* defined GPEs)
* GpeNumber - The event to remove a handler
* Address - Address of the handler
*
* RETURN: Status
*
* DESCRIPTION: Remove a handler for a General Purpose AcpiEvent.
*
******************************************************************************/
{
ACPI_FUNCTION_TRACE ("AcpiRemoveGpeHandler");
/* Parameter validation */
if (!Address)
{
}
if (ACPI_FAILURE (Status))
{
}
/* Ensure that we have a valid GPE number */
if (!GpeEventInfo)
{
goto UnlockAndExit;
}
/* Make sure that a handler is indeed installed */
{
goto UnlockAndExit;
}
/* Make sure that the installed handler is the same */
{
goto UnlockAndExit;
}
/* Disable the GPE before removing the handler */
if (ACPI_FAILURE (Status))
{
goto UnlockAndExit;
}
/* Remove the handler */
/* Restore Method node (if any), set dispatch flags */
if (Handler->MethodNode)
{
}
/* Now we can free the handler object */
(void) AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
}
/*******************************************************************************
*
* FUNCTION: AcpiAcquireGlobalLock
*
* PARAMETERS: Timeout - How long the caller is willing to wait
* Handle - Where the handle to the lock is returned
* (if acquired)
*
* RETURN: Status
*
* DESCRIPTION: Acquire the ACPI Global Lock
*
******************************************************************************/
{
if (!Handle)
{
return (AE_BAD_PARAMETER);
}
Status = AcpiExEnterInterpreter ();
if (ACPI_FAILURE (Status))
{
return (Status);
}
if (ACPI_SUCCESS (Status))
{
}
return (Status);
}
/*******************************************************************************
*
* FUNCTION: AcpiReleaseGlobalLock
*
* PARAMETERS: Handle - Returned from AcpiAcquireGlobalLock
*
* RETURN: Status
*
* DESCRIPTION: Release the ACPI Global Lock. The handle must be valid.
*
******************************************************************************/
{
if (Handle != AcpiGbl_GlobalLockHandle)
{
return (AE_NOT_ACQUIRED);
}
return (Status);
}