#include "PciBus.h"

Macros
#define	OLD_ALIGN 0xFFFFFFFFFFFFFFFFULL

#define	EVEN_ALIGN 0xFFFFFFFFFFFFFFFEULL

#define	SQUAD_ALIGN 0xFFFFFFFFFFFFFFFDULL

#define	DQUAD_ALIGN 0xFFFFFFFFFFFFFFFCULL

Functions
EFI_STATUS	PciDevicePresent (IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL PciRootBridgeIo, OUT PCI_TYPE00 Pci, IN UINT8 Bus, IN UINT8 Device, IN UINT8 Func)

EFI_STATUS	PciPciDeviceInfoCollector (IN PCI_IO_DEVICE *Bridge, IN UINT8 StartBusNumber)

EFI_STATUS	PciSearchDevice (IN PCI_IO_DEVICE Bridge, IN PCI_TYPE00 Pci, IN UINT8 Bus, IN UINT8 Device, IN UINT8 Func, OUT PCI_IO_DEVICE **PciDevice)

VOID	DumpPpbPaddingResource (IN PCI_IO_DEVICE *PciIoDevice, IN PCI_BAR_TYPE ResourceType)

VOID	DumpPciBars (IN PCI_IO_DEVICE *PciIoDevice)

PCI_IO_DEVICE *	GatherDeviceInfo (IN PCI_IO_DEVICE Bridge, IN PCI_TYPE00 Pci, IN UINT8 Bus, IN UINT8 Device, IN UINT8 Func)

PCI_IO_DEVICE *	GatherPpbInfo (IN PCI_IO_DEVICE Bridge, IN PCI_TYPE00 Pci, IN UINT8 Bus, IN UINT8 Device, IN UINT8 Func)

PCI_IO_DEVICE *	GatherP2CInfo (IN PCI_IO_DEVICE Bridge, IN PCI_TYPE00 Pci, IN UINT8 Bus, IN UINT8 Device, IN UINT8 Func)

EFI_DEVICE_PATH_PROTOCOL *	CreatePciDevicePath (IN EFI_DEVICE_PATH_PROTOCOL ParentDevicePath, IN PCI_IO_DEVICE PciIoDevice)

EFI_STATUS	VfBarExisted (IN PCI_IO_DEVICE PciIoDevice, IN UINTN Offset, OUT UINT32 BarLengthValue, OUT UINT32 *OriginalBarValue)

EFI_STATUS	BarExisted (IN PCI_IO_DEVICE PciIoDevice, IN UINTN Offset, OUT UINT32 BarLengthValue, OUT UINT32 *OriginalBarValue)

VOID	PciTestSupportedAttribute (IN PCI_IO_DEVICE PciIoDevice, IN OUT UINT16 Command, IN OUT UINT16 BridgeControl, OUT UINT16 OldCommand, OUT UINT16 *OldBridgeControl)

VOID	PciSetDeviceAttribute (IN PCI_IO_DEVICE *PciIoDevice, IN UINT16 Command, IN UINT16 BridgeControl, IN UINTN Option)

EFI_STATUS	GetFastBackToBackSupport (IN PCI_IO_DEVICE *PciIoDevice, IN UINT8 StatusIndex)

VOID	ProcessOptionRomLight (IN PCI_IO_DEVICE *PciIoDevice)

EFI_STATUS	DetermineDeviceAttribute (IN PCI_IO_DEVICE *PciIoDevice)

EFI_STATUS	UpdatePciInfo (IN OUT PCI_IO_DEVICE PciIoDevice, OUT BOOLEAN IgnoreOptionRom)

VOID	SetNewAlign (IN OUT UINT64 *Alignment, IN UINT64 NewAlignment)

UINTN	PciIovParseVfBar (IN PCI_IO_DEVICE *PciIoDevice, IN UINTN Offset, IN UINTN BarIndex)

UINTN	PciParseBar (IN PCI_IO_DEVICE *PciIoDevice, IN UINTN Offset, IN UINTN BarIndex)

VOID	InitializePciDevice (IN PCI_IO_DEVICE *PciIoDevice)

