EDK2 doxygen online documents - Firmware Encoding Index 1
EDK2 doxygen online documents - Firmware Encoding Index
Functions

MdePkg/Include/Library/S3IoLib.h File Reference

Go to the source code of this file.

Functions

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 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 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 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)
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 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 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 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 operation to be replayed during an S3 resume. This library class maps directly on top of the IoLib class.

Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.

This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Definition in file S3IoLib.h.


Function Documentation

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

Reads a 16-bit I/O port, performs a bitwise 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:
[in]PortThe I/O port to write.
[in]AndDataThe value to AND with the read value from the I/O port.
Returns:
The value written back to the I/O port.

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:
PortThe I/O port to write.
AndDataThe 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 532 of file S3IoLib.c.

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

Reads a 32-bit I/O port, performs a bitwise 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:
[in]PortThe I/O port to write.
[in]AndDataThe value to AND with the read value from the I/O port.
Returns:
The value written back to the I/O port.

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:
PortThe I/O port to write.
AndDataThe 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 883 of file S3IoLib.c.

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

Reads a 64-bit I/O port, performs a bitwise 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:
[in]PortThe I/O port to write.
[in]AndDataThe value to AND with the read value from the I/O port.
Returns:
The value written back to the I/O port.

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:
PortThe I/O port to write.
AndDataThe 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 1234 of file S3IoLib.c.

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

Reads an 8-bit I/O port, performs a bitwise 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:
[in]PortThe I/O port to write.
[in]AndDataThe value to AND with the read value from the I/O port.
Returns:
The value written back to the I/O port.

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:
PortThe I/O port to write.
AndDataThe 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 182 of file S3IoLib.c.

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, 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:
[in]PortThe I/O port to write.
[in]AndDataThe value to AND with the read value from the I/O port.
[in]OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the I/O port.

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:
PortThe I/O port to write.
AndDataThe value to AND with the read value from the I/O port.
OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the I/O port.

Definition at line 563 of file S3IoLib.c.

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, 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:
[in]PortThe I/O port to write.
[in]AndDataThe value to AND with the read value from the I/O port.
[in]OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the I/O port.

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:
PortThe I/O port to write.
AndDataThe value to AND with the read value from the I/O port.
OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the I/O port.

Definition at line 914 of file S3IoLib.c.

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, 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:
[in]PortThe I/O port to write.
[in]AndDataThe value to AND with the read value from the I/O port.
[in]OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the I/O port.

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:
PortThe I/O port to write.
AndDataThe value to AND with the read value from the I/O port.
OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the I/O port.

Definition at line 1265 of file S3IoLib.c.

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, 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:
[in]PortThe I/O port to write.
[in]AndDataThe value to AND with the read value from the I/O port.
[in]OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the I/O port.

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:
PortThe I/O port to write.
AndDataThe value to AND with the read value from the I/O port.
OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the I/O port.

Definition at line 213 of file S3IoLib.c.

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, 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().

Parameters:
[in]PortThe I/O port to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..15.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..15.
[in]AndDataThe value to AND with the read value from the I/O port.
Returns:
The value written back to the I/O port.

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().

Parameters:
PortThe I/O port to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..15.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..15.
AndDataThe 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.

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, 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().

Parameters:
[in]PortThe I/O port to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..31.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..31.
[in]AndDataThe value to AND with the read value from the I/O port.
Returns:
The value written back to the I/O port.

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().

Parameters:
PortThe I/O port to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..31.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..31.
AndDataThe 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 1057 of file S3IoLib.c.

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, 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().

Parameters:
[in]PortThe I/O port to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..63.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..63.
[in]AndDataThe value to AND with the read value from the I/O port.
Returns:
The value written back to the I/O port.

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().

Parameters:
PortThe I/O port to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..63.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..63.
AndDataThe 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 1408 of file S3IoLib.c.

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, 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().

Parameters:
[in]PortThe I/O port to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..7.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..7.
[in]AndDataThe value to AND with the read value from the I/O port.
Returns:
The value written back to the I/O port.

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().

