Data Structures
struct	PCI_RESOURCE_NODE

Macros
#define	PCI_RESOURCE_SIGNATURE SIGNATURE_32 ('p', 'c', 'r', 'c')

#define	RESOURCE_NODE_FROM_LINK(a) CR (a, PCI_RESOURCE_NODE, Link, PCI_RESOURCE_SIGNATURE)

Enumerations
enum	PCI_RESOURCE_USAGE { PciResUsageTypical , PciResUsagePadding }

Functions
VOID	SkipVGAAperture (OUT UINT64 *Start, IN UINT64 Length)

VOID	SkipIsaAliasAperture (OUT UINT64 *Start, IN UINT64 Length)

VOID	InsertResourceNode (IN OUT PCI_RESOURCE_NODE Bridge, IN PCI_RESOURCE_NODE ResNode)

VOID	MergeResourceTree (IN PCI_RESOURCE_NODE Dst, IN PCI_RESOURCE_NODE Res, IN BOOLEAN TypeMerge)

VOID	CalculateApertureIo16 (IN PCI_RESOURCE_NODE *Bridge)

VOID	CalculateResourceAperture (IN PCI_RESOURCE_NODE *Bridge)

VOID	GetResourceFromDevice (IN PCI_IO_DEVICE PciDev, IN OUT PCI_RESOURCE_NODE IoNode, IN OUT PCI_RESOURCE_NODE Mem32Node, IN OUT PCI_RESOURCE_NODE PMem32Node, IN OUT PCI_RESOURCE_NODE Mem64Node, IN OUT PCI_RESOURCE_NODE PMem64Node)

PCI_RESOURCE_NODE *	CreateResourceNode (IN PCI_IO_DEVICE *PciDev, IN UINT64 Length, IN UINT64 Alignment, IN UINT8 Bar, IN PCI_BAR_TYPE ResType, IN PCI_RESOURCE_USAGE ResUsage)

PCI_RESOURCE_NODE *	CreateVfResourceNode (IN PCI_IO_DEVICE *PciDev, IN UINT64 Length, IN UINT64 Alignment, IN UINT8 Bar, IN PCI_BAR_TYPE ResType, IN PCI_RESOURCE_USAGE ResUsage)

VOID	CreateResourceMap (IN PCI_IO_DEVICE Bridge, IN OUT PCI_RESOURCE_NODE IoNode, IN OUT PCI_RESOURCE_NODE Mem32Node, IN OUT PCI_RESOURCE_NODE PMem32Node, IN OUT PCI_RESOURCE_NODE Mem64Node, IN OUT PCI_RESOURCE_NODE PMem64Node)

VOID	ResourcePaddingPolicy (IN PCI_IO_DEVICE PciDev, IN PCI_RESOURCE_NODE IoNode, IN PCI_RESOURCE_NODE Mem32Node, IN PCI_RESOURCE_NODE PMem32Node, IN PCI_RESOURCE_NODE Mem64Node, IN PCI_RESOURCE_NODE PMem64Node)

VOID	DegradeResource (IN PCI_IO_DEVICE Bridge, IN PCI_RESOURCE_NODE Mem32Node, IN PCI_RESOURCE_NODE PMem32Node, IN PCI_RESOURCE_NODE Mem64Node, IN PCI_RESOURCE_NODE *PMem64Node)

BOOLEAN	BridgeSupportResourceDecode (IN PCI_IO_DEVICE *Bridge, IN UINT32 Decode)

EFI_STATUS	ProgramResource (IN UINT64 Base, IN PCI_RESOURCE_NODE *Bridge)

VOID	ProgramBar (IN UINT64 Base, IN PCI_RESOURCE_NODE *Node)

EFI_STATUS	ProgramVfBar (IN UINT64 Base, IN PCI_RESOURCE_NODE *Node)

VOID	ProgramPpbApperture (IN UINT64 Base, IN PCI_RESOURCE_NODE *Node)

VOID	ProgramUpstreamBridgeForRom (IN PCI_IO_DEVICE *PciDevice, IN UINT32 OptionRomBase, IN BOOLEAN Enable)

BOOLEAN	ResourceRequestExisted (IN PCI_RESOURCE_NODE *Bridge)

VOID	InitializeResourcePool (IN OUT PCI_RESOURCE_NODE *ResourcePool, IN PCI_BAR_TYPE ResourceType)

