MdeModulePkg/Library/BaseMemoryTestLibNull/BaseMemoryTestLibNull.c

   1 /** @file
   2   Null instance of Memory Test Library.
   3
   4 Copyright (c) 2009, Intel Corporation.<BR>
   5 All rights reserved. This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12 **/
  13
  14 #include <Base.h>
  15 #include <Library/MemoryTestLib.h>
  16
  17 /**
  18   Perform a quick system memory range test.
  19
  20   This function performs a quick system memory range test. It leads to quick performance
  21   but least reliability.
  22
  23   @param  StartAddress           Start address of the memory range to test.
  24   @param  Length                 Length of the memory range to test.
  25   @param  ErrorAddress           Address of the memory where error is encountered.
  26
  27   @retval RETURN_SUCCESS         The memory range passes test.
  28   @retval RETURN_DEVICE_ERROR    The memory range does not pass test.
  29
  30 **/
  31 RETURN_STATUS
  32 EFIAPI
  33 QuickMemoryTest (
  34   IN  VOID      *StartAddress,
  35   IN  UINT64    Length,
  36   OUT VOID      **ErrorAddress
  37   )
  38 {
  39   return RETURN_SUCCESS;
  40 }
  41
  42 /**
  43   Test a system memory range with sparsely sampled memory units.
  44
  45   This function tests a system memory range, whose memory units
  46   are sampled sparsely. It leads to relatively good performance
  47   and partial reliability.
  48
  49   @param  StartAddress           Start address of the memory range to test.
  50   @param  Length                 Length of the memory range to test.
  51   @param  ErrorAddress           Address of the memory where error is encountered.
  52
  53   @retval RETURN_SUCCESS         The memory range passes test.
  54   @retval RETURN_DEVICE_ERROR    The memory range does not pass test.
  55
  56 **/
  57 RETURN_STATUS
  58 EFIAPI
  59 SparseMemoryTest (
  60   IN  VOID      *StartAddress,
  61   IN  UINT64    Length,
  62   OUT VOID      **ErrorAddress
  63   )
  64 {
  65   return RETURN_SUCCESS;
  66 }
  67
  68 /**
  69   Test a system memory range with extensively sampled memory units.
  70
  71   This function tests a system memory range, whose memory units
  72   are sampled extensively. Compared with SparseMemoryTest, it achieves
  73   more reliability and less performance.
  74
  75   @param  StartAddress           Start address of the memory range to test.
  76   @param  Length                 Length of the memory range to test.
  77   @param  ErrorAddress           Address of the memory where error is encountered.
  78
  79   @retval RETURN_SUCCESS         The memory range passes test.
  80   @retval RETURN_DEVICE_ERROR    The memory range does not pass test.
  81
  82 **/
  83 RETURN_STATUS
  84 EFIAPI
  85 ExtensiveMemoryTest (
  86   IN  VOID      *StartAddress,
  87   IN  UINT64    Length,
  88   OUT VOID      **ErrorAddress
  89   )
  90 {
  91   return RETURN_SUCCESS;
  92 }
  93
  94 /**
  95   Check if soft ECC initialzation is needed for system
  96
  97   @retval TRUE         Soft ECC initialzation is needed.
  98   @retval FALSE        Soft ECC initialzation is not needed.
  99
 100 **/
 101 BOOLEAN
 102 EFIAPI
 103 IsSoftEccInitRequired (
 104   VOID
 105   )
 106 {
 107   return FALSE;
 108 }