/** @file\r
- This file defines 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
\r
typedef struct _PEI_BASE_MEMORY_TEST_PPI PEI_BASE_MEMORY_TEST_PPI;\r
\r
-//\r
-// 4 different test operations\r
-// Ignore op not test memory, Quick and Sparse op test memory quickly, Extensive op test memory detailedly.\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
} PEI_MEMORY_TEST_OP;\r
\r
/**\r
- Test a range memory space is ready to read and write.\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 which has error when checked.\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