#include <Base.h>
#include <Library/S3IoLib.h>
#include <Library/DebugLib.h>
#include <Library/IoLib.h>
#include <Library/S3BootScriptLib.h>

Functions
VOID	InternalSaveIoWriteValueToBootScript (IN S3_BOOT_SCRIPT_LIB_WIDTH Width, IN UINTN Port, IN VOID *Buffer)

UINT8	InternalSaveIoWrite8ValueToBootScript (IN UINTN Port, IN UINT8 Value)

UINT8 EFIAPI	S3IoRead8 (IN UINTN Port)

UINT8 EFIAPI	S3IoWrite8 (IN UINTN Port, IN UINT8 Value)

UINT8 EFIAPI	S3IoOr8 (IN UINTN Port, IN UINT8 OrData)

UINT8 EFIAPI	S3IoAnd8 (IN UINTN Port, IN UINT8 AndData)

UINT8 EFIAPI	S3IoAndThenOr8 (IN UINTN Port, IN UINT8 AndData, IN UINT8 OrData)

UINT8 EFIAPI	S3IoBitFieldRead8 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit)

UINT8 EFIAPI	S3IoBitFieldWrite8 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT8 Value)

UINT8 EFIAPI	S3IoBitFieldOr8 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT8 OrData)

UINT8 EFIAPI	S3IoBitFieldAnd8 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT8 AndData)

UINT8 EFIAPI	S3IoBitFieldAndThenOr8 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT8 AndData, IN UINT8 OrData)

UINT16	InternalSaveIoWrite16ValueToBootScript (IN UINTN Port, IN UINT16 Value)

UINT16 EFIAPI	S3IoRead16 (IN UINTN Port)

UINT16 EFIAPI	S3IoWrite16 (IN UINTN Port, IN UINT16 Value)

UINT16 EFIAPI	S3IoOr16 (IN UINTN Port, IN UINT16 OrData)

UINT16 EFIAPI	S3IoAnd16 (IN UINTN Port, IN UINT16 AndData)

UINT16 EFIAPI	S3IoAndThenOr16 (IN UINTN Port, IN UINT16 AndData, IN UINT16 OrData)

UINT16 EFIAPI	S3IoBitFieldRead16 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit)

UINT16 EFIAPI	S3IoBitFieldWrite16 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT16 Value)

UINT16 EFIAPI	S3IoBitFieldOr16 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT16 OrData)

UINT16 EFIAPI	S3IoBitFieldAnd16 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT16 AndData)

UINT16 EFIAPI	S3IoBitFieldAndThenOr16 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT16 AndData, IN UINT16 OrData)

UINT32	InternalSaveIoWrite32ValueToBootScript (IN UINTN Port, IN UINT32 Value)

UINT32 EFIAPI	S3IoRead32 (IN UINTN Port)

UINT32 EFIAPI	S3IoWrite32 (IN UINTN Port, IN UINT32 Value)

UINT32 EFIAPI	S3IoOr32 (IN UINTN Port, IN UINT32 OrData)

UINT32 EFIAPI	S3IoAnd32 (IN UINTN Port, IN UINT32 AndData)

UINT32 EFIAPI	S3IoAndThenOr32 (IN UINTN Port, IN UINT32 AndData, IN UINT32 OrData)

UINT32 EFIAPI	S3IoBitFieldRead32 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit)

UINT32 EFIAPI	S3IoBitFieldWrite32 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT32 Value)

UINT32 EFIAPI	S3IoBitFieldOr32 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT32 OrData)

UINT32 EFIAPI	S3IoBitFieldAnd32 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT32 AndData)

UINT32 EFIAPI	S3IoBitFieldAndThenOr32 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT32 AndData, IN UINT32 OrData)

UINT64	InternalSaveIoWrite64ValueToBootScript (IN UINTN Port, IN UINT64 Value)

UINT64 EFIAPI	S3IoRead64 (IN UINTN Port)

UINT64 EFIAPI	S3IoWrite64 (IN UINTN Port, IN UINT64 Value)

UINT64 EFIAPI	S3IoOr64 (IN UINTN Port, IN UINT64 OrData)

UINT64 EFIAPI	S3IoAnd64 (IN UINTN Port, IN UINT64 AndData)

UINT64 EFIAPI	S3IoAndThenOr64 (IN UINTN Port, IN UINT64 AndData, IN UINT64 OrData)

UINT64 EFIAPI	S3IoBitFieldRead64 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit)

UINT64 EFIAPI	S3IoBitFieldWrite64 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT64 Value)

UINT64 EFIAPI	S3IoBitFieldOr64 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT64 OrData)

UINT64 EFIAPI	S3IoBitFieldAnd64 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT64 AndData)

UINT64 EFIAPI	S3IoBitFieldAndThenOr64 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT64 AndData, IN UINT64 OrData)

VOID	InternalSaveMmioWriteValueToBootScript (IN S3_BOOT_SCRIPT_LIB_WIDTH Width, IN UINTN Address, IN VOID *Buffer)

UINT8	InternalSaveMmioWrite8ValueToBootScript (IN UINTN Address, IN UINT8 Value)

UINT8 EFIAPI	S3MmioRead8 (IN UINTN Address)

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

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

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

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

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

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

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

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

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

UINT16	InternalSaveMmioWrite16ValueToBootScript (IN UINTN Address, IN UINT16 Value)

UINT16 EFIAPI	S3MmioRead16 (IN UINTN Address)

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

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

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

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

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

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

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

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

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

UINT32	InternalSaveMmioWrite32ValueToBootScript (IN UINTN Address, IN UINT32 Value)

UINT32 EFIAPI	S3MmioRead32 (IN UINTN Address)

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

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

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

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

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

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

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

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

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

UINT64	InternalSaveMmioWrite64ValueToBootScript (IN UINTN Address, IN UINT64 Value)

UINT64 EFIAPI	S3MmioRead64 (IN UINTN Address)

UINT64 EFIAPI	S3MmioWrite64 (IN UINTN Address, IN UINT64 Value)

UINT64 EFIAPI	S3MmioOr64 (IN UINTN Address, IN UINT64 OrData)

UINT64 EFIAPI	S3MmioAnd64 (IN UINTN Address, IN UINT64 AndData)

UINT64 EFIAPI	S3MmioAndThenOr64 (IN UINTN Address, IN UINT64 AndData, IN UINT64 OrData)

UINT64 EFIAPI	S3MmioBitFieldRead64 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit)

UINT64 EFIAPI	S3MmioBitFieldWrite64 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT64 Value)

UINT64 EFIAPI	S3MmioBitFieldOr64 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT64 OrData)

UINT64 EFIAPI	S3MmioBitFieldAnd64 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT64 AndData)

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

UINT8 *EFIAPI	S3MmioReadBuffer8 (IN UINTN StartAddress, IN UINTN Length, OUT UINT8 *Buffer)

UINT16 *EFIAPI	S3MmioReadBuffer16 (IN UINTN StartAddress, IN UINTN Length, OUT UINT16 *Buffer)

UINT32 *EFIAPI	S3MmioReadBuffer32 (IN UINTN StartAddress, IN UINTN Length, OUT UINT32 *Buffer)

UINT64 *EFIAPI	S3MmioReadBuffer64 (IN UINTN StartAddress, IN UINTN Length, OUT UINT64 *Buffer)

UINT8 *EFIAPI	S3MmioWriteBuffer8 (IN UINTN StartAddress, IN UINTN Length, IN CONST UINT8 *Buffer)

UINT16 *EFIAPI	S3MmioWriteBuffer16 (IN UINTN StartAddress, IN UINTN Length, IN CONST UINT16 *Buffer)

UINT32 *EFIAPI	S3MmioWriteBuffer32 (IN UINTN StartAddress, IN UINTN Length, IN CONST UINT32 *Buffer)

UINT64 *EFIAPI	S3MmioWriteBuffer64 (IN UINTN StartAddress, IN UINTN Length, IN CONST UINT64 *Buffer)

Detailed Description

I/O and MMIO Library Services that do I/O and also enable the I/O operatation to be replayed during an S3 resume.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file S3IoLib.c.

Function Documentation

◆ InternalSaveIoWrite16ValueToBootScript()

UINT16 InternalSaveIoWrite16ValueToBootScript	(	IN UINTN	Port,
		IN UINT16	Value
	)

Saves a 16-bit I/O port value to the boot script.

This internal worker function saves a 16-bit I/O port value in the S3 script to be replayed on S3 resume.

If the saving process fails, then ASSERT().

Parameters

Port	The I/O port to write.
Value	The value saved to boot script.

Returns: Value.

Definition at line 419 of file S3IoLib.c.

◆ InternalSaveIoWrite32ValueToBootScript()

UINT32 InternalSaveIoWrite32ValueToBootScript	(	IN UINTN	Port,
		IN UINT32	Value
	)

Saves a 32-bit I/O port value to the boot script.

This internal worker function saves a 32-bit I/O port value in the S3 script to be replayed on S3 resume.

If the saving process fails, then ASSERT().

Parameters

Port	The I/O port to write.
Value	The value saved to boot script.

Returns: Value.

Definition at line 775 of file S3IoLib.c.

◆ InternalSaveIoWrite64ValueToBootScript()

UINT64 InternalSaveIoWrite64ValueToBootScript	(	IN UINTN	Port,
		IN UINT64	Value
	)

Saves a 64-bit I/O port value to the boot script.

This internal worker function saves a 64-bit I/O port value in the S3 script to be replayed on S3 resume.

If the saving process fails, then ASSERT().

Parameters

Port	The I/O port to write.
Value	The value saved to boot script.

Returns: Value.

Definition at line 1131 of file S3IoLib.c.

◆ InternalSaveIoWrite8ValueToBootScript()

UINT8 InternalSaveIoWrite8ValueToBootScript	(	IN UINTN	Port,
		IN UINT8	Value
	)

Saves an 8-bit I/O port value to the boot script.

This internal worker function saves an 8-bit I/O port value in the S3 script to be replayed on S3 resume.

If the saving process fails, then ASSERT().

Parameters

Port	The I/O port to write.
Value	The value saved to boot script.

Returns: Value.

Definition at line 64 of file S3IoLib.c.

◆ InternalSaveIoWriteValueToBootScript()

VOID InternalSaveIoWriteValueToBootScript	(	IN S3_BOOT_SCRIPT_LIB_WIDTH	Width,
		IN UINTN	Port,
		IN VOID *	Buffer
	)

Saves an I/O port value to the boot script.

This internal worker function saves an I/O port value in the S3 script to be replayed on S3 resume.

If the saving process fails, then ASSERT().

Parameters

Width	The width of I/O port.
Port	The I/O port to write.
Buffer	The buffer containing value.

Definition at line 32 of file S3IoLib.c.

◆ InternalSaveMmioWrite16ValueToBootScript()

UINT16 InternalSaveMmioWrite16ValueToBootScript	(	IN UINTN	Address,
		IN UINT16	Value
	)

Saves a 16-bit MMIO register value to the boot script.

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

If the saving process fails, then ASSERT().

Parameters

Address	The MMIO register to write.
Value	The value saved to boot script.

Returns: Value.

Definition at line 1875 of file S3IoLib.c.

◆ InternalSaveMmioWrite32ValueToBootScript()

UINT32 InternalSaveMmioWrite32ValueToBootScript	(	IN UINTN	Address,
		IN UINT32	Value
	)

Saves a 32-bit MMIO register value to the boot script.

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

If the saving process fails, then ASSERT().

Parameters

Address	The MMIO register to write.
Value	The value saved to boot script.

Returns: Value.

Definition at line 2233 of file S3IoLib.c.

◆ InternalSaveMmioWrite64ValueToBootScript()

UINT64 InternalSaveMmioWrite64ValueToBootScript	(	IN UINTN	Address,
		IN UINT64	Value
	)

Saves a 64-bit MMIO register value to the boot script.

This internal worker function saves a 64-bit MMIO register value in the S3 script to be replayed on S3 resume.

If the saving process fails, then ASSERT().

Parameters

Address	The MMIO register to write.
Value	The value saved to boot script.

Returns: Value.

Definition at line 2590 of file S3IoLib.c.

◆ InternalSaveMmioWrite8ValueToBootScript()

UINT8 InternalSaveMmioWrite8ValueToBootScript	(	IN UINTN	Address,
		IN UINT8	Value
	)

Saves an 8-bit MMIO register value to the boot script.

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

If the saving process fails, then ASSERT().

Parameters

Address	The MMIO register to write.
Value	The value saved to boot script.

Returns: Value.

Definition at line 1518 of file S3IoLib.c.

◆ InternalSaveMmioWriteValueToBootScript()

VOID InternalSaveMmioWriteValueToBootScript	(	IN S3_BOOT_SCRIPT_LIB_WIDTH	Width,
		IN UINTN	Address,
		IN VOID *	Buffer
	)

Saves an MMIO register value to the boot script.

This internal worker function saves an MMIO register value in the S3 script to be replayed on S3 resume.

If the saving process fails, then ASSERT().

Parameters

Width	The width of MMIO register.
Address	The MMIO register to write.
Buffer	The buffer containing value.

Definition at line 1486 of file S3IoLib.c.

◆ S3IoAnd16()

UINT16 EFIAPI S3IoAnd16	(	IN UINTN	Port,
		IN UINT16	AndData
	)

Reads a 16-bit I/O port, performs a bitwise AND, and writes the result back to the 16-bit I/O port and saves the value in the S3 script to be replayed on S3 resume.

Reads the 16-bit I/O port specified by Port, performs a bitwise AND between the read result and the value specified by AndData, and writes the result to the 16-bit I/O port specified by Port. The value written to the I/O port is returned. This function must guarantee that all I/O read and write operations are serialized.

If 16-bit I/O port operations are not supported, then ASSERT().

Parameters

Port	The I/O port to write.
AndData	The value to AND with the read value from the I/O port.

Returns: The value written back to the I/O port.

Definition at line 529 of file S3IoLib.c.

◆ S3IoAnd32()

UINT32 EFIAPI S3IoAnd32	(	IN UINTN	Port,
		IN UINT32	AndData
	)

Reads a 32-bit I/O port, performs a bitwise AND, and writes the result back to the 32-bit I/O port and saves the value in the S3 script to be replayed on S3 resume.

Reads the 32-bit I/O port specified by Port, performs a bitwise AND between the read result and the value specified by AndData, and writes the result to the 32-bit I/O port specified by Port. The value written to the I/O port is returned. This function must guarantee that all I/O read and write operations are serialized.

If 32-bit I/O port operations are not supported, then ASSERT().

Parameters

Port	The I/O port to write.
AndData	The value to AND with the read value from the I/O port.

Returns: The value written back to the I/O port.

Definition at line 885 of file S3IoLib.c.

◆ S3IoAnd64()

UINT64 EFIAPI S3IoAnd64	(	IN UINTN	Port,
		IN UINT64	AndData
	)

Reads a 64-bit I/O port, performs a bitwise AND, and writes the result back to the 64-bit I/O port and saves the value in the S3 script to be replayed on S3 resume.

Reads the 64-bit I/O port specified by Port, performs a bitwise AND between the read result and the value specified by AndData, and writes the result to the 64-bit I/O port specified by Port. The value written to the I/O port is returned. This function must guarantee that all I/O read and write operations are serialized.

If 64-bit I/O port operations are not supported, then ASSERT().

Parameters

Port	The I/O port to write.
AndData	The value to AND with the read value from the I/O port.

Returns: The value written back to the I/O port.

Definition at line 1241 of file S3IoLib.c.

◆ S3IoAnd8()

UINT8 EFIAPI S3IoAnd8	(	IN UINTN	Port,
		IN UINT8	AndData
	)

Reads an 8-bit I/O port, performs a bitwise AND, and writes the result back to the 8-bit I/O port and saves the value in the S3 script to be replayed on S3 resume.

Reads the 8-bit I/O port specified by Port, performs a bitwise AND between the read result and the value specified by AndData, and writes the result to the 8-bit I/O port specified by Port. The value written to the I/O port is returned. This function must guarantee that all I/O read and write operations are serialized.

If 8-bit I/O port operations are not supported, then ASSERT().

Parameters

Port	The I/O port to write.
AndData	The value to AND with the read value from the I/O port.

Returns: The value written back to the I/O port.

Definition at line 174 of file S3IoLib.c.

◆ S3IoAndThenOr16()

UINT16 EFIAPI S3IoAndThenOr16	(	IN UINTN	Port,
		IN UINT16	AndData,
		IN UINT16	OrData
	)

Reads a 16-bit I/O port, performs a bitwise AND followed by a bitwise inclusive OR, and writes the result back to the 16-bit I/O port and saves the value in the S3 script to be replayed on S3 resume.

Reads the 16-bit I/O port specified by Port, 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 I/O port specified by Port. The value written to the I/O port is returned. This function must guarantee that all I/O read and write operations are serialized.

If 16-bit I/O port operations are not supported, then ASSERT().

Parameters

Port	The I/O port to write.
AndData	The value to AND with the read value from the I/O port.
OrData	The value to OR with the result of the AND operation.

Returns: The value written back to the I/O port.

Definition at line 560 of file S3IoLib.c.

◆ S3IoAndThenOr32()

UINT32 EFIAPI S3IoAndThenOr32	(	IN UINTN	Port,
		IN UINT32	AndData,
		IN UINT32	OrData
	)

Reads a 32-bit I/O port, performs a bitwise AND followed by a bitwise inclusive OR, and writes the result back to the 32-bit I/O port and saves the value in the S3 script to be replayed on S3 resume.

Reads the 32-bit I/O port specified by Port, 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 I/O port specified by Port. The value written to the I/O port is returned. This function must guarantee that all I/O read and write operations are serialized.

If 32-bit I/O port operations are not supported, then ASSERT().

Parameters

Port	The I/O port to write.
AndData	The value to AND with the read value from the I/O port.
OrData	The value to OR with the result of the AND operation.

Returns: The value written back to the I/O port.

Definition at line 916 of file S3IoLib.c.

◆ S3IoAndThenOr64()

UINT64 EFIAPI S3IoAndThenOr64	(	IN UINTN	Port,
		IN UINT64	AndData,
		IN UINT64	OrData
	)

Reads a 64-bit I/O port, performs a bitwise AND followed by a bitwise inclusive OR, and writes the result back to the 64-bit I/O port and saves the value in the S3 script to be replayed on S3 resume.

