sys/contrib/dev/acpica/source/components/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 - 2018, 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  * Alternatively, you may choose to be licensed under the terms of the
 118  * following license:
 119  *
 120  * Redistribution and use in source and binary forms, with or without
 121  * modification, are permitted provided that the following conditions
 122  * are met:
 123  * 1. Redistributions of source code must retain the above copyright
 124  *    notice, this list of conditions, and the following disclaimer,
 125  *    without modification.
 126  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 127  *    substantially similar to the "NO WARRANTY" disclaimer below
 128  *    ("Disclaimer") and any redistribution must be conditioned upon
 129  *    including a substantially similar Disclaimer requirement for further
 130  *    binary redistribution.
 131  * 3. Neither the names of the above-listed copyright holders nor the names
 132  *    of any contributors may be used to endorse or promote products derived
 133  *    from this software without specific prior written permission.
 134  *
 135  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 136  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 137  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 138  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 139  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 140  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 141  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 142  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 143  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 144  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 145  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 146  *
 147  * Alternatively, you may choose to be licensed under the terms of the
 148  * GNU General Public License ("GPL") version 2 as published by the Free
 149  * Software Foundation.
 150  *
 151  *****************************************************************************/
 152
 153 #define EXPORT_ACPI_INTERFACES
 154
 155 #include "acpi.h"
 156 #include "accommon.h"
 157 #include "acnamesp.h"
 158 #include "acevents.h"
 159
 160 #define _COMPONENT          ACPI_EVENTS
 161         ACPI_MODULE_NAME    ("evxfregn")
 162
 163
 164 /*******************************************************************************
 165  *
 166  * FUNCTION:    AcpiInstallAddressSpaceHandler
 167  *
 168  * PARAMETERS:  Device          - Handle for the device
 169  *              SpaceId         - The address space ID
 170  *              Handler         - Address of the handler
 171  *              Setup           - Address of the setup function
 172  *              Context         - Value passed to the handler on each access
 173  *
 174  * RETURN:      Status
 175  *
 176  * DESCRIPTION: Install a handler for all OpRegions of a given SpaceId.
 177  *
 178  * NOTE: This function should only be called after AcpiEnableSubsystem has
 179  * been called. This is because any _REG methods associated with the Space ID
 180  * are executed here, and these methods can only be safely executed after
 181  * the default handlers have been installed and the hardware has been
 182  * initialized (via AcpiEnableSubsystem.)
 183  *
 184  ******************************************************************************/
 185
 186 ACPI_STATUS
 187 AcpiInstallAddressSpaceHandler (
 188     ACPI_HANDLE             Device,
 189     ACPI_ADR_SPACE_TYPE     SpaceId,
 190     ACPI_ADR_SPACE_HANDLER  Handler,
 191     ACPI_ADR_SPACE_SETUP    Setup,
 192     void                    *Context)
 193 {
 194     ACPI_NAMESPACE_NODE     *Node;
 195     ACPI_STATUS             Status;
 196
 197
 198     ACPI_FUNCTION_TRACE (AcpiInstallAddressSpaceHandler);
 199
 200
 201     /* Parameter validation */
 202
 203     if (!Device)
 204     {
 205         return_ACPI_STATUS (AE_BAD_PARAMETER);
 206     }
 207
 208     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 209     if (ACPI_FAILURE (Status))
 210     {
 211         return_ACPI_STATUS (Status);
 212     }
 213
 214     /* Convert and validate the device handle */
 215
 216     Node = AcpiNsValidateHandle (Device);
 217     if (!Node)
 218     {
 219         Status = AE_BAD_PARAMETER;
 220         goto UnlockAndExit;
 221     }
 222
 223     /* Install the handler for all Regions for this Space ID */
 224
 225     Status = AcpiEvInstallSpaceHandler (
 226         Node, SpaceId, Handler, Setup, Context);
 227     if (ACPI_FAILURE (Status))
 228     {
 229         goto UnlockAndExit;
 230     }
 231
 232     /* Run all _REG methods for this address space */
 233
 234     AcpiEvExecuteRegMethods (Node, SpaceId, ACPI_REG_CONNECT);
 235
 236
 237 UnlockAndExit:
 238     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 239     return_ACPI_STATUS (Status);
 240 }
 241
 242 ACPI_EXPORT_SYMBOL (AcpiInstallAddressSpaceHandler)
 243
 244
 245 /*******************************************************************************
 246  *
 247  * FUNCTION:    AcpiRemoveAddressSpaceHandler
 248  *
 249  * PARAMETERS:  Device          - Handle for the device
 250  *              SpaceId         - The address space ID
 251  *              Handler         - Address of the handler
 252  *
 253  * RETURN:      Status
 254  *
 255  * DESCRIPTION: Remove a previously installed handler.
 256  *
 257  ******************************************************************************/
 258
 259 ACPI_STATUS
 260 AcpiRemoveAddressSpaceHandler (
 261     ACPI_HANDLE             Device,
 262     ACPI_ADR_SPACE_TYPE     SpaceId,
 263     ACPI_ADR_SPACE_HANDLER  Handler)
 264 {
 265     ACPI_OPERAND_OBJECT     *ObjDesc;
 266     ACPI_OPERAND_OBJECT     *HandlerObj;
 267     ACPI_OPERAND_OBJECT     *RegionObj;
 268     ACPI_OPERAND_OBJECT     **LastObjPtr;
 269     ACPI_NAMESPACE_NODE     *Node;
 270     ACPI_STATUS             Status;
 271
 272
 273     ACPI_FUNCTION_TRACE (AcpiRemoveAddressSpaceHandler);
 274
 275
 276     /* Parameter validation */
 277
 278     if (!Device)
 279     {
 280         return_ACPI_STATUS (AE_BAD_PARAMETER);
 281     }
 282
 283     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 284     if (ACPI_FAILURE (Status))
 285     {
 286         return_ACPI_STATUS (Status);
 287     }
 288
 289     /* Convert and validate the device handle */
 290
 291     Node = AcpiNsValidateHandle (Device);
 292     if (!Node ||
 293         ((Node->Type != ACPI_TYPE_DEVICE)    &&
 294          (Node->Type != ACPI_TYPE_PROCESSOR) &&
 295          (Node->Type != ACPI_TYPE_THERMAL)   &&
 296          (Node != AcpiGbl_RootNode)))
 297     {
 298         Status = AE_BAD_PARAMETER;
 299         goto UnlockAndExit;
 300     }
 301
 302     /* Make sure the internal object exists */
 303
 304     ObjDesc = AcpiNsGetAttachedObject (Node);
 305     if (!ObjDesc)
 306     {
 307         Status = AE_NOT_EXIST;
 308         goto UnlockAndExit;
 309     }
 310
 311     /* Find the address handler the user requested */
 312
 313     HandlerObj = ObjDesc->CommonNotify.Handler;
 314     LastObjPtr = &ObjDesc->CommonNotify.Handler;
 315     while (HandlerObj)
 316     {
 317         /* We have a handler, see if user requested this one */
 318
 319         if (HandlerObj->AddressSpace.SpaceId == SpaceId)
 320         {
 321             /* Handler must be the same as the installed handler */
 322
 323             if (HandlerObj->AddressSpace.Handler != Handler)
 324             {
 325                 Status = AE_BAD_PARAMETER;
 326                 goto UnlockAndExit;
 327             }
 328
 329             /* Matched SpaceId, first dereference this in the Regions */
 330
 331             ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
 332                 "Removing address handler %p(%p) for region %s "
 333                 "on Device %p(%p)\n",
 334                 HandlerObj, Handler, AcpiUtGetRegionName (SpaceId),
 335                 Node, ObjDesc));
 336
 337             RegionObj = HandlerObj->AddressSpace.RegionList;
 338
 339             /* Walk the handler's region list */
 340
 341             while (RegionObj)
 342             {
 343                 /*
 344                  * First disassociate the handler from the region.
 345                  *
 346                  * NOTE: this doesn't mean that the region goes away
 347                  * The region is just inaccessible as indicated to
 348                  * the _REG method
 349                  */
 350                 AcpiEvDetachRegion (RegionObj, TRUE);
 351
 352                 /*
 353                  * Walk the list: Just grab the head because the
 354                  * DetachRegion removed the previous head.
 355                  */
 356                 RegionObj = HandlerObj->AddressSpace.RegionList;
 357             }
 358
 359             /* Remove this Handler object from the list */
 360
 361             *LastObjPtr = HandlerObj->AddressSpace.Next;
 362
 363             /* Now we can delete the handler object */
 364
 365             AcpiUtRemoveReference (HandlerObj);
 366             goto UnlockAndExit;
 367         }
 368
 369         /* Walk the linked list of handlers */
 370
 371         LastObjPtr = &HandlerObj->AddressSpace.Next;
 372         HandlerObj = HandlerObj->AddressSpace.Next;
 373     }
 374
 375     /* The handler does not exist */
 376
 377     ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
 378         "Unable to remove address handler %p for %s(%X), DevNode %p, obj %p\n",
 379         Handler, AcpiUtGetRegionName (SpaceId), SpaceId, Node, ObjDesc));
 380
 381     Status = AE_NOT_EXIST;
 382
 383 UnlockAndExit:
 384     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 385     return_ACPI_STATUS (Status);
 386 }
 387
 388 ACPI_EXPORT_SYMBOL (AcpiRemoveAddressSpaceHandler)