#include <Uefi.h>
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/DebugLib.h>
#include <Library/OcMiscLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Protocol/PciRootBridgeIo.h>
#include <Protocol/CpuIo2.h>
#include <Library/IoLib.h>

Macros
#define	MAX_IO_PORT_ADDRESS 0xFFFF

Functions
EFI_CPU_IO2_PROTOCOL *	InitializeCpuIo2 (VOID)

EFI_STATUS EFIAPI	CpuMemoryServiceRead (IN EFI_CPU_IO2_PROTOCOL This, IN EFI_CPU_IO_PROTOCOL_WIDTH Width, IN UINT64 Address, IN UINTN Count, OUT VOID Buffer)

EFI_STATUS EFIAPI	CpuMemoryServiceWrite (IN EFI_CPU_IO2_PROTOCOL This, IN EFI_CPU_IO_PROTOCOL_WIDTH Width, IN UINT64 Address, IN UINTN Count, IN VOID Buffer)

EFI_STATUS EFIAPI	RootBridgeIoMemRead (IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL This, IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width, IN UINT64 Address, IN UINTN Count, IN OUT VOID Buffer)

EFI_STATUS EFIAPI	RootBridgeIoMemWrite (IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL This, IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH Width, IN UINT64 Address, IN UINTN Count, IN OUT VOID Buffer)

Detailed Description

EFI PCI IO protocol functions declaration for PCI Bus module.

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

Definition in file OcPciIoU.h.

Macro Definition Documentation

◆ MAX_IO_PORT_ADDRESS

#define MAX_IO_PORT_ADDRESS 0xFFFF

Definition at line 25 of file OcPciIoU.h.

Function Documentation

◆ CpuMemoryServiceRead()

EFI_STATUS EFIAPI CpuMemoryServiceRead	(	IN EFI_CPU_IO2_PROTOCOL *	This,
		IN EFI_CPU_IO_PROTOCOL_WIDTH	Width,
		IN UINT64	Address,
		IN UINTN	Count,
		OUT VOID *	Buffer )

Reads memory-mapped registers.

The I/O operations are carried out exactly as requested. The caller is responsible for satisfying any alignment and I/O width restrictions that a PI System on a platform might require. For example on some platforms, width requests of EfiCpuIoWidthUint64 do not work. Misaligned buffers, on the other hand, will be handled by the driver.

If Width is EfiCpuIoWidthUint8, EfiCpuIoWidthUint16, EfiCpuIoWidthUint32, or EfiCpuIoWidthUint64, then both Address and Buffer are incremented for each of the Count operations that is performed.

If Width is EfiCpuIoWidthFifoUint8, EfiCpuIoWidthFifoUint16, EfiCpuIoWidthFifoUint32, or EfiCpuIoWidthFifoUint64, then only Buffer is incremented for each of the Count operations that is performed. The read or write operation is performed Count times on the same Address.

If Width is EfiCpuIoWidthFillUint8, EfiCpuIoWidthFillUint16, EfiCpuIoWidthFillUint32, or EfiCpuIoWidthFillUint64, then only Address is incremented for each of the Count operations that is performed. The read or write operation is performed Count times from the first element of Buffer.

Parameters

[in]	This	A pointer to the EFI_CPU_IO2_PROTOCOL instance.
[in]	Width	Signifies the width of the I/O or Memory operation.
[in]	Address	The base address of the I/O operation.
[in]	Count	The number of I/O operations to perform. The number of bytes moved is Width size * Count, starting at Address.
[out]	Buffer	For read operations, the destination buffer to store the results. For write operations, the source buffer from which to write data.

Return values

EFI_SUCCESS	The data was read from or written to the PI system.
EFI_INVALID_PARAMETER	Width is invalid for this PI system.
EFI_INVALID_PARAMETER	Buffer is NULL.
EFI_UNSUPPORTED	The Buffer is not aligned for the given Width.
EFI_UNSUPPORTED	The address range specified by Address, Width, and Count is not valid for this PI system.

Definition at line 228 of file OcPciIoU.c.

◆ CpuMemoryServiceWrite()