Reads the 64-bit I/O port specified by Port, 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 64-bit I/O port specified by Port. The value written to the I/O port is returned. This function must guarantee that all I/O read and write operations are serialized.

If 64-bit I/O port operations are not supported, then ASSERT().

Parameters

Port	The I/O port to write.
AndData	The value to AND with the read value from the I/O port.
OrData	The value to OR with the result of the AND operation.

Returns: The value written back to the I/O port.

Definition at line 1272 of file S3IoLib.c.

◆ S3IoAndThenOr8()

UINT8 EFIAPI S3IoAndThenOr8	(	IN UINTN	Port,
		IN UINT8	AndData,
		IN UINT8	OrData
	)

Reads an 8-bit I/O port, performs a bitwise AND followed by a bitwise inclusive OR, and writes the result back to the 8-bit I/O port and saves the value in the S3 script to be replayed on S3 resume.

Reads the 8-bit I/O port specified by Port, 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 I/O port specified by Port. The value written to the I/O port is returned. This function must guarantee that all I/O read and write operations are serialized.

If 8-bit I/O port operations are not supported, then ASSERT().

Parameters

Port	The I/O port to write.
AndData	The value to AND with the read value from the I/O port.
OrData	The value to OR with the result of the AND operation.

Returns: The value written back to the I/O port.

Definition at line 205 of file S3IoLib.c.

◆ S3IoBitFieldAnd16()

UINT16 EFIAPI S3IoBitFieldAnd16	(	IN UINTN	Port,
		IN UINTN	StartBit,
		IN UINTN	EndBit,
		IN UINT16	AndData
	)

Reads a bit field in a 16-bit port, performs a bitwise AND, and 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 I/O port specified by Port, performs a bitwise AND between the read result and the value specified by AndData, and writes the result to the 16-bit I/O port specified by Port. The value written to the I/O port is returned. This function must guarantee that all I/O read and write operations are serialized. Extra left bits in AndData are stripped.

If 16-bit I/O port operations are not supported, 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

Port	The I/O port 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 read value from the I/O port.

Returns: The value written back to the I/O port.

Definition at line 706 of file S3IoLib.c.

◆ S3IoBitFieldAnd32()

UINT32 EFIAPI S3IoBitFieldAnd32	(	IN UINTN	Port,
		IN UINTN	StartBit,
		IN UINTN	EndBit,
		IN UINT32	AndData
	)

Reads a bit field in a 32-bit port, performs a bitwise AND, and 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 I/O port specified by Port, performs a bitwise AND between the read result and the value specified by AndData, and writes the result to the 32-bit I/O port specified by Port. The value written to the I/O port is returned. This function must guarantee that all I/O read and write operations are serialized. Extra left bits in AndData are stripped.

If 32-bit I/O port operations are not supported, 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

Port	The I/O port 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 read value from the I/O port.

Returns: The value written back to the I/O port.

Definition at line 1062 of file S3IoLib.c.

◆ S3IoBitFieldAnd64()

UINT64 EFIAPI S3IoBitFieldAnd64	(	IN UINTN	Port,
		IN UINTN	StartBit,
		IN UINTN	EndBit,
		IN UINT64	AndData
	)

Reads a bit field in a 64-bit port, performs a bitwise AND, and writes the result back to the bit field in the 64-bit port and saves the value in the S3 script to be replayed on S3 resume.

Reads the 64-bit I/O port specified by Port, performs a bitwise AND between the read result and the value specified by AndData, and writes the result to the 64-bit I/O port specified by Port. The value written to the I/O port is returned. This function must guarantee that all I/O read and write operations are serialized. Extra left bits in AndData are stripped.

If 64-bit I/O port operations are not supported, then ASSERT(). If StartBit is greater than 63, then ASSERT(). If EndBit is greater than 63, 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

Port	The I/O port to write.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..63.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..63.
AndData	The value to AND with the read value from the I/O port.

Returns: The value written back to the I/O port.

Definition at line 1418 of file S3IoLib.c.

◆ S3IoBitFieldAnd8()

UINT8 EFIAPI S3IoBitFieldAnd8	(	IN UINTN	Port,
		IN UINTN	StartBit,
		IN UINTN	EndBit,
		IN UINT8	AndData
	)

Reads a bit field in an 8-bit port, performs a bitwise AND, and 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 I/O port specified by Port, performs a bitwise AND between the read result and the value specified by AndData, and writes the result to the 8-bit I/O port specified by Port. The value written to the I/O port is returned. This function must guarantee that all I/O read and write operations are serialized. Extra left bits in AndData are stripped.

If 8-bit I/O port operations are not supported, 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

Port	The I/O port 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 read value from the I/O port.

Returns: The value written back to the I/O port.

Definition at line 351 of file S3IoLib.c.

◆ S3IoBitFieldAndThenOr16()

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

Reads the 16-bit I/O port specified by Port, 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 I/O port specified by Port. The value written to the I/O port is returned. This function must guarantee that all I/O read and write operations are serialized. Extra left bits in both AndData and OrData are stripped.

If 16-bit I/O port operations are not supported, 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

Port	The I/O port 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 read value from the I/O port.
OrData	The value to OR with the result of the AND operation.

Returns: The value written back to the I/O port.

Definition at line 749 of file S3IoLib.c.

◆ S3IoBitFieldAndThenOr32()

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

Reads the 32-bit I/O port specified by Port, 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 I/O port specified by Port. The value written to the I/O port is returned. This function must guarantee that all I/O read and write operations are serialized. Extra left bits in both AndData and OrData are stripped.

If 32-bit I/O port operations are not supported, 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

Port	The I/O port 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 read value from the I/O port.
OrData	The value to OR with the result of the AND operation.

Returns: The value written back to the I/O port.

Definition at line 1105 of file S3IoLib.c.

◆ S3IoBitFieldAndThenOr64()

UINT64 EFIAPI S3IoBitFieldAndThenOr64	(	IN UINTN	Port,
		IN UINTN	StartBit,
		IN UINTN	EndBit,
		IN UINT64	AndData,
		IN UINT64	OrData
	)

Reads a bit field in a 64-bit port, performs a bitwise AND followed by a bitwise OR, and writes the result back to the bit field in the 64-bit port and saves the value in the S3 script to be replayed on S3 resume.

Reads the 64-bit I/O port specified by Port, 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 64-bit I/O port specified by Port. The value written to the I/O port is returned. This function must guarantee that all I/O read and write operations are serialized. Extra left bits in both AndData and OrData are stripped.

If 64-bit I/O port operations are not supported, then ASSERT(). If StartBit is greater than 63, then ASSERT(). If EndBit is greater than 63, 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

Port	The I/O port to write.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..63.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..63.
AndData	The value to AND with the read value from the I/O port.
OrData	The value to OR with the result of the AND operation.

Returns: The value written back to the I/O port.

Definition at line 1461 of file S3IoLib.c.

◆ S3IoBitFieldAndThenOr8()

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

Reads the 8-bit I/O port specified by Port, 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 I/O port specified by Port. The value written to the I/O port is returned. This function must guarantee that all I/O read and write operations are serialized. Extra left bits in both AndData and OrData are stripped.

If 8-bit I/O port operations are not supported, 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

Port	The I/O port 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 read value from the I/O port.
OrData	The value to OR with the result of the AND operation.

Returns: The value written back to the I/O port.

Definition at line 393 of file S3IoLib.c.

◆ S3IoBitFieldOr16()

UINT16 EFIAPI S3IoBitFieldOr16	(	IN UINTN	Port,
		IN UINTN	StartBit,
		IN UINTN	EndBit,
		IN UINT16	OrData
	)

Reads a bit field in a 16-bit port, performs a bitwise OR, and 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 I/O port specified by Port, performs a bitwise OR between the read result and the value specified by OrData, and writes the result to the 16-bit I/O port specified by Port. The value written to the I/O port is returned. This function must guarantee that all I/O read and write operations are serialized. Extra left bits in OrData are stripped.

If 16-bit I/O port operations are not supported, 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

Port	The I/O port 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 read value from the I/O port.

Returns: The value written back to the I/O port.

Definition at line 667 of file S3IoLib.c.

◆ S3IoBitFieldOr32()

UINT32 EFIAPI S3IoBitFieldOr32	(	IN UINTN	Port,
		IN UINTN	StartBit,
		IN UINTN	EndBit,
		IN UINT32	OrData
	)

Reads a bit field in a 32-bit port, performs a bitwise OR, and 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 I/O port specified by Port, performs a bitwise OR between the read result and the value specified by OrData, and writes the result to the 32-bit I/O port specified by Port. The value written to the I/O port is returned. This function must guarantee that all I/O read and write operations are serialized. Extra left bits in OrData are stripped.

If 32-bit I/O port operations are not supported, 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

Port	The I/O port 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 read value from the I/O port.

Returns: The value written back to the I/O port.

Definition at line 1023 of file S3IoLib.c.

◆ S3IoBitFieldOr64()

UINT64 EFIAPI S3IoBitFieldOr64	(	IN UINTN	Port,
		IN UINTN	StartBit,
		IN UINTN	EndBit,
		IN UINT64	OrData
	)

Reads a bit field in a 64-bit port, performs a bitwise OR, and writes the result back to the bit field in the 64-bit port and saves the value in the S3 script to be replayed on S3 resume.

