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
;
470 return EFI_NOT_READY
;
473 case EfiPciHostBridgeSetResources
:
476 case EfiPciHostBridgeFreeResources
:
477 ReturnStatus
= EFI_SUCCESS
;
478 List
= HostBridgeInstance
->Head
.ForwardLink
;
479 while (List
!= &HostBridgeInstance
->Head
) {
480 RootBridgeInstance
= DRIVER_INSTANCE_FROM_LIST_ENTRY (List
);
481 for (Index
= TypeIo
; Index
< TypeBus
; Index
++) {
482 if (RootBridgeInstance
->ResAllocNode
[Index
].Status
== ResAllocated
) {
483 AddrLen
= RootBridgeInstance
->ResAllocNode
[Index
].Length
;
484 BaseAddress
= RootBridgeInstance
->ResAllocNode
[Index
].Base
;
488 Status
= gDS
->FreeIoSpace (BaseAddress
, AddrLen
);
489 if (EFI_ERROR (Status
)) {
490 ReturnStatus
= Status
;
495 Status
= gDS
->FreeMemorySpace (BaseAddress
, AddrLen
);
496 if (EFI_ERROR (Status
)) {
497 ReturnStatus
= Status
;
515 RootBridgeInstance
->ResAllocNode
[Index
].Type
= Index
;
516 RootBridgeInstance
->ResAllocNode
[Index
].Base
= 0;
517 RootBridgeInstance
->ResAllocNode
[Index
].Length
= 0;
518 RootBridgeInstance
->ResAllocNode
[Index
].Status
= ResNone
;
522 List
= List
->ForwardLink
;
525 HostBridgeInstance
->ResourceSubmited
= FALSE
;
526 HostBridgeInstance
->CanRestarted
= TRUE
;
529 case EfiPciHostBridgeEndResourceAllocation
:
530 HostBridgeInstance
->CanRestarted
= FALSE
;
534 return EFI_INVALID_PARAMETER
;
541 Return the device handle of the next PCI root bridge that is associated with this Host Bridge.
543 This function is called multiple times to retrieve the device handles of all the PCI root bridges that
544 are associated with this PCI host bridge. Each PCI host bridge is associated with one or more PCI
545 root bridges. On each call, the handle that was returned by the previous call is passed into the
546 interface, and on output the interface returns the device handle of the next PCI root bridge. The
547 caller can use the handle to obtain the instance of the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
548 for that root bridge. When there are no more PCI root bridges to report, the interface returns
549 EFI_NOT_FOUND. A PCI enumerator must enumerate the PCI root bridges in the order that they
550 are returned by this function.
551 For D945 implementation, there is only one root bridge in PCI host bridge.
553 @param[in] This The instance pointer of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
554 @param[in, out] RootBridgeHandle Returns the device handle of the next PCI root bridge.
556 @retval EFI_SUCCESS If parameter RootBridgeHandle = NULL, then return the first Rootbridge handle of the
557 specific Host bridge and return EFI_SUCCESS.
558 @retval EFI_NOT_FOUND Can not find the any more root bridge in specific host bridge.
559 @retval EFI_INVALID_PARAMETER RootBridgeHandle is not an EFI_HANDLE that was
560 returned on a previous call to GetNextRootBridge().
565 IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
*This
,
566 IN OUT EFI_HANDLE
*RootBridgeHandle
569 BOOLEAN NoRootBridge
;
571 PCI_HOST_BRIDGE_INSTANCE
*HostBridgeInstance
;
572 PCI_ROOT_BRIDGE_INSTANCE
*RootBridgeInstance
;
575 HostBridgeInstance
= INSTANCE_FROM_RESOURCE_ALLOCATION_THIS (This
);
576 List
= HostBridgeInstance
->Head
.ForwardLink
;
579 while (List
!= &HostBridgeInstance
->Head
) {
580 NoRootBridge
= FALSE
;
581 RootBridgeInstance
= DRIVER_INSTANCE_FROM_LIST_ENTRY (List
);
582 if (*RootBridgeHandle
== NULL
) {
584 // Return the first Root Bridge Handle of the Host Bridge
586 *RootBridgeHandle
= RootBridgeInstance
->Handle
;
589 if (*RootBridgeHandle
== RootBridgeInstance
->Handle
) {
593 List
= List
->ForwardLink
;
594 if (List
!=&HostBridgeInstance
->Head
) {
595 RootBridgeInstance
= DRIVER_INSTANCE_FROM_LIST_ENTRY (List
);
596 *RootBridgeHandle
= RootBridgeInstance
->Handle
;
599 return EFI_NOT_FOUND
;
604 List
= List
->ForwardLink
;
608 return EFI_NOT_FOUND
;
610 return EFI_INVALID_PARAMETER
;
615 Returns the allocation attributes of a PCI root bridge.
617 The function returns the allocation attributes of a specific PCI root bridge. The attributes can vary
618 from one PCI root bridge to another. These attributes are different from the decode-related
619 attributes that are returned by the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.GetAttributes() member function. The
620 RootBridgeHandle parameter is used to specify the instance of the PCI root bridge. The device
621 handles of all the root bridges that are associated with this host bridge must be obtained by calling
622 GetNextRootBridge(). The attributes are static in the sense that they do not change during or
623 after the enumeration process. The hardware may provide mechanisms to change the attributes on
624 the fly, but such changes must be completed before EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL is
625 installed. The permitted values of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ATTRIBUTES are defined in
626 "Related Definitions" below. The caller uses these attributes to combine multiple resource requests.
627 For example, if the flag EFI_PCI_HOST_BRIDGE_COMBINE_MEM_PMEM is set, the PCI bus enumerator needs to
628 include requests for the prefetchable memory in the nonprefetchable memory pool and not request any
630 Attribute Description
631 ------------------------------------ ----------------------------------------------------------------------
632 EFI_PCI_HOST_BRIDGE_COMBINE_MEM_PMEM If this bit is set, then the PCI root bridge does not support separate
633 windows for nonprefetchable and prefetchable memory. A PCI bus
634 driver needs to include requests for prefetchable memory in the
635 nonprefetchable memory pool.
637 EFI_PCI_HOST_BRIDGE_MEM64_DECODE If this bit is set, then the PCI root bridge supports 64-bit memory
638 windows. If this bit is not set, the PCI bus driver needs to include
639 requests for a 64-bit memory address in the corresponding 32-bit
642 @param[in] This The instance pointer of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
643 @param[in] RootBridgeHandle The device handle of the PCI root bridge in which the caller is interested. Type
644 EFI_HANDLE is defined in InstallProtocolInterface() in the UEFI 2.0 Specification.
645 @param[out] Attributes The pointer to attribte of root bridge, it is output parameter
647 @retval EFI_INVALID_PARAMETER Attribute pointer is NULL
648 @retval EFI_INVALID_PARAMETER RootBridgehandle is invalid.
649 @retval EFI_SUCCESS Success to get attribute of interested root bridge.
655 IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
*This
,
656 IN EFI_HANDLE RootBridgeHandle
,
657 OUT UINT64
*Attributes
661 PCI_HOST_BRIDGE_INSTANCE
*HostBridgeInstance
;
662 PCI_ROOT_BRIDGE_INSTANCE
*RootBridgeInstance
;
664 if (Attributes
== NULL
) {
665 return EFI_INVALID_PARAMETER
;
668 HostBridgeInstance
= INSTANCE_FROM_RESOURCE_ALLOCATION_THIS (This
);
669 List
= HostBridgeInstance
->Head
.ForwardLink
;
671 while (List
!= &HostBridgeInstance
->Head
) {
672 RootBridgeInstance
= DRIVER_INSTANCE_FROM_LIST_ENTRY (List
);
673 if (RootBridgeHandle
== RootBridgeInstance
->Handle
) {
674 *Attributes
= RootBridgeInstance
->RootBridgeAttrib
;
677 List
= List
->ForwardLink
;
681 // RootBridgeHandle is not an EFI_HANDLE
682 // that was returned on a previous call to GetNextRootBridge()
684 return EFI_INVALID_PARAMETER
;
688 Sets up the specified PCI root bridge for the bus enumeration process.
690 This member function sets up the root bridge for bus enumeration and returns the PCI bus range
691 over which the search should be performed in ACPI 2.0 resource descriptor format.
693 @param[in] This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance.
694 @param[in] RootBridgeHandle The PCI Root Bridge to be set up.
695 @param[out] Configuration Pointer to the pointer to the PCI bus resource descriptor.
697 @retval EFI_INVALID_PARAMETER Invalid Root bridge's handle
698 @retval EFI_OUT_OF_RESOURCES Fail to allocate ACPI resource descriptor tag.
699 @retval EFI_SUCCESS Sucess to allocate ACPI resource descriptor.
705 IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
*This
,
706 IN EFI_HANDLE RootBridgeHandle
,
707 OUT VOID
**Configuration
711 PCI_HOST_BRIDGE_INSTANCE
*HostBridgeInstance
;
712 PCI_ROOT_BRIDGE_INSTANCE
*RootBridgeInstance
;
718 HostBridgeInstance
= INSTANCE_FROM_RESOURCE_ALLOCATION_THIS (This
);
719 List
= HostBridgeInstance
->Head
.ForwardLink
;
721 while (List
!= &HostBridgeInstance
->Head
) {
722 RootBridgeInstance
= DRIVER_INSTANCE_FROM_LIST_ENTRY (List
);
723 if (RootBridgeHandle
== RootBridgeInstance
->Handle
) {
725 // Set up the Root Bridge for Bus Enumeration
727 BusStart
= RootBridgeInstance
->BusBase
;
728 BusEnd
= RootBridgeInstance
->BusLimit
;
730 // Program the Hardware(if needed) if error return EFI_DEVICE_ERROR
733 Buffer
= AllocatePool (sizeof(EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
) + sizeof(EFI_ACPI_END_TAG_DESCRIPTOR
));
734 if (Buffer
== NULL
) {
735 return EFI_OUT_OF_RESOURCES
;
738 Temp
= (UINT8
*)Buffer
;
740 ((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*)Temp
)->Desc
= 0x8A;
741 ((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*)Temp
)->Len
= 0x2B;
742 ((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*)Temp
)->ResType
= 2;
743 ((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*)Temp
)->GenFlag
= 0;
744 ((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*)Temp
)->SpecificFlag
= 0;
745 ((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*)Temp
)->AddrSpaceGranularity
= 0;
746 ((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*)Temp
)->AddrRangeMin
= BusStart
;
747 ((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*)Temp
)->AddrRangeMax
= 0;
748 ((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*)Temp
)->AddrTranslationOffset
= 0;
749 ((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*)Temp
)->AddrLen
= BusEnd
- BusStart
+ 1;
751 Temp
= Temp
+ sizeof(EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
);
752 ((EFI_ACPI_END_TAG_DESCRIPTOR
*)Temp
)->Desc
= 0x79;
753 ((EFI_ACPI_END_TAG_DESCRIPTOR
*)Temp
)->Checksum
= 0x0;
755 *Configuration
= Buffer
;
758 List
= List
->ForwardLink
;
761 return EFI_INVALID_PARAMETER
;
765 Programs the PCI root bridge hardware so that it decodes the specified PCI bus range.
767 This member function programs the specified PCI root bridge to decode the bus range that is
768 specified by the input parameter Configuration.
769 The bus range information is specified in terms of the ACPI 2.0 resource descriptor format.
771 @param[in] This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
772 @param[in] RootBridgeHandle The PCI Root Bridge whose bus range is to be programmed
773 @param[in] Configuration The pointer to the PCI bus resource descriptor
775 @retval EFI_INVALID_PARAMETER RootBridgeHandle is not a valid root bridge handle.
776 @retval EFI_INVALID_PARAMETER Configuration is NULL.
777 @retval EFI_INVALID_PARAMETER Configuration does not point to a valid ACPI 2.0 resource descriptor.
778 @retval EFI_INVALID_PARAMETER Configuration does not include a valid ACPI 2.0 bus resource descriptor.
779 @retval EFI_INVALID_PARAMETER Configuration includes valid ACPI 2.0 resource descriptors other than
781 @retval EFI_INVALID_PARAMETER Configuration contains one or more invalid ACPI resource descriptors.
782 @retval EFI_INVALID_PARAMETER "Address Range Minimum" is invalid for this root bridge.
783 @retval EFI_INVALID_PARAMETER "Address Range Length" is invalid for this root bridge.
784 @retval EFI_DEVICE_ERROR Programming failed due to a hardware error.
785 @retval EFI_SUCCESS The bus range for the PCI root bridge was programmed.
791 IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
*This
,
792 IN EFI_HANDLE RootBridgeHandle
,
793 IN VOID
*Configuration
797 PCI_HOST_BRIDGE_INSTANCE
*HostBridgeInstance
;
798 PCI_ROOT_BRIDGE_INSTANCE
*RootBridgeInstance
;
804 if (Configuration
== NULL
) {
805 return EFI_INVALID_PARAMETER
;
811 // Check the Configuration is valid
813 if(*Ptr
!= ACPI_ADDRESS_SPACE_DESCRIPTOR
) {
814 return EFI_INVALID_PARAMETER
;
817 if (((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*)Ptr
)->ResType
!= 2) {
818 return EFI_INVALID_PARAMETER
;
821 Ptr
+= sizeof(EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
);
822 if (*Ptr
!= ACPI_END_TAG_DESCRIPTOR
) {
823 return EFI_INVALID_PARAMETER
;
826 HostBridgeInstance
= INSTANCE_FROM_RESOURCE_ALLOCATION_THIS (This
);
827 List
= HostBridgeInstance
->Head
.ForwardLink
;
831 while (List
!= &HostBridgeInstance
->Head
) {
832 RootBridgeInstance
= DRIVER_INSTANCE_FROM_LIST_ENTRY (List
);
833 if (RootBridgeHandle
== RootBridgeInstance
->Handle
) {
834 BusStart
= (UINTN
)((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*)Ptr
)->AddrRangeMin
;
835 BusLen
= (UINTN
)((EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*)Ptr
)->AddrLen
;
836 BusEnd
= BusStart
+ BusLen
- 1;
838 if (BusStart
> BusEnd
) {
839 return EFI_INVALID_PARAMETER
;
842 if ((BusStart
< RootBridgeInstance
->BusBase
) || (BusEnd
> RootBridgeInstance
->BusLimit
)) {
843 return EFI_INVALID_PARAMETER
;
847 // Update the Bus Range
849 RootBridgeInstance
->ResAllocNode
[TypeBus
].Base
= BusStart
;
850 RootBridgeInstance
->ResAllocNode
[TypeBus
].Length
= BusLen
;
851 RootBridgeInstance
->ResAllocNode
[TypeBus
].Status
= ResAllocated
;
854 // Program the Root Bridge Hardware
860 List
= List
->ForwardLink
;
863 return EFI_INVALID_PARAMETER
;
868 Submits the I/O and memory resource requirements for the specified PCI root bridge.
870 This function is used to submit all the I/O and memory resources that are required by the specified
871 PCI root bridge. The input parameter Configuration is used to specify the following:
872 - The various types of resources that are required
873 - The associated lengths in terms of ACPI 2.0 resource descriptor format
875 @param[in] This Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance.
876 @param[in] RootBridgeHandle The PCI root bridge whose I/O and memory resource requirements are being submitted.
877 @param[in] Configuration The pointer to the PCI I/O and PCI memory resource descriptor.
879 @retval EFI_SUCCESS The I/O and memory resource requests for a PCI root bridge were accepted.
880 @retval EFI_INVALID_PARAMETER RootBridgeHandle is not a valid root bridge handle.
881 @retval EFI_INVALID_PARAMETER Configuration is NULL.
882 @retval EFI_INVALID_PARAMETER Configuration does not point to a valid ACPI 2.0 resource descriptor.
883 @retval EFI_INVALID_PARAMETER Configuration includes requests for one or more resource types that are
884 not supported by this PCI root bridge. This error will happen if the caller
885 did not combine resources according to Attributes that were returned by
886 GetAllocAttributes().
887 @retval EFI_INVALID_PARAMETER Address Range Maximum" is invalid.
888 @retval EFI_INVALID_PARAMETER "Address Range Length" is invalid for this PCI root bridge.
889 @retval EFI_INVALID_PARAMETER "Address Space Granularity" is invalid for this PCI root bridge.
895 IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
*This
,
896 IN EFI_HANDLE RootBridgeHandle
,
897 IN VOID
*Configuration
901 PCI_HOST_BRIDGE_INSTANCE
*HostBridgeInstance
;
902 PCI_ROOT_BRIDGE_INSTANCE
*RootBridgeInstance
;
904 EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*Ptr
;
909 // Check the input parameter: Configuration
911 if (Configuration
== NULL
) {
912 return EFI_INVALID_PARAMETER
;
915 HostBridgeInstance
= INSTANCE_FROM_RESOURCE_ALLOCATION_THIS (This
);
916 List
= HostBridgeInstance
->Head
.ForwardLink
;
918 Temp
= (UINT8
*)Configuration
;
919 while ( *Temp
== 0x8A) {
920 Temp
+= sizeof (EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
) ;
923 return EFI_INVALID_PARAMETER
;
926 Temp
= (UINT8
*)Configuration
;
927 while (List
!= &HostBridgeInstance
->Head
) {
928 RootBridgeInstance
= DRIVER_INSTANCE_FROM_LIST_ENTRY (List
);
929 if (RootBridgeHandle
== RootBridgeInstance
->Handle
) {
932 Temp
+= sizeof (EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
)
934 Ptr
= (EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*) Temp
;
937 // Check Address Length
939 if (Ptr
->AddrLen
== 0) {
940 HostBridgeInstance
->ResourceSubmited
= TRUE
;
943 if (Ptr
->AddrLen
> 0xffffffff) {
944 return EFI_INVALID_PARAMETER
;
948 // Check address range alignment
950 if (Ptr
->AddrRangeMax
>= 0xffffffff || Ptr
->AddrRangeMax
!= (GetPowerOfTwo64 (Ptr
->AddrRangeMax
+ 1) - 1)) {
951 return EFI_INVALID_PARAMETER
;
954 switch (Ptr
->ResType
) {
959 // Check invalid Address Sapce Granularity
961 if (Ptr
->AddrSpaceGranularity
!= 32) {
962 return EFI_INVALID_PARAMETER
;
966 // check the memory resource request is supported by PCI root bridge
968 if (RootBridgeInstance
->RootBridgeAttrib
== EFI_PCI_HOST_BRIDGE_COMBINE_MEM_PMEM
&&
969 Ptr
->SpecificFlag
== 0x06) {
970 return EFI_INVALID_PARAMETER
;
973 AddrLen
= Ptr
->AddrLen
;
974 Alignment
= Ptr
->AddrRangeMax
;
975 if (Ptr
->AddrSpaceGranularity
== 32) {
976 if (Ptr
->SpecificFlag
== 0x06) {
980 RootBridgeInstance
->ResAllocNode
[TypePMem32
].Status
= ResSubmitted
;
982 RootBridgeInstance
->ResAllocNode
[TypeMem32
].Length
= AddrLen
;
983 RootBridgeInstance
->ResAllocNode
[TypeMem32
].Alignment
= Alignment
;
984 RootBridgeInstance
->ResAllocNode
[TypeMem32
].Status
= ResRequested
;
985 HostBridgeInstance
->ResourceSubmited
= TRUE
;
989 if (Ptr
->AddrSpaceGranularity
== 64) {
990 if (Ptr
->SpecificFlag
== 0x06) {
991 RootBridgeInstance
->ResAllocNode
[TypePMem64
].Status
= ResSubmitted
;
993 RootBridgeInstance
->ResAllocNode
[TypeMem64
].Status
= ResSubmitted
;
999 AddrLen
= (UINTN
) Ptr
->AddrLen
;
1000 Alignment
= (UINTN
) Ptr
->AddrRangeMax
;
1001 RootBridgeInstance
->ResAllocNode
[TypeIo
].Length
= AddrLen
;
1002 RootBridgeInstance
->ResAllocNode
[TypeIo
].Alignment
= Alignment
;
1003 RootBridgeInstance
->ResAllocNode
[TypeIo
].Status
= ResRequested
;
1004 HostBridgeInstance
->ResourceSubmited
= TRUE
;
1015 List
= List
->ForwardLink
;
1018 return EFI_INVALID_PARAMETER
;
1022 Returns the proposed resource settings for the specified PCI root bridge.
1024 This member function returns the proposed resource settings for the specified PCI root bridge. The
1025 proposed resource settings are prepared when NotifyPhase() is called with a Phase of
1026 EfiPciHostBridgeAllocateResources. The output parameter Configuration
1027 specifies the following:
1028 - The various types of resources, excluding bus resources, that are allocated
1029 - The associated lengths in terms of ACPI 2.0 resource descriptor format
1031 @param[in] This Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance.
1032 @param[in] RootBridgeHandle The PCI root bridge handle. Type EFI_HANDLE is defined in InstallProtocolInterface() in the UEFI 2.0 Specification.
1033 @param[out] Configuration The pointer to the pointer to the PCI I/O and memory resource descriptor.
1035 @retval EFI_SUCCESS The requested parameters were returned.
1036 @retval EFI_INVALID_PARAMETER RootBridgeHandle is not a valid root bridge handle.
1037 @retval EFI_DEVICE_ERROR Programming failed due to a hardware error.
1038 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
1043 GetProposedResources(
1044 IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
*This
,
1045 IN EFI_HANDLE RootBridgeHandle
,
1046 OUT VOID
**Configuration
1050 PCI_HOST_BRIDGE_INSTANCE
*HostBridgeInstance
;
1051 PCI_ROOT_BRIDGE_INSTANCE
*RootBridgeInstance
;
1056 EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*Ptr
;
1062 // Get the Host Bridge Instance from the resource allocation protocol
1064 HostBridgeInstance
= INSTANCE_FROM_RESOURCE_ALLOCATION_THIS (This
);
1065 List
= HostBridgeInstance
->Head
.ForwardLink
;
1068 // Enumerate the root bridges in this host bridge
1070 while (List
!= &HostBridgeInstance
->Head
) {
1071 RootBridgeInstance
= DRIVER_INSTANCE_FROM_LIST_ENTRY (List
);
1072 if (RootBridgeHandle
== RootBridgeInstance
->Handle
) {
1073 for (Index
= 0; Index
< TypeBus
; Index
++) {
1074 if (RootBridgeInstance
->ResAllocNode
[Index
].Status
!= ResNone
) {
1080 EFI_ACPI_END_TAG_DESCRIPTOR
*End
;
1082 End
= AllocateZeroPool (sizeof *End
);
1084 return EFI_OUT_OF_RESOURCES
;
1086 End
->Desc
= ACPI_END_TAG_DESCRIPTOR
;
1087 *Configuration
= End
;
1091 Buffer
= AllocateZeroPool (Number
* sizeof(EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
) + sizeof(EFI_ACPI_END_TAG_DESCRIPTOR
));
1092 if (Buffer
== NULL
) {
1093 return EFI_OUT_OF_RESOURCES
;
1097 for (Index
= 0; Index
< TypeBus
; Index
++) {
1098 if (RootBridgeInstance
->ResAllocNode
[Index
].Status
!= ResNone
) {
1099 Ptr
= (EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*) Temp
;
1100 ResStatus
= RootBridgeInstance
->ResAllocNode
[Index
].Status
;
1112 Ptr
->SpecificFlag
= 0;
1113 Ptr
->AddrRangeMin
= RootBridgeInstance
->ResAllocNode
[Index
].Base
;
1114 Ptr
->AddrRangeMax
= 0;
1115 Ptr
->AddrTranslationOffset
= \
1116 (ResStatus
== ResAllocated
) ? EFI_RESOURCE_SATISFIED
: EFI_RESOURCE_LESS
;
1117 Ptr
->AddrLen
= RootBridgeInstance
->ResAllocNode
[Index
].Length
;
1128 Ptr
->SpecificFlag
= 0;
1129 Ptr
->AddrSpaceGranularity
= 32;
1130 Ptr
->AddrRangeMin
= RootBridgeInstance
->ResAllocNode
[Index
].Base
;
1131 Ptr
->AddrRangeMax
= 0;
1132 Ptr
->AddrTranslationOffset
= \
1133 (ResStatus
== ResAllocated
) ? EFI_RESOURCE_SATISFIED
: EFI_RESOURCE_LESS
;
1134 Ptr
->AddrLen
= RootBridgeInstance
->ResAllocNode
[Index
].Length
;
1139 // Prefetch memory 32
1145 Ptr
->SpecificFlag
= 6;
1146 Ptr
->AddrSpaceGranularity
= 32;
1147 Ptr
->AddrRangeMin
= 0;
1148 Ptr
->AddrRangeMax
= 0;
1149 Ptr
->AddrTranslationOffset
= EFI_RESOURCE_NONEXISTENT
;
1161 Ptr
->SpecificFlag
= 0;
1162 Ptr
->AddrSpaceGranularity
= 64;
1163 Ptr
->AddrRangeMin
= 0;
1164 Ptr
->AddrRangeMax
= 0;
1165 Ptr
->AddrTranslationOffset
= EFI_RESOURCE_NONEXISTENT
;
1171 // Prefetch memory 64
1177 Ptr
->SpecificFlag
= 6;
1178 Ptr
->AddrSpaceGranularity
= 64;
1179 Ptr
->AddrRangeMin
= 0;
1180 Ptr
->AddrRangeMax
= 0;
1181 Ptr
->AddrTranslationOffset
= EFI_RESOURCE_NONEXISTENT
;
1186 Temp
+= sizeof (EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
);
1190 ((EFI_ACPI_END_TAG_DESCRIPTOR
*)Temp
)->Desc
= 0x79;
1191 ((EFI_ACPI_END_TAG_DESCRIPTOR
*)Temp
)->Checksum
= 0x0;
1193 *Configuration
= Buffer
;
1198 List
= List
->ForwardLink
;
1201 return EFI_INVALID_PARAMETER
;
1205 Provides the hooks from the PCI bus driver to every PCI controller (device/function) at various
1206 stages of the PCI enumeration process that allow the host bridge driver to preinitialize individual
1207 PCI controllers before enumeration.
1209 This function is called during the PCI enumeration process. No specific action is expected from this
1210 member function. It allows the host bridge driver to preinitialize individual PCI controllers before
1213 @param This Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance.
1214 @param RootBridgeHandle The associated PCI root bridge handle. Type EFI_HANDLE is defined in
1215 InstallProtocolInterface() in the UEFI 2.0 Specification.
1216 @param PciAddress The address of the PCI device on the PCI bus. This address can be passed to the
1217 EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL member functions to access the PCI
1218 configuration space of the device. See Table 12-1 in the UEFI 2.0 Specification for
1219 the definition of EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS.
1220 @param Phase The phase of the PCI device enumeration.
1222 @retval EFI_SUCCESS The requested parameters were returned.
1223 @retval EFI_INVALID_PARAMETER RootBridgeHandle is not a valid root bridge handle.
1224 @retval EFI_INVALID_PARAMETER Phase is not a valid phase that is defined in
1225 EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE.
1226 @retval EFI_DEVICE_ERROR Programming failed due to a hardware error. The PCI enumerator should
1227 not enumerate this device, including its child devices if it is a PCI-to-PCI
1233 PreprocessController (
1234 IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
*This
,
1235 IN EFI_HANDLE RootBridgeHandle
,
1236 IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS PciAddress
,
1237 IN EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE Phase
1240 PCI_HOST_BRIDGE_INSTANCE
*HostBridgeInstance
;
1241 PCI_ROOT_BRIDGE_INSTANCE
*RootBridgeInstance
;
1244 HostBridgeInstance
= INSTANCE_FROM_RESOURCE_ALLOCATION_THIS (This
);
1245 List
= HostBridgeInstance
->Head
.ForwardLink
;
1248 // Enumerate the root bridges in this host bridge
1250 while (List
!= &HostBridgeInstance
->Head
) {
1251 RootBridgeInstance
= DRIVER_INSTANCE_FROM_LIST_ENTRY (List
);
1252 if (RootBridgeHandle
== RootBridgeInstance
->Handle
) {
1255 List
= List
->ForwardLink
;
1257 if (List
== &HostBridgeInstance
->Head
) {
1258 return EFI_INVALID_PARAMETER
;
1261 if ((UINT32
)Phase
> EfiPciBeforeResourceCollection
) {
1262 return EFI_INVALID_PARAMETER
;