tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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 2009-06-12 05:47:03 +00:00
parent fba25bdd54
commit e40b7d5d1b
7 changed files with 90 additions and 109 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
MdeModulePkg/Include/Guid/Crc32GuidedSectionExtraction.h
View File

@ -1,10 +1,7 @@
/** @file /** @file
This file defines CRC32 GUID to specify the CRC32
This file defines a group of guids to specify the different
encapsulation scheme for the GUIDed section. encapsulation scheme for the GUIDed section.
Only one GUID is defined for the CRC32 encapsulation scheme.
Copyright (c) 2006 - 2009, Intel Corporation Copyright (c) 2006 - 2009, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
@ -19,10 +16,6 @@
#ifndef __CRC32_GUIDED_SECTION_EXTRACTION_H__ #ifndef __CRC32_GUIDED_SECTION_EXTRACTION_H__
#define __CRC32_GUIDED_SECTION_EXTRACTION_H__ #define __CRC32_GUIDED_SECTION_EXTRACTION_H__
//
// GUID definition. All GUIDed section extraction protocols share the
// same interface, but each has a different GUID. All the GUIDs are defined here.
//
#define EFI_CRC32_GUIDED_SECTION_EXTRACTION_GUID \ #define EFI_CRC32_GUIDED_SECTION_EXTRACTION_GUID \
{ 0xFC1BCDB0, 0x7D31, 0x49aa, {0x93, 0x6A, 0xA4, 0x60, 0x0D, 0x9D, 0xD0, 0x83 } } { 0xFC1BCDB0, 0x7D31, 0x49aa, {0x93, 0x6A, 0xA4, 0x60, 0x0D, 0x9D, 0xD0, 0x83 } }

12
MdeModulePkg/Include/Guid/MemoryTypeInformation.h
View File

@ -1,9 +1,13 @@
/** @file /** @file
This file defines the memory type information GUID for its variable and guid. This file defines:
It also defines memory type info variable name and data structure for both variable and hob, * Memory Type Information GUID for HOB and Variable
which can be used to store the information for each memory type in EFI variable or HOB. * Memory Type Information Variable Name
* Memory Type Information GUID HOB data structure
Copyright (c) 2006 - 2008, Intel Corporation. <BR> The memory type information HOB and variable can
be used to store the information for each memory type in Variable or HOB.
Copyright (c) 2006 - 2009, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at

6
MdeModulePkg/Include/Library/HiiLib.h
View File

@ -304,8 +304,8 @@ HiiConstructConfigHdr (
BOOLEAN BOOLEAN
EFIAPI EFIAPI
HiiSetToDefaults ( HiiSetToDefaults (
IN CONST EFI_STRING Request, OPTIONAL IN CONST EFI_STRING Request, OPTIONAL
IN UINT16 DefaultId IN UINT16 DefaultId
); );
/** /**
@ -325,7 +325,7 @@ HiiSetToDefaults (
BOOLEAN BOOLEAN
EFIAPI EFIAPI
HiiValidateSettings ( HiiValidateSettings (
IN CONST EFI_STRING Request OPTIONAL IN CONST EFI_STRING Request OPTIONAL
); );
/** /**

9
MdeModulePkg/Include/Library/ResetSystemLib.h
View File

@ -46,8 +46,7 @@ ResetWarm (
This function causes the system to enter a power state equivalent This function causes the system to enter a power state equivalent
to the ACPI G2/S5 or G3 states. to the ACPI G2/S5 or G3 states.
If this function returns, it means the system does If this function returns, it means that the system does not support shut down reset.
not support shut down reset.
**/ **/
VOID VOID
EFIAPI EFIAPI
@ -56,11 +55,9 @@ ResetShutdown (
); );
/** /**
This function causes the system to enter S3 and then This function causes the system to enter S3 and then wake up immediately.
wake up immediately.
If this function returns, it means the If this function returns, it means that the system does not support S3 feature.
system does not support the feature.
**/ **/
VOID VOID
EFIAPI EFIAPI

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

