#include "SmmCpuIoLibInternal.h"

Functions
UINT64 EFIAPI	IoReadWorker (IN UINTN Port, IN EFI_SMM_IO_WIDTH Width)

UINT64 EFIAPI	IoWriteWorker (IN UINTN Port, IN EFI_SMM_IO_WIDTH Width, IN UINT64 Data)

UINT64 EFIAPI	MmioReadWorker (IN UINTN Address, IN EFI_SMM_IO_WIDTH Width)

UINT64 EFIAPI	MmioWriteWorker (IN UINTN Address, IN EFI_SMM_IO_WIDTH Width, IN UINT64 Data)

UINT8 EFIAPI	IoRead8 (IN UINTN Port)

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

UINT16 EFIAPI	IoRead16 (IN UINTN Port)

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

UINT32 EFIAPI	IoRead32 (IN UINTN Port)

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

UINT64 EFIAPI	IoRead64 (IN UINTN Port)

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

VOID EFIAPI	IoReadFifo8 (IN UINTN Port, IN UINTN Count, OUT VOID *Buffer)

VOID EFIAPI	IoWriteFifo8 (IN UINTN Port, IN UINTN Count, IN VOID *Buffer)

VOID EFIAPI	IoReadFifo16 (IN UINTN Port, IN UINTN Count, OUT VOID *Buffer)

VOID EFIAPI	IoWriteFifo16 (IN UINTN Port, IN UINTN Count, IN VOID *Buffer)

VOID EFIAPI	IoReadFifo32 (IN UINTN Port, IN UINTN Count, OUT VOID *Buffer)

VOID EFIAPI	IoWriteFifo32 (IN UINTN Port, IN UINTN Count, IN VOID *Buffer)

UINT8 EFIAPI	MmioRead8 (IN UINTN Address)

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

UINT16 EFIAPI	MmioRead16 (IN UINTN Address)

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

UINT32 EFIAPI	MmioRead32 (IN UINTN Address)

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

UINT64 EFIAPI	MmioRead64 (IN UINTN Address)

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

Detailed Description

I/O Library. The implementation of I/O operation for this library instance are based on EFI_CPU_IO_PROTOCOL.

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

Definition in file IoLib.c.

Function Documentation

◆ IoRead16()

UINT16 EFIAPI IoRead16 ( IN UINTN Port )

Reads a 16-bit I/O port.

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 Port is not aligned on a 16-bit boundary, then ASSERT().

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

Parameters

Port	The I/O port to read.

Returns: The value read.

Definition at line 203 of file IoLib.c.

◆ IoRead32()

UINT32 EFIAPI IoRead32 ( IN UINTN Port )

Reads a 32-bit I/O port.

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 Port is not aligned on a 32-bit boundary, then ASSERT().

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

Parameters

Port	The I/O port to read.

Returns: The value read.

Definition at line 263 of file IoLib.c.

◆ IoRead64()

UINT64 EFIAPI IoRead64 ( IN UINTN Port )

Reads a 64-bit I/O port.

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 Port is not aligned on a 64-bit boundary, then ASSERT().

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

Parameters

Port	The I/O port to read.

Returns: The value read.

Definition at line 323 of file IoLib.c.

◆ IoRead8()

UINT8 EFIAPI IoRead8 ( IN UINTN Port )

Reads an 8-bit I/O port.

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

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

Parameters

Port	The I/O port to read.

Returns: The value read.

Definition at line 153 of file IoLib.c.

◆ IoReadFifo16()

VOID EFIAPI IoReadFifo16	(	IN UINTN	Port,
		IN UINTN	Count,
		OUT VOID *	Buffer
	)

Reads a 16-bit I/O port fifo into a block of memory.

Reads the 16-bit I/O fifo port specified by Port. The port is read Count times, and the read data is stored in the provided Buffer.

This function must guarantee that all I/O read and write operations are serialized.

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

Parameters

Port	The I/O port to read.
Count	The number of times to read I/O port.
Buffer	The buffer to store the read data into.

Definition at line 450 of file IoLib.c.

◆ IoReadFifo32()

VOID EFIAPI IoReadFifo32	(	IN UINTN	Port,
		IN UINTN	Count,
		OUT VOID *	Buffer
	)

Reads a 32-bit I/O port fifo into a block of memory.

Reads the 32-bit I/O fifo port specified by Port. The port is read Count times, and the read data is stored in the provided Buffer.

This function must guarantee that all I/O read and write operations are serialized.

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

Parameters

