sys/contrib/dev/acpica/events/evrgnini.c

   1 /******************************************************************************
   2  *
   3  * Module Name: evrgnini- ACPI AddressSpace (OpRegion) init
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  16  * 2.1. This is your license from Intel Corp. under its intellectual property
  17  * rights.  You may have additional license terms from the party that provided
  18  * you this software, covering your right to use that party's intellectual
  19  * property rights.
  20  *
  21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  22  * copy of the source code appearing in this file ("Covered Code") an
  23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  24  * base code distributed originally by Intel ("Original Intel Code") to copy,
  25  * make derivatives, distribute, use and display any portion of the Covered
  26  * Code in any form, with the right to sublicense such rights; and
  27  *
  28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  29  * license (with the right to sublicense), under only those claims of Intel
  30  * patents that are infringed by the Original Intel Code, to make, use, sell,
  31  * offer to sell, and import the Covered Code and derivative works thereof
  32  * solely to the minimum extent necessary to exercise the above copyright
  33  * license, and in no event shall the patent license extend to any additions
  34  * to or modifications of the Original Intel Code.  No other license or right
  35  * is granted directly or by implication, estoppel or otherwise;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  43  * Redistribution of source code of any substantial portion of the Covered
  44  * Code or modification with rights to further distribute source must include
  45  * the above Copyright Notice, the above License, this list of Conditions,
  46  * and the following Disclaimer and Export Compliance provision.  In addition,
  47  * Licensee must cause all Covered Code to which Licensee contributes to
  48  * contain a file documenting the changes Licensee made to create that Covered
  49  * Code and the date of any change.  Licensee must include in that file the
  50  * documentation of any changes made by any predecessor Licensee.  Licensee
  51  * must include a prominent statement that the modification is derived,
  52  * directly or indirectly, from Original Intel Code.
  53  *
  54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  55  * Redistribution of source code of any substantial portion of the Covered
  56  * Code or modification without rights to further distribute source must
  57  * include the following Disclaimer and Export Compliance provision in the
  58  * documentation and/or other materials provided with distribution.  In
  59  * addition, Licensee may not authorize further sublicense of source of any
  60  * portion of the Covered Code, and must include terms to the effect that the
  61  * license from Licensee to its licensee is limited to the intellectual
  62  * property embodied in the software Licensee provides to its licensee, and
  63  * not to intellectual property embodied in modifications its licensee may
  64  * make.
  65  *
  66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  67  * substantial portion of the Covered Code or modification must reproduce the
  68  * above Copyright Notice, and the following Disclaimer and Export Compliance
  69  * provision in the documentation and/or other materials provided with the
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  76  * Intel shall be used in advertising or otherwise to promote the sale, use or
  77  * other dealings in products derived from or relating to the Covered Code
  78  * without prior written authorization from Intel.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  83  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  85  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  86  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  88  * PARTICULAR PURPOSE.
  89  *
  90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  97  * LIMITED REMEDY.
  98  *
  99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 100  * software or system incorporating such software without first obtaining any
 101  * required license or other approval from the U. S. Department of Commerce or
 102  * any other agency or department of the United States Government.  In the
 103  * event Licensee exports any such software from the United States or
 104  * re-exports any such software from a foreign destination, Licensee shall
 105  * ensure that the distribution and export/re-export of the software is in
 106  * compliance with all laws, regulations, orders, or other restrictions of the
 107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 108  * any of its subsidiaries will export/re-export any technical data, process,
 109  * software, or service, directly or indirectly, to any country for which the
 110  * United States government or any agency thereof requires an export license,
 111  * other governmental approval, or letter of assurance, without first obtaining
 112  * such license, approval or letter.
 113  *
 114  *****************************************************************************/
 115
 116
 117 #define __EVRGNINI_C__
 118
 119 #include <contrib/dev/acpica/include/acpi.h>
 120 #include <contrib/dev/acpica/include/accommon.h>
 121 #include <contrib/dev/acpica/include/acevents.h>
 122 #include <contrib/dev/acpica/include/acnamesp.h>
 123
 124 #define _COMPONENT          ACPI_EVENTS
 125         ACPI_MODULE_NAME    ("evrgnini")
 126
 127 /* Local prototypes */
 128
 129 static BOOLEAN
 130 AcpiEvMatchPciRootBridge (
 131     char                    *Id);
 132
 133 static BOOLEAN
 134 AcpiEvIsPciRootBridge (
 135     ACPI_NAMESPACE_NODE     *Node);
 136
 137
 138 /*******************************************************************************
 139  *
 140  * FUNCTION:    AcpiEvSystemMemoryRegionSetup
 141  *
 142  * PARAMETERS:  Handle              - Region we are interested in
 143  *              Function            - Start or stop
 144  *              HandlerContext      - Address space handler context
 145  *              RegionContext       - Region specific context
 146  *
 147  * RETURN:      Status
 148  *
 149  * DESCRIPTION: Setup a SystemMemory operation region
 150  *
 151  ******************************************************************************/
 152
 153 ACPI_STATUS
 154 AcpiEvSystemMemoryRegionSetup (
 155     ACPI_HANDLE             Handle,
 156     UINT32                  Function,
 157     void                    *HandlerContext,
 158     void                    **RegionContext)
 159 {
 160     ACPI_OPERAND_OBJECT     *RegionDesc = (ACPI_OPERAND_OBJECT *) Handle;
 161     ACPI_MEM_SPACE_CONTEXT  *LocalRegionContext;
 162
 163
 164     ACPI_FUNCTION_TRACE (EvSystemMemoryRegionSetup);
 165
 166
 167     if (Function == ACPI_REGION_DEACTIVATE)
 168     {
 169         if (*RegionContext)
 170         {
 171             LocalRegionContext = (ACPI_MEM_SPACE_CONTEXT *) *RegionContext;
 172
 173             /* Delete a cached mapping if present */
 174
 175             if (LocalRegionContext->MappedLength)
 176             {
 177                 AcpiOsUnmapMemory (LocalRegionContext->MappedLogicalAddress,
 178                     LocalRegionContext->MappedLength);
 179             }
 180             ACPI_FREE (LocalRegionContext);
 181             *RegionContext = NULL;
 182         }
 183         return_ACPI_STATUS (AE_OK);
 184     }
 185
 186     /* Create a new context */
 187
 188     LocalRegionContext = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_MEM_SPACE_CONTEXT));
 189     if (!(LocalRegionContext))
 190     {
 191         return_ACPI_STATUS (AE_NO_MEMORY);
 192     }
 193
 194     /* Save the region length and address for use in the handler */
 195
 196     LocalRegionContext->Length  = RegionDesc->Region.Length;
 197     LocalRegionContext->Address = RegionDesc->Region.Address;
 198
 199     *RegionContext = LocalRegionContext;
 200     return_ACPI_STATUS (AE_OK);
 201 }
 202
 203
 204 /*******************************************************************************
 205  *
 206  * FUNCTION:    AcpiEvIoSpaceRegionSetup
 207  *
 208  * PARAMETERS:  Handle              - Region we are interested in
 209  *              Function            - Start or stop
 210  *              HandlerContext      - Address space handler context
 211  *              RegionContext       - Region specific context
 212  *
 213  * RETURN:      Status
 214  *
 215  * DESCRIPTION: Setup a IO operation region
 216  *
 217  ******************************************************************************/
 218
 219 ACPI_STATUS
 220 AcpiEvIoSpaceRegionSetup (
 221     ACPI_HANDLE             Handle,
 222     UINT32                  Function,
 223     void                    *HandlerContext,
 224     void                    **RegionContext)
 225 {
 226     ACPI_FUNCTION_TRACE (EvIoSpaceRegionSetup);
 227
 228
 229     if (Function == ACPI_REGION_DEACTIVATE)
 230     {
 231         *RegionContext = NULL;
 232     }
 233     else
 234     {
 235         *RegionContext = HandlerContext;
 236     }
 237
 238     return_ACPI_STATUS (AE_OK);
 239 }
 240
 241
 242 /*******************************************************************************
 243  *
 244  * FUNCTION:    AcpiEvPciConfigRegionSetup
 245  *
 246  * PARAMETERS:  Handle              - Region we are interested in
 247  *              Function            - Start or stop
 248  *              HandlerContext      - Address space handler context
 249  *              RegionContext       - Region specific context
 250  *
 251  * RETURN:      Status
 252  *
 253  * DESCRIPTION: Setup a PCI_Config operation region
 254  *
 255  * MUTEX:       Assumes namespace is not locked
 256  *
 257  ******************************************************************************/
 258
 259 ACPI_STATUS
 260 AcpiEvPciConfigRegionSetup (
 261     ACPI_HANDLE             Handle,
 262     UINT32                  Function,
 263     void                    *HandlerContext,
 264     void                    **RegionContext)
 265 {
 266     ACPI_STATUS             Status = AE_OK;
 267     ACPI_INTEGER            PciValue;
 268     ACPI_PCI_ID             *PciId = *RegionContext;
 269     ACPI_OPERAND_OBJECT     *HandlerObj;
 270     ACPI_NAMESPACE_NODE     *ParentNode;
 271     ACPI_NAMESPACE_NODE     *PciRootNode;
 272     ACPI_NAMESPACE_NODE     *PciDeviceNode;
 273     ACPI_OPERAND_OBJECT     *RegionObj = (ACPI_OPERAND_OBJECT  *) Handle;
 274
 275
 276     ACPI_FUNCTION_TRACE (EvPciConfigRegionSetup);
 277
 278
 279     HandlerObj = RegionObj->Region.Handler;
 280     if (!HandlerObj)
 281     {
 282         /*
 283          * No installed handler. This shouldn't happen because the dispatch
 284          * routine checks before we get here, but we check again just in case.
 285          */
 286         ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
 287             "Attempting to init a region %p, with no handler\n", RegionObj));
 288         return_ACPI_STATUS (AE_NOT_EXIST);
 289     }
 290
 291     *RegionContext = NULL;
 292     if (Function == ACPI_REGION_DEACTIVATE)
 293     {
 294         if (PciId)
 295         {
 296             ACPI_FREE (PciId);
 297         }
 298         return_ACPI_STATUS (Status);
 299     }
 300
 301     ParentNode = AcpiNsGetParentNode (RegionObj->Region.Node);
 302
 303     /*
 304      * Get the _SEG and _BBN values from the device upon which the handler
 305      * is installed.
 306      *
 307      * We need to get the _SEG and _BBN objects relative to the PCI BUS device.
 308      * This is the device the handler has been registered to handle.
 309      */
 310
 311     /*
 312      * If the AddressSpace.Node is still pointing to the root, we need
 313      * to scan upward for a PCI Root bridge and re-associate the OpRegion
 314      * handlers with that device.
 315      */
 316     if (HandlerObj->AddressSpace.Node == AcpiGbl_RootNode)
 317     {
 318         /* Start search from the parent object */
 319
 320         PciRootNode = ParentNode;
 321         while (PciRootNode != AcpiGbl_RootNode)
 322         {
 323             /* Get the _HID/_CID in order to detect a RootBridge */
 324
 325             if (AcpiEvIsPciRootBridge (PciRootNode))
 326             {
 327                 /* Install a handler for this PCI root bridge */
 328
 329                 Status = AcpiInstallAddressSpaceHandler (
 330                             (ACPI_HANDLE) PciRootNode,
 331                             ACPI_ADR_SPACE_PCI_CONFIG,
 332                             ACPI_DEFAULT_HANDLER, NULL, NULL);
 333                 if (ACPI_FAILURE (Status))
 334                 {
 335                     if (Status == AE_SAME_HANDLER)
 336                     {
 337                         /*
 338                          * It is OK if the handler is already installed on the
 339                          * root bridge. Still need to return a context object
 340                          * for the new PCI_Config operation region, however.
 341                          */
 342                         Status = AE_OK;
 343                     }
 344                     else
 345                     {
 346                         ACPI_EXCEPTION ((AE_INFO, Status,
 347                             "Could not install PciConfig handler "
 348                             "for Root Bridge %4.4s",
 349                             AcpiUtGetNodeName (PciRootNode)));
 350                     }
 351                 }
 352                 break;
 353             }
 354
 355             PciRootNode = AcpiNsGetParentNode (PciRootNode);
 356         }
 357
 358         /* PCI root bridge not found, use namespace root node */
 359     }
 360     else
 361     {
 362         PciRootNode = HandlerObj->AddressSpace.Node;
 363     }
 364
 365     /*
 366      * If this region is now initialized, we are done.
 367      * (InstallAddressSpaceHandler could have initialized it)
 368      */
 369     if (RegionObj->Region.Flags & AOPOBJ_SETUP_COMPLETE)
 370     {
 371         return_ACPI_STATUS (AE_OK);
 372     }
 373
 374     /* Region is still not initialized. Create a new context */
 375
 376     PciId = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_PCI_ID));
 377     if (!PciId)
 378     {
 379         return_ACPI_STATUS (AE_NO_MEMORY);
 380     }
 381
 382     /*
 383      * For PCI_Config space access, we need the segment, bus, device and
 384      * function numbers. Acquire them here.
 385      *
 386      * Find the parent device object. (This allows the operation region to be
 387      * within a subscope under the device, such as a control method.)
 388      */
 389     PciDeviceNode = RegionObj->Region.Node;
 390     while (PciDeviceNode && (PciDeviceNode->Type != ACPI_TYPE_DEVICE))
 391     {
 392         PciDeviceNode = AcpiNsGetParentNode (PciDeviceNode);
 393     }
 394
 395     if (!PciDeviceNode)
 396     {
 397         ACPI_FREE (PciId);
 398         return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
 399     }
 400
 401     /*
 402      * Get the PCI device and function numbers from the _ADR object contained
 403      * in the parent's scope.
 404      */
 405     Status = AcpiUtEvaluateNumericObject (METHOD_NAME__ADR,
 406                 PciDeviceNode, &PciValue);
 407
 408     /*
 409      * The default is zero, and since the allocation above zeroed the data,
 410      * just do nothing on failure.
 411      */
 412     if (ACPI_SUCCESS (Status))
 413     {
 414         PciId->Device   = ACPI_HIWORD (ACPI_LODWORD (PciValue));
 415         PciId->Function = ACPI_LOWORD (ACPI_LODWORD (PciValue));
 416     }
 417
 418     /* The PCI segment number comes from the _SEG method */
 419
 420     Status = AcpiUtEvaluateNumericObject (METHOD_NAME__SEG,
 421                 PciRootNode, &PciValue);
 422     if (ACPI_SUCCESS (Status))
 423     {
 424         PciId->Segment = ACPI_LOWORD (PciValue);
 425     }
 426
 427     /* The PCI bus number comes from the _BBN method */
 428
 429     Status = AcpiUtEvaluateNumericObject (METHOD_NAME__BBN,
 430                 PciRootNode, &PciValue);
 431     if (ACPI_SUCCESS (Status))
 432     {
 433         PciId->Bus = ACPI_LOWORD (PciValue);
 434     }
 435
 436     /* Complete this device's PciId */
 437
 438     AcpiOsDerivePciId (PciRootNode, RegionObj->Region.Node, &PciId);
 439
 440     *RegionContext = PciId;
 441     return_ACPI_STATUS (AE_OK);
 442 }
 443
 444
 445 /*******************************************************************************
 446  *
 447  * FUNCTION:    AcpiEvMatchPciRootBridge
 448  *
 449  * PARAMETERS:  Id              - The HID/CID in string format
 450  *
 451  * RETURN:      TRUE if the Id is a match for a PCI/PCI-Express Root Bridge
 452  *
 453  * DESCRIPTION: Determine if the input ID is a PCI Root Bridge ID.
 454  *
 455  ******************************************************************************/
 456
 457 static BOOLEAN
 458 AcpiEvMatchPciRootBridge (
 459     char                    *Id)
 460 {
 461
 462     /*
 463      * Check if this is a PCI root.
 464      * ACPI 3.0+: check for a PCI Express root also.
 465      */
 466     if (!(ACPI_STRNCMP (Id,
 467             PCI_ROOT_HID_STRING,
 468             sizeof (PCI_ROOT_HID_STRING)))      ||
 469
 470         !(ACPI_STRNCMP (Id,
 471             PCI_EXPRESS_ROOT_HID_STRING,
 472             sizeof (PCI_EXPRESS_ROOT_HID_STRING))))
 473     {
 474         return (TRUE);
 475     }
 476
 477     return (FALSE);
 478 }
 479
 480
 481 /*******************************************************************************
 482  *
 483  * FUNCTION:    AcpiEvIsPciRootBridge
 484  *
 485  * PARAMETERS:  Node            - Device node being examined
 486  *
 487  * RETURN:      TRUE if device is a PCI/PCI-Express Root Bridge
 488  *
 489  * DESCRIPTION: Determine if the input device represents a PCI Root Bridge by
 490  *              examining the _HID and _CID for the device.
 491  *
 492  ******************************************************************************/
 493
 494 static BOOLEAN
 495 AcpiEvIsPciRootBridge (
 496     ACPI_NAMESPACE_NODE     *Node)
 497 {
 498     ACPI_STATUS             Status;
 499     ACPI_DEVICE_ID          Hid;
 500     ACPI_COMPATIBLE_ID_LIST *Cid;
 501     UINT32                  i;
 502
 503
 504     /* Get the _HID and check for a PCI Root Bridge */
 505
 506     Status = AcpiUtExecute_HID (Node, &Hid);
 507     if (ACPI_FAILURE (Status))
 508     {
 509         return (FALSE);
 510     }
 511
 512     if (AcpiEvMatchPciRootBridge (Hid.Value))
 513     {
 514         return (TRUE);
 515     }
 516
 517     /* The _HID did not match. Get the _CID and check for a PCI Root Bridge */
 518
 519     Status = AcpiUtExecute_CID (Node, &Cid);
 520     if (ACPI_FAILURE (Status))
 521     {
 522         return (FALSE);
 523     }
 524
 525     /* Check all _CIDs in the returned list */
 526
 527     for (i = 0; i < Cid->Count; i++)
 528     {
 529         if (AcpiEvMatchPciRootBridge (Cid->Id[i].Value))
 530         {
 531             ACPI_FREE (Cid);
 532             return (TRUE);
 533         }
 534     }
 535
 536     ACPI_FREE (Cid);
 537     return (FALSE);
 538 }
 539
 540
 541 /*******************************************************************************
 542  *
 543  * FUNCTION:    AcpiEvPciBarRegionSetup
 544  *
 545  * PARAMETERS:  Handle              - Region we are interested in
 546  *              Function            - Start or stop
 547  *              HandlerContext      - Address space handler context
 548  *              RegionContext       - Region specific context
 549  *
 550  * RETURN:      Status
 551  *
 552  * DESCRIPTION: Setup a PciBAR operation region
 553  *
 554  * MUTEX:       Assumes namespace is not locked
 555  *
 556  ******************************************************************************/
 557
 558 ACPI_STATUS
 559 AcpiEvPciBarRegionSetup (
 560     ACPI_HANDLE             Handle,
 561     UINT32                  Function,
 562     void                    *HandlerContext,
 563     void                    **RegionContext)
 564 {
 565     ACPI_FUNCTION_TRACE (EvPciBarRegionSetup);
 566
 567
 568     return_ACPI_STATUS (AE_OK);
 569 }
 570
 571
 572 /*******************************************************************************
 573  *
 574  * FUNCTION:    AcpiEvCmosRegionSetup
 575  *
 576  * PARAMETERS:  Handle              - Region we are interested in
 577  *              Function            - Start or stop
 578  *              HandlerContext      - Address space handler context
 579  *              RegionContext       - Region specific context
 580  *
 581  * RETURN:      Status
 582  *
 583  * DESCRIPTION: Setup a CMOS operation region
 584  *
 585  * MUTEX:       Assumes namespace is not locked
 586  *
 587  ******************************************************************************/
 588
 589 ACPI_STATUS
 590 AcpiEvCmosRegionSetup (
 591     ACPI_HANDLE             Handle,
 592     UINT32                  Function,
 593     void                    *HandlerContext,
 594     void                    **RegionContext)
 595 {
 596     ACPI_FUNCTION_TRACE (EvCmosRegionSetup);
 597
 598
 599     return_ACPI_STATUS (AE_OK);
 600 }
 601
 602
 603 /*******************************************************************************
 604  *
 605  * FUNCTION:    AcpiEvDefaultRegionSetup
 606  *
 607  * PARAMETERS:  Handle              - Region we are interested in
 608  *              Function            - Start or stop
 609  *              HandlerContext      - Address space handler context
 610  *              RegionContext       - Region specific context
 611  *
 612  * RETURN:      Status
 613  *
 614  * DESCRIPTION: Default region initialization
 615  *
 616  ******************************************************************************/
 617
 618 ACPI_STATUS
 619 AcpiEvDefaultRegionSetup (
 620     ACPI_HANDLE             Handle,
 621     UINT32                  Function,
 622     void                    *HandlerContext,
 623     void                    **RegionContext)
 624 {
 625     ACPI_FUNCTION_TRACE (EvDefaultRegionSetup);
 626
 627
 628     if (Function == ACPI_REGION_DEACTIVATE)
 629     {
 630         *RegionContext = NULL;
 631     }
 632     else
 633     {
 634         *RegionContext = HandlerContext;
 635     }
 636
 637     return_ACPI_STATUS (AE_OK);
 638 }
 639
 640
 641 /*******************************************************************************
 642  *
 643  * FUNCTION:    AcpiEvInitializeRegion
 644  *
 645  * PARAMETERS:  RegionObj       - Region we are initializing
 646  *              AcpiNsLocked    - Is namespace locked?
 647  *
 648  * RETURN:      Status
 649  *
 650  * DESCRIPTION: Initializes the region, finds any _REG methods and saves them
 651  *              for execution at a later time
 652  *
 653  *              Get the appropriate address space handler for a newly
 654  *              created region.
 655  *
 656  *              This also performs address space specific initialization. For
 657  *              example, PCI regions must have an _ADR object that contains
 658  *              a PCI address in the scope of the definition. This address is
 659  *              required to perform an access to PCI config space.
 660  *
 661  * MUTEX:       Interpreter should be unlocked, because we may run the _REG
 662  *              method for this region.
 663  *
 664  ******************************************************************************/
 665
 666 ACPI_STATUS
 667 AcpiEvInitializeRegion (
 668     ACPI_OPERAND_OBJECT     *RegionObj,
 669     BOOLEAN                 AcpiNsLocked)
 670 {
 671     ACPI_OPERAND_OBJECT     *HandlerObj;
 672     ACPI_OPERAND_OBJECT     *ObjDesc;
 673     ACPI_ADR_SPACE_TYPE     SpaceId;
 674     ACPI_NAMESPACE_NODE     *Node;
 675     ACPI_STATUS             Status;
 676     ACPI_NAMESPACE_NODE     *MethodNode;
 677     ACPI_NAME               *RegNamePtr = (ACPI_NAME *) METHOD_NAME__REG;
 678     ACPI_OPERAND_OBJECT     *RegionObj2;
 679
 680
 681     ACPI_FUNCTION_TRACE_U32 (EvInitializeRegion, AcpiNsLocked);
 682
 683
 684     if (!RegionObj)
 685     {
 686         return_ACPI_STATUS (AE_BAD_PARAMETER);
 687     }
 688
 689     if (RegionObj->Common.Flags & AOPOBJ_OBJECT_INITIALIZED)
 690     {
 691         return_ACPI_STATUS (AE_OK);
 692     }
 693
 694     RegionObj2 = AcpiNsGetSecondaryObject (RegionObj);
 695     if (!RegionObj2)
 696     {
 697         return_ACPI_STATUS (AE_NOT_EXIST);
 698     }
 699
 700     Node = AcpiNsGetParentNode (RegionObj->Region.Node);
 701     SpaceId = RegionObj->Region.SpaceId;
 702
 703     /* Setup defaults */
 704
 705     RegionObj->Region.Handler = NULL;
 706     RegionObj2->Extra.Method_REG = NULL;
 707     RegionObj->Common.Flags &= ~(AOPOBJ_SETUP_COMPLETE);
 708     RegionObj->Common.Flags |= AOPOBJ_OBJECT_INITIALIZED;
 709
 710     /* Find any "_REG" method associated with this region definition */
 711
 712     Status = AcpiNsSearchOneScope (
 713                 *RegNamePtr, Node, ACPI_TYPE_METHOD, &MethodNode);
 714     if (ACPI_SUCCESS (Status))
 715     {
 716         /*
 717          * The _REG method is optional and there can be only one per region
 718          * definition. This will be executed when the handler is attached
 719          * or removed
 720          */
 721         RegionObj2->Extra.Method_REG = MethodNode;
 722     }
 723
 724     /*
 725      * The following loop depends upon the root Node having no parent
 726      * ie: AcpiGbl_RootNode->ParentEntry being set to NULL
 727      */
 728     while (Node)
 729     {
 730         /* Check to see if a handler exists */
 731
 732         HandlerObj = NULL;
 733         ObjDesc = AcpiNsGetAttachedObject (Node);
 734         if (ObjDesc)
 735         {
 736             /* Can only be a handler if the object exists */
 737
 738             switch (Node->Type)
 739             {
 740             case ACPI_TYPE_DEVICE:
 741
 742                 HandlerObj = ObjDesc->Device.Handler;
 743                 break;
 744
 745             case ACPI_TYPE_PROCESSOR:
 746
 747                 HandlerObj = ObjDesc->Processor.Handler;
 748                 break;
 749
 750             case ACPI_TYPE_THERMAL:
 751
 752                 HandlerObj = ObjDesc->ThermalZone.Handler;
 753                 break;
 754
 755             default:
 756                 /* Ignore other objects */
 757                 break;
 758             }
 759
 760             while (HandlerObj)
 761             {
 762                 /* Is this handler of the correct type? */
 763
 764                 if (HandlerObj->AddressSpace.SpaceId == SpaceId)
 765                 {
 766                     /* Found correct handler */
 767
 768                     ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
 769                         "Found handler %p for region %p in obj %p\n",
 770                         HandlerObj, RegionObj, ObjDesc));
 771
 772                     Status = AcpiEvAttachRegion (HandlerObj, RegionObj,
 773                                 AcpiNsLocked);
 774
 775                     /*
 776                      * Tell all users that this region is usable by
 777                      * running the _REG method
 778                      */
 779                     if (AcpiNsLocked)
 780                     {
 781                         Status = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 782                         if (ACPI_FAILURE (Status))
 783                         {
 784                             return_ACPI_STATUS (Status);
 785                         }
 786                     }
 787
 788                     Status = AcpiEvExecuteRegMethod (RegionObj, 1);
 789
 790                     if (AcpiNsLocked)
 791                     {
 792                         Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 793                         if (ACPI_FAILURE (Status))
 794                         {
 795                             return_ACPI_STATUS (Status);
 796                         }
 797                     }
 798
 799                     return_ACPI_STATUS (AE_OK);
 800                 }
 801
 802                 /* Try next handler in the list */
 803
 804                 HandlerObj = HandlerObj->AddressSpace.Next;
 805             }
 806         }
 807
 808         /* This node does not have the handler we need; Pop up one level */
 809
 810         Node = AcpiNsGetParentNode (Node);
 811     }
 812
 813     /* If we get here, there is no handler for this region */
 814
 815     ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
 816         "No handler for RegionType %s(%X) (RegionObj %p)\n",
 817         AcpiUtGetRegionName (SpaceId), SpaceId, RegionObj));
 818
 819     return_ACPI_STATUS (AE_NOT_EXIST);
 820 }
 821