Reads the 64-bit I/O port specified by Port, performs a bitwise OR between the read result and the value specified by OrData, and writes the result to the 64-bit I/O port specified by Port. The value written to the I/O port is returned. This function must guarantee that all I/O read and write operations are serialized. Extra left bits in OrData are stripped.

If 64-bit I/O port operations are not supported, then ASSERT(). If StartBit is greater than 63, then ASSERT(). If EndBit is greater than 63, 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

Port	The I/O port to write.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..63.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..63.
OrData	The value to OR with the read value from the I/O port.

Returns: The value written back to the I/O port.

Definition at line 1379 of file S3IoLib.c.

◆ S3IoBitFieldOr8()

UINT8 EFIAPI S3IoBitFieldOr8	(	IN UINTN	Port,
		IN UINTN	StartBit,
		IN UINTN	EndBit,
		IN UINT8	OrData
	)

Reads a bit field in an 8-bit port, performs a bitwise OR, and 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 I/O port specified by Port, performs a bitwise OR between the read result and the value specified by OrData, and writes the result to the 8-bit I/O port specified by Port. The value written to the I/O port is returned. This function must guarantee that all I/O read and write operations are serialized. Extra left bits in OrData are stripped.

If 8-bit I/O port operations are not supported, 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

Port	The I/O port 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 read value from the I/O port.

Returns: The value written back to the I/O port.

Definition at line 312 of file S3IoLib.c.

◆ S3IoBitFieldRead16()

UINT16 EFIAPI S3IoBitFieldRead16	(	IN UINTN	Port,
		IN UINTN	StartBit,
		IN UINTN	EndBit
	)

Reads a bit field of an I/O register saves the value in the S3 script to be replayed on S3 resume.

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

If 16-bit I/O port operations are not supported, 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

Port	The I/O port 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 read.

Definition at line 592 of file S3IoLib.c.

◆ S3IoBitFieldRead32()

UINT32 EFIAPI S3IoBitFieldRead32	(	IN UINTN	Port,
		IN UINTN	StartBit,
		IN UINTN	EndBit
	)

Reads a bit field of an I/O register and saves the value in the S3 script to be replayed on S3 resume.

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

If 32-bit I/O port operations are not supported, 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

Port	The I/O port 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 read.

Definition at line 948 of file S3IoLib.c.

◆ S3IoBitFieldRead64()

UINT64 EFIAPI S3IoBitFieldRead64	(	IN UINTN	Port,
		IN UINTN	StartBit,
		IN UINTN	EndBit
	)

Reads a bit field of an I/O register and saves the value in the S3 script to be replayed on S3 resume.

Reads the bit field in a 64-bit I/O register. The bit field is specified by the StartBit and the EndBit. The value of the bit field is returned.

If 64-bit I/O port operations are not supported, then ASSERT(). If StartBit is greater than 63, then ASSERT(). If EndBit is greater than 63, then ASSERT(). If EndBit is less than StartBit, then ASSERT().

Parameters

Port	The I/O port to read.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..63.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..63.

Returns: The value read.

Definition at line 1304 of file S3IoLib.c.

◆ S3IoBitFieldRead8()

UINT8 EFIAPI S3IoBitFieldRead8	(	IN UINTN	Port,
		IN UINTN	StartBit,
		IN UINTN	EndBit
	)

Reads a bit field of an I/O register and saves the value in the S3 script to be replayed on S3 resume.

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

If 8-bit I/O port operations are not supported, 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

Port	The I/O port 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 read.

Definition at line 237 of file S3IoLib.c.

◆ S3IoBitFieldWrite16()

UINT16 EFIAPI S3IoBitFieldWrite16	(	IN UINTN	Port,
		IN UINTN	StartBit,
		IN UINTN	EndBit,
		IN UINT16	Value
	)

Writes a bit field to an I/O register and saves the value in the S3 script to be replayed on S3 resume.

Writes Value to the bit field of the I/O register. The bit field is specified by the StartBit and the EndBit. All other bits in the destination I/O register are preserved. The value written to the I/O port is returned. Extra left bits in Value are stripped.

If 16-bit I/O port operations are not supported, 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

Port	The I/O port 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 I/O port.

Definition at line 628 of file S3IoLib.c.

◆ S3IoBitFieldWrite32()

UINT32 EFIAPI S3IoBitFieldWrite32	(	IN UINTN	Port,
		IN UINTN	StartBit,
		IN UINTN	EndBit,
		IN UINT32	Value
	)

Writes a bit field to an I/O register and saves the value in the S3 script to be replayed on S3 resume.

Writes Value to the bit field of the I/O register. The bit field is specified by the StartBit and the EndBit. All other bits in the destination I/O register are preserved. The value written to the I/O port is returned. Extra left bits in Value are stripped.

If 32-bit I/O port operations are not supported, 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

Port	The I/O port 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 I/O port.

Definition at line 984 of file S3IoLib.c.

◆ S3IoBitFieldWrite64()

UINT64 EFIAPI S3IoBitFieldWrite64	(	IN UINTN	Port,
		IN UINTN	StartBit,
		IN UINTN	EndBit,
		IN UINT64	Value
	)

Writes a bit field to an I/O register and saves the value in the S3 script to be replayed on S3 resume.

Writes Value to the bit field of the I/O register. The bit field is specified by the StartBit and the EndBit. All other bits in the destination I/O register are preserved. The value written to the I/O port is returned. Extra left bits in Value are stripped.

If 64-bit I/O port operations are not supported, then ASSERT(). If StartBit is greater than 63, then ASSERT(). If EndBit is greater than 63, 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

Port	The I/O port to write.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..63.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..63.
Value	New value of the bit field.

Returns: The value written back to the I/O port.

Definition at line 1340 of file S3IoLib.c.

◆ S3IoBitFieldWrite8()

UINT8 EFIAPI S3IoBitFieldWrite8	(	IN UINTN	Port,
		IN UINTN	StartBit,
		IN UINTN	EndBit,
		IN UINT8	Value
	)

Writes a bit field to an I/O register and saves the value in the S3 script to be replayed on S3 resume.

Writes Value to the bit field of the I/O register. The bit field is specified by the StartBit and the EndBit. All other bits in the destination I/O register are preserved. The value written to the I/O port is returned. Extra left bits in Value are stripped.

If 8-bit I/O port operations are not supported, 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

Port	The I/O port 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 I/O port.

Definition at line 273 of file S3IoLib.c.

◆ S3IoOr16()

UINT16 EFIAPI S3IoOr16	(	IN UINTN	Port,
		IN UINT16	OrData
	)

Reads a 16-bit I/O port, performs a bitwise OR, and writes the result back to the 16-bit I/O port and saves the value in the S3 script to be replayed on S3 resume.

Reads the 16-bit I/O port specified by Port, performs a bitwise OR between the read result and the value specified by OrData, and writes the result to the 16-bit I/O port specified by Port. The value written to the I/O port is returned. This function must guarantee that all I/O read and write operations are serialized.

If 16-bit I/O port operations are not supported, then ASSERT().

Parameters

Port	The I/O port to write.
OrData	The value to OR with the read value from the I/O port.

Returns: The value written back to the I/O port.

Definition at line 500 of file S3IoLib.c.

◆ S3IoOr32()

UINT32 EFIAPI S3IoOr32	(	IN UINTN	Port,
		IN UINT32	OrData
	)

Reads a 32-bit I/O port, performs a bitwise OR, and writes the result back to the 32-bit I/O port and saves the value in the S3 script to be replayed on S3 resume.

Reads the 32-bit I/O port specified by Port, performs a bitwise OR between the read result and the value specified by OrData, and writes the result to the 32-bit I/O port specified by Port. The value written to the I/O port is returned. This function must guarantee that all I/O read and write operations are serialized.

If 32-bit I/O port operations are not supported, then ASSERT().

Parameters

Port	The I/O port to write.
OrData	The value to OR with the read value from the I/O port.

Returns: The value written back to the I/O port.

Definition at line 856 of file S3IoLib.c.

◆ S3IoOr64()

UINT64 EFIAPI S3IoOr64	(	IN UINTN	Port,
		IN UINT64	OrData
	)

Reads a 64-bit I/O port, performs a bitwise OR, and writes the result back to the 64-bit I/O port and saves the value in the S3 script to be replayed on S3 resume.

Reads the 64-bit I/O port specified by Port, performs a bitwise OR between the read result and the value specified by OrData, and writes the result to the 64-bit I/O port specified by Port. The value written to the I/O port is returned. This function must guarantee that all I/O read and write operations are serialized.

If 64-bit I/O port operations are not supported, then ASSERT().

Parameters

Port	The I/O port to write.
OrData	The value to OR with the read value from the I/O port.

Returns: The value written back to the I/O port.

Definition at line 1212 of file S3IoLib.c.

◆ S3IoOr8()

UINT8 EFIAPI S3IoOr8	(	IN UINTN	Port,
		IN UINT8	OrData
	)

Reads an 8-bit I/O port, performs a bitwise OR, and writes the result back to the 8-bit I/O port and saves the value in the S3 script to be replayed on S3 resume.

Reads the 8-bit I/O port specified by Port, performs a bitwise OR between the read result and the value specified by OrData, and writes the result to the 8-bit I/O port specified by Port. The value written to the I/O port is returned. This function must guarantee that all I/O read and write operations are serialized.

