sys/contrib/dev/acpica/evxfregn.c

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