VOID	DestroyResourceTree (IN PCI_RESOURCE_NODE *Bridge)

VOID	ResourcePaddingForCardBusBridge (IN PCI_IO_DEVICE PciDev, IN PCI_RESOURCE_NODE IoNode, IN PCI_RESOURCE_NODE Mem32Node, IN PCI_RESOURCE_NODE PMem32Node, IN PCI_RESOURCE_NODE Mem64Node, IN PCI_RESOURCE_NODE PMem64Node)

VOID	ProgramP2C (IN UINT64 Base, IN PCI_RESOURCE_NODE *Node)

VOID	ApplyResourcePadding (IN PCI_IO_DEVICE PciDev, IN PCI_RESOURCE_NODE IoNode, IN PCI_RESOURCE_NODE Mem32Node, IN PCI_RESOURCE_NODE PMem32Node, IN PCI_RESOURCE_NODE Mem64Node, IN PCI_RESOURCE_NODE PMem64Node)

VOID	GetResourcePaddingPpb (IN PCI_IO_DEVICE *PciIoDevice)

Detailed Description

PCI resources support functions declaration for PCI Bus module.

Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file PciResourceSupport.h.

Macro Definition Documentation

◆ PCI_RESOURCE_SIGNATURE

#define PCI_RESOURCE_SIGNATURE SIGNATURE_32 ('p', 'c', 'r', 'c')

Definition at line 17 of file PciResourceSupport.h.

◆ RESOURCE_NODE_FROM_LINK

#define RESOURCE_NODE_FROM_LINK ( a ) CR (a, PCI_RESOURCE_NODE, Link, PCI_RESOURCE_SIGNATURE)

Definition at line 34 of file PciResourceSupport.h.

Enumeration Type Documentation

◆ PCI_RESOURCE_USAGE

enum PCI_RESOURCE_USAGE

Definition at line 12 of file PciResourceSupport.h.

Function Documentation

◆ ApplyResourcePadding()

VOID ApplyResourcePadding	(	IN PCI_IO_DEVICE *	PciDev,
		IN PCI_RESOURCE_NODE *	IoNode,
		IN PCI_RESOURCE_NODE *	Mem32Node,
		IN PCI_RESOURCE_NODE *	PMem32Node,
		IN PCI_RESOURCE_NODE *	Mem64Node,
		IN PCI_RESOURCE_NODE *	PMem64Node
	)

Create padding resource node.

Parameters

PciDev	Pci device instance.
IoNode	Resource info node for IO.
Mem32Node	Resource info node for 32-bit memory.
PMem32Node	Resource info node for 32-bit Prefetchable Memory.
Mem64Node	Resource info node for 64-bit memory.
PMem64Node	Resource info node for 64-bit Prefetchable Memory.

Definition at line 2118 of file PciResourceSupport.c.

◆ BridgeSupportResourceDecode()

BOOLEAN BridgeSupportResourceDecode	(	IN PCI_IO_DEVICE *	Bridge,
		IN UINT32	Decode
	)

Test whether bridge device support decode resource.

Parameters

Bridge	Bridge device instance.
Decode	Decode type according to resource type.

Returns: TRUE The bridge device support decode resource.; FALSE The bridge device don't support decode resource.

Definition at line 1174 of file PciResourceSupport.c.

◆ CalculateApertureIo16()

VOID CalculateApertureIo16 ( IN PCI_RESOURCE_NODE * Bridge )

This function is used to calculate the IO16 aperture for a bridge.

Parameters

Bridge PCI resource node for bridge.

Definition at line 181 of file PciResourceSupport.c.

◆ CalculateResourceAperture()

VOID CalculateResourceAperture ( IN PCI_RESOURCE_NODE * Bridge )

This function is used to calculate the resource aperture for a given bridge device.

Parameters

Bridge PCI resource node for given bridge device.

Definition at line 335 of file PciResourceSupport.c.

◆ CreateResourceMap()

VOID CreateResourceMap	(	IN PCI_IO_DEVICE *	Bridge,
		IN OUT PCI_RESOURCE_NODE *	IoNode,
		IN OUT PCI_RESOURCE_NODE *	Mem32Node,
		IN OUT PCI_RESOURCE_NODE *	PMem32Node,
		IN OUT PCI_RESOURCE_NODE *	Mem64Node,
		IN OUT PCI_RESOURCE_NODE *	PMem64Node
	)