@ -1,7 +1,7 @@
/** @file /** @file
This protocol defines the 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> Copyright (c) 2006 - 2009, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 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 This Protocol instance pointer.
@param TestedMemorySize Return the tested extended memory size. @param TestedMemorySize Return the tested extended memory size.
@param TotalMemorySize Return the whole system physical 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 ErrorOut TRUE if the memory error occured.
@param IfTestAbort Indicates that the user pressed "ESC" to skip the memory test. @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 Provides the capability to test the compatible range used by some special drivers.
driver.
@param This Protocol instance pointer. @param This Protocol instance pointer.
@param StartAddress The start address of the compatible memory range that @param StartAddress The start address of the compatible memory range that

106
MdeModulePkg/Include/Protocol/Print2.h
View File

@ -29,13 +29,13 @@ typedef struct _EFI_PRINT2_PROTOCOL EFI_PRINT2_PROTOCOL;
Produces a Null-terminated Unicode string in an output buffer, based on Produces a Null-terminated Unicode string in an output buffer, based on
a Null-terminated Unicode format string and a BASE_LIST argument list 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 Produces a Null-terminated Unicode string in the output buffer
and BufferSize. specified by StartOfBuffer and BufferSize.
The Unicode string is produced by parsing the format string specified by FormatString. 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 Arguments are pulled from the variable argument list specified by Marker.
contents of the format string. 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 This function returns the number of Unicode characters in the produced output buffer,
the Null-terminator. not including the Null-terminator.
If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned. 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 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 NULL, then ASSERT().
If BufferSize > 1 and FormatString is not aligned on a 16-bit boundary, 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 If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than
PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().
ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string
contains more than PcdMaximumUnicodeStringLength Unicode characters not including the contains more than PcdMaximumUnicodeStringLength Unicode characters not including the
Null-terminator, then ASSERT(). Null-terminator, then ASSERT().
@ -72,12 +71,12 @@ UINTN
Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated
Unicode format string and variable argument list. Unicode format string and variable argument list.
Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer Produces a Null-terminated Unicode string in the output buffer
and BufferSize. specified by StartOfBuffer and BufferSize.
The Unicode string is produced by parsing the format string specified by FormatString. 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. 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 This function returns the number of Unicode characters in the produced output buffer,
the Null-terminator. not including the Null-terminator.
If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned. 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 NULL, then ASSERT().
@ -85,8 +84,7 @@ UINTN
If BufferSize > 1 and FormatString is NULL, then ASSERT(). 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 BufferSize > 1 and FormatString is not aligned on a 16-bit boundary, then ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than
PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().
ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string
contains more than PcdMaximumUnicodeStringLength Unicode characters not including the contains more than PcdMaximumUnicodeStringLength Unicode characters not including the
Null-terminator, then ASSERT(). Null-terminator, then ASSERT().
@ -115,21 +113,20 @@ UINTN
Produces a Null-terminated Unicode string in an output buffer, based on a Null-terminated Produces a Null-terminated Unicode string in an output buffer, based on a Null-terminated
ASCII format string and a BASE_LIST argument list ASCII format string and a BASE_LIST argument list
Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer Produces a Null-terminated Unicode string in the output buffer
and BufferSize. specified by StartOfBuffer and BufferSize.
The Unicode string is produced by parsing the format string specified by FormatString. 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 Arguments are pulled from the variable argument list specified by Marker based on the
contents of the format string. contents of the format string.
This function returns the number of Unicode characters in the produced output buffer, not including This function returns the number of Unicode characters in the produced output buffer,
the Null-terminator. not including the Null-terminator.
If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned. 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 NULL, then ASSERT().
If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, 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 BufferSize > 1 and FormatString is NULL, then ASSERT().
If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT().
ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string
contains more than PcdMaximumUnicodeStringLength Unicode characters not including the contains more than PcdMaximumUnicodeStringLength Unicode characters not including the
Null-terminator, then ASSERT(). Null-terminator, then ASSERT().
@ -157,21 +154,19 @@ UINTN
Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated
ASCII format string and a variable argument list. ASCII format string and a variable argument list.
Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer Produces a Null-terminated Unicode string in the output buffer
and BufferSize. specified by StartOfBuffer and BufferSize.
The Unicode string is produced by parsing the format string specified by FormatString. 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 Arguments are pulled from the variable argument list based on the contents of the format string.
format string. This function returns the number of Unicode characters in the produced output buffer,
This function returns the number of Unicode characters in the produced output buffer, not including not including the Null-terminator.
the Null-terminator.
If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned. 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 NULL, then ASSERT().
If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, 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 BufferSize > 1 and FormatString is NULL, then ASSERT().
If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT().
ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string
contains more than PcdMaximumUnicodeStringLength Unicode characters not including the contains more than PcdMaximumUnicodeStringLength Unicode characters not including the
Null-terminator, then ASSERT(). Null-terminator, then ASSERT().
@ -250,20 +245,19 @@ UINTN
Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated
ASCII format string and a BASE_LIST argument list. ASCII format string and a BASE_LIST argument list.
Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer Produces a Null-terminated ASCII string in the output buffer
and BufferSize. pecified by StartOfBuffer and BufferSize.
The ASCII string is produced by parsing the format string specified by FormatString. 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 Arguments are pulled from the variable argument list specified by Marker based on
the contents of the format string. the contents of the format string.
This function returns the number of ASCII characters in the output buffer, not including This function returns the number of ASCII characters in the output buffer,
the Null-terminator. not including the Null-terminator.
If BufferSize is 0, then no output buffer is produced and 0 is returned. 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 StartOfBuffer is NULL, then ASSERT().
If BufferSize > 0 and FormatString is NULL, then ASSERT(). If BufferSize > 0 and FormatString is NULL, then ASSERT().
If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT().
ASSERT().
If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string
contains more than PcdMaximumAsciiStringLength ASCII characters not including the contains more than PcdMaximumAsciiStringLength ASCII characters not including the
Null-terminator, then ASSERT(). Null-terminator, then ASSERT().
@ -291,20 +285,18 @@ UINTN
Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated
ASCII format string and variable argument list. ASCII format string and variable argument list.
Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer Produces a Null-terminated ASCII string in the output buffer
and BufferSize. specified by StartOfBuffer and BufferSize.
The ASCII string is produced by parsing the format string specified by FormatString. 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 Arguments are pulled from the variable argument list based on the contents of the format string.
format string. This function returns the number of ASCII characters in the output buffer,
This function returns the number of ASCII characters in the output buffer, not including not including the Null-terminator.
the Null-terminator.
If BufferSize is 0, then no output buffer is produced and 0 is returned. 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 StartOfBuffer is NULL, then ASSERT().
If BufferSize > 0 and FormatString is NULL, then ASSERT(). If BufferSize > 0 and FormatString is NULL, then ASSERT().
If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT().
ASSERT().
If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string
contains more than PcdMaximumAsciiStringLength ASCII characters not including the contains more than PcdMaximumAsciiStringLength ASCII characters not including the
Null-terminator, then ASSERT(). Null-terminator, then ASSERT().
@ -333,21 +325,20 @@ UINTN
Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated
Unicode format string and a BASE_LIST argument list. Unicode format string and a BASE_LIST argument list.
Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer Produces a Null-terminated ASCII string in the output buffer
and BufferSize. specified by StartOfBuffer and BufferSize.
The ASCII string is produced by parsing the format string specified by FormatString. 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 Arguments are pulled from the variable argument list specified by Marker based on
the contents of the format string. the contents of the format string.
This function returns the number of ASCII characters in the output buffer, not including This function returns the number of ASCII characters in the output buffer,
the Null-terminator. not including the Null-terminator.
If BufferSize is 0, then no output buffer is produced and 0 is returned. 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 StartOfBuffer is NULL, then ASSERT().
If BufferSize > 0 and FormatString 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 BufferSize > 0 and FormatString is not aligned on a 16-bit boundary, then ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than
PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().
ASSERT().
If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string
contains more than PcdMaximumAsciiStringLength ASCII characters not including the contains more than PcdMaximumAsciiStringLength ASCII characters not including the
Null-terminator, then ASSERT(). Null-terminator, then ASSERT().
@ -375,21 +366,19 @@ UINTN
Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated
Unicode format string and variable argument list. Unicode format string and variable argument list.
Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer Produces a Null-terminated ASCII string in the output buffer
and BufferSize. specified by StartOfBuffer and BufferSize.
The ASCII string is produced by parsing the format string specified by FormatString. 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 Arguments are pulled from the variable argument list based on the contents of the format string.
format string. This function returns the number of ASCII characters in the output buffer,
This function returns the number of ASCII characters in the output buffer, not including not including the Null-terminator.
the Null-terminator.
If BufferSize is 0, then no output buffer is produced and 0 is returned. 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 StartOfBuffer is NULL, then ASSERT().
If BufferSize > 0 and FormatString 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 BufferSize > 0 and FormatString is not aligned on a 16-bit boundary, then ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than
PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().
ASSERT().
If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string
contains more than PcdMaximumAsciiStringLength ASCII characters not including the contains more than PcdMaximumAsciiStringLength ASCII characters not including the
Null-terminator, then ASSERT(). Null-terminator, then ASSERT().
@ -418,8 +407,7 @@ UINTN
Converts a decimal value to a Null-terminated ASCII string. Converts a decimal value to a Null-terminated ASCII string.
Converts the decimal number specified by 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 specified by Buffer containing at most Width characters. No padding of spaces is ever performed.
is ever performed.
If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed. 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. 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 If the conversion contains more than Width characters, then only the first Width

50
MdeModulePkg/Include/Protocol/SwapAddressRange.h
View File

@ -43,39 +43,39 @@ typedef UINT8 EFI_SWAP_LOCK_CAPABILITY;
This function gets the address range location of This function gets the address range location of
boot block and backup block. boot block and backup block.
@param This Indicates the calling context. @param This Indicates the calling context.
@param BootBlockBase Base address of current boot block. @param BootBlockBase Base address of current boot block.
@param BootBlockSize Size (in bytes) of current boot block. @param BootBlockSize Size (in bytes) of current boot block.
@param BackupBlockBase Base address of current backup block. @param BackupBlockBase Base address of current backup block.
@param BackupBlockSize Size (in bytes) 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 typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_GET_RANGE_LOCATION) ( (EFIAPI *EFI_GET_RANGE_LOCATION) (
IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL * This, IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL *This,
OUT EFI_PHYSICAL_ADDRESS * BootBlockBase, OUT EFI_PHYSICAL_ADDRESS *BootBlockBase,
OUT UINTN *BootBlockSize, OUT UINTN *BootBlockSize,
OUT EFI_PHYSICAL_ADDRESS * BackupBlockBase, OUT EFI_PHYSICAL_ADDRESS *BackupBlockBase,
OUT UINTN *BackupBlockSize OUT UINTN *BackupBlockSize
); );
/** /**
This service checks if the boot block and backup block has been swapped. This service checks if the boot block and backup block has been swapped.
@param This Indicates the calling context. @param This Indicates the calling context.
@param SwapState True if the boot block and backup block has been swapped. @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. 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 typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_GET_SWAP_STATE) ( (EFIAPI *EFI_GET_SWAP_STATE) (
IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL * This, IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL *This,
OUT BOOLEAN *SwapState 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 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. is not affected by the old swap state.
@param This Indicates the calling context. @param This Indicates the calling context.
@param NewSwapState True to swap real boot block and backup block, False to swap them back. @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_SUCCESS The call was successful.
@retval EFI_ABORTED Set swap state error @retval EFI_ABORTED Set swap state error
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_SET_SWAP_STATE) ( (EFIAPI *EFI_SET_SWAP_STATE) (
IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL * This, IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL *This,
IN BOOLEAN NewSwapState IN BOOLEAN NewSwapState
); );
@ -116,16 +116,16 @@ EFI_STATUS
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_GET_RTC_POWER_STATUS) ( (EFIAPI *EFI_GET_RTC_POWER_STATUS) (
IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL * This, IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL *This,
OUT BOOLEAN *RtcPowerFailed 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. 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 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. @retval EFI_SUCCESS The call was successful.
@ -133,8 +133,8 @@ EFI_STATUS
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_GET_SWAP_LOCK_CAPABILITY) ( (EFIAPI *EFI_GET_SWAP_LOCK_CAPABILITY) (
IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL * This, IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL *This,
OUT EFI_SWAP_LOCK_CAPABILITY * LockCapability OUT EFI_SWAP_LOCK_CAPABILITY *LockCapability
); );
@ -154,7 +154,7 @@ EFI_STATUS
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_SET_SWAP_LOCK) ( (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 EFI_SWAP_LOCK_CAPABILITY LockCapability,
IN BOOLEAN NewLockState IN BOOLEAN NewLockState
); );