mirror of
https://github.com/acidanthera/audk.git
synced 2025-07-08 22:34:24 +02:00
OvmfPkg/IoMmuDxe: rewrap source code to 79 characters
No functional changes. Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org> Cc: Brijesh Singh <brijesh.singh@amd.com> Cc: Jordan Justen <jordan.l.justen@intel.com> Cc: Tom Lendacky <thomas.lendacky@amd.com> Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Laszlo Ersek <lersek@redhat.com> Tested-by: Brijesh Singh <brijesh.singh@amd.com> Reviewed-by: Brijesh Singh <brijesh.singh@amd.com>
This commit is contained in:
Laszlo Ersek
parent
8dccfa6d48
commit
812568fb87
@ -1,9 +1,9 @@
|
|||||||
/** @file
|
/** @file
|
||||||
|
|
||||||
The protocol provides support to allocate, free, map and umap a DMA buffer for
|
The protocol provides support to allocate, free, map and umap a DMA buffer
|
||||||
bus master (e.g PciHostBridge). When SEV is enabled, the DMA operations must
|
for bus master (e.g PciHostBridge). When SEV is enabled, the DMA operations
|
||||||
be performed on unencrypted buffer hence we use a bounce buffer to map the guest
|
must be performed on unencrypted buffer hence we use a bounce buffer to map
|
||||||
buffer into an unencrypted DMA buffer.
|
the guest buffer into an unencrypted DMA buffer.
|
||||||
|
|
||||||
Copyright (c) 2017, AMD Inc. All rights reserved.<BR>
|
Copyright (c) 2017, AMD Inc. All rights reserved.<BR>
|
||||||
Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>
|
Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>
|
||||||
@ -31,29 +31,33 @@ typedef struct {
|
|||||||
#define NO_MAPPING (VOID *) (UINTN) -1
|
#define NO_MAPPING (VOID *) (UINTN) -1
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Provides the controller-specific addresses required to access system memory from a
|
Provides the controller-specific addresses required to access system memory
|
||||||
DMA bus master. On SEV guest, the DMA operations must be performed on shared
|
from a DMA bus master. On SEV guest, the DMA operations must be performed on
|
||||||
buffer hence we allocate a bounce buffer to map the HostAddress to a DeviceAddress.
|
shared buffer hence we allocate a bounce buffer to map the HostAddress to a
|
||||||
The Encryption attribute is removed from the DeviceAddress buffer.
|
DeviceAddress. The Encryption attribute is removed from the DeviceAddress
|
||||||
|
buffer.
|
||||||
|
|
||||||
@param This The protocol instance pointer.
|
@param This The protocol instance pointer.
|
||||||
@param Operation Indicates if the bus master is going to read or
|
@param Operation Indicates if the bus master is going to read or
|
||||||
write to system memory.
|
write to system memory.
|
||||||
@param HostAddress The system memory address to map to the PCI controller.
|
@param HostAddress The system memory address to map to the PCI
|
||||||
|
controller.
|
||||||
@param NumberOfBytes On input the number of bytes to map. On output
|
@param NumberOfBytes On input the number of bytes to map. On output
|
||||||
the number of bytes
|
the number of bytes that were mapped.
|
||||||
that were mapped.
|
@param DeviceAddress The resulting map address for the bus master
|
||||||
@param DeviceAddress The resulting map address for the bus master PCI
|
PCI controller to use to access the hosts
|
||||||
controller to use to
|
HostAddress.
|
||||||
access the hosts HostAddress.
|
|
||||||
@param Mapping A resulting value to pass to Unmap().
|
@param Mapping A resulting value to pass to Unmap().
|
||||||
|
|
||||||
@retval EFI_SUCCESS The range was mapped for the returned NumberOfBytes.
|
@retval EFI_SUCCESS The range was mapped for the returned
|
||||||
@retval EFI_UNSUPPORTED The HostAddress cannot be mapped as a common buffer.
|
NumberOfBytes.
|
||||||
|
@retval EFI_UNSUPPORTED The HostAddress cannot be mapped as a common
|
||||||
|
buffer.
|
||||||
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.
|
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.
|
||||||
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack
|
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a
|
||||||
of resources.
|
lack of resources.
|
||||||
@retval EFI_DEVICE_ERROR The system hardware could not map the requested address.
|
@retval EFI_DEVICE_ERROR The system hardware could not map the requested
|
||||||
|
address.
|
||||||
|
|
||||||
**/
|
**/
|
||||||
EFI_STATUS
|
EFI_STATUS
|
||||||
@ -105,8 +109,8 @@ IoMmuMap (
|
|||||||
Operation == EdkiiIoMmuOperationBusMasterCommonBuffer64) {
|
Operation == EdkiiIoMmuOperationBusMasterCommonBuffer64) {
|
||||||
//
|
//
|
||||||
// Common Buffer operations can not be remapped. If the common buffer
|
// Common Buffer operations can not be remapped. If the common buffer
|
||||||
// if above 4GB, then it is not possible to generate a mapping, so return
|
// if above 4GB, then it is not possible to generate a mapping, so
|
||||||
// an error.
|
// return an error.
|
||||||
//
|
//
|
||||||
return EFI_UNSUPPORTED;
|
return EFI_UNSUPPORTED;
|
||||||
}
|
}
|
||||||
@ -161,7 +165,12 @@ IoMmuMap (
|
|||||||
//
|
//
|
||||||
// Clear the memory encryption mask from the device buffer
|
// Clear the memory encryption mask from the device buffer
|
||||||
//
|
//
|
||||||
Status = MemEncryptSevClearPageEncMask (0, MapInfo->DeviceAddress, MapInfo->NumberOfPages, TRUE);
|
Status = MemEncryptSevClearPageEncMask (
|
||||||
|
0,
|
||||||
|
MapInfo->DeviceAddress,
|
||||||
|
MapInfo->NumberOfPages,
|
||||||
|
TRUE
|
||||||
|
);
|
||||||
ASSERT_EFI_ERROR(Status);
|
ASSERT_EFI_ERROR(Status);
|
||||||
|
|
||||||
//
|
//
|
||||||
@ -188,9 +197,15 @@ IoMmuMap (
|
|||||||
//
|
//
|
||||||
*Mapping = MapInfo;
|
*Mapping = MapInfo;
|
||||||
|
|
||||||
DEBUG ((DEBUG_VERBOSE, "%a Device 0x%Lx Host 0x%Lx Pages 0x%Lx Bytes 0x%Lx\n",
|
DEBUG ((
|
||||||
__FUNCTION__, MapInfo->DeviceAddress, MapInfo->HostAddress,
|
DEBUG_VERBOSE,
|
||||||
MapInfo->NumberOfPages, MapInfo->NumberOfBytes));
|
"%a Device 0x%Lx Host 0x%Lx Pages 0x%Lx Bytes 0x%Lx\n",
|
||||||
|
__FUNCTION__,
|
||||||
|
MapInfo->DeviceAddress,
|
||||||
|
MapInfo->HostAddress,
|
||||||
|
MapInfo->NumberOfPages,
|
||||||
|
MapInfo->NumberOfBytes
|
||||||
|
));
|
||||||
|
|
||||||
return EFI_SUCCESS;
|
return EFI_SUCCESS;
|
||||||
}
|
}
|
||||||
@ -202,8 +217,10 @@ IoMmuMap (
|
|||||||
@param Mapping The mapping value returned from Map().
|
@param Mapping The mapping value returned from Map().
|
||||||
|
|
||||||
@retval EFI_SUCCESS The range was unmapped.
|
@retval EFI_SUCCESS The range was unmapped.
|
||||||
@retval EFI_INVALID_PARAMETER Mapping is not a value that was returned by Map().
|
@retval EFI_INVALID_PARAMETER Mapping is not a value that was returned by
|
||||||
@retval EFI_DEVICE_ERROR The data was not committed to the target system memory.
|
Map().
|
||||||
|
@retval EFI_DEVICE_ERROR The data was not committed to the target system
|
||||||
|
memory.
|
||||||
**/
|
**/
|
||||||
EFI_STATUS
|
EFI_STATUS
|
||||||
EFIAPI
|
EFIAPI
|
||||||
@ -244,13 +261,24 @@ IoMmuUnmap (
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
DEBUG ((DEBUG_VERBOSE, "%a Device 0x%Lx Host 0x%Lx Pages 0x%Lx Bytes 0x%Lx\n",
|
DEBUG ((
|
||||||
__FUNCTION__, MapInfo->DeviceAddress, MapInfo->HostAddress,
|
DEBUG_VERBOSE,
|
||||||
MapInfo->NumberOfPages, MapInfo->NumberOfBytes));
|
"%a Device 0x%Lx Host 0x%Lx Pages 0x%Lx Bytes 0x%Lx\n",
|
||||||
|
__FUNCTION__,
|
||||||
|
MapInfo->DeviceAddress,
|
||||||
|
MapInfo->HostAddress,
|
||||||
|
MapInfo->NumberOfPages,
|
||||||
|
MapInfo->NumberOfBytes
|
||||||
|
));
|
||||||
//
|
//
|
||||||
// Restore the memory encryption mask
|
// Restore the memory encryption mask
|
||||||
//
|
//
|
||||||
Status = MemEncryptSevSetPageEncMask (0, MapInfo->DeviceAddress, MapInfo->NumberOfPages, TRUE);
|
Status = MemEncryptSevSetPageEncMask (
|
||||||
|
0,
|
||||||
|
MapInfo->DeviceAddress,
|
||||||
|
MapInfo->NumberOfPages,
|
||||||
|
TRUE
|
||||||
|
);
|
||||||
ASSERT_EFI_ERROR(Status);
|
ASSERT_EFI_ERROR(Status);
|
||||||
|
|
||||||
//
|
//
|
||||||
@ -267,16 +295,18 @@ IoMmuUnmap (
|
|||||||
|
|
||||||
@param This The protocol instance pointer.
|
@param This The protocol instance pointer.
|
||||||
@param Type This parameter is not used and must be ignored.
|
@param Type This parameter is not used and must be ignored.
|
||||||
@param MemoryType The type of memory to allocate, EfiBootServicesData
|
@param MemoryType The type of memory to allocate,
|
||||||
or EfiRuntimeServicesData.
|
EfiBootServicesData or EfiRuntimeServicesData.
|
||||||
@param Pages The number of pages to allocate.
|
@param Pages The number of pages to allocate.
|
||||||
@param HostAddress A pointer to store the base system memory address
|
@param HostAddress A pointer to store the base system memory
|
||||||
of the allocated range.
|
address of the allocated range.
|
||||||
@param Attributes The requested bit mask of attributes for the allocated range.
|
@param Attributes The requested bit mask of attributes for the
|
||||||
|
allocated range.
|
||||||
|
|
||||||
@retval EFI_SUCCESS The requested memory pages were allocated.
|
@retval EFI_SUCCESS The requested memory pages were allocated.
|
||||||
@retval EFI_UNSUPPORTED Attributes is unsupported. The only legal attribute
|
@retval EFI_UNSUPPORTED Attributes is unsupported. The only legal
|
||||||
bits are MEMORY_WRITE_COMBINE and MEMORY_CACHED.
|
attribute bits are MEMORY_WRITE_COMBINE and
|
||||||
|
MEMORY_CACHED.
|
||||||
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.
|
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.
|
||||||
@retval EFI_OUT_OF_RESOURCES The memory pages could not be allocated.
|
@retval EFI_OUT_OF_RESOURCES The memory pages could not be allocated.
|
||||||
|
|
||||||
@ -341,7 +371,13 @@ IoMmuAllocateBuffer (
|
|||||||
ASSERT_EFI_ERROR(Status);
|
ASSERT_EFI_ERROR(Status);
|
||||||
}
|
}
|
||||||
|
|
||||||
DEBUG ((DEBUG_VERBOSE, "%a Address 0x%Lx Pages 0x%Lx\n", __FUNCTION__, PhysicalAddress, Pages));
|
DEBUG ((
|
||||||
|
DEBUG_VERBOSE,
|
||||||
|
"%a Address 0x%Lx Pages 0x%Lx\n",
|
||||||
|
__FUNCTION__,
|
||||||
|
PhysicalAddress,
|
||||||
|
Pages
|
||||||
|
));
|
||||||
return Status;
|
return Status;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -350,11 +386,12 @@ IoMmuAllocateBuffer (
|
|||||||
|
|
||||||
@param This The protocol instance pointer.
|
@param This The protocol instance pointer.
|
||||||
@param Pages The number of pages to free.
|
@param Pages The number of pages to free.
|
||||||
@param HostAddress The base system memory address of the allocated range.
|
@param HostAddress The base system memory address of the allocated
|
||||||
|
range.
|
||||||
|
|
||||||
@retval EFI_SUCCESS The requested memory pages were freed.
|
@retval EFI_SUCCESS The requested memory pages were freed.
|
||||||
@retval EFI_INVALID_PARAMETER The memory range specified by HostAddress and Pages
|
@retval EFI_INVALID_PARAMETER The memory range specified by HostAddress and
|
||||||
was not allocated with AllocateBuffer().
|
Pages was not allocated with AllocateBuffer().
|
||||||
|
|
||||||
**/
|
**/
|
||||||
EFI_STATUS
|
EFI_STATUS
|
||||||
@ -370,10 +407,21 @@ IoMmuFreeBuffer (
|
|||||||
//
|
//
|
||||||
// Set memory encryption mask
|
// Set memory encryption mask
|
||||||
//
|
//
|
||||||
Status = MemEncryptSevSetPageEncMask (0, (EFI_PHYSICAL_ADDRESS)(UINTN)HostAddress, Pages, TRUE);
|
Status = MemEncryptSevSetPageEncMask (
|
||||||
|
0,
|
||||||
|
(EFI_PHYSICAL_ADDRESS)(UINTN)HostAddress,
|
||||||
|
Pages,
|
||||||
|
TRUE
|
||||||
|
);
|
||||||
ASSERT_EFI_ERROR(Status);
|
ASSERT_EFI_ERROR(Status);
|
||||||
|
|
||||||
DEBUG ((DEBUG_VERBOSE, "%a Address 0x%Lx Pages 0x%Lx\n", __FUNCTION__, (UINTN)HostAddress, Pages));
|
DEBUG ((
|
||||||
|
DEBUG_VERBOSE,
|
||||||
|
"%a Address 0x%Lx Pages 0x%Lx\n",
|
||||||
|
__FUNCTION__,
|
||||||
|
(UINTN)HostAddress,
|
||||||
|
Pages
|
||||||
|
));
|
||||||
return gBS->FreePages ((EFI_PHYSICAL_ADDRESS) (UINTN) HostAddress, Pages);
|
return gBS->FreePages ((EFI_PHYSICAL_ADDRESS) (UINTN) HostAddress, Pages);
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -389,30 +437,41 @@ IoMmuFreeBuffer (
|
|||||||
attribute to request DMA access (read and/or write).
|
attribute to request DMA access (read and/or write).
|
||||||
|
|
||||||
The DeviceHandle is used to identify which device submits the request.
|
The DeviceHandle is used to identify which device submits the request.
|
||||||
The IOMMU implementation need translate the device path to an IOMMU device ID,
|
The IOMMU implementation need translate the device path to an IOMMU device
|
||||||
and set IOMMU hardware register accordingly.
|
ID, and set IOMMU hardware register accordingly.
|
||||||
1) DeviceHandle can be a standard PCI device.
|
1) DeviceHandle can be a standard PCI device.
|
||||||
The memory for BusMasterRead need set EDKII_IOMMU_ACCESS_READ.
|
The memory for BusMasterRead need set EDKII_IOMMU_ACCESS_READ.
|
||||||
The memory for BusMasterWrite need set EDKII_IOMMU_ACCESS_WRITE.
|
The memory for BusMasterWrite need set EDKII_IOMMU_ACCESS_WRITE.
|
||||||
The memory for BusMasterCommonBuffer need set EDKII_IOMMU_ACCESS_READ|EDKII_IOMMU_ACCESS_WRITE.
|
The memory for BusMasterCommonBuffer need set
|
||||||
After the memory is used, the memory need set 0 to keep it being protected.
|
EDKII_IOMMU_ACCESS_READ|EDKII_IOMMU_ACCESS_WRITE.
|
||||||
|
After the memory is used, the memory need set 0 to keep it being
|
||||||
|
protected.
|
||||||
2) DeviceHandle can be an ACPI device (ISA, I2C, SPI, etc).
|
2) DeviceHandle can be an ACPI device (ISA, I2C, SPI, etc).
|
||||||
The memory for DMA access need set EDKII_IOMMU_ACCESS_READ and/or EDKII_IOMMU_ACCESS_WRITE.
|
The memory for DMA access need set EDKII_IOMMU_ACCESS_READ and/or
|
||||||
|
EDKII_IOMMU_ACCESS_WRITE.
|
||||||
|
|
||||||
@param[in] This The protocol instance pointer.
|
@param[in] This The protocol instance pointer.
|
||||||
@param[in] DeviceHandle The device who initiates the DMA access request.
|
@param[in] DeviceHandle The device who initiates the DMA access
|
||||||
|
request.
|
||||||
@param[in] Mapping The mapping value returned from Map().
|
@param[in] Mapping The mapping value returned from Map().
|
||||||
@param[in] IoMmuAccess The IOMMU access.
|
@param[in] IoMmuAccess The IOMMU access.
|
||||||
|
|
||||||
@retval EFI_SUCCESS The IoMmuAccess is set for the memory range specified by DeviceAddress and Length.
|
@retval EFI_SUCCESS The IoMmuAccess is set for the memory range
|
||||||
|
specified by DeviceAddress and Length.
|
||||||
@retval EFI_INVALID_PARAMETER DeviceHandle is an invalid handle.
|
@retval EFI_INVALID_PARAMETER DeviceHandle is an invalid handle.
|
||||||
@retval EFI_INVALID_PARAMETER Mapping is not a value that was returned by Map().
|
@retval EFI_INVALID_PARAMETER Mapping is not a value that was returned by
|
||||||
@retval EFI_INVALID_PARAMETER IoMmuAccess specified an illegal combination of access.
|
Map().
|
||||||
|
@retval EFI_INVALID_PARAMETER IoMmuAccess specified an illegal combination
|
||||||
|
of access.
|
||||||
@retval EFI_UNSUPPORTED DeviceHandle is unknown by the IOMMU.
|
@retval EFI_UNSUPPORTED DeviceHandle is unknown by the IOMMU.
|
||||||
@retval EFI_UNSUPPORTED The bit mask of IoMmuAccess is not supported by the IOMMU.
|
@retval EFI_UNSUPPORTED The bit mask of IoMmuAccess is not supported
|
||||||
@retval EFI_UNSUPPORTED The IOMMU does not support the memory range specified by Mapping.
|
by the IOMMU.
|
||||||
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to modify the IOMMU access.
|
@retval EFI_UNSUPPORTED The IOMMU does not support the memory range
|
||||||
@retval EFI_DEVICE_ERROR The IOMMU device reported an error while attempting the operation.
|
specified by Mapping.
|
||||||
|
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to
|
||||||
|
modify the IOMMU access.
|
||||||
|
@retval EFI_DEVICE_ERROR The IOMMU device reported an error while
|
||||||
|
attempting the operation.
|
||||||
|
|
||||||
**/
|
**/
|
||||||
EFI_STATUS
|
EFI_STATUS
|
||||||
|
|||||||
@ -1,9 +1,9 @@
|
|||||||
/** @file
|
/** @file
|
||||||
|
|
||||||
The protocol provides support to allocate, free, map and umap a DMA buffer for
|
The protocol provides support to allocate, free, map and umap a DMA buffer
|
||||||
bus master (e.g PciHostBridge). When SEV is enabled, the DMA operations must
|
for bus master (e.g PciHostBridge). When SEV is enabled, the DMA operations
|
||||||
be performed on unencrypted buffer hence protocol clear the encryption bit
|
must be performed on unencrypted buffer hence protocol clear the encryption
|
||||||
from the DMA buffer.
|
bit from the DMA buffer.
|
||||||
|
|
||||||
Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>
|
Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>
|
||||||
Copyright (c) 2017, AMD Inc. All rights reserved.<BR>
|
Copyright (c) 2017, AMD Inc. All rights reserved.<BR>
|
||||||
|
|||||||
@ -5,10 +5,10 @@
|
|||||||
|
|
||||||
Copyright (c) 2017, AMD Inc. All rights reserved.<BR>
|
Copyright (c) 2017, AMD Inc. All rights reserved.<BR>
|
||||||
|
|
||||||
This program and the accompanying materials
|
This program and the accompanying materials are licensed and made available
|
||||||
are licensed and made available under the terms and conditions of the BSD
|
under the terms and conditions of the BSD License which accompanies this
|
||||||
License which accompanies this distribution. The full text of the license may
|
distribution. The full text of the license may be found at
|
||||||
be found at http://opensource.org/licenses/bsd-license.php
|
http://opensource.org/licenses/bsd-license.php
|
||||||
|
|
||||||
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||||
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||||
|
|||||||
@ -5,13 +5,14 @@
|
|||||||
#
|
#
|
||||||
# Copyright (c) 2017, AMD Inc. All rights reserved.<BR>
|
# Copyright (c) 2017, AMD Inc. All rights reserved.<BR>
|
||||||
#
|
#
|
||||||
# This program and the accompanying materials
|
# This program and the accompanying materials are licensed and made available
|
||||||
# are licensed and made available under the terms and conditions of the BSD
|
# under the terms and conditions of the BSD License which accompanies this
|
||||||
# License which accompanies this distribution. The full text of the license may
|
# distribution. The full text of the license may be found at
|
||||||
# be found at http://opensource.org/licenses/bsd-license.php
|
# http://opensource.org/licenses/bsd-license.php
|
||||||
#
|
#
|
||||||
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||||
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR
|
||||||
|
# IMPLIED.
|
||||||
#
|
#
|
||||||
#**/
|
#**/
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user