xref: /onnv-gate/usr/src/uts/intel/io/acpica/events/evxfregn.c (revision 9980:13d7f3eec672)
13446Smrj /******************************************************************************
23446Smrj  *
33446Smrj  * Module Name: evxfregn - External Interfaces, ACPI Operation Regions and
43446Smrj  *                         Address Spaces.
53446Smrj  *
63446Smrj  *****************************************************************************/
73446Smrj 
83446Smrj /******************************************************************************
93446Smrj  *
103446Smrj  * 1. Copyright Notice
113446Smrj  *
12*9980SDana.Myers@Sun.COM  * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp.
133446Smrj  * All rights reserved.
143446Smrj  *
153446Smrj  * 2. License
163446Smrj  *
173446Smrj  * 2.1. This is your license from Intel Corp. under its intellectual property
183446Smrj  * rights.  You may have additional license terms from the party that provided
193446Smrj  * you this software, covering your right to use that party's intellectual
203446Smrj  * property rights.
213446Smrj  *
223446Smrj  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
233446Smrj  * copy of the source code appearing in this file ("Covered Code") an
243446Smrj  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
253446Smrj  * base code distributed originally by Intel ("Original Intel Code") to copy,
263446Smrj  * make derivatives, distribute, use and display any portion of the Covered
273446Smrj  * Code in any form, with the right to sublicense such rights; and
283446Smrj  *
293446Smrj  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
303446Smrj  * license (with the right to sublicense), under only those claims of Intel
313446Smrj  * patents that are infringed by the Original Intel Code, to make, use, sell,
323446Smrj  * offer to sell, and import the Covered Code and derivative works thereof
333446Smrj  * solely to the minimum extent necessary to exercise the above copyright
343446Smrj  * license, and in no event shall the patent license extend to any additions
353446Smrj  * to or modifications of the Original Intel Code.  No other license or right
363446Smrj  * is granted directly or by implication, estoppel or otherwise;
373446Smrj  *
383446Smrj  * The above copyright and patent license is granted only if the following
393446Smrj  * conditions are met:
403446Smrj  *
413446Smrj  * 3. Conditions
423446Smrj  *
433446Smrj  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
443446Smrj  * Redistribution of source code of any substantial portion of the Covered
453446Smrj  * Code or modification with rights to further distribute source must include
463446Smrj  * the above Copyright Notice, the above License, this list of Conditions,
473446Smrj  * and the following Disclaimer and Export Compliance provision.  In addition,
483446Smrj  * Licensee must cause all Covered Code to which Licensee contributes to
493446Smrj  * contain a file documenting the changes Licensee made to create that Covered
503446Smrj  * Code and the date of any change.  Licensee must include in that file the
513446Smrj  * documentation of any changes made by any predecessor Licensee.  Licensee
523446Smrj  * must include a prominent statement that the modification is derived,
533446Smrj  * directly or indirectly, from Original Intel Code.
543446Smrj  *
553446Smrj  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
563446Smrj  * Redistribution of source code of any substantial portion of the Covered
573446Smrj  * Code or modification without rights to further distribute source must
583446Smrj  * include the following Disclaimer and Export Compliance provision in the
593446Smrj  * documentation and/or other materials provided with distribution.  In
603446Smrj  * addition, Licensee may not authorize further sublicense of source of any
613446Smrj  * portion of the Covered Code, and must include terms to the effect that the
623446Smrj  * license from Licensee to its licensee is limited to the intellectual
633446Smrj  * property embodied in the software Licensee provides to its licensee, and
643446Smrj  * not to intellectual property embodied in modifications its licensee may
653446Smrj  * make.
663446Smrj  *
673446Smrj  * 3.3. Redistribution of Executable. Redistribution in executable form of any
683446Smrj  * substantial portion of the Covered Code or modification must reproduce the
693446Smrj  * above Copyright Notice, and the following Disclaimer and Export Compliance
703446Smrj  * provision in the documentation and/or other materials provided with the
713446Smrj  * distribution.
723446Smrj  *
733446Smrj  * 3.4. Intel retains all right, title, and interest in and to the Original
743446Smrj  * Intel Code.
753446Smrj  *
763446Smrj  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
773446Smrj  * Intel shall be used in advertising or otherwise to promote the sale, use or
783446Smrj  * other dealings in products derived from or relating to the Covered Code
793446Smrj  * without prior written authorization from Intel.
803446Smrj  *
813446Smrj  * 4. Disclaimer and Export Compliance
823446Smrj  *
833446Smrj  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
843446Smrj  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
853446Smrj  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
863446Smrj  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
873446Smrj  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
883446Smrj  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
893446Smrj  * PARTICULAR PURPOSE.
903446Smrj  *
913446Smrj  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
923446Smrj  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
933446Smrj  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
943446Smrj  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
953446Smrj  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
963446Smrj  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
973446Smrj  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
983446Smrj  * LIMITED REMEDY.
993446Smrj  *
1003446Smrj  * 4.3. Licensee shall not export, either directly or indirectly, any of this
1013446Smrj  * software or system incorporating such software without first obtaining any
1023446Smrj  * required license or other approval from the U. S. Department of Commerce or
1033446Smrj  * any other agency or department of the United States Government.  In the
1043446Smrj  * event Licensee exports any such software from the United States or
1053446Smrj  * re-exports any such software from a foreign destination, Licensee shall
1063446Smrj  * ensure that the distribution and export/re-export of the software is in
1073446Smrj  * compliance with all laws, regulations, orders, or other restrictions of the
1083446Smrj  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
1093446Smrj  * any of its subsidiaries will export/re-export any technical data, process,
1103446Smrj  * software, or service, directly or indirectly, to any country for which the
1113446Smrj  * United States government or any agency thereof requires an export license,
1123446Smrj  * other governmental approval, or letter of assurance, without first obtaining
1133446Smrj  * such license, approval or letter.
1143446Smrj  *
1153446Smrj  *****************************************************************************/
1163446Smrj 
1173446Smrj #define __EVXFREGN_C__
1183446Smrj 
1193446Smrj #include "acpi.h"
120*9980SDana.Myers@Sun.COM #include "accommon.h"
1213446Smrj #include "acnamesp.h"
1223446Smrj #include "acevents.h"
1233446Smrj 
1243446Smrj #define _COMPONENT          ACPI_EVENTS
1253446Smrj         ACPI_MODULE_NAME    ("evxfregn")
1263446Smrj 
1273446Smrj 
1283446Smrj /*******************************************************************************
1293446Smrj  *
1303446Smrj  * FUNCTION:    AcpiInstallAddressSpaceHandler
1313446Smrj  *
1323446Smrj  * PARAMETERS:  Device          - Handle for the device
1333446Smrj  *              SpaceId         - The address space ID
1343446Smrj  *              Handler         - Address of the handler
1353446Smrj  *              Setup           - Address of the setup function
1363446Smrj  *              Context         - Value passed to the handler on each access
1373446Smrj  *
1383446Smrj  * RETURN:      Status
1393446Smrj  *
1403446Smrj  * DESCRIPTION: Install a handler for all OpRegions of a given SpaceId.
1413446Smrj  *
1423446Smrj  ******************************************************************************/
1433446Smrj 
1443446Smrj ACPI_STATUS
AcpiInstallAddressSpaceHandler(ACPI_HANDLE Device,ACPI_ADR_SPACE_TYPE SpaceId,ACPI_ADR_SPACE_HANDLER Handler,ACPI_ADR_SPACE_SETUP Setup,void * Context)1453446Smrj AcpiInstallAddressSpaceHandler (
1463446Smrj     ACPI_HANDLE             Device,
1473446Smrj     ACPI_ADR_SPACE_TYPE     SpaceId,
1483446Smrj     ACPI_ADR_SPACE_HANDLER  Handler,
1493446Smrj     ACPI_ADR_SPACE_SETUP    Setup,
1503446Smrj     void                    *Context)
1513446Smrj {
1523446Smrj     ACPI_NAMESPACE_NODE     *Node;
1533446Smrj     ACPI_STATUS             Status;
1543446Smrj 
1553446Smrj 
1563446Smrj     ACPI_FUNCTION_TRACE (AcpiInstallAddressSpaceHandler);
1573446Smrj 
1583446Smrj 
1593446Smrj     /* Parameter validation */
1603446Smrj 
1613446Smrj     if (!Device)
1623446Smrj     {
1633446Smrj         return_ACPI_STATUS (AE_BAD_PARAMETER);
1643446Smrj     }
1653446Smrj 
1663446Smrj     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
1673446Smrj     if (ACPI_FAILURE (Status))
1683446Smrj     {
1693446Smrj         return_ACPI_STATUS (Status);
1703446Smrj     }
1713446Smrj 
1723446Smrj     /* Convert and validate the device handle */
1733446Smrj 
1743446Smrj     Node = AcpiNsMapHandleToNode (Device);
1753446Smrj     if (!Node)
1763446Smrj     {
1773446Smrj         Status = AE_BAD_PARAMETER;
1783446Smrj         goto UnlockAndExit;
1793446Smrj     }
1803446Smrj 
1813446Smrj     /* Install the handler for all Regions for this Space ID */
1823446Smrj 
1833446Smrj     Status = AcpiEvInstallSpaceHandler (Node, SpaceId, Handler, Setup, Context);
1843446Smrj     if (ACPI_FAILURE (Status))
1853446Smrj     {
1863446Smrj         goto UnlockAndExit;
1873446Smrj     }
1883446Smrj 
1893446Smrj     /* Run all _REG methods for this address space */
1903446Smrj 
1913446Smrj     Status = AcpiEvExecuteRegMethods (Node, SpaceId);
1923446Smrj 
1933446Smrj UnlockAndExit:
1943446Smrj     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
1953446Smrj     return_ACPI_STATUS (Status);
1963446Smrj }
1973446Smrj 
ACPI_EXPORT_SYMBOL(AcpiInstallAddressSpaceHandler)1983446Smrj ACPI_EXPORT_SYMBOL (AcpiInstallAddressSpaceHandler)
1993446Smrj 
2003446Smrj 
2013446Smrj /*******************************************************************************
2023446Smrj  *
2033446Smrj  * FUNCTION:    AcpiRemoveAddressSpaceHandler
2043446Smrj  *
2053446Smrj  * PARAMETERS:  Device          - Handle for the device
2063446Smrj  *              SpaceId         - The address space ID
2073446Smrj  *              Handler         - Address of the handler
2083446Smrj  *
2093446Smrj  * RETURN:      Status
2103446Smrj  *
2113446Smrj  * DESCRIPTION: Remove a previously installed handler.
2123446Smrj  *
2133446Smrj  ******************************************************************************/
2143446Smrj 
2153446Smrj ACPI_STATUS
2163446Smrj AcpiRemoveAddressSpaceHandler (
2173446Smrj     ACPI_HANDLE             Device,
2183446Smrj     ACPI_ADR_SPACE_TYPE     SpaceId,
2193446Smrj     ACPI_ADR_SPACE_HANDLER  Handler)
2203446Smrj {
2213446Smrj     ACPI_OPERAND_OBJECT     *ObjDesc;
2223446Smrj     ACPI_OPERAND_OBJECT     *HandlerObj;
2233446Smrj     ACPI_OPERAND_OBJECT     *RegionObj;
2243446Smrj     ACPI_OPERAND_OBJECT     **LastObjPtr;
2253446Smrj     ACPI_NAMESPACE_NODE     *Node;
2263446Smrj     ACPI_STATUS             Status;
2273446Smrj 
2283446Smrj 
2293446Smrj     ACPI_FUNCTION_TRACE (AcpiRemoveAddressSpaceHandler);
2303446Smrj 
2313446Smrj 
2323446Smrj     /* Parameter validation */
2333446Smrj 
2343446Smrj     if (!Device)
2353446Smrj     {
2363446Smrj         return_ACPI_STATUS (AE_BAD_PARAMETER);
2373446Smrj     }
2383446Smrj 
2393446Smrj     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
2403446Smrj     if (ACPI_FAILURE (Status))
2413446Smrj     {
2423446Smrj         return_ACPI_STATUS (Status);
2433446Smrj     }
2443446Smrj 
2453446Smrj     /* Convert and validate the device handle */
2463446Smrj 
2473446Smrj     Node = AcpiNsMapHandleToNode (Device);
2483446Smrj     if (!Node ||
2493446Smrj         ((Node->Type != ACPI_TYPE_DEVICE)    &&
2503446Smrj          (Node->Type != ACPI_TYPE_PROCESSOR) &&
2513446Smrj          (Node->Type != ACPI_TYPE_THERMAL)   &&
2523446Smrj          (Node != AcpiGbl_RootNode)))
2533446Smrj     {
2543446Smrj         Status = AE_BAD_PARAMETER;
2553446Smrj         goto UnlockAndExit;
2563446Smrj     }
2573446Smrj 
2583446Smrj     /* Make sure the internal object exists */
2593446Smrj 
2603446Smrj     ObjDesc = AcpiNsGetAttachedObject (Node);
2613446Smrj     if (!ObjDesc)
2623446Smrj     {
2633446Smrj         Status = AE_NOT_EXIST;
2643446Smrj         goto UnlockAndExit;
2653446Smrj     }
2663446Smrj 
2673446Smrj     /* Find the address handler the user requested */
2683446Smrj 
2693446Smrj     HandlerObj = ObjDesc->Device.Handler;
2703446Smrj     LastObjPtr = &ObjDesc->Device.Handler;
2713446Smrj     while (HandlerObj)
2723446Smrj     {
2733446Smrj         /* We have a handler, see if user requested this one */
2743446Smrj 
2753446Smrj         if (HandlerObj->AddressSpace.SpaceId == SpaceId)
2763446Smrj         {
2773446Smrj             /* Handler must be the same as the installed handler */
2783446Smrj 
2793446Smrj             if (HandlerObj->AddressSpace.Handler != Handler)
2803446Smrj             {
2813446Smrj                 Status = AE_BAD_PARAMETER;
2823446Smrj                 goto UnlockAndExit;
2833446Smrj             }
2843446Smrj 
2853446Smrj             /* Matched SpaceId, first dereference this in the Regions */
2863446Smrj 
2873446Smrj             ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
288*9980SDana.Myers@Sun.COM                 "Removing address handler %p(%p) for region %s "
289*9980SDana.Myers@Sun.COM                 "on Device %p(%p)\n",
2903446Smrj                 HandlerObj, Handler, AcpiUtGetRegionName (SpaceId),
2913446Smrj                 Node, ObjDesc));
2923446Smrj 
2933446Smrj             RegionObj = HandlerObj->AddressSpace.RegionList;
2943446Smrj 
2953446Smrj             /* Walk the handler's region list */
2963446Smrj 
2973446Smrj             while (RegionObj)
2983446Smrj             {
2993446Smrj                 /*
3003446Smrj                  * First disassociate the handler from the region.
3013446Smrj                  *
3023446Smrj                  * NOTE: this doesn't mean that the region goes away
3033446Smrj                  * The region is just inaccessible as indicated to
3043446Smrj                  * the _REG method
3053446Smrj                  */
3063446Smrj                 AcpiEvDetachRegion (RegionObj, TRUE);
3073446Smrj 
3083446Smrj                 /*
3093446Smrj                  * Walk the list: Just grab the head because the
3103446Smrj                  * DetachRegion removed the previous head.
3113446Smrj                  */
3123446Smrj                 RegionObj = HandlerObj->AddressSpace.RegionList;
3133446Smrj 
3143446Smrj             }
3153446Smrj 
3163446Smrj             /* Remove this Handler object from the list */
3173446Smrj 
3183446Smrj             *LastObjPtr = HandlerObj->AddressSpace.Next;
3193446Smrj 
3203446Smrj             /* Now we can delete the handler object */
3213446Smrj 
3223446Smrj             AcpiUtRemoveReference (HandlerObj);
3233446Smrj             goto UnlockAndExit;
3243446Smrj         }
3253446Smrj 
3263446Smrj         /* Walk the linked list of handlers */
3273446Smrj 
3283446Smrj         LastObjPtr = &HandlerObj->AddressSpace.Next;
3293446Smrj         HandlerObj = HandlerObj->AddressSpace.Next;
3303446Smrj     }
3313446Smrj 
3323446Smrj     /* The handler does not exist */
3333446Smrj 
3343446Smrj     ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
3353446Smrj         "Unable to remove address handler %p for %s(%X), DevNode %p, obj %p\n",
3363446Smrj         Handler, AcpiUtGetRegionName (SpaceId), SpaceId, Node, ObjDesc));
3373446Smrj 
3383446Smrj     Status = AE_NOT_EXIST;
3393446Smrj 
3403446Smrj UnlockAndExit:
3413446Smrj     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
3423446Smrj     return_ACPI_STATUS (Status);
3433446Smrj }
3443446Smrj 
3453446Smrj ACPI_EXPORT_SYMBOL (AcpiRemoveAddressSpaceHandler)
3463446Smrj 
347