1 /******************************************************************************
3 * Module Name: evrgnini- ACPI AddressSpace (OpRegion) init
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2019, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
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.
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.
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.
150 *****************************************************************************/
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>
158 #define _COMPONENT ACPI_EVENTS
159 ACPI_MODULE_NAME ("evrgnini")
162 /*******************************************************************************
164 * FUNCTION: AcpiEvSystemMemoryRegionSetup
166 * PARAMETERS: Handle - Region we are interested in
167 * Function - Start or stop
168 * HandlerContext - Address space handler context
169 * RegionContext - Region specific context
173 * DESCRIPTION: Setup a SystemMemory operation region
175 ******************************************************************************/
178 AcpiEvSystemMemoryRegionSetup (
181 void *HandlerContext,
182 void **RegionContext)
184 ACPI_OPERAND_OBJECT *RegionDesc = (ACPI_OPERAND_OBJECT *) Handle;
185 ACPI_MEM_SPACE_CONTEXT *LocalRegionContext;
188 ACPI_FUNCTION_TRACE (EvSystemMemoryRegionSetup);
191 if (Function == ACPI_REGION_DEACTIVATE)
195 LocalRegionContext = (ACPI_MEM_SPACE_CONTEXT *) *RegionContext;
197 /* Delete a cached mapping if present */
199 if (LocalRegionContext->MappedLength)
201 AcpiOsUnmapMemory (LocalRegionContext->MappedLogicalAddress,
202 LocalRegionContext->MappedLength);
204 ACPI_FREE (LocalRegionContext);
205 *RegionContext = NULL;
207 return_ACPI_STATUS (AE_OK);
210 /* Create a new context */
212 LocalRegionContext = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_MEM_SPACE_CONTEXT));
213 if (!(LocalRegionContext))
215 return_ACPI_STATUS (AE_NO_MEMORY);
218 /* Save the region length and address for use in the handler */
220 LocalRegionContext->Length = RegionDesc->Region.Length;
221 LocalRegionContext->Address = RegionDesc->Region.Address;
223 *RegionContext = LocalRegionContext;
224 return_ACPI_STATUS (AE_OK);
228 /*******************************************************************************
230 * FUNCTION: AcpiEvIoSpaceRegionSetup
232 * PARAMETERS: Handle - Region we are interested in
233 * Function - Start or stop
234 * HandlerContext - Address space handler context
235 * RegionContext - Region specific context
239 * DESCRIPTION: Setup a IO operation region
241 ******************************************************************************/
244 AcpiEvIoSpaceRegionSetup (
247 void *HandlerContext,
248 void **RegionContext)
250 ACPI_FUNCTION_TRACE (EvIoSpaceRegionSetup);
253 if (Function == ACPI_REGION_DEACTIVATE)
255 *RegionContext = NULL;
259 *RegionContext = HandlerContext;
262 return_ACPI_STATUS (AE_OK);
266 /*******************************************************************************
268 * FUNCTION: AcpiEvPciConfigRegionSetup
270 * PARAMETERS: Handle - Region we are interested in
271 * Function - Start or stop
272 * HandlerContext - Address space handler context
273 * RegionContext - Region specific context
277 * DESCRIPTION: Setup a PCI_Config operation region
279 * MUTEX: Assumes namespace is not locked
281 ******************************************************************************/
284 AcpiEvPciConfigRegionSetup (
287 void *HandlerContext,
288 void **RegionContext)
290 ACPI_STATUS Status = AE_OK;
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;
300 ACPI_FUNCTION_TRACE (EvPciConfigRegionSetup);
303 HandlerObj = RegionObj->Region.Handler;
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.
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);
315 *RegionContext = NULL;
316 if (Function == ACPI_REGION_DEACTIVATE)
322 return_ACPI_STATUS (Status);
325 ParentNode = RegionObj->Region.Node->Parent;
328 * Get the _SEG and _BBN values from the device upon which the handler
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.
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.
340 if (HandlerObj->AddressSpace.Node == AcpiGbl_RootNode)
342 /* Start search from the parent object */
344 PciRootNode = ParentNode;
345 while (PciRootNode != AcpiGbl_RootNode)
347 /* Get the _HID/_CID in order to detect a RootBridge */
349 if (AcpiEvIsPciRootBridge (PciRootNode))
351 /* Install a handler for this PCI root bridge */
353 Status = AcpiInstallAddressSpaceHandler (
354 (ACPI_HANDLE) PciRootNode,
355 ACPI_ADR_SPACE_PCI_CONFIG,
356 ACPI_DEFAULT_HANDLER, NULL, NULL);
357 if (ACPI_FAILURE (Status))
359 if (Status == AE_SAME_HANDLER)
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.
370 ACPI_EXCEPTION ((AE_INFO, Status,
371 "Could not install PciConfig handler "
372 "for Root Bridge %4.4s",
373 AcpiUtGetNodeName (PciRootNode)));
379 PciRootNode = PciRootNode->Parent;
382 /* PCI root bridge not found, use namespace root node */
386 PciRootNode = HandlerObj->AddressSpace.Node;
390 * If this region is now initialized, we are done.
391 * (InstallAddressSpaceHandler could have initialized it)
393 if (RegionObj->Region.Flags & AOPOBJ_SETUP_COMPLETE)
395 return_ACPI_STATUS (AE_OK);
398 /* Region is still not initialized. Create a new context */
400 PciId = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_PCI_ID));
403 return_ACPI_STATUS (AE_NO_MEMORY);
407 * For PCI_Config space access, we need the segment, bus, device and
408 * function numbers. Acquire them here.
410 * Find the parent device object. (This allows the operation region to be
411 * within a subscope under the device, such as a control method.)
413 PciDeviceNode = RegionObj->Region.Node;
414 while (PciDeviceNode && (PciDeviceNode->Type != ACPI_TYPE_DEVICE))
416 PciDeviceNode = PciDeviceNode->Parent;
422 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
426 * Get the PCI device and function numbers from the _ADR object
427 * contained in the parent's scope.
429 Status = AcpiUtEvaluateNumericObject (METHOD_NAME__ADR,
430 PciDeviceNode, &PciValue);
433 * The default is zero, and since the allocation above zeroed the data,
434 * just do nothing on failure.
436 if (ACPI_SUCCESS (Status))
438 PciId->Device = ACPI_HIWORD (ACPI_LODWORD (PciValue));
439 PciId->Function = ACPI_LOWORD (ACPI_LODWORD (PciValue));
442 /* The PCI segment number comes from the _SEG method */
444 Status = AcpiUtEvaluateNumericObject (METHOD_NAME__SEG,
445 PciRootNode, &PciValue);
446 if (ACPI_SUCCESS (Status))
448 PciId->Segment = ACPI_LOWORD (PciValue);
451 /* The PCI bus number comes from the _BBN method */
453 Status = AcpiUtEvaluateNumericObject (METHOD_NAME__BBN,
454 PciRootNode, &PciValue);
455 if (ACPI_SUCCESS (Status))
457 PciId->Bus = ACPI_LOWORD (PciValue);
460 /* Complete/update the PCI ID for this device */
462 Status = AcpiHwDerivePciId (PciId, PciRootNode, RegionObj->Region.Node);
463 if (ACPI_FAILURE (Status))
466 return_ACPI_STATUS (Status);
469 *RegionContext = PciId;
470 return_ACPI_STATUS (AE_OK);
474 /*******************************************************************************
476 * FUNCTION: AcpiEvIsPciRootBridge
478 * PARAMETERS: Node - Device node being examined
480 * RETURN: TRUE if device is a PCI/PCI-Express Root Bridge
482 * DESCRIPTION: Determine if the input device represents a PCI Root Bridge by
483 * examining the _HID and _CID for the device.
485 ******************************************************************************/
488 AcpiEvIsPciRootBridge (
489 ACPI_NAMESPACE_NODE *Node)
492 ACPI_PNP_DEVICE_ID *Hid;
493 ACPI_PNP_DEVICE_ID_LIST *Cid;
498 /* Get the _HID and check for a PCI Root Bridge */
500 Status = AcpiUtExecute_HID (Node, &Hid);
501 if (ACPI_FAILURE (Status))
506 Match = AcpiUtIsPciRootBridge (Hid->String);
514 /* The _HID did not match. Get the _CID and check for a PCI Root Bridge */
516 Status = AcpiUtExecute_CID (Node, &Cid);
517 if (ACPI_FAILURE (Status))
522 /* Check all _CIDs in the returned list */
524 for (i = 0; i < Cid->Count; i++)
526 if (AcpiUtIsPciRootBridge (Cid->Ids[i].String))
538 /*******************************************************************************
540 * FUNCTION: AcpiEvPciBarRegionSetup
542 * PARAMETERS: Handle - Region we are interested in
543 * Function - Start or stop
544 * HandlerContext - Address space handler context
545 * RegionContext - Region specific context
549 * DESCRIPTION: Setup a PciBAR operation region
551 * MUTEX: Assumes namespace is not locked
553 ******************************************************************************/
556 AcpiEvPciBarRegionSetup (
559 void *HandlerContext,
560 void **RegionContext)
562 ACPI_FUNCTION_TRACE (EvPciBarRegionSetup);
565 return_ACPI_STATUS (AE_OK);
569 /*******************************************************************************
571 * FUNCTION: AcpiEvCmosRegionSetup
573 * PARAMETERS: Handle - Region we are interested in
574 * Function - Start or stop
575 * HandlerContext - Address space handler context
576 * RegionContext - Region specific context
580 * DESCRIPTION: Setup a CMOS operation region
582 * MUTEX: Assumes namespace is not locked
584 ******************************************************************************/
587 AcpiEvCmosRegionSetup (
590 void *HandlerContext,
591 void **RegionContext)
593 ACPI_FUNCTION_TRACE (EvCmosRegionSetup);
596 return_ACPI_STATUS (AE_OK);
600 /*******************************************************************************
602 * FUNCTION: AcpiEvDefaultRegionSetup
604 * PARAMETERS: Handle - Region we are interested in
605 * Function - Start or stop
606 * HandlerContext - Address space handler context
607 * RegionContext - Region specific context
611 * DESCRIPTION: Default region initialization
613 ******************************************************************************/
616 AcpiEvDefaultRegionSetup (
619 void *HandlerContext,
620 void **RegionContext)
622 ACPI_FUNCTION_TRACE (EvDefaultRegionSetup);
625 if (Function == ACPI_REGION_DEACTIVATE)
627 *RegionContext = NULL;
631 *RegionContext = HandlerContext;
634 return_ACPI_STATUS (AE_OK);
638 /*******************************************************************************
640 * FUNCTION: AcpiEvInitializeRegion
642 * PARAMETERS: RegionObj - Region we are initializing
646 * DESCRIPTION: Initializes the region, finds any _REG methods and saves them
647 * for execution at a later time
649 * Get the appropriate address space handler for a newly
652 * This also performs address space specific initialization. For
653 * example, PCI regions must have an _ADR object that contains
654 * a PCI address in the scope of the definition. This address is
655 * required to perform an access to PCI config space.
657 * MUTEX: Interpreter should be unlocked, because we may run the _REG
658 * method for this region.
660 * NOTE: Possible incompliance:
661 * There is a behavior conflict in automatic _REG execution:
662 * 1. When the interpreter is evaluating a method, we can only
663 * automatically run _REG for the following case:
665 * OperationRegion (OPR1, 0x80, 0x1000010, 0x4)
666 * 2. When the interpreter is loading a table, we can also
667 * automatically run _REG for the following case:
668 * OperationRegion (OPR1, 0x80, 0x1000010, 0x4)
670 * Though this may not be compliant to the de-facto standard, the
671 * logic is kept in order not to trigger regressions. And keeping
672 * this logic should be taken care by the caller of this function.
674 ******************************************************************************/
677 AcpiEvInitializeRegion (
678 ACPI_OPERAND_OBJECT *RegionObj)
680 ACPI_OPERAND_OBJECT *HandlerObj;
681 ACPI_OPERAND_OBJECT *ObjDesc;
682 ACPI_ADR_SPACE_TYPE SpaceId;
683 ACPI_NAMESPACE_NODE *Node;
686 ACPI_FUNCTION_TRACE (EvInitializeRegion);
691 return_ACPI_STATUS (AE_BAD_PARAMETER);
694 if (RegionObj->Common.Flags & AOPOBJ_OBJECT_INITIALIZED)
696 return_ACPI_STATUS (AE_OK);
699 RegionObj->Common.Flags |= AOPOBJ_OBJECT_INITIALIZED;
701 Node = RegionObj->Region.Node->Parent;
702 SpaceId = RegionObj->Region.SpaceId;
705 * The following loop depends upon the root Node having no parent
706 * ie: AcpiGbl_RootNode->Parent being set to NULL
710 /* Check to see if a handler exists */
713 ObjDesc = AcpiNsGetAttachedObject (Node);
716 /* Can only be a handler if the object exists */
720 case ACPI_TYPE_DEVICE:
721 case ACPI_TYPE_PROCESSOR:
722 case ACPI_TYPE_THERMAL:
724 HandlerObj = ObjDesc->CommonNotify.Handler;
729 /* Ignore other objects */
734 HandlerObj = AcpiEvFindRegionHandler (SpaceId, HandlerObj);
737 /* Found correct handler */
739 ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
740 "Found handler %p for region %p in obj %p\n",
741 HandlerObj, RegionObj, ObjDesc));
743 (void) AcpiEvAttachRegion (HandlerObj, RegionObj, FALSE);
746 * Tell all users that this region is usable by
747 * running the _REG method
749 AcpiExExitInterpreter ();
750 (void) AcpiEvExecuteRegMethod (RegionObj, ACPI_REG_CONNECT);
751 AcpiExEnterInterpreter ();
752 return_ACPI_STATUS (AE_OK);
756 /* This node does not have the handler we need; Pop up one level */
762 * If we get here, there is no handler for this region. This is not
763 * fatal because many regions get created before a handler is installed
766 ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
767 "No handler for RegionType %s(%X) (RegionObj %p)\n",
768 AcpiUtGetRegionName (SpaceId), SpaceId, RegionObj));
770 return_ACPI_STATUS (AE_OK);