PciHotPlugSupport.h File Reference

Go to the source code of this file.

Data Structures
struct	ROOT_HPC_DATA

Macros
#define	STALL_1_SECOND   1000000

Functions
VOID EFIAPI	PciHPCInitialized (IN EFI_EVENT Event, IN VOID *Context)
BOOLEAN	EfiCompareDevicePath (IN EFI_DEVICE_PATH_PROTOCOL *DevicePath1, IN EFI_DEVICE_PATH_PROTOCOL *DevicePath2)
EFI_STATUS	InitializeHotPlugSupport (VOID)
BOOLEAN	IsPciHotPlugBus (PCI_IO_DEVICE *PciIoDevice)
BOOLEAN	IsRootPciHotPlugBus (IN EFI_DEVICE_PATH_PROTOCOL *HpbDevicePath, OUT UINTN *HpIndex OPTIONAL)
BOOLEAN	IsRootPciHotPlugController (IN EFI_DEVICE_PATH_PROTOCOL *HpcDevicePath, OUT UINTN *HpIndex)
EFI_STATUS	CreateEventForHpc (IN UINTN HpIndex, OUT EFI_EVENT *Event)
EFI_STATUS	AllRootHPCInitialized (IN UINTN TimeoutInMicroSeconds)
BOOLEAN	IsSHPC (IN PCI_IO_DEVICE *PciIoDevice)
BOOLEAN	SupportsPcieHotplug (IN PCI_IO_DEVICE *PciIoDevice)
VOID	GetResourcePaddingForHpb (IN PCI_IO_DEVICE *PciIoDevice)

Variables
EFI_PCI_HOT_PLUG_INIT_PROTOCOL *	gPciHotPlugInit
EFI_HPC_LOCATION *	gPciRootHpcPool
ROOT_HPC_DATA *	gPciRootHpcData

Detailed Description

PCI Hot Plug 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 PciHotPlugSupport.h.

Macro Definition Documentation

STALL_1_SECOND

#define STALL_1_SECOND   1000000

Definition at line 15 of file PciHotPlugSupport.h.

Function Documentation

AllRootHPCInitialized()

EFI_STATUS AllRootHPCInitialized

(

IN UINTN

TimeoutInMicroSeconds

)

Wait for all root PCI Hot Plug controller finished initializing.

Parameters

TimeoutInMicroSeconds

Microseconds to wait for all root HPCs' initialization.

Return values

EFI_SUCCESS	All HPCs initialization finished.
EFI_TIMEOUT	Not ALL HPCs initialization finished in Microseconds.

Definition at line 233 of file PciHotPlugSupport.c.

CreateEventForHpc()

EFI_STATUS CreateEventForHpc	(	IN UINTN	HpIndex,
		OUT EFI_EVENT *	Event
	)

Creating event object for PCI Hot Plug controller.

Parameters

HpIndex	Index of hot plug device in global array.
Event	The returned event that invoke this function.

Returns

Status of create event.

Definition at line 201 of file PciHotPlugSupport.c.

EfiCompareDevicePath()

BOOLEAN EfiCompareDevicePath	(	IN EFI_DEVICE_PATH_PROTOCOL *	DevicePath1,
		IN EFI_DEVICE_PATH_PROTOCOL *	DevicePath2
	)

Compare two device paths to check if they are exactly same.

Parameters

DevicePath1	A pointer to the first device path data structure.
DevicePath2	A pointer to the second device path data structure.

Return values

TRUE	They are same.
FALSE	They are not same.

Definition at line 47 of file PciHotPlugSupport.c.

GetResourcePaddingForHpb()

VOID GetResourcePaddingForHpb

(

IN PCI_IO_DEVICE *

PciIoDevice

)

Get resource padding if the specified PCI bridge is a hot plug bus.

Parameters

PciIoDevice

PCI bridge instance.

Definition at line 402 of file PciHotPlugSupport.c.

InitializeHotPlugSupport()

EFI_STATUS InitializeHotPlugSupport

(

VOID

)

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.

Return values

EFI_SUCCESS	They are same.
EFI_UNSUPPORTED	No PCI Hot Plug controller on the platform.
EFI_OUT_OF_RESOURCES	No memory to constructor root hot plug private data structure.

Definition at line 83 of file PciHotPlugSupport.c.

IsPciHotPlugBus()

BOOLEAN IsPciHotPlugBus

(

PCI_IO_DEVICE *

PciIoDevice

)

Test whether PCI device is hot plug bus.

Parameters

PciIoDevice

PCI device instance.

Return values

TRUE	PCI device is a hot plug bus.
FALSE	PCI device is not a hot plug bus.

Definition at line 449 of file PciHotPlugSupport.c.

IsRootPciHotPlugBus()

BOOLEAN IsRootPciHotPlugBus	(	IN EFI_DEVICE_PATH_PROTOCOL *	HpbDevicePath,
		OUT UINTN *HpIndex	OPTIONAL
	)

Test whether device path is for root pci hot plug bus.

Parameters

HpbDevicePath	A pointer to device path data structure to be tested.
HpIndex	If HpIndex is not NULL, return the index of root hot plug in global array when TRUE is returned.

Return values

TRUE	The device path is for root pci hot plug bus.
FALSE	The device path is not for root pci hot plug bus.

Definition at line 139 of file PciHotPlugSupport.c.

IsRootPciHotPlugController()

BOOLEAN IsRootPciHotPlugController	(	IN EFI_DEVICE_PATH_PROTOCOL *	HpcDevicePath,
		OUT UINTN *	HpIndex
	)

Test whether device path is for root pci hot plug controller.

Parameters

HpcDevicePath	A pointer to device path data structure to be tested.
HpIndex	If HpIndex is not NULL, return the index of root hot plug in global array when TRUE is returned.

Return values

TRUE	The device path is for root pci hot plug controller.
FALSE	The device path is not for root pci hot plug controller.

Definition at line 171 of file PciHotPlugSupport.c.

IsSHPC()

BOOLEAN IsSHPC

(

IN PCI_IO_DEVICE *

PciIoDevice

)

Check whether PCI-PCI bridge has PCI Hot Plug capability register block.

Parameters

PciIoDevice

A Pointer to the PCI-PCI bridge.

Return values

TRUE	PCI device is HPC.
FALSE	PCI device is not HPC.

Definition at line 274 of file PciHotPlugSupport.c.

PciHPCInitialized()

VOID EFIAPI PciHPCInitialized	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

Event notification function to set Hot Plug controller status.

Parameters

Event	The event that invoke this function.
Context	The calling context, pointer to ROOT_HPC_DATA.

Definition at line 25 of file PciHotPlugSupport.c.

SupportsPcieHotplug()

BOOLEAN SupportsPcieHotplug

(

IN PCI_IO_DEVICE *

PciIoDevice

)

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.

Parameters

[in]

PciIoDevice

The device being checked.

Return values

TRUE	PciIoDevice is a PCIe port that accepts a hot-plugged device.
FALSE	Otherwise.

Definition at line 321 of file PciHotPlugSupport.c.

Variable Documentation

gPciHotPlugInit

EFI_PCI_HOT_PLUG_INIT_PROTOCOL* gPciHotPlugInit

extern

Definition at line 11 of file PciHotPlugSupport.c.

gPciRootHpcData

ROOT_HPC_DATA* gPciRootHpcData

extern

Definition at line 14 of file PciHotPlugSupport.c.

gPciRootHpcPool

EFI_HPC_LOCATION* gPciRootHpcPool

extern

Definition at line 12 of file PciHotPlugSupport.c.