This function is used to extract resource request from device node list.

Parameters

Bridge	Pci device instance.
IoNode	Resource info node for IO.
Mem32Node	Resource info node for 32-bit memory.
PMem32Node	Resource info node for 32-bit Prefetchable Memory.
Mem64Node	Resource info node for 64-bit memory.
PMem64Node	Resource info node for 64-bit Prefetchable Memory.

Definition at line 735 of file PciResourceSupport.c.

◆ CreateResourceNode()

PCI_RESOURCE_NODE * CreateResourceNode	(	IN PCI_IO_DEVICE *	PciDev,
		IN UINT64	Length,
		IN UINT64	Alignment,
		IN UINT8	Bar,
		IN PCI_BAR_TYPE	ResType,
		IN PCI_RESOURCE_USAGE	ResUsage
	)

This function is used to create a resource node.

Parameters

PciDev	Pci device instance.
Length	Length of Io/Memory resource.
Alignment	Alignment of resource.
Bar	Bar index.
ResType	Type of resource: IO/Memory.
ResUsage	Resource usage.

Returns: PCI resource node created for given PCI device. NULL means PCI resource node is not created.

Definition at line 654 of file PciResourceSupport.c.

◆ CreateVfResourceNode()

PCI_RESOURCE_NODE * CreateVfResourceNode	(	IN PCI_IO_DEVICE *	PciDev,
		IN UINT64	Length,
		IN UINT64	Alignment,
		IN UINT8	Bar,
		IN PCI_BAR_TYPE	ResType,
		IN PCI_RESOURCE_USAGE	ResUsage
	)

This function is used to create a IOV VF resource node.

Parameters

PciDev	Pci device instance.
Length	Length of Io/Memory resource.
Alignment	Alignment of resource.
Bar	Bar index.
ResType	Type of resource: IO/Memory.
ResUsage	Resource usage.

Returns: PCI resource node created for given VF PCI device. NULL means PCI resource node is not created.

Definition at line 701 of file PciResourceSupport.c.

◆ DegradeResource()

VOID DegradeResource	(	IN PCI_IO_DEVICE *	Bridge,
		IN PCI_RESOURCE_NODE *	Mem32Node,
		IN PCI_RESOURCE_NODE *	PMem32Node,
		IN PCI_RESOURCE_NODE *	Mem64Node,
		IN PCI_RESOURCE_NODE *	PMem64Node
	)

This function is used to degrade resource if the upstream bridge doesn't support certain resource. Degradation path is PMEM64 -> MEM64 -> MEM32 PMEM64 -> PMEM32 -> MEM32 IO32 -> IO16.

Parameters

Bridge	Pci device instance.
Mem32Node	Resource info node for 32-bit memory.
PMem32Node	Resource info node for 32-bit Prefetchable Memory.
Mem64Node	Resource info node for 64-bit memory.
PMem64Node	Resource info node for 64-bit Prefetchable Memory.

Definition at line 1011 of file PciResourceSupport.c.

◆ DestroyResourceTree()

VOID DestroyResourceTree ( IN PCI_RESOURCE_NODE * Bridge )

Destroy given resource tree.

Parameters

Bridge PCI resource root node of resource tree.

Definition at line 1756 of file PciResourceSupport.c.

◆ GetResourceFromDevice()

VOID GetResourceFromDevice	(	IN PCI_IO_DEVICE *	PciDev,
		IN OUT PCI_RESOURCE_NODE *	IoNode,
		IN OUT PCI_RESOURCE_NODE *	Mem32Node,
		IN OUT PCI_RESOURCE_NODE *	PMem32Node,
		IN OUT PCI_RESOURCE_NODE *	Mem64Node,
		IN OUT PCI_RESOURCE_NODE *	PMem64Node
	)

Get IO/Memory resource info for given PCI device.

Parameters

PciDev	Pci device instance.
IoNode	Resource info node for IO .
Mem32Node	Resource info node for 32-bit memory.
PMem32Node	Resource info node for 32-bit Prefetchable Memory.
Mem64Node	Resource info node for 64-bit memory.
PMem64Node	Resource info node for 64-bit Prefetchable Memory.

Definition at line 422 of file PciResourceSupport.c.

