2 This protocol defines the generic memory test interfaces in Dxe phase.
4 Copyright (c) 2006 - 2008, 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
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.
15 #ifndef __GENERIC_MEMORY_TEST_H__
16 #define __GENERIC_MEMORY_TEST_H__
18 #define EFI_GENERIC_MEMORY_TEST_PROTOCOL_GUID \
19 { 0x309de7f1, 0x7f5e, 0x4ace, {0xb4, 0x9c, 0x53, 0x1b, 0xe5, 0xaa, 0x95, 0xef} }
21 typedef struct _EFI_GENERIC_MEMORY_TEST_PROTOCOL EFI_GENERIC_MEMORY_TEST_PROTOCOL
;
24 /// Memory test coverage level
25 /// Ignore op not test memory, Quick and Sparse op test memory quickly, Extensive op test memory detailedly.
33 } EXTENDMEM_COVERAGE_LEVEL
;
37 Initialize the generic memory test.
39 @param This Protocol instance pointer.
40 @param Level The coverage level of the memory test.
41 @param RequireSoftECCInit Indicate if the memory need software ECC init.
43 @retval EFI_SUCCESS The generic memory test is initialized correctly.
44 @retval EFI_NO_MEDIA There is not any non-tested memory found, which means
45 that the memory test driver have not detect any
46 non-tested extended memory in current system.
51 (EFIAPI
*EFI_MEMORY_TEST_INIT
)(
52 IN EFI_GENERIC_MEMORY_TEST_PROTOCOL
*This
,
53 IN EXTENDMEM_COVERAGE_LEVEL Level
,
54 OUT BOOLEAN
*RequireSoftECCInit
59 Perform the memory test.
61 @param This Protocol instance pointer.
62 @param TestedMemorySize Return the tested extended memory size.
63 @param TotalMemorySize Return the whole system physical memory size, this
64 value may be changed if some error DIMMs is disabled in some case.
65 @param ErrorOut TRUE if the memory error occurs.
66 @param IfTestAbort Indicate if the user press "ESC" to skip the memory test.
68 @retval EFI_SUCCESS One block of memory pass test.
69 @retval EFI_NOT_FOUND Indicate all the non-tested memory blocks have been
71 @retval EFI_DEVICE_ERROR Memory device error occurs and no agent can handle it.
76 (EFIAPI
*EFI_PERFORM_MEMORY_TEST
)(
77 IN EFI_GENERIC_MEMORY_TEST_PROTOCOL
*This
,
78 OUT UINT64
*TestedMemorySize
,
79 OUT UINT64
*TotalMemorySize
,
80 OUT BOOLEAN
*ErrorOut
,
81 IN BOOLEAN IfTestAbort
86 Finish the memory test.
88 @param This Protocol instance pointer.
90 @retval EFI_SUCCESS Success. Then free all the generic memory test driver
91 allocated resource and notify to platform memory
92 test driver that memory test finished.
97 (EFIAPI
*EFI_MEMORY_TEST_FINISHED
)(
98 IN EFI_GENERIC_MEMORY_TEST_PROTOCOL
*This
102 Provide capability to test compatible range used by some sepcial
103 driver before BDS perform memory test.
105 @param This Protocol instance pointer.
106 @param StartAddress The start address of the compatible memory range that
108 @param Length The compatible memory range's length.
110 @retval EFI_SUCCESS The compatible memory range pass the memory test.
111 @retval EFI_INVALID_PARAMETER The compatible memory range are not below Low 16M.
116 (EFIAPI
*EFI_MEMORY_TEST_COMPATIBLE_RANGE
)(
117 IN EFI_GENERIC_MEMORY_TEST_PROTOCOL
*This
,
118 IN EFI_PHYSICAL_ADDRESS StartAddress
,
122 struct _EFI_GENERIC_MEMORY_TEST_PROTOCOL
{
123 EFI_MEMORY_TEST_INIT MemoryTestInit
;
124 EFI_PERFORM_MEMORY_TEST PerformMemoryTest
;
125 EFI_MEMORY_TEST_FINISHED Finished
;
126 EFI_MEMORY_TEST_COMPATIBLE_RANGE CompatibleRangeTest
;
129 extern EFI_GUID gEfiGenericMemTestProtocolGuid
;