If 8-bit I/O port operations are not supported, then ASSERT().

Parameters

Port	The I/O port to write.
OrData	The value to OR with the read value from the I/O port.

Returns: The value written back to the I/O port.

Definition at line 145 of file S3IoLib.c.

◆ S3IoRead16()

UINT16 EFIAPI S3IoRead16 ( IN UINTN Port )

Reads a 16-bit I/O port and saves the value in the S3 script to be replayed on S3 resume.

Reads the 16-bit I/O port specified by Port. The 16-bit read value is returned. This function must guarantee that all I/O read and write operations are serialized.

If 16-bit I/O port operations are not supported, then ASSERT().

Parameters

Port	The I/O port to read.

Returns: The value read.

Definition at line 446 of file S3IoLib.c.

◆ S3IoRead32()

UINT32 EFIAPI S3IoRead32 ( IN UINTN Port )

Reads a 32-bit I/O port and saves the value in the S3 script to be replayed on S3 resume.

Reads the 32-bit I/O port specified by Port. The 32-bit read value is returned. This function must guarantee that all I/O read and write operations are serialized.

If 32-bit I/O port operations are not supported, then ASSERT().

Parameters

Port	The I/O port to read.

Returns: The value read.

Definition at line 802 of file S3IoLib.c.

◆ S3IoRead64()

UINT64 EFIAPI S3IoRead64 ( IN UINTN Port )

Reads a 64-bit I/O port and saves the value in the S3 script to be replayed on S3 resume.

Reads the 64-bit I/O port specified by Port. The 64-bit read value is returned. This function must guarantee that all I/O read and write operations are serialized.

If 64-bit I/O port operations are not supported, then ASSERT().

Parameters

Port	The I/O port to read.

Returns: The value read.

Definition at line 1158 of file S3IoLib.c.

◆ S3IoRead8()

UINT8 EFIAPI S3IoRead8 ( IN UINTN Port )

Reads an 8-bit I/O port and saves the value in the S3 script to be replayed on S3 resume.

Reads the 8-bit I/O port specified by Port. The 8-bit read value is returned. This function must guarantee that all I/O read and write operations are serialized.

If 8-bit I/O port operations are not supported, then ASSERT().

Parameters

Port	The I/O port to read.

Returns: The value read.

Definition at line 91 of file S3IoLib.c.

◆ S3IoWrite16()

UINT16 EFIAPI S3IoWrite16	(	IN UINTN	Port,
		IN UINT16	Value
	)

Writes a 16-bit I/O port and saves the value in the S3 script to be replayed on S3 resume.

Writes the 16-bit I/O port specified by Port with the value specified by Value and returns Value. This function must guarantee that all I/O read and write operations are serialized.

If 16-bit I/O port operations are not supported, then ASSERT().

Parameters

Port	The I/O port to write.
Value	The value to write to the I/O port.

Returns: The value written the I/O port.

Definition at line 471 of file S3IoLib.c.

◆ S3IoWrite32()

UINT32 EFIAPI S3IoWrite32	(	IN UINTN	Port,
		IN UINT32	Value
	)

Writes a 32-bit I/O port and saves the value in the S3 script to be replayed on S3 resume.

Writes the 32-bit I/O port specified by Port with the value specified by Value and returns Value. This function must guarantee that all I/O read and write operations are serialized.

If 32-bit I/O port operations are not supported, then ASSERT().

Parameters

Port	The I/O port to write.
Value	The value to write to the I/O port.

Returns: The value written the I/O port.

Definition at line 827 of file S3IoLib.c.

◆ S3IoWrite64()

UINT64 EFIAPI S3IoWrite64	(	IN UINTN	Port,
		IN UINT64	Value
	)

Writes a 64-bit I/O port and saves the value in the S3 script to be replayed on S3 resume.

Writes the 64-bit I/O port specified by Port with the value specified by Value and returns Value. This function must guarantee that all I/O read and write operations are serialized.

If 64-bit I/O port operations are not supported, then ASSERT().

Parameters

Port	The I/O port to write.
Value	The value to write to the I/O port.

Returns: The value written the I/O port.

Definition at line 1183 of file S3IoLib.c.

◆ S3IoWrite8()

UINT8 EFIAPI S3IoWrite8	(	IN UINTN	Port,
		IN UINT8	Value
	)

Writes an 8-bit I/O port and saves the value in the S3 script to be replayed on S3 resume.

Writes the 8-bit I/O port specified by Port with the value specified by Value and returns Value. This function must guarantee that all I/O read and write operations are serialized.

If 8-bit I/O port operations are not supported, then ASSERT().

Parameters

Port	The I/O port to write.
Value	The value to write to the I/O port.

Returns: The value written the I/O port.

Definition at line 116 of file S3IoLib.c.

◆ S3MmioAnd16()

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

Reads a 16-bit MMIO register, performs a bitwise AND, and writes the result back to the 16-bit MMIO register and saves the value in the S3 script to be replayed on S3 resume.

Reads the 16-bit MMIO 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 MMIO register specified by Address. The value written to the MMIO register is returned. This function must guarantee that all MMIO read and write operations are serialized.

If 16-bit MMIO register operations are not supported, then ASSERT().

Parameters

Address	The MMIO register to write.
AndData	The value to AND with the read value from the MMIO register.

Returns: The value written back to the MMIO register.

Definition at line 1986 of file S3IoLib.c.

◆ S3MmioAnd32()

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

Reads a 32-bit MMIO register, performs a bitwise AND, and writes the result back to the 32-bit MMIO register and saves the value in the S3 script to be replayed on S3 resume.

Reads the 32-bit MMIO 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 MMIO register specified by Address. The value written to the MMIO register is returned. This function must guarantee that all MMIO read and write operations are serialized.

If 32-bit MMIO register operations are not supported, then ASSERT().

Parameters

Address	The MMIO register to write.
AndData	The value to AND with the read value from the MMIO register.

Returns: The value written back to the MMIO register.

Definition at line 2343 of file S3IoLib.c.

◆ S3MmioAnd64()

UINT64 EFIAPI S3MmioAnd64	(	IN UINTN	Address,
		IN UINT64	AndData
	)

Reads a 64-bit MMIO register, performs a bitwise AND, and writes the result back to the 64-bit MMIO register and saves the value in the S3 script to be replayed on S3 resume.

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

If 64-bit MMIO register operations are not supported, then ASSERT().

Parameters

Address	The MMIO register to write.
AndData	The value to AND with the read value from the MMIO register.

Returns: The value written back to the MMIO register.

Definition at line 2700 of file S3IoLib.c.

◆ S3MmioAnd8()

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

Reads an 8-bit MMIO register, performs a bitwise AND, and writes the result back to the 8-bit MMIO register and saves the value in the S3 script to be replayed on S3 resume.

Reads the 8-bit MMIO 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 MMIO register specified by Address. The value written to the MMIO register is returned. This function must guarantee that all MMIO read and write operations are serialized.

If 8-bit MMIO register operations are not supported, then ASSERT().

Parameters

Address	The MMIO register to write.
AndData	The value to AND with the read value from the MMIO register.

Returns: The value written back to the MMIO register.

Definition at line 1628 of file S3IoLib.c.

◆ S3MmioAndThenOr16()

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

Reads a 16-bit MMIO register, performs a bitwise AND followed by a bitwise inclusive OR, and writes the result back to the 16-bit MMIO register and saves the value in the S3 script to be replayed on S3 resume.

Reads the 16-bit MMIO 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 MMIO register specified by Address. The value written to the MMIO register is returned. This function must guarantee that all MMIO read and write operations are serialized.

If 16-bit MMIO register operations are not supported, then ASSERT().

Parameters

Address	The MMIO register to write.
AndData	The value to AND with the read value from the MMIO register.
OrData	The value to OR with the result of the AND operation.

Returns: The value written back to the MMIO register.

Definition at line 2017 of file S3IoLib.c.

◆ S3MmioAndThenOr32()

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

Reads a 32-bit MMIO register, performs a bitwise AND followed by a bitwise inclusive OR, and writes the result back to the 32-bit MMIO register and saves the value in the S3 script to be replayed on S3 resume.

Reads the 32-bit MMIO 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 MMIO register specified by Address. The value written to the MMIO register is returned. This function must guarantee that all MMIO read and write operations are serialized.

If 32-bit MMIO register operations are not supported, then ASSERT().

Parameters

Address	The MMIO register to write.
AndData	The value to AND with the read value from the MMIO register.
OrData	The value to OR with the result of the AND operation.

Returns: The value written back to the MMIO register.

Definition at line 2374 of file S3IoLib.c.

◆ S3MmioAndThenOr64()

UINT64 EFIAPI S3MmioAndThenOr64	(	IN UINTN	Address,
		IN UINT64	AndData,
		IN UINT64	OrData
	)

Reads a 64-bit MMIO register, performs a bitwise AND followed by a bitwise inclusive OR, and writes the result back to the 64-bit MMIO register and saves the value in the S3 script to be replayed on S3 resume.

Reads the 64-bit MMIO 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 64-bit MMIO register specified by Address. The value written to the MMIO register is returned. This function must guarantee that all MMIO read and write operations are serialized.

If 64-bit MMIO register operations are not supported, then ASSERT().

Parameters

