#include <PiSmm.h>
#include <Protocol/SmmPciRootBridgeIo.h>
#include <Library/PciLib.h>
#include <Library/DebugLib.h>
#include <Library/BaseLib.h>
#include <Library/SmmServicesTableLib.h>

Macros
#define	ASSERT_INVALID_PCI_ADDRESS(A, M) ASSERT (((A) & (~0xfffffff \| (M))) == 0)

#define	PCI_TO_PCI_ROOT_BRIDGE_IO_ADDRESS(A) ((((A) << 4) & 0xff000000) \| (((A) >> 4) & 0x00000700) \| (((A) << 1) & 0x001f0000) \| (LShiftU64((A) & 0xfff, 32)))

Functions
EFI_STATUS EFIAPI	PciLibConstructor (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

UINT32	SmmPciLibPciRootBridgeIoReadWorker (IN UINTN Address, IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width)

UINT32	SmmPciLibPciRootBridgeIoWriteWorker (IN UINTN Address, IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width, IN UINT32 Data)

RETURN_STATUS EFIAPI	PciRegisterForRuntimeAccess (IN UINTN Address)

UINT8 EFIAPI	PciRead8 (IN UINTN Address)

UINT8 EFIAPI	PciWrite8 (IN UINTN Address, IN UINT8 Value)

UINT8 EFIAPI	PciOr8 (IN UINTN Address, IN UINT8 OrData)

UINT8 EFIAPI	PciAnd8 (IN UINTN Address, IN UINT8 AndData)

UINT8 EFIAPI	PciAndThenOr8 (IN UINTN Address, IN UINT8 AndData, IN UINT8 OrData)

UINT8 EFIAPI	PciBitFieldRead8 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit)

UINT8 EFIAPI	PciBitFieldWrite8 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT8 Value)

UINT8 EFIAPI	PciBitFieldOr8 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT8 OrData)

UINT8 EFIAPI	PciBitFieldAnd8 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT8 AndData)

UINT8 EFIAPI	PciBitFieldAndThenOr8 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT8 AndData, IN UINT8 OrData)

UINT16 EFIAPI	PciRead16 (IN UINTN Address)

UINT16 EFIAPI	PciWrite16 (IN UINTN Address, IN UINT16 Value)

UINT16 EFIAPI	PciOr16 (IN UINTN Address, IN UINT16 OrData)

UINT16 EFIAPI	PciAnd16 (IN UINTN Address, IN UINT16 AndData)

UINT16 EFIAPI	PciAndThenOr16 (IN UINTN Address, IN UINT16 AndData, IN UINT16 OrData)

UINT16 EFIAPI	PciBitFieldRead16 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit)

UINT16 EFIAPI	PciBitFieldWrite16 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT16 Value)

UINT16 EFIAPI	PciBitFieldOr16 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT16 OrData)

UINT16 EFIAPI	PciBitFieldAnd16 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT16 AndData)

UINT16 EFIAPI	PciBitFieldAndThenOr16 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT16 AndData, IN UINT16 OrData)

UINT32 EFIAPI	PciRead32 (IN UINTN Address)

UINT32 EFIAPI	PciWrite32 (IN UINTN Address, IN UINT32 Value)

UINT32 EFIAPI	PciOr32 (IN UINTN Address, IN UINT32 OrData)

UINT32 EFIAPI	PciAnd32 (IN UINTN Address, IN UINT32 AndData)

UINT32 EFIAPI	PciAndThenOr32 (IN UINTN Address, IN UINT32 AndData, IN UINT32 OrData)

UINT32 EFIAPI	PciBitFieldRead32 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit)

UINT32 EFIAPI	PciBitFieldWrite32 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT32 Value)

UINT32 EFIAPI	PciBitFieldOr32 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT32 OrData)

UINT32 EFIAPI	PciBitFieldAnd32 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT32 AndData)

UINT32 EFIAPI	PciBitFieldAndThenOr32 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT32 AndData, IN UINT32 OrData)

UINTN EFIAPI	PciReadBuffer (IN UINTN StartAddress, IN UINTN Size, OUT VOID *Buffer)

UINTN EFIAPI	PciWriteBuffer (IN UINTN StartAddress, IN UINTN Size, IN VOID *Buffer)

Variables
EFI_SMM_PCI_ROOT_BRIDGE_IO_PROTOCOL *	mSmmPciRootBridgeIo = NULL

Detailed Description

PCI Library using SMM PCI Root Bridge I/O Protocol.

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

Definition in file PciLib.c.

Macro Definition Documentation

◆ ASSERT_INVALID_PCI_ADDRESS

#define ASSERT_INVALID_PCI_ADDRESS	(	A,
		M
	)	ASSERT (((A) & (~0xfffffff \| (M))) == 0)

Assert the validity of a PCI address. A valid PCI address should contain 1's only in the low 28 bits.

Parameters

A	The address to validate.
M	Additional bits to assert to be zero.

