TianoCore EDK2 master
Loading...
Searching...
No Matches
IoHighLevel.c File Reference

Go to the source code of this file.

Functions

UINT8 EFIAPI IoOr8 (IN UINTN Port, IN UINT8 OrData)
 
UINT8 EFIAPI IoAnd8 (IN UINTN Port, IN UINT8 AndData)
 
UINT8 EFIAPI IoAndThenOr8 (IN UINTN Port, IN UINT8 AndData, IN UINT8 OrData)
 
UINT8 EFIAPI IoBitFieldRead8 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit)
 
UINT8 EFIAPI IoBitFieldWrite8 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT8 Value)
 
UINT8 EFIAPI IoBitFieldOr8 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT8 OrData)
 
UINT8 EFIAPI IoBitFieldAnd8 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT8 AndData)
 
UINT8 EFIAPI IoBitFieldAndThenOr8 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT8 AndData, IN UINT8 OrData)
 
UINT16 EFIAPI IoOr16 (IN UINTN Port, IN UINT16 OrData)
 
UINT16 EFIAPI IoAnd16 (IN UINTN Port, IN UINT16 AndData)
 
UINT16 EFIAPI IoAndThenOr16 (IN UINTN Port, IN UINT16 AndData, IN UINT16 OrData)
 
UINT16 EFIAPI IoBitFieldRead16 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit)
 
UINT16 EFIAPI IoBitFieldWrite16 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT16 Value)
 
UINT16 EFIAPI IoBitFieldOr16 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT16 OrData)
 
UINT16 EFIAPI IoBitFieldAnd16 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT16 AndData)
 
UINT16 EFIAPI IoBitFieldAndThenOr16 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT16 AndData, IN UINT16 OrData)
 
UINT32 EFIAPI IoOr32 (IN UINTN Port, IN UINT32 OrData)
 
UINT32 EFIAPI IoAnd32 (IN UINTN Port, IN UINT32 AndData)
 
UINT32 EFIAPI IoAndThenOr32 (IN UINTN Port, IN UINT32 AndData, IN UINT32 OrData)
 
UINT32 EFIAPI IoBitFieldRead32 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit)
 
UINT32 EFIAPI IoBitFieldWrite32 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT32 Value)
 
UINT32 EFIAPI IoBitFieldOr32 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT32 OrData)
 
UINT32 EFIAPI IoBitFieldAnd32 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT32 AndData)
 
UINT32 EFIAPI IoBitFieldAndThenOr32 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT32 AndData, IN UINT32 OrData)
 
UINT64 EFIAPI IoOr64 (IN UINTN Port, IN UINT64 OrData)
 
UINT64 EFIAPI IoAnd64 (IN UINTN Port, IN UINT64 AndData)
 
UINT64 EFIAPI IoAndThenOr64 (IN UINTN Port, IN UINT64 AndData, IN UINT64 OrData)
 
UINT64 EFIAPI IoBitFieldRead64 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit)
 
UINT64 EFIAPI IoBitFieldWrite64 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT64 Value)
 
UINT64 EFIAPI IoBitFieldOr64 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT64 OrData)
 
UINT64 EFIAPI IoBitFieldAnd64 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT64 AndData)
 
UINT64 EFIAPI IoBitFieldAndThenOr64 (IN UINTN Port, IN UINTN StartBit, IN UINTN EndBit, IN UINT64 AndData, IN UINT64 OrData)
 
UINT8 EFIAPI MmioOr8 (IN UINTN Address, IN UINT8 OrData)
 
UINT8 EFIAPI MmioAnd8 (IN UINTN Address, IN UINT8 AndData)
 
UINT8 EFIAPI MmioAndThenOr8 (IN UINTN Address, IN UINT8 AndData, IN UINT8 OrData)
 
UINT8 EFIAPI MmioBitFieldRead8 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit)
 
UINT8 EFIAPI MmioBitFieldWrite8 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT8 Value)
 
UINT8 EFIAPI MmioBitFieldOr8 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT8 OrData)
 
UINT8 EFIAPI MmioBitFieldAnd8 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT8 AndData)
 
UINT8 EFIAPI MmioBitFieldAndThenOr8 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT8 AndData, IN UINT8 OrData)
 
