[edk2] [PATCH 04/20] OvmfPkg/MemEncryptSevLib: clean up MemEncryptSevSetPageEncMask() decl

Laszlo Ersek posted 20 patches 6 years, 9 months ago
[edk2] [PATCH 04/20] OvmfPkg/MemEncryptSevLib: clean up MemEncryptSevSetPageEncMask() decl
Posted by Laszlo Ersek 6 years, 9 months ago
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 <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/Include/Library/MemEncryptSevLib.h                   | 32 +++++++++++---------
 OvmfPkg/Library/BaseMemEncryptSevLib/Ia32/MemEncryptSevLib.c | 32 ++++++++++----------
 OvmfPkg/Library/BaseMemEncryptSevLib/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 2d574dd30676..e5ebb4401818 100644
--- a/OvmfPkg/Include/Library/MemEncryptSevLib.h
+++ b/OvmfPkg/Include/Library/MemEncryptSevLib.h
@@ -44,44 +44,46 @@ MemEncryptSevIsEnabled (
   @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 region.
   @retval RETURN_INVALID_PARAMETER    Number of pages is zero.
   @retval RETURN_UNSUPPORTED          Clearing the memory encryption attribute
                                       is not supported
 **/
 RETURN_STATUS
 EFIAPI
 MemEncryptSevClearPageEncMask (
   IN PHYSICAL_ADDRESS         Cr3BaseAddress,
   IN PHYSICAL_ADDRESS         BaseAddress,
   IN UINTN                    NumPages,
   IN BOOLEAN                  Flush
   );
 
 /**
   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 d6067c52aacd..614c97b23bb6 100644
--- a/OvmfPkg/Library/BaseMemEncryptSevLib/Ia32/MemEncryptSevLib.c
+++ b/OvmfPkg/Library/BaseMemEncryptSevLib/Ia32/MemEncryptSevLib.c
@@ -40,51 +40,51 @@
   @retval RETURN_UNSUPPORTED          Clearing the memory encryption attribute
                                       is not supported
 **/
 RETURN_STATUS
 EFIAPI
 MemEncryptSevClearPageEncMask (
   IN PHYSICAL_ADDRESS         Cr3BaseAddress,
   IN PHYSICAL_ADDRESS         BaseAddress,
   IN UINTN                    NumPages,
   IN BOOLEAN                  Flush
   )
 {
   //
   // Memory encryption bit is not accessible in 32-bit mode
   //
   return RETURN_UNSUPPORTED;
 }
 
 /**
   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
   )
 {
   //
   // Memory encryption bit is not accessible in 32-bit mode
   //
   return RETURN_UNSUPPORTED;
 }
diff --git a/OvmfPkg/Library/BaseMemEncryptSevLib/X64/MemEncryptSevLib.c b/OvmfPkg/Library/BaseMemEncryptSevLib/X64/MemEncryptSevLib.c
index 5b8bc737645c..f165722ae550 100644
--- a/OvmfPkg/Library/BaseMemEncryptSevLib/X64/MemEncryptSevLib.c
+++ b/OvmfPkg/Library/BaseMemEncryptSevLib/X64/MemEncryptSevLib.c
@@ -43,55 +43,54 @@
                                       is not supported
 **/
 RETURN_STATUS
 EFIAPI
 MemEncryptSevClearPageEncMask (
   IN PHYSICAL_ADDRESS         Cr3BaseAddress,
   IN PHYSICAL_ADDRESS         BaseAddress,
   IN UINTN                    NumPages,
   IN BOOLEAN                  Flush
   )
 {
   return InternalMemEncryptSevSetMemoryDecrypted (
            Cr3BaseAddress,
            BaseAddress,
            EFI_PAGES_TO_SIZE (NumPages),
            Flush
            );
 }
 
 /**
-
-  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 (
   IN PHYSICAL_ADDRESS         Cr3BaseAddress,
   IN PHYSICAL_ADDRESS         BaseAddress,
   IN UINTN                    NumPages,
   IN BOOLEAN                  Flush
   )
 {
   return InternalMemEncryptSevSetMemoryEncrypted (
            Cr3BaseAddress,
            BaseAddress,
            EFI_PAGES_TO_SIZE (NumPages),
            Flush
            );
 }
-- 
2.14.1.3.gb7cf6e02401b


_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel