OvmfPkg: Apply uncrustify changes

[mirror_edk2.git] / OvmfPkg / Library / BaseMemEncryptSevLib / X64 / VirtualMemory.h

/** @file\r
\r
  Virtual Memory Management Services to set or clear the memory encryption bit\r
\r
  Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
  Copyright (c) 2017 - 2020, AMD Incorporated. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
  Code is derived from MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.h\r
\r
**/\r
\r
#ifndef __VIRTUAL_MEMORY__\r
#define __VIRTUAL_MEMORY__\r
\r
#include <IndustryStandard/PageTable.h>\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/CacheMaintenanceLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Uefi.h>\r
\r
#define SYS_CODE64_SEL  0x38\r
\r
#define PAGE_TABLE_POOL_ALIGNMENT  BASE_2MB\r
#define PAGE_TABLE_POOL_UNIT_SIZE  SIZE_2MB\r
#define PAGE_TABLE_POOL_UNIT_PAGES  \\r
  EFI_SIZE_TO_PAGES (PAGE_TABLE_POOL_UNIT_SIZE)\r
#define PAGE_TABLE_POOL_ALIGN_MASK  \\r
  (~(EFI_PHYSICAL_ADDRESS)(PAGE_TABLE_POOL_ALIGNMENT - 1))\r
\r
typedef struct {\r
  VOID     *NextPool;\r
  UINTN    Offset;\r
  UINTN    FreePages;\r
} PAGE_TABLE_POOL;\r
\r
/**\r
  Return the pagetable memory encryption mask.\r
\r
  @return  The pagetable memory encryption mask.\r
\r
**/\r
UINT64\r
EFIAPI\r
InternalGetMemEncryptionAddressMask (\r
  VOID\r
  );\r
\r
/**\r
  This function clears memory encryption bit for the memory region specified by\r
  PhysicalAddress and Length from the current page table context.\r
\r
  @param[in]  Cr3BaseAddress          Cr3 Base Address (if zero then use\r
                                      current CR3)\r
  @param[in]  PhysicalAddress         The physical address that is the start\r
                                      address of a memory region.\r
  @param[in]  Length                  The length of memory region\r
\r
  @retval RETURN_SUCCESS              The attributes were cleared for the\r
                                      memory region.\r
  @retval RETURN_INVALID_PARAMETER    Number of pages is zero.\r
  @retval RETURN_UNSUPPORTED          Clearing the memory encyrption attribute\r
                                      is not supported\r
**/\r
RETURN_STATUS\r
EFIAPI\r
InternalMemEncryptSevSetMemoryDecrypted (\r
  IN  PHYSICAL_ADDRESS  Cr3BaseAddress,\r
  IN  PHYSICAL_ADDRESS  PhysicalAddress,\r
  IN  UINTN             Length\r
  );\r
\r
/**\r
  This function sets memory encryption bit for the memory region specified by\r
  PhysicalAddress and Length from the current page table context.\r
\r
  @param[in]  Cr3BaseAddress          Cr3 Base Address (if zero then use\r
                                      current CR3)\r
  @param[in]  PhysicalAddress         The physical address that is the start\r
                                      address of a memory region.\r
  @param[in]  Length                  The length of memory region\r
\r
  @retval RETURN_SUCCESS              The attributes were set for the memory\r
                                      region.\r
  @retval RETURN_INVALID_PARAMETER    Number of pages is zero.\r
  @retval RETURN_UNSUPPORTED          Setting the memory encyrption attribute\r
                                      is not supported\r
**/\r
RETURN_STATUS\r
EFIAPI\r
InternalMemEncryptSevSetMemoryEncrypted (\r
  IN  PHYSICAL_ADDRESS  Cr3BaseAddress,\r
  IN  PHYSICAL_ADDRESS  PhysicalAddress,\r
  IN  UINTN             Length\r
  );\r
\r
/**\r
  Returns the encryption state of the specified virtual address range.\r
\r
  @param[in]  Cr3BaseAddress          Cr3 Base Address (if zero then use\r
                                      current CR3)\r
  @param[in]  BaseAddress             Base address to check\r
  @param[in]  Length                  Length of virtual address range\r
\r
  @retval MemEncryptSevAddressRangeUnencrypted  Address range is mapped\r
                                                unencrypted\r
  @retval MemEncryptSevAddressRangeEncrypted    Address range is mapped\r
                                                encrypted\r
  @retval MemEncryptSevAddressRangeMixed        Address range is mapped mixed\r
  @retval MemEncryptSevAddressRangeError        Address range is not mapped\r
**/\r
MEM_ENCRYPT_SEV_ADDRESS_RANGE_STATE\r
EFIAPI\r
InternalMemEncryptSevGetAddressRangeState (\r
  IN PHYSICAL_ADDRESS  Cr3BaseAddress,\r
  IN PHYSICAL_ADDRESS  BaseAddress,\r
  IN UINTN             Length\r
  );\r
\r
/**\r
  This function clears memory encryption bit for the MMIO region specified by\r
  PhysicalAddress and Length.\r
\r
  @param[in]  Cr3BaseAddress          Cr3 Base Address (if zero then use\r
                                      current CR3)\r
  @param[in]  PhysicalAddress         The physical address that is the start\r
                                      address of a MMIO region.\r
  @param[in]  Length                  The length of memory region\r
\r
  @retval RETURN_SUCCESS              The attributes were cleared for the\r
                                      memory region.\r
  @retval RETURN_INVALID_PARAMETER    Length is zero.\r
  @retval RETURN_UNSUPPORTED          Clearing the memory encyrption attribute\r
                                      is not supported\r
**/\r
RETURN_STATUS\r
EFIAPI\r
InternalMemEncryptSevClearMmioPageEncMask (\r
  IN  PHYSICAL_ADDRESS  Cr3BaseAddress,\r
  IN  PHYSICAL_ADDRESS  PhysicalAddress,\r
  IN  UINTN             Length\r
  );\r
\r
#endif\r