Definition at line 23 of file PciLib.c.

◆ PCI_TO_PCI_ROOT_BRIDGE_IO_ADDRESS

#define PCI_TO_PCI_ROOT_BRIDGE_IO_ADDRESS ( A ) ((((A) << 4) & 0xff000000) | (((A) >> 4) & 0x00000700) | (((A) << 1) & 0x001f0000) | (LShiftU64((A) & 0xfff, 32)))

Translate PCI Lib address into format of PCI Root Bridge I/O Protocol.

Parameters

A	The address that encodes the PCI Bus, Device, Function and Register.

Definition at line 33 of file PciLib.c.

Function Documentation

◆ PciAnd16()

UINT16 EFIAPI PciAnd16	(	IN UINTN	Address,
		IN UINT16	AndData
	)

Performs a bitwise AND of a 16-bit PCI configuration register with a 16-bit value.

Reads the 16-bit PCI configuration register specified by Address, performs a bitwise AND between the read result and the value specified by AndData, and writes the result to the 16-bit PCI configuration register specified by Address. The value written to the PCI configuration register is returned. This function must guarantee that all PCI read and write operations are serialized.

If Address > 0x0FFFFFFF, then ASSERT(). If Address is not aligned on a 16-bit boundary, then ASSERT().

Parameters

Address	The address that encodes the PCI Bus, Device, Function and Register.
AndData	The value to AND with the PCI configuration register.

Returns: The value written back to the PCI configuration register.

Definition at line 625 of file PciLib.c.

◆ PciAnd32()

UINT32 EFIAPI PciAnd32	(	IN UINTN	Address,
		IN UINT32	AndData
	)

Performs a bitwise AND of a 32-bit PCI configuration register with a 32-bit value.

Reads the 32-bit PCI configuration register specified by Address, performs a bitwise AND between the read result and the value specified by AndData, and writes the result to the 32-bit PCI configuration register specified by Address. The value written to the PCI configuration register is returned. This function must guarantee that all PCI read and write operations are serialized.

If Address > 0x0FFFFFFF, then ASSERT(). If Address is not aligned on a 32-bit boundary, then ASSERT().

Parameters

Address	The address that encodes the PCI Bus, Device, Function and Register.
AndData	The value to AND with the PCI configuration register.

Returns: The value written back to the PCI configuration register.

Definition at line 984 of file PciLib.c.

◆ PciAnd8()

UINT8 EFIAPI PciAnd8	(	IN UINTN	Address,
		IN UINT8	AndData
	)

Performs a bitwise AND of an 8-bit PCI configuration register with an 8-bit value.

Reads the 8-bit PCI configuration register specified by Address, performs a bitwise AND between the read result and the value specified by AndData, and writes the result to the 8-bit PCI configuration register specified by Address. The value written to the PCI configuration register is returned. This function must guarantee that all PCI read and write operations are serialized.

If Address > 0x0FFFFFFF, then ASSERT().

Parameters

Address	The address that encodes the PCI Bus, Device, Function and Register.
AndData	The value to AND with the PCI configuration register.

Returns: The value written back to the PCI configuration register.

Definition at line 272 of file PciLib.c.

◆ PciAndThenOr16()

UINT16 EFIAPI PciAndThenOr16	(	IN UINTN	Address,
		IN UINT16	AndData,
		IN UINT16	OrData
	)

Performs a bitwise AND of a 16-bit PCI configuration register with a 16-bit value, followed a bitwise OR with another 16-bit value.

Reads the 16-bit PCI configuration register specified by Address, performs a bitwise AND between the read result and the value specified by AndData, performs a bitwise OR between the result of the AND operation and the value specified by OrData, and writes the result to the 16-bit PCI configuration register specified by Address. The value written to the PCI configuration register is returned. This function must guarantee that all PCI read and write operations are serialized.

If Address > 0x0FFFFFFF, then ASSERT(). If Address is not aligned on a 16-bit boundary, then ASSERT().

Parameters

Address	The address that encodes the PCI Bus, Device, Function and Register.
AndData	The value to AND with the PCI configuration register.
OrData	The value to OR with the result of the AND operation.

Returns: The value written back to the PCI configuration register.

Definition at line 658 of file PciLib.c.

◆ PciAndThenOr32()

UINT32 EFIAPI PciAndThenOr32	(	IN UINTN	Address,
		IN UINT32	AndData,
		IN UINT32	OrData
	)

Performs a bitwise AND of a 32-bit PCI configuration register with a 32-bit value, followed a bitwise OR with another 32-bit value.

Reads the 32-bit PCI configuration register specified by Address, performs a bitwise AND between the read result and the value specified by AndData, performs a bitwise OR between the result of the AND operation and the value specified by OrData, and writes the result to the 32-bit PCI configuration register specified by Address. The value written to the PCI configuration register is returned. This function must guarantee that all PCI read and write operations are serialized.

