Macros
#define	PCI_SEGMENT_LIB_ADDRESS(Segment, Bus, Device, Function, Register)

Functions
RETURN_STATUS EFIAPI	PciSegmentRegisterForRuntimeAccess (IN UINTN Address)

UINT8 EFIAPI	PciSegmentRead8 (IN UINT64 Address)

UINT8 EFIAPI	PciSegmentWrite8 (IN UINT64 Address, IN UINT8 Value)

UINT8 EFIAPI	PciSegmentOr8 (IN UINT64 Address, IN UINT8 OrData)

UINT8 EFIAPI	PciSegmentAnd8 (IN UINT64 Address, IN UINT8 AndData)

UINT8 EFIAPI	PciSegmentAndThenOr8 (IN UINT64 Address, IN UINT8 AndData, IN UINT8 OrData)

UINT8 EFIAPI	PciSegmentBitFieldRead8 (IN UINT64 Address, IN UINTN StartBit, IN UINTN EndBit)

UINT8 EFIAPI	PciSegmentBitFieldWrite8 (IN UINT64 Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT8 Value)

UINT8 EFIAPI	PciSegmentBitFieldOr8 (IN UINT64 Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT8 OrData)

UINT8 EFIAPI	PciSegmentBitFieldAnd8 (IN UINT64 Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT8 AndData)

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

UINT16 EFIAPI	PciSegmentRead16 (IN UINT64 Address)

UINT16 EFIAPI	PciSegmentWrite16 (IN UINT64 Address, IN UINT16 Value)

UINT16 EFIAPI	PciSegmentOr16 (IN UINT64 Address, IN UINT16 OrData)

UINT16 EFIAPI	PciSegmentAnd16 (IN UINT64 Address, IN UINT16 AndData)

UINT16 EFIAPI	PciSegmentAndThenOr16 (IN UINT64 Address, IN UINT16 AndData, IN UINT16 OrData)

UINT16 EFIAPI	PciSegmentBitFieldRead16 (IN UINT64 Address, IN UINTN StartBit, IN UINTN EndBit)

UINT16 EFIAPI	PciSegmentBitFieldWrite16 (IN UINT64 Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT16 Value)

UINT16 EFIAPI	PciSegmentBitFieldOr16 (IN UINT64 Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT16 OrData)

UINT16 EFIAPI	PciSegmentBitFieldAnd16 (IN UINT64 Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT16 AndData)

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

UINT32 EFIAPI	PciSegmentRead32 (IN UINT64 Address)

UINT32 EFIAPI	PciSegmentWrite32 (IN UINT64 Address, IN UINT32 Value)

UINT32 EFIAPI	PciSegmentOr32 (IN UINT64 Address, IN UINT32 OrData)

UINT32 EFIAPI	PciSegmentAnd32 (IN UINT64 Address, IN UINT32 AndData)

UINT32 EFIAPI	PciSegmentAndThenOr32 (IN UINT64 Address, IN UINT32 AndData, IN UINT32 OrData)

UINT32 EFIAPI	PciSegmentBitFieldRead32 (IN UINT64 Address, IN UINTN StartBit, IN UINTN EndBit)

UINT32 EFIAPI	PciSegmentBitFieldWrite32 (IN UINT64 Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT32 Value)

UINT32 EFIAPI	PciSegmentBitFieldOr32 (IN UINT64 Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT32 OrData)

UINT32 EFIAPI	PciSegmentBitFieldAnd32 (IN UINT64 Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT32 AndData)

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

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

UINTN EFIAPI	PciSegmentWriteBuffer (IN UINT64 StartAddress, IN UINTN Size, IN VOID *Buffer)

Detailed Description

Provides services to access PCI Configuration Space on a platform with multiple PCI segments.

