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/BaseMemoryTestLib.h>
  16
  17 /**
  18   Test a system memory range with sparsely sampled memory units.
  19
  20   This function tests a system memory range, whose memory units
  21   are sampled sparsely. It leads to quick performance but less
  22   reliability.
  23
  24   @param  StartAddress           Start address of the memory range to test.
  25   @param  Length                 Length of the memory range to test.
  26   @param  ErrorAddress           Address of the memory where error is encountered.
  27
  28   @retval RETURN_SUCCESS         The memory range passes test.
  29   @retval RETURNEFI_DEVICE_ERROR The memory range does not pass test.
  30
  31 **/
  32 RETURN_STATUS
  33 EFIAPI
  34 SparseMemoryTest (
  35   IN  VOID      *StartAddress,
  36   IN  UINT64    Length,
  37   OUT VOID      **ErrorAddress
  38   )
  39 {
  40   return RETURN_SUCCESS;
  41 }
  42
  43 /**
  44   Test a system memory range with extensively sampled memory units.
  45
  46   This function tests a system memory range, whose memory units
  47   are sampled extensively. Compared with SparseMemoryTest, it achieves
  48   more reliability and less performance.
  49
  50   @param  StartAddress           Start address of the memory range to test.
  51   @param  Length                 Length of the memory range to test.
  52   @param  ErrorAddress           Address of the memory where error is encountered.
  53
  54   @retval RETURN_SUCCESS         The memory range passes test.
  55   @retval RETURNEFI_DEVICE_ERROR The memory range does not pass test.
  56
  57 **/
  58 RETURN_STATUS
  59 EFIAPI
  60 ExtensiveMemoryTest (
  61   IN  VOID      *StartAddress,
  62   IN  UINT64    Length,
  63   OUT VOID      **ErrorAddress
  64   )
  65 {
  66   return RETURN_SUCCESS;
  67 }
  68
  69 /**
  70   Test a system memory range with every memory unit checked.
  71
  72   This function tests a system memory range, whose memory units
  73   are fully checked. It leads to complete reliability with the
  74   cost of performance.
  75
  76   @param  StartAddress           Start address of the memory range to test.
  77   @param  Length                 Length of the memory range to test.
  78   @param  ErrorAddress           Address of the memory where error is encountered.
  79
  80   @retval RETURN_SUCCESS         The memory range passes test.
  81   @retval RETURNEFI_DEVICE_ERROR The memory range does not pass test.
  82
  83 **/
  84 RETURN_STATUS
  85 EFIAPI
  86 FullMemoryTest (
  87   IN  VOID      *StartAddress,
  88   IN  UINT64    Length,
  89   OUT VOID      **ErrorAddress
  90   )
  91 {
  92   return RETURN_SUCCESS;
  93 }