If Address > 0x0FFFFFFF, then ASSERT(). If Address is not aligned on a 32-bit boundary, then ASSERT().

Parameters

Address	The address that encodes the PCI Bus, Device, Function and Register.
AndData	The value to AND with the PCI configuration register.
OrData	The value to OR with the result of the AND operation.

Returns: The value written back to the PCI configuration register.

Definition at line 1017 of file PciLib.c.

◆ PciAndThenOr8()

UINT8 EFIAPI PciAndThenOr8	(	IN UINTN	Address,
		IN UINT8	AndData,
		IN UINT8	OrData
	)

Performs a bitwise AND of an 8-bit PCI configuration register with an 8-bit value, followed a bitwise OR with another 8-bit value.

Reads the 8-bit PCI configuration register specified by Address, performs a bitwise AND between the read result and the value specified by AndData, performs a bitwise OR between the result of the AND operation and the value specified by OrData, and writes the result to the 8-bit PCI configuration register specified by Address. The value written to the PCI configuration register is returned. This function must guarantee that all PCI read and write operations are serialized.

If Address > 0x0FFFFFFF, then ASSERT().

Parameters

Address	The address that encodes the PCI Bus, Device, Function and Register.
AndData	The value to AND with the PCI configuration register.
OrData	The value to OR with the result of the AND operation.

Returns: The value written back to the PCI configuration register.

Definition at line 304 of file PciLib.c.

◆ PciBitFieldAnd16()

UINT16 EFIAPI PciBitFieldAnd16	(	IN UINTN	Address,
		IN UINTN	StartBit,
		IN UINTN	EndBit,
		IN UINT16	AndData
	)

Reads a bit field in a 16-bit PCI configuration register, performs a bitwise AND, and writes the result back to the bit field in the 16-bit register.

Reads the 16-bit PCI configuration register specified by Address, performs a bitwise AND between the read result and the value specified by AndData, and writes the result to the 16-bit PCI configuration register specified by Address. The value written to the PCI configuration register is returned. This function must guarantee that all PCI read and write operations are serialized. Extra left bits in AndData are stripped.

If Address > 0x0FFFFFFF, then ASSERT(). If Address is not aligned on a 16-bit boundary, then ASSERT(). If StartBit is greater than 15, then ASSERT(). If EndBit is greater than 15, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters

Address	The PCI configuration register to write.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..15.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..15.
AndData	The value to AND with the PCI configuration register.

Returns: The value written back to the PCI configuration register.

Definition at line 813 of file PciLib.c.

◆ PciBitFieldAnd32()

UINT32 EFIAPI PciBitFieldAnd32	(	IN UINTN	Address,
		IN UINTN	StartBit,
		IN UINTN	EndBit,
		IN UINT32	AndData
	)

Reads a bit field in a 32-bit PCI configuration register, performs a bitwise AND, and writes the result back to the bit field in the 32-bit register.

Reads the 32-bit PCI configuration register specified by Address, performs a bitwise AND between the read result and the value specified by AndData, and writes the result to the 32-bit PCI configuration register specified by Address. The value written to the PCI configuration register is returned. This function must guarantee that all PCI read and write operations are serialized. Extra left bits in AndData are stripped.

If Address > 0x0FFFFFFF, then ASSERT(). If Address is not aligned on a 32-bit boundary, then ASSERT(). If StartBit is greater than 31, then ASSERT(). If EndBit is greater than 31, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters

Address	The PCI configuration register to write.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..31.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..31.
AndData	The value to AND with the PCI configuration register.

Returns: The value written back to the PCI configuration register.

Definition at line 1172 of file PciLib.c.

◆ PciBitFieldAnd8()

UINT8 EFIAPI PciBitFieldAnd8	(	IN UINTN	Address,
		IN UINTN	StartBit,
		IN UINTN	EndBit,
		IN UINT8	AndData
	)

Reads a bit field in an 8-bit PCI configuration register, performs a bitwise AND, and writes the result back to the bit field in the 8-bit register.

Reads the 8-bit PCI configuration register specified by Address, performs a bitwise AND between the read result and the value specified by AndData, and writes the result to the 8-bit PCI configuration register specified by Address. The value written to the PCI configuration register is returned. This function must guarantee that all PCI read and write operations are serialized. Extra left bits in AndData are stripped.

If Address > 0x0FFFFFFF, then ASSERT(). If StartBit is greater than 7, then ASSERT(). If EndBit is greater than 7, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters

Address	The PCI configuration register to write.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..7.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..7.
AndData	The value to AND with the PCI configuration register.

Returns: The value written back to the PCI configuration register.

Definition at line 455 of file PciLib.c.

◆ PciBitFieldAndThenOr16()

UINT16 EFIAPI PciBitFieldAndThenOr16	(	IN UINTN	Address,
		IN UINTN	StartBit,
		IN UINTN	EndBit,
		IN UINT16	AndData,
		IN UINT16	OrData
	)

