2 Provides the basic interfaces to abstract a PCI Host Bridge Resource Allocation
4 Copyright (c) 2008 - 2013, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials are
6 licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #include "PciHostBridge.h"
18 // Hard code: Root Bridge Number within the host bridge
19 // Root Bridge's attribute
20 // Root Bridge's device path
21 // Root Bridge's resource aperture
23 UINTN RootBridgeNumber
[1] = { 1 };
25 UINT64 RootBridgeAttribute
[1][1] = { { EFI_PCI_HOST_BRIDGE_COMBINE_MEM_PMEM
} };
27 EFI_PCI_ROOT_BRIDGE_DEVICE_PATH mEfiPciRootBridgeDevicePath
[1][1] = {
35 (UINT8
) (sizeof(ACPI_HID_DEVICE_PATH
)),
36 (UINT8
) ((sizeof(ACPI_HID_DEVICE_PATH
)) >> 8)
45 END_ENTIRE_DEVICE_PATH_SUBTYPE
,
47 END_DEVICE_PATH_LENGTH
,
55 STATIC PCI_ROOT_BRIDGE_RESOURCE_APERTURE mResAperture
[1][1];
57 EFI_HANDLE mDriverImageHandle
;
59 PCI_HOST_BRIDGE_INSTANCE mPciHostBridgeInstanceTemplate
= {
60 PCI_HOST_BRIDGE_SIGNATURE
, // Signature
61 NULL
, // HostBridgeHandle
62 0, // RootBridgeNumber
64 FALSE
, // ResourceSubiteed
83 Entry point of this driver
85 @param ImageHandle Handle of driver image
86 @param SystemTable Point to EFI_SYSTEM_TABLE
88 @retval EFI_ABORTED PCI host bridge not present
89 @retval EFI_OUT_OF_RESOURCES Can not allocate memory resource
90 @retval EFI_DEVICE_ERROR Can not install the protocol instance
91 @retval EFI_SUCCESS Success to initialize the Pci host bridge.
95 InitializePciHostBridge (
96 IN EFI_HANDLE ImageHandle
,
97 IN EFI_SYSTEM_TABLE
*SystemTable
100 UINT64 MmioAttributes
;
104 PCI_HOST_BRIDGE_INSTANCE
*HostBridge
;
105 PCI_ROOT_BRIDGE_INSTANCE
*PrivateData
;
107 if (PcdGet64 (PcdPciExpressBaseAddress
) == 0) {
108 DEBUG ((EFI_D_INFO
, "%a: PCI host bridge not present\n", __FUNCTION__
));
112 mDriverImageHandle
= ImageHandle
;
114 mResAperture
[0][0].BusBase
= PcdGet32 (PcdPciBusMin
);
115 mResAperture
[0][0].BusLimit
= PcdGet32 (PcdPciBusMax
);
117 mResAperture
[0][0].MemBase
= PcdGet32 (PcdPciMmio32Base
);
118 mResAperture
[0][0].MemLimit
= (UINT64
)PcdGet32 (PcdPciMmio32Base
) +
119 PcdGet32 (PcdPciMmio32Size
) - 1;
121 mResAperture
[0][0].IoBase
= PcdGet64 (PcdPciIoBase
);
122 mResAperture
[0][0].IoLimit
= PcdGet64 (PcdPciIoBase
) +
123 PcdGet64 (PcdPciIoSize
) - 1;
124 mResAperture
[0][0].IoTranslation
= PcdGet64 (PcdPciIoTranslation
);
127 // Add IO and MMIO memory space, so that resources can be allocated in the
128 // EfiPciHostBridgeAllocateResources phase.
130 Status
= gDS
->AddIoSpace (
132 PcdGet64 (PcdPciIoBase
),
133 PcdGet64 (PcdPciIoSize
)
135 ASSERT_EFI_ERROR (Status
);
137 MmioAttributes
= FeaturePcdGet (PcdKludgeMapPciMmioAsCached
) ?
138 EFI_MEMORY_WB
: EFI_MEMORY_UC
;
140 Status
= gDS
->AddMemorySpace (
141 EfiGcdMemoryTypeMemoryMappedIo
,
142 PcdGet32 (PcdPciMmio32Base
),
143 PcdGet32 (PcdPciMmio32Size
),
146 if (EFI_ERROR (Status
)) {
147 DEBUG ((EFI_D_ERROR
, "%a: AddMemorySpace: %r\n", __FUNCTION__
, Status
));
151 Status
= gDS
->SetMemorySpaceAttributes (
152 PcdGet32 (PcdPciMmio32Base
),
153 PcdGet32 (PcdPciMmio32Size
),
156 if (EFI_ERROR (Status
)) {
157 DEBUG ((EFI_D_ERROR
, "%a: SetMemorySpaceAttributes: %r\n", __FUNCTION__
,
163 // Create Host Bridge Device Handle
165 for (Loop1
= 0; Loop1
< HOST_BRIDGE_NUMBER
; Loop1
++) {
166 HostBridge
= AllocateCopyPool (sizeof(PCI_HOST_BRIDGE_INSTANCE
), &mPciHostBridgeInstanceTemplate
);
167 if (HostBridge
== NULL
) {
168 return EFI_OUT_OF_RESOURCES
;
171 HostBridge
->RootBridgeNumber
= RootBridgeNumber
[Loop1
];
172 InitializeListHead (&HostBridge
->Head
);
174 Status
= gBS
->InstallMultipleProtocolInterfaces (
175 &HostBridge
->HostBridgeHandle
,
176 &gEfiPciHostBridgeResourceAllocationProtocolGuid
, &HostBridge
->ResAlloc
,
179 if (EFI_ERROR (Status
)) {
180 FreePool (HostBridge
);
181 return EFI_DEVICE_ERROR
;
185 // Create Root Bridge Device Handle in this Host Bridge
188 for (Loop2
= 0; Loop2
< HostBridge
->RootBridgeNumber
; Loop2
++) {
189 PrivateData
= AllocateZeroPool (sizeof(PCI_ROOT_BRIDGE_INSTANCE
));
190 if (PrivateData
== NULL
) {
191 return EFI_OUT_OF_RESOURCES
;
194 PrivateData
->Signature
= PCI_ROOT_BRIDGE_SIGNATURE
;
195 PrivateData
->DevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*)&mEfiPciRootBridgeDevicePath
[Loop1
][Loop2
];
197 RootBridgeConstructor (
199 HostBridge
->HostBridgeHandle
,
200 RootBridgeAttribute
[Loop1
][Loop2
],
201 &mResAperture
[Loop1
][Loop2
]
204 Status
= gBS
->InstallMultipleProtocolInterfaces(
205 &PrivateData
->Handle
,
206 &gEfiDevicePathProtocolGuid
, PrivateData
->DevicePath
,
207 &gEfiPciRootBridgeIoProtocolGuid
, &PrivateData
->Io
,
210 if (EFI_ERROR (Status
)) {
211 FreePool(PrivateData
);
212 return EFI_DEVICE_ERROR
;
215 InsertTailList (&HostBridge
->Head
, &PrivateData
->Link
);
224 These are the notifications from the PCI bus driver that it is about to enter a certain
225 phase of the PCI enumeration process.
227 This member function can be used to notify the host bridge driver to perform specific actions,
228 including any chipset-specific initialization, so that the chipset is ready to enter the next phase.
229 Eight notification points are defined at this time. See belows:
230 EfiPciHostBridgeBeginEnumeration Resets the host bridge PCI apertures and internal data
231 structures. The PCI enumerator should issue this notification
232 before starting a fresh enumeration process. Enumeration cannot
233 be restarted after sending any other notification such as
234 EfiPciHostBridgeBeginBusAllocation.
235 EfiPciHostBridgeBeginBusAllocation The bus allocation phase is about to begin. No specific action is
236 required here. This notification can be used to perform any
237 chipset-specific programming.
238 EfiPciHostBridgeEndBusAllocation The bus allocation and bus programming phase is complete. No
239 specific action is required here. This notification can be used to
240 perform any chipset-specific programming.
241 EfiPciHostBridgeBeginResourceAllocation
242 The resource allocation phase is about to begin. No specific
243 action is required here. This notification can be used to perform
244 any chipset-specific programming.
245 EfiPciHostBridgeAllocateResources Allocates resources per previously submitted requests for all the PCI
246 root bridges. These resource settings are returned on the next call to
247 GetProposedResources(). Before calling NotifyPhase() with a Phase of
248 EfiPciHostBridgeAllocateResource, the PCI bus enumerator is responsible
249 for gathering I/O and memory requests for
250 all the PCI root bridges and submitting these requests using
251 SubmitResources(). This function pads the resource amount
252 to suit the root bridge hardware, takes care of dependencies between
253 the PCI root bridges, and calls the Global Coherency Domain (GCD)
254 with the allocation request. In the case of padding, the allocated range
255 could be bigger than what was requested.
256 EfiPciHostBridgeSetResources Programs the host bridge hardware to decode previously allocated
257 resources (proposed resources) for all the PCI root bridges. After the
258 hardware is programmed, reassigning resources will not be supported.
259 The bus settings are not affected.
260 EfiPciHostBridgeFreeResources Deallocates resources that were previously allocated for all the PCI
261 root bridges and resets the I/O and memory apertures to their initial
262 state. The bus settings are not affected. If the request to allocate
263 resources fails, the PCI enumerator can use this notification to
264 deallocate previous resources, adjust the requests, and retry
266 EfiPciHostBridgeEndResourceAllocation The resource allocation phase is completed. No specific action is
267 required here. This notification can be used to perform any chipsetspecific
270 @param[in] This The instance pointer of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
271 @param[in] Phase The phase during enumeration
273 @retval EFI_NOT_READY This phase cannot be entered at this time. For example, this error
274 is valid for a Phase of EfiPciHostBridgeAllocateResources if
275 SubmitResources() has not been called for one or more
276 PCI root bridges before this call
277 @retval EFI_DEVICE_ERROR Programming failed due to a hardware error. This error is valid
278 for a Phase of EfiPciHostBridgeSetResources.
279 @retval EFI_INVALID_PARAMETER Invalid phase parameter
280 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
281 This error is valid for a Phase of EfiPciHostBridgeAllocateResources if the
282 previously submitted resource requests cannot be fulfilled or
283 were only partially fulfilled.
284 @retval EFI_SUCCESS The notification was accepted without any errors.
290 IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
*This
,
291 IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE Phase
294 PCI_HOST_BRIDGE_INSTANCE
*HostBridgeInstance
;
295 PCI_ROOT_BRIDGE_INSTANCE
*RootBridgeInstance
;
296 PCI_RESOURCE_TYPE Index
;
298 EFI_PHYSICAL_ADDRESS BaseAddress
;
300 UINTN BitsOfAlignment
;
302 EFI_STATUS ReturnStatus
;
304 HostBridgeInstance
= INSTANCE_FROM_RESOURCE_ALLOCATION_THIS (This
);
308 case EfiPciHostBridgeBeginEnumeration
:
309 if (HostBridgeInstance
->CanRestarted
) {
311 // Reset the Each Root Bridge
313 List
= HostBridgeInstance
->Head
.ForwardLink
;
315 while (List
!= &HostBridgeInstance
->Head
) {
316 RootBridgeInstance
= DRIVER_INSTANCE_FROM_LIST_ENTRY (List
);
317 for (Index
= TypeIo
; Index
< TypeMax
; Index
++) {
318 RootBridgeInstance
->ResAllocNode
[Index
].Type
= Index
;
319 RootBridgeInstance
->ResAllocNode
[Index
].Base
= 0;
320 RootBridgeInstance
->ResAllocNode
[Index
].Length
= 0;
321 RootBridgeInstance
->ResAllocNode
[Index
].Status
= ResNone
;
324 List
= List
->ForwardLink
;
327 HostBridgeInstance
->ResourceSubmited
= FALSE
;
328 HostBridgeInstance
->CanRestarted
= TRUE
;
333 return EFI_NOT_READY
;
337 case EfiPciHostBridgeEndEnumeration
:
340 case EfiPciHostBridgeBeginBusAllocation
:
342 // No specific action is required here, can perform any chipset specific programing
344 HostBridgeInstance
->CanRestarted
= FALSE
;
347 case EfiPciHostBridgeEndBusAllocation
:
349 // No specific action is required here, can perform any chipset specific programing
351 //HostBridgeInstance->CanRestarted = FALSE;
354 case EfiPciHostBridgeBeginResourceAllocation
:
356 // No specific action is required here, can perform any chipset specific programing
358 //HostBridgeInstance->CanRestarted = FALSE;
361 case EfiPciHostBridgeAllocateResources
:
362 ReturnStatus
= EFI_SUCCESS
;
363 if (HostBridgeInstance
->ResourceSubmited
) {
365 // Take care of the resource dependencies between the root bridges
367 List
= HostBridgeInstance
->Head
.ForwardLink
;
369 while (List
!= &HostBridgeInstance
->Head
) {
370 RootBridgeInstance
= DRIVER_INSTANCE_FROM_LIST_ENTRY (List
);
371 for (Index
= TypeIo
; Index
< TypeBus
; Index
++) {
372 if (RootBridgeInstance
->ResAllocNode
[Index
].Status
!= ResNone
) {
374 AddrLen
= RootBridgeInstance
->ResAllocNode
[Index
].Length
;
377 // Get the number of '1' in Alignment.
379 BitsOfAlignment
= (UINTN
) (HighBitSet64 (RootBridgeInstance
->ResAllocNode
[Index
].Alignment
) + 1);
385 // It is impossible for this chipset to align 0xFFFF for IO16
388 if (BitsOfAlignment
>= 16) {
392 BaseAddress
= mResAperture
[0][0].IoLimit
;
393 Status
= gDS
->AllocateIoSpace (
394 EfiGcdAllocateMaxAddressSearchTopDown
,
403 if (!EFI_ERROR (Status
)) {
404 RootBridgeInstance
->ResAllocNode
[Index
].Base
= (UINTN
)BaseAddress
;
405 RootBridgeInstance
->ResAllocNode
[Index
].Status
= ResAllocated
;
407 ReturnStatus
= Status
;
408 if (Status
!= EFI_OUT_OF_RESOURCES
) {
409 RootBridgeInstance
->ResAllocNode
[Index
].Length
= 0;
418 // It is impossible for this chipset to align 0xFFFFFFFF for Mem32
422 if (BitsOfAlignment
>= 32) {
426 BaseAddress
= mResAperture
[0][0].MemLimit
;
427 Status
= gDS
->AllocateMemorySpace (
428 EfiGcdAllocateMaxAddressSearchTopDown
,
429 EfiGcdMemoryTypeMemoryMappedIo
,
437 if (!EFI_ERROR (Status
)) {
438 // We were able to allocate the PCI memory
439 RootBridgeInstance
->ResAllocNode
[Index
].Base
= (UINTN
)BaseAddress
;
440 RootBridgeInstance
->ResAllocNode
[Index
].Status
= ResAllocated
;
443 // Not able to allocate enough PCI memory
444 ReturnStatus
= Status
;
446 if (Status
!= EFI_OUT_OF_RESOURCES
) {
447 RootBridgeInstance
->ResAllocNode
[Index
].Length
= 0;
456 ReturnStatus
= EFI_ABORTED
;
465 List
= List
->ForwardLink
;
471 return EFI_NOT_READY
;
475 case EfiPciHostBridgeSetResources
:
478 case EfiPciHostBridgeFreeResources
:
479 ReturnStatus
= EFI_SUCCESS
;
480 List
= HostBridgeInstance
->Head
.ForwardLink
;
481 while (List
!= &HostBridgeInstance
->Head
) {
482 RootBridgeInstance
= DRIVER_INSTANCE_FROM_LIST_ENTRY (List
);
483 for (Index
= TypeIo
; Index
< TypeBus
; Index
++) {
484 if (RootBridgeInstance
->ResAllocNode
[Index
].Status
== ResAllocated
) {
485 AddrLen
= RootBridgeInstance
->ResAllocNode
[Index
].Length
;
486 BaseAddress
= RootBridgeInstance
->ResAllocNode
[Index
].Base
;
490 Status
= gDS
->FreeIoSpace (BaseAddress
, AddrLen
);
491 if (EFI_ERROR (Status
)) {
492 ReturnStatus
= Status
;
497 Status
= gDS
->FreeMemorySpace (BaseAddress
, AddrLen
);
498 if (EFI_ERROR (Status
)) {
499 ReturnStatus
= Status
;
517 RootBridgeInstance
->ResAllocNode
[Index
].Type
= Index
;
518 RootBridgeInstance
->ResAllocNode
[Index
].Base
= 0;
519 RootBridgeInstance
->ResAllocNode
[Index
].Length
= 0;
520 RootBridgeInstance
->ResAllocNode
[Index
].Status
= ResNone
;
524 List
= List
->ForwardLink
;
527 HostBridgeInstance
->ResourceSubmited
= FALSE
;
528 HostBridgeInstance
->CanRestarted
= TRUE
;
531 case EfiPciHostBridgeEndResourceAllocation
:
532 HostBridgeInstance
->CanRestarted
= FALSE
;
536 return EFI_INVALID_PARAMETER
;
543 Return the device handle of the next PCI root bridge that is associated with this Host Bridge.
545 This function is called multiple times to retrieve the device handles of all the PCI root bridges that
546 are associated with this PCI host bridge. Each PCI host bridge is associated with one or more PCI
547 root bridges. On each call, the handle that was returned by the previous call is passed into the
548 interface, and on output the interface returns the device handle of the next PCI root bridge. The
549 caller can use the handle to obtain the instance of the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
550 for that root bridge. When there are no more PCI root bridges to report, the interface returns
551 EFI_NOT_FOUND. A PCI enumerator must enumerate the PCI root bridges in the order that they
552 are returned by this function.
553 For D945 implementation, there is only one root bridge in PCI host bridge.
555 @param[in] This The instance pointer of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
556 @param[in, out] RootBridgeHandle Returns the device handle of the next PCI root bridge.
558 @retval EFI_SUCCESS If parameter RootBridgeHandle = NULL, then return the first Rootbridge handle of the
559 specific Host bridge and return EFI_SUCCESS.
560 @retval EFI_NOT_FOUND Can not find the any more root bridge in specific host bridge.
561 @retval EFI_INVALID_PARAMETER RootBridgeHandle is not an EFI_HANDLE that was
562 returned on a previous call to GetNextRootBridge().
567 IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
*This
,
568 IN OUT EFI_HANDLE
*RootBridgeHandle
571 BOOLEAN NoRootBridge
;
573 PCI_HOST_BRIDGE_INSTANCE
*HostBridgeInstance
;
574 PCI_ROOT_BRIDGE_INSTANCE
*RootBridgeInstance
;
577 HostBridgeInstance
= INSTANCE_FROM_RESOURCE_ALLOCATION_THIS (This
);
578 List
= HostBridgeInstance
->Head
.ForwardLink
;
581 while (List
!= &HostBridgeInstance
->Head
) {
582 NoRootBridge
= FALSE
;
583 RootBridgeInstance
= DRIVER_INSTANCE_FROM_LIST_ENTRY (List
);
584 if (*RootBridgeHandle
== NULL
) {
586 // Return the first Root Bridge Handle of the Host Bridge
588 *RootBridgeHandle
= RootBridgeInstance
->Handle
;
591 if (*RootBridgeHandle
== RootBridgeInstance
->Handle
) {
595 List
= List
->ForwardLink
;
596 if (List
!=&HostBridgeInstance
->Head
) {
597 RootBridgeInstance
= DRIVER_INSTANCE_FROM_LIST_ENTRY (List
);
598 *RootBridgeHandle
= RootBridgeInstance
->Handle
;
601 return EFI_NOT_FOUND
;
606 List
= List
->ForwardLink
;
610 return EFI_NOT_FOUND
;
612 return EFI_INVALID_PARAMETER
;
617 Returns the allocation attributes of a PCI root bridge.
619 The function returns the allocation attributes of a specific PCI root bridge. The attributes can vary
620 from one PCI root bridge to another. These attributes are different from the decode-related
621 attributes that are returned by the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.GetAttributes() member function. The
622 RootBridgeHandle parameter is used to specify the instance of the PCI root bridge. The device
623 handles of all the root bridges that are associated with this host bridge must be obtained by calling
624 GetNextRootBridge(). The attributes are static in the sense that they do not change during or
625 after the enumeration process. The hardware may provide mechanisms to change the attributes on
626 the fly, but such changes must be completed before EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL is
627 installed. The permitted values of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ATTRIBUTES are defined in
628 "Related Definitions" below. The caller uses these attributes to combine multiple resource requests.
629 For example, if the flag EFI_PCI_HOST_BRIDGE_COMBINE_MEM_PMEM is set, the PCI bus enumerator needs to
630 include requests for the prefetchable memory in the nonprefetchable memory pool and not request any
632 Attribute Description
633 ------------------------------------ ----------------------------------------------------------------------
634 EFI_PCI_HOST_BRIDGE_COMBINE_MEM_PMEM If this bit is set, then the PCI root bridge does not support separate
635 windows for nonprefetchable and prefetchable memory. A PCI bus
636 driver needs to include requests for prefetchable memory in the
637 nonprefetchable memory pool.
639 EFI_PCI_HOST_BRIDGE_MEM64_DECODE If this bit is set, then the PCI root bridge supports 64-bit memory
640 windows. If this bit is not set, the PCI bus driver needs to include
641 requests for a 64-bit memory address in the corresponding 32-bit
644 @param[in] This The instance pointer of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
645 @param[in] RootBridgeHandle The device handle of the PCI root bridge in which the caller is interested. Type
646 EFI_HANDLE is defined in InstallProtocolInterface() in the UEFI 2.0 Specification.
647 @param[out] Attributes The pointer to attribte of root bridge, it is output parameter
649 @retval EFI_INVALID_PARAMETER Attribute pointer is NULL
650 @retval EFI_INVALID_PARAMETER RootBridgehandle is invalid.
651 @retval EFI_SUCCESS Success to get attribute of interested root bridge.
657 IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
*This
,
658 IN EFI_HANDLE RootBridgeHandle
,
659 OUT UINT64
*Attributes
663 PCI_HOST_BRIDGE_INSTANCE
*HostBridgeInstance
;
664 PCI_ROOT_BRIDGE_INSTANCE
*RootBridgeInstance
;
666 if (Attributes
== NULL
) {
667 return EFI_INVALID_PARAMETER
;
670 HostBridgeInstance
= INSTANCE_FROM_RESOURCE_ALLOCATION_THIS (This
);
671 List
= HostBridgeInstance
->Head
.ForwardLink
;
673 while (List
!= &HostBridgeInstance
->Head
) {
674 RootBridgeInstance
= DRIVER_INSTANCE_FROM_LIST_ENTRY (List
);
675 if (RootBridgeHandle
== RootBridgeInstance
->Handle
) {
676 *Attributes
= RootBridgeInstance
->RootBridgeAttrib
;
679 List
= List
->ForwardLink
;
683 // RootBridgeHandle is not an EFI_HANDLE
684 // that was returned on a previous call to GetNextRootBridge()
686 return EFI_INVALID_PARAMETER
;
690 Sets up the specified PCI root bridge for the bus enumeration process.
692 This member function sets up the root bridge for bus enumeration and returns the PCI bus range
693 over which the search should be performed in ACPI 2.0 resource descriptor format.
695 @param[in] This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance.
696 @param[in] RootBridgeHandle The PCI Root Bridge to be set up.
697 @param[out] Configuration Pointer to the pointer to the PCI bus resource descriptor.
699 @retval EFI_INVALID_PARAMETER Invalid Root bridge's handle
700 @retval EFI_OUT_OF_RESOURCES Fail to allocate ACPI resource descriptor tag.
701 @retval EFI_SUCCESS Sucess to allocate ACPI resource descriptor.
707 IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
*This
,
708 IN EFI_HANDLE RootBridgeHandle
,
709 OUT VOID
**Configuration
713 PCI_HOST_BRIDGE_INSTANCE
*HostBridgeInstance
;
714 PCI_ROOT_BRIDGE_INSTANCE
*RootBridgeInstance
;
720 HostBridgeInstance
= INSTANCE_FROM_RESOURCE_ALLOCATION_THIS (This
);
721 List
= HostBridgeInstance
->Head
.ForwardLink
;
723 while (List
!= &HostBridgeInstance
->Head
) {
724 RootBridgeInstance
= DRIVER_INSTANCE_FROM_LIST_ENTRY (List
);
725 if (RootBridgeHandle
== RootBridgeInstance
->Handle
) {
727 // Set up the Root Bridge for Bus Enumeration
729 BusStart
= RootBridgeInstance
->BusBase
;
730 BusEnd
= RootBridgeInstance
->BusLimit
;
732 // Program the Hardware(if needed) if error return EFI_DEVICE_ERROR
735 Buffer
= AllocatePool (sizeof(EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
) + sizeof(EFI_ACPI_END_TAG_DESCRIPTOR
));
736 if (Buffer
== NULL
) {
737 return EFI_OUT_OF_RESOURCES
;
740 Temp
= (UINT8
*)Buffer
;
742 ((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*)Temp
)->Desc
= 0x8A;
743 ((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*)Temp
)->Len
= 0x2B;
744 ((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*)Temp
)->ResType
= 2;
745 ((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*)Temp
)->GenFlag
= 0;
746 ((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*)Temp
)->SpecificFlag
= 0;
747 ((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*)Temp
)->AddrSpaceGranularity
= 0;
748 ((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*)Temp
)->AddrRangeMin
= BusStart
;
749 ((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*)Temp
)->AddrRangeMax
= 0;
750 ((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*)Temp
)->AddrTranslationOffset
= 0;
751 ((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*)Temp
)->AddrLen
= BusEnd
- BusStart
+ 1;
753 Temp
= Temp
+ sizeof(EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
);
754 ((EFI_ACPI_END_TAG_DESCRIPTOR
*)Temp
)->Desc
= 0x79;
755 ((EFI_ACPI_END_TAG_DESCRIPTOR
*)Temp
)->Checksum
= 0x0;
757 *Configuration
= Buffer
;
760 List
= List
->ForwardLink
;
763 return EFI_INVALID_PARAMETER
;
767 Programs the PCI root bridge hardware so that it decodes the specified PCI bus range.
769 This member function programs the specified PCI root bridge to decode the bus range that is
770 specified by the input parameter Configuration.
771 The bus range information is specified in terms of the ACPI 2.0 resource descriptor format.
773 @param[in] This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
774 @param[in] RootBridgeHandle The PCI Root Bridge whose bus range is to be programmed
775 @param[in] Configuration The pointer to the PCI bus resource descriptor
777 @retval EFI_INVALID_PARAMETER RootBridgeHandle is not a valid root bridge handle.
778 @retval EFI_INVALID_PARAMETER Configuration is NULL.
779 @retval EFI_INVALID_PARAMETER Configuration does not point to a valid ACPI 2.0 resource descriptor.
780 @retval EFI_INVALID_PARAMETER Configuration does not include a valid ACPI 2.0 bus resource descriptor.
781 @retval EFI_INVALID_PARAMETER Configuration includes valid ACPI 2.0 resource descriptors other than
783 @retval EFI_INVALID_PARAMETER Configuration contains one or more invalid ACPI resource descriptors.
784 @retval EFI_INVALID_PARAMETER "Address Range Minimum" is invalid for this root bridge.
785 @retval EFI_INVALID_PARAMETER "Address Range Length" is invalid for this root bridge.
786 @retval EFI_DEVICE_ERROR Programming failed due to a hardware error.
787 @retval EFI_SUCCESS The bus range for the PCI root bridge was programmed.
793 IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
*This
,
794 IN EFI_HANDLE RootBridgeHandle
,
795 IN VOID
*Configuration
799 PCI_HOST_BRIDGE_INSTANCE
*HostBridgeInstance
;
800 PCI_ROOT_BRIDGE_INSTANCE
*RootBridgeInstance
;
806 if (Configuration
== NULL
) {
807 return EFI_INVALID_PARAMETER
;
813 // Check the Configuration is valid
815 if(*Ptr
!= ACPI_ADDRESS_SPACE_DESCRIPTOR
) {
816 return EFI_INVALID_PARAMETER
;
819 if (((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*)Ptr
)->ResType
!= 2) {
820 return EFI_INVALID_PARAMETER
;
823 Ptr
+= sizeof(EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
);
824 if (*Ptr
!= ACPI_END_TAG_DESCRIPTOR
) {
825 return EFI_INVALID_PARAMETER
;
828 HostBridgeInstance
= INSTANCE_FROM_RESOURCE_ALLOCATION_THIS (This
);
829 List
= HostBridgeInstance
->Head
.ForwardLink
;
833 while (List
!= &HostBridgeInstance
->Head
) {
834 RootBridgeInstance
= DRIVER_INSTANCE_FROM_LIST_ENTRY (List
);
835 if (RootBridgeHandle
== RootBridgeInstance
->Handle
) {
836 BusStart
= (UINTN
)((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*)Ptr
)->AddrRangeMin
;
837 BusLen
= (UINTN
)((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*)Ptr
)->AddrLen
;
838 BusEnd
= BusStart
+ BusLen
- 1;
840 if (BusStart
> BusEnd
) {
841 return EFI_INVALID_PARAMETER
;
844 if ((BusStart
< RootBridgeInstance
->BusBase
) || (BusEnd
> RootBridgeInstance
->BusLimit
)) {
845 return EFI_INVALID_PARAMETER
;
849 // Update the Bus Range
851 RootBridgeInstance
->ResAllocNode
[TypeBus
].Base
= BusStart
;
852 RootBridgeInstance
->ResAllocNode
[TypeBus
].Length
= BusLen
;
853 RootBridgeInstance
->ResAllocNode
[TypeBus
].Status
= ResAllocated
;
856 // Program the Root Bridge Hardware
862 List
= List
->ForwardLink
;
865 return EFI_INVALID_PARAMETER
;
870 Submits the I/O and memory resource requirements for the specified PCI root bridge.
872 This function is used to submit all the I/O and memory resources that are required by the specified
873 PCI root bridge. The input parameter Configuration is used to specify the following:
874 - The various types of resources that are required
875 - The associated lengths in terms of ACPI 2.0 resource descriptor format
877 @param[in] This Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance.
878 @param[in] RootBridgeHandle The PCI root bridge whose I/O and memory resource requirements are being submitted.
879 @param[in] Configuration The pointer to the PCI I/O and PCI memory resource descriptor.
881 @retval EFI_SUCCESS The I/O and memory resource requests for a PCI root bridge were accepted.
882 @retval EFI_INVALID_PARAMETER RootBridgeHandle is not a valid root bridge handle.
883 @retval EFI_INVALID_PARAMETER Configuration is NULL.
884 @retval EFI_INVALID_PARAMETER Configuration does not point to a valid ACPI 2.0 resource descriptor.
885 @retval EFI_INVALID_PARAMETER Configuration includes requests for one or more resource types that are
886 not supported by this PCI root bridge. This error will happen if the caller
887 did not combine resources according to Attributes that were returned by
888 GetAllocAttributes().
889 @retval EFI_INVALID_PARAMETER Address Range Maximum" is invalid.
890 @retval EFI_INVALID_PARAMETER "Address Range Length" is invalid for this PCI root bridge.
891 @retval EFI_INVALID_PARAMETER "Address Space Granularity" is invalid for this PCI root bridge.
897 IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
*This
,
898 IN EFI_HANDLE RootBridgeHandle
,
899 IN VOID
*Configuration
903 PCI_HOST_BRIDGE_INSTANCE
*HostBridgeInstance
;
904 PCI_ROOT_BRIDGE_INSTANCE
*RootBridgeInstance
;
906 EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*Ptr
;
911 // Check the input parameter: Configuration
913 if (Configuration
== NULL
) {
914 return EFI_INVALID_PARAMETER
;
917 HostBridgeInstance
= INSTANCE_FROM_RESOURCE_ALLOCATION_THIS (This
);
918 List
= HostBridgeInstance
->Head
.ForwardLink
;
920 Temp
= (UINT8
*)Configuration
;
921 while ( *Temp
== 0x8A) {
922 Temp
+= sizeof (EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
) ;
925 return EFI_INVALID_PARAMETER
;
928 Temp
= (UINT8
*)Configuration
;
929 while (List
!= &HostBridgeInstance
->Head
) {
930 RootBridgeInstance
= DRIVER_INSTANCE_FROM_LIST_ENTRY (List
);
931 if (RootBridgeHandle
== RootBridgeInstance
->Handle
) {
932 while ( *Temp
== 0x8A) {
933 Ptr
= (EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*) Temp
;
936 // Check Address Length
938 if (Ptr
->AddrLen
> 0xffffffff) {
939 return EFI_INVALID_PARAMETER
;
943 // Check address range alignment
945 if (Ptr
->AddrRangeMax
>= 0xffffffff || Ptr
->AddrRangeMax
!= (GetPowerOfTwo64 (Ptr
->AddrRangeMax
+ 1) - 1)) {
946 return EFI_INVALID_PARAMETER
;
949 switch (Ptr
->ResType
) {
954 // Check invalid Address Sapce Granularity
956 if (Ptr
->AddrSpaceGranularity
!= 32) {
957 return EFI_INVALID_PARAMETER
;
961 // check the memory resource request is supported by PCI root bridge
963 if (RootBridgeInstance
->RootBridgeAttrib
== EFI_PCI_HOST_BRIDGE_COMBINE_MEM_PMEM
&&
964 Ptr
->SpecificFlag
== 0x06) {
965 return EFI_INVALID_PARAMETER
;
968 AddrLen
= Ptr
->AddrLen
;
969 Alignment
= Ptr
->AddrRangeMax
;
970 if (Ptr
->AddrSpaceGranularity
== 32) {
971 if (Ptr
->SpecificFlag
== 0x06) {
975 RootBridgeInstance
->ResAllocNode
[TypePMem32
].Status
= ResSubmitted
;
977 RootBridgeInstance
->ResAllocNode
[TypeMem32
].Length
= AddrLen
;
978 RootBridgeInstance
->ResAllocNode
[TypeMem32
].Alignment
= Alignment
;
979 RootBridgeInstance
->ResAllocNode
[TypeMem32
].Status
= ResRequested
;
980 HostBridgeInstance
->ResourceSubmited
= TRUE
;
984 if (Ptr
->AddrSpaceGranularity
== 64) {
985 if (Ptr
->SpecificFlag
== 0x06) {
986 RootBridgeInstance
->ResAllocNode
[TypePMem64
].Status
= ResSubmitted
;
988 RootBridgeInstance
->ResAllocNode
[TypeMem64
].Status
= ResSubmitted
;
994 AddrLen
= (UINTN
) Ptr
->AddrLen
;
995 Alignment
= (UINTN
) Ptr
->AddrRangeMax
;
996 RootBridgeInstance
->ResAllocNode
[TypeIo
].Length
= AddrLen
;
997 RootBridgeInstance
->ResAllocNode
[TypeIo
].Alignment
= Alignment
;
998 RootBridgeInstance
->ResAllocNode
[TypeIo
].Status
= ResRequested
;
999 HostBridgeInstance
->ResourceSubmited
= TRUE
;
1006 Temp
+= sizeof (EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
) ;
1012 List
= List
->ForwardLink
;
1015 return EFI_INVALID_PARAMETER
;
1019 Returns the proposed resource settings for the specified PCI root bridge.
1021 This member function returns the proposed resource settings for the specified PCI root bridge. The
1022 proposed resource settings are prepared when NotifyPhase() is called with a Phase of
1023 EfiPciHostBridgeAllocateResources. The output parameter Configuration
1024 specifies the following:
1025 - The various types of resources, excluding bus resources, that are allocated
1026 - The associated lengths in terms of ACPI 2.0 resource descriptor format
1028 @param[in] This Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance.
1029 @param[in] RootBridgeHandle The PCI root bridge handle. Type EFI_HANDLE is defined in InstallProtocolInterface() in the UEFI 2.0 Specification.
1030 @param[out] Configuration The pointer to the pointer to the PCI I/O and memory resource descriptor.
1032 @retval EFI_SUCCESS The requested parameters were returned.
1033 @retval EFI_INVALID_PARAMETER RootBridgeHandle is not a valid root bridge handle.
1034 @retval EFI_DEVICE_ERROR Programming failed due to a hardware error.
1035 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
1040 GetProposedResources(
1041 IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
*This
,
1042 IN EFI_HANDLE RootBridgeHandle
,
1043 OUT VOID
**Configuration
1047 PCI_HOST_BRIDGE_INSTANCE
*HostBridgeInstance
;
1048 PCI_ROOT_BRIDGE_INSTANCE
*RootBridgeInstance
;
1053 EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*Ptr
;
1059 // Get the Host Bridge Instance from the resource allocation protocol
1061 HostBridgeInstance
= INSTANCE_FROM_RESOURCE_ALLOCATION_THIS (This
);
1062 List
= HostBridgeInstance
->Head
.ForwardLink
;
1065 // Enumerate the root bridges in this host bridge
1067 while (List
!= &HostBridgeInstance
->Head
) {
1068 RootBridgeInstance
= DRIVER_INSTANCE_FROM_LIST_ENTRY (List
);
1069 if (RootBridgeHandle
== RootBridgeInstance
->Handle
) {
1070 for (Index
= 0; Index
< TypeBus
; Index
++) {
1071 if (RootBridgeInstance
->ResAllocNode
[Index
].Status
!= ResNone
) {
1077 return EFI_INVALID_PARAMETER
;
1080 Buffer
= AllocateZeroPool (Number
* sizeof(EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
) + sizeof(EFI_ACPI_END_TAG_DESCRIPTOR
));
1081 if (Buffer
== NULL
) {
1082 return EFI_OUT_OF_RESOURCES
;
1086 for (Index
= 0; Index
< TypeBus
; Index
++) {
1087 if (RootBridgeInstance
->ResAllocNode
[Index
].Status
!= ResNone
) {
1088 Ptr
= (EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*) Temp
;
1089 ResStatus
= RootBridgeInstance
->ResAllocNode
[Index
].Status
;
1101 Ptr
->SpecificFlag
= 0;
1102 Ptr
->AddrRangeMin
= RootBridgeInstance
->ResAllocNode
[Index
].Base
;
1103 Ptr
->AddrRangeMax
= 0;
1104 Ptr
->AddrTranslationOffset
= \
1105 (ResStatus
== ResAllocated
) ? EFI_RESOURCE_SATISFIED
: EFI_RESOURCE_LESS
;
1106 Ptr
->AddrLen
= RootBridgeInstance
->ResAllocNode
[Index
].Length
;
1117 Ptr
->SpecificFlag
= 0;
1118 Ptr
->AddrSpaceGranularity
= 32;
1119 Ptr
->AddrRangeMin
= RootBridgeInstance
->ResAllocNode
[Index
].Base
;
1120 Ptr
->AddrRangeMax
= 0;
1121 Ptr
->AddrTranslationOffset
= \
1122 (ResStatus
== ResAllocated
) ? EFI_RESOURCE_SATISFIED
: EFI_RESOURCE_LESS
;
1123 Ptr
->AddrLen
= RootBridgeInstance
->ResAllocNode
[Index
].Length
;
1128 // Prefetch memory 32
1134 Ptr
->SpecificFlag
= 6;
1135 Ptr
->AddrSpaceGranularity
= 32;
1136 Ptr
->AddrRangeMin
= 0;
1137 Ptr
->AddrRangeMax
= 0;
1138 Ptr
->AddrTranslationOffset
= EFI_RESOURCE_NONEXISTENT
;
1150 Ptr
->SpecificFlag
= 0;
1151 Ptr
->AddrSpaceGranularity
= 64;
1152 Ptr
->AddrRangeMin
= 0;
1153 Ptr
->AddrRangeMax
= 0;
1154 Ptr
->AddrTranslationOffset
= EFI_RESOURCE_NONEXISTENT
;
1160 // Prefetch memory 64
1166 Ptr
->SpecificFlag
= 6;
1167 Ptr
->AddrSpaceGranularity
= 64;
1168 Ptr
->AddrRangeMin
= 0;
1169 Ptr
->AddrRangeMax
= 0;
1170 Ptr
->AddrTranslationOffset
= EFI_RESOURCE_NONEXISTENT
;
1175 Temp
+= sizeof (EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
);
1179 ((EFI_ACPI_END_TAG_DESCRIPTOR
*)Temp
)->Desc
= 0x79;
1180 ((EFI_ACPI_END_TAG_DESCRIPTOR
*)Temp
)->Checksum
= 0x0;
1182 *Configuration
= Buffer
;
1187 List
= List
->ForwardLink
;
1190 return EFI_INVALID_PARAMETER
;
1194 Provides the hooks from the PCI bus driver to every PCI controller (device/function) at various
1195 stages of the PCI enumeration process that allow the host bridge driver to preinitialize individual
1196 PCI controllers before enumeration.
1198 This function is called during the PCI enumeration process. No specific action is expected from this
1199 member function. It allows the host bridge driver to preinitialize individual PCI controllers before
1202 @param This Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance.
1203 @param RootBridgeHandle The associated PCI root bridge handle. Type EFI_HANDLE is defined in
1204 InstallProtocolInterface() in the UEFI 2.0 Specification.
1205 @param PciAddress The address of the PCI device on the PCI bus. This address can be passed to the
1206 EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL member functions to access the PCI
1207 configuration space of the device. See Table 12-1 in the UEFI 2.0 Specification for
1208 the definition of EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS.
1209 @param Phase The phase of the PCI device enumeration.
1211 @retval EFI_SUCCESS The requested parameters were returned.
1212 @retval EFI_INVALID_PARAMETER RootBridgeHandle is not a valid root bridge handle.
1213 @retval EFI_INVALID_PARAMETER Phase is not a valid phase that is defined in
1214 EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE.
1215 @retval EFI_DEVICE_ERROR Programming failed due to a hardware error. The PCI enumerator should
1216 not enumerate this device, including its child devices if it is a PCI-to-PCI
1222 PreprocessController (
1223 IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
*This
,
1224 IN EFI_HANDLE RootBridgeHandle
,
1225 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS PciAddress
,
1226 IN EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE Phase
1229 PCI_HOST_BRIDGE_INSTANCE
*HostBridgeInstance
;
1230 PCI_ROOT_BRIDGE_INSTANCE
*RootBridgeInstance
;
1233 HostBridgeInstance
= INSTANCE_FROM_RESOURCE_ALLOCATION_THIS (This
);
1234 List
= HostBridgeInstance
->Head
.ForwardLink
;
1237 // Enumerate the root bridges in this host bridge
1239 while (List
!= &HostBridgeInstance
->Head
) {
1240 RootBridgeInstance
= DRIVER_INSTANCE_FROM_LIST_ENTRY (List
);
1241 if (RootBridgeHandle
== RootBridgeInstance
->Handle
) {
1244 List
= List
->ForwardLink
;
1246 if (List
== &HostBridgeInstance
->Head
) {
1247 return EFI_INVALID_PARAMETER
;
1250 if ((UINT32
)Phase
> EfiPciBeforeResourceCollection
) {
1251 return EFI_INVALID_PARAMETER
;