HII Library Class interface refine.

[mirror_edk2.git] / MdeModulePkg / Include / Library / MemoryTestLib.h

/** @file\r
  Library class to provide APIs for system memory test.\r
  \r
Copyright (c) 2009, 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
\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
\r
#ifndef _MEMORY_TEST_LIB_H_\r
#define _MEMORY_TEST_LIB_H_\r
\r
\r
/**\r
  Perform a quick system memory range test.\r
\r
  This function performs a quick system memory range test. It leads to quick performance\r
  but least reliability.\r
\r
  @param  StartAddress           Start address of the memory range to test.\r
  @param  Length                 Length of the memory range to test.\r
  @param  ErrorAddress           Address of the memory where error is encountered.\r
\r
  @retval RETURN_SUCCESS         The memory range passes test.\r
  @retval RETURN_DEVICE_ERROR    The memory range does not pass test.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
QuickMemoryTest (\r
  IN  VOID      *StartAddress,\r
  IN  UINT64    Length,\r
  OUT VOID      **ErrorAddress\r
  );\r
\r
/**\r
  Test a system memory range with sparsely sampled memory units.\r
\r
  This function tests a system memory range, whose memory units\r
  are sampled sparsely. It leads to relatively good performance\r
  and partial reliability.\r
\r
  @param  StartAddress           Start address of the memory range to test.\r
  @param  Length                 Length of the memory range to test.\r
  @param  ErrorAddress           Address of the memory where error is encountered.\r
\r
  @retval RETURN_SUCCESS         The memory range passes test.\r
  @retval RETURN_DEVICE_ERROR    The memory range does not pass test.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
SparseMemoryTest (\r
  IN  VOID      *StartAddress,\r
  IN  UINT64    Length,\r
  OUT VOID      **ErrorAddress\r
  );\r
\r
/**\r
  Test a system memory range with extensively sampled memory units.\r
\r
  This function tests a system memory range, whose memory units\r
  are sampled extensively. Compared with SparseMemoryTest, it achieves\r
  more reliability and less performance.\r
\r
  @param  StartAddress           Start address of the memory range to test.\r
  @param  Length                 Length of the memory range to test.\r
  @param  ErrorAddress           Address of the memory where error is encountered.\r
\r
  @retval RETURN_SUCCESS         The memory range passes test.\r
  @retval RETURN_DEVICE_ERROR    The memory range does not pass test.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
ExtensiveMemoryTest (\r
  IN  VOID      *StartAddress,\r
  IN  UINT64    Length,\r
  OUT VOID      **ErrorAddress\r
  );\r
\r
/**\r
  Check if soft ECC initialzation is needed for system\r
\r
  @retval TRUE         Soft ECC initialzation is needed.\r
  @retval FALSE        Soft ECC initialzation is not needed.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
IsSoftEccInitRequired (\r
  VOID\r
  );\r
\r
#endif\r