sys/contrib/dev/acpica/evxfregn.c

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