Check in library class of BaseMemoryTestLib.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7663 6f19259b-4bc3-4df7-8a09-765794883524

MdeModulePkg/Include/Library/BaseMemoryTestLib.h

@@ -0,0 +1,88 @@
+/** @file
+  Library class to provide APIs for system memory test.
+  
+Copyright (c) 2009, Intel Corporation.<BR>
+All rights reserved. This program and the accompanying materials
+are licensed and made available under the terms and conditions of the BSD License
+which accompanies this distribution.  The full text of the license may be found at
+http://opensource.org/licenses/bsd-license.php
+
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+
+**/
+
+#ifndef _MEMORY_TEST_LIB_H_
+#define _MEMORY_TEST_LIB_H_
+
+
+/**
+  Test a system memory range with sparsely sampled memory units.
+
+  This function tests a system memory range, whose memory units
+  are sampled sparsely. It leads to quick performance but less
+  reliability.
+
+  @param  StartAddress           Start address of the memory range to test.
+  @param  Length                 Length of the memory range to test.
+  @param  ErrorAddress           Address of the memory where error is encountered.
+
+  @retval RETURN_SUCCESS         The memory range passes test.
+  @retval RETURNEFI_DEVICE_ERROR The memory range does not pass test.
+
+**/
+RETURN_STATUS
+EFIAPI
+SparseMemoryTest (
+  IN  VOID      *StartAddress,
+  IN  UINT64    Length,
+  OUT VOID      **ErrorAddress
+  );
+
+/**
+  Test a system memory range with extensively sampled memory units.
+
+  This function tests a system memory range, whose memory units
+  are sampled extensively. Compared with SparseMemoryTest, it achieves
+  more reliability and less performance.
+
+  @param  StartAddress           Start address of the memory range to test.
+  @param  Length                 Length of the memory range to test.
+  @param  ErrorAddress           Address of the memory where error is encountered.
+
+  @retval RETURN_SUCCESS         The memory range passes test.
+  @retval RETURNEFI_DEVICE_ERROR The memory range does not pass test.
+
+**/
+RETURN_STATUS
+EFIAPI
+ExtensiveMemoryTest (
+  IN  VOID      *StartAddress,
+  IN  UINT64    Length,
+  OUT VOID      **ErrorAddress
+  );
+
+/**
+  Test a system memory range with every memory unit checked.
+
+  This function tests a system memory range, whose memory units
+  are fully checked. It leads to complete reliability with the
+  cost of performance.
+
+  @param  StartAddress           Start address of the memory range to test.
+  @param  Length                 Length of the memory range to test.
+  @param  ErrorAddress           Address of the memory where error is encountered.
+
+  @retval RETURN_SUCCESS         The memory range passes test.
+  @retval RETURNEFI_DEVICE_ERROR The memory range does not pass test.
+
+**/
+RETURN_STATUS
+EFIAPI
+FullMemoryTest (
+  IN  VOID      *StartAddress,
+  IN  UINT64    Length,
+  OUT VOID      **ErrorAddress
+  );
+
+#endif

MdeModulePkg/Library/BaseMemoryTestLibNull/BaseMemoryTestLibNull.c

@@ -0,0 +1,93 @@
+/** @file
+  Null instance of Memory Test Library.
+  
+Copyright (c) 2009, Intel Corporation.<BR>
+All rights reserved. This program and the accompanying materials
+are licensed and made available under the terms and conditions of the BSD License
+which accompanies this distribution.  The full text of the license may be found at
+http://opensource.org/licenses/bsd-license.php
+
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+**/
+
+#include <Base.h>
+#include <Library/BaseMemoryTestLib.h>
+
+/**
+  Test a system memory range with sparsely sampled memory units.
+
+  This function tests a system memory range, whose memory units
+  are sampled sparsely. It leads to quick performance but less
+  reliability.
+
+  @param  StartAddress           Start address of the memory range to test.
+  @param  Length                 Length of the memory range to test.
+  @param  ErrorAddress           Address of the memory where error is encountered.
+
+  @retval RETURN_SUCCESS         The memory range passes test.
+  @retval RETURNEFI_DEVICE_ERROR The memory range does not pass test.
+
+**/
+RETURN_STATUS
+EFIAPI
+SparseMemoryTest (
+  IN  VOID      *StartAddress,
+  IN  UINT64    Length,
+  OUT VOID      **ErrorAddress
+  )
+{
+  return RETURN_SUCCESS;
+}
+
+/**
+  Test a system memory range with extensively sampled memory units.
+
+  This function tests a system memory range, whose memory units
+  are sampled extensively. Compared with SparseMemoryTest, it achieves
+  more reliability and less performance.
+
+  @param  StartAddress           Start address of the memory range to test.
+  @param  Length                 Length of the memory range to test.
+  @param  ErrorAddress           Address of the memory where error is encountered.
+
+  @retval RETURN_SUCCESS         The memory range passes test.
+  @retval RETURNEFI_DEVICE_ERROR The memory range does not pass test.
+
+**/
+RETURN_STATUS
+EFIAPI
+ExtensiveMemoryTest (
+  IN  VOID      *StartAddress,
+  IN  UINT64    Length,
+  OUT VOID      **ErrorAddress
+  )
+{
+  return RETURN_SUCCESS;
+}
+
+/**
+  Test a system memory range with every memory unit checked.
+
+  This function tests a system memory range, whose memory units
+  are fully checked. It leads to complete reliability with the
+  cost of performance.
+
+  @param  StartAddress           Start address of the memory range to test.
+  @param  Length                 Length of the memory range to test.
+  @param  ErrorAddress           Address of the memory where error is encountered.
+
+  @retval RETURN_SUCCESS         The memory range passes test.
+  @retval RETURNEFI_DEVICE_ERROR The memory range does not pass test.
+
+**/
+RETURN_STATUS
+EFIAPI
+FullMemoryTest (
+  IN  VOID      *StartAddress,
+  IN  UINT64    Length,
+  OUT VOID      **ErrorAddress
+  )
+{
+  return RETURN_SUCCESS;
+}

