DxeCpuIo2LibInternal.h File Reference

#include <PiDxe.h>
#include <Protocol/CpuIo2.h>
#include <Library/IoLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/DebugLib.h>
#include <Library/BaseLib.h>

Go to the source code of this file.

Functions
UINT64 EFIAPI	IoReadWorker (IN UINTN Port, IN EFI_CPU_IO_PROTOCOL_WIDTH Width)
UINT64 EFIAPI	IoWriteWorker (IN UINTN Port, IN EFI_CPU_IO_PROTOCOL_WIDTH Width, IN UINT64 Data)
VOID EFIAPI	IoReadFifoWorker (IN UINTN Port, IN EFI_CPU_IO_PROTOCOL_WIDTH Width, IN UINTN Count, IN VOID *Buffer)
VOID EFIAPI	IoWriteFifoWorker (IN UINTN Port, IN EFI_CPU_IO_PROTOCOL_WIDTH Width, IN UINTN Count, IN VOID *Buffer)
UINT64 EFIAPI	MmioReadWorker (IN UINTN Address, IN EFI_CPU_IO_PROTOCOL_WIDTH Width)
UINT64 EFIAPI	MmioWriteWorker (IN UINTN Address, IN EFI_CPU_IO_PROTOCOL_WIDTH Width, IN UINT64 Data)

Detailed Description

Internal include file of DXE CPU IO2 Library.

Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.
Copyright (c) 2017, AMD Incorporated. All rights reserved.

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

Definition in file DxeCpuIo2LibInternal.h.

Function Documentation

IoReadFifoWorker()

VOID EFIAPI IoReadFifoWorker	(	IN UINTN	Port,
		IN EFI_CPU_IO_PROTOCOL_WIDTH	Width,
		IN UINTN	Count,
		IN VOID *	Buffer
	)

Reads registers in the EFI CPU I/O space.

Reads the I/O port specified by Port with registers width specified by Width. 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 such operations are not supported, then ASSERT().

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.
Count	The number of times to read I/O port.
Buffer	The buffer to store the read data into.

Definition at line 128 of file IoLib.c.

IoReadWorker()

UINT64 EFIAPI IoReadWorker	(	IN UINTN	Port,
		IN EFI_CPU_IO_PROTOCOL_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.

This function must guarantee that all I/O read and write operations are serialized. If such operations are not supported, then ASSERT().

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 63 of file IoLib.c.

IoWriteFifoWorker()

VOID EFIAPI IoWriteFifoWorker	(	IN UINTN	Port,
		IN EFI_CPU_IO_PROTOCOL_WIDTH	Width,
		IN UINTN	Count,
		IN VOID *	Buffer
	)

Writes registers in the EFI CPU I/O space.

Writes the I/O port specified by Port with registers width specified by Width. The port is written Count times, and the write data is retrieved from the provided Buffer.

This function must guarantee that all I/O read and write operations are serialized. If such operations are not supported, then ASSERT().

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.
Count	The number of times to write I/O port.
Buffer	The buffer to store the read data into.

Definition at line 159 of file IoLib.c.

IoWriteWorker()

UINT64 EFIAPI IoWriteWorker	(	IN UINTN	Port,
		IN EFI_CPU_IO_PROTOCOL_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.

This function must guarantee that all I/O read and write operations are serialized. If such operations are not supported, then ASSERT().

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 96 of file IoLib.c.

MmioReadWorker()

UINT64 EFIAPI MmioReadWorker	(	IN UINTN	Address,
		IN EFI_CPU_IO_PROTOCOL_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 188 of file IoLib.c.

MmioWriteWorker()

UINT64 EFIAPI MmioWriteWorker	(	IN UINTN	Address,
		IN EFI_CPU_IO_PROTOCOL_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 219 of file IoLib.c.