mirror of
https://github.com/CloverHackyColor/CloverBootloader.git
synced 2024-11-28 12:25:19 +01:00
485 lines
12 KiB
C
485 lines
12 KiB
C
/** @file
|
|
PCI Hot Plug support functions implementation for PCI Bus module..
|
|
|
|
Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#include "PciBus.h"
|
|
|
|
EFI_PCI_HOT_PLUG_INIT_PROTOCOL *gPciHotPlugInit = NULL;
|
|
EFI_HPC_LOCATION *gPciRootHpcPool = NULL;
|
|
UINTN gPciRootHpcCount = 0;
|
|
ROOT_HPC_DATA *gPciRootHpcData = NULL;
|
|
|
|
|
|
/**
|
|
Event notification function to set Hot Plug controller status.
|
|
|
|
@param Event The event that invoke this function.
|
|
@param Context The calling context, pointer to ROOT_HPC_DATA.
|
|
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
PciHPCInitialized (
|
|
IN EFI_EVENT Event,
|
|
IN VOID *Context
|
|
)
|
|
{
|
|
ROOT_HPC_DATA *HpcData;
|
|
|
|
HpcData = (ROOT_HPC_DATA *) Context;
|
|
HpcData->Initialized = TRUE;
|
|
}
|
|
|
|
/**
|
|
Compare two device paths to check if they are exactly same.
|
|
|
|
@param DevicePath1 A pointer to the first device path data structure.
|
|
@param DevicePath2 A pointer to the second device path data structure.
|
|
|
|
@retval TRUE They are same.
|
|
@retval FALSE They are not same.
|
|
|
|
**/
|
|
BOOLEAN
|
|
EfiCompareDevicePath (
|
|
IN EFI_DEVICE_PATH_PROTOCOL *DevicePath1,
|
|
IN EFI_DEVICE_PATH_PROTOCOL *DevicePath2
|
|
)
|
|
{
|
|
UINTN Size1;
|
|
UINTN Size2;
|
|
|
|
Size1 = GetDevicePathSize (DevicePath1);
|
|
Size2 = GetDevicePathSize (DevicePath2);
|
|
|
|
if (Size1 != Size2) {
|
|
return FALSE;
|
|
}
|
|
|
|
if (CompareMem (DevicePath1, DevicePath2, Size1) != 0) {
|
|
return FALSE;
|
|
}
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
/**
|
|
Check hot plug support and initialize root hot plug private data.
|
|
|
|
If Hot Plug is supported by the platform, call PCI Hot Plug Init protocol
|
|
to get PCI Hot Plug controller's information and constructor the root hot plug
|
|
private data structure.
|
|
|
|
@retval EFI_SUCCESS They are same.
|
|
@retval EFI_UNSUPPORTED No PCI Hot Plug controller on the platform.
|
|
@retval EFI_OUT_OF_RESOURCES No memory to constructor root hot plug private
|
|
data structure.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
InitializeHotPlugSupport (
|
|
VOID
|
|
)
|
|
{
|
|
EFI_STATUS Status;
|
|
EFI_HPC_LOCATION *HpcList;
|
|
UINTN HpcCount;
|
|
|
|
//
|
|
// Locate the PciHotPlugInit Protocol
|
|
// If it doesn't exist, that means there is no
|
|
// hot plug controller supported on the platform
|
|
// the PCI Bus driver is running on. HotPlug Support
|
|
// is an optional feature, so absence of the protocol
|
|
// won't incur the penalty.
|
|
//
|
|
Status = gBS->LocateProtocol (
|
|
&gEfiPciHotPlugInitProtocolGuid,
|
|
NULL,
|
|
(VOID **) &gPciHotPlugInit
|
|
);
|
|
|
|
if (EFI_ERROR (Status)) {
|
|
return EFI_UNSUPPORTED;
|
|
}
|
|
|
|
Status = gPciHotPlugInit->GetRootHpcList (
|
|
gPciHotPlugInit,
|
|
&HpcCount,
|
|
&HpcList
|
|
);
|
|
|
|
if (!EFI_ERROR (Status)) {
|
|
|
|
gPciRootHpcPool = HpcList;
|
|
gPciRootHpcCount = HpcCount;
|
|
gPciRootHpcData = AllocateZeroPool (sizeof (ROOT_HPC_DATA) * gPciRootHpcCount);
|
|
if (gPciRootHpcData == NULL) {
|
|
return EFI_OUT_OF_RESOURCES;
|
|
}
|
|
}
|
|
|
|
return EFI_SUCCESS;
|
|
}
|
|
|
|
/**
|
|
Test whether device path is for root pci hot plug bus.
|
|
|
|
@param HpbDevicePath A pointer to device path data structure to be tested.
|
|
@param HpIndex If HpIndex is not NULL, return the index of root hot
|
|
plug in global array when TRUE is returned.
|
|
|
|
@retval TRUE The device path is for root pci hot plug bus.
|
|
@retval FALSE The device path is not for root pci hot plug bus.
|
|
|
|
**/
|
|
BOOLEAN
|
|
IsRootPciHotPlugBus (
|
|
IN EFI_DEVICE_PATH_PROTOCOL *HpbDevicePath,
|
|
OUT UINTN *HpIndex OPTIONAL
|
|
)
|
|
{
|
|
UINTN Index;
|
|
|
|
for (Index = 0; Index < gPciRootHpcCount; Index++) {
|
|
|
|
if (EfiCompareDevicePath (gPciRootHpcPool[Index].HpbDevicePath, HpbDevicePath)) {
|
|
|
|
if (HpIndex != NULL) {
|
|
*HpIndex = Index;
|
|
}
|
|
|
|
return TRUE;
|
|
}
|
|
}
|
|
|
|
return FALSE;
|
|
}
|
|
|
|
/**
|
|
Test whether device path is for root pci hot plug controller.
|
|
|
|
@param HpcDevicePath A pointer to device path data structure to be tested.
|
|
@param HpIndex If HpIndex is not NULL, return the index of root hot
|
|
plug in global array when TRUE is returned.
|
|
|
|
@retval TRUE The device path is for root pci hot plug controller.
|
|
@retval FALSE The device path is not for root pci hot plug controller.
|
|
|
|
**/
|
|
BOOLEAN
|
|
IsRootPciHotPlugController (
|
|
IN EFI_DEVICE_PATH_PROTOCOL *HpcDevicePath,
|
|
OUT UINTN *HpIndex
|
|
)
|
|
{
|
|
UINTN Index;
|
|
|
|
for (Index = 0; Index < gPciRootHpcCount; Index++) {
|
|
|
|
if (EfiCompareDevicePath (gPciRootHpcPool[Index].HpcDevicePath, HpcDevicePath)) {
|
|
|
|
if (HpIndex != NULL) {
|
|
*HpIndex = Index;
|
|
}
|
|
|
|
return TRUE;
|
|
}
|
|
}
|
|
|
|
return FALSE;
|
|
}
|
|
|
|
/**
|
|
Creating event object for PCI Hot Plug controller.
|
|
|
|
@param HpIndex Index of hot plug device in global array.
|
|
@param Event The returned event that invoke this function.
|
|
|
|
@return Status of create event.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
CreateEventForHpc (
|
|
IN UINTN HpIndex,
|
|
OUT EFI_EVENT *Event
|
|
)
|
|
{
|
|
EFI_STATUS Status;
|
|
|
|
Status = gBS->CreateEvent (
|
|
EVT_NOTIFY_SIGNAL,
|
|
TPL_CALLBACK,
|
|
PciHPCInitialized,
|
|
gPciRootHpcData + HpIndex,
|
|
&((gPciRootHpcData + HpIndex)->Event)
|
|
);
|
|
|
|
if (!EFI_ERROR (Status)) {
|
|
*Event = (gPciRootHpcData + HpIndex)->Event;
|
|
}
|
|
|
|
return Status;
|
|
}
|
|
|
|
/**
|
|
Wait for all root PCI Hot Plug controller finished initializing.
|
|
|
|
@param TimeoutInMicroSeconds Microseconds to wait for all root HPCs' initialization.
|
|
|
|
@retval EFI_SUCCESS All HPCs initialization finished.
|
|
@retval EFI_TIMEOUT Not ALL HPCs initialization finished in Microseconds.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
AllRootHPCInitialized (
|
|
IN UINTN TimeoutInMicroSeconds
|
|
)
|
|
{
|
|
UINT32 Delay;
|
|
UINTN Index;
|
|
|
|
Delay = (UINT32) ((TimeoutInMicroSeconds / 30) + 1);
|
|
|
|
do {
|
|
for (Index = 0; Index < gPciRootHpcCount; Index++) {
|
|
|
|
if (gPciRootHpcData[Index].Found && !gPciRootHpcData[Index].Initialized) {
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (Index == gPciRootHpcCount) {
|
|
return EFI_SUCCESS;
|
|
}
|
|
|
|
//
|
|
// Stall for 30 microseconds..
|
|
//
|
|
gBS->Stall (30);
|
|
|
|
Delay--;
|
|
|
|
} while (Delay > 0);
|
|
|
|
return EFI_TIMEOUT;
|
|
}
|
|
|
|
/**
|
|
Check whether PCI-PCI bridge has PCI Hot Plug capability register block.
|
|
|
|
@param PciIoDevice A Pointer to the PCI-PCI bridge.
|
|
|
|
@retval TRUE PCI device is HPC.
|
|
@retval FALSE PCI device is not HPC.
|
|
|
|
**/
|
|
BOOLEAN
|
|
IsSHPC (
|
|
IN PCI_IO_DEVICE *PciIoDevice
|
|
)
|
|
{
|
|
|
|
EFI_STATUS Status;
|
|
UINT8 Offset;
|
|
|
|
if (PciIoDevice == NULL) {
|
|
return FALSE;
|
|
}
|
|
|
|
Offset = 0;
|
|
Status = LocateCapabilityRegBlock (
|
|
PciIoDevice,
|
|
EFI_PCI_CAPABILITY_ID_SHPC,
|
|
&Offset,
|
|
NULL
|
|
);
|
|
|
|
//
|
|
// If the PCI-PCI bridge has the hot plug controller build-in,
|
|
// then return TRUE;
|
|
//
|
|
if (!EFI_ERROR (Status)) {
|
|
return TRUE;
|
|
}
|
|
|
|
return FALSE;
|
|
}
|
|
|
|
/**
|
|
Check whether PciIoDevice supports PCIe hotplug.
|
|
|
|
This is equivalent to the following condition:
|
|
- the device is either a PCIe switch downstream port or a root port,
|
|
- and the device has the SlotImplemented bit set in its PCIe capability
|
|
register,
|
|
- and the device has the HotPlugCapable bit set in its slot capabilities
|
|
register.
|
|
|
|
@param[in] PciIoDevice The device being checked.
|
|
|
|
@retval TRUE PciIoDevice is a PCIe port that accepts a hot-plugged device.
|
|
@retval FALSE Otherwise.
|
|
|
|
**/
|
|
BOOLEAN
|
|
SupportsPcieHotplug (
|
|
IN PCI_IO_DEVICE *PciIoDevice
|
|
)
|
|
{
|
|
UINT32 Offset;
|
|
EFI_STATUS Status;
|
|
PCI_REG_PCIE_CAPABILITY Capability;
|
|
PCI_REG_PCIE_SLOT_CAPABILITY SlotCapability;
|
|
|
|
if (PciIoDevice == NULL) {
|
|
return FALSE;
|
|
}
|
|
|
|
//
|
|
// Read the PCI Express Capabilities Register
|
|
//
|
|
if (!PciIoDevice->IsPciExp) {
|
|
return FALSE;
|
|
}
|
|
Offset = PciIoDevice->PciExpressCapabilityOffset +
|
|
OFFSET_OF (PCI_CAPABILITY_PCIEXP, Capability);
|
|
Status = PciIoDevice->PciIo.Pci.Read (
|
|
&PciIoDevice->PciIo,
|
|
EfiPciIoWidthUint16,
|
|
Offset,
|
|
1,
|
|
&Capability
|
|
);
|
|
if (EFI_ERROR (Status)) {
|
|
return FALSE;
|
|
}
|
|
|
|
//
|
|
// Check the contents of the register
|
|
//
|
|
switch (Capability.Bits.DevicePortType) {
|
|
case PCIE_DEVICE_PORT_TYPE_ROOT_PORT:
|
|
case PCIE_DEVICE_PORT_TYPE_DOWNSTREAM_PORT:
|
|
break;
|
|
default:
|
|
return FALSE;
|
|
}
|
|
if (!Capability.Bits.SlotImplemented) {
|
|
return FALSE;
|
|
}
|
|
|
|
//
|
|
// Read the Slot Capabilities Register
|
|
//
|
|
Offset = PciIoDevice->PciExpressCapabilityOffset +
|
|
OFFSET_OF (PCI_CAPABILITY_PCIEXP, SlotCapability);
|
|
Status = PciIoDevice->PciIo.Pci.Read (
|
|
&PciIoDevice->PciIo,
|
|
EfiPciIoWidthUint32,
|
|
Offset,
|
|
1,
|
|
&SlotCapability
|
|
);
|
|
if (EFI_ERROR (Status)) {
|
|
return FALSE;
|
|
}
|
|
|
|
//
|
|
// Check the contents of the register
|
|
//
|
|
if (SlotCapability.Bits.HotPlugCapable) {
|
|
return TRUE;
|
|
}
|
|
return FALSE;
|
|
}
|
|
|
|
/**
|
|
Get resource padding if the specified PCI bridge is a hot plug bus.
|
|
|
|
@param PciIoDevice PCI bridge instance.
|
|
|
|
**/
|
|
VOID
|
|
GetResourcePaddingForHpb (
|
|
IN PCI_IO_DEVICE *PciIoDevice
|
|
)
|
|
{
|
|
EFI_STATUS Status;
|
|
EFI_HPC_STATE State;
|
|
UINT64 PciAddress;
|
|
EFI_HPC_PADDING_ATTRIBUTES Attributes;
|
|
EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *Descriptors;
|
|
|
|
if (IsPciHotPlugBus (PciIoDevice)) {
|
|
//
|
|
// If PCI-PCI bridge device is PCI Hot Plug bus.
|
|
//
|
|
PciAddress = EFI_PCI_ADDRESS (PciIoDevice->BusNumber, PciIoDevice->DeviceNumber, PciIoDevice->FunctionNumber, 0);
|
|
Status = gPciHotPlugInit->GetResourcePadding (
|
|
gPciHotPlugInit,
|
|
PciIoDevice->DevicePath,
|
|
PciAddress,
|
|
&State,
|
|
(VOID **) &Descriptors,
|
|
&Attributes
|
|
);
|
|
|
|
if (EFI_ERROR (Status)) {
|
|
return;
|
|
}
|
|
|
|
if ((State & EFI_HPC_STATE_ENABLED) != 0 && (State & EFI_HPC_STATE_INITIALIZED) != 0) {
|
|
PciIoDevice->ResourcePaddingDescriptors = Descriptors;
|
|
PciIoDevice->PaddingAttributes = Attributes;
|
|
}
|
|
|
|
return;
|
|
}
|
|
}
|
|
|
|
/**
|
|
Test whether PCI device is hot plug bus.
|
|
|
|
@param PciIoDevice PCI device instance.
|
|
|
|
@retval TRUE PCI device is a hot plug bus.
|
|
@retval FALSE PCI device is not a hot plug bus.
|
|
|
|
**/
|
|
BOOLEAN
|
|
IsPciHotPlugBus (
|
|
PCI_IO_DEVICE *PciIoDevice
|
|
)
|
|
{
|
|
if (IsSHPC (PciIoDevice)) {
|
|
//
|
|
// If the PPB has the hot plug controller build-in,
|
|
// then return TRUE;
|
|
//
|
|
return TRUE;
|
|
}
|
|
|
|
if (SupportsPcieHotplug (PciIoDevice)) {
|
|
//
|
|
// If the PPB is a PCIe root complex port or a switch downstream port, and
|
|
// implements a hot-plug capable slot, then also return TRUE.
|
|
//
|
|
return TRUE;
|
|
}
|
|
|
|
//
|
|
// Otherwise, see if it is a Root HPC
|
|
//
|
|
if(IsRootPciHotPlugBus (PciIoDevice->DevicePath, NULL)) {
|
|
return TRUE;
|
|
}
|
|
|
|
return FALSE;
|
|
}
|
|
|