3 Copyright (c) 2006, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 PCI Bus Driver Lib file
19 It abstracts some functions that can be different
20 between light PCI bus driver and full PCI bus driver
28 GLOBAL_REMOVE_IF_UNREFERENCED EFI_PCI_HOTPLUG_REQUEST_PROTOCOL gPciHotPlugRequest
= {
29 PciHotPlugRequestNotify
34 InstallHotPlugRequestProtocol (
42 Status - A pointer to the status.
52 if (!FeaturePcdGet (PcdPciBusHotplugDeviceSupport
)) {
57 *Status
= gBS
->InstallProtocolInterface (
59 &gEfiPciHotPlugRequestProtocolGuid
,
66 InstallPciHotplugGuid (
67 IN PCI_IO_DEVICE
*PciIoDevice
75 PciIoDevice - A pointer to the PCI_IO_DEVICE.
85 if (!FeaturePcdGet (PcdPciBusHotplugDeviceSupport
)) {
89 if (IS_CARDBUS_BRIDGE (&PciIoDevice
->Parent
->Pci
)) {
91 Status
= gBS
->InstallProtocolInterface (
93 &gEfiPciHotplugDeviceGuid
,
97 ASSERT_EFI_ERROR (Status
);
102 UninstallPciHotplugGuid (
103 IN PCI_IO_DEVICE
*PciIoDevice
111 PciIoDevice - A pointer to the PCI_IO_DEVICE.
121 if (!FeaturePcdGet (PcdPciBusHotplugDeviceSupport
)) {
125 Status
= gBS
->OpenProtocol (
127 &gEfiPciHotplugDeviceGuid
,
131 EFI_OPEN_PROTOCOL_TEST_PROTOCOL
134 if (Status
== EFI_SUCCESS
) {
136 // This may triger CardBus driver to stop for
137 // Pccard devices opened the GUID via BY_DRIVER
139 Status
= gBS
->UninstallProtocolInterface (
141 &gEfiPciHotplugDeviceGuid
,
149 IN PCI_IO_DEVICE
*PciIoDevice
158 PciIoDevice - A pointer to the PCI_IO_DEVICE.
168 if (!FeaturePcdGet (PcdPciBusHotplugDeviceSupport
)) {
173 // Read PciBar information from the bar register
175 if (!gFullEnumeration
) {
178 PciIoDevice
->PciIo
.Pci
.Read (
179 &(PciIoDevice
->PciIo
),
186 (PciIoDevice
->PciBar
)[P2C_MEM_1
].BaseAddress
= (UINT64
) (Address
);
187 (PciIoDevice
->PciBar
)[P2C_MEM_1
].Length
= 0x2000000;
188 (PciIoDevice
->PciBar
)[P2C_MEM_1
].BarType
= PciBarTypeMem32
;
191 PciIoDevice
->PciIo
.Pci
.Read (
192 &(PciIoDevice
->PciIo
),
198 (PciIoDevice
->PciBar
)[P2C_MEM_2
].BaseAddress
= (UINT64
) (Address
);
199 (PciIoDevice
->PciBar
)[P2C_MEM_2
].Length
= 0x2000000;
200 (PciIoDevice
->PciBar
)[P2C_MEM_2
].BarType
= PciBarTypePMem32
;
203 PciIoDevice
->PciIo
.Pci
.Read (
204 &(PciIoDevice
->PciIo
),
210 (PciIoDevice
->PciBar
)[P2C_IO_1
].BaseAddress
= (UINT64
) (Address
);
211 (PciIoDevice
->PciBar
)[P2C_IO_1
].Length
= 0x100;
212 (PciIoDevice
->PciBar
)[P2C_IO_1
].BarType
= PciBarTypeIo16
;
215 PciIoDevice
->PciIo
.Pci
.Read (
216 &(PciIoDevice
->PciIo
),
222 (PciIoDevice
->PciBar
)[P2C_IO_2
].BaseAddress
= (UINT64
) (Address
);
223 (PciIoDevice
->PciBar
)[P2C_IO_2
].Length
= 0x100;
224 (PciIoDevice
->PciBar
)[P2C_IO_2
].BarType
= PciBarTypeIo16
;
228 if (gPciHotPlugInit
!= NULL
) {
229 GetResourcePaddingForHpb (PciIoDevice
);
234 RemoveRejectedPciDevices (
235 EFI_HANDLE RootBridgeHandle
,
236 IN PCI_IO_DEVICE
*Bridge
245 RootBridgeHandle - An efi handle.
246 Bridge - An pointer to the PCI_IO_DEVICE.
253 // TODO: EFI_SUCCESS - add return value to function comment
256 LIST_ENTRY
*CurrentLink
;
257 LIST_ENTRY
*LastLink
;
259 if (!FeaturePcdGet (PcdPciBusHotplugDeviceSupport
)) {
263 CurrentLink
= Bridge
->ChildList
.ForwardLink
;
265 while (CurrentLink
&& CurrentLink
!= &Bridge
->ChildList
) {
267 Temp
= PCI_IO_DEVICE_FROM_LINK (CurrentLink
);
269 if (IS_PCI_BRIDGE (&Temp
->Pci
)) {
271 // Remove rejected devices recusively
273 RemoveRejectedPciDevices (RootBridgeHandle
, Temp
);
276 // Skip rejection for all PPBs, while detect rejection for others
278 if (IsPciDeviceRejected (Temp
)) {
281 // For P2C, remove all devices on it
284 if (!IsListEmpty (&Temp
->ChildList
)) {
285 RemoveAllPciDeviceOnBridge (RootBridgeHandle
, Temp
);
289 // Finally remove itself
292 LastLink
= CurrentLink
->BackLink
;
293 RemoveEntryList (CurrentLink
);
294 FreePciDevice (Temp
);
296 CurrentLink
= LastLink
;
300 CurrentLink
= CurrentLink
->ForwardLink
;
307 PciHostBridgeResourceAllocator (
308 IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
*PciResAlloc
311 if (FeaturePcdGet (PcdPciBusHotplugDeviceSupport
)) {
312 return PciHostBridgeResourceAllocator_WithHotPlugDeviceSupport (
316 return PciHostBridgeResourceAllocator_WithoutHotPlugDeviceSupport (
324 PciHostBridgeResourceAllocator_WithoutHotPlugDeviceSupport (
325 IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
*PciResAlloc
338 // TODO: PciResAlloc - add argument and description to function comment
339 // TODO: EFI_NOT_FOUND - add return value to function comment
340 // TODO: EFI_OUT_OF_RESOURCES - add return value to function comment
341 // TODO: EFI_NOT_FOUND - add return value to function comment
342 // TODO: EFI_SUCCESS - add return value to function comment
344 PCI_IO_DEVICE
*RootBridgeDev
;
345 EFI_HANDLE RootBridgeHandle
;
353 UINT64 MaxOptionRomSize
;
354 PCI_RESOURCE_NODE
*IoBridge
;
355 PCI_RESOURCE_NODE
*Mem32Bridge
;
356 PCI_RESOURCE_NODE
*PMem32Bridge
;
357 PCI_RESOURCE_NODE
*Mem64Bridge
;
358 PCI_RESOURCE_NODE
*PMem64Bridge
;
359 PCI_RESOURCE_NODE IoPool
;
360 PCI_RESOURCE_NODE Mem32Pool
;
361 PCI_RESOURCE_NODE PMem32Pool
;
362 PCI_RESOURCE_NODE Mem64Pool
;
363 PCI_RESOURCE_NODE PMem64Pool
;
364 REPORT_STATUS_CODE_LIBRARY_DEVICE_HANDLE_EXTENDED_DATA ExtendedData
;
367 // Initialize resource pool
370 InitializeResourcePool (&IoPool
, PciBarTypeIo16
);
371 InitializeResourcePool (&Mem32Pool
, PciBarTypeMem32
);
372 InitializeResourcePool (&PMem32Pool
, PciBarTypePMem32
);
373 InitializeResourcePool (&Mem64Pool
, PciBarTypeMem64
);
374 InitializeResourcePool (&PMem64Pool
, PciBarTypePMem64
);
376 RootBridgeDev
= NULL
;
377 RootBridgeHandle
= 0;
379 while (PciResAlloc
->GetNextRootBridge (PciResAlloc
, &RootBridgeHandle
) == EFI_SUCCESS
) {
381 // Get RootBridg Device by handle
383 RootBridgeDev
= GetRootBridgeByHandle (RootBridgeHandle
);
385 if (RootBridgeDev
== NULL
) {
386 return EFI_NOT_FOUND
;
390 // Get host bridge handle for status report
392 ExtendedData
.Handle
= RootBridgeDev
->PciRootBridgeIo
->ParentHandle
;
395 // Create the entire system resource map from the information collected by
396 // enumerator. Several resource tree was created
399 IoBridge
= CreateResourceNode (
408 Mem32Bridge
= CreateResourceNode (
417 PMem32Bridge
= CreateResourceNode (
426 Mem64Bridge
= CreateResourceNode (
435 PMem64Bridge
= CreateResourceNode (
445 // Create resourcemap by going through all the devices subject to this root bridge
447 Status
= CreateResourceMap (
457 // Get the max ROM size that the root bridge can process
459 RootBridgeDev
->RomSize
= Mem32Bridge
->Length
;
462 // Get Max Option Rom size for current root bridge
464 MaxOptionRomSize
= GetMaxOptionRomSize (RootBridgeDev
);
467 // Enlarger the mem32 resource to accomdate the option rom
468 // if the mem32 resource is not enough to hold the rom
470 if (MaxOptionRomSize
> Mem32Bridge
->Length
) {
472 Mem32Bridge
->Length
= MaxOptionRomSize
;
473 RootBridgeDev
->RomSize
= MaxOptionRomSize
;
476 // Alignment should be adjusted as well
478 if (Mem32Bridge
->Alignment
< MaxOptionRomSize
- 1) {
479 Mem32Bridge
->Alignment
= MaxOptionRomSize
- 1;
484 // Based on the all the resource tree, contruct ACPI resource node to
485 // submit the resource aperture to pci host bridge protocol
487 Status
= ConstructAcpiResourceRequestor (
498 // Insert these resource nodes into the database
500 InsertResourceNode (&IoPool
, IoBridge
);
501 InsertResourceNode (&Mem32Pool
, Mem32Bridge
);
502 InsertResourceNode (&PMem32Pool
, PMem32Bridge
);
503 InsertResourceNode (&Mem64Pool
, Mem64Bridge
);
504 InsertResourceNode (&PMem64Pool
, PMem64Bridge
);
506 if (Status
== EFI_SUCCESS
) {
508 // Submit the resource requirement
510 Status
= PciResAlloc
->SubmitResources (
512 RootBridgeDev
->Handle
,
517 // Free acpi resource node
520 gBS
->FreePool (AcpiConfig
);
523 if (EFI_ERROR (Status
)) {
525 // Destroy all the resource tree
527 DestroyResourceTree (&IoPool
);
528 DestroyResourceTree (&Mem32Pool
);
529 DestroyResourceTree (&PMem32Pool
);
530 DestroyResourceTree (&Mem64Pool
);
531 DestroyResourceTree (&PMem64Pool
);
540 // Notify pci bus driver starts to program the resource
542 Status
= NotifyPhase (PciResAlloc
, EfiPciHostBridgeAllocateResources
);
544 if (EFI_ERROR (Status
)) {
546 // Allocation failed, then return
548 return EFI_OUT_OF_RESOURCES
;
551 // Raise the EFI_IOB_PCI_RES_ALLOC status code
553 REPORT_STATUS_CODE_WITH_EXTENDED_DATA (
555 EFI_IO_BUS_PCI
| EFI_IOB_PCI_PC_RES_ALLOC
,
556 (VOID
*) &ExtendedData
,
557 sizeof (ExtendedData
)
561 // Notify pci bus driver starts to program the resource
563 NotifyPhase (PciResAlloc
, EfiPciHostBridgeSetResources
);
565 RootBridgeDev
= NULL
;
567 RootBridgeHandle
= 0;
569 while (PciResAlloc
->GetNextRootBridge (PciResAlloc
, &RootBridgeHandle
) == EFI_SUCCESS
) {
571 // Get RootBridg Device by handle
573 RootBridgeDev
= GetRootBridgeByHandle (RootBridgeHandle
);
575 if (RootBridgeDev
== NULL
) {
576 return EFI_NOT_FOUND
;
580 // Get acpi resource node for all the resource types
583 Status
= PciResAlloc
->GetProposedResources (
585 RootBridgeDev
->Handle
,
589 if (EFI_ERROR (Status
)) {
594 // Get the resource base by interpreting acpi resource node
607 // Process option rom for this root bridge
609 Status
= ProcessOptionRom (RootBridgeDev
, Mem32Base
, RootBridgeDev
->RomSize
);
612 // Create the entire system resource map from the information collected by
613 // enumerator. Several resource tree was created
615 Status
= GetResourceMap (
629 if (EFI_ERROR (Status
)) {
634 // Program IO resources
642 // Program Mem32 resources
650 // Program PMem32 resources
658 // Program Mem64 resources
666 // Program PMem64 resources
673 if (AcpiConfig
!= NULL
) {
674 gBS
->FreePool (AcpiConfig
);
679 // Destroy all the resource tree
681 DestroyResourceTree (&IoPool
);
682 DestroyResourceTree (&Mem32Pool
);
683 DestroyResourceTree (&PMem32Pool
);
684 DestroyResourceTree (&Mem64Pool
);
685 DestroyResourceTree (&PMem64Pool
);
688 // Notify the resource allocation phase is to end
690 NotifyPhase (PciResAlloc
, EfiPciHostBridgeEndResourceAllocation
);
697 PciHostBridgeResourceAllocator_WithHotPlugDeviceSupport (
698 IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
*PciResAlloc
704 Host brige resource allocator.
708 PciResAlloc - A pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL.
715 // TODO: EFI_NOT_FOUND - add return value to function comment
716 // TODO: EFI_NOT_FOUND - add return value to function comment
717 // TODO: EFI_NOT_FOUND - add return value to function comment
718 // TODO: EFI_SUCCESS - add return value to function comment
720 PCI_IO_DEVICE
*RootBridgeDev
;
721 EFI_HANDLE RootBridgeHandle
;
730 UINT64 Mem32ResStatus
;
731 UINT64 PMem32ResStatus
;
732 UINT64 Mem64ResStatus
;
733 UINT64 PMem64ResStatus
;
734 UINT64 MaxOptionRomSize
;
735 PCI_RESOURCE_NODE
*IoBridge
;
736 PCI_RESOURCE_NODE
*Mem32Bridge
;
737 PCI_RESOURCE_NODE
*PMem32Bridge
;
738 PCI_RESOURCE_NODE
*Mem64Bridge
;
739 PCI_RESOURCE_NODE
*PMem64Bridge
;
740 PCI_RESOURCE_NODE IoPool
;
741 PCI_RESOURCE_NODE Mem32Pool
;
742 PCI_RESOURCE_NODE PMem32Pool
;
743 PCI_RESOURCE_NODE Mem64Pool
;
744 PCI_RESOURCE_NODE PMem64Pool
;
746 REPORT_STATUS_CODE_LIBRARY_DEVICE_HANDLE_EXTENDED_DATA HandleExtendedData
;
747 REPORT_STATUS_CODE_LIBRARY_RESOURCE_ALLOC_FAILURE_ERROR_DATA AllocFailExtendedData
;
755 // It will try several times if the resource allocation fails
760 // Initialize resource pool
762 InitializeResourcePool (&IoPool
, PciBarTypeIo16
);
763 InitializeResourcePool (&Mem32Pool
, PciBarTypeMem32
);
764 InitializeResourcePool (&PMem32Pool
, PciBarTypePMem32
);
765 InitializeResourcePool (&Mem64Pool
, PciBarTypeMem64
);
766 InitializeResourcePool (&PMem64Pool
, PciBarTypePMem64
);
768 RootBridgeDev
= NULL
;
769 RootBridgeHandle
= 0;
771 while (PciResAlloc
->GetNextRootBridge (PciResAlloc
, &RootBridgeHandle
) == EFI_SUCCESS
) {
774 // Get RootBridg Device by handle
776 RootBridgeDev
= GetRootBridgeByHandle (RootBridgeHandle
);
778 if (RootBridgeDev
== NULL
) {
779 return EFI_NOT_FOUND
;
783 // Create the entire system resource map from the information collected by
784 // enumerator. Several resource tree was created
787 IoBridge
= CreateResourceNode (
796 Mem32Bridge
= CreateResourceNode (
805 PMem32Bridge
= CreateResourceNode (
814 Mem64Bridge
= CreateResourceNode (
823 PMem64Bridge
= CreateResourceNode (
833 // Create resourcemap by going through all the devices subject to this root bridge
835 Status
= CreateResourceMap (
845 // Get the max ROM size that the root bridge can process
847 RootBridgeDev
->RomSize
= Mem32Bridge
->Length
;
850 // Skip to enlarge the resource request during realloction
854 // Get Max Option Rom size for current root bridge
856 MaxOptionRomSize
= GetMaxOptionRomSize (RootBridgeDev
);
859 // Enlarger the mem32 resource to accomdate the option rom
860 // if the mem32 resource is not enough to hold the rom
862 if (MaxOptionRomSize
> Mem32Bridge
->Length
) {
864 Mem32Bridge
->Length
= MaxOptionRomSize
;
865 RootBridgeDev
->RomSize
= MaxOptionRomSize
;
868 // Alignment should be adjusted as well
870 if (Mem32Bridge
->Alignment
< MaxOptionRomSize
- 1) {
871 Mem32Bridge
->Alignment
= MaxOptionRomSize
- 1;
877 // Based on the all the resource tree, contruct ACPI resource node to
878 // submit the resource aperture to pci host bridge protocol
880 Status
= ConstructAcpiResourceRequestor (
891 // Insert these resource nodes into the database
893 InsertResourceNode (&IoPool
, IoBridge
);
894 InsertResourceNode (&Mem32Pool
, Mem32Bridge
);
895 InsertResourceNode (&PMem32Pool
, PMem32Bridge
);
896 InsertResourceNode (&Mem64Pool
, Mem64Bridge
);
897 InsertResourceNode (&PMem64Pool
, PMem64Bridge
);
899 if (Status
== EFI_SUCCESS
) {
901 // Submit the resource requirement
903 Status
= PciResAlloc
->SubmitResources (
905 RootBridgeDev
->Handle
,
911 // Free acpi resource node
913 if (AcpiConfig
!= NULL
) {
914 gBS
->FreePool (AcpiConfig
);
917 if (EFI_ERROR (Status
)) {
919 // Destroy all the resource tree
921 DestroyResourceTree (&IoPool
);
922 DestroyResourceTree (&Mem32Pool
);
923 DestroyResourceTree (&PMem32Pool
);
924 DestroyResourceTree (&Mem64Pool
);
925 DestroyResourceTree (&PMem64Pool
);
931 // Notify pci bus driver starts to program the resource
934 Status
= NotifyPhase (PciResAlloc
, EfiPciHostBridgeAllocateResources
);
936 if (!EFI_ERROR (Status
)) {
938 // Allocation succeed, then continue the following
944 // If the resource allocation is unsuccessful, free resources on bridge
947 RootBridgeDev
= NULL
;
948 RootBridgeHandle
= 0;
950 IoResStatus
= EFI_RESOURCE_SATISFIED
;
951 Mem32ResStatus
= EFI_RESOURCE_SATISFIED
;
952 PMem32ResStatus
= EFI_RESOURCE_SATISFIED
;
953 Mem64ResStatus
= EFI_RESOURCE_SATISFIED
;
954 PMem64ResStatus
= EFI_RESOURCE_SATISFIED
;
956 while (PciResAlloc
->GetNextRootBridge (PciResAlloc
, &RootBridgeHandle
) == EFI_SUCCESS
) {
958 // Get RootBridg Device by handle
960 RootBridgeDev
= GetRootBridgeByHandle (RootBridgeHandle
);
961 if (RootBridgeDev
== NULL
) {
962 return EFI_NOT_FOUND
;
966 // Get host bridge handle for status report
968 HandleExtendedData
.Handle
= RootBridgeDev
->PciRootBridgeIo
->ParentHandle
;
971 // Get acpi resource node for all the resource types
975 Status
= PciResAlloc
->GetProposedResources (
977 RootBridgeDev
->Handle
,
981 if (EFI_ERROR (Status
)) {
985 if (AcpiConfig
!= NULL
) {
987 // Adjust resource allocation policy for each RB
989 GetResourceAllocationStatus (
997 gBS
->FreePool (AcpiConfig
);
1005 // Raise the EFI_IOB_EC_RESOURCE_CONFLICT status code
1008 // It is very difficult to follow the spec here
1009 // Device path , Bar index can not be get here
1011 ZeroMem (&AllocFailExtendedData
, sizeof (AllocFailExtendedData
));
1013 REPORT_STATUS_CODE_WITH_EXTENDED_DATA (
1015 EFI_IO_BUS_PCI
| EFI_IOB_EC_RESOURCE_CONFLICT
,
1016 (VOID
*) &AllocFailExtendedData
,
1017 sizeof (AllocFailExtendedData
)
1020 Status
= PciHostBridgeAdjustAllocation (
1034 // Destroy all the resource tree
1036 DestroyResourceTree (&IoPool
);
1037 DestroyResourceTree (&Mem32Pool
);
1038 DestroyResourceTree (&PMem32Pool
);
1039 DestroyResourceTree (&Mem64Pool
);
1040 DestroyResourceTree (&PMem64Pool
);
1042 NotifyPhase (PciResAlloc
, EfiPciHostBridgeFreeResources
);
1044 if (EFI_ERROR (Status
)) {
1056 // Raise the EFI_IOB_PCI_RES_ALLOC status code
1058 REPORT_STATUS_CODE_WITH_EXTENDED_DATA (
1060 EFI_IO_BUS_PCI
| EFI_IOB_PCI_PC_RES_ALLOC
,
1061 (VOID
*) &HandleExtendedData
,
1062 sizeof (HandleExtendedData
)
1066 // Notify pci bus driver starts to program the resource
1068 NotifyPhase (PciResAlloc
, EfiPciHostBridgeSetResources
);
1070 RootBridgeDev
= NULL
;
1072 RootBridgeHandle
= 0;
1074 while (PciResAlloc
->GetNextRootBridge (PciResAlloc
, &RootBridgeHandle
) == EFI_SUCCESS
) {
1077 // Get RootBridg Device by handle
1079 RootBridgeDev
= GetRootBridgeByHandle (RootBridgeHandle
);
1081 if (RootBridgeDev
== NULL
) {
1082 return EFI_NOT_FOUND
;
1086 // Get acpi resource node for all the resource types
1089 Status
= PciResAlloc
->GetProposedResources (
1091 RootBridgeDev
->Handle
,
1095 if (EFI_ERROR (Status
)) {
1100 // Get the resource base by interpreting acpi resource node
1113 // Process option rom for this root bridge
1115 Status
= ProcessOptionRom (RootBridgeDev
, Mem32Base
, RootBridgeDev
->RomSize
);
1118 // Create the entire system resource map from the information collected by
1119 // enumerator. Several resource tree was created
1121 Status
= GetResourceMap (
1135 if (EFI_ERROR (Status
)) {
1140 // Program IO resources
1148 // Program Mem32 resources
1156 // Program PMem32 resources
1164 // Program Mem64 resources
1172 // Program PMem64 resources
1179 if (AcpiConfig
!= NULL
) {
1180 gBS
->FreePool (AcpiConfig
);
1185 // Destroy all the resource tree
1187 DestroyResourceTree (&IoPool
);
1188 DestroyResourceTree (&Mem32Pool
);
1189 DestroyResourceTree (&PMem32Pool
);
1190 DestroyResourceTree (&Mem64Pool
);
1191 DestroyResourceTree (&PMem64Pool
);
1194 // Notify the resource allocation phase is to end
1196 NotifyPhase (PciResAlloc
, EfiPciHostBridgeEndResourceAllocation
);
1204 IN PCI_IO_DEVICE
*Bridge
,
1205 IN UINT8 StartBusNumber
,
1206 OUT UINT8
*SubBusNumber
,
1207 OUT UINT8
*PaddedBusRange
1210 if (FeaturePcdGet (PcdPciBusHotplugDeviceSupport
)) {
1211 return PciScanBus_WithHotPlugDeviceSupport (
1218 return PciScanBus_WithoutHotPlugDeviceSupport (
1229 PciScanBus_WithoutHotPlugDeviceSupport (
1230 IN PCI_IO_DEVICE
*Bridge
,
1231 IN UINT8 StartBusNumber
,
1232 OUT UINT8
*SubBusNumber
,
1233 OUT UINT8
*PaddedBusRange
1237 Routine Description:
1239 This routine is used to assign bus number to the given PCI bus system
1248 // TODO: Bridge - add argument and description to function comment
1249 // TODO: StartBusNumber - add argument and description to function comment
1250 // TODO: SubBusNumber - add argument and description to function comment
1251 // TODO: PaddedBusRange - add argument and description to function comment
1252 // TODO: EFI_DEVICE_ERROR - add return value to function comment
1253 // TODO: EFI_SUCCESS - add return value to function comment
1262 PCI_IO_DEVICE
*PciDevice
;
1263 EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*PciRootBridgeIo
;
1265 PciRootBridgeIo
= Bridge
->PciRootBridgeIo
;
1269 ResetAllPpbBusReg (Bridge
, StartBusNumber
);
1271 for (Device
= 0; Device
<= PCI_MAX_DEVICE
; Device
++) {
1272 for (Func
= 0; Func
<= PCI_MAX_FUNC
; Func
++) {
1275 // Check to see whether a pci device is present
1277 Status
= PciDevicePresent (
1285 if (!EFI_ERROR (Status
) &&
1286 (IS_PCI_BRIDGE (&Pci
) ||
1287 IS_CARDBUS_BRIDGE (&Pci
))) {
1290 // Get the bridge information
1292 Status
= PciSearchDevice (
1301 if (EFI_ERROR (Status
)) {
1307 SecondBus
= (*SubBusNumber
);
1309 Register
= (UINT16
) ((SecondBus
<< 8) | (UINT16
) StartBusNumber
);
1311 Address
= EFI_PCI_ADDRESS (StartBusNumber
, Device
, Func
, 0x18);
1313 Status
= PciRootBridgeIo
->Pci
.Write (
1322 // Initialize SubBusNumber to SecondBus
1324 Address
= EFI_PCI_ADDRESS (StartBusNumber
, Device
, Func
, 0x1A);
1325 Status
= PciRootBridgeIo
->Pci
.Write (
1333 // If it is PPB, resursively search down this bridge
1335 if (IS_PCI_BRIDGE (&Pci
)) {
1337 // Temporarily initialize SubBusNumber to maximum bus number to ensure the
1338 // PCI configuration transaction to go through any PPB
1340 Address
= EFI_PCI_ADDRESS (StartBusNumber
, Device
, Func
, 0x1A);
1342 Status
= PciRootBridgeIo
->Pci
.Write (
1350 PreprocessController (
1352 PciDevice
->BusNumber
,
1353 PciDevice
->DeviceNumber
,
1354 PciDevice
->FunctionNumber
,
1355 EfiPciBeforeChildBusEnumeration
1358 Status
= PciScanBus (
1360 (UINT8
) (SecondBus
),
1365 if (EFI_ERROR (Status
)) {
1366 return EFI_DEVICE_ERROR
;
1371 // Set the current maximum bus number under the PPB
1374 Address
= EFI_PCI_ADDRESS (StartBusNumber
, Device
, Func
, 0x1A);
1376 Status
= PciRootBridgeIo
->Pci
.Write (
1386 if (Func
== 0 && !IS_PCI_MULTI_FUNC (&Pci
)) {
1389 // Skip sub functions, this is not a multi function device
1392 Func
= PCI_MAX_FUNC
;
1401 PciScanBus_WithHotPlugDeviceSupport (
1402 IN PCI_IO_DEVICE
*Bridge
,
1403 IN UINT8 StartBusNumber
,
1404 OUT UINT8
*SubBusNumber
,
1405 OUT UINT8
*PaddedBusRange
1409 Routine Description:
1411 This routine is used to assign bus number to the given PCI bus system
1415 Bridge - A pointer to the PCI_IO_DEVICE structure.
1416 StartBusNumber - The start bus number.
1417 SubBusNumber - A pointer to the sub bus number.
1418 PaddedBusRange - A pointer to the padded bus range.
1425 // TODO: EFI_DEVICE_ERROR - add return value to function comment
1426 // TODO: EFI_SUCCESS - add return value to function comment
1436 PCI_IO_DEVICE
*PciDevice
;
1438 EFI_HPC_STATE State
;
1440 EFI_HPC_PADDING_ATTRIBUTES Attributes
;
1441 EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*Descriptors
;
1443 EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*PciRootBridgeIo
;
1446 PciRootBridgeIo
= Bridge
->PciRootBridgeIo
;
1450 Attributes
= (EFI_HPC_PADDING_ATTRIBUTES
) 0;
1453 ResetAllPpbBusReg (Bridge
, StartBusNumber
);
1455 for (Device
= 0; Device
<= PCI_MAX_DEVICE
; Device
++) {
1456 for (Func
= 0; Func
<= PCI_MAX_FUNC
; Func
++) {
1459 // Check to see whether a pci device is present
1461 Status
= PciDevicePresent (
1469 if (EFI_ERROR (Status
)) {
1472 // Skip sub functions, this is not a multi function device
1474 Func
= PCI_MAX_FUNC
;
1481 // Get the PCI device information
1483 Status
= PciSearchDevice (
1492 ASSERT (!EFI_ERROR (Status
));
1494 PciAddress
= EFI_PCI_ADDRESS (StartBusNumber
, Device
, Func
, 0);
1496 if (!IS_PCI_BRIDGE (&Pci
)) {
1498 // PCI bridges will be called later
1499 // Here just need for PCI device or PCI to cardbus controller
1500 // EfiPciBeforeChildBusEnumeration for PCI Device Node
1502 PreprocessController (
1504 PciDevice
->BusNumber
,
1505 PciDevice
->DeviceNumber
,
1506 PciDevice
->FunctionNumber
,
1507 EfiPciBeforeChildBusEnumeration
1512 // For Pci Hotplug controller devcie only
1514 if (gPciHotPlugInit
!= NULL
) {
1516 // Check if it is a Hotplug PCI controller
1518 if (IsRootPciHotPlugController (PciDevice
->DevicePath
, &HpIndex
)) {
1520 if (!gPciRootHpcData
[HpIndex
].Initialized
) {
1522 Status
= CreateEventForHpc (HpIndex
, &Event
);
1524 ASSERT (!EFI_ERROR (Status
));
1526 Status
= gPciHotPlugInit
->InitializeRootHpc (
1528 gPciRootHpcPool
[HpIndex
].HpcDevicePath
,
1534 PreprocessController (
1536 PciDevice
->BusNumber
,
1537 PciDevice
->DeviceNumber
,
1538 PciDevice
->FunctionNumber
,
1539 EfiPciBeforeChildBusEnumeration
1546 if (IS_PCI_BRIDGE (&Pci
) || IS_CARDBUS_BRIDGE (&Pci
)) {
1549 // Get the bridge information
1552 if (gPciHotPlugInit
!= NULL
) {
1554 if (IsRootPciHotPlugBus (PciDevice
->DevicePath
, &HpIndex
)) {
1557 // If it is initialized, get the padded bus range
1559 Status
= gPciHotPlugInit
->GetResourcePadding (
1561 gPciRootHpcPool
[HpIndex
].HpbDevicePath
,
1564 (VOID
**) &Descriptors
,
1568 if (EFI_ERROR (Status
)) {
1573 Status
= PciGetBusRange (
1580 gBS
->FreePool (Descriptors
);
1582 if (EFI_ERROR (Status
)) {
1591 SecondBus
= *SubBusNumber
;
1593 Register
= (UINT16
) ((SecondBus
<< 8) | (UINT16
) StartBusNumber
);
1594 Address
= EFI_PCI_ADDRESS (StartBusNumber
, Device
, Func
, 0x18);
1596 Status
= PciRootBridgeIo
->Pci
.Write (
1606 // If it is PPB, resursively search down this bridge
1608 if (IS_PCI_BRIDGE (&Pci
)) {
1611 // Initialize SubBusNumber to Maximum bus number
1614 Address
= EFI_PCI_ADDRESS (StartBusNumber
, Device
, Func
, 0x1A);
1615 Status
= PciRootBridgeIo
->Pci
.Write (
1624 // Nofify EfiPciBeforeChildBusEnumeration for PCI Brige
1626 PreprocessController (
1628 PciDevice
->BusNumber
,
1629 PciDevice
->DeviceNumber
,
1630 PciDevice
->FunctionNumber
,
1631 EfiPciBeforeChildBusEnumeration
1634 Status
= PciScanBus (
1636 (UINT8
) (SecondBus
),
1641 if (EFI_ERROR (Status
)) {
1642 return EFI_DEVICE_ERROR
;
1648 // Ensure the device is enabled and initialized
1650 if ((Attributes
== EfiPaddingPciRootBridge
) &&
1651 (State
& EFI_HPC_STATE_ENABLED
) &&
1652 (State
& EFI_HPC_STATE_INITIALIZED
) ) {
1653 *PaddedBusRange
= (UINT8
) ((UINT8
) (BusRange
) +*PaddedBusRange
);
1655 *SubBusNumber
= (UINT8
) ((UINT8
) (BusRange
) +*SubBusNumber
);
1660 // Set the current maximum bus number under the PPB
1662 Address
= EFI_PCI_ADDRESS (StartBusNumber
, Device
, Func
, 0x1A);
1664 Status
= PciRootBridgeIo
->Pci
.Write (
1673 if (Func
== 0 && !IS_PCI_MULTI_FUNC (&Pci
)) {
1676 // Skip sub functions, this is not a multi function device
1678 Func
= PCI_MAX_FUNC
;
1688 PciRootBridgeP2CProcess (
1689 IN PCI_IO_DEVICE
*Bridge
1693 Routine Description:
1695 Process Option Rom on this host bridge
1704 // TODO: Bridge - add argument and description to function comment
1705 // TODO: EFI_SUCCESS - add return value to function comment
1707 LIST_ENTRY
*CurrentLink
;
1708 PCI_IO_DEVICE
*Temp
;
1709 EFI_HPC_STATE State
;
1713 CurrentLink
= Bridge
->ChildList
.ForwardLink
;
1715 while (CurrentLink
&& CurrentLink
!= &Bridge
->ChildList
) {
1717 Temp
= PCI_IO_DEVICE_FROM_LINK (CurrentLink
);
1719 if (IS_CARDBUS_BRIDGE (&Temp
->Pci
)) {
1721 if (gPciHotPlugInit
&& Temp
->Allocated
) {
1724 // Raise the EFI_IOB_PCI_HPC_INIT status code
1726 REPORT_STATUS_CODE_WITH_DEVICE_PATH (
1728 EFI_IO_BUS_PCI
| EFI_IOB_PCI_PC_HPC_INIT
,
1732 PciAddress
= EFI_PCI_ADDRESS (Temp
->BusNumber
, Temp
->DeviceNumber
, Temp
->FunctionNumber
, 0);
1733 Status
= gPciHotPlugInit
->InitializeRootHpc (
1741 if (!EFI_ERROR (Status
)) {
1742 Status
= PciBridgeEnumerator (Temp
);
1744 if (EFI_ERROR (Status
)) {
1749 CurrentLink
= CurrentLink
->ForwardLink
;
1755 if (!IsListEmpty (&Temp
->ChildList
)) {
1756 Status
= PciRootBridgeP2CProcess (Temp
);
1759 CurrentLink
= CurrentLink
->ForwardLink
;
1766 PciHostBridgeP2CProcess (
1767 IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
*PciResAlloc
1771 Routine Description:
1780 // TODO: PciResAlloc - add argument and description to function comment
1781 // TODO: EFI_NOT_FOUND - add return value to function comment
1782 // TODO: EFI_SUCCESS - add return value to function comment
1784 EFI_HANDLE RootBridgeHandle
;
1785 PCI_IO_DEVICE
*RootBridgeDev
;
1788 if (!FeaturePcdGet (PcdPciBusHotplugDeviceSupport
)) {
1792 RootBridgeHandle
= NULL
;
1794 while (PciResAlloc
->GetNextRootBridge (PciResAlloc
, &RootBridgeHandle
) == EFI_SUCCESS
) {
1797 // Get RootBridg Device by handle
1799 RootBridgeDev
= GetRootBridgeByHandle (RootBridgeHandle
);
1801 if (RootBridgeDev
== NULL
) {
1802 return EFI_NOT_FOUND
;
1805 Status
= PciRootBridgeP2CProcess (RootBridgeDev
);
1807 if (EFI_ERROR (Status
)) {
1817 PciHostBridgeEnumerator (
1818 EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL
*PciResAlloc
1822 Routine Description:
1824 This function is used to enumerate the entire host bridge
1829 PciResAlloc - A pointer to the resource allocate protocol.
1836 // TODO: EFI_OUT_OF_RESOURCES - add return value to function comment
1837 // TODO: EFI_OUT_OF_RESOURCES - add return value to function comment
1838 // TODO: EFI_OUT_OF_RESOURCES - add return value to function comment
1839 // TODO: EFI_SUCCESS - add return value to function comment
1841 EFI_HANDLE RootBridgeHandle
;
1842 PCI_IO_DEVICE
*RootBridgeDev
;
1844 EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*PciRootBridgeIo
;
1846 EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*Descriptors
;
1848 InitializeHotPlugSupport ();
1851 // Notify the bus allocation phase is about to start
1853 NotifyPhase (PciResAlloc
, EfiPciHostBridgeBeginBusAllocation
);
1855 RootBridgeHandle
= NULL
;
1856 while (PciResAlloc
->GetNextRootBridge (PciResAlloc
, &RootBridgeHandle
) == EFI_SUCCESS
) {
1859 // if a root bridge instance is found, create root bridge device for it
1862 RootBridgeDev
= CreateRootBridge (RootBridgeHandle
);
1864 if (RootBridgeDev
== NULL
) {
1865 return EFI_OUT_OF_RESOURCES
;
1869 // Enumerate all the buses under this root bridge
1872 Status
= PciRootBridgeEnumerator (
1877 if (EFI_ERROR (Status
)) {
1881 DestroyRootBridge (RootBridgeDev
);
1884 // Error proccess here
1888 if (FeaturePcdGet (PcdPciBusHotplugDeviceSupport
)) {
1891 // Notify the bus allocation phase is finished for the first time
1893 NotifyPhase (PciResAlloc
, EfiPciHostBridgeEndBusAllocation
);
1896 if (gPciHotPlugInit
!= NULL
) {
1898 // Wait for all HPC initialized
1900 Status
= AllRootHPCInitialized (STALL_1_SECOND
* 15);
1902 if (EFI_ERROR (Status
)) {
1907 // Notify the bus allocation phase is about to start for the 2nd time
1909 NotifyPhase (PciResAlloc
, EfiPciHostBridgeBeginBusAllocation
);
1911 RootBridgeHandle
= NULL
;
1912 while (PciResAlloc
->GetNextRootBridge (PciResAlloc
, &RootBridgeHandle
) == EFI_SUCCESS
) {
1915 // if a root bridge instance is found, create root bridge device for it
1918 RootBridgeDev
= CreateRootBridge (RootBridgeHandle
);
1920 if (RootBridgeDev
== NULL
) {
1921 return EFI_OUT_OF_RESOURCES
;
1925 // Enumerate all the buses under this root bridge
1928 Status
= PciRootBridgeEnumerator (
1933 DestroyRootBridge (RootBridgeDev
);
1934 if (EFI_ERROR (Status
)) {
1940 // Notify the bus allocation phase is to end
1942 NotifyPhase (PciResAlloc
, EfiPciHostBridgeEndBusAllocation
);
1946 // Notify the bus allocation phase is to end
1948 NotifyPhase (PciResAlloc
, EfiPciHostBridgeEndBusAllocation
);
1952 // Notify the resource allocation phase is to start
1954 NotifyPhase (PciResAlloc
, EfiPciHostBridgeBeginResourceAllocation
);
1956 RootBridgeHandle
= NULL
;
1957 while (PciResAlloc
->GetNextRootBridge (PciResAlloc
, &RootBridgeHandle
) == EFI_SUCCESS
) {
1960 // if a root bridge instance is found, create root bridge device for it
1963 RootBridgeDev
= CreateRootBridge (RootBridgeHandle
);
1965 if (RootBridgeDev
== NULL
) {
1966 return EFI_OUT_OF_RESOURCES
;
1969 Status
= StartManagingRootBridge (RootBridgeDev
);
1971 if (EFI_ERROR (Status
)) {
1975 PciRootBridgeIo
= RootBridgeDev
->PciRootBridgeIo
;
1976 Status
= PciRootBridgeIo
->Configuration (PciRootBridgeIo
, (VOID
**) &Descriptors
);
1978 if (EFI_ERROR (Status
)) {
1982 Status
= PciGetBusRange (&Descriptors
, &MinBus
, NULL
, NULL
);
1984 if (EFI_ERROR (Status
)) {
1989 // Determine root bridge attribute by calling interface of Pcihostbridge
1992 DetermineRootBridgeAttributes (
1998 // Collect all the resource information under this root bridge
1999 // A database that records all the information about pci device subject to this
2000 // root bridge will then be created
2002 Status
= PciPciDeviceInfoCollector (
2007 if (EFI_ERROR (Status
)) {
2011 InsertRootBridge (RootBridgeDev
);
2014 // Record the hostbridge handle
2016 AddHostBridgeEnumerator (RootBridgeDev
->PciRootBridgeIo
->ParentHandle
);