Parameters:
PortThe I/O port to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..7.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..7.
AndDataThe 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 356 of file S3IoLib.c.

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, 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().

Parameters:
[in]PortThe I/O port to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..15.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..15.
[in]AndDataThe value to AND with the read value from the I/O port.
[in]OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the I/O port.

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().

Parameters:
PortThe I/O port to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..15.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..15.
AndDataThe value to AND with the read value from the I/O port.
OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the I/O port.

Definition at line 747 of file S3IoLib.c.

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, 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().

Parameters:
[in]PortThe I/O port to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..31.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..31.
[in]AndDataThe value to AND with the read value from the I/O port.
[in]OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the I/O port.

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().

Parameters:
PortThe I/O port to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..31.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..31.
AndDataThe value to AND with the read value from the I/O port.
OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the I/O port.

Definition at line 1098 of file S3IoLib.c.

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, 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().

Parameters:
[in]PortThe I/O port to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..63.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..63.
[in]AndDataThe value to AND with the read value from the I/O port.
[in]OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the I/O port.

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().

Parameters:
PortThe I/O port to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..63.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..63.
AndDataThe value to AND with the read value from the I/O port.
OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the I/O port.

Definition at line 1449 of file S3IoLib.c.

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, 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().

Parameters:
[in]PortThe I/O port to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..7.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..7.
[in]AndDataThe value to AND with the read value from the I/O port.
[in]OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the I/O port.

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().

Parameters:
PortThe I/O port to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..7.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..7.
AndDataThe value to AND with the read value from the I/O port.
OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the I/O port.

Definition at line 396 of file S3IoLib.c.

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, 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().

Parameters:
[in]PortThe I/O port to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..15.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..15.
[in]OrDataThe value to OR with the read value from the I/O port.
Returns:
The value written back to the I/O port.

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().

Parameters:
PortThe I/O port to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..15.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..15.
OrDataThe 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 668 of file S3IoLib.c.

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, 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().

Parameters:
[in]PortThe I/O port to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..31.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..31.
[in]OrDataThe value to OR with the read value from the I/O port.
Returns:
The value written back to the I/O port.

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().

Parameters:
PortThe I/O port to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..31.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..31.
OrDataThe 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 1019 of file S3IoLib.c.

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, 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().

Parameters:
[in]PortThe I/O port to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..63.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..63.
[in]OrDataThe value to OR with the read value from the I/O port.
Returns:
The value written back to the I/O port.

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().

Parameters:
PortThe I/O port to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..63.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..63.
OrDataThe 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 1370 of file S3IoLib.c.

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, 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().

Parameters:
[in]PortThe I/O port to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..7.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..7.
[in]OrDataThe value to OR with the read value from the I/O port.
Returns:
The value written back to the I/O port.

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().

Parameters:
PortThe I/O port to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..7.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..7.
OrDataThe 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 318 of file S3IoLib.c.

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:
[in]PortThe I/O port to read.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..15.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..15.
Returns:
The value read.

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:
PortThe I/O port to read.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..15.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..15.
Returns:
The value read.

Definition at line 595 of file S3IoLib.c.

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:
[in]PortThe I/O port to read.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..31.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..31.
Returns:
The value read.

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:
PortThe I/O port to read.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..31.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..31.
Returns:
The value read.

Definition at line 946 of file S3IoLib.c.

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:
[in]PortThe I/O port to read.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..63.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..63.
Returns:
The value read.

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:
PortThe I/O port to read.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..63.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..63.
Returns:
The value read.

Definition at line 1297 of file S3IoLib.c.

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:
[in]PortThe I/O port to read.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..7.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..7.
Returns:
The value read.

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:
PortThe I/O port to read.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..7.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..7.
Returns:
The value read.

Definition at line 245 of file S3IoLib.c.

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().

Parameters:
[in]PortThe I/O port to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..15.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..15.
[in]ValueNew value of the bit field.
Returns:
The value written back to the I/O port.

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().

Parameters:
PortThe I/O port to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..15.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..15.
ValueNew value of the bit field.
Returns:
The value written back to the I/O port.