Reads a bit field in a 16-bit port, performs a bitwise AND followed by a bitwise OR, and writes the result back to the bit field in the 16-bit port.

Reads the 16-bit PCI configuration register specified by Address, performs a bitwise AND followed by a bitwise OR between the read result and the value specified by AndData, and writes the result to the 16-bit PCI configuration register specified by Address. The value written to the PCI configuration register is returned. This function must guarantee that all PCI read and write operations are serialized. Extra left bits in both AndData and OrData are stripped.

If Address > 0x0FFFFFFF, then ASSERT(). If Address is not aligned on a 16-bit boundary, then ASSERT(). If StartBit is greater than 15, then ASSERT(). If EndBit is greater than 15, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT(). If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters

Address	The PCI configuration register to write.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..15.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..15.
AndData	The value to AND with the PCI configuration register.
OrData	The value to OR with the result of the AND operation.

Returns: The value written back to the PCI configuration register.

Definition at line 860 of file PciLib.c.

◆ PciBitFieldAndThenOr32()

UINT32 EFIAPI PciBitFieldAndThenOr32	(	IN UINTN	Address,
		IN UINTN	StartBit,
		IN UINTN	EndBit,
		IN UINT32	AndData,
		IN UINT32	OrData
	)

Reads a bit field in a 32-bit port, performs a bitwise AND followed by a bitwise OR, and writes the result back to the bit field in the 32-bit port.

Reads the 32-bit PCI configuration register specified by Address, performs a bitwise AND followed by a bitwise OR between the read result and the value specified by AndData, and writes the result to the 32-bit PCI configuration register specified by Address. The value written to the PCI configuration register is returned. This function must guarantee that all PCI read and write operations are serialized. Extra left bits in both AndData and OrData are stripped.

If Address > 0x0FFFFFFF, then ASSERT(). If Address is not aligned on a 32-bit boundary, then ASSERT(). If StartBit is greater than 31, then ASSERT(). If EndBit is greater than 31, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT(). If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters

Address	The PCI configuration register to write.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..31.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..31.
AndData	The value to AND with the PCI configuration register.
OrData	The value to OR with the result of the AND operation.

Returns: The value written back to the PCI configuration register.

Definition at line 1219 of file PciLib.c.

◆ PciBitFieldAndThenOr8()

UINT8 EFIAPI PciBitFieldAndThenOr8	(	IN UINTN	Address,
		IN UINTN	StartBit,
		IN UINTN	EndBit,
		IN UINT8	AndData,
		IN UINT8	OrData
	)

Reads a bit field in an 8-bit port, performs a bitwise AND followed by a bitwise OR, and writes the result back to the bit field in the 8-bit port.

Reads the 8-bit PCI configuration register specified by Address, performs a bitwise AND followed by a bitwise OR between the read result and the value specified by AndData, and writes the result to the 8-bit PCI configuration register specified by Address. The value written to the PCI configuration register is returned. This function must guarantee that all PCI read and write operations are serialized. Extra left bits in both AndData and OrData are stripped.

If Address > 0x0FFFFFFF, then ASSERT(). If StartBit is greater than 7, then ASSERT(). If EndBit is greater than 7, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT(). If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters

Address	The PCI configuration register to write.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..7.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..7.
AndData	The value to AND with the PCI configuration register.
OrData	The value to OR with the result of the AND operation.

Returns: The value written back to the PCI configuration register.

Definition at line 501 of file PciLib.c.

◆ PciBitFieldOr16()

UINT16 EFIAPI PciBitFieldOr16	(	IN UINTN	Address,
		IN UINTN	StartBit,
		IN UINTN	EndBit,
		IN UINT16	OrData
	)

Reads a bit field in a 16-bit PCI configuration, performs a bitwise OR, and writes the result back to the bit field in the 16-bit port.

Reads the 16-bit PCI configuration register specified by Address, performs a bitwise OR between the read result and the value specified by OrData, and writes the result to the 16-bit PCI configuration register specified by Address. The value written to the PCI configuration register is returned. This function must guarantee that all PCI read and write operations are serialized. Extra left bits in OrData are stripped.

If Address > 0x0FFFFFFF, then ASSERT(). If Address is not aligned on a 16-bit boundary, then ASSERT(). If StartBit is greater than 15, then ASSERT(). If EndBit is greater than 15, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters

Address	The PCI configuration register to write.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..15.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..15.
OrData	The value to OR with the PCI configuration register.

Returns: The value written back to the PCI configuration register.

Definition at line 770 of file PciLib.c.

◆ PciBitFieldOr32()

UINT32 EFIAPI PciBitFieldOr32	(	IN UINTN	Address,
		IN UINTN	StartBit,
		IN UINTN	EndBit,
		IN UINT32	OrData
	)

Reads a bit field in a 32-bit PCI configuration, performs a bitwise OR, and writes the result back to the bit field in the 32-bit port.

