sys/contrib/dev/acpica/evxfregn.c

   1 /******************************************************************************
   2  *
   3  * Module Name: evxfregn - External Interfaces, ACPI Operation Regions and
   4  *                         Address Spaces.
   5  *              $Revision: 41 $
   6  *
   7  *****************************************************************************/
   8
   9 /******************************************************************************
  10  *
  11  * 1. Copyright Notice
  12  *
  13  * Some or all of this work - Copyright (c) 1999, 2000, 2001, Intel Corp.
  14  * All rights 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          ACPI_EVENTS
 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_ADR_SPACE_TYPE     SpaceId,
 151     ACPI_ADR_SPACE_HANDLER  Handler,
 152     ACPI_ADR_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     ACPI_OBJECT_TYPE8       Type;
 160     UINT16                  Flags = 0;
 161
 162
 163     FUNCTION_TRACE ("AcpiInstallAddressSpaceHandler");
 164
 165
 166     /* Parameter validation */
 167
 168     if ((!Device)   ||
 169         ((!Handler)  && (Handler != ACPI_DEFAULT_HANDLER)) ||
 170         (SpaceId > ACPI_MAX_ADDRESS_SPACE))
 171     {
 172         return_ACPI_STATUS (AE_BAD_PARAMETER);
 173     }
 174
 175     AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 176
 177     /* Convert and validate the device handle */
 178
 179     Node = AcpiNsMapHandleToNode (Device);
 180     if (!Node)
 181     {
 182         Status = AE_BAD_PARAMETER;
 183         goto UnlockAndExit;
 184     }
 185
 186     /*
 187      * This registration is valid for only the types below
 188      * and the root.  This is where the default handlers
 189      * get placed.
 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 ACPI_ADR_SPACE_SYSTEM_MEMORY:
 207             Handler = AcpiExSystemMemorySpaceHandler;
 208             Setup   = AcpiEvSystemMemoryRegionSetup;
 209             break;
 210
 211         case ACPI_ADR_SPACE_SYSTEM_IO:
 212             Handler = AcpiExSystemIoSpaceHandler;
 213             Setup   = AcpiEvIoSpaceRegionSetup;
 214             break;
 215
 216         case ACPI_ADR_SPACE_PCI_CONFIG:
 217             Handler = AcpiExPciConfigSpaceHandler;
 218             Setup   = AcpiEvPciConfigRegionSetup;
 219             break;
 220
 221         case ACPI_ADR_SPACE_CMOS:
 222             Handler = AcpiExCmosSpaceHandler;
 223             Setup   = AcpiEvCmosRegionSetup;
 224             break;
 225
 226         case ACPI_ADR_SPACE_PCI_BAR_TARGET:
 227             Handler = AcpiExPciBarSpaceHandler;
 228             Setup   = AcpiEvPciBarRegionSetup;
 229             break;
 230
 231         default:
 232             Status = AE_NOT_EXIST;
 233             goto UnlockAndExit;
 234             break;
 235         }
 236     }
 237
 238     /*
 239      * If the caller hasn't specified a setup routine, use the default
 240      */
 241     if (!Setup)
 242     {
 243         Setup = AcpiEvDefaultRegionSetup;
 244     }
 245
 246     /*
 247      * Check for an existing internal object
 248      */
 249     ObjDesc = AcpiNsGetAttachedObject (Node);
 250     if (ObjDesc)
 251     {
 252         /*
 253          * The object exists.
 254          * Make sure the handler is not already installed.
 255          */
 256
 257         /* check the address handler the user requested */
 258
 259         HandlerObj = ObjDesc->Device.AddrHandler;
 260         while (HandlerObj)
 261         {
 262             /*
 263              * We have an Address handler, see if user requested this
 264              * address space.
 265              */
 266             if(HandlerObj->AddrHandler.SpaceId == SpaceId)
 267             {
 268                 Status = AE_ALREADY_EXISTS;
 269                 goto UnlockAndExit;
 270             }
 271
 272             /*
 273              * Move through the linked list of handlers
 274              */
 275             HandlerObj = HandlerObj->AddrHandler.Next;
 276         }
 277     }
 278
 279     else
 280     {
 281         ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
 282             "Creating object on Device %p while installing handler\n", Node));
 283
 284         /* ObjDesc does not exist, create one */
 285
 286         if (Node->Type == ACPI_TYPE_ANY)
 287         {
 288             Type = ACPI_TYPE_DEVICE;
 289         }
 290         else
 291         {
 292             Type = Node->Type;
 293         }
 294
 295         ObjDesc = AcpiUtCreateInternalObject (Type);
 296         if (!ObjDesc)
 297         {
 298             Status = AE_NO_MEMORY;
 299             goto UnlockAndExit;
 300         }
 301
 302         /* Init new descriptor */
 303
 304         ObjDesc->Common.Type = (UINT8) Type;
 305
 306         /* Attach the new object to the Node */
 307
 308         Status = AcpiNsAttachObject (Node, ObjDesc, (UINT8) Type);
 309         if (ACPI_FAILURE (Status))
 310         {
 311             AcpiUtRemoveReference (ObjDesc);
 312             goto UnlockAndExit;
 313         }
 314     }
 315
 316     ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
 317         "Installing address handler for region %s(%X) on Device %p(%p)\n",
 318         AcpiUtGetRegionName (SpaceId), SpaceId, Node, ObjDesc));
 319
 320     /*
 321      * Now we can install the handler
 322      *
 323      * At this point we know that there is no existing handler.
 324      * So, we just allocate the object for the handler and link it
 325      * into the list.
 326      */
 327     HandlerObj = AcpiUtCreateInternalObject (INTERNAL_TYPE_ADDRESS_HANDLER);
 328     if (!HandlerObj)
 329     {
 330         Status = AE_NO_MEMORY;
 331         goto UnlockAndExit;
 332     }
 333
 334     HandlerObj->AddrHandler.SpaceId     = (UINT8) SpaceId;
 335     HandlerObj->AddrHandler.Hflags      = Flags;
 336     HandlerObj->AddrHandler.Next        = ObjDesc->Device.AddrHandler;
 337     HandlerObj->AddrHandler.RegionList  = NULL;
 338     HandlerObj->AddrHandler.Node        = Node;
 339     HandlerObj->AddrHandler.Handler     = Handler;
 340     HandlerObj->AddrHandler.Context     = Context;
 341     HandlerObj->AddrHandler.Setup       = Setup;
 342
 343     /*
 344      * Now walk the namespace finding all of the regions this
 345      * handler will manage.
 346      *
 347      * We start at the device and search the branch toward
 348      * the leaf nodes until either the leaf is encountered or
 349      * a device is detected that has an address handler of the
 350      * same type.
 351      *
 352      * In either case we back up and search down the remainder
 353      * of the branch
 354      */
 355     Status = AcpiNsWalkNamespace (ACPI_TYPE_ANY, Device,
 356                                   ACPI_UINT32_MAX, NS_WALK_UNLOCK,
 357                                   AcpiEvAddrHandlerHelper,
 358                                   HandlerObj, NULL);
 359
 360     /*
 361      * Place this handler 1st on the list
 362      */
 363     HandlerObj->Common.ReferenceCount =
 364                             (UINT16) (HandlerObj->Common.ReferenceCount +
 365                             ObjDesc->Common.ReferenceCount - 1);
 366     ObjDesc->Device.AddrHandler = HandlerObj;
 367
 368
 369 UnlockAndExit:
 370     AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 371     return_ACPI_STATUS (Status);
 372 }
 373
 374
 375 /*******************************************************************************
 376  *
 377  * FUNCTION:    AcpiRemoveAddressSpaceHandler
 378  *
 379  * PARAMETERS:  SpaceId         - The address space ID
 380  *              Handler         - Address of the handler
 381  *
 382  * RETURN:      Status
 383  *
 384  * DESCRIPTION: Install a handler for accesses on an Operation Region
 385  *
 386  ******************************************************************************/
 387
 388 ACPI_STATUS
 389 AcpiRemoveAddressSpaceHandler (
 390     ACPI_HANDLE             Device,
 391     ACPI_ADR_SPACE_TYPE     SpaceId,
 392     ACPI_ADR_SPACE_HANDLER  Handler)
 393 {
 394     ACPI_OPERAND_OBJECT     *ObjDesc;
 395     ACPI_OPERAND_OBJECT     *HandlerObj;
 396     ACPI_OPERAND_OBJECT     *RegionObj;
 397     ACPI_OPERAND_OBJECT     **LastObjPtr;
 398     ACPI_NAMESPACE_NODE     *Node;
 399     ACPI_STATUS             Status = AE_OK;
 400
 401
 402     FUNCTION_TRACE ("AcpiRemoveAddressSpaceHandler");
 403
 404
 405     /* Parameter validation */
 406
 407     if ((!Device)   ||
 408         ((!Handler)  && (Handler != ACPI_DEFAULT_HANDLER)) ||
 409         (SpaceId > ACPI_MAX_ADDRESS_SPACE))
 410     {
 411         return_ACPI_STATUS (AE_BAD_PARAMETER);
 412     }
 413
 414     AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 415
 416     /* Convert and validate the device handle */
 417
 418     Node = AcpiNsMapHandleToNode (Device);
 419     if (!Node)
 420     {
 421         Status = AE_BAD_PARAMETER;
 422         goto UnlockAndExit;
 423     }
 424
 425
 426     /* Make sure the internal object exists */
 427
 428     ObjDesc = AcpiNsGetAttachedObject (Node);
 429     if (!ObjDesc)
 430     {
 431         Status = AE_NOT_EXIST;
 432         goto UnlockAndExit;
 433     }
 434
 435     /*
 436      * find the address handler the user requested
 437      */
 438     HandlerObj = ObjDesc->Device.AddrHandler;
 439     LastObjPtr = &ObjDesc->Device.AddrHandler;
 440     while (HandlerObj)
 441     {
 442         /*
 443          * We have a handler, see if user requested this one
 444          */
 445         if (HandlerObj->AddrHandler.SpaceId == SpaceId)
 446         {
 447             /*
 448              * Got it, first dereference this in the Regions
 449              */
 450             ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
 451                 "Removing address handler %p(%p) for region %s on Device %p(%p)\n",
 452                 HandlerObj, Handler, AcpiUtGetRegionName (SpaceId),
 453                 Node, ObjDesc));
 454
 455             RegionObj = HandlerObj->AddrHandler.RegionList;
 456
 457             /* Walk the handler's region list */
 458
 459             while (RegionObj)
 460             {
 461                 /*
 462                  * First disassociate the handler from the region.
 463                  *
 464                  * NOTE: this doesn't mean that the region goes away
 465                  * The region is just inaccessible as indicated to
 466                  * the _REG method
 467                  */
 468                 AcpiEvDisassociateRegionFromHandler(RegionObj, TRUE);
 469
 470                 /*
 471                  * Walk the list, since we took the first region and it
 472                  * was removed from the list by the dissassociate call
 473                  * we just get the first item on the list again
 474                  */
 475                 RegionObj = HandlerObj->AddrHandler.RegionList;
 476
 477             }
 478
 479             /*
 480              * Remove this Handler object from the list
 481              */
 482             *LastObjPtr = HandlerObj->AddrHandler.Next;
 483
 484             /*
 485              * Now we can delete the handler object
 486              */
 487             AcpiUtRemoveReference (HandlerObj);
 488             AcpiUtRemoveReference (HandlerObj);
 489
 490             goto UnlockAndExit;
 491         }
 492
 493         /*
 494          * Move through the linked list of handlers
 495          */
 496         LastObjPtr = &HandlerObj->AddrHandler.Next;
 497         HandlerObj = HandlerObj->AddrHandler.Next;
 498     }
 499
 500
 501     /*
 502      * The handler does not exist
 503      */
 504     ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
 505         "Unable to remove address handler %p for %s(%X), DevNode %p, obj %p\n",
 506         Handler, AcpiUtGetRegionName (SpaceId), SpaceId, Node, ObjDesc));
 507
 508     Status = AE_NOT_EXIST;
 509
 510
 511 UnlockAndExit:
 512     AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 513     return_ACPI_STATUS (Status);
 514 }
 515
 516