Definition at line 630 of file S3IoLib.c.

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().

Parameters:
[in]PortThe I/O port to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..31.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..31.
[in]ValueNew value of the bit field.
Returns:
The value written back to the I/O port.

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().

Parameters:
PortThe I/O port to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..31.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..31.
ValueNew value of the bit field.
Returns:
The value written back to the I/O port.

Definition at line 981 of file S3IoLib.c.

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().

Parameters:
[in]PortThe I/O port to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..63.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..63.
[in]ValueNew value of the bit field.
Returns:
The value written back to the I/O port.

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().

Parameters:
PortThe I/O port to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..63.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..63.
ValueNew value of the bit field.
Returns:
The value written back to the I/O port.

Definition at line 1332 of file S3IoLib.c.

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. Remaining 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().

Parameters:
[in]PortThe I/O port to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..7.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..7.
[in]ValueNew value of the bit field.
Returns:
The value written back to the I/O port.

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().

Parameters:
PortThe I/O port to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..7.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..7.
ValueNew value of the bit field.
Returns:
The value written back to the I/O port.

Definition at line 280 of file S3IoLib.c.

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

Reads a 16-bit I/O port, performs a bitwise OR, 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:
[in]PortThe I/O port to write.
[in]OrDataThe value to OR with the read value from the I/O port.
Returns:
The value written back to the I/O port.

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:
PortThe I/O port to write.
OrDataThe 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 503 of file S3IoLib.c.

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

Reads a 32-bit I/O port, performs a bitwise OR, 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:
[in]PortThe I/O port to write.
[in]OrDataThe value to OR with the read value from the I/O port.
Returns:
The value written back to the I/O port.

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:
PortThe I/O port to write.
OrDataThe 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 854 of file S3IoLib.c.

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

Reads a 64-bit I/O port, performs a bitwise OR, 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:
[in]PortThe I/O port to write.
[in]OrDataThe value to OR with the read value from the I/O port.
Returns:
The value written back to the I/O port.

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:
PortThe I/O port to write.
OrDataThe 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 1205 of file S3IoLib.c.

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

Reads an 8-bit I/O port, performs a bitwise OR, 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:
[in]PortThe I/O port to write.
[in]OrDataThe value to OR with the read value from the I/O port.
Returns:
The value written back to the I/O port.

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:
PortThe I/O port to write.
OrDataThe 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 153 of file S3IoLib.c.

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:
[in]PortThe I/O port to read.
Returns:
The value read.

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:
PortThe I/O port to read.
Returns:
The value read.

Definition at line 449 of file S3IoLib.c.

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:
[in]PortThe I/O port to read.
Returns:
The value read.

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:
PortThe I/O port to read.
Returns:
The value read.

Definition at line 800 of file S3IoLib.c.

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:
[in]PortThe I/O port to read.
Returns:
The value read.

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:
PortThe I/O port to read.
Returns:
The value read.

Definition at line 1151 of file S3IoLib.c.

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:
[in]PortThe I/O port to read.
Returns:
The value read.

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:
PortThe I/O port to read.
Returns:
The value read.

Definition at line 99 of file S3IoLib.c.

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:
[in]PortThe I/O port to write.
[in]ValueThe value to write to the I/O port.
Returns:
The value written the I/O port.

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:
PortThe I/O port to write.
ValueThe value to write to the I/O port.
Returns:
The value written the I/O port.

Definition at line 474 of file S3IoLib.c.

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:
[in]PortThe I/O port to write.
[in]ValueThe value to write to the I/O port.
Returns:
The value written the I/O port.

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:
PortThe I/O port to write.
ValueThe value to write to the I/O port.
Returns:
The value written the I/O port.

Definition at line 825 of file S3IoLib.c.

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:
[in]PortThe I/O port to write.
[in]ValueThe value to write to the I/O port.
Returns:
The value written to the I/O port.

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:
PortThe I/O port to write.
ValueThe value to write to the I/O port.
Returns:
The value written the I/O port.

