acpica/events/evrgnini.c

0001 /******************************************************************************
0002  *
0003  * Module Name: evrgnini- ACPI AddressSpace (OpRegion) init
0004  *
0005  *****************************************************************************/
0006
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights. You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code. No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision. In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change. Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee. Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution. In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
0086  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
0087  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0088  * PARTICULAR PURPOSE.
0089  *
0090  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0091  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0092  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0093  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0094  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0095  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
0096  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0097  * LIMITED REMEDY.
0098  *
0099  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0100  * software or system incorporating such software without first obtaining any
0101  * required license or other approval from the U. S. Department of Commerce or
0102  * any other agency or department of the United States Government. In the
0103  * event Licensee exports any such software from the United States or
0104  * re-exports any such software from a foreign destination, Licensee shall
0105  * ensure that the distribution and export/re-export of the software is in
0106  * compliance with all laws, regulations, orders, or other restrictions of the
0107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0108  * any of its subsidiaries will export/re-export any technical data, process,
0109  * software, or service, directly or indirectly, to any country for which the
0110  * United States government or any agency thereof requires an export license,
0111  * other governmental approval, or letter of assurance, without first obtaining
0112  * such license, approval or letter.
0113  *
0114  *****************************************************************************
0115  *
0116  * Alternatively, you may choose to be licensed under the terms of the
0117  * following license:
0118  *
0119  * Redistribution and use in source and binary forms, with or without
0120  * modification, are permitted provided that the following conditions
0121  * are met:
0122  * 1. Redistributions of source code must retain the above copyright
0123  *    notice, this list of conditions, and the following disclaimer,
0124  *    without modification.
0125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
0126  *    substantially similar to the "NO WARRANTY" disclaimer below
0127  *    ("Disclaimer") and any redistribution must be conditioned upon
0128  *    including a substantially similar Disclaimer requirement for further
0129  *    binary redistribution.
0130  * 3. Neither the names of the above-listed copyright holders nor the names
0131  *    of any contributors may be used to endorse or promote products derived
0132  *    from this software without specific prior written permission.
0133  *
0134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0145  *
0146  * Alternatively, you may choose to be licensed under the terms of the
0147  * GNU General Public License ("GPL") version 2 as published by the Free
0148  * Software Foundation.
0149  *
0150  *****************************************************************************/
0151
0152 #include "acpi.h"
0153 #include "accommon.h"
0154 #include "acevents.h"
0155 #include "acnamesp.h"
0156 #include "acinterp.h"
0157
0158 #define _COMPONENT          ACPI_EVENTS
0159         ACPI_MODULE_NAME    ("evrgnini")
0160
0161
0162 /*******************************************************************************
0163  *
0164  * FUNCTION:    AcpiEvSystemMemoryRegionSetup
0165  *
0166  * PARAMETERS:  Handle              - Region we are interested in
0167  *              Function            - Start or stop
0168  *              HandlerContext      - Address space handler context
0169  *              RegionContext       - Region specific context
0170  *
0171  * RETURN:      Status
0172  *
0173  * DESCRIPTION: Setup a SystemMemory operation region
0174  *
0175  ******************************************************************************/
0176
0177 ACPI_STATUS
0178 AcpiEvSystemMemoryRegionSetup (
0179     ACPI_HANDLE             Handle,
0180     UINT32                  Function,
0181     void                    *HandlerContext,
0182     void                    **RegionContext)
0183 {
0184     ACPI_OPERAND_OBJECT     *RegionDesc = (ACPI_OPERAND_OBJECT *) Handle;
0185     ACPI_MEM_SPACE_CONTEXT  *LocalRegionContext;
0186     ACPI_MEM_MAPPING        *Mm;
0187
0188
0189     ACPI_FUNCTION_TRACE (EvSystemMemoryRegionSetup);
0190
0191
0192     if (Function == ACPI_REGION_DEACTIVATE)
0193     {
0194         if (*RegionContext)
0195         {
0196             LocalRegionContext = (ACPI_MEM_SPACE_CONTEXT *) *RegionContext;
0197
0198             /* Delete memory mappings if present */
0199
0200             while (LocalRegionContext->FirstMm)
0201             {
0202                 Mm = LocalRegionContext->FirstMm;
0203                 LocalRegionContext->FirstMm = Mm->NextMm;
0204                 AcpiOsUnmapMemory(Mm->LogicalAddress, Mm->Length);
0205                 ACPI_FREE(Mm);
0206             }
0207             ACPI_FREE (LocalRegionContext);
0208             *RegionContext = NULL;
0209         }
0210         return_ACPI_STATUS (AE_OK);
0211     }
0212
0213     /* Create a new context */
0214
0215     LocalRegionContext = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_MEM_SPACE_CONTEXT));
0216     if (!(LocalRegionContext))
0217     {
0218         return_ACPI_STATUS (AE_NO_MEMORY);
0219     }
0220
0221     /* Save the region length and address for use in the handler */
0222
0223     LocalRegionContext->Length  = RegionDesc->Region.Length;
0224     LocalRegionContext->Address = RegionDesc->Region.Address;
0225
0226     *RegionContext = LocalRegionContext;
0227     return_ACPI_STATUS (AE_OK);
0228 }
0229
0230
0231 /*******************************************************************************
0232  *
0233  * FUNCTION:    AcpiEvIoSpaceRegionSetup
0234  *
0235  * PARAMETERS:  Handle              - Region we are interested in
0236  *              Function            - Start or stop
0237  *              HandlerContext      - Address space handler context
0238  *              RegionContext       - Region specific context
0239  *
0240  * RETURN:      Status
0241  *
0242  * DESCRIPTION: Setup a IO operation region
0243  *
0244  ******************************************************************************/
0245
0246 ACPI_STATUS
0247 AcpiEvIoSpaceRegionSetup (
0248     ACPI_HANDLE             Handle,
0249     UINT32                  Function,
0250     void                    *HandlerContext,
0251     void                    **RegionContext)
0252 {
0253     ACPI_FUNCTION_TRACE (EvIoSpaceRegionSetup);
0254
0255
0256     if (Function == ACPI_REGION_DEACTIVATE)
0257     {
0258         *RegionContext = NULL;
0259     }
0260     else
0261     {
0262         *RegionContext = HandlerContext;
0263     }
0264
0265     return_ACPI_STATUS (AE_OK);
0266 }
0267
0268
0269 /*******************************************************************************
0270  *
0271  * FUNCTION:    AcpiEvPciConfigRegionSetup
0272  *
0273  * PARAMETERS:  Handle              - Region we are interested in
0274  *              Function            - Start or stop
0275  *              HandlerContext      - Address space handler context
0276  *              RegionContext       - Region specific context
0277  *
0278  * RETURN:      Status
0279  *
0280  * DESCRIPTION: Setup a PCI_Config operation region
0281  *
0282  * MUTEX:       Assumes namespace is not locked
0283  *
0284  ******************************************************************************/
0285
0286 ACPI_STATUS
0287 AcpiEvPciConfigRegionSetup (
0288     ACPI_HANDLE             Handle,
0289     UINT32                  Function,
0290     void                    *HandlerContext,
0291     void                    **RegionContext)
0292 {
0293     ACPI_STATUS             Status = AE_OK;
0294     UINT64                  PciValue;
0295     ACPI_PCI_ID             *PciId = *RegionContext;
0296     ACPI_OPERAND_OBJECT     *HandlerObj;
0297     ACPI_NAMESPACE_NODE     *ParentNode;
0298     ACPI_NAMESPACE_NODE     *PciRootNode;
0299     ACPI_NAMESPACE_NODE     *PciDeviceNode;
0300     ACPI_OPERAND_OBJECT     *RegionObj = (ACPI_OPERAND_OBJECT  *) Handle;
0301
0302
0303     ACPI_FUNCTION_TRACE (EvPciConfigRegionSetup);
0304
0305
0306     HandlerObj = RegionObj->Region.Handler;
0307     if (!HandlerObj)
0308     {
0309         /*
0310          * No installed handler. This shouldn't happen because the dispatch
0311          * routine checks before we get here, but we check again just in case.
0312          */
0313         ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
0314             "Attempting to init a region %p, with no handler\n", RegionObj));
0315         return_ACPI_STATUS (AE_NOT_EXIST);
0316     }
0317
0318     *RegionContext = NULL;
0319     if (Function == ACPI_REGION_DEACTIVATE)
0320     {
0321         if (PciId)
0322         {
0323             ACPI_FREE (PciId);
0324         }
0325         return_ACPI_STATUS (Status);
0326     }
0327
0328     ParentNode = RegionObj->Region.Node->Parent;
0329
0330     /*
0331      * Get the _SEG and _BBN values from the device upon which the handler
0332      * is installed.
0333      *
0334      * We need to get the _SEG and _BBN objects relative to the PCI BUS device.
0335      * This is the device the handler has been registered to handle.
0336      */
0337
0338     /*
0339      * If the AddressSpace.Node is still pointing to the root, we need
0340      * to scan upward for a PCI Root bridge and re-associate the OpRegion
0341      * handlers with that device.
0342      */
0343     if (HandlerObj->AddressSpace.Node == AcpiGbl_RootNode)
0344     {
0345         /* Start search from the parent object */
0346
0347         PciRootNode = ParentNode;
0348         while (PciRootNode != AcpiGbl_RootNode)
0349         {
0350             /* Get the _HID/_CID in order to detect a RootBridge */
0351
0352             if (AcpiEvIsPciRootBridge (PciRootNode))
0353             {
0354                 /* Install a handler for this PCI root bridge */
0355
0356                 Status = AcpiInstallAddressSpaceHandler (
0357                     (ACPI_HANDLE) PciRootNode,
0358                     ACPI_ADR_SPACE_PCI_CONFIG,
0359                     ACPI_DEFAULT_HANDLER, NULL, NULL);
0360                 if (ACPI_FAILURE (Status))
0361                 {
0362                     if (Status == AE_SAME_HANDLER)
0363                     {
0364                         /*
0365                          * It is OK if the handler is already installed on the
0366                          * root bridge. Still need to return a context object
0367                          * for the new PCI_Config operation region, however.
0368                          */
0369                     }
0370                     else
0371                     {
0372                         ACPI_EXCEPTION ((AE_INFO, Status,
0373                             "Could not install PciConfig handler "
0374                             "for Root Bridge %4.4s",
0375                             AcpiUtGetNodeName (PciRootNode)));
0376                     }
0377                 }
0378                 break;
0379             }
0380
0381             PciRootNode = PciRootNode->Parent;
0382         }
0383
0384         /* PCI root bridge not found, use namespace root node */
0385     }
0386     else
0387     {
0388         PciRootNode = HandlerObj->AddressSpace.Node;
0389     }
0390
0391     /*
0392      * If this region is now initialized, we are done.
0393      * (InstallAddressSpaceHandler could have initialized it)
0394      */
0395     if (RegionObj->Region.Flags & AOPOBJ_SETUP_COMPLETE)
0396     {
0397         return_ACPI_STATUS (AE_OK);
0398     }
0399
0400     /* Region is still not initialized. Create a new context */
0401
0402     PciId = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_PCI_ID));
0403     if (!PciId)
0404     {
0405         return_ACPI_STATUS (AE_NO_MEMORY);
0406     }
0407
0408     /*
0409      * For PCI_Config space access, we need the segment, bus, device and
0410      * function numbers. Acquire them here.
0411      *
0412      * Find the parent device object. (This allows the operation region to be
0413      * within a subscope under the device, such as a control method.)
0414      */
0415     PciDeviceNode = RegionObj->Region.Node;
0416     while (PciDeviceNode && (PciDeviceNode->Type != ACPI_TYPE_DEVICE))
0417     {
0418         PciDeviceNode = PciDeviceNode->Parent;
0419     }
0420
0421     if (!PciDeviceNode)
0422     {
0423         ACPI_FREE (PciId);
0424         return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
0425     }
0426
0427     /*
0428      * Get the PCI device and function numbers from the _ADR object
0429      * contained in the parent's scope.
0430      */
0431     Status = AcpiUtEvaluateNumericObject (METHOD_NAME__ADR,
0432         PciDeviceNode, &PciValue);
0433
0434     /*
0435      * The default is zero, and since the allocation above zeroed the data,
0436      * just do nothing on failure.
0437      */
0438     if (ACPI_SUCCESS (Status))
0439     {
0440         PciId->Device   = ACPI_HIWORD (ACPI_LODWORD (PciValue));
0441         PciId->Function = ACPI_LOWORD (ACPI_LODWORD (PciValue));
0442     }
0443
0444     /* The PCI segment number comes from the _SEG method */
0445
0446     Status = AcpiUtEvaluateNumericObject (METHOD_NAME__SEG,
0447         PciRootNode, &PciValue);
0448     if (ACPI_SUCCESS (Status))
0449     {
0450         PciId->Segment = ACPI_LOWORD (PciValue);
0451     }
0452
0453     /* The PCI bus number comes from the _BBN method */
0454
0455     Status = AcpiUtEvaluateNumericObject (METHOD_NAME__BBN,
0456         PciRootNode, &PciValue);
0457     if (ACPI_SUCCESS (Status))
0458     {
0459         PciId->Bus = ACPI_LOWORD (PciValue);
0460     }
0461
0462     /* Complete/update the PCI ID for this device */
0463
0464     Status = AcpiHwDerivePciId (PciId, PciRootNode, RegionObj->Region.Node);
0465     if (ACPI_FAILURE (Status))
0466     {
0467         ACPI_FREE (PciId);
0468         return_ACPI_STATUS (Status);
0469     }
0470
0471     *RegionContext = PciId;
0472     return_ACPI_STATUS (AE_OK);
0473 }
0474
0475
0476 /*******************************************************************************
0477  *
0478  * FUNCTION:    AcpiEvIsPciRootBridge
0479  *
0480  * PARAMETERS:  Node            - Device node being examined
0481  *
0482  * RETURN:      TRUE if device is a PCI/PCI-Express Root Bridge
0483  *
0484  * DESCRIPTION: Determine if the input device represents a PCI Root Bridge by
0485  *              examining the _HID and _CID for the device.
0486  *
0487  ******************************************************************************/
0488
0489 BOOLEAN
0490 AcpiEvIsPciRootBridge (
0491     ACPI_NAMESPACE_NODE     *Node)
0492 {
0493     ACPI_STATUS             Status;
0494     ACPI_PNP_DEVICE_ID      *Hid;
0495     ACPI_PNP_DEVICE_ID_LIST *Cid;
0496     UINT32                  i;
0497     BOOLEAN                 Match;
0498
0499
0500     /* Get the _HID and check for a PCI Root Bridge */
0501
0502     Status = AcpiUtExecute_HID (Node, &Hid);
0503     if (ACPI_FAILURE (Status))
0504     {
0505         return (FALSE);
0506     }
0507
0508     Match = AcpiUtIsPciRootBridge (Hid->String);
0509     ACPI_FREE (Hid);
0510
0511     if (Match)
0512     {
0513         return (TRUE);
0514     }
0515
0516     /* The _HID did not match. Get the _CID and check for a PCI Root Bridge */
0517
0518     Status = AcpiUtExecute_CID (Node, &Cid);
0519     if (ACPI_FAILURE (Status))
0520     {
0521         return (FALSE);
0522     }
0523
0524     /* Check all _CIDs in the returned list */
0525
0526     for (i = 0; i < Cid->Count; i++)
0527     {
0528         if (AcpiUtIsPciRootBridge (Cid->Ids[i].String))
0529         {
0530             ACPI_FREE (Cid);
0531             return (TRUE);
0532         }
0533     }
0534
0535     ACPI_FREE (Cid);
0536     return (FALSE);
0537 }
0538
0539
0540 /*******************************************************************************
0541  *
0542  * FUNCTION:    AcpiEvPciBarRegionSetup
0543  *
0544  * PARAMETERS:  Handle              - Region we are interested in
0545  *              Function            - Start or stop
0546  *              HandlerContext      - Address space handler context
0547  *              RegionContext       - Region specific context
0548  *
0549  * RETURN:      Status
0550  *
0551  * DESCRIPTION: Setup a PciBAR operation region
0552  *
0553  * MUTEX:       Assumes namespace is not locked
0554  *
0555  ******************************************************************************/
0556
0557 ACPI_STATUS
0558 AcpiEvPciBarRegionSetup (
0559     ACPI_HANDLE             Handle,
0560     UINT32                  Function,
0561     void                    *HandlerContext,
0562     void                    **RegionContext)
0563 {
0564     ACPI_FUNCTION_TRACE (EvPciBarRegionSetup);
0565
0566
0567     return_ACPI_STATUS (AE_OK);
0568 }
0569
0570
0571 /*******************************************************************************
0572  *
0573  * FUNCTION:    AcpiEvCmosRegionSetup
0574  *
0575  * PARAMETERS:  Handle              - Region we are interested in
0576  *              Function            - Start or stop
0577  *              HandlerContext      - Address space handler context
0578  *              RegionContext       - Region specific context
0579  *
0580  * RETURN:      Status
0581  *
0582  * DESCRIPTION: Setup a CMOS operation region
0583  *
0584  * MUTEX:       Assumes namespace is not locked
0585  *
0586  ******************************************************************************/
0587
0588 ACPI_STATUS
0589 AcpiEvCmosRegionSetup (
0590     ACPI_HANDLE             Handle,
0591     UINT32                  Function,
0592     void                    *HandlerContext,
0593     void                    **RegionContext)
0594 {
0595     ACPI_FUNCTION_TRACE (EvCmosRegionSetup);
0596
0597
0598     return_ACPI_STATUS (AE_OK);
0599 }
0600
0601
0602 /*******************************************************************************
0603  *
0604  * FUNCTION:    AcpiEvDataTableRegionSetup
0605  *
0606  * PARAMETERS:  Handle              - Region we are interested in
0607  *              Function            - Start or stop
0608  *              HandlerContext      - Address space handler context
0609  *              RegionContext       - Region specific context
0610  *
0611  * RETURN:      Status
0612  *
0613  * DESCRIPTION: Setup a DataTableRegion
0614  *
0615  * MUTEX:       Assumes namespace is not locked
0616  *
0617  ******************************************************************************/
0618
0619 ACPI_STATUS
0620 AcpiEvDataTableRegionSetup (
0621     ACPI_HANDLE             Handle,
0622     UINT32                  Function,
0623     void                    *HandlerContext,
0624     void                    **RegionContext)
0625 {
0626     ACPI_OPERAND_OBJECT     *RegionDesc = (ACPI_OPERAND_OBJECT *) Handle;
0627     ACPI_DATA_TABLE_MAPPING *LocalRegionContext;
0628
0629
0630     ACPI_FUNCTION_TRACE (EvDataTableRegionSetup);
0631
0632
0633     if (Function == ACPI_REGION_DEACTIVATE)
0634     {
0635         if (*RegionContext)
0636         {
0637             ACPI_FREE (*RegionContext);
0638             *RegionContext = NULL;
0639         }
0640         return_ACPI_STATUS (AE_OK);
0641     }
0642
0643     /* Create a new context */
0644
0645     LocalRegionContext = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_DATA_TABLE_MAPPING));
0646     if (!(LocalRegionContext))
0647     {
0648         return_ACPI_STATUS (AE_NO_MEMORY);
0649     }
0650
0651     /* Save the data table pointer for use in the handler */
0652
0653     LocalRegionContext->Pointer = RegionDesc->Region.Pointer;
0654
0655     *RegionContext = LocalRegionContext;
0656     return_ACPI_STATUS (AE_OK);
0657 }
0658
0659
0660 /*******************************************************************************
0661  *
0662  * FUNCTION:    AcpiEvDefaultRegionSetup
0663  *
0664  * PARAMETERS:  Handle              - Region we are interested in
0665  *              Function            - Start or stop
0666  *              HandlerContext      - Address space handler context
0667  *              RegionContext       - Region specific context
0668  *
0669  * RETURN:      Status
0670  *
0671  * DESCRIPTION: Default region initialization
0672  *
0673  ******************************************************************************/
0674
0675 ACPI_STATUS
0676 AcpiEvDefaultRegionSetup (
0677     ACPI_HANDLE             Handle,
0678     UINT32                  Function,
0679     void                    *HandlerContext,
0680     void                    **RegionContext)
0681 {
0682     ACPI_FUNCTION_TRACE (EvDefaultRegionSetup);
0683
0684
0685     if (Function == ACPI_REGION_DEACTIVATE)
0686     {
0687         *RegionContext = NULL;
0688     }
0689     else
0690     {
0691         *RegionContext = HandlerContext;
0692     }
0693
0694     return_ACPI_STATUS (AE_OK);
0695 }
0696
0697
0698 /*******************************************************************************
0699  *
0700  * FUNCTION:    AcpiEvInitializeRegion
0701  *
0702  * PARAMETERS:  RegionObj       - Region we are initializing
0703  *
0704  * RETURN:      Status
0705  *
0706  * DESCRIPTION: Initializes the region, finds any _REG methods and saves them
0707  *              for execution at a later time
0708  *
0709  *              Get the appropriate address space handler for a newly
0710  *              created region.
0711  *
0712  *              This also performs address space specific initialization. For
0713  *              example, PCI regions must have an _ADR object that contains
0714  *              a PCI address in the scope of the definition. This address is
0715  *              required to perform an access to PCI config space.
0716  *
0717  * MUTEX:       Interpreter should be unlocked, because we may run the _REG
0718  *              method for this region.
0719  *
0720  * NOTE:        Possible incompliance:
0721  *              There is a behavior conflict in automatic _REG execution:
0722  *              1. When the interpreter is evaluating a method, we can only
0723  *                 automatically run _REG for the following case:
0724  *                   Method(_REG, 2) {}
0725  *                   OperationRegion (OPR1, 0x80, 0x1000010, 0x4)
0726  *              2. When the interpreter is loading a table, we can also
0727  *                 automatically run _REG for the following case:
0728  *                   OperationRegion (OPR1, 0x80, 0x1000010, 0x4)
0729  *                   Method(_REG, 2) {}
0730  *              Though this may not be compliant to the de-facto standard, the
0731  *              logic is kept in order not to trigger regressions. And keeping
0732  *              this logic should be taken care by the caller of this function.
0733  *
0734  ******************************************************************************/
0735
0736 ACPI_STATUS
0737 AcpiEvInitializeRegion (
0738     ACPI_OPERAND_OBJECT     *RegionObj)
0739 {
0740     ACPI_OPERAND_OBJECT     *HandlerObj;
0741     ACPI_OPERAND_OBJECT     *ObjDesc;
0742     ACPI_ADR_SPACE_TYPE     SpaceId;
0743     ACPI_NAMESPACE_NODE     *Node;
0744
0745
0746     ACPI_FUNCTION_TRACE (EvInitializeRegion);
0747
0748
0749     if (!RegionObj)
0750     {
0751         return_ACPI_STATUS (AE_BAD_PARAMETER);
0752     }
0753
0754     if (RegionObj->Common.Flags & AOPOBJ_OBJECT_INITIALIZED)
0755     {
0756         return_ACPI_STATUS (AE_OK);
0757     }
0758
0759     RegionObj->Common.Flags |= AOPOBJ_OBJECT_INITIALIZED;
0760
0761     Node = RegionObj->Region.Node->Parent;
0762     SpaceId = RegionObj->Region.SpaceId;
0763
0764     /*
0765      * The following loop depends upon the root Node having no parent
0766      * ie: AcpiGbl_RootNode->Parent being set to NULL
0767      */
0768     while (Node)
0769     {
0770         /* Check to see if a handler exists */
0771
0772         HandlerObj = NULL;
0773         ObjDesc = AcpiNsGetAttachedObject (Node);
0774         if (ObjDesc)
0775         {
0776             /* Can only be a handler if the object exists */
0777
0778             switch (Node->Type)
0779             {
0780             case ACPI_TYPE_DEVICE:
0781             case ACPI_TYPE_PROCESSOR:
0782             case ACPI_TYPE_THERMAL:
0783
0784                 HandlerObj = ObjDesc->CommonNotify.Handler;
0785                 break;
0786
0787             default:
0788
0789                 /* Ignore other objects */
0790
0791                 break;
0792             }
0793
0794             HandlerObj = AcpiEvFindRegionHandler (SpaceId, HandlerObj);
0795             if (HandlerObj)
0796             {
0797                 /* Found correct handler */
0798
0799                 ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
0800                     "Found handler %p for region %p in obj %p\n",
0801                     HandlerObj, RegionObj, ObjDesc));
0802
0803                 (void) AcpiEvAttachRegion (HandlerObj, RegionObj, FALSE);
0804
0805                 /*
0806                  * Tell all users that this region is usable by
0807                  * running the _REG method
0808                  */
0809                 AcpiExExitInterpreter ();
0810                 (void) AcpiEvExecuteRegMethod (RegionObj, ACPI_REG_CONNECT);
0811                 AcpiExEnterInterpreter ();
0812                 return_ACPI_STATUS (AE_OK);
0813             }
0814         }
0815
0816         /* This node does not have the handler we need; Pop up one level */
0817
0818         Node = Node->Parent;
0819     }
0820
0821     /*
0822      * If we get here, there is no handler for this region. This is not
0823      * fatal because many regions get created before a handler is installed
0824      * for said region.
0825      */
0826     ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
0827         "No handler for RegionType %s(%X) (RegionObj %p)\n",
0828         AcpiUtGetRegionName (SpaceId), SpaceId, RegionObj));
0829
0830     return_ACPI_STATUS (AE_OK);
0831 }