From: lgao4 Date: Fri, 12 Jun 2009 05:47:03 +0000 (+0000) Subject: Update some comments for MdeModulePkg Include header files. X-Git-Tag: edk2-stable201903~17751 X-Git-Url: https://git.proxmox.com/?a=commitdiff_plain;h=e40b7d5d1b4f7d0cc7d4e91d6aa26033d5afd3a7;hp=fba25bdd548b00d0b2982ab17748de0aa29d609b;p=mirror_edk2.git 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 --- diff --git a/MdeModulePkg/Include/Guid/Crc32GuidedSectionExtraction.h b/MdeModulePkg/Include/Guid/Crc32GuidedSectionExtraction.h index aab340b55d..f608ae4ae9 100644 --- a/MdeModulePkg/Include/Guid/Crc32GuidedSectionExtraction.h +++ b/MdeModulePkg/Include/Guid/Crc32GuidedSectionExtraction.h @@ -1,10 +1,7 @@ /** @file - - This file defines a group of guids to specify the different + This file defines CRC32 GUID to specify the CRC32 encapsulation scheme for the GUIDed section. - Only one GUID is defined for the CRC32 encapsulation scheme. - Copyright (c) 2006 - 2009, 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 @@ -19,10 +16,6 @@ #ifndef __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 \ { 0xFC1BCDB0, 0x7D31, 0x49aa, {0x93, 0x6A, 0xA4, 0x60, 0x0D, 0x9D, 0xD0, 0x83 } } diff --git a/MdeModulePkg/Include/Guid/MemoryTypeInformation.h b/MdeModulePkg/Include/Guid/MemoryTypeInformation.h index f2c0ae3fcd..6143dc70dd 100644 --- a/MdeModulePkg/Include/Guid/MemoryTypeInformation.h +++ b/MdeModulePkg/Include/Guid/MemoryTypeInformation.h @@ -1,9 +1,13 @@ /** @file - This file defines the memory type information GUID for its variable and guid. - It also defines memory type info variable name and data structure for both variable and hob, - which can be used to store the information for each memory type in EFI variable or HOB. + This file defines: + * Memory Type Information GUID for HOB and Variable + * Memory Type Information Variable Name + * Memory Type Information GUID HOB data structure -Copyright (c) 2006 - 2008, Intel Corporation.
+ 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.
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 diff --git a/MdeModulePkg/Include/Library/HiiLib.h b/MdeModulePkg/Include/Library/HiiLib.h index af3ed0eb2b..dd8c231d4f 100644 --- a/MdeModulePkg/Include/Library/HiiLib.h +++ b/MdeModulePkg/Include/Library/HiiLib.h @@ -304,8 +304,8 @@ HiiConstructConfigHdr ( BOOLEAN EFIAPI HiiSetToDefaults ( - IN CONST EFI_STRING Request, OPTIONAL - IN UINT16 DefaultId + IN CONST EFI_STRING Request, OPTIONAL + IN UINT16 DefaultId ); /** @@ -325,7 +325,7 @@ HiiSetToDefaults ( BOOLEAN EFIAPI HiiValidateSettings ( - IN CONST EFI_STRING Request OPTIONAL + IN CONST EFI_STRING Request OPTIONAL ); /** diff --git a/MdeModulePkg/Include/Library/ResetSystemLib.h b/MdeModulePkg/Include/Library/ResetSystemLib.h index f77c441ad5..4b67865fa3 100644 --- a/MdeModulePkg/Include/Library/ResetSystemLib.h +++ b/MdeModulePkg/Include/Library/ResetSystemLib.h @@ -46,8 +46,7 @@ ResetWarm ( This function causes the system to enter a power state equivalent to the ACPI G2/S5 or G3 states. - If this function returns, it means the system does - not support shut down reset. + If this function returns, it means that the system does not support shut down reset. **/ VOID EFIAPI @@ -56,11 +55,9 @@ ResetShutdown ( ); /** - This function causes the system to enter S3 and then - wake up immediately. + This function causes the system to enter S3 and then wake up immediately. - If this function returns, it means the - system does not support the feature. + If this function returns, it means that the system does not support S3 feature. **/ VOID EFIAPI diff --git a/MdeModulePkg/Include/Protocol/GenericMemoryTest.h b/MdeModulePkg/Include/Protocol/GenericMemoryTest.h index 1abaf88fda..ad628a0e5d 100644 --- a/MdeModulePkg/Include/Protocol/GenericMemoryTest.h +++ b/MdeModulePkg/Include/Protocol/GenericMemoryTest.h @@ -1,7 +1,7 @@ /** @file This protocol defines the generic memory test interfaces in Dxe phase. -Copyright (c) 2006 - 2008, Intel Corporation.
+Copyright (c) 2006 - 2009, 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 @@ -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 diff --git a/MdeModulePkg/Include/Protocol/Print2.h b/MdeModulePkg/Include/Protocol/Print2.h index de590e89aa..848b2b14df 100644 --- a/MdeModulePkg/Include/Protocol/Print2.h +++ b/MdeModulePkg/Include/Protocol/Print2.h @@ -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 diff --git a/MdeModulePkg/Include/Protocol/SwapAddressRange.h b/MdeModulePkg/Include/Protocol/SwapAddressRange.h index b6898be8d0..4018ba49b6 100644 --- a/MdeModulePkg/Include/Protocol/SwapAddressRange.h +++ b/MdeModulePkg/Include/Protocol/SwapAddressRange.h @@ -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 );