VOID	InitializePpb (IN PCI_IO_DEVICE *PciIoDevice)

VOID	InitializeP2C (IN PCI_IO_DEVICE *PciIoDevice)

EFI_STATUS	AuthenticatePciDevice (IN PCI_IO_DEVICE *PciIoDevice)

BOOLEAN	IsRootBridge (IN PCI_IO_DEVICE *PciIoDevice)

PCI_IO_DEVICE *	CreatePciIoDevice (IN PCI_IO_DEVICE Bridge, IN PCI_TYPE00 Pci, IN UINT8 Bus, IN UINT8 Device, IN UINT8 Func)

EFI_STATUS	PciEnumeratorLight (IN EFI_HANDLE Controller)

EFI_STATUS	PciGetBusRange (IN EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *Descriptors, OUT UINT16 MinBus, OUT UINT16 MaxBus, OUT UINT16 BusRange)

EFI_STATUS	StartManagingRootBridge (IN PCI_IO_DEVICE *RootBridgeDev)

BOOLEAN	IsPciDeviceRejected (IN PCI_IO_DEVICE *PciIoDevice)

VOID	ResetAllPpbBusNumber (IN PCI_IO_DEVICE *Bridge, IN UINT8 StartBusNumber)

Variables
CHAR16 *	mBarTypeStr []

EDKII_DEVICE_SECURITY_PROTOCOL *	mDeviceSecurityProtocol

Detailed Description

PCI emumeration support functions implementation for PCI Bus module.

Copyright (c) 2006 - 2021, Intel Corporation. All rights reserved.
(C) Copyright 2015 Hewlett Packard Enterprise Development LP
Copyright (C) 2023 Advanced Micro Devices, Inc. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file PciEnumeratorSupport.c.

Macro Definition Documentation

◆ DQUAD_ALIGN

#define DQUAD_ALIGN 0xFFFFFFFFFFFFFFFCULL

Definition at line 19 of file PciEnumeratorSupport.c.

◆ EVEN_ALIGN

#define EVEN_ALIGN 0xFFFFFFFFFFFFFFFEULL

Definition at line 17 of file PciEnumeratorSupport.c.

◆ OLD_ALIGN

#define OLD_ALIGN 0xFFFFFFFFFFFFFFFFULL

Definition at line 16 of file PciEnumeratorSupport.c.

◆ SQUAD_ALIGN

#define SQUAD_ALIGN 0xFFFFFFFFFFFFFFFDULL

Definition at line 18 of file PciEnumeratorSupport.c.

Function Documentation

◆ AuthenticatePciDevice()

EFI_STATUS AuthenticatePciDevice ( IN PCI_IO_DEVICE * PciIoDevice )

Authenticate the PCI device by using DeviceSecurityProtocol.

Parameters

PciIoDevice PCI device.

Return values

EFI_SUCCESS The device passes the authentication.

Returns: not EFI_SUCCESS The device failes the authentication or unexpected error happen during authentication.

Definition at line 2085 of file PciEnumeratorSupport.c.

◆ BarExisted()

EFI_STATUS BarExisted	(	IN PCI_IO_DEVICE *	PciIoDevice,
		IN UINTN	Offset,
		OUT UINT32 *	BarLengthValue,
		OUT UINT32 *	OriginalBarValue
	)

Check whether the bar is existed or not.

Parameters

PciIoDevice	A pointer to the PCI_IO_DEVICE.
Offset	The offset.
BarLengthValue	The bar length value returned.
OriginalBarValue	The original bar value returned.

Return values

EFI_NOT_FOUND	The bar doesn't exist.
EFI_SUCCESS	The bar exist.

Definition at line 859 of file PciEnumeratorSupport.c.

◆ CreatePciDevicePath()

EFI_DEVICE_PATH_PROTOCOL * CreatePciDevicePath	(	IN EFI_DEVICE_PATH_PROTOCOL *	ParentDevicePath,
		IN PCI_IO_DEVICE *	PciIoDevice
	)

Create device path for pci device.

Parameters

ParentDevicePath	Parent bridge's path.
PciIoDevice	Pci device instance.

