sys/contrib/dev/acpica/evxfregn.c

   1 /******************************************************************************
   2  *
   3  * Module Name: evxfregn - External Interfaces, ACPI Operation Regions and
   4  *                         Address Spaces.
   5  *              $Revision: 22 $
   6  *
   7  *****************************************************************************/
   8
   9 /******************************************************************************
  10  *
  11  * 1. Copyright Notice
  12  *
  13  * Some or all of this work - Copyright (c) 1999, Intel Corp.  All rights
  14  * reserved.
  15  *
  16  * 2. License
  17  *
  18  * 2.1. This is your license from Intel Corp. under its intellectual property
  19  * rights.  You may have additional license terms from the party that provided
  20  * you this software, covering your right to use that party's intellectual
  21  * property rights.
  22  *
  23  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  24  * copy of the source code appearing in this file ("Covered Code") an
  25  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  26  * base code distributed originally by Intel ("Original Intel Code") to copy,
  27  * make derivatives, distribute, use and display any portion of the Covered
  28  * Code in any form, with the right to sublicense such rights; and
  29  *
  30  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  31  * license (with the right to sublicense), under only those claims of Intel
  32  * patents that are infringed by the Original Intel Code, to make, use, sell,
  33  * offer to sell, and import the Covered Code and derivative works thereof
  34  * solely to the minimum extent necessary to exercise the above copyright
  35  * license, and in no event shall the patent license extend to any additions
  36  * to or modifications of the Original Intel Code.  No other license or right
  37  * is granted directly or by implication, estoppel or otherwise;
  38  *
  39  * The above copyright and patent license is granted only if the following
  40  * conditions are met:
  41  *
  42  * 3. Conditions
  43  *
  44  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  45  * Redistribution of source code of any substantial prton of the Covered
  46  * Code or modification with rights to further distribute source must include
  47  * the above Copyright Notice, the above License, this list of Conditions,
  48  * and the following Disclaimer and Export Compliance provision.  In addition,
  49  * Licensee must cause all Covered Code to which Licensee contributes to
  50  * contain a file documenting the changes Licensee made to create that Covered
  51  * Code and the date of any change.  Licensee must include in that file the
  52  * documentation of any changes made by any predecessor Licensee.  Licensee
  53  * must include a prominent statement that the modification is derived,
  54  * directly or indirectly, from Original Intel Code.
  55  *
  56  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  57  * Redistribution of source code of any substantial portion of the Covered
  58  * Code or modification without rights to further distribute source must
  59  * include the following Disclaimer and Export Compliance provision in the
  60  * documentation and/or other materials provided with distribution.  In
  61  * addition, Licensee may not authorize further sublicense of source of any
  62  * portion of the Covered Code, and must include terms to the effect that the
  63  * license from Licensee to its licensee is limited to the intellectual
  64  * property embodied in the software Licensee provides to its licensee, and
  65  * not to intellectual property embodied in modifications its licensee may
  66  * make.
  67  *
  68  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  69  * substantial portion of the Covered Code or modification must reproduce the
  70  * above Copyright Notice, and the following Disclaimer and Export Compliance
  71  * provision in the documentation and/or other materials provided with the
  72  * distribution.
  73  *
  74  * 3.4. Intel retains all right, title, and interest in and to the Original
  75  * Intel Code.
  76  *
  77  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  78  * Intel shall be used in advertising or otherwise to promote the sale, use or
  79  * other dealings in products derived from or relating to the Covered Code
  80  * without prior written authorization from Intel.
  81  *
  82  * 4. Disclaimer and Export Compliance
  83  *
  84  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  85  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  86  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  87  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  88  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  89  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  90  * PARTICULAR PURPOSE.
  91  *
  92  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  93  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  94  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  95  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  96  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  97  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  98  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  99  * LIMITED REMEDY.
 100  *
 101  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 102  * software or system incorporating such software without first obtaining any
 103  * required license or other approval from the U. S. Department of Commerce or
 104  * any other agency or department of the United States Government.  In the
 105  * event Licensee exports any such software from the United States or
 106  * re-exports any such software from a foreign destination, Licensee shall
 107  * ensure that the distribution and export/re-export of the software is in
 108  * compliance with all laws, regulations, orders, or other restrictions of the
 109  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 110  * any of its subsidiaries will export/re-export any technical data, process,
 111  * software, or service, directly or indirectly, to any country for which the
 112  * United States government or any agency thereof requires an export license,
 113  * other governmental approval, or letter of assurance, without first obtaining
 114  * such license, approval or letter.
 115  *
 116  *****************************************************************************/
 117
 118 #define __EVXFREGN_C__
 119
 120 #include "acpi.h"
 121 #include "achware.h"
 122 #include "acnamesp.h"
 123 #include "acevents.h"
 124 #include "amlcode.h"
 125 #include "acinterp.h"
 126
 127 #define _COMPONENT          EVENT_HANDLING
 128         MODULE_NAME         ("evxfregn")
 129
 130
 131 /******************************************************************************
 132  *
 133  * FUNCTION:    AcpiInstallAddressSpaceHandler
 134  *
 135  * PARAMETERS:  Device          - Handle for the device
 136  *              SpaceId         - The address space ID
 137  *              Handler         - Address of the handler
 138  *              Setup           - Address of the setup function
 139  *              Context         - Value passed to the handler on each access
 140  *
 141  * RETURN:      Status
 142  *
 143  * DESCRIPTION: Install a handler for all OpRegions of a given SpaceId.
 144  *
 145  ******************************************************************************/
 146
 147 ACPI_STATUS
 148 AcpiInstallAddressSpaceHandler (
 149     ACPI_HANDLE             Device,
 150     ACPI_ADDRESS_SPACE_TYPE SpaceId,
 151     ADDRESS_SPACE_HANDLER   Handler,
 152     ADDRESS_SPACE_SETUP     Setup,
 153     void                    *Context)
 154 {
 155     ACPI_OPERAND_OBJECT     *ObjDesc;
 156     ACPI_OPERAND_OBJECT     *HandlerObj;
 157     ACPI_NAMESPACE_NODE     *Node;
 158     ACPI_STATUS             Status = AE_OK;
 159     OBJECT_TYPE_INTERNAL    Type;
 160     UINT16                  Flags = 0;
 161
 162
 163     FUNCTION_TRACE ("AcpiInstallAddressSpaceHandler");
 164
 165     /* Parameter validation */
 166
 167     if ((!Device)   ||
 168         ((!Handler)  && (Handler != ACPI_DEFAULT_HANDLER)) ||
 169         (SpaceId > ACPI_MAX_ADDRESS_SPACE))
 170     {
 171         return_ACPI_STATUS (AE_BAD_PARAMETER);
 172     }
 173
 174     AcpiCmAcquireMutex (ACPI_MTX_NAMESPACE);
 175
 176     /* Convert and validate the device handle */
 177
 178     Node = AcpiNsConvertHandleToEntry (Device);
 179     if (!Node)
 180     {
 181         Status = AE_BAD_PARAMETER;
 182         goto UnlockAndExit;
 183     }
 184
 185     /*
 186      *  This registration is valid for only the types below
 187      *  and the root.  This is where the default handlers
 188      *  get placed.
 189      */
 190
 191     if ((Node->Type != ACPI_TYPE_DEVICE)     &&
 192         (Node->Type != ACPI_TYPE_PROCESSOR)  &&
 193         (Node->Type != ACPI_TYPE_THERMAL)    &&
 194         (Node != AcpiGbl_RootNode))
 195     {
 196         Status = AE_BAD_PARAMETER;
 197         goto UnlockAndExit;
 198     }
 199
 200     if (Handler == ACPI_DEFAULT_HANDLER)
 201     {
 202         Flags = ADDR_HANDLER_DEFAULT_INSTALLED;
 203
 204         switch (SpaceId)
 205         {
 206         case ADDRESS_SPACE_SYSTEM_MEMORY:
 207             Handler = AcpiAmlSystemMemorySpaceHandler;
 208             Setup = AcpiEvSystemMemoryRegionSetup;
 209             break;
 210
 211         case ADDRESS_SPACE_SYSTEM_IO:
 212             Handler = AcpiAmlSystemIoSpaceHandler;
 213             Setup = AcpiEvIoSpaceRegionSetup;
 214             break;
 215
 216         case ADDRESS_SPACE_PCI_CONFIG:
 217             Handler = AcpiAmlPciConfigSpaceHandler;
 218             Setup = AcpiEvPciConfigRegionSetup;
 219             break;
 220
 221         default:
 222             Status = AE_NOT_EXIST;
 223             goto UnlockAndExit;
 224             break;
 225         }
 226     }
 227
 228     /*
 229      *  If the caller hasn't specified a setup routine, use the default
 230      */
 231     if (!Setup)
 232     {
 233         Setup = AcpiEvDefaultRegionSetup;
 234     }
 235
 236     /*
 237      *  Check for an existing internal object
 238      */
 239
 240     ObjDesc = AcpiNsGetAttachedObject ((ACPI_HANDLE) Node);
 241     if (ObjDesc)
 242     {
 243         /*
 244          *  The object exists.
 245          *  Make sure the handler is not already installed.
 246          */
 247
 248         /* check the address handler the user requested */
 249
 250         HandlerObj = ObjDesc->Device.AddrHandler;
 251         while (HandlerObj)
 252         {
 253             /*
 254              *  We have an Address handler, see if user requested this
 255              *  address space.
 256              */
 257             if(HandlerObj->AddrHandler.SpaceId == SpaceId)
 258             {
 259                 Status = AE_EXIST;
 260                 goto UnlockAndExit;
 261             }
 262
 263             /*
 264              *  Move through the linked list of handlers
 265              */
 266             HandlerObj = HandlerObj->AddrHandler.Next;
 267         }
 268     }
 269
 270     else
 271     {
 272         DEBUG_PRINT (TRACE_OPREGION,
 273             ("Creating object on Device 0x%X while installing handler\n",
 274             Node));
 275
 276         /* ObjDesc does not exist, create one */
 277
 278         if (Node->Type == ACPI_TYPE_ANY)
 279         {
 280             Type = ACPI_TYPE_DEVICE;
 281         }
 282
 283         else
 284         {
 285             Type = Node->Type;
 286         }
 287
 288         ObjDesc = AcpiCmCreateInternalObject (Type);
 289         if (!ObjDesc)
 290         {
 291             Status = AE_NO_MEMORY;
 292             goto UnlockAndExit;
 293         }
 294
 295         /* Init new descriptor */
 296
 297         ObjDesc->Common.Type = (UINT8) Type;
 298
 299         /* Attach the new object to the Node */
 300
 301         Status = AcpiNsAttachObject (Node, ObjDesc, (UINT8) Type);
 302         if (ACPI_FAILURE (Status))
 303         {
 304             AcpiCmRemoveReference (ObjDesc);
 305             goto UnlockAndExit;
 306         }
 307     }
 308
 309     DEBUG_PRINT (TRACE_OPREGION,
 310         ("Installing address handler for %s on Device 0x%p (0x%p)\n",
 311         AcpiGbl_RegionTypes[SpaceId], Node, ObjDesc));
 312
 313     /*
 314      *  Now we can install the handler
 315      *
 316      *  At this point we know that there is no existing handler.
 317      *  So, we just allocate the object for the handler and link it
 318      *  into the list.
 319      */
 320     HandlerObj = AcpiCmCreateInternalObject (INTERNAL_TYPE_ADDRESS_HANDLER);
 321     if (!HandlerObj)
 322     {
 323         Status = AE_NO_MEMORY;
 324         goto UnlockAndExit;
 325     }
 326
 327     HandlerObj->AddrHandler.SpaceId     = (UINT8) SpaceId;
 328     HandlerObj->AddrHandler.Hflags      = Flags;
 329     HandlerObj->AddrHandler.Next        = ObjDesc->Device.AddrHandler;
 330     HandlerObj->AddrHandler.RegionList  = NULL;
 331     HandlerObj->AddrHandler.Node        = Node;
 332     HandlerObj->AddrHandler.Handler     = Handler;
 333     HandlerObj->AddrHandler.Context     = Context;
 334     HandlerObj->AddrHandler.Setup       = Setup;
 335
 336     /*
 337      *  Now walk the namespace finding all of the regions this
 338      *  handler will manage.
 339      *
 340      *  We start at the device and search the branch toward
 341      *  the leaf nodes until either the leaf is encountered or
 342      *  a device is detected that has an address handler of the
 343      *  same type.
 344      *
 345      *  In either case we back up and search down the remainder
 346      *  of the branch
 347      */
 348     Status = AcpiNsWalkNamespace (ACPI_TYPE_ANY, Device,
 349                                   ACPI_UINT32_MAX, NS_WALK_UNLOCK,
 350                                   AcpiEvAddrHandlerHelper,
 351                                   HandlerObj, NULL);
 352
 353     /*
 354      *  Place this handler 1st on the list
 355      */
 356
 357     HandlerObj->Common.ReferenceCount =
 358                             (UINT16) (HandlerObj->Common.ReferenceCount +
 359                             ObjDesc->Common.ReferenceCount - 1);
 360     ObjDesc->Device.AddrHandler = HandlerObj;
 361
 362
 363 UnlockAndExit:
 364     AcpiCmReleaseMutex (ACPI_MTX_NAMESPACE);
 365     return_ACPI_STATUS (Status);
 366 }
 367
 368
 369 /******************************************************************************
 370  *
 371  * FUNCTION:    AcpiRemoveAddressSpaceHandler
 372  *
 373  * PARAMETERS:  SpaceId         - The address space ID
 374  *              Handler         - Address of the handler
 375  *
 376  * RETURN:      Status
 377  *
 378  * DESCRIPTION: Install a handler for accesses on an Operation Region
 379  *
 380  ******************************************************************************/
 381
 382 ACPI_STATUS
 383 AcpiRemoveAddressSpaceHandler (
 384     ACPI_HANDLE             Device,
 385     ACPI_ADDRESS_SPACE_TYPE SpaceId,
 386     ADDRESS_SPACE_HANDLER   Handler)
 387 {
 388     ACPI_OPERAND_OBJECT     *ObjDesc;
 389     ACPI_OPERAND_OBJECT     *HandlerObj;
 390     ACPI_OPERAND_OBJECT     *RegionObj;
 391     ACPI_OPERAND_OBJECT     **LastObjPtr;
 392     ACPI_NAMESPACE_NODE     *Node;
 393     ACPI_STATUS             Status = AE_OK;
 394
 395
 396     FUNCTION_TRACE ("AcpiRemoveAddressSpaceHandler");
 397
 398
 399     /* Parameter validation */
 400
 401     if ((!Device)   ||
 402         ((!Handler)  && (Handler != ACPI_DEFAULT_HANDLER)) ||
 403         (SpaceId > ACPI_MAX_ADDRESS_SPACE))
 404     {
 405         return_ACPI_STATUS (AE_BAD_PARAMETER);
 406     }
 407
 408     AcpiCmAcquireMutex (ACPI_MTX_NAMESPACE);
 409
 410     /* Convert and validate the device handle */
 411
 412     Node = AcpiNsConvertHandleToEntry (Device);
 413     if (!Node)
 414     {
 415         Status = AE_BAD_PARAMETER;
 416         goto UnlockAndExit;
 417     }
 418
 419
 420     /* Make sure the internal object exists */
 421
 422     ObjDesc = AcpiNsGetAttachedObject ((ACPI_HANDLE) Node);
 423     if (!ObjDesc)
 424     {
 425         /*
 426          *  The object DNE.
 427          */
 428         Status = AE_NOT_EXIST;
 429         goto UnlockAndExit;
 430     }
 431
 432     /*
 433      *  find the address handler the user requested
 434      */
 435
 436     HandlerObj = ObjDesc->Device.AddrHandler;
 437     LastObjPtr = &ObjDesc->Device.AddrHandler;
 438     while (HandlerObj)
 439     {
 440         /*
 441          *  We have a handler, see if user requested this one
 442          */
 443
 444         if(HandlerObj->AddrHandler.SpaceId == SpaceId)
 445         {
 446             /*
 447              *  Got it, first dereference this in the Regions
 448              */
 449             DEBUG_PRINT (TRACE_OPREGION,
 450                 ("Removing address handler 0x%p (0x%p) for %s on Device 0x%p (0x%p)\n",
 451                 HandlerObj, Handler, AcpiGbl_RegionTypes[SpaceId],
 452                 Node, ObjDesc));
 453
 454             RegionObj = HandlerObj->AddrHandler.RegionList;
 455
 456             /* Walk the handler's region list */
 457
 458             while (RegionObj)
 459             {
 460                 /*
 461                  *  First disassociate the handler from the region.
 462                  *
 463                  *  NOTE: this doesn't mean that the region goes away
 464                  *  The region is just inaccessible as indicated to
 465                  *  the _REG method
 466                  */
 467                 AcpiEvDisassociateRegionFromHandler(RegionObj);
 468
 469                 /*
 470                  *  Walk the list, since we took the first region and it
 471                  *  was removed from the list by the dissassociate call
 472                  *  we just get the first item on the list again
 473                  */
 474                 RegionObj = HandlerObj->AddrHandler.RegionList;
 475
 476             }
 477
 478             /*
 479              *  Remove this Handler object from the list
 480              */
 481             *LastObjPtr = HandlerObj->AddrHandler.Next;
 482
 483             /*
 484              *  Now we can delete the handler object
 485              */
 486             AcpiCmRemoveReference (HandlerObj);
 487             AcpiCmRemoveReference (HandlerObj);
 488
 489             goto UnlockAndExit;
 490         }
 491
 492         /*
 493          *  Move through the linked list of handlers
 494          */
 495         LastObjPtr = &HandlerObj->AddrHandler.Next;
 496         HandlerObj = HandlerObj->AddrHandler.Next;
 497     }
 498
 499
 500     /*
 501      *  The handler does not exist
 502      */
 503     DEBUG_PRINT (TRACE_OPREGION,
 504         ("Unable to remove address handler 0x%p for %s, DeviceNode 0x%p, obj 0x%p\n",
 505         Handler, AcpiGbl_RegionTypes[SpaceId], Node, ObjDesc));
 506
 507     Status = AE_NOT_EXIST;
 508
 509
 510 UnlockAndExit:
 511     AcpiCmReleaseMutex (ACPI_MTX_NAMESPACE);
 512     return_ACPI_STATUS (Status);
 513 }
 514
 515