Reads the 32-bit PCI configuration register specified by Address, performs a bitwise OR between the read result and the value specified by OrData, and writes the result to the 32-bit PCI configuration register specified by Address. The value written to the PCI configuration register is returned. This function must guarantee that all PCI read and write operations are serialized. Extra left bits in OrData are stripped.

If Address > 0x0FFFFFFF, then ASSERT(). If Address is not aligned on a 32-bit boundary, then ASSERT(). If StartBit is greater than 31, then ASSERT(). If EndBit is greater than 31, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters

Address	The PCI configuration register to write.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..31.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..31.
OrData	The value to OR with the PCI configuration register.

Returns: The value written back to the PCI configuration register.

Definition at line 1129 of file PciLib.c.

◆ PciBitFieldOr8()

UINT8 EFIAPI PciBitFieldOr8	(	IN UINTN	Address,
		IN UINTN	StartBit,
		IN UINTN	EndBit,
		IN UINT8	OrData
	)

Reads a bit field in an 8-bit PCI configuration, performs a bitwise OR, and writes the result back to the bit field in the 8-bit port.

Reads the 8-bit PCI configuration register specified by Address, performs a bitwise OR between the read result and the value specified by OrData, and writes the result to the 8-bit PCI configuration register specified by Address. The value written to the PCI configuration register is returned. This function must guarantee that all PCI read and write operations are serialized. Extra left bits in OrData are stripped.

If Address > 0x0FFFFFFF, then ASSERT(). If StartBit is greater than 7, then ASSERT(). If EndBit is greater than 7, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters

Address	The PCI configuration register to write.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..7.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..7.
OrData	The value to OR with the PCI configuration register.

Returns: The value written back to the PCI configuration register.

Definition at line 413 of file PciLib.c.

◆ PciBitFieldRead16()

UINT16 EFIAPI PciBitFieldRead16	(	IN UINTN	Address,
		IN UINTN	StartBit,
		IN UINTN	EndBit
	)

Reads a bit field of a PCI configuration register.

Reads the bit field in a 16-bit PCI configuration register. The bit field is specified by the StartBit and the EndBit. The value of the bit field is returned.

If Address > 0x0FFFFFFF, then ASSERT(). If Address is not aligned on a 16-bit boundary, then ASSERT(). If StartBit is greater than 15, then ASSERT(). If EndBit is greater than 15, then ASSERT(). If EndBit is less than StartBit, then ASSERT().

Parameters

Address	The PCI configuration register to read.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..15.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..15.

Returns: The value of the bit field read from the PCI configuration register.

Definition at line 691 of file PciLib.c.

◆ PciBitFieldRead32()

UINT32 EFIAPI PciBitFieldRead32	(	IN UINTN	Address,
		IN UINTN	StartBit,
		IN UINTN	EndBit
	)

Reads a bit field of a PCI configuration register.

Reads the bit field in a 32-bit PCI configuration register. The bit field is specified by the StartBit and the EndBit. The value of the bit field is returned.

If Address > 0x0FFFFFFF, then ASSERT(). If Address is not aligned on a 32-bit boundary, then ASSERT(). If StartBit is greater than 31, then ASSERT(). If EndBit is greater than 31, then ASSERT(). If EndBit is less than StartBit, then ASSERT().

Parameters

Address	The PCI configuration register to read.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..31.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..31.

Returns: The value of the bit field read from the PCI configuration register.

Definition at line 1050 of file PciLib.c.

◆ PciBitFieldRead8()

UINT8 EFIAPI PciBitFieldRead8	(	IN UINTN	Address,
		IN UINTN	StartBit,
		IN UINTN	EndBit
	)

Reads a bit field of a PCI configuration register.

Reads the bit field in an 8-bit PCI configuration register. The bit field is specified by the StartBit and the EndBit. The value of the bit field is returned.

If Address > 0x0FFFFFFF, then ASSERT(). If StartBit is greater than 7, then ASSERT(). If EndBit is greater than 7, then ASSERT(). If EndBit is less than StartBit, then ASSERT().

Parameters

Address	The PCI configuration register to read.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..7.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..7.

Returns: The value of the bit field read from the PCI configuration register.

Definition at line 336 of file PciLib.c.

◆ PciBitFieldWrite16()

UINT16 EFIAPI PciBitFieldWrite16	(	IN UINTN	Address,
		IN UINTN	StartBit,
		IN UINTN	EndBit,
		IN UINT16	Value
	)

Writes a bit field to a PCI configuration register.

Writes Value to the bit field of the PCI configuration register. The bit field is specified by the StartBit and the EndBit. All other bits in the destination PCI configuration register are preserved. The new value of the 16-bit register is returned.

If Address > 0x0FFFFFFF, then ASSERT(). If Address is not aligned on a 16-bit boundary, then ASSERT(). If StartBit is greater than 15, then ASSERT(). If EndBit is greater than 15, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters

Address	The PCI configuration register to write.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..15.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..15.
Value	The new value of the bit field.

Returns: The value written back to the PCI configuration register.

Definition at line 727 of file PciLib.c.

◆ PciBitFieldWrite32()

UINT32 EFIAPI PciBitFieldWrite32	(	IN UINTN	Address,
		IN UINTN	StartBit,
		IN UINTN	EndBit,
		IN UINT32	Value
	)

Writes a bit field to a PCI configuration register.

Writes Value to the bit field of the PCI configuration register. The bit field is specified by the StartBit and the EndBit. All other bits in the destination PCI configuration register are preserved. The new value of the 32-bit register is returned.

If Address > 0x0FFFFFFF, then ASSERT(). If Address is not aligned on a 32-bit boundary, then ASSERT(). If StartBit is greater than 31, then ASSERT(). If EndBit is greater than 31, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters

Address	The PCI configuration register to write.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..31.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..31.
Value	The new value of the bit field.

Returns: The value written back to the PCI configuration register.

Definition at line 1086 of file PciLib.c.

◆ PciBitFieldWrite8()

UINT8 EFIAPI PciBitFieldWrite8	(	IN UINTN	Address,
		IN UINTN	StartBit,
		IN UINTN	EndBit,
		IN UINT8	Value
	)

Writes a bit field to a PCI configuration register.

Writes Value to the bit field of the PCI configuration register. The bit field is specified by the StartBit and the EndBit. All other bits in the destination PCI configuration register are preserved. The new value of the 8-bit register is returned.

If Address > 0x0FFFFFFF, then ASSERT(). If StartBit is greater than 7, then ASSERT(). If EndBit is greater than 7, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters

Address	The PCI configuration register to write.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..7.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..7.
Value	The new value of the bit field.

Returns: The value written back to the PCI configuration register.

Definition at line 371 of file PciLib.c.

◆ PciLibConstructor()

EFI_STATUS EFIAPI PciLibConstructor	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

The constructor function caches the pointer to PCI Root Bridge I/O protocol.

The constructor function locates PCI Root Bridge I/O protocol from protocol database. It will ASSERT() if that operation fails and it will always return EFI_SUCCESS.

Parameters

ImageHandle	The firmware allocated handle for the EFI image.
SystemTable	A pointer to the EFI System Table.

Return values

EFI_SUCCESS The constructor always returns EFI_SUCCESS.

Definition at line 55 of file PciLib.c.

◆ PciOr16()

UINT16 EFIAPI PciOr16	(	IN UINTN	Address,
		IN UINT16	OrData
	)

Performs a bitwise OR of a 16-bit PCI configuration register with a 16-bit value.

Reads the 16-bit PCI configuration register specified by Address, performs a bitwise OR between the read result and the value specified by OrData, and writes the result to the 16-bit PCI configuration register specified by Address. The value written to the PCI configuration register is returned. This function must guarantee that all PCI read and write operations are serialized.

If Address > 0x0FFFFFFF, then ASSERT(). If Address is not aligned on a 16-bit boundary, then ASSERT().

Parameters

Address	The address that encodes the PCI Bus, Device, Function and Register.
OrData	The value to OR with the PCI configuration register.

Returns: The value written back to the PCI configuration register.

Definition at line 594 of file PciLib.c.

◆ PciOr32()

UINT32 EFIAPI PciOr32	(	IN UINTN	Address,
		IN UINT32	OrData
	)

Performs a bitwise OR of a 32-bit PCI configuration register with a 32-bit value.

Reads the 32-bit PCI configuration register specified by Address, performs a bitwise OR between the read result and the value specified by OrData, and writes the result to the 32-bit PCI configuration register specified by Address. The value written to the PCI configuration register is returned. This function must guarantee that all PCI read and write operations are serialized.

If Address > 0x0FFFFFFF, then ASSERT(). If Address is not aligned on a 32-bit boundary, then ASSERT().

Parameters

Address	The address that encodes the PCI Bus, Device, Function and Register.
OrData	The value to OR with the PCI configuration register.

Returns: The value written back to the PCI configuration register.

Definition at line 953 of file PciLib.c.

◆ PciOr8()

UINT8 EFIAPI PciOr8	(	IN UINTN	Address,
		IN UINT8	OrData
	)

Performs a bitwise OR of an 8-bit PCI configuration register with an 8-bit value.

Reads the 8-bit PCI configuration register specified by Address, performs a bitwise OR between the read result and the value specified by OrData, and writes the result to the 8-bit PCI configuration register specified by Address. The value written to the PCI configuration register is returned. This function must guarantee that all PCI read and write operations are serialized.

If Address > 0x0FFFFFFF, then ASSERT().

Parameters

Address	The address that encodes the PCI Bus, Device, Function and Register.
OrData	The value to OR with the PCI configuration register.