Returns: Device path protocol instance for specific pci device.

Definition at line 751 of file PciEnumeratorSupport.c.

◆ CreatePciIoDevice()

PCI_IO_DEVICE * CreatePciIoDevice	(	IN PCI_IO_DEVICE *	Bridge,
		IN PCI_TYPE00 *	Pci,
		IN UINT8	Bus,
		IN UINT8	Device,
		IN UINT8	Func
	)

Create and initialize general PCI I/O device instance for PCI device/bridge device/hotplug bridge device.

Parameters

Bridge	Parent bridge instance.
Pci	Input Pci information block.
Bus	Device Bus NO.
Device	Device device NO.
Func	Device func NO.

Returns: Instance of PCI device. NULL means no instance created.

Definition at line 2171 of file PciEnumeratorSupport.c.

◆ DetermineDeviceAttribute()

EFI_STATUS DetermineDeviceAttribute ( IN PCI_IO_DEVICE * PciIoDevice )

Determine the related attributes of all devices under a Root Bridge.

Parameters

PciIoDevice PCI device instance.

Definition at line 1179 of file PciEnumeratorSupport.c.

◆ DumpPciBars()

VOID DumpPciBars ( IN PCI_IO_DEVICE * PciIoDevice )

Dump the PCI BAR information.

Parameters

PciIoDevice PCI IO instance.

Definition at line 406 of file PciEnumeratorSupport.c.

◆ DumpPpbPaddingResource()

VOID DumpPpbPaddingResource	(	IN PCI_IO_DEVICE *	PciIoDevice,
		IN PCI_BAR_TYPE	ResourceType
	)

Dump the PPB padding resource information.

Parameters

PciIoDevice	PCI IO instance.
ResourceType	The desired resource type to dump. PciBarTypeUnknown means to dump all types of resources.

Definition at line 334 of file PciEnumeratorSupport.c.

◆ GatherDeviceInfo()

PCI_IO_DEVICE * GatherDeviceInfo	(	IN PCI_IO_DEVICE *	Bridge,
		IN PCI_TYPE00 *	Pci,
		IN UINT8	Bus,
		IN UINT8	Device,
		IN UINT8	Func
	)

Create PCI device instance for PCI device.

Parameters

Bridge	Parent bridge instance.
Pci	Input PCI device information block.
Bus	PCI device Bus NO.
Device	PCI device Device NO.
Func	PCI device's func NO.

Returns: Created PCI device instance.

Definition at line 460 of file PciEnumeratorSupport.c.

◆ GatherP2CInfo()

PCI_IO_DEVICE * GatherP2CInfo	(	IN PCI_IO_DEVICE *	Bridge,
		IN PCI_TYPE00 *	Pci,
		IN UINT8	Bus,
		IN UINT8	Device,
		IN UINT8	Func
	)

Create PCI device instance for PCI Card bridge device.

Parameters

Bridge	Parent bridge instance.
Pci	Input PCI device information block.
Bus	PCI device Bus NO.
Device	PCI device Device NO.
Func	PCI device's func NO.

Returns: Created PCI device instance.

Definition at line 690 of file PciEnumeratorSupport.c.

◆ GatherPpbInfo()

PCI_IO_DEVICE * GatherPpbInfo	(	IN PCI_IO_DEVICE *	Bridge,
		IN PCI_TYPE00 *	Pci,
		IN UINT8	Bus,
		IN UINT8	Device,
		IN UINT8	Func
	)

Create PCI device instance for PCI-PCI bridge.

Parameters

Bridge	Parent bridge instance.
Pci	Input PCI device information block.
Bus	PCI device Bus NO.
Device	PCI device Device NO.
Func	PCI device's func NO.

Returns: Created PCI device instance.

Definition at line 530 of file PciEnumeratorSupport.c.

◆ GetFastBackToBackSupport()

EFI_STATUS GetFastBackToBackSupport	(	IN PCI_IO_DEVICE *	PciIoDevice,
		IN UINT8	StatusIndex
	)

Determine if the device can support Fast Back to Back attribute.

Parameters

PciIoDevice	Pci device instance.
StatusIndex	Status register value.