Address	The MMIO register to write.
AndData	The value to AND with the read value from the MMIO register.
OrData	The value to OR with the result of the AND operation.

Returns: The value written back to the MMIO register.

Definition at line 2731 of file S3IoLib.c.

◆ S3MmioAndThenOr8()

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

Reads an 8-bit MMIO register, performs a bitwise AND followed by a bitwise inclusive OR, and writes the result back to the 8-bit MMIO register and saves the value in the S3 script to be replayed on S3 resume.

Reads the 8-bit MMIO 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 MMIO register specified by Address. The value written to the MMIO register is returned. This function must guarantee that all MMIO read and write operations are serialized.

If 8-bit MMIO register operations are not supported, then ASSERT().

Parameters

Address	The MMIO register to write.
AndData	The value to AND with the read value from the MMIO register.
OrData	The value to OR with the result of the AND operation.

Returns: The value written back to the MMIO register.

Definition at line 1659 of file S3IoLib.c.

◆ S3MmioBitFieldAnd16()

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

Reads a bit field in a 16-bit MMIO register, performs a bitwise AND, and writes the result back to the bit field in the 16-bit MMIO register and saves the value in the S3 script to be replayed on S3 resume.

Reads the 16-bit MMIO 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 MMIO register specified by Address. The value written to the MMIO register is returned. This function must guarantee that all MMIO read and write operations are serialized. Extra left bits in AndData are stripped.

If 16-bit MMIO register operations are not supported, 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 MMIO 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 read value from the MMIO register.

Returns: The value written back to the MMIO register.

Definition at line 2164 of file S3IoLib.c.

◆ S3MmioBitFieldAnd32()

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

Reads a bit field in a 32-bit MMIO register, performs a bitwise AND, and writes the result back to the bit field in the 32-bit MMIO register and saves the value in the S3 script to be replayed on S3 resume.

Reads the 32-bit MMIO 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 MMIO register specified by Address. The value written to the MMIO register is returned. This function must guarantee that all MMIO read and write operations are serialized. Extra left bits in AndData are stripped.

If 32-bit MMIO register operations are not supported, 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 MMIO 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 read value from the MMIO register.

Returns: The value written back to the MMIO register.

Definition at line 2521 of file S3IoLib.c.

◆ S3MmioBitFieldAnd64()

UINT64 EFIAPI S3MmioBitFieldAnd64	(	IN UINTN	Address,
		IN UINTN	StartBit,
		IN UINTN	EndBit,
		IN UINT64	AndData
	)

Reads a bit field in a 64-bit MMIO register, performs a bitwise AND, and writes the result back to the bit field in the 64-bit MMIO register and saves the value in the S3 script to be replayed on S3 resume.

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

If 64-bit MMIO register operations are not supported, then ASSERT(). If StartBit is greater than 63, then ASSERT(). If EndBit is greater than 63, 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 MMIO register to write.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..63.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..63.
AndData	The value to AND with the read value from the MMIO register.

Returns: The value written back to the MMIO register.

Definition at line 2878 of file S3IoLib.c.

◆ S3MmioBitFieldAnd8()

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

Reads a bit field in an 8-bit MMIO register, performs a bitwise AND, and writes the result back to the bit field in the 8-bit MMIO register and saves the value in the S3 script to be replayed on S3 resume.

Reads the 8-bit MMIO 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 MMIO register specified by Address. The value written to the MMIO register is returned. This function must guarantee that all MMIO read and write operations are serialized. Extra left bits in AndData are stripped.

If 8-bit MMIO register operations are not supported, 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 MMIO 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 read value from the MMIO register.

Returns: The value written back to the MMIO register.

Definition at line 1806 of file S3IoLib.c.

◆ S3MmioBitFieldAndThenOr16()

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

Reads a bit field in a 16-bit MMIO register, performs a bitwise AND followed by a bitwise OR, and writes the result back to the bit field in the 16-bit MMIO register and saves the value in the S3 script to be replayed on S3 resume.

Reads the 16-bit MMIO 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 MMIO register specified by Address. The value written to the MMIO register is returned. This function must guarantee that all MMIO read and write operations are serialized. Extra left bits in both AndData and OrData are stripped.

If 16-bit MMIO register operations are not supported, 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 MMIO 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 read value from the MMIO register.
OrData	The value to OR with the result of the AND operation.

Returns: The value written back to the MMIO register.

Definition at line 2207 of file S3IoLib.c.

◆ S3MmioBitFieldAndThenOr32()

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

Reads a bit field in a 32-bit MMIO register, performs a bitwise AND followed by a bitwise OR, and writes the result back to the bit field in the 32-bit MMIO register and saves the value in the S3 script to be replayed on S3 resume.

Reads the 32-bit MMIO 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 MMIO register specified by Address. The value written to the MMIO register is returned. This function must guarantee that all MMIO read and write operations are serialized. Extra left bits in both AndData and OrData are stripped.

If 32-bit MMIO register operations are not supported, 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 MMIO 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 read value from the MMIO register.
OrData	The value to OR with the result of the AND operation.

Returns: The value written back to the MMIO register.

Definition at line 2564 of file S3IoLib.c.

◆ S3MmioBitFieldAndThenOr64()

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

Reads a bit field in a 64-bit MMIO register, performs a bitwise AND followed by a bitwise OR, and writes the result back to the bit field in the 64-bit MMIO register and saves the value in the S3 script to be replayed on S3 resume.

Reads the 64-bit MMIO 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 64-bit MMIO register specified by Address. The value written to the MMIO register is returned. This function must guarantee that all MMIO read and write operations are serialized. Extra left bits in both AndData and OrData are stripped.

If 64-bit MMIO register operations are not supported, then ASSERT(). If StartBit is greater than 63, then ASSERT(). If EndBit is greater than 63, 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 MMIO register to write.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..63.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..63.
AndData	The value to AND with the read value from the MMIO register.
OrData	The value to OR with the result of the AND operation.

Returns: The value written back to the MMIO register.

Definition at line 2921 of file S3IoLib.c.

◆ S3MmioBitFieldAndThenOr8()

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

Reads a bit field in an 8-bit MMIO register, performs a bitwise AND followed by a bitwise OR, and writes the result back to the bit field in the 8-bit MMIO register and saves the value in the S3 script to be replayed on S3 resume.

Reads the 8-bit MMIO 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 MMIO register specified by Address. The value written to the MMIO register is returned. This function must guarantee that all MMIO read and write operations are serialized. Extra left bits in both AndData and OrData are stripped.

If 8-bit MMIO register operations are not supported, 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 MMIO 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 read value from the MMIO register.
OrData	The value to OR with the result of the AND operation.

Returns: The value written back to the MMIO register.

Definition at line 1849 of file S3IoLib.c.

◆ S3MmioBitFieldOr16()

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

Reads a bit field in a 16-bit MMIO register, performs a bitwise OR, and writes the result back to the bit field in the 16-bit MMIO register and saves the value in the S3 script to be replayed on S3 resume.

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

If 16-bit MMIO register operations are not supported, 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 MMIO 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 read value from the MMIO register.

Returns: The value written back to the MMIO register.

Definition at line 2124 of file S3IoLib.c.

◆ S3MmioBitFieldOr32()

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

Reads a bit field in a 32-bit MMIO register, performs a bitwise OR, and writes the result back to the bit field in the 32-bit MMIO register and saves the value in the S3 script to be replayed on S3 resume.

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

If 32-bit MMIO register operations are not supported, 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 MMIO 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 read value from the MMIO register.

Returns: The value written back to the MMIO register.

Definition at line 2481 of file S3IoLib.c.

◆ S3MmioBitFieldOr64()

UINT64 EFIAPI S3MmioBitFieldOr64	(	IN UINTN	Address,
		IN UINTN	StartBit,
		IN UINTN	EndBit,
		IN UINT64	OrData
	)

Reads a bit field in a 64-bit MMIO register, performs a bitwise OR, and writes the result back to the bit field in the 64-bit MMIO register and saves the value in the S3 script to be replayed on S3 resume.

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

If 64-bit MMIO register operations are not supported, then ASSERT(). If StartBit is greater than 63, then ASSERT(). If EndBit is greater than 63, 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 MMIO register to write.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..63.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..63.
OrData	The value to OR with the read value from the MMIO register.

Returns: The value written back to the MMIO register.

Definition at line 2838 of file S3IoLib.c.

◆ S3MmioBitFieldOr8()

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

Reads a bit field in an 8-bit MMIO register, performs a bitwise OR, and writes the result back to the bit field in the 8-bit MMIO register and saves the value in the S3 script to be replayed on S3 resume.

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

If 8-bit MMIO register operations are not supported, 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 MMIO 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 read value from the MMIO register.

Returns: The value written back to the MMIO register.

Definition at line 1766 of file S3IoLib.c.

◆ S3MmioBitFieldRead16()

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

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

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

If 16-bit MMIO register operations are not supported, 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	MMIO 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 read.

Definition at line 2049 of file S3IoLib.c.

◆ S3MmioBitFieldRead32()

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

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

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

If 32-bit MMIO register operations are not supported, 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	MMIO 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 read.

Definition at line 2406 of file S3IoLib.c.

◆ S3MmioBitFieldRead64()

UINT64 EFIAPI S3MmioBitFieldRead64	(	IN UINTN	Address,
		IN UINTN	StartBit,
		IN UINTN	EndBit
	)

