sys/contrib/dev/acpica/evxfregn.c

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