The PCI Segment Library function provide services to read, write, and modify the PCI configuration registers on PCI root bridges on any supported PCI segment. These library services take a single address parameter that encodes the PCI Segment, PCI Bus, PCI Device, PCI Function, and PCI Register. The layout of this address parameter is as follows:

      PCI Register: Bits 0..11
      PCI Function  Bits 12..14
      PCI Device  Bits 15..19
      PCI Bus Bits 20..27
      Reserved  Bits 28..31.  Must be 0.
      PCI Segment Bits 32..47
      Reserved  Bits 48..63.  Must be 0.

These functions perform PCI configuration cycles using the default PCI configuration access method. This may use I/O ports 0xCF8 and 0xCFC to perform PCI configuration accesses, or it may use MMIO registers relative to the PcdPciExpressBaseAddress, or it may use some alternate access method. Modules will typically use the PCI Segment Library for its PCI configuration accesses when PCI Segments other than Segment #0 must be accessed.

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

Definition in file PciSegmentLib.h.

Macro Definition Documentation

◆ PCI_SEGMENT_LIB_ADDRESS

#define PCI_SEGMENT_LIB_ADDRESS	(	Segment,
		Bus,
		Device,
		Function,
		Register
	)

Value:

  ((Segment != 0) ? \
    ( ((Register) & 0xfff)                 | \
      (((Function) & 0x07) << 12)          | \
      (((Device) & 0x1f) << 15)            | \
      (((Bus) & 0xff) << 20)               | \
      (LShiftU64 ((Segment) & 0xffff, 32))   \
    ) :                                      \
    ( ((Register) & 0xfff)                 | \
      (((Function) & 0x07) << 12)          | \
      (((Device) & 0x1f) << 15)            | \
      (((Bus) & 0xff) << 20)                 \
    )                                        \
  )

Macro that converts PCI Segment, PCI Bus, PCI Device, PCI Function, and PCI Register to an address that can be passed to the PCI Segment Library functions.

Computes an address that is compatible with the PCI Segment Library functions. The unused upper bits of Segment, Bus, Device, Function, and Register are stripped prior to the generation of the address.

Parameters

Segment	PCI Segment number. Range 0..65535.
Bus	PCI Bus number. Range 0..255.
Device	PCI Device number. Range 0..31.
Function	PCI Function number. Range 0..7.
Register	PCI Register number. Range 0..255 for PCI. Range 0..4095 for PCI Express.

Returns: The address that is compatible with the PCI Segment Library functions.

Definition at line 51 of file PciSegmentLib.h.

Function Documentation

◆ PciSegmentAnd16()

