diff options
Diffstat (limited to 'MdeModulePkg/Include/Protocol/GenericMemoryTest.h')
| -rw-r--r-- | MdeModulePkg/Include/Protocol/GenericMemoryTest.h | 151 |
1 files changed, 66 insertions, 85 deletions
diff --git a/MdeModulePkg/Include/Protocol/GenericMemoryTest.h b/MdeModulePkg/Include/Protocol/GenericMemoryTest.h index 8f566d3..9fcdffa 100644 --- a/MdeModulePkg/Include/Protocol/GenericMemoryTest.h +++ b/MdeModulePkg/Include/Protocol/GenericMemoryTest.h @@ -1,24 +1,17 @@ -/*++
+/** @file
+ The EFI generic memory test protocol interface.
+ For more information please look at EfiMemoryTest.doc
-Copyright (c) 2006, Intel Corporation
-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.
+Copyright (c) 2006 - 2008, 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
-Module Name:
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
- GenericMemoryTest.h
-
-Abstract:
-
- The EFI generic memory test protocol
- For more information please look at EfiMemoryTest.doc
-
---*/
+**/
#ifndef __GENERIC_MEMORY_TEST_H__
#define __GENERIC_MEMORY_TEST_H__
@@ -36,6 +29,21 @@ typedef enum { MAXLEVEL
} EXTENDMEM_COVERAGE_LEVEL;
+
+/**
+ Initialize the generic memory test.
+
+ @param This Protocol instance pointer.
+ @param Level The coverage level of the memory test.
+ @param RequireSoftECCInit Indicate if the memory need software ECC init.
+
+ @retval EFI_SUCCESS The generic memory test initialized correctly.
+ @retval EFI_NO_MEDIA There is not any non-tested memory found, in this
+ function if not any non-tesed memory found means
+ that the memory test driver have not detect any
+ non-tested extended memory of current system.
+
+**/
typedef
EFI_STATUS
(EFIAPI *EFI_MEMORY_TEST_INIT) (
@@ -43,26 +51,28 @@ EFI_STATUS IN EXTENDMEM_COVERAGE_LEVEL Level,
OUT BOOLEAN *RequireSoftECCInit
)
-/*++
+;
- Routine Description:
- Initialize the generic memory test.
- Arguments:
- This - Protocol instance pointer.
- Level - The coverage level of the memory test.
- RequireSoftECCInit - Indicate if the memory need software ECC init.
+/**
+ Perform the memory test.
- Returns:
- EFI_SUCCESS - The generic memory test initialized correctly.
- EFI_NO_MEDIA - There is not any non-tested memory found, in this
- function if not any non-tesed memory found means
- that the memory test driver have not detect any
- non-tested extended memory of current system.
+ @param This Protocol instance pointer.
+ @param TestedMemorySize Return the tested extended memory size.
+ @param TotalMemorySize Return the whole system physical memory size, this
+ value may be changed if in some case some error
+ DIMMs be disabled.
+ @param ErrorOut Any time the memory error occurs, this will be
+ TRUE.
+ @param IfTestAbort Indicate if the user press "ESC" to skip the memory
+ test.
---*/
-;
+ @retval EFI_SUCCESS One block of memory test ok, the block size is hide
+ internally.
+ @retval EFI_NOT_FOUND Indicate all the non-tested memory blocks have
+ already go through.
+**/
typedef
EFI_STATUS
(EFIAPI *EFI_PERFORM_MEMORY_TEST) (
@@ -72,51 +82,39 @@ EFI_STATUS OUT BOOLEAN *ErrorOut,
IN BOOLEAN IfTestAbort
)
-/*++
-
- Routine Description:
- Perform the memory test.
-
- Arguments:
- This - Protocol instance pointer.
- TestedMemorySize - Return the tested extended memory size.
- TotalMemorySize - Return the whole system physical memory size, this
- value may be changed if in some case some error
- DIMMs be disabled.
- ErrorOut - Any time the memory error occurs, this will be TRUE.
- IfTestAbort - Indicate if the user press "ESC" to skip the memory
- test.
-
- Returns:
- EFI_SUCCESS - One block of memory test ok, the block size is hide
- internally.
- EFI_NOT_FOUND - Indicate all the non-tested memory blocks have
- already go through.
-
---*/
;
+
+/**
+ The memory test finished.
+
+ @param This Protocol instance pointer.
+
+ @retval EFI_SUCCESS Successful free all the generic memory test driver
+ allocated resource and notify to platform memory
+ test driver that memory test finished.
+
+**/
typedef
EFI_STATUS
(EFIAPI *EFI_MEMORY_TEST_FINISHED) (
IN EFI_GENERIC_MEMORY_TEST_PROTOCOL *This
)
-/*++
-
- Routine Description:
- The memory test finished.
-
- Arguments:
- This - Protocol instance pointer.
+;
- Returns:
- EFI_SUCCESS - Successful free all the generic memory test driver
- allocated resource and notify to platform memory
- test driver that memory test finished.
+/**
+ Provide capability to test compatible range which used by some sepcial
+ driver required using memory range before BDS perform memory test.
---*/
-;
+ @param This Protocol instance pointer.
+ @param StartAddress The start address of the memory range.
+ @param Length The memory range's length.
+ @retval EFI_SUCCESS The compatible memory range pass the memory test.
+ @retval EFI_DEVICE_ERROR The compatible memory range test find memory error
+ and also return return the error address.
+
+**/
typedef
EFI_STATUS
(EFIAPI *EFI_MEMORY_TEST_COMPATIBLE_RANGE) (
@@ -124,23 +122,6 @@ EFI_STATUS IN EFI_PHYSICAL_ADDRESS StartAddress,
IN UINT64 Length
)
-/*++
-
- Routine Description:
- Provide capability to test compatible range which used by some sepcial
- driver required using memory range before BDS perform memory test.
-
- Arguments:
- This - Protocol instance pointer.
- StartAddress - The start address of the memory range.
- Length - The memory range's length.
-
- Return:
- EFI_SUCCESS - The compatible memory range pass the memory test.
- EFI_DEVICE_ERROR - The compatible memory range test find memory error
- and also return return the error address.
-
---*/
;
struct _EFI_GENERIC_MEMORY_TEST_PROTOCOL {
|