Definition at line 1176 of file S3IoLib.c.

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:
[in]PortThe I/O port to write.
[in]ValueThe value to write to the I/O port.
Returns:
The value written the I/O port.

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:
PortThe I/O port to write.
ValueThe value to write to the I/O port.
Returns:
The value written the I/O port.

Definition at line 124 of file S3IoLib.c.

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

Reads a 16-bit MMIO register, performs a bitwise 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:
[in]AddressThe MMIO register to write.
[in]AndDataThe value to AND with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

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:
AddressThe MMIO register to write.
AndDataThe value to AND with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

Definition at line 1969 of file S3IoLib.c.

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

Reads a 32-bit MMIO register, performs a bitwise 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:
[in]AddressThe MMIO register to write.
[in]AndDataThe value to AND with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

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:
AddressThe MMIO register to write.
AndDataThe value to AND with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

Definition at line 2321 of file S3IoLib.c.

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

Reads a 64-bit MMIO register, performs a bitwise 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:
[in]AddressThe MMIO register to write.
[in]AndDataThe value to AND with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

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:
AddressThe MMIO register to write.
AndDataThe value to AND with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

Definition at line 2673 of file S3IoLib.c.

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

Reads an 8-bit MMIO register, performs a bitwise 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:
[in]AddressThe MMIO register to write.
[in]AndDataThe value to AND with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

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:
AddressThe MMIO register to write.
AndDataThe value to AND with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

Definition at line 1616 of file S3IoLib.c.

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, 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:
[in]AddressThe MMIO register to write.
[in]AndDataThe value to AND with the read value from the MMIO register.
[in]OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the MMIO register.

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:
AddressThe MMIO register to write.
AndDataThe value to AND with the read value from the MMIO register.
OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the MMIO register.

Definition at line 2000 of file S3IoLib.c.

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, 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:
[in]AddressThe MMIO register to write.
[in]AndDataThe value to AND with the read value from the MMIO register.
[in]OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the MMIO register.

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:
AddressThe MMIO register to write.
AndDataThe value to AND with the read value from the MMIO register.
OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the MMIO register.

Definition at line 2352 of file S3IoLib.c.

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, 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:
[in]AddressThe MMIO register to write.
[in]AndDataThe value to AND with the read value from the MMIO register.
[in]OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the MMIO register.

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:
AddressThe MMIO register to write.
AndDataThe value to AND with the read value from the MMIO register.
OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the MMIO register.

Definition at line 2704 of file S3IoLib.c.

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, 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:
[in]AddressThe MMIO register to write.
[in]AndDataThe value to AND with the read value from the MMIO register.
[in]OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the MMIO register.

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:
AddressThe MMIO register to write.
AndDataThe value to AND with the read value from the MMIO register.
OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the MMIO register.

Definition at line 1647 of file S3IoLib.c.

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().

Parameters:
[in]AddressThe MMIO register to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..15.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..15.
[in]AndDataThe value to AND with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

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().

Parameters:
AddressThe MMIO register to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..15.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..15.
AndDataThe value to AND with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

Definition at line 2144 of file S3IoLib.c.

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().

Parameters:
[in]AddressThe MMIO register to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..31.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..31.
[in]AndDataThe value to AND with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

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().

Parameters:
AddressThe MMIO register to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..31.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..31.
AndDataThe value to AND with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

Definition at line 2496 of file S3IoLib.c.

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().

Parameters:
[in]AddressThe MMIO register to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..63.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..63.
[in]AndDataThe value to AND with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

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().

Parameters:
AddressThe MMIO register to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..63.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..63.
AndDataThe value to AND with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

Definition at line 2848 of file S3IoLib.c.

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().

Parameters:
[in]AddressThe MMIO register to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..7.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..7.
[in]AndDataThe value to AND with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

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().

Parameters:
AddressThe MMIO register to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..7.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..7.
AndDataThe value to AND with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

Definition at line 1791 of file S3IoLib.c.

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, 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().

Parameters:
[in]AddressThe MMIO register to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..15.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..15.
[in]AndDataThe value to AND with the read value from the MMIO register.
[in]OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the MMIO register.

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().

