freebsd-nq/sys/contrib/dev/acpica/evxfregn.c
2001-01-31 09:17:50 +00:00

516 lines
17 KiB
C

/******************************************************************************
*
* Module Name: evxfregn - External Interfaces, ACPI Operation Regions and
* Address Spaces.
* $Revision: 27 $
*
*****************************************************************************/
/******************************************************************************
*
* 1. Copyright Notice
*
* Some or all of this work - Copyright (c) 1999, 2000, 2001, 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
* documentation and/or other materials provided with distribution. In
* 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
* provision in the documentation and/or other materials provided with the
* 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
* ensure that the distribution and export/re-export of the software is in
* compliance with all laws, regulations, orders, or other restrictions of the
* U.S. Export Administration Regulations. Licensee agrees that neither it nor
* any of its subsidiaries will export/re-export any technical data, process,
* 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 __EVXFREGN_C__
#include "acpi.h"
#include "achware.h"
#include "acnamesp.h"
#include "acevents.h"
#include "amlcode.h"
#include "acinterp.h"
#define _COMPONENT EVENT_HANDLING
MODULE_NAME ("evxfregn")
/******************************************************************************
*
* FUNCTION: AcpiInstallAddressSpaceHandler
*
* PARAMETERS: Device - Handle for the device
* SpaceId - The address space ID
* Handler - Address of the handler
* Setup - Address of the setup function
* Context - Value passed to the handler on each access
*
* RETURN: Status
*
* DESCRIPTION: Install a handler for all OpRegions of a given SpaceId.
*
******************************************************************************/
ACPI_STATUS
AcpiInstallAddressSpaceHandler (
ACPI_HANDLE Device,
ACPI_ADDRESS_SPACE_TYPE SpaceId,
ADDRESS_SPACE_HANDLER Handler,
ADDRESS_SPACE_SETUP Setup,
void *Context)
{
ACPI_OPERAND_OBJECT *ObjDesc;
ACPI_OPERAND_OBJECT *HandlerObj;
ACPI_NAMESPACE_NODE *Node;
ACPI_STATUS Status = AE_OK;
OBJECT_TYPE_INTERNAL Type;
UINT16 Flags = 0;
FUNCTION_TRACE ("AcpiInstallAddressSpaceHandler");
/* Parameter validation */
if ((!Device) ||
((!Handler) && (Handler != ACPI_DEFAULT_HANDLER)) ||
(SpaceId > ACPI_MAX_ADDRESS_SPACE))
{
return_ACPI_STATUS (AE_BAD_PARAMETER);
}
AcpiCmAcquireMutex (ACPI_MTX_NAMESPACE);
/* Convert and validate the device handle */
Node = AcpiNsConvertHandleToEntry (Device);
if (!Node)
{
Status = AE_BAD_PARAMETER;
goto UnlockAndExit;
}
/*
* This registration is valid for only the types below
* and the root. This is where the default handlers
* get placed.
*/
if ((Node->Type != ACPI_TYPE_DEVICE) &&
(Node->Type != ACPI_TYPE_PROCESSOR) &&
(Node->Type != ACPI_TYPE_THERMAL) &&
(Node != AcpiGbl_RootNode))
{
Status = AE_BAD_PARAMETER;
goto UnlockAndExit;
}
if (Handler == ACPI_DEFAULT_HANDLER)
{
Flags = ADDR_HANDLER_DEFAULT_INSTALLED;
switch (SpaceId)
{
case ADDRESS_SPACE_SYSTEM_MEMORY:
Handler = AcpiAmlSystemMemorySpaceHandler;
Setup = AcpiEvSystemMemoryRegionSetup;
break;
case ADDRESS_SPACE_SYSTEM_IO:
Handler = AcpiAmlSystemIoSpaceHandler;
Setup = AcpiEvIoSpaceRegionSetup;
break;
case ADDRESS_SPACE_PCI_CONFIG:
Handler = AcpiAmlPciConfigSpaceHandler;
Setup = AcpiEvPciConfigRegionSetup;
break;
default:
Status = AE_NOT_EXIST;
goto UnlockAndExit;
break;
}
}
/*
* If the caller hasn't specified a setup routine, use the default
*/
if (!Setup)
{
Setup = AcpiEvDefaultRegionSetup;
}
/*
* Check for an existing internal object
*/
ObjDesc = AcpiNsGetAttachedObject ((ACPI_HANDLE) Node);
if (ObjDesc)
{
/*
* The object exists.
* Make sure the handler is not already installed.
*/
/* check the address handler the user requested */
HandlerObj = ObjDesc->Device.AddrHandler;
while (HandlerObj)
{
/*
* We have an Address handler, see if user requested this
* address space.
*/
if(HandlerObj->AddrHandler.SpaceId == SpaceId)
{
Status = AE_EXIST;
goto UnlockAndExit;
}
/*
* Move through the linked list of handlers
*/
HandlerObj = HandlerObj->AddrHandler.Next;
}
}
else
{
DEBUG_PRINT (TRACE_OPREGION,
("Creating object on Device %p while installing handler\n",
Node));
/* ObjDesc does not exist, create one */
if (Node->Type == ACPI_TYPE_ANY)
{
Type = ACPI_TYPE_DEVICE;
}
else
{
Type = Node->Type;
}
ObjDesc = AcpiCmCreateInternalObject (Type);
if (!ObjDesc)
{
Status = AE_NO_MEMORY;
goto UnlockAndExit;
}
/* Init new descriptor */
ObjDesc->Common.Type = (UINT8) Type;
/* Attach the new object to the Node */
Status = AcpiNsAttachObject (Node, ObjDesc, (UINT8) Type);
if (ACPI_FAILURE (Status))
{
AcpiCmRemoveReference (ObjDesc);
goto UnlockAndExit;
}
}
DEBUG_PRINT (TRACE_OPREGION,
("Installing address handler for region %s(%X) on Device %p(%p)\n",
AcpiCmGetRegionName (SpaceId), SpaceId, Node, ObjDesc));
/*
* Now we can install the handler
*
* At this point we know that there is no existing handler.
* So, we just allocate the object for the handler and link it
* into the list.
*/
HandlerObj = AcpiCmCreateInternalObject (INTERNAL_TYPE_ADDRESS_HANDLER);
if (!HandlerObj)
{
Status = AE_NO_MEMORY;
goto UnlockAndExit;
}
HandlerObj->AddrHandler.SpaceId = (UINT8) SpaceId;
HandlerObj->AddrHandler.Hflags = Flags;
HandlerObj->AddrHandler.Next = ObjDesc->Device.AddrHandler;
HandlerObj->AddrHandler.RegionList = NULL;
HandlerObj->AddrHandler.Node = Node;
HandlerObj->AddrHandler.Handler = Handler;
HandlerObj->AddrHandler.Context = Context;
HandlerObj->AddrHandler.Setup = Setup;
/*
* Now walk the namespace finding all of the regions this
* handler will manage.
*
* We start at the device and search the branch toward
* the leaf nodes until either the leaf is encountered or
* a device is detected that has an address handler of the
* same type.
*
* In either case we back up and search down the remainder
* of the branch
*/
Status = AcpiNsWalkNamespace (ACPI_TYPE_ANY, Device,
ACPI_UINT32_MAX, NS_WALK_UNLOCK,
AcpiEvAddrHandlerHelper,
HandlerObj, NULL);
/*
* Place this handler 1st on the list
*/
HandlerObj->Common.ReferenceCount =
(UINT16) (HandlerObj->Common.ReferenceCount +
ObjDesc->Common.ReferenceCount - 1);
ObjDesc->Device.AddrHandler = HandlerObj;
UnlockAndExit:
AcpiCmReleaseMutex (ACPI_MTX_NAMESPACE);
return_ACPI_STATUS (Status);
}
/******************************************************************************
*
* FUNCTION: AcpiRemoveAddressSpaceHandler
*
* PARAMETERS: SpaceId - The address space ID
* Handler - Address of the handler
*
* RETURN: Status
*
* DESCRIPTION: Install a handler for accesses on an Operation Region
*
******************************************************************************/
ACPI_STATUS
AcpiRemoveAddressSpaceHandler (
ACPI_HANDLE Device,
ACPI_ADDRESS_SPACE_TYPE SpaceId,
ADDRESS_SPACE_HANDLER Handler)
{
ACPI_OPERAND_OBJECT *ObjDesc;
ACPI_OPERAND_OBJECT *HandlerObj;
ACPI_OPERAND_OBJECT *RegionObj;
ACPI_OPERAND_OBJECT **LastObjPtr;
ACPI_NAMESPACE_NODE *Node;
ACPI_STATUS Status = AE_OK;
FUNCTION_TRACE ("AcpiRemoveAddressSpaceHandler");
/* Parameter validation */
if ((!Device) ||
((!Handler) && (Handler != ACPI_DEFAULT_HANDLER)) ||
(SpaceId > ACPI_MAX_ADDRESS_SPACE))
{
return_ACPI_STATUS (AE_BAD_PARAMETER);
}
AcpiCmAcquireMutex (ACPI_MTX_NAMESPACE);
/* Convert and validate the device handle */
Node = AcpiNsConvertHandleToEntry (Device);
if (!Node)
{
Status = AE_BAD_PARAMETER;
goto UnlockAndExit;
}
/* Make sure the internal object exists */
ObjDesc = AcpiNsGetAttachedObject ((ACPI_HANDLE) Node);
if (!ObjDesc)
{
/*
* The object DNE.
*/
Status = AE_NOT_EXIST;
goto UnlockAndExit;
}
/*
* find the address handler the user requested
*/
HandlerObj = ObjDesc->Device.AddrHandler;
LastObjPtr = &ObjDesc->Device.AddrHandler;
while (HandlerObj)
{
/*
* We have a handler, see if user requested this one
*/
if(HandlerObj->AddrHandler.SpaceId == SpaceId)
{
/*
* Got it, first dereference this in the Regions
*/
DEBUG_PRINT (TRACE_OPREGION,
("Removing address handler %p(%p) for region %s on Device %p(%p)\n",
HandlerObj, Handler, AcpiCmGetRegionName (SpaceId),
Node, ObjDesc));
RegionObj = HandlerObj->AddrHandler.RegionList;
/* Walk the handler's region list */
while (RegionObj)
{
/*
* First disassociate the handler from the region.
*
* NOTE: this doesn't mean that the region goes away
* The region is just inaccessible as indicated to
* the _REG method
*/
AcpiEvDisassociateRegionFromHandler(RegionObj, FALSE);
/*
* Walk the list, since we took the first region and it
* was removed from the list by the dissassociate call
* we just get the first item on the list again
*/
RegionObj = HandlerObj->AddrHandler.RegionList;
}
/*
* Remove this Handler object from the list
*/
*LastObjPtr = HandlerObj->AddrHandler.Next;
/*
* Now we can delete the handler object
*/
AcpiCmRemoveReference (HandlerObj);
AcpiCmRemoveReference (HandlerObj);
goto UnlockAndExit;
}
/*
* Move through the linked list of handlers
*/
LastObjPtr = &HandlerObj->AddrHandler.Next;
HandlerObj = HandlerObj->AddrHandler.Next;
}
/*
* The handler does not exist
*/
DEBUG_PRINT (TRACE_OPREGION,
("Unable to remove address handler %p for %s(%X), DevNode %p, obj %p\n",
Handler, AcpiCmGetRegionName (SpaceId), SpaceId, Node, ObjDesc));
Status = AE_NOT_EXIST;
UnlockAndExit:
AcpiCmReleaseMutex (ACPI_MTX_NAMESPACE);
return_ACPI_STATUS (Status);
}