#include <Base.h>
#include <Library/DebugLib.h>
#include <Library/S3BootScriptLib.h>
#include <Library/PciSegmentLib.h>

Macros
#define	PCI_SEGMENT_LIB_ADDRESS_TO_S3_BOOT_SCRIPT_PCI_ADDRESS(Address)

Functions
VOID	InternalSavePciSegmentWriteValueToBootScript (IN S3_BOOT_SCRIPT_LIB_WIDTH Width, IN UINT64 Address, IN VOID *Buffer)

UINT8	InternalSavePciSegmentWrite8ValueToBootScript (IN UINT64 Address, IN UINT8 Value)

UINT8 EFIAPI	S3PciSegmentRead8 (IN UINT64 Address)

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

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

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

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

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

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

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

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

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

UINT16	InternalSavePciSegmentWrite16ValueToBootScript (IN UINT64 Address, IN UINT16 Value)

UINT16 EFIAPI	S3PciSegmentRead16 (IN UINT64 Address)

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

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

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

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

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

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

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

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

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

UINT32	InternalSavePciSegmentWrite32ValueToBootScript (IN UINT64 Address, IN UINT32 Value)

UINT32 EFIAPI	S3PciSegmentRead32 (IN UINT64 Address)

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

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

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

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

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

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

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

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

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

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

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

Detailed Description

The multiple segments PCI configuration Library Services that carry out PCI configuration and enable the PCI operations to be replayed during an S3 resume. This library class maps directly on top of the PciSegmentLib class.

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

Definition in file S3PciSegmentLib.c.

Macro Definition Documentation

◆ PCI_SEGMENT_LIB_ADDRESS_TO_S3_BOOT_SCRIPT_PCI_ADDRESS

#define PCI_SEGMENT_LIB_ADDRESS_TO_S3_BOOT_SCRIPT_PCI_ADDRESS ( Address )

Value:

          ((((UINT32)(Address) >> 20) & 0xff) << 24) | \
          ((((UINT32)(Address) >> 15) & 0x1f) << 16) | \
          ((((UINT32)(Address) >> 12) & 0x07) <<  8) | \
          LShiftU64 ((Address) & 0xfff, 32)

Macro that converts address in PciSegmentLib format to the new address that can be pass to the S3 Boot Script Library functions. The Segment is dropped.

Parameters

Address Address in PciSegmentLib format.

Return values

New	address that can be pass to the S3 Boot Script Library functions.

Definition at line 25 of file S3PciSegmentLib.c.

Function Documentation

◆ InternalSavePciSegmentWrite16ValueToBootScript()

UINT16 InternalSavePciSegmentWrite16ValueToBootScript	(	IN UINT64	Address,
		IN UINT16	Value
	)

Saves a 16-bit PCI configuration value to the boot script.

This internal worker function saves a 16-bit PCI configuration value in the S3 script to be replayed on S3 resume.

If the saving process fails, then ASSERT().

Parameters

Address	Address that encodes the PCI Bus, Device, Function and Register.
Value	The value saved to boot script.

Returns: Value.

Definition at line 435 of file S3PciSegmentLib.c.

◆ InternalSavePciSegmentWrite32ValueToBootScript()

UINT32 InternalSavePciSegmentWrite32ValueToBootScript	(	IN UINT64	Address,
		IN UINT32	Value
	)

Saves a 32-bit PCI configuration value to the boot script.

This internal worker function saves a 32-bit PCI configuration value in the S3 script to be replayed on S3 resume.

If the saving process fails, then ASSERT().

Parameters

Address	Address that encodes the PCI Bus, Device, Function and Register.
Value	The value saved to boot script.

Returns: Value.

Definition at line 801 of file S3PciSegmentLib.c.

◆ InternalSavePciSegmentWrite8ValueToBootScript()

UINT8 InternalSavePciSegmentWrite8ValueToBootScript	(	IN UINT64	Address,
		IN UINT8	Value
	)

Saves an 8-bit PCI configuration value to the boot script.

This internal worker function saves an 8-bit PCI configuration value in the S3 script to be replayed on S3 resume.

If the saving process fails, then ASSERT().

Parameters

Address	Address that encodes the PCI Bus, Device, Function and Register.
Value	The value saved to boot script.

Returns: Value.

Definition at line 80 of file S3PciSegmentLib.c.

◆ InternalSavePciSegmentWriteValueToBootScript()

VOID InternalSavePciSegmentWriteValueToBootScript	(	IN S3_BOOT_SCRIPT_LIB_WIDTH	Width,
		IN UINT64	Address,
		IN VOID *	Buffer
	)

Saves a PCI configuration value to the boot script.

This internal worker function saves a PCI configuration value in the S3 script to be replayed on S3 resume.

If the saving process fails, then ASSERT().

Parameters

Width	The width of PCI configuration.
Address	Address that encodes the PCI Bus, Device, Function and Register.
Buffer	The buffer containing value.

Definition at line 46 of file S3PciSegmentLib.c.

