[PATCH 05/20] OvmfPkg/MemEncryptSevLib: clean up SetMemoryEncDec() comment block

[Laszlo Ersek <lersek@redhat.com>]

Document the "Cr3BaseAddress" parameter, and 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>
---
 OvmfPkg/Library/BaseMemEncryptSevLib/X64/VirtualMemory.c | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/OvmfPkg/Library/BaseMemEncryptSevLib/X64/VirtualMemory.c b/OvmfPkg/Library/BaseMemEncryptSevLib/X64/VirtualMemory.c
index 65b8babaac44..aed92127629f 100644
--- a/OvmfPkg/Library/BaseMemEncryptSevLib/X64/VirtualMemory.c
+++ b/OvmfPkg/Library/BaseMemEncryptSevLib/X64/VirtualMemory.c
@@ -531,55 +531,57 @@ DisableReadOnlyPageWriteProtect (
   VOID
   )
 {
   AsmWriteCr0 (AsmReadCr0() & ~BIT16);
 }
 
 /**
  Enable Write Protect on pages marked as read-only.
 **/
 VOID
 EnableReadOnlyPageWriteProtect (
   VOID
   )
 {
   AsmWriteCr0 (AsmReadCr0() | BIT16);
 }
 
 
 /**
   This function either sets or clears memory encryption bit for the memory
-  region specified by PhysicalAddress and length from the current page table
+  region specified by PhysicalAddress and Length from the current page table
   context.
 
-  The function iterates through the physicalAddress one page at a time, and set
+  The function iterates through the PhysicalAddress one page at a time, and set
   or clears the memory encryption mask in the page table. If it encounters
   that a given physical address range is part of large page then it attempts to
   change the attribute at one go (based on size), otherwise it splits the
   large pages into smaller (e.g 2M page into 4K pages) and then try to set or
   clear the encryption bit on the smallest page size.
 
+  @param[in]  Cr3BaseAddress          Cr3 Base Address (if zero then use
+                                      current CR3)
   @param[in]  PhysicalAddress         The physical address that is the start
                                       address of a memory region.
   @param[in]  Length                  The length of memory region
   @param[in]  Mode                    Set or Clear mode
-  @param[in]  Flush                   Flush the caches before applying the
+  @param[in]  CacheFlush              Flush the caches before applying the
                                       encryption mask
 
   @retval RETURN_SUCCESS              The attributes were cleared for the
                                       memory region.
   @retval RETURN_INVALID_PARAMETER    Number of pages is zero.
   @retval RETURN_UNSUPPORTED          Setting the memory encyrption attribute
                                       is not supported
 **/
 
 STATIC
 RETURN_STATUS
 EFIAPI
 SetMemoryEncDec (
   IN    PHYSICAL_ADDRESS         Cr3BaseAddress,
   IN    PHYSICAL_ADDRESS         PhysicalAddress,
   IN    UINTN                    Length,
   IN    MAP_RANGE_MODE           Mode,
   IN    BOOLEAN                  CacheFlush
   )
 {
-- 
2.14.1.3.gb7cf6e02401b