UINT16 EFIAPI MmioOr16 (IN UINTN Address, IN UINT16 OrData)
 
UINT16 EFIAPI MmioAnd16 (IN UINTN Address, IN UINT16 AndData)
 
UINT16 EFIAPI MmioAndThenOr16 (IN UINTN Address, IN UINT16 AndData, IN UINT16 OrData)
 
UINT16 EFIAPI MmioBitFieldRead16 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit)
 
UINT16 EFIAPI MmioBitFieldWrite16 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT16 Value)
 
UINT16 EFIAPI MmioBitFieldOr16 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT16 OrData)
 
UINT16 EFIAPI MmioBitFieldAnd16 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT16 AndData)
 
UINT16 EFIAPI MmioBitFieldAndThenOr16 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT16 AndData, IN UINT16 OrData)
 
UINT32 EFIAPI MmioOr32 (IN UINTN Address, IN UINT32 OrData)
 
UINT32 EFIAPI MmioAnd32 (IN UINTN Address, IN UINT32 AndData)
 
UINT32 EFIAPI MmioAndThenOr32 (IN UINTN Address, IN UINT32 AndData, IN UINT32 OrData)
 
UINT32 EFIAPI MmioBitFieldRead32 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit)
 
UINT32 EFIAPI MmioBitFieldWrite32 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT32 Value)
 
UINT32 EFIAPI MmioBitFieldOr32 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT32 OrData)
 
UINT32 EFIAPI MmioBitFieldAnd32 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT32 AndData)
 
UINT32 EFIAPI MmioBitFieldAndThenOr32 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT32 AndData, IN UINT32 OrData)
 
UINT64 EFIAPI MmioOr64 (IN UINTN Address, IN UINT64 OrData)
 
UINT64 EFIAPI MmioAnd64 (IN UINTN Address, IN UINT64 AndData)
 
UINT64 EFIAPI MmioAndThenOr64 (IN UINTN Address, IN UINT64 AndData, IN UINT64 OrData)
 
UINT64 EFIAPI MmioBitFieldRead64 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit)
 
UINT64 EFIAPI MmioBitFieldWrite64 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT64 Value)
 
UINT64 EFIAPI MmioBitFieldOr64 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT64 OrData)
 
UINT64 EFIAPI MmioBitFieldAnd64 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT64 AndData)
 
UINT64 EFIAPI MmioBitFieldAndThenOr64 (IN UINTN Address, IN UINTN StartBit, IN UINTN EndBit, IN UINT64 AndData, IN UINT64 OrData)
 

Detailed Description

High-level Io/Mmio functions.

All assertions for bit field operations are handled bit field functions in the Base Library.

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

Definition in file IoHighLevel.c.

Function Documentation

◆ IoAnd16()

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

Reads a 16-bit I/O port, performs a bitwise AND, and writes the result back to the 16-bit I/O port.

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(). If Port is not aligned on a 16-bit boundary, 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 353 of file IoHighLevel.c.

◆ IoAnd32()

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

Reads a 32-bit I/O port, performs a bitwise AND, and writes the result back to the 32-bit I/O port.

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(). If Port is not aligned on a 32-bit boundary, 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 646 of file IoHighLevel.c.

◆ IoAnd64()

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

Reads a 64-bit I/O port, performs a bitwise AND, and writes the result back to the 64-bit I/O port.

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(). If Port is not aligned on a 64-bit boundary, 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 939 of file IoHighLevel.c.

◆ IoAnd8()

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

Reads an 8-bit I/O port, performs a bitwise AND, and writes the result back to the 8-bit I/O port.

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 67 of file IoHighLevel.c.

◆ IoAndThenOr16()

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

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

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(). If Port is not aligned on a 16-bit boundary, 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 384 of file IoHighLevel.c.

◆ IoAndThenOr32()

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

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

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(). If Port is not aligned on a 32-bit boundary, 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 677 of file IoHighLevel.c.

◆ IoAndThenOr64()

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

Reads a 64-bit I/O port, performs a bitwise AND followed by a bitwise OR, and writes the result back to the 64-bit I/O port.

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(). If Port is not aligned on a 64-bit boundary, 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 970 of file IoHighLevel.c.

◆ IoAndThenOr8()

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

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

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 97 of file IoHighLevel.c.

