Refine BaseMemoryTestLib and add instance with full functionality.

[mirror_edk2.git] / MdeModulePkg / Include / Library / BaseMemoryTestLib.h

diff --git a/MdeModulePkg/Include/Library/BaseMemoryTestLib.h b/MdeModulePkg/Include/Library/BaseMemoryTestLib.h
index ec384de83e9ceb262adb07afcca52cee9bd19f3f..0dad0b2d165aae5c169673ad9b247d5ef1577057 100644 (file)
--- a/MdeModulePkg/Include/Library/BaseMemoryTestLib.h
+++ b/MdeModulePkg/Include/Library/BaseMemoryTestLib.h
@@ -28,12 +28,12 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   @param  ErrorAddress           Address of the memory where error is encountered.\r
 \r
   @retval RETURN_SUCCESS         The memory range passes test.\r
-  @retval RETURNEFI_DEVICE_ERROR The memory range does not pass test.\r
+  @retval RETURN_DEVICE_ERROR    The memory range does not pass test.\r
 \r
 **/\r
 RETURN_STATUS\r
 EFIAPI\r
-SparseMemoryTest (\r
+QuickMemoryTest (\r
   IN  VOID      *StartAddress,\r
   IN  UINT64    Length,\r
   OUT VOID      **ErrorAddress\r
@@ -51,38 +51,51 @@ SparseMemoryTest (
   @param  ErrorAddress           Address of the memory where error is encountered.\r
 \r
   @retval RETURN_SUCCESS         The memory range passes test.\r
-  @retval RETURNEFI_DEVICE_ERROR The memory range does not pass test.\r
+  @retval RETURN_DEVICE_ERROR    The memory range does not pass test.\r
 \r
 **/\r
 RETURN_STATUS\r
 EFIAPI\r
-ExtensiveMemoryTest (\r
+SparseMemoryTest (\r
   IN  VOID      *StartAddress,\r
   IN  UINT64    Length,\r
   OUT VOID      **ErrorAddress\r
   );\r
 \r
 /**\r
-  Test a system memory range with every memory unit checked.\r
+  Test a system memory range with extensively sampled memory units.\r
 \r
   This function tests a system memory range, whose memory units\r
-  are fully checked. It leads to complete reliability with the\r
-  cost of performance.\r
+  are sampled extensively. Compared with SparseMemoryTest, it achieves\r
+  more reliability and less performance.\r
 \r
   @param  StartAddress           Start address of the memory range to test.\r
   @param  Length                 Length of the memory range to test.\r
   @param  ErrorAddress           Address of the memory where error is encountered.\r
 \r
   @retval RETURN_SUCCESS         The memory range passes test.\r
-  @retval RETURNEFI_DEVICE_ERROR The memory range does not pass test.\r
+  @retval RETURN_DEVICE_ERROR    The memory range does not pass test.\r
 \r
 **/\r
 RETURN_STATUS\r
 EFIAPI\r
-FullMemoryTest (\r
+ExtensiveMemoryTest (\r
   IN  VOID      *StartAddress,\r
   IN  UINT64    Length,\r
   OUT VOID      **ErrorAddress\r
   );\r
 \r
+/**\r
+  Check if soft ECC initialzation is needed for system\r
+\r
+  @retval TRUE         Soft ECC initialzation is needed.\r
+  @retval FALSE        Soft ECC initialzation is not needed.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+IsSoftEccInitRequired (\r
+  VOID\r
+  );\r
+\r
 #endif\r