Parameters:
AddressThe MMIO register to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..15.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..15.
AndDataThe value to AND with the read value from the MMIO register.
OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the MMIO register.

Definition at line 2185 of file S3IoLib.c.

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, 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().

Parameters:
[in]AddressThe MMIO register to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..31.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..31.
[in]AndDataThe value to AND with the read value from the MMIO register.
[in]OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the MMIO register.

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().

Parameters:
AddressThe MMIO register to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..31.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..31.
AndDataThe value to AND with the read value from the MMIO register.
OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the MMIO register.

Definition at line 2537 of file S3IoLib.c.

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, 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().

Parameters:
[in]AddressThe MMIO register to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..63.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..63.
[in]AndDataThe value to AND with the read value from the MMIO register.
[in]OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the MMIO register.

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().

Parameters:
AddressThe MMIO register to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..63.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..63.
AndDataThe value to AND with the read value from the MMIO register.
OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the MMIO register.

Definition at line 2889 of file S3IoLib.c.

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, 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().

Parameters:
[in]AddressThe MMIO register to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..7.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..7.
[in]AndDataThe value to AND with the read value from the MMIO register.
[in]OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the MMIO register.

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().

Parameters:
AddressThe MMIO register to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..7.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..7.
AndDataThe value to AND with the read value from the MMIO register.
OrDataThe value to OR with the result of the AND operation.
Returns:
The value written back to the MMIO register.

Definition at line 1832 of file S3IoLib.c.

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, 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().

Parameters:
[in]AddressThe MMIO register to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..15.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..15.
[in]OrDataThe value to OR with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

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().

Parameters:
AddressThe MMIO register to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..15.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..15.
OrDataThe value to OR with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

Definition at line 2105 of file S3IoLib.c.

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, 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().

Parameters:
[in]AddressThe MMIO register to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..31.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..31.
[in]OrDataThe value to OR with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

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().

Parameters:
AddressThe MMIO register to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..31.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..31.
OrDataThe value to OR with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

Definition at line 2457 of file S3IoLib.c.

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, 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().

Parameters:
[in]AddressThe MMIO register to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..63.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..63.
[in]OrDataThe value to OR with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

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().

Parameters:
AddressThe MMIO register to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..63.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..63.
OrDataThe value to OR with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

Definition at line 2809 of file S3IoLib.c.

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, 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().

Parameters:
[in]AddressThe MMIO register to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..7.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..7.
[in]OrDataThe value to OR with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

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().

Parameters:
AddressThe MMIO register to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..7.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..7.
OrDataThe value to OR with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

Definition at line 1752 of file S3IoLib.c.

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:
[in]AddressMMIO register to read.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..15.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..15.
Returns:
The value read.

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:
AddressMMIO register to read.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..15.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..15.
Returns:
The value read.

Definition at line 2032 of file S3IoLib.c.

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:
[in]AddressMMIO register to read.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..31.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..31.
Returns:
The value read.

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:
AddressMMIO register to read.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..31.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..31.
Returns:
The value read.

Definition at line 2384 of file S3IoLib.c.

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:
[in]AddressMMIO register to read.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..63.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..63.
Returns:
The value read.

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:
AddressMMIO register to read.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..63.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..63.
Returns:
The value read.

Definition at line 2736 of file S3IoLib.c.

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:
[in]AddressMMIO register to read.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..7.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..7.
Returns:
The value read.

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:
AddressMMIO register to read.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..7.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..7.
Returns:
The value read.

Definition at line 1679 of file S3IoLib.c.

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().

Parameters:
[in]AddressThe MMIO register to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..15.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..15.
[in]ValueNew value of the bit field.
Returns:
The value written back to the MMIO register.

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().

Parameters:
AddressThe MMIO register to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..15.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..15.
ValueNew value of the bit field.
Returns:
The value written back to the MMIO register.

Definition at line 2066 of file S3IoLib.c.

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().

Parameters:
[in]AddressThe MMIO register to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..31.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..31.
[in]ValueNew value of the bit field.
Returns:
The value written back to the MMIO register.

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().