UINT16 EFIAPI PciSegmentAnd16	(	IN UINT64	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 any reserved bits in Address are set, then ASSERT(). If Address is not aligned on a 16-bit boundary, then ASSERT().

Parameters

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

Returns: The value written to the PCI configuration register.

Definition at line 500 of file PciSegmentLib.c.

◆ PciSegmentAnd32()

UINT32 EFIAPI PciSegmentAnd32	(	IN UINT64	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 any reserved bits in Address are set, then ASSERT(). If Address is not aligned on a 32-bit boundary, then ASSERT().

Parameters

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

Returns: The value written to the PCI configuration register.

Definition at line 846 of file PciSegmentLib.c.

◆ PciSegmentAnd8()

UINT8 EFIAPI PciSegmentAnd8	(	IN UINT64	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 any reserved bits in Address are set, then ASSERT().

Parameters

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

Returns: The value written to the PCI configuration register.

Definition at line 158 of file PciSegmentLib.c.

◆ PciSegmentAndThenOr16()

UINT16 EFIAPI PciSegmentAndThenOr16	(	IN UINT64	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 any reserved bits in Address are set, then ASSERT(). If Address is not aligned on a 16-bit boundary, then ASSERT().

Parameters

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

Returns: The value written to the PCI configuration register.

Definition at line 531 of file PciSegmentLib.c.

◆ PciSegmentAndThenOr32()

UINT32 EFIAPI PciSegmentAndThenOr32	(	IN UINT64	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 any reserved bits in Address are set, then ASSERT(). If Address is not aligned on a 32-bit boundary, then ASSERT().

Parameters

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

Returns: The value written to the PCI configuration register.

Definition at line 877 of file PciSegmentLib.c.

◆ PciSegmentAndThenOr8()

UINT8 EFIAPI PciSegmentAndThenOr8	(	IN UINT64	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 any reserved bits in Address are set, then ASSERT().

Parameters

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

Returns: The value written to the PCI configuration register.

Definition at line 188 of file PciSegmentLib.c.

◆ PciSegmentBitFieldAnd16()

UINT16 EFIAPI PciSegmentBitFieldAnd16	(	IN UINT64	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, 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 any reserved bits in Address are set, 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	Address that encodes the PCI Segment, Bus, Device, Function, and Register.
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 686 of file PciSegmentLib.c.

◆ PciSegmentBitFieldAnd32()

UINT32 EFIAPI PciSegmentBitFieldAnd32	(	IN UINT64	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 any reserved bits in Address are set, 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	Address that encodes the PCI Segment, Bus, Device, Function, and Register.
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 1030 of file PciSegmentLib.c.

◆ PciSegmentBitFieldAnd8()

UINT8 EFIAPI PciSegmentBitFieldAnd8	(	IN UINT64	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 any reserved bits in Address are set, 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	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 339 of file PciSegmentLib.c.

◆ PciSegmentBitFieldAndThenOr16()

UINT16 EFIAPI PciSegmentBitFieldAndThenOr16	(	IN UINT64	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 any reserved bits in Address are set, 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	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 732 of file PciSegmentLib.c.

◆ PciSegmentBitFieldAndThenOr32()

UINT32 EFIAPI PciSegmentBitFieldAndThenOr32	(	IN UINT64	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 any reserved bits in Address are set, 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	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 1076 of file PciSegmentLib.c.

◆ PciSegmentBitFieldAndThenOr8()

UINT8 EFIAPI PciSegmentBitFieldAndThenOr8	(	IN UINT64	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 any reserved bits in Address are set, 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	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 384 of file PciSegmentLib.c.

◆ PciSegmentBitFieldOr16()

UINT16 EFIAPI PciSegmentBitFieldOr16	(	IN UINT64	Address,
		IN UINTN	StartBit,
		IN UINTN	EndBit,
		IN UINT16	OrData
	)

Reads a bit field in a 16-bit PCI configuration, performs a bitwise OR, 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 any reserved bits in Address are set, 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	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 643 of file PciSegmentLib.c.

◆ PciSegmentBitFieldOr32()

UINT32 EFIAPI PciSegmentBitFieldOr32	(	IN UINT64	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 any reserved bits in Address are set, 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	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 988 of file PciSegmentLib.c.

◆ PciSegmentBitFieldOr8()

UINT8 EFIAPI PciSegmentBitFieldOr8	(	IN UINT64	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 any reserved bits in Address are set, 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	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 297 of file PciSegmentLib.c.

◆ PciSegmentBitFieldRead16()

UINT16 EFIAPI PciSegmentBitFieldRead16	(	IN UINT64	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 any reserved bits in Address are set, 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	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 564 of file PciSegmentLib.c.

◆ PciSegmentBitFieldRead32()

UINT32 EFIAPI PciSegmentBitFieldRead32	(	IN UINT64	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 any reserved bits in Address are set, 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	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 910 of file PciSegmentLib.c.

◆ PciSegmentBitFieldRead8()

UINT8 EFIAPI PciSegmentBitFieldRead8	(	IN UINT64	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 any reserved bits in Address are set, 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	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 220 of file PciSegmentLib.c.

◆ PciSegmentBitFieldWrite16()

UINT16 EFIAPI PciSegmentBitFieldWrite16	(	IN UINT64	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 any reserved bits in Address are set, 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	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	New value of the bit field.

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

Definition at line 600 of file PciSegmentLib.c.

◆ PciSegmentBitFieldWrite32()

UINT32 EFIAPI PciSegmentBitFieldWrite32	(	IN UINT64	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 any reserved bits in Address are set, 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	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	New value of the bit field.

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

Definition at line 946 of file PciSegmentLib.c.

◆ PciSegmentBitFieldWrite8()

UINT8 EFIAPI PciSegmentBitFieldWrite8	(	IN UINT64	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 any reserved bits in Address are set, 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	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	New value of the bit field.

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

Definition at line 255 of file PciSegmentLib.c.

◆ PciSegmentOr16()

UINT16 EFIAPI PciSegmentOr16	(	IN UINT64	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 any reserved bits in Address are set, then ASSERT(). If Address is not aligned on a 16-bit boundary, then ASSERT().

Parameters

Address	Address that encodes the PCI Segment, 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 472 of file PciSegmentLib.c.

◆ PciSegmentOr32()

UINT32 EFIAPI PciSegmentOr32	(	IN UINT64	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 any reserved bits in Address are set, then ASSERT(). If Address is not aligned on a 32-bit boundary, then ASSERT().

Parameters

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

Returns: The value written to the PCI configuration register.

Definition at line 818 of file PciSegmentLib.c.

◆ PciSegmentOr8()

UINT8 EFIAPI PciSegmentOr8	(	IN UINT64	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 any reserved bits in Address are set, then ASSERT().

Parameters

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

Returns: The value written to the PCI configuration register.

Definition at line 132 of file PciSegmentLib.c.

◆ PciSegmentRead16()

UINT16 EFIAPI PciSegmentRead16 ( IN UINT64 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 any reserved bits in Address are set, then ASSERT(). If Address is not aligned on a 16-bit boundary, then ASSERT().

Parameters

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

Returns: The 16-bit PCI configuration register specified by Address.

Definition at line 414 of file PciSegmentLib.c.

◆ PciSegmentRead32()

UINT32 EFIAPI PciSegmentRead32 ( IN UINT64 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 any reserved bits in Address are set, then ASSERT(). If Address is not aligned on a 32-bit boundary, then ASSERT().

Parameters

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

Returns: The 32-bit PCI configuration register specified by Address.

Definition at line 762 of file PciSegmentLib.c.

◆ PciSegmentRead8()

UINT8 EFIAPI PciSegmentRead8 ( IN UINT64 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 any reserved bits in Address are set, then ASSERT().

Parameters

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

Returns: The 8-bit PCI configuration register specified by Address.

Definition at line 78 of file PciSegmentLib.c.

◆ PciSegmentReadBuffer()

UINTN EFIAPI PciSegmentReadBuffer	(	IN UINT64	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 any reserved bits in StartAddress are set, then ASSERT(). If ((StartAddress & 0xFFF) + Size) > 0x1000, then ASSERT(). If Size > 0 and Buffer is NULL, then ASSERT().

Parameters

StartAddress	Starting address that encodes the PCI Segment, Bus, Device, Function and Register.
Size	Size in bytes of the transfer.
Buffer	Pointer to a buffer receiving the data read.

Returns: Size

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 StartAdress 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 any reserved bits in StartAddress are set, then ASSERT(). If ((StartAddress & 0xFFF) + Size) > 0x1000, then ASSERT(). If Size > 0 and Buffer is NULL, then ASSERT().

Parameters

StartAddress	Starting address that encodes the PCI Segment, Bus, Device, Function and Register.
Size	Size in bytes of the transfer.
Buffer	Pointer to a buffer receiving the data read.

Returns: Size

Definition at line 1115 of file PciSegmentLib.c.

◆ PciSegmentRegisterForRuntimeAccess()

RETURN_STATUS EFIAPI PciSegmentRegisterForRuntimeAccess ( IN UINTN Address )

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

If any reserved bits in Address are set, then ASSERT().

Parameters

Address 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.

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

If any reserved bits in Address are set, 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 55 of file PciSegmentLib.c.

◆ PciSegmentWrite16()

UINT16 EFIAPI PciSegmentWrite16	(	IN UINT64	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 any reserved bits in Address are set, then ASSERT(). If Address is not aligned on a 16-bit boundary, then ASSERT().

Parameters

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

Returns: The parameter of Value.

Definition at line 440 of file PciSegmentLib.c.

◆ PciSegmentWrite32()

UINT32 EFIAPI PciSegmentWrite32	(	IN UINT64	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 any reserved bits in Address are set, then ASSERT(). If Address is not aligned on a 32-bit boundary, then ASSERT().

Parameters

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

Returns: The parameter of Value.

Definition at line 788 of file PciSegmentLib.c.

◆ PciSegmentWrite8()

UINT8 EFIAPI PciSegmentWrite8	(	IN UINT64	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 any reserved bits in Address are set, then ASSERT().

Parameters

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

Returns: The value written to the PCI configuration register.

Definition at line 103 of file PciSegmentLib.c.

◆ PciSegmentWriteBuffer()

UINTN EFIAPI PciSegmentWriteBuffer	(	IN UINT64	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 any reserved bits in StartAddress are set, then ASSERT(). If ((StartAddress & 0xFFF) + Size) > 0x1000, then ASSERT(). If Size > 0 and Buffer is NULL, then ASSERT().

Parameters

StartAddress	Starting address that encodes the PCI Segment, Bus, Device, Function and Register.
Size	Size in bytes of the transfer.
Buffer	Pointer to a buffer containing the data to write.

Returns: The parameter of Size.

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 StartAdress 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 any reserved bits in StartAddress are set, then ASSERT(). If ((StartAddress & 0xFFF) + Size) > 0x1000, then ASSERT(). If Size > 0 and Buffer is NULL, then ASSERT().

Parameters

StartAddress	Starting address that encodes the PCI Segment, Bus, Device, Function and Register.
Size	Size in bytes of the transfer.
Buffer	Pointer to a buffer containing the data to write.

Returns: The parameter of Size.

Definition at line 1213 of file PciSegmentLib.c.

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ PCI_SEGMENT_LIB_ADDRESS

Function Documentation

◆ PciSegmentAnd16()

◆ PciSegmentAnd32()

◆ PciSegmentAnd8()

◆ PciSegmentAndThenOr16()

◆ PciSegmentAndThenOr32()

◆ PciSegmentAndThenOr8()

◆ PciSegmentBitFieldAnd16()

◆ PciSegmentBitFieldAnd32()

◆ PciSegmentBitFieldAnd8()

◆ PciSegmentBitFieldAndThenOr16()

◆ PciSegmentBitFieldAndThenOr32()

◆ PciSegmentBitFieldAndThenOr8()

◆ PciSegmentBitFieldOr16()

◆ PciSegmentBitFieldOr32()

◆ PciSegmentBitFieldOr8()

◆ PciSegmentBitFieldRead16()

◆ PciSegmentBitFieldRead32()

◆ PciSegmentBitFieldRead8()

◆ PciSegmentBitFieldWrite16()

◆ PciSegmentBitFieldWrite32()

◆ PciSegmentBitFieldWrite8()

◆ PciSegmentOr16()

◆ PciSegmentOr32()

◆ PciSegmentOr8()

◆ PciSegmentRead16()

◆ PciSegmentRead32()

◆ PciSegmentRead8()

◆ PciSegmentReadBuffer()

◆ PciSegmentRegisterForRuntimeAccess()

◆ PciSegmentWrite16()

◆ PciSegmentWrite32()

◆ PciSegmentWrite8()

◆ PciSegmentWriteBuffer()