X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdeModulePkg%2FInclude%2FProtocol%2FGenericMemoryTest.h;h=ad628a0e5dd9dcc555ec5d624c2b05da901fb182;hb=e40b7d5d1b4f7d0cc7d4e91d6aa26033d5afd3a7;hp=87959ed73a1cf8e885041dcebb47d013c2c4b072;hpb=7d839888ffce3572e8ef4b82e0811d82cd2bbd74;p=mirror_edk2.git

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