drivers/acpica/evxfregn.c

0001 /******************************************************************************
0002  *
0003  * Module Name: evxfregn - External Interfaces, ACPI Operation Regions and
0004  *                         Address Spaces.
0005  *
0006  *****************************************************************************/
0007
0008 /******************************************************************************
0009  *
0010  * 1. Copyright Notice
0011  *
0012  * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp.
0013  * All rights reserved.
0014  *
0015  * 2. License
0016  *
0017  * 2.1. This is your license from Intel Corp. under its intellectual property
0018  * rights.  You may have additional license terms from the party that provided
0019  * you this software, covering your right to use that party's intellectual
0020  * property rights.
0021  *
0022  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0023  * copy of the source code appearing in this file ("Covered Code") an
0024  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0025  * base code distributed originally by Intel ("Original Intel Code") to copy,
0026  * make derivatives, distribute, use and display any portion of the Covered
0027  * Code in any form, with the right to sublicense such rights; and
0028  *
0029  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0030  * license (with the right to sublicense), under only those claims of Intel
0031  * patents that are infringed by the Original Intel Code, to make, use, sell,
0032  * offer to sell, and import the Covered Code and derivative works thereof
0033  * solely to the minimum extent necessary to exercise the above copyright
0034  * license, and in no event shall the patent license extend to any additions
0035  * to or modifications of the Original Intel Code.  No other license or right
0036  * is granted directly or by implication, estoppel or otherwise;
0037  *
0038  * The above copyright and patent license is granted only if the following
0039  * conditions are met:
0040  *
0041  * 3. Conditions
0042  *
0043  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0044  * Redistribution of source code of any substantial portion of the Covered
0045  * Code or modification with rights to further distribute source must include
0046  * the above Copyright Notice, the above License, this list of Conditions,
0047  * and the following Disclaimer and Export Compliance provision.  In addition,
0048  * Licensee must cause all Covered Code to which Licensee contributes to
0049  * contain a file documenting the changes Licensee made to create that Covered
0050  * Code and the date of any change.  Licensee must include in that file the
0051  * documentation of any changes made by any predecessor Licensee.  Licensee
0052  * must include a prominent statement that the modification is derived,
0053  * directly or indirectly, from Original Intel Code.
0054  *
0055  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0056  * Redistribution of source code of any substantial portion of the Covered
0057  * Code or modification without rights to further distribute source must
0058  * include the following Disclaimer and Export Compliance provision in the
0059  * documentation and/or other materials provided with distribution.  In
0060  * addition, Licensee may not authorize further sublicense of source of any
0061  * portion of the Covered Code, and must include terms to the effect that the
0062  * license from Licensee to its licensee is limited to the intellectual
0063  * property embodied in the software Licensee provides to its licensee, and
0064  * not to intellectual property embodied in modifications its licensee may
0065  * make.
0066  *
0067  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0068  * substantial portion of the Covered Code or modification must reproduce the
0069  * above Copyright Notice, and the following Disclaimer and Export Compliance
0070  * provision in the documentation and/or other materials provided with the
0071  * distribution.
0072  *
0073  * 3.4. Intel retains all right, title, and interest in and to the Original
0074  * Intel Code.
0075  *
0076  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0077  * Intel shall be used in advertising or otherwise to promote the sale, use or
0078  * other dealings in products derived from or relating to the Covered Code
0079  * without prior written authorization from Intel.
0080  *
0081  * 4. Disclaimer and Export Compliance
0082  *
0083  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0084  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0085  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
0086  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
0087  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
0088  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0089  * PARTICULAR PURPOSE.
0090  *
0091  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0092  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0093  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0094  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0095  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0096  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
0097  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0098  * LIMITED REMEDY.
0099  *
0100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0101  * software or system incorporating such software without first obtaining any
0102  * required license or other approval from the U. S. Department of Commerce or
0103  * any other agency or department of the United States Government.  In the
0104  * event Licensee exports any such software from the United States or
0105  * re-exports any such software from a foreign destination, Licensee shall
0106  * ensure that the distribution and export/re-export of the software is in
0107  * compliance with all laws, regulations, orders, or other restrictions of the
0108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0109  * any of its subsidiaries will export/re-export any technical data, process,
0110  * software, or service, directly or indirectly, to any country for which the
0111  * United States government or any agency thereof requires an export license,
0112  * other governmental approval, or letter of assurance, without first obtaining
0113  * such license, approval or letter.
0114  *
0115  *****************************************************************************/
0116
0117 #define __EVXFREGN_C__
0118
0119 #include "acpi.h"
0120 #include "accommon.h"
0121 #include "acnamesp.h"
0122 #include "acevents.h"
0123
0124 #define _COMPONENT          ACPI_EVENTS
0125         ACPI_MODULE_NAME    ("evxfregn")
0126
0127
0128 /*******************************************************************************
0129  *
0130  * FUNCTION:    AcpiInstallAddressSpaceHandler
0131  *
0132  * PARAMETERS:  Device          - Handle for the device
0133  *              SpaceId         - The address space ID
0134  *              Handler         - Address of the handler
0135  *              Setup           - Address of the setup function
0136  *              Context         - Value passed to the handler on each access
0137  *
0138  * RETURN:      Status
0139  *
0140  * DESCRIPTION: Install a handler for all OpRegions of a given SpaceId.
0141  *
0142  ******************************************************************************/
0143
0144 ACPI_STATUS
0145 AcpiInstallAddressSpaceHandler (
0146     ACPI_HANDLE             Device,
0147     ACPI_ADR_SPACE_TYPE     SpaceId,
0148     ACPI_ADR_SPACE_HANDLER  Handler,
0149     ACPI_ADR_SPACE_SETUP    Setup,
0150     void                    *Context)
0151 {
0152     ACPI_NAMESPACE_NODE     *Node;
0153     ACPI_STATUS             Status;
0154
0155
0156     ACPI_FUNCTION_TRACE (AcpiInstallAddressSpaceHandler);
0157
0158
0159     /* Parameter validation */
0160
0161     if (!Device)
0162     {
0163         return_ACPI_STATUS (AE_BAD_PARAMETER);
0164     }
0165
0166     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
0167     if (ACPI_FAILURE (Status))
0168     {
0169         return_ACPI_STATUS (Status);
0170     }
0171
0172     /* Convert and validate the device handle */
0173
0174     Node = AcpiNsMapHandleToNode (Device);
0175     if (!Node)
0176     {
0177         Status = AE_BAD_PARAMETER;
0178         goto UnlockAndExit;
0179     }
0180
0181     /* Install the handler for all Regions for this Space ID */
0182
0183     Status = AcpiEvInstallSpaceHandler (Node, SpaceId, Handler, Setup, Context);
0184     if (ACPI_FAILURE (Status))
0185     {
0186         goto UnlockAndExit;
0187     }
0188
0189     /* Run all _REG methods for this address space */
0190
0191     Status = AcpiEvExecuteRegMethods (Node, SpaceId);
0192
0193 UnlockAndExit:
0194     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
0195     return_ACPI_STATUS (Status);
0196 }
0197
0198 ACPI_EXPORT_SYMBOL (AcpiInstallAddressSpaceHandler)
0199
0200
0201 /*******************************************************************************
0202  *
0203  * FUNCTION:    AcpiRemoveAddressSpaceHandler
0204  *
0205  * PARAMETERS:  Device          - Handle for the device
0206  *              SpaceId         - The address space ID
0207  *              Handler         - Address of the handler
0208  *
0209  * RETURN:      Status
0210  *
0211  * DESCRIPTION: Remove a previously installed handler.
0212  *
0213  ******************************************************************************/
0214
0215 ACPI_STATUS
0216 AcpiRemoveAddressSpaceHandler (
0217     ACPI_HANDLE             Device,
0218     ACPI_ADR_SPACE_TYPE     SpaceId,
0219     ACPI_ADR_SPACE_HANDLER  Handler)
0220 {
0221     ACPI_OPERAND_OBJECT     *ObjDesc;
0222     ACPI_OPERAND_OBJECT     *HandlerObj;
0223     ACPI_OPERAND_OBJECT     *RegionObj;
0224     ACPI_OPERAND_OBJECT     **LastObjPtr;
0225     ACPI_NAMESPACE_NODE     *Node;
0226     ACPI_STATUS             Status;
0227
0228
0229     ACPI_FUNCTION_TRACE (AcpiRemoveAddressSpaceHandler);
0230
0231
0232     /* Parameter validation */
0233
0234     if (!Device)
0235     {
0236         return_ACPI_STATUS (AE_BAD_PARAMETER);
0237     }
0238
0239     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
0240     if (ACPI_FAILURE (Status))
0241     {
0242         return_ACPI_STATUS (Status);
0243     }
0244
0245     /* Convert and validate the device handle */
0246
0247     Node = AcpiNsMapHandleToNode (Device);
0248     if (!Node ||
0249         ((Node->Type != ACPI_TYPE_DEVICE)    &&
0250          (Node->Type != ACPI_TYPE_PROCESSOR) &&
0251          (Node->Type != ACPI_TYPE_THERMAL)   &&
0252          (Node != AcpiGbl_RootNode)))
0253     {
0254         Status = AE_BAD_PARAMETER;
0255         goto UnlockAndExit;
0256     }
0257
0258     /* Make sure the internal object exists */
0259
0260     ObjDesc = AcpiNsGetAttachedObject (Node);
0261     if (!ObjDesc)
0262     {
0263         Status = AE_NOT_EXIST;
0264         goto UnlockAndExit;
0265     }
0266
0267     /* Find the address handler the user requested */
0268
0269     HandlerObj = ObjDesc->Device.Handler;
0270     LastObjPtr = &ObjDesc->Device.Handler;
0271     while (HandlerObj)
0272     {
0273         /* We have a handler, see if user requested this one */
0274
0275         if (HandlerObj->AddressSpace.SpaceId == SpaceId)
0276         {
0277             /* Handler must be the same as the installed handler */
0278
0279             if (HandlerObj->AddressSpace.Handler != Handler)
0280             {
0281                 Status = AE_BAD_PARAMETER;
0282                 goto UnlockAndExit;
0283             }
0284
0285             /* Matched SpaceId, first dereference this in the Regions */
0286
0287             ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
0288                 "Removing address handler %p(%p) for region %s "
0289                 "on Device %p(%p)\n",
0290                 HandlerObj, Handler, AcpiUtGetRegionName (SpaceId),
0291                 Node, ObjDesc));
0292
0293             RegionObj = HandlerObj->AddressSpace.RegionList;
0294
0295             /* Walk the handler's region list */
0296
0297             while (RegionObj)
0298             {
0299                 /*
0300                  * First disassociate the handler from the region.
0301                  *
0302                  * NOTE: this doesn't mean that the region goes away
0303                  * The region is just inaccessible as indicated to
0304                  * the _REG method
0305                  */
0306                 AcpiEvDetachRegion (RegionObj, TRUE);
0307
0308                 /*
0309                  * Walk the list: Just grab the head because the
0310                  * DetachRegion removed the previous head.
0311                  */
0312                 RegionObj = HandlerObj->AddressSpace.RegionList;
0313
0314             }
0315
0316             /* Remove this Handler object from the list */
0317
0318             *LastObjPtr = HandlerObj->AddressSpace.Next;
0319
0320             /* Now we can delete the handler object */
0321
0322             AcpiUtRemoveReference (HandlerObj);
0323             goto UnlockAndExit;
0324         }
0325
0326         /* Walk the linked list of handlers */
0327
0328         LastObjPtr = &HandlerObj->AddressSpace.Next;
0329         HandlerObj = HandlerObj->AddressSpace.Next;
0330     }
0331
0332     /* The handler does not exist */
0333
0334     ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
0335         "Unable to remove address handler %p for %s(%X), DevNode %p, obj %p\n",
0336         Handler, AcpiUtGetRegionName (SpaceId), SpaceId, Node, ObjDesc));
0337
0338     Status = AE_NOT_EXIST;
0339
0340 UnlockAndExit:
0341     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
0342     return_ACPI_STATUS (Status);
0343 }
0344
0345 ACPI_EXPORT_SYMBOL (AcpiRemoveAddressSpaceHandler)
0346