Return values

EFI_SUCCESS	This device support Fast Back to Back attribute.
EFI_UNSUPPORTED	This device doesn't support Fast Back to Back attribute.

Definition at line 1112 of file PciEnumeratorSupport.c.

◆ InitializeP2C()

VOID InitializeP2C ( IN PCI_IO_DEVICE * PciIoDevice )

This routine is used to initialize the bar of a PCI Card Bridge device.

Parameters

PciIoDevice PCI Card bridge device.

Definition at line 2044 of file PciEnumeratorSupport.c.

◆ InitializePciDevice()

VOID InitializePciDevice ( IN PCI_IO_DEVICE * PciIoDevice )

This routine is used to initialize the bar of a PCI device.

Parameters

PciIoDevice Pci device instance.

Note: It can be called typically when a device is going to be rejected.

Definition at line 1974 of file PciEnumeratorSupport.c.

◆ InitializePpb()

VOID InitializePpb ( IN PCI_IO_DEVICE * PciIoDevice )

This routine is used to initialize the bar of a PCI-PCI Bridge device.

Parameters

PciIoDevice PCI-PCI bridge device instance.

Definition at line 2000 of file PciEnumeratorSupport.c.

◆ IsPciDeviceRejected()

BOOLEAN IsPciDeviceRejected ( IN PCI_IO_DEVICE * PciIoDevice )

This routine can be used to check whether a PCI device should be rejected when light enumeration.

Parameters

PciIoDevice Pci device instance.

Return values

TRUE	This device should be rejected.
FALSE	This device shouldn't be rejected.

Definition at line 2718 of file PciEnumeratorSupport.c.

◆ IsRootBridge()

BOOLEAN IsRootBridge ( IN PCI_IO_DEVICE * PciIoDevice )

Checks if PCI device is Root Bridge.

Parameters

PciIoDevice Instance of PCI device

Return values

TRUE	Device is Root Bridge
FALSE	Device is not Root Bridge

Definition at line 2146 of file PciEnumeratorSupport.c.

◆ PciDevicePresent()

EFI_STATUS PciDevicePresent	(	IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *	PciRootBridgeIo,
		OUT PCI_TYPE00 *	Pci,
		IN UINT8	Bus,
		IN UINT8	Device,
		IN UINT8	Func
	)

This routine is used to check whether the pci device is present.

Parameters

PciRootBridgeIo	Pointer to instance of EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
Pci	Output buffer for PCI device configuration space.
Bus	PCI bus NO.
Device	PCI device NO.
Func	PCI Func NO.

Return values

EFI_NOT_FOUND	PCI device not present.
EFI_SUCCESS	PCI device is found.

Definition at line 35 of file PciEnumeratorSupport.c.

◆ PciEnumeratorLight()

EFI_STATUS PciEnumeratorLight ( IN EFI_HANDLE Controller )

This routine is used to enumerate entire pci bus system in a given platform.

It is only called on the second start on the same Root Bridge.

Parameters

Controller Parent bridge handler.

Return values

EFI_SUCCESS	PCI enumeration finished successfully.
other	Some error occurred when enumerating the pci bus system.

Definition at line 2520 of file PciEnumeratorSupport.c.

◆ PciGetBusRange()

EFI_STATUS PciGetBusRange	(	IN EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR **	Descriptors,
		OUT UINT16 *	MinBus,
		OUT UINT16 *	MaxBus,
		OUT UINT16 *	BusRange
	)

Get bus range from PCI resource descriptor list.

Parameters

Descriptors	A pointer to the address space descriptor.
MinBus	The min bus returned.
MaxBus	The max bus returned.
BusRange	The bus range returned.

Return values

EFI_SUCCESS	Successfully got bus range.
EFI_NOT_FOUND	Can not find the specific bus.

Definition at line 2630 of file PciEnumeratorSupport.c.

◆ PciIovParseVfBar()

UINTN PciIovParseVfBar	(	IN PCI_IO_DEVICE *	PciIoDevice,
		IN UINTN	Offset,
		IN UINTN	BarIndex
	)