Port	The I/O port to read.
Count	The number of times to read I/O port.
Buffer	The buffer to store the read data into.

Definition at line 524 of file IoLib.c.

◆ IoReadFifo8()

VOID EFIAPI IoReadFifo8	(	IN UINTN	Port,
		IN UINTN	Count,
		OUT VOID *	Buffer
	)

Reads an 8-bit I/O port fifo into a block of memory.

Reads the 8-bit I/O fifo port specified by Port. The port is read Count times, and the read data is stored in the provided Buffer.

This function must guarantee that all I/O read and write operations are serialized.

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

Parameters

Port	The I/O port to read.
Count	The number of times to read I/O port.
Buffer	The buffer to store the read data into.

Definition at line 384 of file IoLib.c.

◆ IoReadWorker()

UINT64 EFIAPI IoReadWorker	(	IN UINTN	Port,
		IN EFI_SMM_IO_WIDTH	Width
	)

Reads registers in the EFI CPU I/O space.

Reads the I/O port specified by Port with registers width specified by Width. The read value is returned. If such operations are not supported, then ASSERT(). This function must guarantee that all I/O read and write operations are serialized.

Parameters

Port	The base address of the I/O operation. The caller is responsible for aligning the Address if required.
Width	The width of the I/O operation.

Returns: Data read from registers in the EFI CPU I/O space.

Definition at line 31 of file IoLib.c.

◆ IoWrite16()

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

Writes a 16-bit I/O port.

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 Port is not aligned on a 16-bit boundary, then ASSERT().

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

Parameters

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

Returns: The value written the I/O port.

Definition at line 233 of file IoLib.c.

◆ IoWrite32()

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

Writes a 32-bit I/O port.

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 Port is not aligned on a 32-bit boundary, then ASSERT().

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

Parameters

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

Returns: The value written the I/O port.

Definition at line 293 of file IoLib.c.

◆ IoWrite64()

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

Writes a 64-bit I/O port.

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 Port is not aligned on a 64-bit boundary, then ASSERT().

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

Parameters

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

Returns: The value written the I/O port.

Definition at line 353 of file IoLib.c.

◆ IoWrite8()

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

Writes an 8-bit I/O port.

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

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

Parameters

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

Returns: The value written the I/O port.

Definition at line 177 of file IoLib.c.

◆ IoWriteFifo16()

VOID EFIAPI IoWriteFifo16	(	IN UINTN	Port,
		IN UINTN	Count,
		IN VOID *	Buffer
	)

Writes a block of memory into a 16-bit I/O port fifo.

Writes the 16-bit I/O fifo port specified by Port. The port is written Count times, and the write data is retrieved from the provided Buffer.

This function must guarantee that all I/O write and write operations are serialized.

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

Parameters

Port	The I/O port to write.
Count	The number of times to write I/O port.
Buffer	The buffer to retrieve the write data from.

Definition at line 487 of file IoLib.c.

◆ IoWriteFifo32()

VOID EFIAPI IoWriteFifo32	(	IN UINTN	Port,
		IN UINTN	Count,
		IN VOID *	Buffer
	)

Writes a block of memory into a 32-bit I/O port fifo.

Writes the 32-bit I/O fifo port specified by Port. The port is written Count times, and the write data is retrieved from the provided Buffer.

This function must guarantee that all I/O write and write operations are serialized.

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

Parameters

Port	The I/O port to write.
Count	The number of times to write I/O port.
Buffer	The buffer to retrieve the write data from.

Definition at line 561 of file IoLib.c.

◆ IoWriteFifo8()

VOID EFIAPI IoWriteFifo8	(	IN UINTN	Port,
		IN UINTN	Count,
		IN VOID *	Buffer
	)

Writes a block of memory into an 8-bit I/O port fifo.

Writes the 8-bit I/O fifo port specified by Port. The port is written Count times, and the write data is retrieved from the provided Buffer.

This function must guarantee that all I/O write and write operations are serialized.

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

Parameters

Port	The I/O port to write.
Count	The number of times to write I/O port.
Buffer	The buffer to retrieve the write data from.

Definition at line 417 of file IoLib.c.

◆ IoWriteWorker()

UINT64 EFIAPI IoWriteWorker	(	IN UINTN	Port,
		IN EFI_SMM_IO_WIDTH	Width,
		IN UINT64	Data
	)

Writes registers in the EFI CPU I/O space.

Writes the I/O port specified by Port with registers width and value specified by Width and Data respectively. Data is returned. If such operations are not supported, then ASSERT(). This function must guarantee that all I/O read and write operations are serialized.