Returns: The value written back to the PCI configuration register.

Definition at line 242 of file PciLib.c.

◆ PciRead16()

UINT16 EFIAPI PciRead16 ( IN UINTN Address )

Reads a 16-bit PCI configuration register.

Reads and returns the 16-bit PCI configuration register specified by Address. This function must guarantee that all PCI read and write operations are serialized.

If Address > 0x0FFFFFFF, then ASSERT(). If Address is not aligned on a 16-bit boundary, then ASSERT().

Parameters

Address The address that encodes the PCI Bus, Device, Function and Register.

Returns: The read value from the PCI configuration register.

Definition at line 533 of file PciLib.c.

◆ PciRead32()

UINT32 EFIAPI PciRead32 ( IN UINTN Address )

Reads a 32-bit PCI configuration register.

Reads and returns the 32-bit PCI configuration register specified by Address. This function must guarantee that all PCI read and write operations are serialized.

If Address > 0x0FFFFFFF, then ASSERT(). If Address is not aligned on a 32-bit boundary, then ASSERT().

Parameters

Address The address that encodes the PCI Bus, Device, Function and Register.

Returns: The read value from the PCI configuration register.

Definition at line 892 of file PciLib.c.

◆ PciRead8()

UINT8 EFIAPI PciRead8 ( IN UINTN Address )

Reads an 8-bit PCI configuration register.

Reads and returns the 8-bit PCI configuration register specified by Address. This function must guarantee that all PCI read and write operations are serialized.

If Address > 0x0FFFFFFF, then ASSERT().

Parameters

Address The address that encodes the PCI Bus, Device, Function and Register.

Returns: The read value from the PCI configuration register.

Definition at line 183 of file PciLib.c.

◆ PciReadBuffer()

UINTN EFIAPI PciReadBuffer	(	IN UINTN	StartAddress,
		IN UINTN	Size,
		OUT VOID *	Buffer
	)

Reads a range of PCI configuration registers into a caller supplied buffer.

Reads the range of PCI configuration registers specified by StartAddress and Size into the buffer specified by Buffer. This function only allows the PCI configuration registers from a single PCI function to be read. Size is returned. When possible 32-bit PCI configuration read cycles are used to read from StartAddress to StartAddress + Size. Due to alignment restrictions, 8-bit and 16-bit PCI configuration read cycles may be used at the beginning and the end of the range.

If StartAddress > 0x0FFFFFFF, then ASSERT(). If ((StartAddress & 0xFFF) + Size) > 0x1000, then ASSERT(). If Size > 0 and Buffer is NULL, then ASSERT().

Parameters

StartAddress	The starting address that encodes the PCI Bus, Device, Function and Register.
Size	The size in bytes of the transfer.
Buffer	The pointer to a buffer receiving the data read.

Returns: Size

Definition at line 1258 of file PciLib.c.

◆ PciRegisterForRuntimeAccess()

RETURN_STATUS EFIAPI PciRegisterForRuntimeAccess ( IN UINTN Address )

Registers a PCI device so PCI configuration registers may be accessed after SetVirtualAddressMap().

Registers the PCI device specified by Address so all the PCI configuration registers associated with that PCI device may be accessed after SetVirtualAddressMap() is called.

If Address > 0x0FFFFFFF, then ASSERT().

Parameters

Address The address that encodes the PCI Bus, Device, Function and Register.

Return values

RETURN_SUCCESS	The PCI device was registered for runtime access.
RETURN_UNSUPPORTED	An attempt was made to call this function after ExitBootServices().
RETURN_UNSUPPORTED	The resources required to access the PCI device at runtime could not be mapped.
RETURN_OUT_OF_RESOURCES	There are not enough resources available to complete the registration.

Definition at line 158 of file PciLib.c.

◆ PciWrite16()

UINT16 EFIAPI PciWrite16	(	IN UINTN	Address,
		IN UINT16	Value
	)

Writes a 16-bit PCI configuration register.

Writes the 16-bit PCI configuration register specified by Address with the value specified by Value. Value is returned. This function must guarantee that all PCI read and write operations are serialized.

If Address > 0x0FFFFFFF, then ASSERT(). If Address is not aligned on a 16-bit boundary, then ASSERT().

Parameters

Address	The address that encodes the PCI Bus, Device, Function and Register.
Value	The value to write.

Returns: The value written to the PCI configuration register.

Definition at line 561 of file PciLib.c.

◆ PciWrite32()

UINT32 EFIAPI PciWrite32	(	IN UINTN	Address,
		IN UINT32	Value
	)

Writes a 32-bit PCI configuration register.

Writes the 32-bit PCI configuration register specified by Address with the value specified by Value. Value is returned. This function must guarantee that all PCI read and write operations are serialized.

If Address > 0x0FFFFFFF, then ASSERT(). If Address is not aligned on a 32-bit boundary, then ASSERT().

Parameters