◆ GetResourcePaddingPpb()

VOID GetResourcePaddingPpb ( IN PCI_IO_DEVICE * PciIoDevice )

Get padding resource for PCI-PCI bridge.

Parameters

PciIoDevice PCI-PCI bridge device instance.

Note: Feature flag PcdPciBusHotplugDeviceSupport determines whether need to pad resource for them.

Definition at line 2266 of file PciResourceSupport.c.

◆ InitializeResourcePool()

VOID InitializeResourcePool	(	IN OUT PCI_RESOURCE_NODE *	ResourcePool,
		IN PCI_BAR_TYPE	ResourceType
	)

Initialize resource pool structure.

Parameters

ResourcePool	Point to resource pool structure. This pool is reset to all zero when returned.
ResourceType	Type of resource.

Definition at line 1738 of file PciResourceSupport.c.

◆ InsertResourceNode()

VOID InsertResourceNode	(	IN OUT PCI_RESOURCE_NODE *	Bridge,
		IN PCI_RESOURCE_NODE *	ResNode
	)

This function inserts a resource node into the resource list. The resource list is sorted in descend order.

Parameters

Bridge	PCI resource node for bridge.
ResNode	Resource node want to be inserted.

Definition at line 93 of file PciResourceSupport.c.

◆ MergeResourceTree()

VOID MergeResourceTree	(	IN PCI_RESOURCE_NODE *	Dst,
		IN PCI_RESOURCE_NODE *	Res,
		IN BOOLEAN	TypeMerge
	)

This routine is used to merge two different resource trees in need of resource degradation.

For example, if an upstream PPB doesn't support, prefetchable memory decoding, the PCI bus driver will choose to call this function to merge prefetchable memory resource list into normal memory list.

If the TypeMerge is TRUE, Res resource type is changed to the type of destination resource type. If Dst is NULL or Res is NULL, ASSERT ().

Parameters

Dst	Point to destination resource tree.
Res	Point to source resource tree.
TypeMerge	If the TypeMerge is TRUE, Res resource type is changed to the type of destination resource type.

Definition at line 147 of file PciResourceSupport.c.

◆ ProgramBar()

VOID ProgramBar	(	IN UINT64	Base,
		IN PCI_RESOURCE_NODE *	Node
	)

Program Bar register for PCI device.

Parameters

Base	Base address for PCI device resource to be programmed.
Node	Point to resource node structure.

Definition at line 1255 of file PciResourceSupport.c.

◆ ProgramP2C()

VOID ProgramP2C	(	IN UINT64	Base,
		IN PCI_RESOURCE_NODE *	Node
	)

Program PCI Card device register for given resource node.

Parameters

Base	Base address of PCI Card device to be programmed.
Node	Given resource node.

Definition at line 1885 of file PciResourceSupport.c.

◆ ProgramPpbApperture()

VOID ProgramPpbApperture	(	IN UINT64	Base,
		IN PCI_RESOURCE_NODE *	Node
	)

Program PCI-PCI bridge aperture.

Parameters

Base	Base address for resource.
Node	Point to resource node structure.

Definition at line 1436 of file PciResourceSupport.c.

◆ ProgramResource()

EFI_STATUS ProgramResource	(	IN UINT64	Base,
		IN PCI_RESOURCE_NODE *	Bridge
	)

This function is used to program the resource allocated for each resource node under specified bridge.

Parameters

Base	Base address of resource to be programmed.
Bridge	PCI resource node for the bridge device.

Return values

EFI_SUCCESS	Successfully to program all resources on given PCI bridge device.
EFI_OUT_OF_RESOURCES	Base is all one.

Definition at line 1199 of file PciResourceSupport.c.

◆ ProgramUpstreamBridgeForRom()

VOID ProgramUpstreamBridgeForRom	(	IN PCI_IO_DEVICE *	PciDevice,
		IN UINT32	OptionRomBase,
		IN BOOLEAN	Enable
	)

Program parent bridge for Option Rom.

Parameters

PciDevice	Pci device instance.
OptionRomBase	Base address for Option Rom.
Enable	Enable or disable PCI memory.

Definition at line 1645 of file PciResourceSupport.c.

◆ ProgramVfBar()

EFI_STATUS ProgramVfBar	(	IN UINT64	Base,
		IN PCI_RESOURCE_NODE *	Node
	)