Parameters:
AddressThe MMIO register to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..31.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..31.
ValueNew value of the bit field.
Returns:
The value written back to the MMIO register.

Definition at line 2418 of file S3IoLib.c.

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().

Parameters:
[in]AddressThe MMIO register to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..63.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..63.
[in]ValueNew value of the bit field.
Returns:
The value written back to the MMIO register.

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().

Parameters:
AddressThe MMIO register to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..63.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..63.
ValueNew value of the bit field.
Returns:
The value written back to the MMIO register.

Definition at line 2770 of file S3IoLib.c.

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().

Parameters:
[in]AddressThe MMIO register to write.
[in]StartBitThe ordinal of the least significant bit in the bit field. Range 0..7.
[in]EndBitThe ordinal of the most significant bit in the bit field. Range 0..7.
[in]ValueNew value of the bit field.
Returns:
The value written back to the MMIO register.

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().

Parameters:
AddressThe MMIO register to write.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..7.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..7.
ValueNew value of the bit field.
Returns:
The value written back to the MMIO register.

Definition at line 1713 of file S3IoLib.c.

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

Reads a 16-bit MMIO register, performs a bitwise OR, 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:
[in]AddressThe MMIO register to write.
[in]OrDataThe value to OR with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

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:
AddressThe MMIO register to write.
OrDataThe value to OR with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

Definition at line 1940 of file S3IoLib.c.

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

Reads a 32-bit MMIO register, performs a bitwise OR, 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:
[in]AddressThe MMIO register to write.
[in]OrDataThe value to OR with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

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:
AddressThe MMIO register to write.
OrDataThe value to OR with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

Definition at line 2292 of file S3IoLib.c.

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

Reads a 64-bit MMIO register, performs a bitwise OR, 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:
[in]AddressThe MMIO register to write.
[in]OrDataThe value to OR with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

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:
AddressThe MMIO register to write.
OrDataThe value to OR with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

Definition at line 2644 of file S3IoLib.c.

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

Reads an 8-bit MMIO register, performs a bitwise OR, 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:
[in]AddressThe MMIO register to write.
[in]OrDataThe value to OR with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

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:
AddressThe MMIO register to write.
OrDataThe value to OR with the read value from the MMIO register.
Returns:
The value written back to the MMIO register.

Definition at line 1587 of file S3IoLib.c.

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:
[in]AddressThe MMIO register to read.
Returns:
The value read.

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:
AddressThe MMIO register to read.
Returns:
The value read.

Definition at line 1885 of file S3IoLib.c.

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:
[in]AddressThe MMIO register to read.
Returns:
The value read.

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:
AddressThe MMIO register to read.
Returns:
The value read.

Definition at line 2238 of file S3IoLib.c.

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:
[in]AddressThe MMIO register to read.
Returns:
The value read.

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:
AddressThe MMIO register to read.
Returns:
The value read.

Definition at line 2590 of file S3IoLib.c.

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:
[in]AddressThe MMIO register to read.
Returns:
The value read.

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:
AddressThe MMIO register to read.
Returns:
The value read.

Definition at line 1533 of file S3IoLib.c.

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

Copies 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 bytes 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:
[in]StartAddressStarting address for the MMIO region to be copied from.
[in]LengthSize in bytes of the copy.
[out]BufferPointer to a system memory buffer receiving the data read.
Returns:
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:
StartAddressStarting address for the MMIO region to be copied from.
LengthSize in bytes of the copy.
BufferPointer to a system memory buffer receiving the data read.
Returns:
Buffer

Definition at line 2968 of file S3IoLib.c.

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

Copies 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:
[in]StartAddressStarting address for the MMIO region to be copied from.
[in]LengthSize in bytes of the copy.
[out]BufferPointer to a system memory buffer receiving the data read.
Returns:
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:
StartAddressStarting address for the MMIO region to be copied from.
LengthSize in bytes of the copy.
BufferPointer to a system memory buffer receiving the data read.
Returns:
Buffer

Definition at line 3015 of file S3IoLib.c.

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

