Clean up gEfiHotPlugDeviceGuid in ConPlatformDxe.

[mirror_edk2.git] / MdeModulePkg / Include / Ppi / BaseMemoryTest.h

diff --git a/MdeModulePkg/Include/Ppi/BaseMemoryTest.h b/MdeModulePkg/Include/Ppi/BaseMemoryTest.h
index e769a9929f1769fa51300809604b736d0179b641..1e0fbb4af79d4d989f4bdcd16588819deff009aa 100644 (file)
--- a/MdeModulePkg/Include/Ppi/BaseMemoryTest.h
+++ b/MdeModulePkg/Include/Ppi/BaseMemoryTest.h
@@ -1,5 +1,5 @@
 /** @file\r
-  Pei memory test PPI used to Perform memory test in PEI phase.\r
+  This file defines Pei memory test PPI used to perform memory test in PEI 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 _PEI_BASE_MEMORY_TEST_PPI  PEI_BASE_MEMORY_TEST_PPI;\r
 \r
+///\r
+/// Pei Memory test operations\r
+/// Ignore op not test memory, Quick and Sparse op test memory quickly, Extensive op test memory detailedly.\r
+///\r
 typedef enum {\r
   Ignore,\r
   Quick,\r
@@ -27,9 +31,23 @@ typedef enum {
   Extensive\r
 } PEI_MEMORY_TEST_OP;\r
 \r
+/**\r
+  Test a range memory space that is ready to read and write.\r
+  If the memory is not ready, the error memory address will be returned.\r
+\r
+  @param PeiServices      An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param This             Pointer to Pei memory test PPI instance.\r
+  @param BeginAddress     Beginning of the memory address to be checked.\r
+  @param MemoryLength     Bytes of memory range to be checked.\r
+  @param Operation        Type of memory check operation to be performed.\r
+  @param ErrorAddress     Address of memory where the error is checked.\r
+\r
+  @retval EFI_SUCCESS         Memory range pass basic read and write test.\r
+  @retval EFI_DEVICE_ERROR    Memory is not ready to access.\r
+**/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *PEI_BASE_MEMORY_TEST) (\r
+(EFIAPI *PEI_BASE_MEMORY_TEST)(\r
   IN  EFI_PEI_SERVICES                   **PeiServices,\r
   IN PEI_BASE_MEMORY_TEST_PPI            * This,\r
   IN  EFI_PHYSICAL_ADDRESS               BeginAddress,\r