Reads a bit field of a MMIO register saves the value in the S3 script to be replayed on S3 resume.

Reads the bit field in a 64-bit MMIO register. The bit field is specified by the StartBit and the EndBit. The value of the bit field is returned.

If 64-bit MMIO register operations are not supported, then ASSERT(). If StartBit is greater than 63, then ASSERT(). If EndBit is greater than 63, then ASSERT(). If EndBit is less than StartBit, then ASSERT().

Parameters

Address	MMIO register to read.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..63.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..63.

Returns: The value read.

Definition at line 2763 of file S3IoLib.c.

◆ S3MmioBitFieldRead8()

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

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

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

If 8-bit MMIO register operations are not supported, 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	MMIO 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 read.

Definition at line 1691 of file S3IoLib.c.

◆ S3MmioBitFieldWrite16()

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

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

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

If 16-bit MMIO register operations are not supported, 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 MMIO 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 MMIO register.

Definition at line 2084 of file S3IoLib.c.

◆ S3MmioBitFieldWrite32()

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

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

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

If 32-bit MMIO register operations are not supported, 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 MMIO 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 MMIO register.

Definition at line 2441 of file S3IoLib.c.

◆ S3MmioBitFieldWrite64()

UINT64 EFIAPI S3MmioBitFieldWrite64	(	IN UINTN	Address,
		IN UINTN	StartBit,
		IN UINTN	EndBit,
		IN UINT64	Value
	)

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

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

If 64-bit MMIO register operations are not supported, then ASSERT(). If StartBit is greater than 63, then ASSERT(). If EndBit is greater than 63, 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 MMIO register to write.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..63.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..63.
Value	New value of the bit field.

Returns: The value written back to the MMIO register.

Definition at line 2798 of file S3IoLib.c.

◆ S3MmioBitFieldWrite8()

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

Writes a bit field to an MMIO register and saves the value in the S3 script to be replayed on S3 resume.

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

If 8-bit MMIO register operations are not supported, 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 MMIO 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 MMIO register.

Definition at line 1726 of file S3IoLib.c.

◆ S3MmioOr16()

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

Reads a 16-bit MMIO register, performs a bitwise OR, and writes the result back to the 16-bit MMIO register and saves the value in the S3 script to be replayed on S3 resume.

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

If 16-bit MMIO register operations are not supported, then ASSERT().

Parameters

Address	The MMIO register to write.
OrData	The value to OR with the read value from the MMIO register.

Returns: The value written back to the MMIO register.

Definition at line 1957 of file S3IoLib.c.

◆ S3MmioOr32()

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

Reads a 32-bit MMIO register, performs a bitwise OR, and writes the result back to the 32-bit MMIO register and saves the value in the S3 script to be replayed on S3 resume.

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

If 32-bit MMIO register operations are not supported, then ASSERT().

Parameters

Address	The MMIO register to write.
OrData	The value to OR with the read value from the MMIO register.

Returns: The value written back to the MMIO register.

Definition at line 2314 of file S3IoLib.c.

◆ S3MmioOr64()

UINT64 EFIAPI S3MmioOr64	(	IN UINTN	Address,
		IN UINT64	OrData
	)

Reads a 64-bit MMIO register, performs a bitwise OR, and writes the result back to the 64-bit MMIO register and saves the value in the S3 script to be replayed on S3 resume.

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

If 64-bit MMIO register operations are not supported, then ASSERT().

Parameters

Address	The MMIO register to write.
OrData	The value to OR with the read value from the MMIO register.

Returns: The value written back to the MMIO register.

Definition at line 2671 of file S3IoLib.c.

◆ S3MmioOr8()

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

Reads an 8-bit MMIO register, performs a bitwise OR, and writes the result back to the 8-bit MMIO register and saves the value in the S3 script to be replayed on S3 resume.

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

If 8-bit MMIO register operations are not supported, then ASSERT().

Parameters

Address	The MMIO register to write.
OrData	The value to OR with the read value from the MMIO register.

Returns: The value written back to the MMIO register.

Definition at line 1599 of file S3IoLib.c.

◆ S3MmioRead16()

UINT16 EFIAPI S3MmioRead16 ( IN UINTN Address )

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

Reads the 16-bit MMIO register specified by Address. The 16-bit read value is returned. This function must guarantee that all MMIO read and write operations are serialized.

If 16-bit MMIO register operations are not supported, then ASSERT().

Parameters

Address The MMIO register to read.

Returns: The value read.

Definition at line 1902 of file S3IoLib.c.

◆ S3MmioRead32()

UINT32 EFIAPI S3MmioRead32 ( IN UINTN Address )

Reads a 32-bit MMIO register saves the value in the S3 script to be replayed on S3 resume.

Reads the 32-bit MMIO register specified by Address. The 32-bit read value is returned. This function must guarantee that all MMIO read and write operations are serialized.

If 32-bit MMIO register operations are not supported, then ASSERT().

Parameters

Address The MMIO register to read.

Returns: The value read.

Definition at line 2260 of file S3IoLib.c.

◆ S3MmioRead64()

UINT64 EFIAPI S3MmioRead64 ( IN UINTN Address )

Reads a 64-bit MMIO register and saves the value in the S3 script to be replayed on S3 resume.

Reads the 64-bit MMIO register specified by Address. The 64-bit read value is returned. This function must guarantee that all MMIO read and write operations are serialized.

If 64-bit MMIO register operations are not supported, then ASSERT().

Parameters

Address The MMIO register to read.

Returns: The value read.

Definition at line 2617 of file S3IoLib.c.

◆ S3MmioRead8()

UINT8 EFIAPI S3MmioRead8 ( IN UINTN Address )

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

Reads the 8-bit MMIO register specified by Address. The 8-bit read value is returned. This function must guarantee that all MMIO read and write operations are serialized.

If 8-bit MMIO register operations are not supported, then ASSERT().

Parameters

Address The MMIO register to read.

Returns: The value read.

Definition at line 1545 of file S3IoLib.c.

◆ S3MmioReadBuffer16()

UINT16 *EFIAPI S3MmioReadBuffer16	(	IN UINTN	StartAddress,
		IN UINTN	Length,
		OUT UINT16 *	Buffer
	)

Copy data from MMIO region to system memory by using 16-bit access and saves the value in the S3 script to be replayed on S3 resume.

Copy data from MMIO region specified by starting address StartAddress to system memory specified by Buffer by using 16-bit access. The total number of byte to be copied is specified by Length. Buffer is returned.

If StartAddress is not aligned on a 16-bit boundary, then ASSERT().

If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().

If Length is not aligned on a 16-bit boundary, then ASSERT(). If Buffer is not aligned on a 16-bit boundary, then ASSERT().

Parameters

StartAddress	Starting address for the MMIO region to be copied from.
Length	Size in bytes of the copy.
Buffer	Pointer to a system memory buffer receiving the data read.

Returns: Buffer

Definition at line 3000 of file S3IoLib.c.

◆ S3MmioReadBuffer32()

UINT32 *EFIAPI S3MmioReadBuffer32	(	IN UINTN	StartAddress,
		IN UINTN	Length,
		OUT UINT32 *	Buffer
	)

Copy data from MMIO region to system memory by using 32-bit access and saves the value in the S3 script to be replayed on S3 resume.

Copy data from MMIO region specified by starting address StartAddress to system memory specified by Buffer by using 32-bit access. The total number of byte to be copied is specified by Length. Buffer is returned.

If StartAddress is not aligned on a 32-bit boundary, then ASSERT().

If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().

If Length is not aligned on a 32-bit boundary, then ASSERT(). If Buffer is not aligned on a 32-bit boundary, then ASSERT().

Parameters

StartAddress	Starting address for the MMIO region to be copied from.
Length	Size in bytes of the copy.
Buffer	Pointer to a system memory buffer receiving the data read.

Returns: Buffer

Definition at line 3047 of file S3IoLib.c.

◆ S3MmioReadBuffer64()

UINT64 *EFIAPI S3MmioReadBuffer64	(	IN UINTN	StartAddress,
		IN UINTN	Length,
		OUT UINT64 *	Buffer
	)

Copy data from MMIO region to system memory by using 64-bit access and saves the value in the S3 script to be replayed on S3 resume.

Copy data from MMIO region specified by starting address StartAddress to system memory specified by Buffer by using 64-bit access. The total number of byte to be copied is specified by Length. Buffer is returned.

If StartAddress is not aligned on a 64-bit boundary, then ASSERT().

If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().

If Length is not aligned on a 64-bit boundary, then ASSERT(). If Buffer is not aligned on a 64-bit boundary, then ASSERT().

Parameters

StartAddress	Starting address for the MMIO region to be copied from.
Length	Size in bytes of the copy.
Buffer	Pointer to a system memory buffer receiving the data read.

Returns: Buffer

Definition at line 3094 of file S3IoLib.c.

◆ S3MmioReadBuffer8()

UINT8 *EFIAPI S3MmioReadBuffer8	(	IN UINTN	StartAddress,
		IN UINTN	Length,
		OUT UINT8 *	Buffer
	)

Copy data from MMIO region to system memory by using 8-bit access and saves the value in the S3 script to be replayed on S3 resume.

Copy data from MMIO region specified by starting address StartAddress to system memory specified by Buffer by using 8-bit access. The total number of byte to be copied is specified by Length. Buffer is returned.