Copies 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:
[in]StartAddressStarting address for the MMIO region to be copied from.
[in]LengthSize in bytes of the copy.
[out]BufferPointer to a system memory buffer receiving the data read.
Returns:
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:
StartAddressStarting address for the MMIO region to be copied from.
LengthSize in bytes of the copy.
BufferPointer to a system memory buffer receiving the data read.
Returns:
Buffer

Definition at line 3062 of file S3IoLib.c.

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

Copies 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 bytes 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:
[in]StartAddressStarting address for the MMIO region to be copied from.
[in]LengthSize in bytes of the copy.
[out]BufferPointer to a system memory buffer receiving the data read.
Returns:
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:
StartAddressStarting address for the MMIO region to be copied from.
LengthSize in bytes of the copy.
BufferPointer to a system memory buffer receiving the data read.
Returns:
Buffer

Definition at line 2921 of file S3IoLib.c.

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:
[in]AddressThe MMIO register to write.
[in]ValueThe value to write to the MMIO register.
Returns:
The value written the MMIO register.

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:
AddressThe MMIO register to write.
ValueThe value to write to the MMIO register.
Returns:
The value written the MMIO register.

Definition at line 1911 of file S3IoLib.c.

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:
[in]AddressThe MMIO register to write.
[in]ValueThe value to write to the MMIO register.
Returns:
The value written the MMIO register.

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:
AddressThe MMIO register to write.
ValueThe value to write to the MMIO register.
Returns:
The value written the MMIO register.

Definition at line 2263 of file S3IoLib.c.

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:
[in]AddressThe MMIO register to write.
[in]ValueThe value to write to the MMIO register.
Returns:
The value written the MMIO register.

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:
AddressThe MMIO register to write.
ValueThe value to write to the MMIO register.
Returns:
The value written the MMIO register.

Definition at line 2615 of file S3IoLib.c.

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:
[in]AddressThe MMIO register to write.
[in]ValueThe value to write to the MMIO register.
Returns:
The value written the MMIO register.

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:
AddressThe MMIO register to write.
ValueThe value to write to the MMIO register.
Returns:
The value written the MMIO register.

Definition at line 1558 of file S3IoLib.c.

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

Copies 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 bytes 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:
[in]StartAddressStarting address for the MMIO region to be copied to.
[in]LengthSize in bytes of the copy.
[in]BufferPointer to a system memory buffer containing the data to write.
Returns:
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:
StartAddressStarting address for the MMIO region to be copied to.
LengthSize in bytes of the copy.
BufferPointer to a system memory buffer containing the data to write.
Returns:
Buffer

Definition at line 3154 of file S3IoLib.c.

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

Copies 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 bytes 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:
[in]StartAddressStarting address for the MMIO region to be copied to.
[in]LengthSize in bytes of the copy.
[in]BufferPointer to a system memory buffer containing the data to write.
Returns:
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:
StartAddressStarting address for the MMIO region to be copied to.
LengthSize in bytes of the copy.
BufferPointer to a system memory buffer containing the data to write.
Returns:
Buffer

Definition at line 3203 of file S3IoLib.c.

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

Copies 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 bytes 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:
[in]StartAddressStarting address for the MMIO region to be copied to.
[in]LengthSize in bytes of the copy.
[in]BufferPointer to a system memory buffer containing the data to write.
Returns:
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:
StartAddressStarting address for the MMIO region to be copied to.
LengthSize in bytes of the copy.
BufferPointer to a system memory buffer containing the data to write.
Returns:
Buffer

Definition at line 3251 of file S3IoLib.c.

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

Copies 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:
[in]StartAddressStarting address for the MMIO region to be copied to.
[in]LengthSize in bytes of the copy.
[in]BufferPointer to a system memory buffer containing the data to write.
Returns:
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:
StartAddressStarting address for the MMIO region to be copied to.
LengthSize in bytes of the copy.
BufferPointer to a system memory buffer containing the data to write.
Returns:
Buffer

Definition at line 3106 of file S3IoLib.c.

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines