From 154dcd6c58a397a6d31a8fe0bc3dab70b916f33a Mon Sep 17 00:00:00 2001 From: Laszlo Ersek Date: Thu, 1 Mar 2018 14:41:01 +0100 Subject: [PATCH] OvmfPkg/MemEncryptSevLib: clean up MemEncryptSevSetPageEncMask() decl The declaration and the definition(s) of the function should have identical leading comments and/or identical parameter lists. Replace any leftover "clear" references to the C-bit with "set" references. Also remove any excess space in the comment block, and unindent the trailing "**/" if necessary. Correct several parameter references. Cc: Ard Biesheuvel Cc: Brijesh Singh Cc: Jordan Justen Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Laszlo Ersek Tested-by: Brijesh Singh Reviewed-by: Brijesh Singh --- OvmfPkg/Include/Library/MemEncryptSevLib.h | 32 ++++++++++--------- .../Ia32/MemEncryptSevLib.c | 32 +++++++++---------- .../X64/MemEncryptSevLib.c | 17 +++++----- 3 files changed, 41 insertions(+), 40 deletions(-) diff --git a/OvmfPkg/Include/Library/MemEncryptSevLib.h b/OvmfPkg/Include/Library/MemEncryptSevLib.h index 2d574dd306..e5ebb44018 100644 --- a/OvmfPkg/Include/Library/MemEncryptSevLib.h +++ b/OvmfPkg/Include/Library/MemEncryptSevLib.h @@ -61,27 +61,29 @@ MemEncryptSevClearPageEncMask ( /** This function sets memory encryption bit for the memory region specified by - BaseAddress and Number of pages from the current page table context. + BaseAddress and NumPages from the current page table context. - @param[in] BaseAddress The physical address that is the start - address of a memory region. - @param[in] NumberOfPages The number of pages from start memory - region. - @param[in] Flush Flush the caches before clearing the bit - (mostly TRUE except MMIO addresses) + @param[in] Cr3BaseAddress Cr3 Base Address (if zero then use + current CR3) + @param[in] BaseAddress The physical address that is the start + address of a memory region. + @param[in] NumPages The number of pages from start memory + region. + @param[in] Flush Flush the caches before setting the bit + (mostly TRUE except MMIO addresses) - @retval RETURN_SUCCESS The attributes were set for the memory - region. - @retval RETURN_INVALID_PARAMETER Number of pages is zero. - @retval RETURN_UNSUPPORTED Clearing memory encryption attribute is not - supported - **/ + @retval RETURN_SUCCESS The attributes were set for the memory + region. + @retval RETURN_INVALID_PARAMETER Number of pages is zero. + @retval RETURN_UNSUPPORTED Setting the memory encryption attribute + is not supported +**/ RETURN_STATUS EFIAPI MemEncryptSevSetPageEncMask ( IN PHYSICAL_ADDRESS Cr3BaseAddress, IN PHYSICAL_ADDRESS BaseAddress, - IN UINTN NumberOfPages, - IN BOOLEAN CacheFlush + IN UINTN NumPages, + IN BOOLEAN Flush ); #endif // _MEM_ENCRYPT_SEV_LIB_H_ diff --git a/OvmfPkg/Library/BaseMemEncryptSevLib/Ia32/MemEncryptSevLib.c b/OvmfPkg/Library/BaseMemEncryptSevLib/Ia32/MemEncryptSevLib.c index d6067c52aa..614c97b23b 100644 --- a/OvmfPkg/Library/BaseMemEncryptSevLib/Ia32/MemEncryptSevLib.c +++ b/OvmfPkg/Library/BaseMemEncryptSevLib/Ia32/MemEncryptSevLib.c @@ -57,29 +57,29 @@ MemEncryptSevClearPageEncMask ( /** This function sets memory encryption bit for the memory region specified by - BaseAddress and Number of pages from the current page table context. + BaseAddress and NumPages from the current page table context. - @param[in] Cr3BaseAddress Cr3 Base Address (if zero then use current - CR3) - @param[in] BaseAddress The physical address that is the start - address of a memory region. - @param[in] NumberOfPages The number of pages from start memory - region. - @param[in] Flush Flush the caches before clearing the bit - (mostly TRUE except MMIO addresses) + @param[in] Cr3BaseAddress Cr3 Base Address (if zero then use + current CR3) + @param[in] BaseAddress The physical address that is the start + address of a memory region. + @param[in] NumPages The number of pages from start memory + region. + @param[in] Flush Flush the caches before setting the bit + (mostly TRUE except MMIO addresses) - @retval RETURN_SUCCESS The attributes were set for the memory - region. - @retval RETURN_INVALID_PARAMETER Number of pages is zero. - @retval RETURN_UNSUPPORTED Clearing memory encryption attribute is not - supported - **/ + @retval RETURN_SUCCESS The attributes were set for the memory + region. + @retval RETURN_INVALID_PARAMETER Number of pages is zero. + @retval RETURN_UNSUPPORTED Setting the memory encryption attribute + is not supported +**/ RETURN_STATUS EFIAPI MemEncryptSevSetPageEncMask ( IN PHYSICAL_ADDRESS Cr3BaseAddress, IN PHYSICAL_ADDRESS BaseAddress, - IN UINTN NumberOfPages, + IN UINTN NumPages, IN BOOLEAN Flush ) { diff --git a/OvmfPkg/Library/BaseMemEncryptSevLib/X64/MemEncryptSevLib.c b/OvmfPkg/Library/BaseMemEncryptSevLib/X64/MemEncryptSevLib.c index 5b8bc73764..f165722ae5 100644 --- a/OvmfPkg/Library/BaseMemEncryptSevLib/X64/MemEncryptSevLib.c +++ b/OvmfPkg/Library/BaseMemEncryptSevLib/X64/MemEncryptSevLib.c @@ -60,25 +60,24 @@ MemEncryptSevClearPageEncMask ( } /** - - This function clears memory encryption bit for the memory region specified by - BaseAddress and Number of pages from the current page table context. + This function sets memory encryption bit for the memory region specified by + BaseAddress and NumPages from the current page table context. @param[in] Cr3BaseAddress Cr3 Base Address (if zero then use current CR3) @param[in] BaseAddress The physical address that is the start address of a memory region. - @param[in] NumberOfPages The number of pages from start memory + @param[in] NumPages The number of pages from start memory region. - @param[in] Flush Flush the caches before clearing the bit + @param[in] Flush Flush the caches before setting the bit (mostly TRUE except MMIO addresses) - @retval RETURN_SUCCESS The attributes were cleared for the - memory region. + @retval RETURN_SUCCESS The attributes were set for the memory + region. @retval RETURN_INVALID_PARAMETER Number of pages is zero. - @retval RETURN_UNSUPPORTED Clearing the memory encryption attribute + @retval RETURN_UNSUPPORTED Setting the memory encryption attribute is not supported - **/ +**/ RETURN_STATUS EFIAPI MemEncryptSevSetPageEncMask (