◆ IoBitFieldAnd16()

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

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

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 Port is not aligned on a 16-bit boundary, then ASSERT(). If StartBit is greater than 15, then ASSERT(). If EndBit is greater than 15, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters
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 536 of file IoHighLevel.c.

◆ IoBitFieldAnd32()

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

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

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 Port is not aligned on a 32-bit boundary, then ASSERT(). If StartBit is greater than 31, then ASSERT(). If EndBit is greater than 31, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters
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 829 of file IoHighLevel.c.

◆ IoBitFieldAnd64()

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

Reads a bit field in a 64-bit port, performs a bitwise AND, and writes the result back to the bit field in the 64-bit port.

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 Port is not aligned on a 64-bit boundary, then ASSERT(). If StartBit is greater than 63, then ASSERT(). If EndBit is greater than 63, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters
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 1122 of file IoHighLevel.c.

◆ IoBitFieldAnd8()

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

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

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

If 8-bit I/O port operations are not supported, then ASSERT(). If StartBit is greater than 7, then ASSERT(). If EndBit is greater than 7, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters
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 244 of file IoHighLevel.c.

◆ IoBitFieldAndThenOr16()

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

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

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 Port is not aligned on a 16-bit boundary, then ASSERT(). If StartBit is greater than 15, then ASSERT(). If EndBit is greater than 15, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT(). If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters
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 582 of file IoHighLevel.c.

◆ IoBitFieldAndThenOr32()

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

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

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 Port is not aligned on a 32-bit boundary, then ASSERT(). If StartBit is greater than 31, then ASSERT(). If EndBit is greater than 31, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT(). If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters
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 875 of file IoHighLevel.c.

◆ IoBitFieldAndThenOr64()

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

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

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 Port is not aligned on a 64-bit boundary, then ASSERT(). If StartBit is greater than 63, then ASSERT(). If EndBit is greater than 63, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT(). If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters
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 1168 of file IoHighLevel.c.

◆ IoBitFieldAndThenOr8()

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

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

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

If 8-bit I/O port operations are not supported, then ASSERT(). If StartBit is greater than 7, then ASSERT(). If EndBit is greater than 7, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT(). If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters
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 289 of file IoHighLevel.c.

◆ IoBitFieldOr16()

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

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

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 Port is not aligned on a 16-bit boundary, then ASSERT(). If StartBit is greater than 15, then ASSERT(). If EndBit is greater than 15, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters
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 494 of file IoHighLevel.c.

◆ IoBitFieldOr32()

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

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

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 Port is not aligned on a 32-bit boundary, then ASSERT(). If StartBit is greater than 31, then ASSERT(). If EndBit is greater than 31, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters
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 787 of file IoHighLevel.c.

◆ IoBitFieldOr64()

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

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

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 Port is not aligned on a 64-bit boundary, then ASSERT(). If StartBit is greater than 63, then ASSERT(). If EndBit is greater than 63, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters
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 1080 of file IoHighLevel.c.

◆ IoBitFieldOr8()

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

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

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

If 8-bit I/O port operations are not supported, then ASSERT(). If StartBit is greater than 7, then ASSERT(). If EndBit is greater than 7, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters
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 203 of file IoHighLevel.c.

◆ IoBitFieldRead16()

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

Reads a bit field of an I/O register.

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 Port is not aligned on a 16-bit boundary, then ASSERT(). If StartBit is greater than 15, then ASSERT(). If EndBit is greater than 15, then ASSERT(). If EndBit is less than StartBit, then ASSERT().

Parameters
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 416 of file IoHighLevel.c.

◆ IoBitFieldRead32()

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

Reads a bit field of an I/O register.

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 Port is not aligned on a 32-bit boundary, then ASSERT(). If StartBit is greater than 31, then ASSERT(). If EndBit is greater than 31, then ASSERT(). If EndBit is less than StartBit, then ASSERT().

Parameters
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 709 of file IoHighLevel.c.

◆ IoBitFieldRead64()

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

Reads a bit field of an I/O register.

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 Port is not aligned on a 64-bit boundary, 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 1002 of file IoHighLevel.c.

◆ IoBitFieldRead8()

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

Reads a bit field of an I/O register.

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 128 of file IoHighLevel.c.

