Update some comments for MdeModulePkg Include header files.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8536 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
lgao4
@ -1,7 +1,7 @@
|
||||
/** @file
|
||||
This protocol defines the generic memory test interfaces in Dxe phase.
|
||||
|
||||
Copyright (c) 2006 - 2008, Intel Corporation. <BR>
|
||||
Copyright (c) 2006 - 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
|
||||
@ -59,7 +59,7 @@ EFI_STATUS
|
||||
@param This Protocol instance pointer.
|
||||
@param TestedMemorySize Return the tested extended memory size.
|
||||
@param TotalMemorySize Return the whole system physical memory size.
|
||||
The total memory size does not include memory in a slot with a disabled DIMM.
|
||||
The total memory size does not include memory in a slot with a disabled DIMM.
|
||||
@param ErrorOut TRUE if the memory error occured.
|
||||
@param IfTestAbort Indicates that the user pressed "ESC" to skip the memory test.
|
||||
|
||||
@ -94,8 +94,7 @@ EFI_STATUS
|
||||
);
|
||||
|
||||
/**
|
||||
Provides the capability to test the compatible range used by a special
|
||||
driver.
|
||||
Provides the capability to test the compatible range used by some special drivers.
|
||||
|
||||
@param This Protocol instance pointer.
|
||||
@param StartAddress The start address of the compatible memory range that
|
||||
|
||||
@ -29,13 +29,13 @@ typedef struct _EFI_PRINT2_PROTOCOL EFI_PRINT2_PROTOCOL;
|
||||
Produces a Null-terminated Unicode string in an output buffer, based on
|
||||
a Null-terminated Unicode format string and a BASE_LIST argument list
|
||||
|
||||
Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer
|
||||
and BufferSize.
|
||||
Produces a Null-terminated Unicode string in the output buffer
|
||||
specified by StartOfBuffer and BufferSize.
|
||||
The Unicode string is produced by parsing the format string specified by FormatString.
|
||||
Arguments are pulled from the variable argument list specified by Marker. Marker is constructed based on the
|
||||
contents of the format string.
|
||||
This function returns the number of Unicode characters in the produced output buffer, not including
|
||||
the Null-terminator.
|
||||
Arguments are pulled from the variable argument list specified by Marker.
|
||||
Marker is constructed based on the contents of the format string.
|
||||
This function returns the number of Unicode characters in the produced output buffer,
|
||||
not including the Null-terminator.
|
||||
If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.
|
||||
|
||||
If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().
|
||||
@ -43,8 +43,7 @@ typedef struct _EFI_PRINT2_PROTOCOL EFI_PRINT2_PROTOCOL;
|
||||
If BufferSize > 1 and FormatString is NULL, then ASSERT().
|
||||
If BufferSize > 1 and FormatString is not aligned on a 16-bit boundary, then ASSERT().
|
||||
If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than
|
||||
PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then
|
||||
ASSERT().
|
||||
PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().
|
||||
If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string
|
||||
contains more than PcdMaximumUnicodeStringLength Unicode characters not including the
|
||||
Null-terminator, then ASSERT().
|
||||
@ -72,12 +71,12 @@ UINTN
|
||||
Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated
|
||||
Unicode format string and variable argument list.
|
||||
|
||||
Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer
|
||||
and BufferSize.
|
||||
Produces a Null-terminated Unicode string in the output buffer
|
||||
specified by StartOfBuffer and BufferSize.
|
||||
The Unicode string is produced by parsing the format string specified by FormatString.
|
||||
Arguments are pulled from the variable argument list based on the contents of the format string.
|
||||
This function returns the number of Unicode characters in the produced output buffer, not including
|
||||
the Null-terminator.
|
||||
This function returns the number of Unicode characters in the produced output buffer,
|
||||
not including the Null-terminator.
|
||||
If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.
|
||||
|
||||
If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().
|
||||
@ -85,8 +84,7 @@ UINTN
|
||||
If BufferSize > 1 and FormatString is NULL, then ASSERT().
|
||||
If BufferSize > 1 and FormatString is not aligned on a 16-bit boundary, then ASSERT().
|
||||
If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than
|
||||
PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then
|
||||
ASSERT().
|
||||
PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().
|
||||
If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string
|
||||
contains more than PcdMaximumUnicodeStringLength Unicode characters not including the
|
||||
Null-terminator, then ASSERT().
|
||||
@ -115,21 +113,20 @@ UINTN
|
||||
Produces a Null-terminated Unicode string in an output buffer, based on a Null-terminated
|
||||
ASCII format string and a BASE_LIST argument list
|
||||
|
||||
Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer
|
||||
and BufferSize.
|
||||
Produces a Null-terminated Unicode string in the output buffer
|
||||
specified by StartOfBuffer and BufferSize.
|
||||
The Unicode string is produced by parsing the format string specified by FormatString.
|
||||
Arguments are pulled from the variable argument list specified by Marker based on the
|
||||
contents of the format string.
|
||||
This function returns the number of Unicode characters in the produced output buffer, not including
|
||||
the Null-terminator.
|
||||
This function returns the number of Unicode characters in the produced output buffer,
|
||||
not including the Null-terminator.
|
||||
If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.
|
||||
|
||||
If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().
|
||||
If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().
|
||||
If BufferSize > 1 and FormatString is NULL, then ASSERT().
|
||||
If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than
|
||||
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then
|
||||
ASSERT().
|
||||
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT().
|
||||
If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string
|
||||
contains more than PcdMaximumUnicodeStringLength Unicode characters not including the
|
||||
Null-terminator, then ASSERT().
|
||||
@ -157,21 +154,19 @@ UINTN
|
||||
Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated
|
||||
ASCII format string and a variable argument list.
|
||||
|
||||
Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer
|
||||
and BufferSize.
|
||||
Produces a Null-terminated Unicode string in the output buffer
|
||||
specified by StartOfBuffer and BufferSize.
|
||||
The Unicode string is produced by parsing the format string specified by FormatString.
|
||||
Arguments are pulled from the variable argument list based on the contents of the
|
||||
format string.
|
||||
This function returns the number of Unicode characters in the produced output buffer, not including
|
||||
the Null-terminator.
|
||||
Arguments are pulled from the variable argument list based on the contents of the format string.
|
||||
This function returns the number of Unicode characters in the produced output buffer,
|
||||
not including the Null-terminator.
|
||||
If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.
|
||||
|
||||
If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().
|
||||
If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().
|
||||
If BufferSize > 1 and FormatString is NULL, then ASSERT().
|
||||
If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than
|
||||
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then
|
||||
ASSERT().
|
||||
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT().
|
||||
If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string
|
||||
contains more than PcdMaximumUnicodeStringLength Unicode characters not including the
|
||||
Null-terminator, then ASSERT().
|
||||
@ -250,20 +245,19 @@ UINTN
|
||||
Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated
|
||||
ASCII format string and a BASE_LIST argument list.
|
||||
|
||||
Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer
|
||||
and BufferSize.
|
||||
Produces a Null-terminated ASCII string in the output buffer
|
||||
pecified by StartOfBuffer and BufferSize.
|
||||
The ASCII string is produced by parsing the format string specified by FormatString.
|
||||
Arguments are pulled from the variable argument list specified by Marker based on
|
||||
the contents of the format string.
|
||||
This function returns the number of ASCII characters in the output buffer, not including
|
||||
the Null-terminator.
|
||||
This function returns the number of ASCII characters in the output buffer,
|
||||
not including the Null-terminator.
|
||||
If BufferSize is 0, then no output buffer is produced and 0 is returned.
|
||||
|
||||
If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().
|
||||
If BufferSize > 0 and FormatString is NULL, then ASSERT().
|
||||
If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than
|
||||
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then
|
||||
ASSERT().
|
||||
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT().
|
||||
If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string
|
||||
contains more than PcdMaximumAsciiStringLength ASCII characters not including the
|
||||
Null-terminator, then ASSERT().
|
||||
@ -291,20 +285,18 @@ UINTN
|
||||
Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated
|
||||
ASCII format string and variable argument list.
|
||||
|
||||
Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer
|
||||
and BufferSize.
|
||||
Produces a Null-terminated ASCII string in the output buffer
|
||||
specified by StartOfBuffer and BufferSize.
|
||||
The ASCII string is produced by parsing the format string specified by FormatString.
|
||||
Arguments are pulled from the variable argument list based on the contents of the
|
||||
format string.
|
||||
This function returns the number of ASCII characters in the output buffer, not including
|
||||
the Null-terminator.
|
||||
Arguments are pulled from the variable argument list based on the contents of the format string.
|
||||
This function returns the number of ASCII characters in the output buffer,
|
||||
not including the Null-terminator.
|
||||
If BufferSize is 0, then no output buffer is produced and 0 is returned.
|
||||
|
||||
If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().
|
||||
If BufferSize > 0 and FormatString is NULL, then ASSERT().
|
||||
If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than
|
||||
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then
|
||||
ASSERT().
|
||||
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT().
|
||||
If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string
|
||||
contains more than PcdMaximumAsciiStringLength ASCII characters not including the
|
||||
Null-terminator, then ASSERT().
|
||||
@ -333,21 +325,20 @@ UINTN
|
||||
Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated
|
||||
Unicode format string and a BASE_LIST argument list.
|
||||
|
||||
Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer
|
||||
and BufferSize.
|
||||
Produces a Null-terminated ASCII string in the output buffer
|
||||
specified by StartOfBuffer and BufferSize.
|
||||
The ASCII string is produced by parsing the format string specified by FormatString.
|
||||
Arguments are pulled from the variable argument list specified by Marker based on
|
||||
the contents of the format string.
|
||||
This function returns the number of ASCII characters in the output buffer, not including
|
||||
the Null-terminator.
|
||||
This function returns the number of ASCII characters in the output buffer,
|
||||
not including the Null-terminator.
|
||||
If BufferSize is 0, then no output buffer is produced and 0 is returned.
|
||||
|
||||
If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().
|
||||
If BufferSize > 0 and FormatString is NULL, then ASSERT().
|
||||
If BufferSize > 0 and FormatString is not aligned on a 16-bit boundary, then ASSERT().
|
||||
If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than
|
||||
PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then
|
||||
ASSERT().
|
||||
PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().
|
||||
If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string
|
||||
contains more than PcdMaximumAsciiStringLength ASCII characters not including the
|
||||
Null-terminator, then ASSERT().
|
||||
@ -375,21 +366,19 @@ UINTN
|
||||
Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated
|
||||
Unicode format string and variable argument list.
|
||||
|
||||
Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer
|
||||
and BufferSize.
|
||||
Produces a Null-terminated ASCII string in the output buffer
|
||||
specified by StartOfBuffer and BufferSize.
|
||||
The ASCII string is produced by parsing the format string specified by FormatString.
|
||||
Arguments are pulled from the variable argument list based on the contents of the
|
||||
format string.
|
||||
This function returns the number of ASCII characters in the output buffer, not including
|
||||
the Null-terminator.
|
||||
Arguments are pulled from the variable argument list based on the contents of the format string.
|
||||
This function returns the number of ASCII characters in the output buffer,
|
||||
not including the Null-terminator.
|
||||
If BufferSize is 0, then no output buffer is produced and 0 is returned.
|
||||
|
||||
If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().
|
||||
If BufferSize > 0 and FormatString is NULL, then ASSERT().
|
||||
If BufferSize > 0 and FormatString is not aligned on a 16-bit boundary, then ASSERT().
|
||||
If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than
|
||||
PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then
|
||||
ASSERT().
|
||||
If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than
|
||||
PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().
|
||||
If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string
|
||||
contains more than PcdMaximumAsciiStringLength ASCII characters not including the
|
||||
Null-terminator, then ASSERT().
|
||||
@ -418,8 +407,7 @@ UINTN
|
||||
Converts a decimal value to a Null-terminated ASCII string.
|
||||
|
||||
Converts the decimal number specified by Value to a Null-terminated ASCII string
|
||||
specified by Buffer containing at most Width characters. No padding of spaces
|
||||
is ever performed.
|
||||
specified by Buffer containing at most Width characters. No padding of spaces is ever performed.
|
||||
If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.
|
||||
The number of ASCII characters in Buffer is returned not including the Null-terminator.
|
||||
If the conversion contains more than Width characters, then only the first Width
|
||||
|
||||
@ -43,39 +43,39 @@ typedef UINT8 EFI_SWAP_LOCK_CAPABILITY;
|
||||
This function gets the address range location of
|
||||
boot block and backup block.
|
||||
|
||||
@param This Indicates the calling context.
|
||||
@param BootBlockBase Base address of current boot block.
|
||||
@param BootBlockSize Size (in bytes) of current boot block.
|
||||
@param BackupBlockBase Base address of current backup block.
|
||||
@param BackupBlockSize Size (in bytes) of current backup block.
|
||||
@param This Indicates the calling context.
|
||||
@param BootBlockBase Base address of current boot block.
|
||||
@param BootBlockSize Size (in bytes) of current boot block.
|
||||
@param BackupBlockBase Base address of current backup block.
|
||||
@param BackupBlockSize Size (in bytes) of current backup block.
|
||||
|
||||
@retval EFI_SUCCESS The call was successful.
|
||||
@retval EFI_SUCCESS The call was successful.
|
||||
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
(EFIAPI *EFI_GET_RANGE_LOCATION) (
|
||||
IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL * This,
|
||||
OUT EFI_PHYSICAL_ADDRESS * BootBlockBase,
|
||||
IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL *This,
|
||||
OUT EFI_PHYSICAL_ADDRESS *BootBlockBase,
|
||||
OUT UINTN *BootBlockSize,
|
||||
OUT EFI_PHYSICAL_ADDRESS * BackupBlockBase,
|
||||
OUT EFI_PHYSICAL_ADDRESS *BackupBlockBase,
|
||||
OUT UINTN *BackupBlockSize
|
||||
);
|
||||
|
||||
/**
|
||||
This service checks if the boot block and backup block has been swapped.
|
||||
|
||||
@param This Indicates the calling context.
|
||||
@param SwapState True if the boot block and backup block has been swapped.
|
||||
False if the boot block and backup block has not been swapped.
|
||||
@param This Indicates the calling context.
|
||||
@param SwapState True if the boot block and backup block has been swapped.
|
||||
False if the boot block and backup block has not been swapped.
|
||||
|
||||
@retval EFI_SUCCESS The call was successful.
|
||||
@retval EFI_SUCCESS The call was successful.
|
||||
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
(EFIAPI *EFI_GET_SWAP_STATE) (
|
||||
IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL * This,
|
||||
IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL *This,
|
||||
OUT BOOLEAN *SwapState
|
||||
);
|
||||
|
||||
@ -85,17 +85,17 @@ EFI_STATUS
|
||||
It also acquires and releases software swap lock during operation. The setting of the new swap state
|
||||
is not affected by the old swap state.
|
||||
|
||||
@param This Indicates the calling context.
|
||||
@param NewSwapState True to swap real boot block and backup block, False to swap them back.
|
||||
@param This Indicates the calling context.
|
||||
@param NewSwapState True to swap real boot block and backup block, False to swap them back.
|
||||
|
||||
@retval EFI_SUCCESS The call was successful.
|
||||
@retval EFI_ABORTED Set swap state error
|
||||
@retval EFI_SUCCESS The call was successful.
|
||||
@retval EFI_ABORTED Set swap state error
|
||||
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
(EFIAPI *EFI_SET_SWAP_STATE) (
|
||||
IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL * This,
|
||||
IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL *This,
|
||||
IN BOOLEAN NewSwapState
|
||||
);
|
||||
|
||||
@ -116,16 +116,16 @@ EFI_STATUS
|
||||
typedef
|
||||
EFI_STATUS
|
||||
(EFIAPI *EFI_GET_RTC_POWER_STATUS) (
|
||||
IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL * This,
|
||||
IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL *This,
|
||||
OUT BOOLEAN *RtcPowerFailed
|
||||
);
|
||||
|
||||
/**
|
||||
This service returns all lock methods for swap operations that the current platform supports. Could be software lock, hardware lock, or unsupport lock.
|
||||
Note that software and hardware lock methods can be used simultaneously.
|
||||
Note that software and hardware lock methods can be used simultaneously.
|
||||
|
||||
@param This Indicates the calling context.
|
||||
@param LockCapability Current lock method for swap operation.
|
||||
@param LockCapability Current lock method for swap operation.
|
||||
|
||||
@retval EFI_SUCCESS The call was successful.
|
||||
|
||||
@ -133,8 +133,8 @@ EFI_STATUS
|
||||
typedef
|
||||
EFI_STATUS
|
||||
(EFIAPI *EFI_GET_SWAP_LOCK_CAPABILITY) (
|
||||
IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL * This,
|
||||
OUT EFI_SWAP_LOCK_CAPABILITY * LockCapability
|
||||
IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL *This,
|
||||
OUT EFI_SWAP_LOCK_CAPABILITY *LockCapability
|
||||
);
|
||||
|
||||
|
||||
@ -154,7 +154,7 @@ EFI_STATUS
|
||||
typedef
|
||||
EFI_STATUS
|
||||
(EFIAPI *EFI_SET_SWAP_LOCK) (
|
||||
IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL * This,
|
||||
IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL *This,
|
||||
IN EFI_SWAP_LOCK_CAPABILITY LockCapability,
|
||||
IN BOOLEAN NewLockState
|
||||
);
|
||||
|
||||
Reference in New Issue
Block a user