If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().

Parameters

StartAddress	Starting address for the MMIO region to be copied from.
Length	Size in bytes of the copy.
Buffer	Pointer to a system memory buffer receiving the data read.

Returns: Buffer

Definition at line 2953 of file S3IoLib.c.

◆ S3MmioWrite16()

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

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

Writes the 16-bit MMIO register specified by Address with the value specified by Value and returns Value. This function must guarantee that all MMIO read and write operations are serialized and saves the value in the S3 script to be replayed on S3 resume.

If 16-bit MMIO register operations are not supported, then ASSERT().

Parameters

Address	The MMIO register to write.
Value	The value to write to the MMIO register.

Returns: The value written the MMIO register.

Definition at line 1928 of file S3IoLib.c.

◆ S3MmioWrite32()

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

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

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

If 32-bit MMIO register operations are not supported, then ASSERT().

Parameters

Address	The MMIO register to write.
Value	The value to write to the MMIO register.

Returns: The value written the MMIO register.

Definition at line 2285 of file S3IoLib.c.

◆ S3MmioWrite64()

UINT64 EFIAPI S3MmioWrite64	(	IN UINTN	Address,
		IN UINT64	Value
	)

Writes a 64-bit MMIO register and saves the value in the S3 script to be replayed on S3 resume.

Writes the 64-bit MMIO register specified by Address with the value specified by Value and returns Value. This function must guarantee that all MMIO read and write operations are serialized.

If 64-bit MMIO register operations are not supported, then ASSERT().

Parameters

Address	The MMIO register to write.
Value	The value to write to the MMIO register.

Returns: The value written the MMIO register.

Definition at line 2642 of file S3IoLib.c.

◆ S3MmioWrite8()

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

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

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

If 8-bit MMIO register operations are not supported, then ASSERT().

Parameters

Address	The MMIO register to write.
Value	The value to write to the MMIO register.

Returns: The value written the MMIO register.

Definition at line 1570 of file S3IoLib.c.

◆ S3MmioWriteBuffer16()

UINT16 *EFIAPI S3MmioWriteBuffer16	(	IN UINTN	StartAddress,
		IN UINTN	Length,
		IN CONST UINT16 *	Buffer
	)

Copy data from system memory to MMIO region by using 16-bit access and saves the value in the S3 script to be replayed on S3 resume.

Copy data from system memory specified by Buffer to MMIO region specified by starting address StartAddress by using 16-bit access. The total number of byte to be copied is specified by Length. Buffer is returned.

If StartAddress is not aligned on a 16-bit boundary, then ASSERT().

If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS -Buffer + 1), then ASSERT().

If Length is not aligned on a 16-bit boundary, then ASSERT().

If Buffer is not aligned on a 16-bit boundary, then ASSERT().

Parameters

StartAddress	Starting address for the MMIO region to be copied to.
Length	Size in bytes of the copy.
Buffer	Pointer to a system memory buffer containing the data to write.

Returns: Buffer

Definition at line 3185 of file S3IoLib.c.

◆ S3MmioWriteBuffer32()

UINT32 *EFIAPI S3MmioWriteBuffer32	(	IN UINTN	StartAddress,
		IN UINTN	Length,
		IN CONST UINT32 *	Buffer
	)

Copy data from system memory to MMIO region by using 32-bit access and saves the value in the S3 script to be replayed on S3 resume.

Copy data from system memory specified by Buffer to MMIO region specified by starting address StartAddress by using 32-bit access. The total number of byte to be copied is specified by Length. Buffer is returned.

If StartAddress is not aligned on a 32-bit boundary, then ASSERT().

If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS -Buffer + 1), then ASSERT().

If Length is not aligned on a 32-bit boundary, then ASSERT().

If Buffer is not aligned on a 32-bit boundary, then ASSERT().

Parameters

StartAddress	Starting address for the MMIO region to be copied to.
Length	Size in bytes of the copy.
Buffer	Pointer to a system memory buffer containing the data to write.

Returns: Buffer

Definition at line 3233 of file S3IoLib.c.

◆ S3MmioWriteBuffer64()

UINT64 *EFIAPI S3MmioWriteBuffer64	(	IN UINTN	StartAddress,
		IN UINTN	Length,
		IN CONST UINT64 *	Buffer
	)

Copy data from system memory to MMIO region by using 64-bit access and saves the value in the S3 script to be replayed on S3 resume.

Copy data from system memory specified by Buffer to MMIO region specified by starting address StartAddress by using 64-bit access. The total number of byte to be copied is specified by Length. Buffer is returned.

If StartAddress is not aligned on a 64-bit boundary, then ASSERT().

If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS -Buffer + 1), then ASSERT().

If Length is not aligned on a 64-bit boundary, then ASSERT().

If Buffer is not aligned on a 64-bit boundary, then ASSERT().

Parameters

StartAddress	Starting address for the MMIO region to be copied to.
Length	Size in bytes of the copy.
Buffer	Pointer to a system memory buffer containing the data to write.

Returns: Buffer

Definition at line 3281 of file S3IoLib.c.

◆ S3MmioWriteBuffer8()

UINT8 *EFIAPI S3MmioWriteBuffer8	(	IN UINTN	StartAddress,
		IN UINTN	Length,
		IN CONST UINT8 *	Buffer
	)

Copy data from system memory to MMIO region by using 8-bit access and saves the value in the S3 script to be replayed on S3 resume.

Copy data from system memory specified by Buffer to MMIO region specified by starting address StartAddress by using 8-bit access. The total number of byte to be copied is specified by Length. Buffer is returned.

If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS -Buffer + 1), then ASSERT().

Parameters

StartAddress	Starting address for the MMIO region to be copied to.
Length	Size in bytes of the copy.
Buffer	Pointer to a system memory buffer containing the data to write.

Returns: Buffer

Definition at line 3137 of file S3IoLib.c.

Functions

Detailed Description

Function Documentation

◆ InternalSaveIoWrite16ValueToBootScript()

◆ InternalSaveIoWrite32ValueToBootScript()

◆ InternalSaveIoWrite64ValueToBootScript()

◆ InternalSaveIoWrite8ValueToBootScript()

◆ InternalSaveIoWriteValueToBootScript()

◆ InternalSaveMmioWrite16ValueToBootScript()

◆ InternalSaveMmioWrite32ValueToBootScript()

◆ InternalSaveMmioWrite64ValueToBootScript()

◆ InternalSaveMmioWrite8ValueToBootScript()

◆ InternalSaveMmioWriteValueToBootScript()

◆ S3IoAnd16()

◆ S3IoAnd32()

◆ S3IoAnd64()

◆ S3IoAnd8()

◆ S3IoAndThenOr16()

◆ S3IoAndThenOr32()

◆ S3IoAndThenOr64()

◆ S3IoAndThenOr8()

◆ S3IoBitFieldAnd16()

◆ S3IoBitFieldAnd32()

◆ S3IoBitFieldAnd64()

◆ S3IoBitFieldAnd8()

◆ S3IoBitFieldAndThenOr16()

◆ S3IoBitFieldAndThenOr32()

◆ S3IoBitFieldAndThenOr64()

◆ S3IoBitFieldAndThenOr8()

◆ S3IoBitFieldOr16()

◆ S3IoBitFieldOr32()

◆ S3IoBitFieldOr64()

◆ S3IoBitFieldOr8()

◆ S3IoBitFieldRead16()

◆ S3IoBitFieldRead32()

◆ S3IoBitFieldRead64()

◆ S3IoBitFieldRead8()

◆ S3IoBitFieldWrite16()

◆ S3IoBitFieldWrite32()

◆ S3IoBitFieldWrite64()

◆ S3IoBitFieldWrite8()

◆ S3IoOr16()

◆ S3IoOr32()

◆ S3IoOr64()

◆ S3IoOr8()

◆ S3IoRead16()

◆ S3IoRead32()

◆ S3IoRead64()

◆ S3IoRead8()

◆ S3IoWrite16()

◆ S3IoWrite32()

◆ S3IoWrite64()

◆ S3IoWrite8()

◆ S3MmioAnd16()

◆ S3MmioAnd32()

◆ S3MmioAnd64()

◆ S3MmioAnd8()

◆ S3MmioAndThenOr16()

◆ S3MmioAndThenOr32()

◆ S3MmioAndThenOr64()

◆ S3MmioAndThenOr8()

◆ S3MmioBitFieldAnd16()

◆ S3MmioBitFieldAnd32()

◆ S3MmioBitFieldAnd64()

◆ S3MmioBitFieldAnd8()

◆ S3MmioBitFieldAndThenOr16()

◆ S3MmioBitFieldAndThenOr32()

◆ S3MmioBitFieldAndThenOr64()

◆ S3MmioBitFieldAndThenOr8()

◆ S3MmioBitFieldOr16()

◆ S3MmioBitFieldOr32()

◆ S3MmioBitFieldOr64()

◆ S3MmioBitFieldOr8()

◆ S3MmioBitFieldRead16()

◆ S3MmioBitFieldRead32()

◆ S3MmioBitFieldRead64()

◆ S3MmioBitFieldRead8()

◆ S3MmioBitFieldWrite16()

◆ S3MmioBitFieldWrite32()

◆ S3MmioBitFieldWrite64()