ab9d790901
RFC: https://bugzilla.tianocore.org/show_bug.cgi?id=3429 Intel TDX architecture does not prescribe a specific software convention to perform I/O from the guest TD. Guest TD providers have many choices to provide I/O to the guest. The common I/O models are emulated devices, para-virtualized devices, SRIOV devices and Direct Device assignments. TDVF chooses para-virtualized I/O (Choice-A) which use the TDG.VP.VMCALL function to invoke the funtions provided by the host VMM to perform I/O. Another choice (Choice-B) is the emulation performed by the #VE handler. There are 2 benefits of para-virtualized I/O: 1. Performance. VMEXIT/VMENTRY is skipped so that the performance is better than #VE handler. 2. De-couple with #VE handler. Choice-B depends on the #VE handler which means I/O is not available until #VE handler is installed. For example, in PEI phase #VE handler is installed in CpuMpPei, while communication with Qemu (via I/O port) happen earlier than it. IoLibInternalTdx.c provides the helper functions for Tdx guest. IoLibInternalTdxNull.c provides the null version of the helper functions. It is included in the Non-X64 IoLib so that the build will not be broken. Cc: Michael D Kinney <michael.d.kinney@intel.com> Cc: Liming Gao <gaoliming@byosoft.com.cn> Cc: Zhiguang Liu <zhiguang.liu@intel.com> Cc: Brijesh Singh <brijesh.singh@amd.com> Cc: Erdem Aktas <erdemaktas@google.com> Cc: James Bottomley <jejb@linux.ibm.com> Cc: Jiewen Yao <jiewen.yao@intel.com> Cc: Tom Lendacky <thomas.lendacky@amd.com> Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn> Reviewed-by: Jiewen Yao <jiewen.yao@intel.com> Signed-off-by: Min Xu <min.m.xu@intel.com>
411 lines
8.0 KiB
C
411 lines
8.0 KiB
C
/** @file
|
|
Header file for Tdx IO library.
|
|
|
|
Copyright (c) 2020 - 2021, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
**/
|
|
|
|
#ifndef IOLIB_TDX_H_
|
|
#define IOLIB_TDX_H_
|
|
|
|
/**
|
|
Check if it is Tdx guest.
|
|
|
|
@return TRUE It is Tdx guest
|
|
@return FALSE It is not Tdx guest
|
|
|
|
**/
|
|
BOOLEAN
|
|
EFIAPI
|
|
IsTdxGuest (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Reads an 8-bit I/O port.
|
|
|
|
TDVMCALL_IO is invoked to read I/O port.
|
|
|
|
@param Port The I/O port to read.
|
|
|
|
@return The value read.
|
|
|
|
**/
|
|
UINT8
|
|
EFIAPI
|
|
TdIoRead8 (
|
|
IN UINTN Port
|
|
);
|
|
|
|
/**
|
|
Reads a 16-bit I/O port.
|
|
|
|
TDVMCALL_IO is invoked to write I/O port.
|
|
|
|
@param Port The I/O port to read.
|
|
|
|
@return The value read.
|
|
|
|
**/
|
|
UINT16
|
|
EFIAPI
|
|
TdIoRead16 (
|
|
IN UINTN Port
|
|
);
|
|
|
|
/**
|
|
Reads a 32-bit I/O port.
|
|
|
|
TDVMCALL_IO is invoked to read I/O port.
|
|
|
|
@param Port The I/O port to read.
|
|
|
|
@return The value read.
|
|
|
|
**/
|
|
UINT32
|
|
EFIAPI
|
|
TdIoRead32 (
|
|
IN UINTN Port
|
|
);
|
|
|
|
/**
|
|
Writes an 8-bit I/O port.
|
|
|
|
TDVMCALL_IO is invoked to write I/O port.
|
|
|
|
@param Port The I/O port to write.
|
|
@param Value The value to write to the I/O port.
|
|
|
|
@return The value written the I/O port.
|
|
|
|
**/
|
|
UINT8
|
|
EFIAPI
|
|
TdIoWrite8 (
|
|
IN UINTN Port,
|
|
IN UINT8 Value
|
|
);
|
|
|
|
/**
|
|
Writes a 16-bit I/O port.
|
|
|
|
TDVMCALL_IO is invoked to write I/O port.
|
|
|
|
@param Port The I/O port to write.
|
|
@param Value The value to write to the I/O port.
|
|
|
|
@return The value written the I/O port.
|
|
|
|
**/
|
|
UINT16
|
|
EFIAPI
|
|
TdIoWrite16 (
|
|
IN UINTN Port,
|
|
IN UINT16 Value
|
|
);
|
|
|
|
/**
|
|
Writes a 32-bit I/O port.
|
|
|
|
TDVMCALL_IO is invoked to write I/O port.
|
|
|
|
@param Port The I/O port to write.
|
|
@param Value The value to write to the I/O port.
|
|
|
|
@return The value written the I/O port.
|
|
|
|
**/
|
|
UINT32
|
|
EFIAPI
|
|
TdIoWrite32 (
|
|
IN UINTN Port,
|
|
IN UINT32 Value
|
|
);
|
|
|
|
/**
|
|
Reads an 8-bit MMIO register.
|
|
|
|
TDVMCALL_MMIO is invoked to read MMIO registers.
|
|
|
|
@param Address The MMIO register to read.
|
|
|
|
@return The value read.
|
|
|
|
**/
|
|
UINT8
|
|
EFIAPI
|
|
TdMmioRead8 (
|
|
IN UINTN Address
|
|
);
|
|
|
|
/**
|
|
Writes an 8-bit MMIO register.
|
|
|
|
TDVMCALL_MMIO is invoked to read write registers.
|
|
|
|
@param Address The MMIO register to write.
|
|
@param Value The value to write to the MMIO register.
|
|
|
|
@return Value.
|
|
|
|
**/
|
|
UINT8
|
|
EFIAPI
|
|
TdMmioWrite8 (
|
|
IN UINTN Address,
|
|
IN UINT8 Val
|
|
);
|
|
|
|
/**
|
|
Reads a 16-bit MMIO register.
|
|
|
|
TDVMCALL_MMIO is invoked to read MMIO registers.
|
|
|
|
@param Address The MMIO register to read.
|
|
|
|
@return The value read.
|
|
|
|
**/
|
|
UINT16
|
|
EFIAPI
|
|
TdMmioRead16 (
|
|
IN UINTN Address
|
|
);
|
|
|
|
/**
|
|
Writes a 16-bit MMIO register.
|
|
|
|
TDVMCALL_MMIO is invoked to write MMIO registers.
|
|
|
|
@param Address The MMIO register to write.
|
|
@param Value The value to write to the MMIO register.
|
|
|
|
@return Value.
|
|
|
|
**/
|
|
UINT16
|
|
EFIAPI
|
|
TdMmioWrite16 (
|
|
IN UINTN Address,
|
|
IN UINT16 Val
|
|
);
|
|
|
|
/**
|
|
Reads a 32-bit MMIO register.
|
|
|
|
TDVMCALL_MMIO is invoked to read MMIO registers.
|
|
|
|
@param Address The MMIO register to read.
|
|
|
|
@return The value read.
|
|
|
|
**/
|
|
UINT32
|
|
EFIAPI
|
|
TdMmioRead32 (
|
|
IN UINTN Address
|
|
);
|
|
|
|
/**
|
|
Writes a 32-bit MMIO register.
|
|
|
|
TDVMCALL_MMIO is invoked to write MMIO registers.
|
|
|
|
@param Address The MMIO register to write.
|
|
@param Value The value to write to the MMIO register.
|
|
|
|
@return Value.
|
|
|
|
**/
|
|
UINT32
|
|
EFIAPI
|
|
TdMmioWrite32 (
|
|
IN UINTN Address,
|
|
IN UINT32 Val
|
|
);
|
|
|
|
/**
|
|
Reads a 64-bit MMIO register.
|
|
|
|
TDVMCALL_MMIO is invoked to read MMIO registers.
|
|
|
|
@param Address The MMIO register to read.
|
|
|
|
@return The value read.
|
|
|
|
**/
|
|
UINT64
|
|
EFIAPI
|
|
TdMmioRead64 (
|
|
IN UINTN Address
|
|
);
|
|
|
|
/**
|
|
Writes a 64-bit MMIO register.
|
|
|
|
TDVMCALL_MMIO is invoked to write MMIO registers.
|
|
|
|
@param Address The MMIO register to write.
|
|
@param Value The value to write to the MMIO register.
|
|
|
|
**/
|
|
UINT64
|
|
EFIAPI
|
|
TdMmioWrite64 (
|
|
IN UINTN Address,
|
|
IN UINT64 Value
|
|
);
|
|
|
|
/**
|
|
Reads an 8-bit I/O port fifo into a block of memory in Tdx.
|
|
|
|
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().
|
|
|
|
@param Port The I/O port to read.
|
|
@param Count The number of times to read I/O port.
|
|
@param Buffer The buffer to store the read data into.
|
|
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
TdIoReadFifo8 (
|
|
IN UINTN Port,
|
|
IN UINTN Count,
|
|
OUT VOID *Buffer
|
|
);
|
|
|
|
/**
|
|
Writes a block of memory into an 8-bit I/O port fifo in Tdx.
|
|
|
|
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().
|
|
|
|
@param Port The I/O port to write.
|
|
@param Count The number of times to write I/O port.
|
|
@param Buffer The buffer to retrieve the write data from.
|
|
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
TdIoWriteFifo8 (
|
|
IN UINTN Port,
|
|
IN UINTN Count,
|
|
IN VOID *Buffer
|
|
);
|
|
|
|
/**
|
|
Reads a 16-bit I/O port fifo into a block of memory in Tdx.
|
|
|
|
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().
|
|
|
|
@param Port The I/O port to read.
|
|
@param Count The number of times to read I/O port.
|
|
@param Buffer The buffer to store the read data into.
|
|
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
TdIoReadFifo16 (
|
|
IN UINTN Port,
|
|
IN UINTN Count,
|
|
OUT VOID *Buffer
|
|
);
|
|
|
|
/**
|
|
Writes a block of memory into a 16-bit I/O port fifo in Tdx.
|
|
|
|
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().
|
|
|
|
@param Port The I/O port to write.
|
|
@param Count The number of times to write I/O port.
|
|
@param Buffer The buffer to retrieve the write data from.
|
|
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
TdIoWriteFifo16 (
|
|
IN UINTN Port,
|
|
IN UINTN Count,
|
|
IN VOID *Buffer
|
|
);
|
|
|
|
/**
|
|
Reads a 32-bit I/O port fifo into a block of memory in Tdx.
|
|
|
|
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().
|
|
|
|
@param Port The I/O port to read.
|
|
@param Count The number of times to read I/O port.
|
|
@param Buffer The buffer to store the read data into.
|
|
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
TdIoReadFifo32 (
|
|
IN UINTN Port,
|
|
IN UINTN Count,
|
|
OUT VOID *Buffer
|
|
);
|
|
|
|
/**
|
|
Writes a block of memory into a 32-bit I/O port fifo in Tdx.
|
|
|
|
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().
|
|
|
|
@param Port The I/O port to write.
|
|
@param Count The number of times to write I/O port.
|
|
@param Buffer The buffer to retrieve the write data from.
|
|
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
TdIoWriteFifo32 (
|
|
IN UINTN Port,
|
|
IN UINTN Count,
|
|
IN VOID *Buffer
|
|
);
|
|
|
|
#endif
|