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

Function headers in .h and .c files synchronized with spec

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6722 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
jji4
2008-11-25 07:38:54 +00:00
parent eb1c78dbb9
commit cf8ae2f6fe
10 changed files with 582 additions and 469 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
MdePkg/Library/UefiLib/Console.c
View File

@@ -189,8 +189,10 @@ GLOBAL_REMOVE_IF_UNREFERENCED CONST UNICODE_WIDTH_ENTRY mUnicodeWidthTable[] = {
};
/**
This function computes and returns the width of the Unicode character
specified by UnicodeChar.
Retrieves the width of a Unicode character.
This function computes and returns the width of the Unicode character specified
by UnicodeChar.
@param UnicodeChar A Unicode character.
@@ -246,11 +248,13 @@ GetGlyphWidth (
/**
Computes the display length of a Null-terminated Unicode String.
This function computes and returns the display length of
the Null-terminated Unicode string specified by String.
If String is NULL, then 0 is returned.
If any of the widths of the Unicode characters in String
can not be determined, then 0 is returned.
This function computes and returns the display length of the Null-terminated Unicode
string specified by String. If String is NULL then 0 is returned. If any of the widths
of the Unicode characters in String can not be determined, then 0 is returned. The display
width of String can be computed by summing the display widths of each Unicode character
in String. Unicode characters that are narrow glyphs have a width of 1, and Unicode
characters that are width glyphs have a width of 2.
If String is not aligned on a 16-bit boundary, then ASSERT().
@param String A pointer to a Null-terminated Unicode string.

144
MdePkg/Library/UefiLib/UefiDriverModel.c
View File

@@ -17,23 +17,25 @@
#include "UefiLibInternal.h"
/**
Initializes a driver by installing the Driver Binding Protocol onto the driver's
DriverBindingHandle.
Installs and completes the initialization of a Driver Binding Protocol instance.
Installs the Driver Binding Protocol specified by DriverBinding onto the handle
specified by DriverBindingHandle. If DriverBindingHandle is NULL, then DriverBinding
is installed onto a newly created handle. DriverBindingHandle is typically the same
as the driver's ImageHandle, but it can be different if the driver produces multiple
Driver Binding Protocols.
If DriverBinding is NULL, then ASSERT().
If DriverBinding can not be installed onto a handle, then ASSERT().
This is typically the same as the driver's ImageHandle, but
it can be different if the driver produces multiple DriverBinding Protocols.
If the Driver Binding Protocol interface is NULL, then ASSERT ().
If the installation fails, then ASSERT ().
@param ImageHandle The image handle of the driver.
@param SystemTable The EFI System Table that was passed to the driver's entry point.
@param DriverBinding A Driver Binding Protocol instance that this driver is producing.
@param DriverBindingHandle The handle that DriverBinding is to be installed onto. If this
parameter is NULL, then a new handle is created.
@param ImageHandle The image handle of the driver.
@param SystemTable The EFI System Table that was passed to the driver's entry point.
@param DriverBinding A Driver Binding Protocol instance that this driver is producing.
@param DriverBindingHandle The handle that DriverBinding is to be installed onto. If this
parameter is NULL, then a new handle is created.
@retval EFI_SUCCESS The protocol installation is completed successfully.
@retval EFI_OUT_OF_RESOURCES There was not enough system resources to install the protocol.
@retval Others Status from gBS->InstallMultipleProtocolInterfaces().
@retval EFI_SUCCESS The protocol installation is completed successfully.
@retval EFI_OUT_OF_RESOURCES There was not enough system resources to install the protocol.
@retval Others Status from gBS->InstallMultipleProtocolInterfaces().
**/
EFI_STATUS
@@ -70,25 +72,29 @@ EfiLibInstallDriverBinding (
/**
Initializes a driver by installing the Driver Binding Protocol together with the optional Component Name,
Driver Configure and Driver Diagnostic Protocols onto the driver's DriverBindingHandle.
Installs and completes the initialization of a Driver Binding Protocol instance and
optionally installs the Component Name, Driver Configuration and Driver Diagnostics Protocols.
This is typically the same as the driver's ImageHandle, but it can be different if the driver produces multiple
DriverBinding Protocols.
If the Driver Binding Protocol interface is NULL, then ASSERT ().
If the installation fails, then ASSERT ().
Initializes a driver by installing the Driver Binding Protocol together with the
optional Component Name, optional Driver Configure and optional Driver Diagnostic
Protocols onto the driver's DriverBindingHandle. If DriverBindingHandle is NULL,
then the protocols are installed onto a newly created handle. DriverBindingHandle
is typically the same as the driver's ImageHandle, but it can be different if the
driver produces multiple Driver Binding Protocols.
If DriverBinding is NULL, then ASSERT().
If the installation fails, then ASSERT().
@param ImageHandle The image handle of the driver.
@param SystemTable The EFI System Table that was passed to the driver's entry point.
@param DriverBinding A Driver Binding Protocol instance that this driver is producing.
@param DriverBindingHandle The handle that DriverBinding is to be installed onto. If this
parameter is NULL, then a new handle is created.
@param ComponentName A Component Name Protocol instance that this driver is producing.
@param DriverConfiguration A Driver Configuration Protocol instance that this driver is producing.
@param DriverDiagnostics A Driver Diagnostics Protocol instance that this driver is producing.
@param ImageHandle The image handle of the driver.
@param SystemTable The EFI System Table that was passed to the driver's entry point.
@param DriverBinding A Driver Binding Protocol instance that this driver is producing.
@param DriverBindingHandle The handle that DriverBinding is to be installed onto. If this
parameter is NULL, then a new handle is created.
@param ComponentName A Component Name Protocol instance that this driver is producing.
@param DriverConfiguration A Driver Configuration Protocol instance that this driver is producing.
@param DriverDiagnostics A Driver Diagnostics Protocol instance that this driver is producing.
@retval EFI_SUCCESS The protocol installation is completed successfully.
@retval Others Status from gBS->InstallMultipleProtocolInterfaces().
@retval EFI_SUCCESS The protocol installation is completed successfully.
@retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.
**/
EFI_STATUS
@@ -198,22 +204,26 @@ EfiLibInstallAllDriverProtocols (
/**
Intialize a driver by installing the Driver Binding Protocol together with the optional Component Name,
Component Name 2 onto the driver's DriverBindingHandle. This is typically the same as the driver's
ImageHandle, but it can be different if the driver produces multiple DriverBinding Protocols.
If the Drvier Binding Protocol interface is NULL, then ASSERT ().
If the installation fails, then ASSERT ().
Installs Driver Binding Protocol with optional Component Name and Component Name 2 Protocols.
@param ImageHandle The image handle of the driver.
@param SystemTable The EFI System Table that was passed to the driver's entry point.
@param DriverBinding A Driver Binding Protocol instance that this driver is producing.
@param DriverBindingHandle The handle that DriverBinding is to be installe onto. If this
parameter is NULL, then a new handle is created.
@param ComponentName A Component Name Protocol instance that this driver is producing.
@param ComponentName2 A Component Name 2 Protocol instance that this driver is producing.
Initializes a driver by installing the Driver Binding Protocol together with the
optional Component Name and optional Component Name 2 protocols onto the driver's
DriverBindingHandle. If DriverBindingHandle is NULL, then the protocols are installed
onto a newly created handle. DriverBindingHandle is typically the same as the driver's
ImageHandle, but it can be different if the driver produces multiple Driver Binding Protocols.
If DriverBinding is NULL, then ASSERT().
If the installation fails, then ASSERT().
@retval EFI_SUCCESS The protocol installation is completed successfully.
@retval Others Status from gBS->InstallMultipleProtocolInterfaces().
@param ImageHandle The image handle of the driver.
@param SystemTable The EFI System Table that was passed to the driver's entry point.
@param DriverBinding A Driver Binding Protocol instance that this driver is producing.
@param DriverBindingHandle The handle that DriverBinding is to be installed onto. If this
parameter is NULL, then a new handle is created.
@param ComponentName A Component Name Protocol instance that this driver is producing.
@param ComponentName2 A Component Name 2 Protocol instance that this driver is producing.
@retval EFI_SUCCESS The protocol installation is completed successfully.
@retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.
**/
EFI_STATUS
@@ -281,29 +291,31 @@ EfiLibInstallDriverBindingComponentName2 (
/**
Intialize a driver by installing the Driver Binding Protocol together with the optional Component Name,
Component Name 2, Driver Configure, Driver Diagnostic and Driver Diagnostic 2 Protocols onto the driver's
DriverBindingHandle.
Installs Driver Binding Protocol with optional Component Name, Component Name 2, Driver
Configuration, Driver Configuration 2, Driver Diagnostics, and Driver Diagnostics 2 Protocols.
This is typically the same as the driver's ImageHandle, but it can be different if
the driver produces multiple DriverBinding Protocols.
If the Drvier Binding Protocol interface is NULL, then ASSERT ().
If the installation fails, then ASSERT ().
Initializes a driver by installing the Driver Binding Protocol together with the optional
Component Name, optional Component Name 2, optional Driver Configuration, optional Driver
Configuration 2, optional Driver Diagnostic, and optional Driver Diagnostic 2 Protocols
onto the driver's DriverBindingHandle. DriverBindingHandle is typically the same as the
driver's ImageHandle, but it can be different if the driver produces multiple Driver Binding Protocols.
If DriverBinding is NULL, then ASSERT().
If the installation fails, then ASSERT().
@param ImageHandle The image handle of the driver.
@param SystemTable The EFI System Table that was passed to the driver's entry point.
@param DriverBinding A Driver Binding Protocol instance that this driver is producing.
@param DriverBindingHandle The handle that DriverBinding is to be installe onto. If this
parameter is NULL, then a new handle is created.
@param ComponentName A Component Name Protocol instance that this driver is producing.
@param ComponentName2 A Component Name 2 Protocol instance that this driver is producing.
@param DriverConfiguration A Driver Configuration Protocol instance that this driver is producing.
@param DriverConfiguration2 A Driver Configuration Protocol 2 instance that this driver is producing.
@param DriverDiagnostics A Driver Diagnostics Protocol instance that this driver is producing.
@param DriverDiagnostics2 A Driver Diagnostics Protocol 2 instance that this driver is producing.
@param ImageHandle The image handle of the driver.
@param SystemTable The EFI System Table that was passed to the driver's entry point.
@param DriverBinding A Driver Binding Protocol instance that this driver is producing.
@param DriverBindingHandle The handle that DriverBinding is to be installe onto. If this
parameter is NULL, then a new handle is created.
@param ComponentName A Component Name Protocol instance that this driver is producing.
@param ComponentName2 A Component Name 2 Protocol instance that this driver is producing.
@param DriverConfiguration A Driver Configuration Protocol instance that this driver is producing.
@param DriverConfiguration2 A Driver Configuration Protocol 2 instance that this driver is producing.
@param DriverDiagnostics A Driver Diagnostics Protocol instance that this driver is producing.
@param DriverDiagnostics2 A Driver Diagnostics Protocol 2 instance that this driver is producing.
@retval EFI_SUCCESS The protocol installation is completed successfully.
@retval Others Status from gBS->InstallMultipleProtocolInterfaces().
@retval EFI_SUCCESS The protocol installation is completed successfully.
@retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.
**/
EFI_STATUS

182
MdePkg/Library/UefiLib/UefiLib.c
View File

@@ -280,18 +280,16 @@ EfiNamedEventSignal (
return Status;
}
/**
/**
Returns the current TPL.
This function returns the current TPL. There is no EFI service to directly
retrieve the current TPL. Instead, the RaiseTPL() function is used to raise
the TPL to TPL_HIGH_LEVEL. This will return the current TPL. The TPL level
can then immediately be restored back to the current TPL level with a call
This function returns the current TPL. There is no EFI service to directly
retrieve the current TPL. Instead, the RaiseTPL() function is used to raise
the TPL to TPL_HIGH_LEVEL. This will return the current TPL. The TPL level
can then immediately be restored back to the current TPL level with a call
to RestoreTPL().
@param VOID
@retval EFI_TPL The current TPL.
@return The current TPL.
**/
EFI_TPL
@@ -368,11 +366,12 @@ EfiAcquireLock (
}
/**
Acquires ownership of a lock. If the lock is already owned , then an error is returned.
Acquires ownership of a lock.
This function raises the system's current task priority level to the task
priority level of the mutual exclusion lock. Then, it attempts to place the
lock in the acquired state.
This function raises the system's current task priority level to the task priority
level of the mutual exclusion lock. Then, it attempts to place the lock in the acquired state.
If the lock is already in the acquired state, then EFI_ACCESS_DENIED is returned.
Otherwise, EFI_SUCCESS is returned.
If Lock is NULL, then ASSERT().
If Lock is not initialized, then ASSERT().
@@ -444,7 +443,7 @@ EfiReleaseLock (
currently managing the controller specified by ControllerHandle. This test
is performed by evaluating if the the protocol specified by ProtocolGuid is
present on ControllerHandle and is was opened by DriverBindingHandle with an
attribute of EFI_OPEN_PROTOCOL_BY_DRIVER.
attribute of EFI_OPEN_PROTOCOL_BY_DRIVER.
If ProtocolGuid is NULL, then ASSERT().
@param ControllerHandle A handle for a controller to test.
@@ -507,10 +506,10 @@ EfiTestManagedDevice (
ChildHandle with an attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.
If ProtocolGuid is NULL, then ASSERT().
@param ControllerHandle A handle for a (parent) controller to test.
@param ControllerHandle A handle for a (parent) controller to test.
@param ChildHandle A child handle to test.
@param ProtocolGuid Supplies the protocol that the child controller
opens on its parent controller.
opens on its parent controller.
@retval EFI_SUCCESS ChildHandle is a child of the ControllerHandle.
@retval EFI_UNSUPPORTED ChildHandle is not a child of the
@@ -565,7 +564,7 @@ EfiTestChildHandle (
/**
This function looks up a Unicode string in UnicodeStringTable.
If Language is a member of SupportedLanguages and a Unicode string is found in
If Language is a member of SupportedLanguages and a Unicode string is found in
UnicodeStringTable that matches the language code specified by Language, then it
is returned in UnicodeString.
@@ -651,48 +650,42 @@ LookupUnicodeString (
/**
This function looks up a Unicode string in UnicodeStringTable.
If Language is a member of SupportedLanguages and a Unicode
string is found in UnicodeStringTable that matches the
language code specified by Language, then it is returned in
UnicodeString.
@param Language A pointer to the ISO 639-2 or
RFC 3066 language code for the
Unicode string to look up and
return.
@param SupportedLanguages A pointer to the set of ISO
639-2 or RFC 3066 language
codes that the Unicode string
table supports. Language must
be a member of this set.
@param UnicodeStringTable A pointer to the table of
Unicode strings.
@param UnicodeString A pointer to the Unicode
string from UnicodeStringTable
that matches the language
specified by Language.
@param Iso639Language Specify the language code
format supported. If true,
then the format follow ISO
639-2. If false, then it
follows RFC3066.
@retval EFI_SUCCESS The Unicode string that
matches the language specified
by Language was found in the
table of Unicoide strings
UnicodeStringTable, and it was
returned in UnicodeString.
If Language is a member of SupportedLanguages and a Unicode string is found in
UnicodeStringTable that matches the language code specified by Language, then
it is returned in UnicodeString.
@param Language A pointer to an ASCII string containing the ISO 639-2 or the
RFC 4646 language code for the Unicode string to look up and
return. If Iso639Language is TRUE, then this ASCII string is
not assumed to be Null-terminated, and only the first three
chacters are used. If Iso639Language is FALSE, then this ASCII
string must be Null-terminated.
@param SupportedLanguages A pointer to a Null-terminated ASCII string that contains a
set of ISO 639-2 or RFC 4646 language codes that the Unicode
string table supports. Language must be a member of this set.
If Iso639Language is TRUE, then this string contains one or more
ISO 639-2 language codes with no separator characters. If Iso639Language
is FALSE, then is string contains one or more RFC 4646 language
codes separated by ';'.
@param UnicodeStringTable A pointer to the table of Unicode strings. Type EFI_UNICODE_STRING_TABLE
is defined in "Related Definitions".
@param UnicodeString A pointer to the Null-terminated Unicode string from UnicodeStringTable
that matches the language specified by Language.
@param Iso639Language Specifies the supported language code format. If it is TRUE, then
Language and SupportedLanguages follow ISO 639-2 language code format.
Otherwise, they follow RFC 4646 language code format.
@retval EFI_SUCCESS The Unicode string that matches the language specified by Language
was found in the table of Unicode strings UnicodeStringTable, and
it was returned in UnicodeString.
@retval EFI_INVALID_PARAMETER Language is NULL.
@retval EFI_INVALID_PARAMETER UnicodeString is NULL.
@retval EFI_UNSUPPORTED SupportedLanguages is NULL.
@retval EFI_UNSUPPORTED UnicodeStringTable is NULL.
@retval EFI_UNSUPPORTED The language specified by
Language is not a member
ofSupportedLanguages.
@retval EFI_UNSUPPORTED The language specified by
Language is not supported by
UnicodeStringTable.
@retval EFI_UNSUPPORTED UnicodeStringTable is NULL.
@retval EFI_UNSUPPORTED The language specified by Language is not a member of SupportedLanguages.
@retval EFI_UNSUPPORTED The language specified by Language is not supported by UnicodeStringTable.
**/
EFI_STATUS
@@ -944,52 +937,45 @@ AddUnicodeString (
/**
This function adds a Unicode string to UnicodeStringTable.
This function adds the Null-terminated Unicode string specified by UnicodeString
to UnicodeStringTable.
If Language is a member of SupportedLanguages then
UnicodeString is added to UnicodeStringTable. New buffers are
allocated for both Language and UnicodeString. The contents
of Language and UnicodeString are copied into these new
buffers. These buffers are automatically freed when
FreeUnicodeStringTable() is called.
If Language is a member of SupportedLanguages then UnicodeString is added to
UnicodeStringTable. New buffers are allocated for both Language and UnicodeString.
The contents of Language and UnicodeString are copied into these new buffers.
These buffers are automatically freed when EfiLibFreeUnicodeStringTable() is called.
@param Language A pointer to the ISO 639-2 or
RFC 3066 language code for the
Unicode string to add.
@param SupportedLanguages A pointer to the set of ISO
639-2 or RFC 3066 language
codes that the Unicode string
table supports. Language must
be a member of this set.
@param UnicodeStringTable A pointer to the table of
Unicode strings.
@param UnicodeString A pointer to the Unicode
string to add.
@param Iso639Language Specify the language code
format supported. If true,
then the format follow ISO
639-2. If false, then it
follows RFC3066.
@retval EFI_SUCCESS The Unicode string that
matches the language specified
by Language was found in the
table of Unicode strings
UnicodeStringTable, and it was
returned in UnicodeString.
@retval EFI_INVALID_PARAMETER Language is NULL.
@retval EFI_INVALID_PARAMETER UnicodeString is NULL.
@retval EFI_INVALID_PARAMETER UnicodeString is an empty string.
@retval EFI_UNSUPPORTED SupportedLanguages is NULL.
@retval EFI_ALREADY_STARTED A Unicode string with language
Language is already present in
UnicodeStringTable.
@retval EFI_OUT_OF_RESOURCES There is not enough memory to
add another Unicode string to
UnicodeStringTable.
@retval EFI_UNSUPPORTED The language specified by
Language is not a member of
SupportedLanguages.
@param Language A pointer to an ASCII string containing the ISO 639-2 or
the RFC 4646 language code for the Unicode string to add.
If Iso639Language is TRUE, then this ASCII string is not
assumed to be Null-terminated, and only the first three
chacters are used. If Iso639Language is FALSE, then this
ASCII string must be Null-terminated.
@param SupportedLanguages A pointer to a Null-terminated ASCII string that contains
a set of ISO 639-2 or RFC 4646 language codes that the Unicode
string table supports. Language must be a member of this set.
If Iso639Language is TRUE, then this string contains one or more
ISO 639-2 language codes with no separator characters.
If Iso639Language is FALSE, then is string contains one or more
RFC 4646 language codes separated by ';'.
@param UnicodeStringTable A pointer to the table of Unicode strings. Type EFI_UNICODE_STRING_TABLE
is defined in "Related Definitions".
@param UnicodeString A pointer to the Unicode string to add.
@param Iso639Language Specifies the supported language code format. If it is TRUE,
then Language and SupportedLanguages follow ISO 639-2 language code format.
Otherwise, they follow RFC 4646 language code format.
@retval EFI_SUCCESS The Unicode string that matches the language specified by
Language was found in the table of Unicode strings UnicodeStringTable,
and it was returned in UnicodeString.
@retval EFI_INVALID_PARAMETER Language is NULL.
@retval EFI_INVALID_PARAMETER UnicodeString is NULL.
@retval EFI_INVALID_PARAMETER UnicodeString is an empty string.
@retval EFI_UNSUPPORTED SupportedLanguages is NULL.
@retval EFI_ALREADY_STARTED A Unicode string with language Language is already present in
UnicodeStringTable.
@retval EFI_OUT_OF_RESOURCES There is not enough memory to add another Unicode string UnicodeStringTable.
@retval EFI_UNSUPPORTED The language specified by Language is not a member of SupportedLanguages.
**/
EFI_STATUS

67
MdePkg/Library/UefiLib/UefiLibPrint.c
View File

@@ -85,14 +85,14 @@ InternalPrint (
return Return;
}
/**
Prints a formatted Unicode string to the console output device specified by
/**
Prints a formatted Unicode string to the console output device specified by
ConOut defined in the EFI_SYSTEM_TABLE.
This function prints a formatted Unicode string to the console output device
specified by ConOut in EFI_SYSTEM_TABLE and returns the number of Unicode
characters that printed to ConOut. If the length of the formatted Unicode
string is greater than PcdUefiLibMaxPrintBufferSize, then only the first
This function prints a formatted Unicode string to the console output device
specified by ConOut in EFI_SYSTEM_TABLE and returns the number of Unicode
characters that printed to ConOut. If the length of the formatted Unicode
string is greater than PcdUefiLibMaxPrintBufferSize, then only the first
PcdUefiLibMaxPrintBufferSize characters are sent to ConOut.
If Format is NULL, then ASSERT().
If Format is not aligned on a 16-bit boundary, then ASSERT().
@@ -101,8 +101,7 @@ InternalPrint (
@param ... Variable argument list whose contents are accessed based
on the format string specified by Format.
@return The number of Unicode characters in the produced
output buffer not including the Null-terminator.
@return Number of Unicode characters printed to ConOut.
**/
UINTN
@@ -124,14 +123,14 @@ Print (
return Return;
}
/**
Prints a formatted Unicode string to the console output device specified by
/**
Prints a formatted Unicode string to the console output device specified by
StdErr defined in the EFI_SYSTEM_TABLE.
This function prints a formatted Unicode string to the console output device
specified by StdErr in EFI_SYSTEM_TABLE and returns the number of Unicode
characters that printed to StdErr. If the length of the formatted Unicode
string is greater than PcdUefiLibMaxPrintBufferSize, then only the first
This function prints a formatted Unicode string to the console output device
specified by StdErr in EFI_SYSTEM_TABLE and returns the number of Unicode
characters that printed to StdErr. If the length of the formatted Unicode
string is greater than PcdUefiLibMaxPrintBufferSize, then only the first
PcdUefiLibMaxPrintBufferSize characters are sent to StdErr.
If Format is NULL, then ASSERT().
If Format is not aligned on a 16-bit boundary, then ASSERT().
@@ -139,9 +138,9 @@ Print (
@param Format Null-terminated Unicode format string.
@param ... Variable argument list whose contents are accessed based
on the format string specified by Format.
@return Number of Unicode characters printed to StdErr.
@return The number of Unicode characters in the produced
output buffer not including the Null-terminator.
**/
UINTN
EFIAPI
@@ -214,14 +213,14 @@ AsciiInternalPrint (
return Return;
}
/**
Prints a formatted ASCII string to the console output device specified by
/**
Prints a formatted ASCII string to the console output device specified by
ConOut defined in the EFI_SYSTEM_TABLE.
This function prints a formatted ASCII string to the console output device
specified by ConOut in EFI_SYSTEM_TABLE and returns the number of ASCII
characters that printed to ConOut. If the length of the formatted ASCII
string is greater than PcdUefiLibMaxPrintBufferSize, then only the first
This function prints a formatted ASCII string to the console output device
specified by ConOut in EFI_SYSTEM_TABLE and returns the number of ASCII
characters that printed to ConOut. If the length of the formatted ASCII
string is greater than PcdUefiLibMaxPrintBufferSize, then only the first
PcdUefiLibMaxPrintBufferSize characters are sent to ConOut.
If Format is NULL, then ASSERT().
@@ -229,8 +228,7 @@ AsciiInternalPrint (
@param ... Variable argument list whose contents are accessed based
on the format string specified by Format.
@return The number of Ascii characters in the produced
output buffer not including the Null-terminator.
@return Number of ASCII characters printed to ConOut.
**/
UINTN
@@ -253,14 +251,14 @@ AsciiPrint (
return Return;
}
/**
Prints a formatted ASCII string to the console output device specified by
/**
Prints a formatted ASCII string to the console output device specified by
StdErr defined in the EFI_SYSTEM_TABLE.
This function prints a formatted ASCII string to the console output device
specified by StdErr in EFI_SYSTEM_TABLE and returns the number of ASCII
characters that printed to StdErr. If the length of the formatted ASCII
string is greater than PcdUefiLibMaxPrintBufferSize, then only the first
This function prints a formatted ASCII string to the console output device
specified by StdErr in EFI_SYSTEM_TABLE and returns the number of ASCII
characters that printed to StdErr. If the length of the formatted ASCII
string is greater than PcdUefiLibMaxPrintBufferSize, then only the first
PcdUefiLibMaxPrintBufferSize characters are sent to StdErr.
If Format is NULL, then ASSERT().
@@ -268,8 +266,7 @@ AsciiPrint (
@param ... Variable argument list whose contents are accessed based
on the format string specified by Format.
@return The number of Ascii characters in the produced output
buffer not including the Null-terminator.
@return Number of ASCII characters printed to ConErr.
**/
UINTN
@@ -567,7 +564,7 @@ Error:
@param ... Variable argument list whose contents are accessed based on
the format string specified by Format.
@return The number of characters printed.
@return The number of Unicode characters printed.
**/
UINTN
@@ -612,7 +609,7 @@ PrintXY (
This function prints a formatted ASCII string to the graphics console device
specified by ConsoleOutputHandle in EFI_SYSTEM_TABLE and returns the number of
Unicode characters printed. If the length of the formatted ASCII string is
ASCII characters printed. If the length of the formatted ASCII string is
greater than PcdUefiLibMaxPrintBufferSize, then only the first
PcdUefiLibMaxPrintBufferSize characters are printed. The EFI_HII_FONT_PROTOCOL
is used to convert the string to a bitmap using the glyphs registered with the
@@ -640,7 +637,7 @@ PrintXY (
@param ... Variable argument list whose contents are accessed based on
the format string specified by Format.
@return The number of characters printed.
@return The number of ASCII characters printed.
**/
UINTN

42
MdePkg/Library/UefiLib/UefiNotTiano.c
View File

@@ -43,16 +43,16 @@ InternalEmptyFuntion (
}
/**
Creates an EFI event in the Legacy Boot Event Group. Prior to UEFI 2.0 this
was done via a non blessed UEFI extensions and this library abstracts the
implementation mechanism of this event from the caller.
This function abstracts the creation of the Legacy Boot Event. The Framework
moved from a proprietary to UEFI 2.0 based mechanism. This library abstracts
the caller from how this event is created to prevent to code form having to
change with the version of the specification supported.
Creates an EFI event in the Legacy Boot Event Group.
Prior to UEFI 2.0 this was done via a non blessed UEFI extensions and this library
abstracts the implementation mechanism of this event from the caller. This function
abstracts the creation of the Legacy Boot Event. The Framework moved from a proprietary
to UEFI 2.0 based mechanism. This library abstracts the caller from how this event
is created to prevent to code form having to change with the version of the
specification supported.
If LegacyBootEvent is NULL, then ASSERT().
@param LegacyBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).
@retval EFI_SUCCESS Event was created.
@@ -75,8 +75,8 @@ EfiCreateEventLegacyBoot (
/**
Create an EFI event in the Legacy Boot Event Group and allows
the caller to specify a notification function.
the caller to specify a notification function.
This function abstracts the creation of the Legacy Boot Event.
The Framework moved from a proprietary to UEFI 2.0 based mechanism.
This library abstracts the caller from how this event is created to prevent
@@ -128,17 +128,17 @@ EfiCreateEventLegacyBootEx (
}
/**
Create an EFI event in the Ready To Boot Event Group. Prior to UEFI 2.0 this
was done via a non-standard UEFI extension, and this library abstracts the
implementation mechanism of this event from the caller.
Create an EFI event in the Ready To Boot Event Group.
Prior to UEFI 2.0 this was done via a non-standard UEFI extension, and this library
abstracts the implementation mechanism of this event from the caller.
This function abstracts the creation of the Ready to Boot Event. The Framework
moved from a proprietary to UEFI 2.0-based mechanism. This library abstracts
the caller from how this event is created to prevent the code form having to
change with the version of the specification supported.
If ReadyToBootEvent is NULL, then ASSERT().
@param ReadyToBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).
@param ReadyToBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).
@retval EFI_SUCCESS Event was created.
@retval Other Event was not created.
@@ -160,8 +160,8 @@ EfiCreateEventReadyToBoot (
/**
Create an EFI event in the Ready To Boot Event Group and allows
the caller to specify a notification function.
the caller to specify a notification function.
This function abstracts the creation of the Ready to Boot Event.
The Framework moved from a proprietary to UEFI 2.0 based mechanism.
This library abstracts the caller from how this event is created to prevent
@@ -217,9 +217,9 @@ EfiCreateEventReadyToBootEx (
Create, Signal, and Close the Ready to Boot event using EfiSignalEventReadyToBoot().
This function abstracts the signaling of the Ready to Boot Event. The Framework moved
from a proprietary to UEFI 2.0 based mechanism. This library abstracts the caller from
how this event is created to prevent to code form having to change with the version of
the specification supported.
from a proprietary to UEFI 2.0 based mechanism. This library abstracts the caller
from how this event is created to prevent to code form having to change with the
version of the specification supported.
**/
VOID