Parameters

Port	The base address of the I/O operation. The caller is responsible for aligning the Address if required.
Width	The width of the I/O operation.
Data	The value to write to the I/O port.

Returns: The parameter of Data.

Definition at line 62 of file IoLib.c.

◆ MmioRead16()

UINT16 EFIAPI MmioRead16 ( IN UINTN Address )

Reads a 16-bit MMIO register.

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 Address is not aligned on a 16-bit boundary, then ASSERT().

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

Parameters

Address The MMIO register to read.

Returns: The value read.

Definition at line 643 of file IoLib.c.

◆ MmioRead32()

UINT32 EFIAPI MmioRead32 ( IN UINTN Address )

Reads a 32-bit MMIO register.

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 Address is not aligned on a 32-bit boundary, then ASSERT().

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

Parameters

Address The MMIO register to read.

Returns: The value read.

Definition at line 701 of file IoLib.c.

◆ MmioRead64()

UINT64 EFIAPI MmioRead64 ( IN UINTN Address )

Reads a 64-bit MMIO register.

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 Address is not aligned on a 64-bit boundary, then ASSERT().

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

Parameters

Address The MMIO register to read.

Returns: The value read.

Definition at line 759 of file IoLib.c.

◆ MmioRead8()

UINT8 EFIAPI MmioRead8 ( IN UINTN Address )

Reads an 8-bit MMIO register.

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

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

Parameters

Address The MMIO register to read.

Returns: The value read.

Definition at line 595 of file IoLib.c.

◆ MmioReadWorker()

UINT64 EFIAPI MmioReadWorker	(	IN UINTN	Address,
		IN EFI_SMM_IO_WIDTH	Width
	)

Reads memory-mapped registers in the EFI system memory space.

Reads the MMIO registers specified by Address with registers width specified by Width. The read value is returned. If such operations are not supported, then ASSERT(). This function must guarantee that all MMIO read and write operations are serialized.

Parameters

Address	The MMIO register to read. The caller is responsible for aligning the Address if required.
Width	The width of the I/O operation.

Returns: Data read from registers in the EFI system memory space.

Definition at line 92 of file IoLib.c.

◆ MmioWrite16()

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

Writes a 16-bit MMIO register.

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.

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

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

Parameters

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

Definition at line 671 of file IoLib.c.

◆ MmioWrite32()

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

Writes a 32-bit MMIO register.

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 Address is not aligned on a 32-bit boundary, then ASSERT().

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

Parameters

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

Definition at line 729 of file IoLib.c.

◆ MmioWrite64()

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

Writes a 64-bit MMIO register.

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 Address is not aligned on a 64-bit boundary, then ASSERT().

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

Parameters

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

Definition at line 787 of file IoLib.c.

◆ MmioWrite8()

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

Writes an 8-bit MMIO register.

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

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

Parameters

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

Definition at line 617 of file IoLib.c.

◆ MmioWriteWorker()

UINT64 EFIAPI MmioWriteWorker	(	IN UINTN	Address,
		IN EFI_SMM_IO_WIDTH	Width,
		IN UINT64	Data
	)

Writes memory-mapped registers in the EFI system memory space.

Writes the MMIO registers specified by Address with registers width and value specified by Width and Data respectively. Data is returned. If such operations are not supported, then ASSERT(). This function must guarantee that all MMIO read and write operations are serialized.

Parameters

Address	The MMIO register to read. The caller is responsible for aligning the Address if required.
Width	The width of the I/O operation.
Data	The value to write to the I/O port.

Returns: Data read from registers in the EFI system memory space.

Definition at line 123 of file IoLib.c.

Functions

Detailed Description

Function Documentation

◆ IoRead16()

◆ IoRead32()

◆ IoRead64()

◆ IoRead8()

◆ IoReadFifo16()

◆ IoReadFifo32()

◆ IoReadFifo8()

◆ IoReadWorker()

◆ IoWrite16()

◆ IoWrite32()

◆ IoWrite64()

◆ IoWrite8()

◆ IoWriteFifo16()

◆ IoWriteFifo32()

◆ IoWriteFifo8()

◆ IoWriteWorker()

◆ MmioRead16()

◆ MmioRead32()

◆ MmioRead64()

◆ MmioRead8()

◆ MmioReadWorker()

◆ MmioWrite16()

◆ MmioWrite32()

◆ MmioWrite64()

◆ MmioWrite8()

◆ MmioWriteWorker()