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