tyler.durden/audk
1
0
Fork 0
mirror of https://github.com/acidanthera/audk.git synced 2025-07-21 04:34:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update some comments for MdeModulePkg Include header files.

Browse Source 
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
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 } }

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

@ -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. <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
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

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

@ -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

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

@ -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
@ -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

104
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
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().
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