OvmfPkg/MemEncryptSevLib: clean up MemEncryptSevClearPageEncMask() decl

[mirror_edk2.git] / OvmfPkg / Include / Library / MemEncryptSevLib.h

diff --git a/OvmfPkg/Include/Library/MemEncryptSevLib.h b/OvmfPkg/Include/Library/MemEncryptSevLib.h
index b6753762423e4dd0ccd86b074d29fe58a9ea042d..2d574dd30676de0142b42b21e8b27a6b53aef74a 100644 (file)
--- a/OvmfPkg/Include/Library/MemEncryptSevLib.h
+++ b/OvmfPkg/Include/Library/MemEncryptSevLib.h
@@ -22,9 +22,9 @@
 /**\r
   Returns a boolean to indicate whether SEV is enabled\r
 \r
-  @retval TRUE           SEV is active\r
+  @retval TRUE           SEV is enabled\r
   @retval FALSE          SEV is not enabled\r
-  **/\r
+**/\r
 BOOLEAN\r
 EFIAPI\r
 MemEncryptSevIsEnabled (\r
@@ -32,40 +32,46 @@ MemEncryptSevIsEnabled (
   );\r
 \r
 /**\r
-  This function clears memory encryption bit for the memory region specified\r
-  by BaseAddress and Number of pages from the current page table context.\r
+  This function clears memory encryption bit for the memory region specified by\r
+  BaseAddress and NumPages from the current page table context.\r
 \r
-  @param[in]  BaseAddress           The physical address that is the start address\r
-                                    of a memory region.\r
-  @param[in]  NumberOfPages         The number of pages from start memory region.\r
-  @param[in]  Flush                 Flush the caches before clearing the bit\r
-                                    (mostly TRUE except MMIO addresses)\r
+  @param[in]  Cr3BaseAddress          Cr3 Base Address (if zero then use\r
+                                      current CR3)\r
+  @param[in]  BaseAddress             The physical address that is the start\r
+                                      address of a memory region.\r
+  @param[in]  NumPages                The number of pages from start memory\r
+                                      region.\r
+  @param[in]  Flush                   Flush the caches before clearing the bit\r
+                                      (mostly TRUE except MMIO addresses)\r
 \r
-  @retval RETURN_SUCCESS            The attributes were cleared for the memory region.\r
-  @retval RETURN_INVALID_PARAMETER  Number of pages is zero.\r
-  @retval RETURN_UNSUPPORTED        Clearing memory encryption attribute is not\r
-                                    supported\r
-  **/\r
+  @retval RETURN_SUCCESS              The attributes were cleared for the\r
+                                      memory region.\r
+  @retval RETURN_INVALID_PARAMETER    Number of pages is zero.\r
+  @retval RETURN_UNSUPPORTED          Clearing the memory encryption attribute\r
+                                      is not supported\r
+**/\r
 RETURN_STATUS\r
 EFIAPI\r
 MemEncryptSevClearPageEncMask (\r
   IN PHYSICAL_ADDRESS         Cr3BaseAddress,\r
   IN PHYSICAL_ADDRESS         BaseAddress,\r
-  IN UINTN                    NumberOfPages,\r
-  IN BOOLEAN                  CacheFlush\r
+  IN UINTN                    NumPages,\r
+  IN BOOLEAN                  Flush\r
   );\r
 \r
 /**\r
   This function sets memory encryption bit for the memory region specified by\r
   BaseAddress and Number of pages from the current page table context.\r
 \r
-  @param[in]  BaseAddress           The physical address that is the start address\r
-                                    of a memory region.\r
-  @param[in]  NumberOfPages         The number of pages from start memory region.\r
+  @param[in]  BaseAddress           The physical address that is the start\r
+                                    address of a memory region.\r
+  @param[in]  NumberOfPages         The number of pages from start memory\r
+                                    region.\r
   @param[in]  Flush                 Flush the caches before clearing the bit\r
                                     (mostly TRUE except MMIO addresses)\r
 \r
-  @retval RETURN_SUCCESS            The attributes were set for the memory region.\r
+  @retval RETURN_SUCCESS            The attributes were set for the memory\r
+                                    region.\r
   @retval RETURN_INVALID_PARAMETER  Number of pages is zero.\r
   @retval RETURN_UNSUPPORTED        Clearing memory encryption attribute is not\r
                                     supported\r