sys/contrib/dev/acpica/evxfregn.c

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