OvmfPkg/MemEncryptSevLib: clean up InternalMemEncryptSevSetMemoryDecrypted() decl

The declaration and the definition(s) of the function should have
identical leading comments and/or identical parameter lists. Document the
"Cr3BaseAddress" parameter, and correct several parameter references.
Replace a "set" reference to the C-bit with a "clear" reference.

Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Cc: Brijesh Singh <brijesh.singh@amd.com>
Cc: Jordan Justen <jordan.l.justen@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
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 2018-03-01 15:15:39 +01:00
parent cde8c56809
commit 1532e5d5ed
2 changed files with 12 additions and 8 deletions

View File

@ -826,8 +826,10 @@ Done:
/** /**
This function clears memory encryption bit for the memory region specified by This function clears memory encryption bit for the memory region specified by
PhysicalAddress and length from the current page table context. PhysicalAddress and Length from the current page table context.
@param[in] Cr3BaseAddress Cr3 Base Address (if zero then use
current CR3)
@param[in] PhysicalAddress The physical address that is the start @param[in] PhysicalAddress The physical address that is the start
address of a memory region. address of a memory region.
@param[in] Length The length of memory region @param[in] Length The length of memory region
@ -837,7 +839,7 @@ Done:
@retval RETURN_SUCCESS The attributes were cleared for the @retval RETURN_SUCCESS The attributes were cleared for the
memory region. memory region.
@retval RETURN_INVALID_PARAMETER Number of pages is zero. @retval RETURN_INVALID_PARAMETER Number of pages is zero.
@retval RETURN_UNSUPPORTED Setting the memory encyrption attribute @retval RETURN_UNSUPPORTED Clearing the memory encyrption attribute
is not supported is not supported
**/ **/
RETURN_STATUS RETURN_STATUS

View File

@ -188,8 +188,10 @@ typedef struct {
/** /**
This function clears memory encryption bit for the memory region specified by This function clears memory encryption bit for the memory region specified by
PhysicalAddress and length from the current page table context. PhysicalAddress and Length from the current page table context.
@param[in] Cr3BaseAddress Cr3 Base Address (if zero then use
current CR3)
@param[in] PhysicalAddress The physical address that is the start @param[in] PhysicalAddress The physical address that is the start
address of a memory region. address of a memory region.
@param[in] Length The length of memory region @param[in] Length The length of memory region
@ -199,16 +201,16 @@ typedef struct {
@retval RETURN_SUCCESS The attributes were cleared for the @retval RETURN_SUCCESS The attributes were cleared for the
memory region. memory region.
@retval RETURN_INVALID_PARAMETER Number of pages is zero. @retval RETURN_INVALID_PARAMETER Number of pages is zero.
@retval RETURN_UNSUPPORTED Setting the memory encyrption attribute @retval RETURN_UNSUPPORTED Clearing the memory encyrption attribute
is not supported is not supported
**/ **/
RETURN_STATUS RETURN_STATUS
EFIAPI EFIAPI
InternalMemEncryptSevSetMemoryDecrypted ( InternalMemEncryptSevSetMemoryDecrypted (
IN PHYSICAL_ADDRESS Cr3BaseAddress, IN PHYSICAL_ADDRESS Cr3BaseAddress,
IN PHYSICAL_ADDRESS PhysicalAddress, IN PHYSICAL_ADDRESS PhysicalAddress,
IN UINT64 Length, IN UINTN Length,
IN BOOLEAN CacheFlush IN BOOLEAN Flush
); );
/** /**