MdeModulePkg: Add match2 opcode support in SetupBrowserDxe and sample code in DriverS...

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

diff --git a/MdeModulePkg/Include/Protocol/GenericMemoryTest.h b/MdeModulePkg/Include/Protocol/GenericMemoryTest.h
index 3b0614ad82b88c647f30fb1f39e4f1bed76451af..163e76d8f46eb73389f28835c99ae98c22f591b3 100644 (file)
--- a/MdeModulePkg/Include/Protocol/GenericMemoryTest.h
+++ b/MdeModulePkg/Include/Protocol/GenericMemoryTest.h
@@ -1,13 +1,13 @@
 /** @file\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
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution.  The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php.                                            \r
 \r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 **/\r
@@ -21,8 +21,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 typedef struct _EFI_GENERIC_MEMORY_TEST_PROTOCOL  EFI_GENERIC_MEMORY_TEST_PROTOCOL;\r
 \r
 ///\r
-/// Memory test coverage level\r
-/// Ignore op not test memory, Quick and Sparse op test memory quickly, Extensive op test memory detailedly.\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
@@ -36,14 +36,12 @@ typedef enum {
 /**\r
   Initialize the generic memory test.\r
 \r
-  @param  This                Protocol instance pointer. \r
+  @param  This                The protocol instance pointer. \r
   @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 is initialized correctly. \r
-  @retval EFI_NO_MEDIA        There is not any non-tested memory found, which means  \r
-                              that the memory test driver have not detect any \r
-                              non-tested extended memory in current system. \r
+  @retval EFI_NO_MEDIA        The system had no memory to be tested. \r
 \r
 **/\r
 typedef\r
@@ -58,17 +56,16 @@ EFI_STATUS
 /**\r
   Perform the memory test.\r
 \r
-  @param  This                Protocol instance pointer. \r
+  @param  This                The 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 some error DIMMs is disabled in some case. \r
-  @param  ErrorOut            TRUE if the memory error occurs.\r
-  @param  IfTestAbort         Indicate if the user press "ESC" to skip the memory test. \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 pass test.\r
-  @retval EFI_NOT_FOUND       Indicate all the non-tested memory blocks have been\r
-                              already gone through.\r
-  @retval EFI_DEVICE_ERROR    Memory device error occurs and no agent can handle it.\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
@@ -85,9 +82,9 @@ EFI_STATUS
 /**\r
   Finish the memory test.\r
 \r
-  @param  This                Protocol instance pointer. \r
+  @param  This                The protocol instance pointer. \r
 \r
-  @retval EFI_SUCCESS         Successful.  \r
+  @retval EFI_SUCCESS         Success. All resources used in the memory test are freed.\r
 \r
 **/\r
 typedef\r
@@ -97,16 +94,15 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Provide capability to test compatible range used by some sepcial\r
-  driver before BDS perform memory test.\r
+  Provides the capability to test the compatible range used by some special drivers.\r
 \r
-  @param  This                Protocol instance pointer. \r
+  @param  This                The protocol instance pointer. \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