Parse PCI IOV VF bar information and fill them into PCI device instance.

Parameters

PciIoDevice	Pci device instance.
Offset	Bar offset.
BarIndex	Bar index.

Returns: Next bar offset.

Definition at line 1574 of file PciEnumeratorSupport.c.

◆ PciParseBar()

UINTN PciParseBar	(	IN PCI_IO_DEVICE *	PciIoDevice,
		IN UINTN	Offset,
		IN UINTN	BarIndex
	)

Parse PCI bar information and fill them into PCI device instance.

Parameters

PciIoDevice	Pci device instance.
Offset	Bar offset.
BarIndex	Bar index.

Returns: Next bar offset.

Definition at line 1764 of file PciEnumeratorSupport.c.

◆ PciPciDeviceInfoCollector()

EFI_STATUS PciPciDeviceInfoCollector	(	IN PCI_IO_DEVICE *	Bridge,
		IN UINT8	StartBusNumber
	)

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.

Parameters

Bridge	Parent bridge instance.
StartBusNumber	Bus number of beginning.

Return values

EFI_SUCCESS	PCI device is found.
other	Some error occurred when reading PCI bridge information.

Definition at line 94 of file PciEnumeratorSupport.c.

◆ PciSearchDevice()

EFI_STATUS PciSearchDevice	(	IN PCI_IO_DEVICE *	Bridge,
		IN PCI_TYPE00 *	Pci,
		IN UINT8	Bus,
		IN UINT8	Device,
		IN UINT8	Func,
		OUT PCI_IO_DEVICE **	PciDevice
	)

Search required device and create PCI device instance.

Parameters

Bridge	Parent bridge instance.
Pci	Input PCI device information block.
Bus	PCI bus NO.
Device	PCI device NO.
Func	PCI func NO.
PciDevice	Output of searched PCI device instance.

Return values

EFI_SUCCESS	Successfully created PCI device instance.
EFI_OUT_OF_RESOURCES	Cannot get PCI device information.

Definition at line 214 of file PciEnumeratorSupport.c.

◆ PciSetDeviceAttribute()

VOID PciSetDeviceAttribute	(	IN PCI_IO_DEVICE *	PciIoDevice,
		IN UINT16	Command,
		IN UINT16	BridgeControl,
		IN UINTN	Option
	)

Set the supported or current attributes of a PCI device.

Parameters

PciIoDevice	Structure pointer for PCI device.
Command	Command register value.
BridgeControl	Bridge control value for PPB or P2C.
Option	Make a choice of EFI_SET_SUPPORTS or EFI_SET_ATTRIBUTES.

Definition at line 999 of file PciEnumeratorSupport.c.

◆ PciTestSupportedAttribute()

VOID PciTestSupportedAttribute	(	IN PCI_IO_DEVICE *	PciIoDevice,
		IN OUT UINT16 *	Command,
		IN OUT UINT16 *	BridgeControl,
		OUT UINT16 *	OldCommand,
		OUT UINT16 *	OldBridgeControl
	)

Test whether the device can support given attributes.

Parameters

PciIoDevice	Pci device instance.
Command	Input command register value, and returned supported register value.
BridgeControl	Input bridge control value for PPB or P2C, and returned supported bridge control value.
OldCommand	Returned and stored old command register offset.
OldBridgeControl	Returned and stored old Bridge control value for PPB or P2C.

Definition at line 924 of file PciEnumeratorSupport.c.

◆ ProcessOptionRomLight()

VOID ProcessOptionRomLight ( IN PCI_IO_DEVICE * PciIoDevice )

Process the option ROM for all the children of the specified parent PCI device. It can only be used after the first full Option ROM process.

Parameters

PciIoDevice Pci device instance.

Definition at line 1148 of file PciEnumeratorSupport.c.

◆ ResetAllPpbBusNumber()

VOID ResetAllPpbBusNumber	(	IN PCI_IO_DEVICE *	Bridge,
		IN UINT8	StartBusNumber
	)

Reset all bus number from specific bridge.

Parameters

Bridge	Parent specific bridge.
StartBusNumber	Start bus number.