Program IOV VF Bar register for PCI device.

Parameters

Base	Base address for PCI device resource to be programmed.
Node	Point to resource node structure.

Definition at line 1351 of file PciResourceSupport.c.

◆ ResourcePaddingForCardBusBridge()

VOID ResourcePaddingForCardBusBridge	(	IN PCI_IO_DEVICE *	PciDev,
		IN PCI_RESOURCE_NODE *	IoNode,
		IN PCI_RESOURCE_NODE *	Mem32Node,
		IN PCI_RESOURCE_NODE *	PMem32Node,
		IN PCI_RESOURCE_NODE *	Mem64Node,
		IN PCI_RESOURCE_NODE *	PMem64Node
	)

Insert resource padding for P2C.

Parameters

PciDev	Pci device instance.
IoNode	Resource info node for IO.
Mem32Node	Resource info node for 32-bit memory.
PMem32Node	Resource info node for 32-bit Prefetchable Memory.
Mem64Node	Resource info node for 64-bit memory.
PMem64Node	Resource info node for 64-bit Prefetchable Memory.

Definition at line 1791 of file PciResourceSupport.c.

◆ ResourcePaddingPolicy()

VOID ResourcePaddingPolicy	(	IN PCI_IO_DEVICE *	PciDev,
		IN PCI_RESOURCE_NODE *	IoNode,
		IN PCI_RESOURCE_NODE *	Mem32Node,
		IN PCI_RESOURCE_NODE *	PMem32Node,
		IN PCI_RESOURCE_NODE *	Mem64Node,
		IN PCI_RESOURCE_NODE *	PMem64Node
	)

This function is used to do the resource padding for a specific platform.

Parameters

PciDev	Pci device instance.
IoNode	Resource info node for IO.
Mem32Node	Resource info node for 32-bit memory.
PMem32Node	Resource info node for 32-bit Prefetchable Memory.
Mem64Node	Resource info node for 64-bit memory.
PMem64Node	Resource info node for 64-bit Prefetchable Memory.

Definition at line 972 of file PciResourceSupport.c.

◆ ResourceRequestExisted()

BOOLEAN ResourceRequestExisted ( IN PCI_RESOURCE_NODE * Bridge )

Test whether resource exists for a bridge.

Parameters

Bridge Point to resource node for a bridge.

Return values

TRUE	There is resource on the given bridge.
FALSE	There isn't resource on the given bridge.

Definition at line 1716 of file PciResourceSupport.c.

◆ SkipIsaAliasAperture()

VOID SkipIsaAliasAperture	(	OUT UINT64 *	Start,
		IN UINT64	Length
	)

This function is used to skip ISA aliasing aperture.

Parameters

Start	Returned start address including ISA aliasing aperture.
Length	The length of ISA aliasing aperture.

Definition at line 58 of file PciResourceSupport.c.

◆ SkipVGAAperture()

VOID SkipVGAAperture	(	OUT UINT64 *	Start,
		IN UINT64	Length
	)

The function is used to skip VGA range.

Parameters

Start	Returned start address including VGA range.
Length	The length of VGA range.

Definition at line 26 of file PciResourceSupport.c.

Data Structures

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ PCI_RESOURCE_SIGNATURE

◆ RESOURCE_NODE_FROM_LINK

Enumeration Type Documentation

◆ PCI_RESOURCE_USAGE

Function Documentation

◆ ApplyResourcePadding()

◆ BridgeSupportResourceDecode()

◆ CalculateApertureIo16()

◆ CalculateResourceAperture()

◆ CreateResourceMap()

◆ CreateResourceNode()

◆ CreateVfResourceNode()

◆ DegradeResource()

◆ DestroyResourceTree()

◆ GetResourceFromDevice()

◆ GetResourcePaddingPpb()

◆ InitializeResourcePool()

◆ InsertResourceNode()

◆ MergeResourceTree()

◆ ProgramBar()

◆ ProgramP2C()

◆ ProgramPpbApperture()

◆ ProgramResource()

◆ ProgramUpstreamBridgeForRom()

◆ ProgramVfBar()

◆ ResourcePaddingForCardBusBridge()

◆ ResourcePaddingPolicy()

◆ ResourceRequestExisted()

◆ SkipIsaAliasAperture()

◆ SkipVGAAperture()