Address	The address that encodes the PCI Bus, Device, Function and Register.
Value	The value to write.

Returns: The value written to the PCI configuration register.

Definition at line 920 of file PciLib.c.

◆ PciWrite8()

UINT8 EFIAPI PciWrite8	(	IN UINTN	Address,
		IN UINT8	Value
	)

Writes an 8-bit PCI configuration register.

Writes the 8-bit PCI configuration register specified by Address with the value specified by Value. Value is returned. This function must guarantee that all PCI read and write operations are serialized.

If Address > 0x0FFFFFFF, then ASSERT().

Parameters

Address	The address that encodes the PCI Bus, Device, Function and Register.
Value	The value to write.

Returns: The value written to the PCI configuration register.

Definition at line 210 of file PciLib.c.

◆ PciWriteBuffer()

UINTN EFIAPI PciWriteBuffer	(	IN UINTN	StartAddress,
		IN UINTN	Size,
		IN VOID *	Buffer
	)

Copies the data in a caller supplied buffer to a specified range of PCI configuration space.

Writes the range of PCI configuration registers specified by StartAddress and Size from the buffer specified by Buffer. This function only allows the PCI configuration registers from a single PCI function to be written. Size is returned. When possible 32-bit PCI configuration write cycles are used to write from StartAddress to StartAddress + Size. Due to alignment restrictions, 8-bit and 16-bit PCI configuration write cycles may be used at the beginning and the end of the range.

If StartAddress > 0x0FFFFFFF, then ASSERT(). If ((StartAddress & 0xFFF) + Size) > 0x1000, then ASSERT(). If Size > 0 and Buffer is NULL, then ASSERT().

Parameters

StartAddress	The starting address that encodes the PCI Bus, Device, Function and Register.
Size	The size in bytes of the transfer.
Buffer	The pointer to a buffer containing the data to write.

Returns: Size written to StartAddress.

Definition at line 1356 of file PciLib.c.

◆ SmmPciLibPciRootBridgeIoReadWorker()

UINT32 SmmPciLibPciRootBridgeIoReadWorker	(	IN UINTN	Address,
		IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH	Width
	)

Internal worker function to read a PCI configuration register.

This function wraps EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.Pci.Read() service. It reads and returns the PCI configuration register specified by Address, the width of data is specified by Width.

Parameters

Address	The address that encodes the PCI Bus, Device, Function and Register.
Width	The width of data to read

Returns: The value read from the PCI configuration register.

Definition at line 84 of file PciLib.c.

◆ SmmPciLibPciRootBridgeIoWriteWorker()

UINT32 SmmPciLibPciRootBridgeIoWriteWorker	(	IN UINTN	Address,
		IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH	Width,
		IN UINT32	Data
	)

Internal worker function to writes a PCI configuration register.

This function wraps EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.Pci.Write() service. It writes the PCI configuration register specified by Address with the value specified by Data. The width of data is specified by Width. Data is returned.

Parameters

Address	The address that encodes the PCI Bus, Device, Function and Register.
Width	The width of data to write
Data	The value to write.

Returns: The value written to the PCI configuration register.

Definition at line 119 of file PciLib.c.

Variable Documentation

◆ mSmmPciRootBridgeIo

EFI_SMM_PCI_ROOT_BRIDGE_IO_PROTOCOL* mSmmPciRootBridgeIo = NULL

Definition at line 39 of file PciLib.c.

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ ASSERT_INVALID_PCI_ADDRESS

◆ PCI_TO_PCI_ROOT_BRIDGE_IO_ADDRESS

Function Documentation

◆ PciAnd16()

◆ PciAnd32()

◆ PciAnd8()

◆ PciAndThenOr16()

◆ PciAndThenOr32()

◆ PciAndThenOr8()

◆ PciBitFieldAnd16()

◆ PciBitFieldAnd32()

◆ PciBitFieldAnd8()

◆ PciBitFieldAndThenOr16()

◆ PciBitFieldAndThenOr32()

◆ PciBitFieldAndThenOr8()

◆ PciBitFieldOr16()

◆ PciBitFieldOr32()

◆ PciBitFieldOr8()

◆ PciBitFieldRead16()

◆ PciBitFieldRead32()

◆ PciBitFieldRead8()

◆ PciBitFieldWrite16()

◆ PciBitFieldWrite32()

◆ PciBitFieldWrite8()

◆ PciLibConstructor()

◆ PciOr16()

◆ PciOr32()

◆ PciOr8()

◆ PciRead16()

◆ PciRead32()

◆ PciRead8()

◆ PciReadBuffer()

◆ PciRegisterForRuntimeAccess()

◆ PciWrite16()

◆ PciWrite32()

◆ PciWrite8()

◆ PciWriteBuffer()

◆ SmmPciLibPciRootBridgeIoReadWorker()

◆ SmmPciLibPciRootBridgeIoWriteWorker()

Variable Documentation

◆ mSmmPciRootBridgeIo