OvmfPkg/MemEncryptSevLib: clean up MemEncryptSevClearPageEncMask() decl

The declaration and the definition(s) of the function should have
identical leading comments and/or identical parameter lists. Also remove
any excess space in the comment block, and unindent the trailing "**/" if
necessary. Correct several parameter references.

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 14:41:01 +01:00
parent d4dd22c7bc
commit 5b5028e67b
3 changed files with 38 additions and 37 deletions

View File

@ -32,29 +32,31 @@ MemEncryptSevIsEnabled (
); );
/** /**
This function clears memory encryption bit for the memory region specified This function clears memory encryption bit for the memory region specified by
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 @param[in] Cr3BaseAddress Cr3 Base Address (if zero then use
address of a memory region. current CR3)
@param[in] NumberOfPages The number of pages from start memory @param[in] BaseAddress The physical address that is the start
region. address of a memory region.
@param[in] Flush Flush the caches before clearing the bit @param[in] NumPages The number of pages from start memory
(mostly TRUE except MMIO addresses) region.
@param[in] Flush Flush the caches before clearing the bit
(mostly TRUE except MMIO addresses)
@retval RETURN_SUCCESS The attributes were cleared for the memory @retval RETURN_SUCCESS The attributes were cleared for the
region. memory region.
@retval RETURN_INVALID_PARAMETER Number of pages is zero. @retval RETURN_INVALID_PARAMETER Number of pages is zero.
@retval RETURN_UNSUPPORTED Clearing memory encryption attribute is not @retval RETURN_UNSUPPORTED Clearing the memory encryption attribute
supported is not supported
**/ **/
RETURN_STATUS RETURN_STATUS
EFIAPI EFIAPI
MemEncryptSevClearPageEncMask ( MemEncryptSevClearPageEncMask (
IN PHYSICAL_ADDRESS Cr3BaseAddress, IN PHYSICAL_ADDRESS Cr3BaseAddress,
IN PHYSICAL_ADDRESS BaseAddress, IN PHYSICAL_ADDRESS BaseAddress,
IN UINTN NumberOfPages, IN UINTN NumPages,
IN BOOLEAN CacheFlush IN BOOLEAN Flush
); );
/** /**

View File

@ -22,30 +22,30 @@
#include <Library/MemEncryptSevLib.h> #include <Library/MemEncryptSevLib.h>
/** /**
This function clears memory encryption bit for the memory region specified This function clears memory encryption bit for the memory region specified by
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 @param[in] Cr3BaseAddress Cr3 Base Address (if zero then use
CR3) current CR3)
@param[in] BaseAddress The physical address that is the start @param[in] BaseAddress The physical address that is the start
address of a memory region. 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. region.
@param[in] Flush Flush the caches before clearing the bit @param[in] Flush Flush the caches before clearing the bit
(mostly TRUE except MMIO addresses) (mostly TRUE except MMIO addresses)
@retval RETURN_SUCCESS The attributes were cleared for the memory @retval RETURN_SUCCESS The attributes were cleared for the
region. memory region.
@retval RETURN_INVALID_PARAMETER Number of pages is zero. @retval RETURN_INVALID_PARAMETER Number of pages is zero.
@retval RETURN_UNSUPPORTED Clearing memory encryption attribute is not @retval RETURN_UNSUPPORTED Clearing the memory encryption attribute
supported is not supported
**/ **/
RETURN_STATUS RETURN_STATUS
EFIAPI EFIAPI
MemEncryptSevClearPageEncMask ( MemEncryptSevClearPageEncMask (
IN PHYSICAL_ADDRESS Cr3BaseAddress, IN PHYSICAL_ADDRESS Cr3BaseAddress,
IN PHYSICAL_ADDRESS BaseAddress, IN PHYSICAL_ADDRESS BaseAddress,
IN UINTN NumberOfPages, IN UINTN NumPages,
IN BOOLEAN Flush IN BOOLEAN Flush
) )
{ {

View File

@ -24,15 +24,14 @@
#include "VirtualMemory.h" #include "VirtualMemory.h"
/** /**
This function clears memory encryption bit for the memory region specified by This function clears 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 @param[in] Cr3BaseAddress Cr3 Base Address (if zero then use
current CR3) current CR3)
@param[in] BaseAddress The physical address that is the start @param[in] BaseAddress The physical address that is the start
address of a memory region. 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. region.
@param[in] Flush Flush the caches before clearing the bit @param[in] Flush Flush the caches before clearing the bit
(mostly TRUE except MMIO addresses) (mostly TRUE except MMIO addresses)
@ -42,7 +41,7 @@
@retval RETURN_INVALID_PARAMETER Number of pages is zero. @retval RETURN_INVALID_PARAMETER Number of pages is zero.
@retval RETURN_UNSUPPORTED Clearing the memory encryption attribute @retval RETURN_UNSUPPORTED Clearing the memory encryption attribute
is not supported is not supported
**/ **/
RETURN_STATUS RETURN_STATUS
EFIAPI EFIAPI
MemEncryptSevClearPageEncMask ( MemEncryptSevClearPageEncMask (