Definition at line 2819 of file PciEnumeratorSupport.c.

◆ SetNewAlign()

VOID SetNewAlign	(	IN OUT UINT64 *	Alignment,
		IN UINT64	NewAlignment
	)

This routine will update the alignment with the new alignment. Compare with OLD_ALIGN/EVEN_ALIGN/SQUAD_ALIGN/DQUAD_ALIGN is to keep backward compatibility.

Parameters

Alignment	Input Old alignment. Output updated alignment.
NewAlignment	New alignment.

Definition at line 1499 of file PciEnumeratorSupport.c.

◆ StartManagingRootBridge()

EFI_STATUS StartManagingRootBridge ( IN PCI_IO_DEVICE * RootBridgeDev )

This routine can be used to start the root bridge.

Parameters

RootBridgeDev Pci device instance.

Return values

EFI_SUCCESS	This device started.
other	Failed to get PCI Root Bridge I/O protocol.

Definition at line 2670 of file PciEnumeratorSupport.c.

◆ UpdatePciInfo()

EFI_STATUS UpdatePciInfo	(	IN OUT PCI_IO_DEVICE *	PciIoDevice,
		OUT BOOLEAN *	IgnoreOptionRom
	)

This routine is used to update the bar information for those incompatible PCI device.

Parameters

PciIoDevice	Input Pci device instance. Output Pci device instance with updated Bar information.
IgnoreOptionRom	Output If the option rom of incompatible device need to be ignored.

Return values

EFI_SUCCESS	Successfully updated bar information.
EFI_UNSUPPORTED	Given PCI device doesn't belong to incompatible PCI device list.

Definition at line 1325 of file PciEnumeratorSupport.c.

◆ VfBarExisted()

EFI_STATUS VfBarExisted	(	IN PCI_IO_DEVICE *	PciIoDevice,
		IN UINTN	Offset,
		OUT UINT32 *	BarLengthValue,
		OUT UINT32 *	OriginalBarValue
	)

Check whether the PCI IOV VF bar is existed or not.

Parameters

PciIoDevice	A pointer to the PCI_IO_DEVICE.
Offset	The offset.
BarLengthValue	The bar length value returned.
OriginalBarValue	The original bar value returned.

Return values

EFI_NOT_FOUND	The bar doesn't exist.
EFI_SUCCESS	The bar exist.

Definition at line 785 of file PciEnumeratorSupport.c.

Variable Documentation

◆ mBarTypeStr

CHAR16* mBarTypeStr[]

extern

Definition at line 13 of file PciLib.c.

◆ mDeviceSecurityProtocol

EDKII_DEVICE_SECURITY_PROTOCOL* mDeviceSecurityProtocol

extern

Definition at line 40 of file PciBus.c.

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ DQUAD_ALIGN

◆ EVEN_ALIGN

◆ OLD_ALIGN

◆ SQUAD_ALIGN

Function Documentation

◆ AuthenticatePciDevice()

◆ BarExisted()

◆ CreatePciDevicePath()

◆ CreatePciIoDevice()

◆ DetermineDeviceAttribute()

◆ DumpPciBars()

◆ DumpPpbPaddingResource()

◆ GatherDeviceInfo()

◆ GatherP2CInfo()

◆ GatherPpbInfo()

◆ GetFastBackToBackSupport()

◆ InitializeP2C()

◆ InitializePciDevice()

◆ InitializePpb()

◆ IsPciDeviceRejected()

◆ IsRootBridge()

◆ PciDevicePresent()

◆ PciEnumeratorLight()

◆ PciGetBusRange()

◆ PciIovParseVfBar()

◆ PciParseBar()

◆ PciPciDeviceInfoCollector()

◆ PciSearchDevice()

◆ PciSetDeviceAttribute()

◆ PciTestSupportedAttribute()

◆ ProcessOptionRomLight()

◆ ResetAllPpbBusNumber()

◆ SetNewAlign()

◆ StartManagingRootBridge()

◆ UpdatePciInfo()

◆ VfBarExisted()

Variable Documentation

◆ mBarTypeStr

◆ mDeviceSecurityProtocol