diff options
| author | xli24 <xli24@6f19259b-4bc3-4df7-8a09-765794883524> | 2009-02-25 02:09:31 +0000 |
|---|---|---|
| committer | xli24 <xli24@6f19259b-4bc3-4df7-8a09-765794883524> | 2009-02-25 02:09:31 +0000 |
| commit | ad801d0121b30d91d42e9e004dd2da7df7f64a0e (patch) | |
| tree | e8f9285b3b166390d571e055ec0ff90e10f58782 /MdeModulePkg/Include | |
| parent | 7e6142874d9f63b38f122710bc1fe6678b89a1cb (diff) | |
| download | edk2-platforms-ad801d0121b30d91d42e9e004dd2da7df7f64a0e.tar.xz | |
Check in library class of BaseMemoryTestLib.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7663 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg/Include')
| -rw-r--r-- | MdeModulePkg/Include/Library/BaseMemoryTestLib.h | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/MdeModulePkg/Include/Library/BaseMemoryTestLib.h b/MdeModulePkg/Include/Library/BaseMemoryTestLib.h new file mode 100644 index 0000000000..ec384de83e --- /dev/null +++ b/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
|