[edk2] [PATCH 03/20] OvmfPkg/MemEncryptSevLib: clean up MemEncryptSevClearPageEncMask() decl

Laszlo Ersek posted 20 patches 6 years, 9 months ago
[edk2] [PATCH 03/20] OvmfPkg/MemEncryptSevLib: clean up MemEncryptSevClearPageEncMask() 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. 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                   | 34 +++++++++++---------
 OvmfPkg/Library/BaseMemEncryptSevLib/Ia32/MemEncryptSevLib.c | 34 ++++++++++----------
 OvmfPkg/Library/BaseMemEncryptSevLib/X64/MemEncryptSevLib.c  |  7 ++--
 3 files changed, 38 insertions(+), 37 deletions(-)

diff --git a/OvmfPkg/Include/Library/MemEncryptSevLib.h b/OvmfPkg/Include/Library/MemEncryptSevLib.h
index 88b272ebedef..2d574dd30676 100644
--- a/OvmfPkg/Include/Library/MemEncryptSevLib.h
+++ b/OvmfPkg/Include/Library/MemEncryptSevLib.h
@@ -15,63 +15,65 @@
 **/
 
 #ifndef _MEM_ENCRYPT_SEV_LIB_H_
 #define _MEM_ENCRYPT_SEV_LIB_H_
 
 #include <Base.h>
 
 /**
   Returns a boolean to indicate whether SEV is enabled
 
   @retval TRUE           SEV is enabled
   @retval FALSE          SEV is not enabled
 **/
 BOOLEAN
 EFIAPI
 MemEncryptSevIsEnabled (
   VOID
   );
 
 /**
-  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 clears memory encryption bit for the memory region specified by
+  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 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 memory encryption attribute is not
-                                    supported
-  **/
+  @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                    NumberOfPages,
-  IN BOOLEAN                  CacheFlush
+  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.
 
   @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)
 
   @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
   **/
 RETURN_STATUS
diff --git a/OvmfPkg/Library/BaseMemEncryptSevLib/Ia32/MemEncryptSevLib.c b/OvmfPkg/Library/BaseMemEncryptSevLib/Ia32/MemEncryptSevLib.c
index d1130df2d0e7..d6067c52aacd 100644
--- a/OvmfPkg/Library/BaseMemEncryptSevLib/Ia32/MemEncryptSevLib.c
+++ b/OvmfPkg/Library/BaseMemEncryptSevLib/Ia32/MemEncryptSevLib.c
@@ -5,64 +5,64 @@
   Copyright (c) 2017, AMD Incorporated. All rights reserved.<BR>
 
   This program and the accompanying materials are licensed and made available
   under the terms and conditions of the BSD License which accompanies this
   distribution.  The full text of the license may be found at
   http://opensource.org/licenses/bsd-license.php
 
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
 **/
 
 #include <Library/BaseLib.h>
 #include <Library/DebugLib.h>
 #include <Register/Cpuid.h>
 #include <Register/Amd/Cpuid.h>
 #include <Register/Amd/Msr.h>
 #include <Library/MemEncryptSevLib.h>
 
 /**
-  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 clears 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
-                                    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 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 memory encryption attribute is not
-                                    supported
-  **/
+  @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                    NumberOfPages,
+  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.
 
   @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
diff --git a/OvmfPkg/Library/BaseMemEncryptSevLib/X64/MemEncryptSevLib.c b/OvmfPkg/Library/BaseMemEncryptSevLib/X64/MemEncryptSevLib.c
index 4b7fdf7d044d..5b8bc737645c 100644
--- a/OvmfPkg/Library/BaseMemEncryptSevLib/X64/MemEncryptSevLib.c
+++ b/OvmfPkg/Library/BaseMemEncryptSevLib/X64/MemEncryptSevLib.c
@@ -7,59 +7,58 @@
   This program and the accompanying materials are licensed and made available
   under the terms and conditions of the BSD License which accompanies this
   distribution.  The full text of the license may be found at
   http://opensource.org/licenses/bsd-license.php
 
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
 **/
 
 #include <Library/BaseLib.h>
 #include <Library/DebugLib.h>
 #include <Register/Cpuid.h>
 #include <Register/Amd/Cpuid.h>
 #include <Register/Amd/Msr.h>
 #include <Library/MemEncryptSevLib.h>
 
 #include "VirtualMemory.h"
 
 /**
-
   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
                                       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
                                       (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
   )
 {
   return InternalMemEncryptSevSetMemoryDecrypted (
            Cr3BaseAddress,
            BaseAddress,
            EFI_PAGES_TO_SIZE (NumPages),
            Flush
            );
 }
 
 /**
 
   This function clears memory encryption bit for the memory region specified by
-- 
2.14.1.3.gb7cf6e02401b


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