MdeModulePkg/Library/BaseMemoryTestLibNull/BaseMemoryTestLibNull.inf

@@ -0,0 +1,37 @@
+/** @file
+  Null instance of Memory Test Library.
+
+Copyright (c) 2009, Intel Corporation.<BR>
+All rights reserved. This program and the accompanying materials
+are licensed and made available under the terms and conditions of the BSD License
+which accompanies this distribution.  The full text of the license may be found at
+http://opensource.org/licenses/bsd-license.php
+
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+
+**/
+
+[Defines]
+  INF_VERSION                    = 0x00010005
+  BASE_NAME                      = BaseMemoryTestLibNull
+  FILE_GUID                      = D519E511-9C1C-47F5-AE01-FD216E779269
+  MODULE_TYPE                    = BASE
+  VERSION_STRING                 = 1.0
+  LIBRARY_CLASS                  = MemoryTestLib
+
+#
+# The following information is for reference only and not required by the build tools.
+#
+#  VALID_ARCHITECTURES           = IA32 X64 IPF EBC
+#
+
+[Sources.common]
+  BaseMemoryTestLibNull.c
+
+[Packages]
+  MdePkg/MdePkg.dec
+  MdeModulePkg/MdeModulePkg.dec
+
+[LibraryClasses]
+  MemoryTestLib

MdeModulePkg/MdeModulePkg.dec

@@ -77,6 +77,10 @@
   ##
   FvbServiceLib|Include/Library/FvbServiceLib.h
 
+  ##  @libraryclass  Provides APIs for system memory test.
+  ##
+  MemoryTestLib|Include/Library/BaseMemoryTestLib.h
+
 [Guids.common]
   ## MdeModule package token space guid
   ## Include/Guid/MdeModulePkgTokenSpace.h

MdeModulePkg/MdeModulePkg.dsc

@@ -77,6 +77,7 @@
   PlatformDriverOverrideLib|MdeModulePkg/Library/DxePlatDriOverLib/DxePlatDriOverLib.inf
   OemHookStatusCodeLib|IntelFrameworkModulePkg/Library/OemHookStatusCodeLibNull/OemHookStatusCodeLibNull.inf
   HiiLib|MdeModulePkg/Library/UefiHiiLib/UefiHiiLib.inf
+  MemoryTestLib|MdeModulePkg/Library/BaseMemoryTestLibNull/BaseMemoryTestLibNull.inf
 
 [LibraryClasses.IA32]
   IoLib|MdePkg/Library/BaseIoLibIntrinsic/BaseIoLibIntrinsic.inf
@@ -296,6 +297,7 @@
   MdeModulePkg/Library/EdkFvbServiceLib/EdkFvbServiceLib.inf
   MdeModulePkg/Library/UefiHiiLib/UefiHiiLib.inf
   MdeModulePkg/Library/UefiIfrSupportLib/UefiIfrSupportLib.inf
+  MdeModulePkg/Library/BaseMemoryTestLibNull/BaseMemoryTestLibNull.inf
 
   MdeModulePkg/Universal/CapsuleRuntimeDxe/CapsuleRuntimeDxe.inf
   MdeModulePkg/Universal/Console/ConPlatformDxe/ConPlatformDxe.inf