sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Code scrub for MdeModule Include header file (Protocol and DEC)

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6817 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
lgao4
2008-12-03 08:55:36 +00:00
parent aa79b0b379
commit 346cf9ace3
18 changed files with 116 additions and 98 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
MdeModulePkg/Include/Protocol/GenericMemoryTest.h
View File

@ -1,5 +1,5 @@
/** @file
This protocol defines the EFI generic memory test interfaces in Dxe phase.
This protocol defines the generic memory test interfaces in Dxe phase.
Copyright (c) 2006 - 2008, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials
@ -20,6 +20,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
typedef struct _EFI_GENERIC_MEMORY_TEST_PROTOCOL EFI_GENERIC_MEMORY_TEST_PROTOCOL;
///
/// Memory test coverage level
/// Ignore op not test memory, Quick and Sparse op test memory quickly, Extensive op test memory detailedly.
///
typedef enum {
IGNORE,
QUICK,
@ -36,11 +40,10 @@ typedef enum {
@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
@retval EFI_SUCCESS The generic memory test is initialized correctly.
@retval EFI_NO_MEDIA There is not any non-tested memory found, which means
that the memory test driver have not detect any
non-tested extended memory of current system.
non-tested extended memory in current system.
**/
typedef
@ -58,24 +61,20 @@ EFI_STATUS
@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.
value may be changed if some error DIMMs is disabled in some case.
@param ErrorOut TRUE if the memory error occurs.
@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.
@retval EFI_DEVICE_ERROR Mis-compare error, and no agent can handle it
@retval EFI_SUCCESS One block of memory pass test.
@retval EFI_NOT_FOUND Indicate all the non-tested memory blocks have been
already gone through.
@retval EFI_DEVICE_ERROR Memory device error occurs and no agent can handle it.
**/
typedef
EFI_STATUS
(EFIAPI *EFI_PERFORM_MEMORY_TEST)(
IN EFI_GENERIC_MEMORY_TEST_PROTOCOL *This,
IN EFI_GENERIC_MEMORY_TEST_PROTOCOL *This,
OUT UINT64 *TestedMemorySize,
OUT UINT64 *TotalMemorySize,
OUT BOOLEAN *ErrorOut,
@ -84,13 +83,11 @@ EFI_STATUS
/**
The memory test finished.
Finish the memory test.
@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.
@retval EFI_SUCCESS Successful.
**/
typedef
@ -100,12 +97,13 @@ EFI_STATUS
);
/**
Provide capability to test compatible range which used by some sepcial
driver required using memory range before BDS perform memory test.
Provide capability to test compatible range used by some sepcial
driver 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.
@param StartAddress The start address of the compatible memory range that
must be below 16M.
@param Length The compatible memory range's length.
@retval EFI_SUCCESS The compatible memory range pass the memory test.
@retval EFI_INVALID_PARAMETER The compatible memory range must be below 16M.