◆ S3PciSegmentAnd16()

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

Performs a bitwise AND of a 16-bit PCI configuration register with a 16-bit value, and saves the value in the S3 script to be replayed on S3 resume.

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 546 of file S3PciSegmentLib.c.

◆ S3PciSegmentAnd32()

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

Performs a bitwise AND of a 32-bit PCI configuration register with a 32-bit value, and saves the value in the S3 script to be replayed on S3 resume.

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 912 of file S3PciSegmentLib.c.

◆ S3PciSegmentAnd8()

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

Performs a bitwise AND of an 8-bit PCI configuration register with an 8-bit value, and saves the value in the S3 script to be replayed on S3 resume.

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 185 of file S3PciSegmentLib.c.

◆ S3PciSegmentAndThenOr16()

UINT16 EFIAPI S3PciSegmentAndThenOr16	(	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, and saves the value in the S3 script to be replayed on S3 resume.

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 578 of file S3PciSegmentLib.c.

◆ S3PciSegmentAndThenOr32()

UINT32 EFIAPI S3PciSegmentAndThenOr32	(	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, and saves the value in the S3 script to be replayed on S3 resume.

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 944 of file S3PciSegmentLib.c.

◆ S3PciSegmentAndThenOr8()

UINT8 EFIAPI S3PciSegmentAndThenOr8	(	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, and saves the value in the S3 script to be replayed on S3 resume.

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 216 of file S3PciSegmentLib.c.

◆ S3PciSegmentBitFieldAnd16()

UINT16 EFIAPI S3PciSegmentBitFieldAnd16	(	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, and saves the value in the S3 script to be replayed on S3 resume.

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 731 of file S3PciSegmentLib.c.

◆ S3PciSegmentBitFieldAnd32()

UINT32 EFIAPI S3PciSegmentBitFieldAnd32	(	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, and saves the value in the S3 script to be replayed on S3 resume.

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 1097 of file S3PciSegmentLib.c.

◆ S3PciSegmentBitFieldAnd8()

UINT8 EFIAPI S3PciSegmentBitFieldAnd8	(	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, writes the result back to the bit field in the 8-bit register, and saves the value in the S3 script to be replayed on S3 resume.

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 365 of file S3PciSegmentLib.c.

◆ S3PciSegmentBitFieldAndThenOr16()

UINT16 EFIAPI S3PciSegmentBitFieldAndThenOr16	(	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, writes the result back to the bit field in the 16-bit port, and saves the value in the S3 script to be replayed on S3 resume.

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 774 of file S3PciSegmentLib.c.

◆ S3PciSegmentBitFieldAndThenOr32()

UINT32 EFIAPI S3PciSegmentBitFieldAndThenOr32	(	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, writes the result back to the bit field in the 32-bit port, and saves the value in the S3 script to be replayed on S3 resume.

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 1140 of file S3PciSegmentLib.c.

◆ S3PciSegmentBitFieldAndThenOr8()

UINT8 EFIAPI S3PciSegmentBitFieldAndThenOr8	(	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, writes the result back to the bit field in the 8-bit port, and saves the value in the S3 script to be replayed on S3 resume.

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 408 of file S3PciSegmentLib.c.

◆ S3PciSegmentBitFieldOr16()

UINT16 EFIAPI S3PciSegmentBitFieldOr16	(	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, and saves the value in the S3 script to be replayed on S3 resume.

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 690 of file S3PciSegmentLib.c.

◆ S3PciSegmentBitFieldOr32()

UINT32 EFIAPI S3PciSegmentBitFieldOr32	(	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, writes the result back to the bit field in the 32-bit port, and saves the value in the S3 script to be replayed on S3 resume.

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 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	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 1056 of file S3PciSegmentLib.c.

◆ S3PciSegmentBitFieldOr8()

UINT8 EFIAPI S3PciSegmentBitFieldOr8	(	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, writes the result back to the bit field in the 8-bit port, and saves the value in the S3 script to be replayed on S3 resume.

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 325 of file S3PciSegmentLib.c.

◆ S3PciSegmentBitFieldRead16()

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

Reads a bit field of a PCI configuration register, and saves the value in the S3 script to be replayed on S3 resume.

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 612 of file S3PciSegmentLib.c.

◆ S3PciSegmentBitFieldRead32()

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

Reads a bit field of a PCI configuration register, and saves the value in the S3 script to be replayed on S3 resume.

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 978 of file S3PciSegmentLib.c.

◆ S3PciSegmentBitFieldRead8()

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

Reads a bit field of a PCI configuration register, and saves the value in the S3 script to be replayed on S3 resume.

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 249 of file S3PciSegmentLib.c.

◆ S3PciSegmentBitFieldWrite16()

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

Writes a bit field to a PCI configuration register, and saves the value in the S3 script to be replayed on S3 resume.

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 649 of file S3PciSegmentLib.c.

◆ S3PciSegmentBitFieldWrite32()

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

Writes a bit field to a PCI configuration register, and saves the value in the S3 script to be replayed on S3 resume.

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 1015 of file S3PciSegmentLib.c.

◆ S3PciSegmentBitFieldWrite8()

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

Writes a bit field to a PCI configuration register, and saves the value in the S3 script to be replayed on S3 resume.

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 285 of file S3PciSegmentLib.c.

◆ S3PciSegmentOr16()

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

Performs a bitwise OR of a 16-bit PCI configuration register with a 16-bit value, and saves the value in the S3 script to be replayed on S3 resume.

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 517 of file S3PciSegmentLib.c.

◆ S3PciSegmentOr32()

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

Performs a bitwise OR of a 32-bit PCI configuration register with a 32-bit value, and saves the value in the S3 script to be replayed on S3 resume.

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 back to the PCI configuration register.

Definition at line 883 of file S3PciSegmentLib.c.

◆ S3PciSegmentOr8()

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

Performs a bitwise OR of an 8-bit PCI configuration register with an 8-bit value, and saves the value in the S3 script to be replayed on S3 resume.

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 158 of file S3PciSegmentLib.c.

◆ S3PciSegmentRead16()

UINT16 EFIAPI S3PciSegmentRead16 ( IN UINT64 Address )

Reads a 16-bit PCI configuration register, and saves the value in the S3 script to be replayed on S3 resume.

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 462 of file S3PciSegmentLib.c.

◆ S3PciSegmentRead32()

UINT32 EFIAPI S3PciSegmentRead32 ( IN UINT64 Address )

Reads a 32-bit PCI configuration register, and saves the value in the S3 script to be replayed on S3 resume.

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 828 of file S3PciSegmentLib.c.

◆ S3PciSegmentRead8()

UINT8 EFIAPI S3PciSegmentRead8 ( IN UINT64 Address )

Reads an 8-bit PCI configuration register, and saves the value in the S3 script to be replayed on S3 resume.

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 106 of file S3PciSegmentLib.c.

◆ S3PciSegmentReadBuffer()

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

Reads a range of PCI configuration registers into a caller supplied buffer, and saves the value in the S3 script to be replayed on S3 resume.

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 1177 of file S3PciSegmentLib.c.

◆ S3PciSegmentWrite16()

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

Writes a 16-bit PCI configuration register, and saves the value in the S3 script to be replayed on S3 resume.

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 487 of file S3PciSegmentLib.c.

◆ S3PciSegmentWrite32()

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

Writes a 32-bit PCI configuration register, and saves the value in the S3 script to be replayed on S3 resume.

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 853 of file S3PciSegmentLib.c.

◆ S3PciSegmentWrite8()

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

Writes an 8-bit PCI configuration register, and saves the value in the S3 script to be replayed on S3 resume.

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 130 of file S3PciSegmentLib.c.

◆ S3PciSegmentWriteBuffer()

UINTN EFIAPI S3PciSegmentWriteBuffer	(	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, and saves the value in the S3 script to be replayed on S3 resume.

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 1223 of file S3PciSegmentLib.c.

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ PCI_SEGMENT_LIB_ADDRESS_TO_S3_BOOT_SCRIPT_PCI_ADDRESS

Function Documentation

◆ InternalSavePciSegmentWrite16ValueToBootScript()

◆ InternalSavePciSegmentWrite32ValueToBootScript()

◆ InternalSavePciSegmentWrite8ValueToBootScript()

◆ InternalSavePciSegmentWriteValueToBootScript()

◆ S3PciSegmentAnd16()

◆ S3PciSegmentAnd32()

◆ S3PciSegmentAnd8()

◆ S3PciSegmentAndThenOr16()

◆ S3PciSegmentAndThenOr32()

◆ S3PciSegmentAndThenOr8()

◆ S3PciSegmentBitFieldAnd16()

◆ S3PciSegmentBitFieldAnd32()

◆ S3PciSegmentBitFieldAnd8()

◆ S3PciSegmentBitFieldAndThenOr16()

◆ S3PciSegmentBitFieldAndThenOr32()

◆ S3PciSegmentBitFieldAndThenOr8()

◆ S3PciSegmentBitFieldOr16()

◆ S3PciSegmentBitFieldOr32()

◆ S3PciSegmentBitFieldOr8()

◆ S3PciSegmentBitFieldRead16()

◆ S3PciSegmentBitFieldRead32()

◆ S3PciSegmentBitFieldRead8()

◆ S3PciSegmentBitFieldWrite16()

◆ S3PciSegmentBitFieldWrite32()

◆ S3PciSegmentBitFieldWrite8()

◆ S3PciSegmentOr16()

◆ S3PciSegmentOr32()

◆ S3PciSegmentOr8()

◆ S3PciSegmentRead16()

◆ S3PciSegmentRead32()

◆ S3PciSegmentRead8()

◆ S3PciSegmentReadBuffer()

◆ S3PciSegmentWrite16()

◆ S3PciSegmentWrite32()

◆ S3PciSegmentWrite8()

◆ S3PciSegmentWriteBuffer()