OvmfPkg/MemEncryptSevLib: Address range encryption state interface

[mirror_edk2.git] / OvmfPkg / Include / Library / MemEncryptSevLib.h

/** @file\r
\r
  Define Secure Encrypted Virtualization (SEV) base library helper function\r
\r
  Copyright (c) 2017 - 2020, AMD Incorporated. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _MEM_ENCRYPT_SEV_LIB_H_\r
#define _MEM_ENCRYPT_SEV_LIB_H_\r
\r
#include <Base.h>\r
\r
//\r
// Internal structure for holding SEV-ES information needed during SEC phase\r
// and valid only during SEC phase and early PEI during platform\r
// initialization.\r
//\r
// This structure is also used by assembler files:\r
//   OvmfPkg/ResetVector/ResetVector.nasmb\r
//   OvmfPkg/ResetVector/Ia32/PageTables64.asm\r
//   OvmfPkg/ResetVector/Ia32/Flat32ToFlat64.asm\r
// any changes must stay in sync with its usage.\r
//\r
typedef struct _SEC_SEV_ES_WORK_AREA {\r
  UINT8    SevEsEnabled;\r
  UINT8    Reserved1[7];\r
\r
  UINT64   RandomData;\r
\r
  UINT64   EncryptionMask;\r
} SEC_SEV_ES_WORK_AREA;\r
\r
//\r
// Memory encryption address range states.\r
//\r
typedef enum {\r
  MemEncryptSevAddressRangeUnencrypted,\r
  MemEncryptSevAddressRangeEncrypted,\r
  MemEncryptSevAddressRangeMixed,\r
  MemEncryptSevAddressRangeError,\r
} MEM_ENCRYPT_SEV_ADDRESS_RANGE_STATE;\r
\r
/**\r
  Returns a boolean to indicate whether SEV-ES is enabled.\r
\r
  @retval TRUE           SEV-ES is enabled\r
  @retval FALSE          SEV-ES is not enabled\r
**/\r
BOOLEAN\r
EFIAPI\r
MemEncryptSevEsIsEnabled (\r
  VOID\r
  );\r
\r
/**\r
  Returns a boolean to indicate whether SEV is enabled\r
\r
  @retval TRUE           SEV is enabled\r
  @retval FALSE          SEV is not enabled\r
**/\r
BOOLEAN\r
EFIAPI\r
MemEncryptSevIsEnabled (\r
  VOID\r
  );\r
\r
/**\r
  This function clears memory encryption bit for the memory region specified by\r
  BaseAddress and NumPages from the current page table context.\r
\r
  @param[in]  Cr3BaseAddress          Cr3 Base Address (if zero then use\r
                                      current CR3)\r
  @param[in]  BaseAddress             The physical address that is the start\r
                                      address of a memory region.\r
  @param[in]  NumPages                The number of pages from start memory\r
                                      region.\r
  @param[in]  Flush                   Flush the caches before clearing the bit\r
                                      (mostly TRUE except MMIO addresses)\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 encryption attribute\r
                                      is not supported\r
**/\r
RETURN_STATUS\r
EFIAPI\r
MemEncryptSevClearPageEncMask (\r
  IN PHYSICAL_ADDRESS         Cr3BaseAddress,\r
  IN PHYSICAL_ADDRESS         BaseAddress,\r
  IN UINTN                    NumPages,\r
  IN BOOLEAN                  Flush\r
  );\r
\r
/**\r
  This function sets memory encryption bit for the memory region specified by\r
  BaseAddress and NumPages from the current page table context.\r
\r
  @param[in]  Cr3BaseAddress          Cr3 Base Address (if zero then use\r
                                      current CR3)\r
  @param[in]  BaseAddress             The physical address that is the start\r
                                      address of a memory region.\r
  @param[in]  NumPages                The number of pages from start memory\r
                                      region.\r
  @param[in]  Flush                   Flush the caches before setting the bit\r
                                      (mostly TRUE except MMIO addresses)\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 encryption attribute\r
                                      is not supported\r
**/\r
RETURN_STATUS\r
EFIAPI\r
MemEncryptSevSetPageEncMask (\r
  IN PHYSICAL_ADDRESS         Cr3BaseAddress,\r
  IN PHYSICAL_ADDRESS         BaseAddress,\r
  IN UINTN                    NumPages,\r
  IN BOOLEAN                  Flush\r
  );\r
\r
\r
/**\r
  Locate the page range that covers the initial (pre-SMBASE-relocation) SMRAM\r
  Save State Map.\r
\r
  @param[out] BaseAddress     The base address of the lowest-address page that\r
                              covers the initial SMRAM Save State Map.\r
\r
  @param[out] NumberOfPages   The number of pages in the page range that covers\r
                              the initial SMRAM Save State Map.\r
\r
  @retval RETURN_SUCCESS      BaseAddress and NumberOfPages have been set on\r
                              output.\r
\r
  @retval RETURN_UNSUPPORTED  SMM is unavailable.\r
**/\r
RETURN_STATUS\r
EFIAPI\r
MemEncryptSevLocateInitialSmramSaveStateMapPages (\r
  OUT UINTN *BaseAddress,\r
  OUT UINTN *NumberOfPages\r
  );\r
\r
/**\r
  Returns the SEV encryption mask.\r
\r
  @return  The SEV pagetable encryption mask\r
**/\r
UINT64\r
EFIAPI\r
MemEncryptSevGetEncryptionMask (\r
  VOID\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
MemEncryptSevGetAddressRangeState (\r
  IN PHYSICAL_ADDRESS         Cr3BaseAddress,\r
  IN PHYSICAL_ADDRESS         BaseAddress,\r
  IN UINTN                    Length\r
  );\r
\r
#endif // _MEM_ENCRYPT_SEV_LIB_H_\r