sys/contrib/dev/acpica/events/evxfregn.c

   1 /******************************************************************************
   2  *
   3  * Module Name: evxfregn - External Interfaces, ACPI Operation Regions and
   4  *                         Address Spaces.
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp.
  13  * All rights reserved.
  14  *
  15  * 2. License
  16  *
  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
  20  * property rights.
  21  *
  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
  28  *
  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;
  37  *
  38  * The above copyright and patent license is granted only if the following
  39  * conditions are met:
  40  *
  41  * 3. Conditions
  42  *
  43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  44  * Redistribution of source code of any substantial portion 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.
  54  *
  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
  65  * make.
  66  *
  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
  71  * distribution.
  72  *
  73  * 3.4. Intel retains all right, title, and interest in and to the Original
  74  * Intel Code.
  75  *
  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.
  80  *
  81  * 4. Disclaimer and Export Compliance
  82  *
  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
  89  * PARTICULAR PURPOSE.
  90  *
  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
  98  * LIMITED REMEDY.
  99  *
 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.
 114  *
 115  *****************************************************************************/
 116
 117 #define __EVXFREGN_C__
 118
 119 #include <contrib/dev/acpica/include/acpi.h>
 120 #include <contrib/dev/acpica/include/accommon.h>
 121 #include <contrib/dev/acpica/include/acnamesp.h>
 122 #include <contrib/dev/acpica/include/acevents.h>
 123
 124 #define _COMPONENT          ACPI_EVENTS
 125         ACPI_MODULE_NAME    ("evxfregn")
 126
 127
 128 /*******************************************************************************
 129  *
 130  * FUNCTION:    AcpiInstallAddressSpaceHandler
 131  *
 132  * PARAMETERS:  Device          - Handle for the device
 133  *              SpaceId         - The address space ID
 134  *              Handler         - Address of the handler
 135  *              Setup           - Address of the setup function
 136  *              Context         - Value passed to the handler on each access
 137  *
 138  * RETURN:      Status
 139  *
 140  * DESCRIPTION: Install a handler for all OpRegions of a given SpaceId.
 141  *
 142  * NOTE: This function should only be called after AcpiEnableSubsystem has
 143  * been called. This is because any _REG methods associated with the Space ID
 144  * are executed here, and these methods can only be safely executed after
 145  * the default handlers have been installed and the hardware has been
 146  * initialized (via AcpiEnableSubsystem.)
 147  *
 148  ******************************************************************************/
 149
 150 ACPI_STATUS
 151 AcpiInstallAddressSpaceHandler (
 152     ACPI_HANDLE             Device,
 153     ACPI_ADR_SPACE_TYPE     SpaceId,
 154     ACPI_ADR_SPACE_HANDLER  Handler,
 155     ACPI_ADR_SPACE_SETUP    Setup,
 156     void                    *Context)
 157 {
 158     ACPI_NAMESPACE_NODE     *Node;
 159     ACPI_STATUS             Status;
 160
 161
 162     ACPI_FUNCTION_TRACE (AcpiInstallAddressSpaceHandler);
 163
 164
 165     /* Parameter validation */
 166
 167     if (!Device)
 168     {
 169         return_ACPI_STATUS (AE_BAD_PARAMETER);
 170     }
 171
 172     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 173     if (ACPI_FAILURE (Status))
 174     {
 175         return_ACPI_STATUS (Status);
 176     }
 177
 178     /* Convert and validate the device handle */
 179
 180     Node = AcpiNsValidateHandle (Device);
 181     if (!Node)
 182     {
 183         Status = AE_BAD_PARAMETER;
 184         goto UnlockAndExit;
 185     }
 186
 187     /* Install the handler for all Regions for this Space ID */
 188
 189     Status = AcpiEvInstallSpaceHandler (Node, SpaceId, Handler, Setup, Context);
 190     if (ACPI_FAILURE (Status))
 191     {
 192         goto UnlockAndExit;
 193     }
 194
 195     /* Run all _REG methods for this address space */
 196
 197     Status = AcpiEvExecuteRegMethods (Node, SpaceId);
 198
 199 UnlockAndExit:
 200     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 201     return_ACPI_STATUS (Status);
 202 }
 203
 204 ACPI_EXPORT_SYMBOL (AcpiInstallAddressSpaceHandler)
 205
 206
 207 /*******************************************************************************
 208  *
 209  * FUNCTION:    AcpiRemoveAddressSpaceHandler
 210  *
 211  * PARAMETERS:  Device          - Handle for the device
 212  *              SpaceId         - The address space ID
 213  *              Handler         - Address of the handler
 214  *
 215  * RETURN:      Status
 216  *
 217  * DESCRIPTION: Remove a previously installed handler.
 218  *
 219  ******************************************************************************/
 220
 221 ACPI_STATUS
 222 AcpiRemoveAddressSpaceHandler (
 223     ACPI_HANDLE             Device,
 224     ACPI_ADR_SPACE_TYPE     SpaceId,
 225     ACPI_ADR_SPACE_HANDLER  Handler)
 226 {
 227     ACPI_OPERAND_OBJECT     *ObjDesc;
 228     ACPI_OPERAND_OBJECT     *HandlerObj;
 229     ACPI_OPERAND_OBJECT     *RegionObj;
 230     ACPI_OPERAND_OBJECT     **LastObjPtr;
 231     ACPI_NAMESPACE_NODE     *Node;
 232     ACPI_STATUS             Status;
 233
 234
 235     ACPI_FUNCTION_TRACE (AcpiRemoveAddressSpaceHandler);
 236
 237
 238     /* Parameter validation */
 239
 240     if (!Device)
 241     {
 242         return_ACPI_STATUS (AE_BAD_PARAMETER);
 243     }
 244
 245     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 246     if (ACPI_FAILURE (Status))
 247     {
 248         return_ACPI_STATUS (Status);
 249     }
 250
 251     /* Convert and validate the device handle */
 252
 253     Node = AcpiNsValidateHandle (Device);
 254     if (!Node ||
 255         ((Node->Type != ACPI_TYPE_DEVICE)    &&
 256          (Node->Type != ACPI_TYPE_PROCESSOR) &&
 257          (Node->Type != ACPI_TYPE_THERMAL)   &&
 258          (Node != AcpiGbl_RootNode)))
 259     {
 260         Status = AE_BAD_PARAMETER;
 261         goto UnlockAndExit;
 262     }
 263
 264     /* Make sure the internal object exists */
 265
 266     ObjDesc = AcpiNsGetAttachedObject (Node);
 267     if (!ObjDesc)
 268     {
 269         Status = AE_NOT_EXIST;
 270         goto UnlockAndExit;
 271     }
 272
 273     /* Find the address handler the user requested */
 274
 275     HandlerObj = ObjDesc->Device.Handler;
 276     LastObjPtr = &ObjDesc->Device.Handler;
 277     while (HandlerObj)
 278     {
 279         /* We have a handler, see if user requested this one */
 280
 281         if (HandlerObj->AddressSpace.SpaceId == SpaceId)
 282         {
 283             /* Handler must be the same as the installed handler */
 284
 285             if (HandlerObj->AddressSpace.Handler != Handler)
 286             {
 287                 Status = AE_BAD_PARAMETER;
 288                 goto UnlockAndExit;
 289             }
 290
 291             /* Matched SpaceId, first dereference this in the Regions */
 292
 293             ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
 294                 "Removing address handler %p(%p) for region %s "
 295                 "on Device %p(%p)\n",
 296                 HandlerObj, Handler, AcpiUtGetRegionName (SpaceId),
 297                 Node, ObjDesc));
 298
 299             RegionObj = HandlerObj->AddressSpace.RegionList;
 300
 301             /* Walk the handler's region list */
 302
 303             while (RegionObj)
 304             {
 305                 /*
 306                  * First disassociate the handler from the region.
 307                  *
 308                  * NOTE: this doesn't mean that the region goes away
 309                  * The region is just inaccessible as indicated to
 310                  * the _REG method
 311                  */
 312                 AcpiEvDetachRegion (RegionObj, TRUE);
 313
 314                 /*
 315                  * Walk the list: Just grab the head because the
 316                  * DetachRegion removed the previous head.
 317                  */
 318                 RegionObj = HandlerObj->AddressSpace.RegionList;
 319
 320             }
 321
 322             /* Remove this Handler object from the list */
 323
 324             *LastObjPtr = HandlerObj->AddressSpace.Next;
 325
 326             /* Now we can delete the handler object */
 327
 328             AcpiUtRemoveReference (HandlerObj);
 329             goto UnlockAndExit;
 330         }
 331
 332         /* Walk the linked list of handlers */
 333
 334         LastObjPtr = &HandlerObj->AddressSpace.Next;
 335         HandlerObj = HandlerObj->AddressSpace.Next;
 336     }
 337
 338     /* The handler does not exist */
 339
 340     ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
 341         "Unable to remove address handler %p for %s(%X), DevNode %p, obj %p\n",
 342         Handler, AcpiUtGetRegionName (SpaceId), SpaceId, Node, ObjDesc));
 343
 344     Status = AE_NOT_EXIST;
 345
 346 UnlockAndExit:
 347     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 348     return_ACPI_STATUS (Status);
 349 }
 350
 351 ACPI_EXPORT_SYMBOL (AcpiRemoveAddressSpaceHandler)
 352