audk/UefiCpuPkg/Include/Library/AmdSvsmLib.h

102 lines
2.4 KiB
C

/** @file
Public header file for the AmdSvsmLib.
This library class defines some routines used for invoking an SVSM when the
guest is not running at VMPL0.
Copyright (C) 2024, Advanced Micro Devices, Inc. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#ifndef AMD_SVSM_LIB_H_
#define AMD_SVSM_LIB_H_
#include <Protocol/DebugSupport.h>
#include <Register/Amd/Ghcb.h>
/**
Report the presence of an Secure Virtual Services Module (SVSM).
Determines the presence of an SVSM.
@retval TRUE An SVSM is present
@retval FALSE An SVSM is not present
**/
BOOLEAN
EFIAPI
AmdSvsmIsSvsmPresent (
VOID
);
/**
Report the VMPL level at which the SEV-SNP guest is running.
Determines the VMPL level at which the guest is running. If an SVSM is
not present, then it must be VMPL0, otherwise return what is reported
by the SVSM.
@return The VMPL level
**/
UINT8
EFIAPI
AmdSvsmSnpGetVmpl (
VOID
);
/**
Report the Calling Area address (CAA) for the BSP of the SEV-SNP guest.
If an SVSM is present, the CAA for the BSP is returned.
@return The CAA
**/
UINT64
EFIAPI
AmdSvsmSnpGetCaa (
VOID
);
/**
Perform a PVALIDATE operation for the page ranges specified.
Validate or rescind the validation of the specified pages.
@param[in] Info Pointer to a page state change structure
**/
VOID
EFIAPI
AmdSvsmSnpPvalidate (
IN SNP_PAGE_STATE_CHANGE_INFO *Info
);
/**
Perform an RMPADJUST operation to alter the VMSA setting of a page.
Add or remove the VMSA attribute for a page.
@param[in] Vmsa Pointer to an SEV-ES save area page
@param[in] ApicId APIC ID associated with the VMSA
@param[in] SetVmsa Boolean indicator as to whether to set or
or clear the VMSA setting for the page
@retval EFI_SUCCESS RMPADJUST operation successful
@retval EFI_UNSUPPORTED Operation is not supported
@retval EFI_INVALID_PARAMETER RMPADJUST operation failed, an invalid
parameter was supplied
**/
EFI_STATUS
EFIAPI
AmdSvsmSnpVmsaRmpAdjust (
IN SEV_ES_SAVE_AREA *Vmsa,
IN UINT32 ApicId,
IN BOOLEAN SetVmsa
);
#endif