◆ IoBitFieldWrite16()

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

Writes a bit field to an I/O register.

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 Port is not aligned on a 16-bit boundary, then ASSERT(). If StartBit is greater than 15, then ASSERT(). If EndBit is greater than 15, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters
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.
ValueThe new value of the bit field.
Returns
The value written back to the I/O port.

Definition at line 452 of file IoHighLevel.c.

◆ IoBitFieldWrite32()

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

Writes a bit field to an I/O register.

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 Port is not aligned on a 32-bit boundary, then ASSERT(). If StartBit is greater than 31, then ASSERT(). If EndBit is greater than 31, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters
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.
ValueThe new value of the bit field.
Returns
The value written back to the I/O port.

Definition at line 745 of file IoHighLevel.c.

◆ IoBitFieldWrite64()

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

Writes a bit field to an I/O register.

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 Port is not aligned on a 64-bit boundary, then ASSERT(). If StartBit is greater than 63, then ASSERT(). If EndBit is greater than 63, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters
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.
ValueThe new value of the bit field.
Returns
The value written back to the I/O port.

Definition at line 1038 of file IoHighLevel.c.

◆ IoBitFieldWrite8()

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

Writes a bit field to an I/O register.

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.

If 8-bit I/O port operations are not supported, then ASSERT(). If StartBit is greater than 7, then ASSERT(). If EndBit is greater than 7, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters
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.
ValueThe new value of the bit field.
Returns
The value written back to the I/O port.

Definition at line 162 of file IoHighLevel.c.

◆ IoOr16()

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

Reads a 16-bit I/O port, performs a bitwise OR, and writes the result back to the 16-bit I/O port.

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(). If Port is not aligned on a 16-bit boundary, 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 324 of file IoHighLevel.c.

◆ IoOr32()

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

Reads a 32-bit I/O port, performs a bitwise OR, and writes the result back to the 32-bit I/O port.

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(). If Port is not aligned on a 32-bit boundary, 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 617 of file IoHighLevel.c.

◆ IoOr64()

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

Reads a 64-bit I/O port, performs a bitwise OR, and writes the result back to the 64-bit I/O port.

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(). If Port is not aligned on a 64-bit boundary, 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 910 of file IoHighLevel.c.

◆ IoOr8()

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

Reads an 8-bit I/O port, performs a bitwise OR, and writes the result back to the 8-bit I/O port.

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 39 of file IoHighLevel.c.

◆ MmioAnd16()

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

Reads a 16-bit MMIO register, performs a bitwise AND, and writes the result back to the 16-bit MMIO register.

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(). If Address is not aligned on a 16-bit boundary, 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 1519 of file IoHighLevel.c.

◆ MmioAnd32()

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

Reads a 32-bit MMIO register, performs a bitwise AND, and writes the result back to the 32-bit MMIO register.

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(). If Address is not aligned on a 32-bit boundary, 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 1813 of file IoHighLevel.c.

◆ MmioAnd64()

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

Reads a 64-bit MMIO register, performs a bitwise AND, and writes the result back to the 64-bit MMIO register.

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(). If Address is not aligned on a 64-bit boundary, 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 2107 of file IoHighLevel.c.

◆ MmioAnd8()

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

Reads an 8-bit MMIO register, performs a bitwise AND, and writes the result back to the 8-bit MMIO register.

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 1230 of file IoHighLevel.c.

◆ MmioAndThenOr16()

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

Reads a 16-bit MMIO register, performs a bitwise AND followed by a bitwise OR, and writes the result back to the 16-bit MMIO register.

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(). If Address is not aligned on a 16-bit boundary, 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 1550 of file IoHighLevel.c.

◆ MmioAndThenOr32()

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

Reads a 32-bit MMIO register, performs a bitwise AND followed by a bitwise OR, and writes the result back to the 32-bit MMIO register.

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(). If Address is not aligned on a 32-bit boundary, 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 1844 of file IoHighLevel.c.

◆ MmioAndThenOr64()

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

Reads a 64-bit MMIO register, performs a bitwise AND followed by a bitwise OR, and writes the result back to the 64-bit MMIO register.

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(). If Address is not aligned on a 64-bit boundary, 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 2138 of file IoHighLevel.c.

