Committing changes to the comments, to improve code documentation.

[mirror_edk2.git] / MdeModulePkg / Include / Protocol / GenericMemoryTest.h

diff --git a/MdeModulePkg/Include/Protocol/GenericMemoryTest.h b/MdeModulePkg/Include/Protocol/GenericMemoryTest.h
index 57ef1493b42e81af30ff22192f40c0b9eaa7bbc8..1abaf88fdaabdf85f36f77b3b07c0426483fdfa9 100644 (file)
--- a/MdeModulePkg/Include/Protocol/GenericMemoryTest.h
+++ b/MdeModulePkg/Include/Protocol/GenericMemoryTest.h
@@ -1,5 +1,5 @@
 /** @file\r
-  This protocol defines the EFI generic memory test interfaces in Dxe phase.\r
+  This protocol defines the generic memory test interfaces in Dxe phase.\r
 \r
 Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
 All rights reserved. This program and the accompanying materials\r
@@ -20,6 +20,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 typedef struct _EFI_GENERIC_MEMORY_TEST_PROTOCOL  EFI_GENERIC_MEMORY_TEST_PROTOCOL;\r
 \r
+///\r
+/// Memory test coverage level\r
+/// Ignore chooses not to test memory, Quick and Sparse test some memory, and Extensive performs a detailed memory test.\r
+///\r
 typedef enum {\r
   IGNORE,\r
   QUICK,\r
@@ -36,11 +40,8 @@ typedef enum {
   @param  Level               The coverage level of the memory test. \r
   @param  RequireSoftECCInit  Indicate if the memory need software ECC init. \r
 \r
-  @retval EFI_SUCCESS         The generic memory test initialized correctly. \r
-  @retval EFI_NO_MEDIA        There is not any non-tested memory found, in this \r
-                              function if not any non-tesed memory found means  \r
-                              that the memory test driver have not detect any \r
-                              non-tested extended memory of current system. \r
+  @retval EFI_SUCCESS         The generic memory test is initialized correctly. \r
+  @retval EFI_NO_MEDIA        The system had no memory to be tested. \r
 \r
 **/\r
 typedef\r
@@ -57,25 +58,20 @@ EFI_STATUS
 \r
   @param  This                Protocol instance pointer. \r
   @param  TestedMemorySize    Return the tested extended memory size. \r
-  @param  TotalMemorySize     Return the whole system physical memory size, this  \r
-                              value may be changed if in some case some error  \r
-                              DIMMs be disabled. \r
-  @param  ErrorOut            Any time the memory error occurs, this will be \r
-                              TRUE. \r
-  @param  IfTestAbort         Indicate if the user press "ESC" to skip the memory \r
-                              test. \r
-\r
-  @retval EFI_SUCCESS         One block of memory test ok, the block size is hide \r
-                              internally. \r
-  @retval EFI_NOT_FOUND       Indicate all the non-tested memory blocks have  \r
-                              already go through. \r
-  @retval EFI_DEVICE_ERROR    Mis-compare error, and no agent can handle it\r
+  @param  TotalMemorySize     Return the whole system physical memory size. \r
+                                                                                                               The total memory size does not include memory in a slot with a disabled DIMM.  \r
+  @param  ErrorOut            TRUE if the memory error occured.\r
+  @param  IfTestAbort         Indicates that the user pressed "ESC" to skip the memory test. \r
+\r
+  @retval EFI_SUCCESS         One block of memory passed the test.\r
+  @retval EFI_NOT_FOUND       All memory blocks have already been tested.\r
+  @retval EFI_DEVICE_ERROR    Memory device error occured, and no agent can handle it.\r
 \r
 **/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_PERFORM_MEMORY_TEST)(\r
-  IN EFI_GENERIC_MEMORY_TEST_PROTOCOL *This,\r
+  IN EFI_GENERIC_MEMORY_TEST_PROTOCOL          *This,\r
   OUT UINT64                                   *TestedMemorySize,\r
   OUT UINT64                                   *TotalMemorySize,\r
   OUT BOOLEAN                                  *ErrorOut,\r
@@ -84,13 +80,11 @@ EFI_STATUS
 \r
 \r
 /**\r
-  The memory test finished.\r
+  Finish the memory test.\r
 \r
   @param  This                Protocol instance pointer. \r
 \r
-  @retval EFI_SUCCESS         Successful free all the generic memory test driver \r
-                              allocated resource and notify to platform memory \r
-                              test driver that memory test finished. \r
+  @retval EFI_SUCCESS         Success. All resources used in the memory test are freed.\r
 \r
 **/\r
 typedef\r
@@ -100,15 +94,16 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Provide capability to test compatible range which used by some sepcial\r
-  driver required using memory range before BDS perform memory test.\r
+  Provides the capability to test the compatible range used by a special\r
+  driver.\r
 \r
   @param  This                Protocol instance pointer. \r
-  @param  StartAddress        The start address of the memory range. \r
-  @param  Length              The memory range's length. \r
+  @param  StartAddress        The start address of the compatible memory range that\r
+                              must be below 16M.\r
+  @param  Length              The compatible memory range's length. \r
   \r
   @retval EFI_SUCCESS           The compatible memory range pass the memory test. \r
-  @retval EFI_INVALID_PARAMETER The compatible memory range must be below 16M.\r
+  @retval EFI_INVALID_PARAMETER The compatible memory range are not below Low 16M.\r
 \r
 **/\r
 typedef\r