OvmfPkg/IoMmuDxe: Reserve shared memory region for DMA operation

[mirror_edk2.git] / OvmfPkg / IoMmuDxe / IoMmuInternal.h

/** @file\r
\r
  Copyright (c) 2022, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef IOMMU_INTERNAL_H_\r
#define IOMMU_INTERNAL_H_\r
\r
#include <Base.h>\r
#include <Protocol/IoMmu.h>\r
#include <Uefi/UefiBaseType.h>\r
#include <Uefi/UefiSpec.h>\r
\r
#define MAP_INFO_SIG  SIGNATURE_64 ('M', 'A', 'P', '_', 'I', 'N', 'F', 'O')\r
\r
typedef struct {\r
  UINT64                   Signature;\r
  LIST_ENTRY               Link;\r
  EDKII_IOMMU_OPERATION    Operation;\r
  UINTN                    NumberOfBytes;\r
  UINTN                    NumberOfPages;\r
  EFI_PHYSICAL_ADDRESS     CryptedAddress;\r
  EFI_PHYSICAL_ADDRESS     PlainTextAddress;\r
  UINT32                   ReservedMemBitmap;\r
} MAP_INFO;\r
\r
#define COMMON_BUFFER_SIG  SIGNATURE_64 ('C', 'M', 'N', 'B', 'U', 'F', 'F', 'R')\r
\r
#pragma pack (1)\r
//\r
// The following structure enables Map() and Unmap() to perform in-place\r
// decryption and encryption, respectively, for BusMasterCommonBuffer[64]\r
// operations, without dynamic memory allocation or release.\r
//\r
// Both COMMON_BUFFER_HEADER and COMMON_BUFFER_HEADER.StashBuffer are allocated\r
// by AllocateBuffer() and released by FreeBuffer().\r
//\r
typedef struct {\r
  UINT64    Signature;\r
\r
  //\r
  // Always allocated from EfiBootServicesData type memory, and always\r
  // encrypted.\r
  //\r
  VOID      *StashBuffer;\r
\r
  //\r
  // Bitmap of reserved memory\r
  //\r
  UINT32    ReservedMemBitmap;\r
\r
  //\r
  // Followed by the actual common buffer, starting at the next page.\r
  //\r
} COMMON_BUFFER_HEADER;\r
\r
//\r
// This data structure defines a memory range in the reserved memory region.\r
// Please refer to IoMmuInitReservedSharedMem() for detailed information.\r
//\r
// The memory region looks like:\r
//     |------------|----------------------------|\r
//     | Header     |    Data                    |\r
//     | 4k, private| 4k/32k/128k/etc, shared    |\r
//     |-----------------------------------------|\r
//\r
typedef struct {\r
  UINT32                  BitmapMask;\r
  UINT32                  Shift;\r
  UINT32                  Slots;\r
  UINT32                  DataSize;\r
  UINT32                  HeaderSize;\r
  EFI_PHYSICAL_ADDRESS    StartAddressOfMemRange;\r
} IOMMU_RESERVED_MEM_RANGE;\r
#pragma pack()\r
\r
/**\r
 * Allocate a memory region and convert it to be shared. This memory region will be\r
 * used in the DMA operation.\r
 *\r
 * The pre-alloc memory contains pieces of memory regions with different size. The\r
 * allocation of the shared memory regions are indicated by a 32-bit bitmap (mReservedMemBitmap).\r
 *\r
 * The memory regions are consumed by IoMmuAllocateBuffer (in which CommonBuffer is allocated) and\r
 * IoMmuMap (in which bounce buffer is allocated).\r
 *\r
 * The CommonBuffer contains 2 parts, one page for CommonBufferHeader which is private memory,\r
 * the other part is shared memory. So the layout of a piece of memory region after initialization\r
 * looks like:\r
 *\r
 *     |------------|----------------------------|\r
 *     | Header     |    Data                    |  <-- a piece of pre-alloc memory region\r
 *     | 4k, private| 4k/32k/128k/etc, shared    |\r
 *     |-----------------------------------------|\r
 *\r
 * @retval EFI_SUCCESS      Successfully initialize the reserved memory.\r
 * @retval EFI_UNSUPPORTED  This feature is not supported.\r
 */\r
EFI_STATUS\r
IoMmuInitReservedSharedMem (\r
  VOID\r
  );\r
\r
/**\r
 * Release the pre-alloc shared memory.\r
 *\r
 * @retval EFI_SUCCESS  Successfully release the shared memory\r
 */\r
EFI_STATUS\r
IoMmuReleaseReservedSharedMem (\r
  BOOLEAN  MemoryMapLocked\r
  );\r
\r
/**\r
 * Allocate reserved shared memory for bounce buffer.\r
 *\r
 * @param Type        Allocate type\r
 * @param MemoryType  The memory type to be allocated\r
 * @param MapInfo     Pointer to the MAP_INFO\r
 *\r
 * @retval EFI_SUCCESS        Successfully allocate the bounce buffer\r
 * @retval Other              As the error code indicates\r
 */\r
EFI_STATUS\r
IoMmuAllocateBounceBuffer (\r
  IN     EFI_ALLOCATE_TYPE  Type,\r
  IN     EFI_MEMORY_TYPE    MemoryType,\r
  IN OUT MAP_INFO           *MapInfo\r
  );\r
\r
/**\r
 * Free the bounce buffer allocated in IoMmuAllocateBounceBuffer.\r
 *\r
 * @param MapInfo       Pointer to the MAP_INFO\r
 * @return EFI_SUCCESS  Successfully free the bounce buffer.\r
 */\r
EFI_STATUS\r
IoMmuFreeBounceBuffer (\r
  IN OUT     MAP_INFO  *MapInfo\r
  );\r
\r
/**\r
 * Allocate CommonBuffer from pre-allocated shared memory.\r
 *\r
 * @param MemoryType          Memory type\r
 * @param CommonBufferPages   Pages of CommonBuffer\r
 * @param PhysicalAddress     Allocated physical address\r
 * @param ReservedMemBitmap   Bitmap which indicates the allocation of reserved memory\r
 *\r
 * @retval EFI_SUCCESS        Successfully allocate the common buffer\r
 * @retval Other              As the error code indicates\r
 */\r
EFI_STATUS\r
IoMmuAllocateCommonBuffer (\r
  IN EFI_MEMORY_TYPE        MemoryType,\r
  IN UINTN                  CommonBufferPages,\r
  OUT EFI_PHYSICAL_ADDRESS  *PhysicalAddress,\r
  OUT UINT32                *ReservedMemBitmap\r
  );\r
\r
/**\r
 * Free CommonBuffer which is allocated by IoMmuAllocateCommonBuffer().\r
 *\r
 * @param CommonBufferHeader  Pointer to the CommonBufferHeader\r
 * @param CommonBufferPages   Pages of CommonBuffer\r
 *\r
 * @retval EFI_SUCCESS        Successfully free the common buffer\r
 * @retval Other              As the error code indicates\r
 */\r
EFI_STATUS\r
IoMmuFreeCommonBuffer (\r
  IN COMMON_BUFFER_HEADER  *CommonBufferHeader,\r
  IN UINTN                 CommonBufferPages\r
  );\r
\r
#endif\r