◆ MmioAndThenOr8()

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

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

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 1261 of file IoHighLevel.c.

◆ MmioBitFieldAnd16()

UINT16 EFIAPI MmioBitFieldAnd16 ( 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.

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

Parameters
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 read value from the MMIO register.
Returns
The value written back to the MMIO register.

Definition at line 1703 of file IoHighLevel.c.

◆ MmioBitFieldAnd32()

UINT32 EFIAPI MmioBitFieldAnd32 ( 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.

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

Parameters
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 read value from the MMIO register.
Returns
The value written back to the MMIO register.

Definition at line 1997 of file IoHighLevel.c.

◆ MmioBitFieldAnd64()

UINT64 EFIAPI MmioBitFieldAnd64 ( 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.

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 Address is not aligned on a 64-bit boundary, then ASSERT(). If StartBit is greater than 63, then ASSERT(). If EndBit is greater than 63, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters
AddressMMIO 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 read value from the MMIO register.
Returns
The value written back to the MMIO register.

Definition at line 2291 of file IoHighLevel.c.

◆ MmioBitFieldAnd8()

UINT8 EFIAPI MmioBitFieldAnd8 ( 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.

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

If 8-bit MMIO register operations are not supported, then ASSERT(). If StartBit is greater than 7, then ASSERT(). If EndBit is greater than 7, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters
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 read value from the MMIO register.
Returns
The value written back to the MMIO register.

Definition at line 1410 of file IoHighLevel.c.

◆ MmioBitFieldAndThenOr16()

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

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

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

Parameters
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 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 1749 of file IoHighLevel.c.

◆ MmioBitFieldAndThenOr32()

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

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

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

Parameters
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 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 2043 of file IoHighLevel.c.

◆ MmioBitFieldAndThenOr64()

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

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

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 Address is not aligned on a 64-bit boundary, then ASSERT(). If StartBit is greater than 63, then ASSERT(). If EndBit is greater than 63, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT(). If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters
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 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 2337 of file IoHighLevel.c.

◆ MmioBitFieldAndThenOr8()

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

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

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

If 8-bit MMIO register operations are not supported, then ASSERT(). If StartBit is greater than 7, then ASSERT(). If EndBit is greater than 7, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT(). If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters
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 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 1455 of file IoHighLevel.c.

◆ MmioBitFieldOr16()

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

Reads a bit field in a 16-bit MMIO register, performs a bitwise OR, and writes the result back to the bit field in the 16-bit MMIO register.

Reads the 16-bit MMIO register specified by Address, performs a bitwise OR between the read result and the value specified by OrData, and writes the result to the 16-bit 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 Address is not aligned on a 16-bit boundary, then ASSERT(). If StartBit is greater than 15, then ASSERT(). If EndBit is greater than 15, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters
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 read value from the MMIO register.
Returns
The value written back to the MMIO register.

Definition at line 1660 of file IoHighLevel.c.

◆ MmioBitFieldOr32()

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

Reads a bit field in a 32-bit MMIO register, performs a bitwise OR, and writes the result back to the bit field in the 32-bit MMIO register.

Reads the 32-bit MMIO register specified by Address, performs a bitwise OR between the read result and the value specified by OrData, and writes the result to the 32-bit 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 Address is not aligned on a 32-bit boundary, then ASSERT(). If StartBit is greater than 31, then ASSERT(). If EndBit is greater than 31, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters
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 read value from the MMIO register.
Returns
The value written back to the MMIO register.

Definition at line 1954 of file IoHighLevel.c.

◆ MmioBitFieldOr64()

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

Reads a bit field in a 64-bit MMIO register, performs a bitwise OR, and writes the result back to the bit field in the 64-bit MMIO register.

Reads the 64-bit MMIO register specified by Address, performs a bitwise 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 Address is not aligned on a 64-bit boundary, then ASSERT(). If StartBit is greater than 63, then ASSERT(). If EndBit is greater than 63, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters
AddressMMIO 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 read value from the MMIO register.
Returns
The value written back to the MMIO register.

Definition at line 2248 of file IoHighLevel.c.

◆ MmioBitFieldOr8()

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

Reads a bit field in an 8-bit MMIO register, performs a bitwise OR, and writes the result back to the bit field in the 8-bit MMIO register.

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

If 8-bit MMIO register operations are not supported, then ASSERT(). If StartBit is greater than 7, then ASSERT(). If EndBit is greater than 7, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters
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 read value from the MMIO register.
Returns
The value written back to the MMIO register.

Definition at line 1368 of file IoHighLevel.c.

◆ MmioBitFieldRead16()

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

Reads a bit field of a MMIO register.

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 Address is not aligned on a 16-bit boundary, then ASSERT(). If StartBit is greater than 15, then ASSERT(). If EndBit is greater than 15, then ASSERT(). If EndBit is less than StartBit, then ASSERT().

Parameters
AddressThe MMIO 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 1582 of file IoHighLevel.c.

◆ MmioBitFieldRead32()

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

Reads a bit field of a MMIO register.

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 Address is not aligned on a 32-bit boundary, then ASSERT(). If StartBit is greater than 31, then ASSERT(). If EndBit is greater than 31, then ASSERT(). If EndBit is less than StartBit, then ASSERT().

Parameters
AddressThe MMIO 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 1876 of file IoHighLevel.c.

◆ MmioBitFieldRead64()

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

Reads a bit field of a MMIO register.

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 Address is not aligned on a 64-bit boundary, 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 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 2170 of file IoHighLevel.c.

◆ MmioBitFieldRead8()

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

Reads a bit field of a MMIO register.

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
AddressThe MMIO 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 1292 of file IoHighLevel.c.

◆ MmioBitFieldWrite16()

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

Writes a bit field to a MMIO register.

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

Parameters
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.
ValueThe new value of the bit field.
Returns
The value written back to the MMIO register.

Definition at line 1617 of file IoHighLevel.c.

◆ MmioBitFieldWrite32()

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

Writes a bit field to a MMIO register.

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

Parameters
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.
ValueThe new value of the bit field.
Returns
The value written back to the MMIO register.

Definition at line 1911 of file IoHighLevel.c.

◆ MmioBitFieldWrite64()

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

Writes a bit field to a MMIO register.

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 Address is not aligned on a 64-bit boundary, then ASSERT(). If StartBit is greater than 63, then ASSERT(). If EndBit is greater than 63, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters
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.
ValueThe new value of the bit field.
Returns
The value written back to the MMIO register.

Definition at line 2205 of file IoHighLevel.c.

◆ MmioBitFieldWrite8()

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

Writes a bit field to a MMIO register.

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

If 8-bit MMIO register operations are not supported, then ASSERT(). If StartBit is greater than 7, then ASSERT(). If EndBit is greater than 7, then ASSERT(). If EndBit is less than StartBit, then ASSERT(). If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters
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.
ValueThe new value of the bit field.
Returns
The value written back to the MMIO register.

Definition at line 1326 of file IoHighLevel.c.

◆ MmioOr16()

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

Reads a 16-bit MMIO register, performs a bitwise OR, and writes the result back to the 16-bit MMIO register.

Reads the 16-bit MMIO register specified by Address, performs a bitwise OR between the read result and the value specified by OrData, and writes the result to the 16-bit 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(). If Address is not aligned on a 16-bit boundary, 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 1490 of file IoHighLevel.c.

◆ MmioOr32()

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

Reads a 32-bit MMIO register, performs a bitwise OR, and writes the result back to the 32-bit MMIO register.

Reads the 32-bit MMIO register specified by Address, performs a bitwise OR between the read result and the value specified by OrData, and writes the result to the 32-bit 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(). If Address is not aligned on a 32-bit boundary, 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 1784 of file IoHighLevel.c.

◆ MmioOr64()

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

Reads a 64-bit MMIO register, performs a bitwise OR, and writes the result back to the 64-bit MMIO register.

Reads the 64-bit MMIO register specified by Address, performs a bitwise 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(). If Address is not aligned on a 64-bit boundary, 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 2078 of file IoHighLevel.c.

◆ MmioOr8()

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

Reads an 8-bit MMIO register, performs a bitwise OR, and writes the result back to the 8-bit MMIO register.

Reads the 8-bit MMIO register specified by Address, performs a bitwise OR between the read result and the value specified by OrData, and writes the result to the 8-bit 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 1202 of file IoHighLevel.c.