xref: /freebsd/sys/contrib/dev/acpica/components/events/evrgnini.c (revision 7029da5c36f2d3cf6bb6c81bf551229f416399e8)
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 - 2020, 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  * Alternatively, you may choose to be licensed under the terms of the
117  * following license:
118  *
119  * Redistribution and use in source and binary forms, with or without
120  * modification, are permitted provided that the following conditions
121  * are met:
122  * 1. Redistributions of source code must retain the above copyright
123  *    notice, this list of conditions, and the following disclaimer,
124  *    without modification.
125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126  *    substantially similar to the "NO WARRANTY" disclaimer below
127  *    ("Disclaimer") and any redistribution must be conditioned upon
128  *    including a substantially similar Disclaimer requirement for further
129  *    binary redistribution.
130  * 3. Neither the names of the above-listed copyright holders nor the names
131  *    of any contributors may be used to endorse or promote products derived
132  *    from this software without specific prior written permission.
133  *
134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145  *
146  * Alternatively, you may choose to be licensed under the terms of the
147  * GNU General Public License ("GPL") version 2 as published by the Free
148  * Software Foundation.
149  *
150  *****************************************************************************/
151 
152 #include <contrib/dev/acpica/include/acpi.h>
153 #include <contrib/dev/acpica/include/accommon.h>
154 #include <contrib/dev/acpica/include/acevents.h>
155 #include <contrib/dev/acpica/include/acnamesp.h>
156 #include <contrib/dev/acpica/include/acinterp.h>
157 
158 #define _COMPONENT          ACPI_EVENTS
159         ACPI_MODULE_NAME    ("evrgnini")
160 
161 
162 /*******************************************************************************
163  *
164  * FUNCTION:    AcpiEvSystemMemoryRegionSetup
165  *
166  * PARAMETERS:  Handle              - Region we are interested in
167  *              Function            - Start or stop
168  *              HandlerContext      - Address space handler context
169  *              RegionContext       - Region specific context
170  *
171  * RETURN:      Status
172  *
173  * DESCRIPTION: Setup a SystemMemory operation region
174  *
175  ******************************************************************************/
176 
177 ACPI_STATUS
178 AcpiEvSystemMemoryRegionSetup (
179     ACPI_HANDLE             Handle,
180     UINT32                  Function,
181     void                    *HandlerContext,
182     void                    **RegionContext)
183 {
184     ACPI_OPERAND_OBJECT     *RegionDesc = (ACPI_OPERAND_OBJECT *) Handle;
185     ACPI_MEM_SPACE_CONTEXT  *LocalRegionContext;
186 
187 
188     ACPI_FUNCTION_TRACE (EvSystemMemoryRegionSetup);
189 
190 
191     if (Function == ACPI_REGION_DEACTIVATE)
192     {
193         if (*RegionContext)
194         {
195             LocalRegionContext = (ACPI_MEM_SPACE_CONTEXT *) *RegionContext;
196 
197             /* Delete a cached mapping if present */
198 
199             if (LocalRegionContext->MappedLength)
200             {
201                 AcpiOsUnmapMemory (LocalRegionContext->MappedLogicalAddress,
202                     LocalRegionContext->MappedLength);
203             }
204             ACPI_FREE (LocalRegionContext);
205             *RegionContext = NULL;
206         }
207         return_ACPI_STATUS (AE_OK);
208     }
209 
210     /* Create a new context */
211 
212     LocalRegionContext = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_MEM_SPACE_CONTEXT));
213     if (!(LocalRegionContext))
214     {
215         return_ACPI_STATUS (AE_NO_MEMORY);
216     }
217 
218     /* Save the region length and address for use in the handler */
219 
220     LocalRegionContext->Length  = RegionDesc->Region.Length;
221     LocalRegionContext->Address = RegionDesc->Region.Address;
222 
223     *RegionContext = LocalRegionContext;
224     return_ACPI_STATUS (AE_OK);
225 }
226 
227 
228 /*******************************************************************************
229  *
230  * FUNCTION:    AcpiEvIoSpaceRegionSetup
231  *
232  * PARAMETERS:  Handle              - Region we are interested in
233  *              Function            - Start or stop
234  *              HandlerContext      - Address space handler context
235  *              RegionContext       - Region specific context
236  *
237  * RETURN:      Status
238  *
239  * DESCRIPTION: Setup a IO operation region
240  *
241  ******************************************************************************/
242 
243 ACPI_STATUS
244 AcpiEvIoSpaceRegionSetup (
245     ACPI_HANDLE             Handle,
246     UINT32                  Function,
247     void                    *HandlerContext,
248     void                    **RegionContext)
249 {
250     ACPI_FUNCTION_TRACE (EvIoSpaceRegionSetup);
251 
252 
253     if (Function == ACPI_REGION_DEACTIVATE)
254     {
255         *RegionContext = NULL;
256     }
257     else
258     {
259         *RegionContext = HandlerContext;
260     }
261 
262     return_ACPI_STATUS (AE_OK);
263 }
264 
265 
266 /*******************************************************************************
267  *
268  * FUNCTION:    AcpiEvPciConfigRegionSetup
269  *
270  * PARAMETERS:  Handle              - Region we are interested in
271  *              Function            - Start or stop
272  *              HandlerContext      - Address space handler context
273  *              RegionContext       - Region specific context
274  *
275  * RETURN:      Status
276  *
277  * DESCRIPTION: Setup a PCI_Config operation region
278  *
279  * MUTEX:       Assumes namespace is not locked
280  *
281  ******************************************************************************/
282 
283 ACPI_STATUS
284 AcpiEvPciConfigRegionSetup (
285     ACPI_HANDLE             Handle,
286     UINT32                  Function,
287     void                    *HandlerContext,
288     void                    **RegionContext)
289 {
290     ACPI_STATUS             Status = AE_OK;
291     UINT64                  PciValue;
292     ACPI_PCI_ID             *PciId = *RegionContext;
293     ACPI_OPERAND_OBJECT     *HandlerObj;
294     ACPI_NAMESPACE_NODE     *ParentNode;
295     ACPI_NAMESPACE_NODE     *PciRootNode;
296     ACPI_NAMESPACE_NODE     *PciDeviceNode;
297     ACPI_OPERAND_OBJECT     *RegionObj = (ACPI_OPERAND_OBJECT  *) Handle;
298 
299 
300     ACPI_FUNCTION_TRACE (EvPciConfigRegionSetup);
301 
302 
303     HandlerObj = RegionObj->Region.Handler;
304     if (!HandlerObj)
305     {
306         /*
307          * No installed handler. This shouldn't happen because the dispatch
308          * routine checks before we get here, but we check again just in case.
309          */
310         ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
311             "Attempting to init a region %p, with no handler\n", RegionObj));
312         return_ACPI_STATUS (AE_NOT_EXIST);
313     }
314 
315     *RegionContext = NULL;
316     if (Function == ACPI_REGION_DEACTIVATE)
317     {
318         if (PciId)
319         {
320             ACPI_FREE (PciId);
321         }
322         return_ACPI_STATUS (Status);
323     }
324 
325     ParentNode = RegionObj->Region.Node->Parent;
326 
327     /*
328      * Get the _SEG and _BBN values from the device upon which the handler
329      * is installed.
330      *
331      * We need to get the _SEG and _BBN objects relative to the PCI BUS device.
332      * This is the device the handler has been registered to handle.
333      */
334 
335     /*
336      * If the AddressSpace.Node is still pointing to the root, we need
337      * to scan upward for a PCI Root bridge and re-associate the OpRegion
338      * handlers with that device.
339      */
340     if (HandlerObj->AddressSpace.Node == AcpiGbl_RootNode)
341     {
342         /* Start search from the parent object */
343 
344         PciRootNode = ParentNode;
345         while (PciRootNode != AcpiGbl_RootNode)
346         {
347             /* Get the _HID/_CID in order to detect a RootBridge */
348 
349             if (AcpiEvIsPciRootBridge (PciRootNode))
350             {
351                 /* Install a handler for this PCI root bridge */
352 
353                 Status = AcpiInstallAddressSpaceHandler (
354                     (ACPI_HANDLE) PciRootNode,
355                     ACPI_ADR_SPACE_PCI_CONFIG,
356                     ACPI_DEFAULT_HANDLER, NULL, NULL);
357                 if (ACPI_FAILURE (Status))
358                 {
359                     if (Status == AE_SAME_HANDLER)
360                     {
361                         /*
362                          * It is OK if the handler is already installed on the
363                          * root bridge. Still need to return a context object
364                          * for the new PCI_Config operation region, however.
365                          */
366                     }
367                     else
368                     {
369                         ACPI_EXCEPTION ((AE_INFO, Status,
370                             "Could not install PciConfig handler "
371                             "for Root Bridge %4.4s",
372                             AcpiUtGetNodeName (PciRootNode)));
373                     }
374                 }
375                 break;
376             }
377 
378             PciRootNode = PciRootNode->Parent;
379         }
380 
381         /* PCI root bridge not found, use namespace root node */
382     }
383     else
384     {
385         PciRootNode = HandlerObj->AddressSpace.Node;
386     }
387 
388     /*
389      * If this region is now initialized, we are done.
390      * (InstallAddressSpaceHandler could have initialized it)
391      */
392     if (RegionObj->Region.Flags & AOPOBJ_SETUP_COMPLETE)
393     {
394         return_ACPI_STATUS (AE_OK);
395     }
396 
397     /* Region is still not initialized. Create a new context */
398 
399     PciId = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_PCI_ID));
400     if (!PciId)
401     {
402         return_ACPI_STATUS (AE_NO_MEMORY);
403     }
404 
405     /*
406      * For PCI_Config space access, we need the segment, bus, device and
407      * function numbers. Acquire them here.
408      *
409      * Find the parent device object. (This allows the operation region to be
410      * within a subscope under the device, such as a control method.)
411      */
412     PciDeviceNode = RegionObj->Region.Node;
413     while (PciDeviceNode && (PciDeviceNode->Type != ACPI_TYPE_DEVICE))
414     {
415         PciDeviceNode = PciDeviceNode->Parent;
416     }
417 
418     if (!PciDeviceNode)
419     {
420         ACPI_FREE (PciId);
421         return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
422     }
423 
424     /*
425      * Get the PCI device and function numbers from the _ADR object
426      * contained in the parent's scope.
427      */
428     Status = AcpiUtEvaluateNumericObject (METHOD_NAME__ADR,
429         PciDeviceNode, &PciValue);
430 
431     /*
432      * The default is zero, and since the allocation above zeroed the data,
433      * just do nothing on failure.
434      */
435     if (ACPI_SUCCESS (Status))
436     {
437         PciId->Device   = ACPI_HIWORD (ACPI_LODWORD (PciValue));
438         PciId->Function = ACPI_LOWORD (ACPI_LODWORD (PciValue));
439     }
440 
441     /* The PCI segment number comes from the _SEG method */
442 
443     Status = AcpiUtEvaluateNumericObject (METHOD_NAME__SEG,
444         PciRootNode, &PciValue);
445     if (ACPI_SUCCESS (Status))
446     {
447         PciId->Segment = ACPI_LOWORD (PciValue);
448     }
449 
450     /* The PCI bus number comes from the _BBN method */
451 
452     Status = AcpiUtEvaluateNumericObject (METHOD_NAME__BBN,
453         PciRootNode, &PciValue);
454     if (ACPI_SUCCESS (Status))
455     {
456         PciId->Bus = ACPI_LOWORD (PciValue);
457     }
458 
459     /* Complete/update the PCI ID for this device */
460 
461     Status = AcpiHwDerivePciId (PciId, PciRootNode, RegionObj->Region.Node);
462     if (ACPI_FAILURE (Status))
463     {
464         ACPI_FREE (PciId);
465         return_ACPI_STATUS (Status);
466     }
467 
468     *RegionContext = PciId;
469     return_ACPI_STATUS (AE_OK);
470 }
471 
472 
473 /*******************************************************************************
474  *
475  * FUNCTION:    AcpiEvIsPciRootBridge
476  *
477  * PARAMETERS:  Node            - Device node being examined
478  *
479  * RETURN:      TRUE if device is a PCI/PCI-Express Root Bridge
480  *
481  * DESCRIPTION: Determine if the input device represents a PCI Root Bridge by
482  *              examining the _HID and _CID for the device.
483  *
484  ******************************************************************************/
485 
486 BOOLEAN
487 AcpiEvIsPciRootBridge (
488     ACPI_NAMESPACE_NODE     *Node)
489 {
490     ACPI_STATUS             Status;
491     ACPI_PNP_DEVICE_ID      *Hid;
492     ACPI_PNP_DEVICE_ID_LIST *Cid;
493     UINT32                  i;
494     BOOLEAN                 Match;
495 
496 
497     /* Get the _HID and check for a PCI Root Bridge */
498 
499     Status = AcpiUtExecute_HID (Node, &Hid);
500     if (ACPI_FAILURE (Status))
501     {
502         return (FALSE);
503     }
504 
505     Match = AcpiUtIsPciRootBridge (Hid->String);
506     ACPI_FREE (Hid);
507 
508     if (Match)
509     {
510         return (TRUE);
511     }
512 
513     /* The _HID did not match. Get the _CID and check for a PCI Root Bridge */
514 
515     Status = AcpiUtExecute_CID (Node, &Cid);
516     if (ACPI_FAILURE (Status))
517     {
518         return (FALSE);
519     }
520 
521     /* Check all _CIDs in the returned list */
522 
523     for (i = 0; i < Cid->Count; i++)
524     {
525         if (AcpiUtIsPciRootBridge (Cid->Ids[i].String))
526         {
527             ACPI_FREE (Cid);
528             return (TRUE);
529         }
530     }
531 
532     ACPI_FREE (Cid);
533     return (FALSE);
534 }
535 
536 
537 /*******************************************************************************
538  *
539  * FUNCTION:    AcpiEvPciBarRegionSetup
540  *
541  * PARAMETERS:  Handle              - Region we are interested in
542  *              Function            - Start or stop
543  *              HandlerContext      - Address space handler context
544  *              RegionContext       - Region specific context
545  *
546  * RETURN:      Status
547  *
548  * DESCRIPTION: Setup a PciBAR operation region
549  *
550  * MUTEX:       Assumes namespace is not locked
551  *
552  ******************************************************************************/
553 
554 ACPI_STATUS
555 AcpiEvPciBarRegionSetup (
556     ACPI_HANDLE             Handle,
557     UINT32                  Function,
558     void                    *HandlerContext,
559     void                    **RegionContext)
560 {
561     ACPI_FUNCTION_TRACE (EvPciBarRegionSetup);
562 
563 
564     return_ACPI_STATUS (AE_OK);
565 }
566 
567 
568 /*******************************************************************************
569  *
570  * FUNCTION:    AcpiEvCmosRegionSetup
571  *
572  * PARAMETERS:  Handle              - Region we are interested in
573  *              Function            - Start or stop
574  *              HandlerContext      - Address space handler context
575  *              RegionContext       - Region specific context
576  *
577  * RETURN:      Status
578  *
579  * DESCRIPTION: Setup a CMOS operation region
580  *
581  * MUTEX:       Assumes namespace is not locked
582  *
583  ******************************************************************************/
584 
585 ACPI_STATUS
586 AcpiEvCmosRegionSetup (
587     ACPI_HANDLE             Handle,
588     UINT32                  Function,
589     void                    *HandlerContext,
590     void                    **RegionContext)
591 {
592     ACPI_FUNCTION_TRACE (EvCmosRegionSetup);
593 
594 
595     return_ACPI_STATUS (AE_OK);
596 }
597 
598 
599 /*******************************************************************************
600  *
601  * FUNCTION:    AcpiEvDefaultRegionSetup
602  *
603  * PARAMETERS:  Handle              - Region we are interested in
604  *              Function            - Start or stop
605  *              HandlerContext      - Address space handler context
606  *              RegionContext       - Region specific context
607  *
608  * RETURN:      Status
609  *
610  * DESCRIPTION: Default region initialization
611  *
612  ******************************************************************************/
613 
614 ACPI_STATUS
615 AcpiEvDefaultRegionSetup (
616     ACPI_HANDLE             Handle,
617     UINT32                  Function,
618     void                    *HandlerContext,
619     void                    **RegionContext)
620 {
621     ACPI_FUNCTION_TRACE (EvDefaultRegionSetup);
622 
623 
624     if (Function == ACPI_REGION_DEACTIVATE)
625     {
626         *RegionContext = NULL;
627     }
628     else
629     {
630         *RegionContext = HandlerContext;
631     }
632 
633     return_ACPI_STATUS (AE_OK);
634 }
635 
636 
637 /*******************************************************************************
638  *
639  * FUNCTION:    AcpiEvInitializeRegion
640  *
641  * PARAMETERS:  RegionObj       - Region we are initializing
642  *
643  * RETURN:      Status
644  *
645  * DESCRIPTION: Initializes the region, finds any _REG methods and saves them
646  *              for execution at a later time
647  *
648  *              Get the appropriate address space handler for a newly
649  *              created region.
650  *
651  *              This also performs address space specific initialization. For
652  *              example, PCI regions must have an _ADR object that contains
653  *              a PCI address in the scope of the definition. This address is
654  *              required to perform an access to PCI config space.
655  *
656  * MUTEX:       Interpreter should be unlocked, because we may run the _REG
657  *              method for this region.
658  *
659  * NOTE:        Possible incompliance:
660  *              There is a behavior conflict in automatic _REG execution:
661  *              1. When the interpreter is evaluating a method, we can only
662  *                 automatically run _REG for the following case:
663  *                   Method(_REG, 2) {}
664  *                   OperationRegion (OPR1, 0x80, 0x1000010, 0x4)
665  *              2. When the interpreter is loading a table, we can also
666  *                 automatically run _REG for the following case:
667  *                   OperationRegion (OPR1, 0x80, 0x1000010, 0x4)
668  *                   Method(_REG, 2) {}
669  *              Though this may not be compliant to the de-facto standard, the
670  *              logic is kept in order not to trigger regressions. And keeping
671  *              this logic should be taken care by the caller of this function.
672  *
673  ******************************************************************************/
674 
675 ACPI_STATUS
676 AcpiEvInitializeRegion (
677     ACPI_OPERAND_OBJECT     *RegionObj)
678 {
679     ACPI_OPERAND_OBJECT     *HandlerObj;
680     ACPI_OPERAND_OBJECT     *ObjDesc;
681     ACPI_ADR_SPACE_TYPE     SpaceId;
682     ACPI_NAMESPACE_NODE     *Node;
683 
684 
685     ACPI_FUNCTION_TRACE (EvInitializeRegion);
686 
687 
688     if (!RegionObj)
689     {
690         return_ACPI_STATUS (AE_BAD_PARAMETER);
691     }
692 
693     if (RegionObj->Common.Flags & AOPOBJ_OBJECT_INITIALIZED)
694     {
695         return_ACPI_STATUS (AE_OK);
696     }
697 
698     RegionObj->Common.Flags |= AOPOBJ_OBJECT_INITIALIZED;
699 
700     Node = RegionObj->Region.Node->Parent;
701     SpaceId = RegionObj->Region.SpaceId;
702 
703     /*
704      * The following loop depends upon the root Node having no parent
705      * ie: AcpiGbl_RootNode->Parent being set to NULL
706      */
707     while (Node)
708     {
709         /* Check to see if a handler exists */
710 
711         HandlerObj = NULL;
712         ObjDesc = AcpiNsGetAttachedObject (Node);
713         if (ObjDesc)
714         {
715             /* Can only be a handler if the object exists */
716 
717             switch (Node->Type)
718             {
719             case ACPI_TYPE_DEVICE:
720             case ACPI_TYPE_PROCESSOR:
721             case ACPI_TYPE_THERMAL:
722 
723                 HandlerObj = ObjDesc->CommonNotify.Handler;
724                 break;
725 
726             default:
727 
728                 /* Ignore other objects */
729 
730                 break;
731             }
732 
733             HandlerObj = AcpiEvFindRegionHandler (SpaceId, HandlerObj);
734             if (HandlerObj)
735             {
736                 /* Found correct handler */
737 
738                 ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
739                     "Found handler %p for region %p in obj %p\n",
740                     HandlerObj, RegionObj, ObjDesc));
741 
742                 (void) AcpiEvAttachRegion (HandlerObj, RegionObj, FALSE);
743 
744                 /*
745                  * Tell all users that this region is usable by
746                  * running the _REG method
747                  */
748                 AcpiExExitInterpreter ();
749                 (void) AcpiEvExecuteRegMethod (RegionObj, ACPI_REG_CONNECT);
750                 AcpiExEnterInterpreter ();
751                 return_ACPI_STATUS (AE_OK);
752             }
753         }
754 
755         /* This node does not have the handler we need; Pop up one level */
756 
757         Node = Node->Parent;
758     }
759 
760     /*
761      * If we get here, there is no handler for this region. This is not
762      * fatal because many regions get created before a handler is installed
763      * for said region.
764      */
765     ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
766         "No handler for RegionType %s(%X) (RegionObj %p)\n",
767         AcpiUtGetRegionName (SpaceId), SpaceId, RegionObj));
768 
769     return_ACPI_STATUS (AE_OK);
770 }
771