EFI_STATUS EFIAPI CpuMemoryServiceWrite	(	IN EFI_CPU_IO2_PROTOCOL *	This,
		IN EFI_CPU_IO_PROTOCOL_WIDTH	Width,
		IN UINT64	Address,
		IN UINTN	Count,
		IN VOID *	Buffer )

Writes memory-mapped registers.

The I/O operations are carried out exactly as requested. The caller is responsible for satisfying any alignment and I/O width restrictions that a PI System on a platform might require. For example on some platforms, width requests of EfiCpuIoWidthUint64 do not work. Misaligned buffers, on the other hand, will be handled by the driver.

If Width is EfiCpuIoWidthUint8, EfiCpuIoWidthUint16, EfiCpuIoWidthUint32, or EfiCpuIoWidthUint64, then both Address and Buffer are incremented for each of the Count operations that is performed.

If Width is EfiCpuIoWidthFifoUint8, EfiCpuIoWidthFifoUint16, EfiCpuIoWidthFifoUint32, or EfiCpuIoWidthFifoUint64, then only Buffer is incremented for each of the Count operations that is performed. The read or write operation is performed Count times on the same Address.

If Width is EfiCpuIoWidthFillUint8, EfiCpuIoWidthFillUint16, EfiCpuIoWidthFillUint32, or EfiCpuIoWidthFillUint64, then only Address is incremented for each of the Count operations that is performed. The read or write operation is performed Count times from the first element of Buffer.

Parameters

[in]	This	A pointer to the EFI_CPU_IO2_PROTOCOL instance.
[in]	Width	Signifies the width of the I/O or Memory operation.
[in]	Address	The base address of the I/O operation.
[in]	Count	The number of I/O operations to perform. The number of bytes moved is Width size * Count, starting at Address.
[in]	Buffer	For read operations, the destination buffer to store the results. For write operations, the source buffer from which to write data.

Return values

EFI_SUCCESS	The data was read from or written to the PI system.
EFI_INVALID_PARAMETER	Width is invalid for this PI system.
EFI_INVALID_PARAMETER	Buffer is NULL.
EFI_UNSUPPORTED	The Buffer is not aligned for the given Width.
EFI_UNSUPPORTED	The address range specified by Address, Width, and Count is not valid for this PI system.

Definition at line 309 of file OcPciIoU.c.

◆ InitializeCpuIo2()

EFI_CPU_IO2_PROTOCOL * InitializeCpuIo2 ( VOID )

Definition at line 48 of file OcPciIoU.c.

◆ RootBridgeIoMemRead()

EFI_STATUS EFIAPI RootBridgeIoMemRead	(	IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *	This,
		IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH	Width,
		IN UINT64	Address,
		IN UINTN	Count,
		IN OUT VOID *	Buffer )

Allow read from memory mapped I/O space.

Parameters

This	- Pointer to EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL instance.
Width	- The width of memory operation.
Address	- Base address of the memory operation.
Count	- Number of memory opeartion to perform.
Buffer	- The destination buffer to store data.

Return values

EFI_SUCCESS	- Success.
EFI_INVALID_PARAMETER	- Invalid parameter found.
EFI_OUT_OF_RESOURCES	- Fail due to lack of resources.

◆ RootBridgeIoMemWrite()

EFI_STATUS EFIAPI RootBridgeIoMemWrite	(	IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *	This,
		IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH	Width,
		IN UINT64	Address,
		IN UINTN	Count,
		IN OUT VOID *	Buffer )

Allow write to memory mapped I/O space.

Parameters

This	- Pointer to EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL instance.
Width	- The width of memory operation.
Address	- Base address of the memory operation.
Count	- Number of memory opeartion to perform.
Buffer	- The source buffer to write data from.

Return values

EFI_SUCCESS	- Success.
EFI_INVALID_PARAMETER	- Invalid parameter found.
EFI_OUT_OF_RESOURCES	- Fail due to lack of resources.

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ MAX_IO_PORT_ADDRESS

Function Documentation

◆ CpuMemoryServiceRead()

◆ CpuMemoryServiceWrite()

◆ InitializeCpuIo2()

◆ RootBridgeIoMemRead()

◆ RootBridgeIoMemWrite()