PciLib.c revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
/** @file
Internal library implementation for PCI Bus module.
Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include "PciBus.h"
CHAR16 *mBarTypeStr[] = {
L"Unknow",
L" Io16",
L" Io32",
L" Mem32",
L"PMem32",
L" Mem64",
L"PMem64",
L" Io",
L" Mem",
L"Unknow"
};
/**
Retrieve the PCI Card device BAR information via PciIo interface.
@param PciIoDevice PCI Card device instance.
**/
)
{
if (!FeaturePcdGet (PcdPciBusHotplugDeviceSupport)) {
return;
}
//
// Read PciBar information from the bar register
//
if (!gFullEnumeration) {
Address = 0;
&(PciIoDevice->PciIo),
1,
);
Address = 0;
&(PciIoDevice->PciIo),
1,
);
Address = 0;
&(PciIoDevice->PciIo),
1,
);
Address = 0;
&(PciIoDevice->PciIo),
1,
);
}
}
}
/**
Remove rejected pci device from specific root bridge
handle.
@param RootBridgeHandle Specific parent root bridge handle.
@param Bridge Bridge device instance.
**/
)
{
if (!FeaturePcdGet (PcdPciBusHotplugDeviceSupport)) {
return;
}
//
// Remove rejected devices recusively
//
} else {
//
// Skip rejection for all PPBs, while detect rejection for others
//
if (IsPciDeviceRejected (Temp)) {
//
// For P2C, remove all devices on it
//
}
//
// Finally remove itself
//
}
}
}
}
/**
Dump the resourc map of the bridge device.
@param[in] BridgeResource Resource descriptor of the bridge device.
**/
)
{
DEBUG ((
EFI_D_INFO, "Type = %s; Base = 0x%x;\tLength = 0x%x;\tAlignment = 0x%x\n",
));
) {
DEBUG ((
EFI_D_INFO, " Base = 0x%x;\tLength = 0x%x;\tAlignment = 0x%x;\tOwner = %s ",
L"PCI"
));
) {
//
// The resource requirement comes from the device itself.
//
DEBUG ((
EFI_D_INFO, " [%02x|%02x|%02x:%02x]\n",
));
} else {
//
// The resource requirement comes from the subordinate devices.
//
DEBUG ((
EFI_D_INFO, " [%02x|%02x|%02x:**]\n",
));
}
} else {
DEBUG ((EFI_D_INFO, " Padding:Length = 0x%x;\tAlignment = 0x%x\n", Resource->Length, Resource->Alignment));
}
}
}
}
/**
Find the corresponding resource node for the Device in child list of BridgeResource.
@param[in] Device Pointer to PCI_IO_DEVICE.
@param[in] BridgeResource Pointer to PCI_RESOURCE_NODE.
@return !NULL The corresponding resource node for the Device.
@return NULL No corresponding resource node for the Device.
**/
)
{
) {
return Resource;
}
}
return NULL;
}
/**
Dump the resource map of all the devices under Bridge.
@param[in] Bridge Bridge device instance.
@param[in] IoNode IO resource descriptor for the bridge device.
@param[in] Mem32Node Mem32 resource descriptor for the bridge device.
@param[in] PMem32Node PMem32 resource descriptor for the bridge device.
@param[in] Mem64Node Mem64 resource descriptor for the bridge device.
@param[in] PMem64Node PMem64 resource descriptor for the bridge device.
**/
)
{
NULL,
NULL,
NULL,
);
DEBUG ((
EFI_D_INFO, "Bridge [%02x|%02x|%02x]\n",
));
} else {
NULL,
);
);
}
}
}
) {
);
}
}
}
/**
Submits the I/O and memory resource requirements for the specified PCI Host Bridge.
@param PciResAlloc Point to protocol instance of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL.
@retval EFI_SUCCESS Successfully finished resource allocation.
@retval EFI_NOT_FOUND Cannot get root bridge instance.
@retval EFI_OUT_OF_RESOURCES Platform failed to program the resources if no hot plug supported.
@retval other Some error occurred when allocating resources for the PCI Host Bridge.
@note Feature flag PcdPciBusHotplugDeviceSupport determine whether need support hotplug.
**/
)
{
//
// Reallocate flag
//
ReAllocate = FALSE;
//
// It may try several times if the resource allocation fails
//
while (TRUE) {
//
// Initialize resource pool
//
RootBridgeHandle = 0;
//
// Get Root Bridge Device by handle
//
if (RootBridgeDev == NULL) {
return EFI_NOT_FOUND;
}
//
// Create the entire system resource map from the information collected by
// enumerator. Several resource tree was created
//
//
// If non-stardard PCI Bridge I/O window alignment is supported,
// set I/O aligment to minimum possible alignment for root bridge.
//
0,
);
0,
0xFFFFF,
);
0,
0xFFFFF,
);
0,
0xFFFFF,
);
0,
0xFFFFF,
);
//
// Create resourcemap by going through all the devices subject to this root bridge
//
);
//
// Get the max ROM size that the root bridge can process
//
//
// Skip to enlarge the resource request during realloction
//
if (!ReAllocate) {
//
// Get Max Option Rom size for current root bridge
//
//
// Enlarger the mem32 resource to accomdate the option rom
// if the mem32 resource is not enough to hold the rom
//
//
// Alignment should be adjusted as well
//
}
}
}
//
// Based on the all the resource tree, contruct ACPI resource node to
// submit the resource aperture to pci host bridge protocol
//
);
//
// Insert these resource nodes into the database
//
if (Status == EFI_SUCCESS) {
//
// Submit the resource requirement
//
);
}
//
// Free acpi resource node
//
if (AcpiConfig != NULL) {
}
//
// Destroy all the resource tree
//
return Status;
}
}
//
// End while, at least one Root Bridge should be found.
//
//
// Notify platform to start to program the resource
//
if (!FeaturePcdGet (PcdPciBusHotplugDeviceSupport)) {
//
// If Hot Plug is not supported
//
//
// Allocation failed, then return
//
return EFI_OUT_OF_RESOURCES;
}
//
// Allocation succeed.
// Get host bridge handle for status report, and then skip the main while
//
break;
} else {
//
// If Hot Plug is supported
//
//
// Allocation succeed, then continue the following
//
break;
}
//
// If the resource allocation is unsuccessful, free resources on bridge
//
RootBridgeHandle = 0;
//
// Get RootBridg Device by handle
//
if (RootBridgeDev == NULL) {
return EFI_NOT_FOUND;
}
//
// Get host bridge handle for status report
//
//
// Get acpi resource node for all the resource types
//
AcpiConfig = NULL;
);
return Status;
}
if (AcpiConfig != NULL) {
//
// Adjust resource allocation policy for each RB
//
);
}
}
//
// End while
//
//
// Raise the EFI_IOB_EC_RESOURCE_CONFLICT status code
//
//
// It is very difficult to follow the spec here
// Device path , Bar index can not be get here
//
(VOID *) &AllocFailExtendedData,
sizeof (AllocFailExtendedData)
);
&IoPool,
);
//
// Destroy all the resource tree
//
return Status;
}
ReAllocate = TRUE;
}
}
//
// End main while
//
//
// Raise the EFI_IOB_PCI_RES_ALLOC status code
//
(VOID *) &HandleExtendedData,
sizeof (HandleExtendedData)
);
//
// Notify pci bus driver starts to program the resource
//
RootBridgeHandle = 0;
//
// Get RootBridg Device by handle
//
if (RootBridgeDev == NULL) {
return EFI_NOT_FOUND;
}
//
// Get acpi resource node for all the resource types
//
AcpiConfig = NULL;
);
return Status;
}
//
// Get the resource base by interpreting acpi resource node
//
//
&IoBase,
);
//
// Process option rom for this root bridge
//
//
// Create the entire system resource map from the information collected by
// enumerator. Several resource tree was created
//
//
// Program IO resources
//
);
//
// Program Mem32 resources
//
);
//
// Program PMem32 resources
//
);
//
// Program Mem64 resources
//
);
//
// Program PMem64 resources
//
);
//
// Dump the resource map for current root bridge
//
);
);
}
//
// Destroy all the resource tree
//
//
// Notify the resource allocation phase is to end
//
return EFI_SUCCESS;
}
/**
Allocate NumberOfBuses buses and return the next available PCI bus number.
@param Bridge Bridge device instance.
@param StartBusNumber Current available PCI bus number.
@param NumberOfBuses Number of buses enumerated below the StartBusNumber.
@param NextBusNumber Next available PCI bus number.
@retval EFI_SUCCESS Available bus number resource is enough. Next available PCI bus number
is returned in NextBusNumber.
@retval EFI_OUT_OF_RESOURCES Available bus number resource is not enough for allocation.
**/
)
{
//
// Get PCI Root Bridge device
//
RootBridge = Bridge;
}
//
// Get next available PCI bus number
//
while (NextNumber > MaxNumberInRange) {
return EFI_OUT_OF_RESOURCES;
}
}
return EFI_SUCCESS;
}
}
return EFI_OUT_OF_RESOURCES;
}
/**
Scan pci bus and assign bus number to the given PCI bus system.
@param Bridge Bridge device instance.
@param StartBusNumber start point.
@param SubBusNumber Point to sub bus number.
@param PaddedBusRange Customized bus number.
@retval EFI_SUCCESS Successfully scanned and assigned bus number.
@retval other Some error occurred when scanning pci bus.
@note Feature flag PcdPciBusHotplugDeviceSupport determine whether need support hotplug.
**/
)
{
SecondBus = 0;
Register = 0;
State = 0;
BusRange = 0;
BusPadding = FALSE;
PciAddress = 0;
TempReservedBusNum = 0;
//
// Check to see whether a pci device is present
//
&Pci,
);
continue;
}
//
// Get the PCI device information
//
&Pci,
Func,
);
if (!IS_PCI_BRIDGE (&Pci)) {
//
// PCI bridges will be called later
// Here just need for PCI device or PCI to cardbus controller
// EfiPciBeforeChildBusEnumeration for PCI Device Node
//
);
}
//
// For Pci Hotplug controller devcie only
//
if (gPciHotPlugInit != NULL) {
//
// Check if it is a Hotplug PCI controller
//
);
);
}
}
}
}
//
// For PPB
//
if (!FeaturePcdGet (PcdPciBusHotplugDeviceSupport)) {
//
// If Hot Plug is not supported,
// get the bridge information
//
&Pci,
Func,
);
return Status;
}
} else {
//
// If Hot Plug is supported,
// Get the bridge information
//
BusPadding = FALSE;
if (gPciHotPlugInit != NULL) {
//
// If it is initialized, get the padded bus range
//
&State,
(VOID **) &Descriptors,
);
return Status;
}
BusRange = 0;
Status = PciGetBusRange (
NULL,
NULL,
);
return Status;
}
BusPadding = TRUE;
}
}
}
return Status;
}
1,
);
//
// If it is PPB, resursively search down this bridge
//
if (IS_PCI_BRIDGE (&Pci)) {
//
// Temporarily initialize SubBusNumber to maximum bus number to ensure the
// PCI configuration transaction to go through any PPB
//
Register = 0xFF;
Address = EFI_PCI_ADDRESS (StartBusNumber, Device, Func, PCI_BRIDGE_SUBORDINATE_BUS_REGISTER_OFFSET);
1,
);
//
// Nofify EfiPciBeforeChildBusEnumeration for PCI Brige
//
);
Status = PciScanBus (
);
return Status;
}
}
//
// Ensure the device is enabled and initialized
//
if ((Attributes == EfiPaddingPciRootBridge) &&
(State & EFI_HPC_STATE_ENABLED) != 0 &&
(State & EFI_HPC_STATE_INITIALIZED) != 0) {
} else {
return Status;
}
}
}
//
// Set the current maximum bus number under the PPB
//
Address = EFI_PCI_ADDRESS (StartBusNumber, Device, Func, PCI_BRIDGE_SUBORDINATE_BUS_REGISTER_OFFSET);
1,
);
} else {
//
// It is device. Check PCI IOV for Bus reservation
// Go through each function, just reserve the MAX ReservedBusNum for one device
//
Status = PciAllocateBusNumber (PciDevice, *SubBusNumber, (UINT8) (PciDevice->ReservedBusNum - TempReservedBusNum), SubBusNumber);
return Status;
}
if (Func == 0) {
} else {
}
}
}
}
//
// Skip sub functions, this is not a multi function device
//
Func = PCI_MAX_FUNC;
}
}
}
return EFI_SUCCESS;
}
/**
Process Option Rom on the specified root bridge.
@param Bridge Pci root bridge device instance.
@retval EFI_SUCCESS Success process.
@retval other Some error occurred when processing Option Rom on the root bridge.
**/
)
{
//
// Raise the EFI_IOB_PCI_HPC_INIT status code
//
);
NULL,
);
return Status;
}
}
continue;
}
}
}
}
return EFI_SUCCESS;
}
/**
Process Option Rom on the specified host bridge.
@param PciResAlloc Pointer to instance of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL.
@retval EFI_SUCCESS Success process.
@retval EFI_NOT_FOUND Can not find the root bridge instance.
@retval other Some error occurred when processing Option Rom on the host bridge.
**/
)
{
if (!FeaturePcdGet (PcdPciBusHotplugDeviceSupport)) {
return EFI_SUCCESS;
}
//
// Get RootBridg Device by handle
//
if (RootBridgeDev == NULL) {
return EFI_NOT_FOUND;
}
return Status;
}
}
return EFI_SUCCESS;
}
/**
This function is used to enumerate the entire host bridge
in a given platform.
@param PciResAlloc A pointer to the PCI Host Resource Allocation protocol.
@retval EFI_SUCCESS Successfully enumerated the host bridge.
@retval EFI_OUT_OF_RESOURCES No enough memory available.
@retval other Some error occurred when enumerating the host bridge.
**/
)
{
}
//
// Notify the bus allocation phase is about to start
//
//
// if a root bridge instance is found, create root bridge device for it
//
if (RootBridgeDev == NULL) {
return EFI_OUT_OF_RESOURCES;
}
//
// Enumerate all the buses under this root bridge
//
);
} else {
}
return Status;
}
}
//
// Notify the bus allocation phase is finished for the first time
//
//
// Reset all assigned PCI bus number in all PPB
//
//
// Get the Bus information
//
(VOID **) &Configuration
);
return Status;
}
//
// Get the bus number to start with
//
);
}
//
// Wait for all HPC initialized
//
return Status;
}
//
// Notify the bus allocation phase is about to start for the 2nd time
//
//
// if a root bridge instance is found, create root bridge device for it
//
if (RootBridgeDev == NULL) {
return EFI_OUT_OF_RESOURCES;
}
//
// Enumerate all the buses under this root bridge
//
);
return Status;
}
}
//
// Notify the bus allocation phase is to end for the 2nd time
//
}
//
// Notify the resource allocation phase is to start
//
//
// if a root bridge instance is found, create root bridge device for it
//
if (RootBridgeDev == NULL) {
return EFI_OUT_OF_RESOURCES;
}
return Status;
}
return Status;
}
return Status;
}
//
// Determine root bridge attribute by calling interface of Pcihostbridge
// protocol
//
);
//
// Collect all the resource information under this root bridge
// A database that records all the information about pci device subject to this
// root bridge will then be created
//
);
return Status;
}
//
// Record the hostbridge handle
//
}
return EFI_SUCCESS;
}