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

Code and comments have been checked with spec.

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6650 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
jji4 2008-11-20 08:55:42 +00:00
parent 404c79588e
commit 1d37ab9fb9
7 changed files with 429 additions and 312 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

206
MdePkg/Include/Library/UefiLib.h
View File

@ -99,10 +99,15 @@ typedef struct {
/** /**
This function searches the list of configuration tables stored in the EFI System Retrieves a pointer to the system configuration table from the EFI System Table
Table for a table with a GUID that matches TableGuid. If a match is found, based on a specified GUID.
then a pointer to the configuration table is returned in Table, and EFI_SUCCESS
is returned. If a matching GUID is not found, then EFI_NOT_FOUND is returned. This function searches the list of configuration tables stored in the EFI System Table
for a table with a GUID that matches TableGuid. If a match is found, then a pointer to
the configuration table is returned in Table., and EFI_SUCCESS is returned. If a matching GUID
is not found, then EFI_NOT_FOUND is returned.
If TableGuid is NULL, then ASSERT().
If Table is NULL, then ASSERT().
@param TableGuid Pointer to table's GUID type.. @param TableGuid Pointer to table's GUID type..
@param Table Pointer to the table associated with TableGuid in the EFI System Table. @param Table Pointer to the table associated with TableGuid in the EFI System Table.
@ -119,18 +124,28 @@ EfiGetSystemConfigurationTable (
); );
/** /**
This function causes the notification function to be executed for every protocol Creates and returns a notification event and registers that event with all the protocol
of type ProtocolGuid instance that exists in the system when this function is instances specified by ProtocolGuid.
invoked. In addition, every time a protocol of type ProtocolGuid instance is
installed or reinstalled, the notification function is also executed. This function causes the notification function to be executed for every protocol of type
ProtocolGuid instance that exists in the system when this function is invoked.
In addition, every time a protocol of type ProtocolGuid instance is installed or reinstalled,
the notification function is also executed. This function returns the notification event
that was created.
If ProtocolGuid is NULL, then ASSERT().
If NotifyTpl is not a legal TPL value, then ASSERT().
If NotifyFunction is NULL, then ASSERT().
If Registration is NULL, then ASSERT().
@param ProtocolGuid Supplies GUID of the protocol upon whose installation the event is fired. @param ProtocolGuid Supplies GUID of the protocol upon whose installation the event is fired.
@param NotifyTpl Supplies the task priority level of the event notifications. @param NotifyTpl Supplies the task priority level of the event notifications.
@param NotifyFunction Supplies the function to notify when the event is signaled. @param NotifyFunction Supplies the function to notify when the event is signaled.
@param NotifyContext The context parameter to pass to NotifyFunction. @param NotifyContext The context parameter to pass to NotifyFunction.
@param Registration A pointer to a memory location to receive the registration value. @param Registration A pointer to a memory location to receive the registration value.
This value is passed to LocateHandle() to obtain new handles that
have been added that support the ProtocolGuid-specified protocol.
@return The notification event that was created. @return The notification event that was created.
**/ **/
EFI_EVENT EFI_EVENT
@ -144,9 +159,14 @@ EfiCreateProtocolNotifyEvent(
); );
/** /**
Creates a named event that can be signaled with EfiNamedEventSignal().
This function creates an event using NotifyTpl, NoifyFunction, and NotifyContext. This function creates an event using NotifyTpl, NoifyFunction, and NotifyContext.
This event is signaled with EfiNamedEventSignal(). This provide the ability for This event is signaled with EfiNamedEventSignal(). This provides the ability for one or more
one or more listeners on the same event named by the GUID specified by Name. listeners on the same event named by the GUID specified by Name.
If Name is NULL, then ASSERT().
If NotifyTpl is not a legal TPL value, then ASSERT().
If NotifyFunction is NULL, then ASSERT().
@param Name Supplies GUID name of the event. @param Name Supplies GUID name of the event.
@param NotifyTpl Supplies the task priority level of the event notifications. @param NotifyTpl Supplies the task priority level of the event notifications.
@ -169,8 +189,11 @@ EfiNamedEventListen (
); );
/** /**
This function signals the named event specified by Name. The named event must Signals a named event created with EfiNamedEventListen().
have been created with EfiNamedEventListen().
This function signals the named event specified by Name. The named event must have been
created with EfiNamedEventListen().
If Name is NULL, then ASSERT().
@param Name Supplies GUID name of the event. @param Name Supplies GUID name of the event.
@ -203,10 +226,14 @@ EfiGetCurrentTpl (
); );
/** /**
Initializes a basic mutual exclusion lock.
This function initializes a basic mutual exclusion lock to the released state This function initializes a basic mutual exclusion lock to the released state
and returns the lock. Each lock provides mutual exclusion access at its task and returns the lock. Each lock provides mutual exclusion access at its task
priority level. Since there is no preemption or multiprocessor support in EFI, priority level. Since there is no preemption or multiprocessor support in EFI,
acquiring the lock only consists of raising to the locks TPL. acquiring the lock only consists of raising to the locks TPL.
If Lock is NULL, then ASSERT().
If Priority is not a valid TPL value, then ASSERT().
@param Lock A pointer to the lock data structure to initialize. @param Lock A pointer to the lock data structure to initialize.
@param Priority EFI TPL associated with the lock. @param Priority EFI TPL associated with the lock.
@ -244,7 +271,6 @@ EfiInitializeLock (
then this macro evaluates the EFI_LOCK structure specified by Lock. If Lock then this macro evaluates the EFI_LOCK structure specified by Lock. If Lock
is not in the locked state, then DebugAssert() is called passing in the source is not in the locked state, then DebugAssert() is called passing in the source
filename, source line number, and Lock. filename, source line number, and Lock.
If Lock is NULL, then ASSERT(). If Lock is NULL, then ASSERT().
@param LockParameter A pointer to the lock to acquire. @param LockParameter A pointer to the lock to acquire.
@ -262,9 +288,14 @@ EfiInitializeLock (
/** /**
Acquires ownership of a lock.
This function raises the system's current task priority level to the task This function raises the system's current task priority level to the task
priority level of the mutual exclusion lock. Then, it places the lock in the priority level of the mutual exclusion lock. Then, it places the lock in the
acquired state. acquired state.
If Lock is NULL, then ASSERT().
If Lock is not initialized, then ASSERT().
If Lock is already in the acquired state, then ASSERT().
@param Lock A pointer to the lock to acquire. @param Lock A pointer to the lock to acquire.
@ -276,9 +307,13 @@ EfiAcquireLock (
); );
/** /**
Acquires ownership of a lock. If the lock is already owned , then an error is returned.
This function raises the system's current task priority level to the task 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 priority level of the mutual exclusion lock. Then, it attempts to place the
lock in the acquired state. lock in the acquired state.
If Lock is NULL, then ASSERT().
If Lock is not initialized, then ASSERT().
@param Lock A pointer to the lock to acquire. @param Lock A pointer to the lock to acquire.
@ -293,9 +328,14 @@ EfiAcquireLockOrFail (
); );
/** /**
Releases ownership of a lock.
This function transitions a mutual exclusion lock from the acquired state to This function transitions a mutual exclusion lock from the acquired state to
the released state, and restores the system's task priority level to its the released state, and restores the system's task priority level to its
previous level. previous level.
If Lock is NULL, then ASSERT().
If Lock is not initialized, then ASSERT().
If Lock is already in the released state, then ASSERT().
@param Lock A pointer to the lock to release. @param Lock A pointer to the lock to release.
@ -365,10 +405,11 @@ EfiTestChildHandle (
); );
/** /**
This function looks up a Unicode string in UnicodeStringTable. If Language is This function looks up a Unicode string in UnicodeStringTable.
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 If Language is a member of SupportedLanguages and a Unicode string is found in
UnicodeString. UnicodeStringTable that matches the language code specified by Language, then it
is returned in UnicodeString.
@param Language A pointer to the ISO 639-2 language code for the @param Language A pointer to the ISO 639-2 language code for the
Unicode string to look up and return. Unicode string to look up and return.
@ -412,48 +453,38 @@ LookupUnicodeString (
@param Language A pointer to the ISO 639-2 or @param Language A pointer to the ISO 639-2 or
RFC 3066 language code for the RFC 3066 language code for the
Unicode string to look up and Unicode string to look up and
return. return.
@param SupportedLanguages A pointer to the set of ISO @param SupportedLanguages A pointer to the set of ISO
639-2 or RFC 3066 language 639-2 or RFC 3066 language
codes that the Unicode string codes that the Unicode string
table supports. Language must table supports. Language must
be a member of this set. be a member of this set.
@param UnicodeStringTable A pointer to the table of @param UnicodeStringTable A pointer to the table of
Unicode strings. Unicode strings.
@param UnicodeString A pointer to the Unicode @param UnicodeString A pointer to the Unicode
string from UnicodeStringTable string from UnicodeStringTable
that matches the language that matches the language
specified by Language. specified by Language.
@param Iso639Language Specify the language code @param Iso639Language Specify the language code
format supported. If true, format supported. If true,
then the format follow ISO then the format follow ISO
639-2. If false, then it 639-2. If false, then it
follows RFC3066. follows RFC3066.
@retval EFI_SUCCESS The Unicode string that @retval EFI_SUCCESS The Unicode string that
matches the language specified matches the language specified
by Language was found in the by Language was found in the
table of Unicoide strings table of Unicoide strings
UnicodeStringTable, and it was UnicodeStringTable, and it was
returned in UnicodeString. returned in UnicodeString.
@retval EFI_INVALID_PARAMETER Language is NULL. @retval EFI_INVALID_PARAMETER Language is NULL.
@retval EFI_INVALID_PARAMETER UnicodeString is NULL.
@retval EFI_INVALID_PARAMETER UnicodeString is NULL. @retval EFI_UNSUPPORTED SupportedLanguages is NULL.
@retval EFI_UNSUPPORTED UnicodeStringTable is NULL.
@retval EFI_UNSUPPORTED SupportedLanguages is NULL.
@retval EFI_UNSUPPORTED UnicodeStringTable is NULL.
@retval EFI_UNSUPPORTED The language specified by @retval EFI_UNSUPPORTED The language specified by
Language is not a member Language is not a member
ofSupportedLanguages. ofSupportedLanguages.
@retval EFI_UNSUPPORTED The language specified by
@retval EFI_UNSUPPORTED The language specified by
Language is not supported by Language is not supported by
UnicodeStringTable. UnicodeStringTable.
@ -470,6 +501,7 @@ LookupUnicodeString2 (
/** /**
This function adds a Unicode string to UnicodeStringTable. This function adds a Unicode string to UnicodeStringTable.
If Language is a member of SupportedLanguages then UnicodeString is added to If Language is a member of SupportedLanguages then UnicodeString is added to
UnicodeStringTable. New buffers are allocated for both Language and UnicodeStringTable. New buffers are allocated for both Language and
UnicodeString. The contents of Language and UnicodeString are copied into UnicodeString. The contents of Language and UnicodeString are copied into
@ -510,8 +542,8 @@ AddUnicodeString (
); );
/** /**
This function adds a Unicode string to UnicodeStringTable. This function adds a Unicode string to UnicodeStringTable.
If Language is a member of SupportedLanguages then If Language is a member of SupportedLanguages then
UnicodeString is added to UnicodeStringTable. New buffers are UnicodeString is added to UnicodeStringTable. New buffers are
allocated for both Language and UnicodeString. The contents allocated for both Language and UnicodeString. The contents
@ -521,26 +553,21 @@ AddUnicodeString (
@param Language A pointer to the ISO 639-2 or @param Language A pointer to the ISO 639-2 or
RFC 3066 language code for the RFC 3066 language code for the
Unicode string to add. Unicode string to add.
@param SupportedLanguages A pointer to the set of ISO @param SupportedLanguages A pointer to the set of ISO
639-2 or RFC 3066 language 639-2 or RFC 3066 language
codes that the Unicode string codes that the Unicode string
table supports. Language must table supports. Language must
be a member of this set. be a member of this set.
@param UnicodeStringTable A pointer to the table of @param UnicodeStringTable A pointer to the table of
Unicode strings. Unicode strings.
@param UnicodeString A pointer to the Unicode @param UnicodeString A pointer to the Unicode
string to add. string to add.
@param Iso639Language Specify the language code @param Iso639Language Specify the language code
format supported. If true, format supported. If true,
then the format follow ISO then the format follow ISO
639-2. If false, then it 639-2. If false, then it
follows RFC3066. follows RFC3066.
@retval EFI_SUCCESS The Unicode string that @retval EFI_SUCCESS The Unicode string that
matches the language specified matches the language specified
by Language was found in the by Language was found in the
@ -548,22 +575,16 @@ AddUnicodeString (
UnicodeStringTable, and it was UnicodeStringTable, and it was
returned in UnicodeString. returned in UnicodeString.
@retval EFI_INVALID_PARAMETER Language is NULL. @retval EFI_INVALID_PARAMETER Language is NULL.
@retval EFI_INVALID_PARAMETER UnicodeString 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_INVALID_PARAMETER UnicodeString is an empty string.
@retval EFI_UNSUPPORTED SupportedLanguages is NULL.
@retval EFI_ALREADY_STARTED A Unicode string with language @retval EFI_ALREADY_STARTED A Unicode string with language
Language is already present in Language is already present in
UnicodeStringTable. UnicodeStringTable.
@retval EFI_OUT_OF_RESOURCES There is not enough memory to @retval EFI_OUT_OF_RESOURCES There is not enough memory to
add another Unicode string to add another Unicode string to
UnicodeStringTable. UnicodeStringTable.
@retval EFI_UNSUPPORTED The language specified by @retval EFI_UNSUPPORTED The language specified by
Language is not a member of Language is not a member of
SupportedLanguages. SupportedLanguages.
@ -581,6 +602,7 @@ AddUnicodeString2 (
/** /**
This function frees the table of Unicode strings in UnicodeStringTable. This function frees the table of Unicode strings in UnicodeStringTable.
If UnicodeStringTable is NULL, then EFI_SUCCESS is returned. If UnicodeStringTable is NULL, then EFI_SUCCESS is returned.
Otherwise, each language code, and each Unicode string in the Unicode string Otherwise, each language code, and each Unicode string in the Unicode string
table are freed, and EFI_SUCCESS is returned. table are freed, and EFI_SUCCESS is returned.
@ -614,6 +636,8 @@ GetGlyphWidth (
); );
/** /**
Computes the display length of a Null-terminated Unicode String.
This function computes and returns the display length of This function computes and returns the display length of
the Null-terminated Unicode string specified by String. the Null-terminated Unicode string specified by String.
If String is NULL, then 0 is returned. If String is NULL, then 0 is returned.
@ -635,10 +659,12 @@ UnicodeStringDisplayLength (
// Functions that abstract early Framework contamination of UEFI. // Functions that abstract early Framework contamination of UEFI.
// //
/** /**
Signal a Ready to Boot Event. Create, Signal, and Close the Ready to Boot event using EfiSignalEventReadyToBoot().
Create a Ready to Boot Event. Signal it and close it. This causes other This function abstracts the signaling of the Ready to Boot Event. The Framework moved
events of the same event group to be signaled in other modules. 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 VOID
@ -648,10 +674,12 @@ EfiSignalEventReadyToBoot (
); );
/** /**
Signal a Legacy Boot Event. Create, Signal, and Close the Ready to Boot event using EfiSignalEventLegacyBoot().
Create a legacy Boot Event. Signal it and close it. This causes other This function abstracts the signaling of the Legacy Boot Event. The Framework moved from
events of the same event group to be signaled in other modules. 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 VOID
@ -766,13 +794,11 @@ EfiCreateEventReadyToBootEx (
Initialize a Firmware Volume (FV) Media Device Path node. Initialize a Firmware Volume (FV) Media Device Path node.
The Framework FwVol Device Path changed to conform to the UEFI 2.0 specification. The Framework FwVol Device Path changed to conform to the UEFI 2.0 specification.
This library function abstracts initializing a device path node. This library function abstracts initializing a device path node.
Initialize the MEDIA_FW_VOL_FILEPATH_DEVICE_PATH data structure. This device Initialize the MEDIA_FW_VOL_FILEPATH_DEVICE_PATH data structure. This device
path changed in the DXE CIS version 0.92 in a non back ward compatible way to path changed in the DXE CIS version 0.92 in a non back ward compatible way to
not conflict with the UEFI 2.0 specification. This function abstracts the not conflict with the UEFI 2.0 specification. This function abstracts the
differences from the caller. differences from the caller.
If FvDevicePathNode is NULL, then ASSERT(). If FvDevicePathNode is NULL, then ASSERT().
If NameGuid is NULL, then ASSERT(). If NameGuid is NULL, then ASSERT().
@ -792,7 +818,6 @@ EfiInitializeFwVolDevicepathNode (
The Framework FwVol Device Path changed to conform to the UEFI 2.0 specification. The Framework FwVol Device Path changed to conform to the UEFI 2.0 specification.
This library function abstracts validating a device path node. This library function abstracts validating a device path node.
Check the MEDIA_FW_VOL_FILEPATH_DEVICE_PATH data structure to see if it's valid. Check the MEDIA_FW_VOL_FILEPATH_DEVICE_PATH data structure to see if it's valid.
If it is valid, then return the GUID file name from the device path node. Otherwise, If it is valid, then return the GUID file name from the device path node. Otherwise,
return NULL. This device path changed in the DXE CIS version 0.92 in a non back ward return NULL. This device path changed in the DXE CIS version 0.92 in a non back ward
@ -821,12 +846,12 @@ EfiGetNameGuidFromFwVolDevicePathNode (
characters that printed to ConOut. If the length of the formatted Unicode characters that printed to ConOut. If the length of the formatted Unicode
string is greater than PcdUefiLibMaxPrintBufferSize, then only the first string is greater than PcdUefiLibMaxPrintBufferSize, then only the first
PcdUefiLibMaxPrintBufferSize characters are sent to ConOut. PcdUefiLibMaxPrintBufferSize characters are sent to ConOut.
If Format is NULL, then ASSERT().
If Format is not aligned on a 16-bit boundary, then ASSERT().
@param Format Null-terminated Unicode format string. @param Format Null-terminated Unicode format string.
@param ... Variable argument list whose contents are accessed based @param ... Variable argument list whose contents are accessed based
on the format string specified by Format. on the format string specified by Format.
If Format is NULL, then ASSERT().
If Format is not aligned on a 16-bit boundary, then ASSERT().
@return Number of Unicode characters printed to ConOut. @return Number of Unicode characters printed to ConOut.
@ -847,12 +872,12 @@ Print (
characters that printed to StdErr. If the length of the formatted Unicode characters that printed to StdErr. If the length of the formatted Unicode
string is greater than PcdUefiLibMaxPrintBufferSize, then only the first string is greater than PcdUefiLibMaxPrintBufferSize, then only the first
PcdUefiLibMaxPrintBufferSize characters are sent to StdErr. PcdUefiLibMaxPrintBufferSize characters are sent to StdErr.
If Format is NULL, then ASSERT().
If Format is not aligned on a 16-bit boundary, then ASSERT().
@param Format Null-terminated Unicode format string. @param Format Null-terminated Unicode format string.
@param ... Variable argument list whose contents are accessed based @param ... Variable argument list whose contents are accessed based
on the format string specified by Format. on the format string specified by Format.
If Format is NULL, then ASSERT().
If Format is not aligned on a 16-bit boundary, then ASSERT().
@return Number of Unicode characters printed to StdErr. @return Number of Unicode characters printed to StdErr.
@ -873,12 +898,12 @@ ErrorPrint (
characters that printed to ConOut. If the length of the formatted ASCII characters that printed to ConOut. If the length of the formatted ASCII
string is greater than PcdUefiLibMaxPrintBufferSize, then only the first string is greater than PcdUefiLibMaxPrintBufferSize, then only the first
PcdUefiLibMaxPrintBufferSize characters are sent to ConOut. PcdUefiLibMaxPrintBufferSize characters are sent to ConOut.
If Format is NULL, then ASSERT().
If Format is not aligned on a 16-bit boundary, then ASSERT().
@param Format Null-terminated ASCII format string. @param Format Null-terminated ASCII format string.
@param ... Variable argument list whose contents are accessed based @param ... Variable argument list whose contents are accessed based
on the format string specified by Format. on the format string specified by Format.
If Format is NULL, then ASSERT().
If Format is not aligned on a 16-bit boundary, then ASSERT().
@return Number of ASCII characters printed to ConOut. @return Number of ASCII characters printed to ConOut.
@ -899,12 +924,12 @@ AsciiPrint (
characters that printed to StdErr. If the length of the formatted ASCII characters that printed to StdErr. If the length of the formatted ASCII
string is greater than PcdUefiLibMaxPrintBufferSize, then only the first string is greater than PcdUefiLibMaxPrintBufferSize, then only the first
PcdUefiLibMaxPrintBufferSize characters are sent to StdErr. PcdUefiLibMaxPrintBufferSize characters are sent to StdErr.
If Format is NULL, then ASSERT().
If Format is not aligned on a 16-bit boundary, then ASSERT().
@param Format Null-terminated ASCII format string. @param Format Null-terminated ASCII format string.
@param ... Variable argument list whose contents are accessed based @param ... Variable argument list whose contents are accessed based
on the format string specified by Format. on the format string specified by Format.
If Format is NULL, then ASSERT().
If Format is not aligned on a 16-bit boundary, then ASSERT().
@return Number of ASCII characters printed to ConErr. @return Number of ASCII characters printed to ConErr.
@ -1016,7 +1041,9 @@ AsciiPrintXY (
/** /**
Initializes a driver by installing the Driver Binding Protocol onto the driver's Initializes a driver by installing the Driver Binding Protocol onto the driver's
DriverBindingHandle. This is typically the same as the driver's ImageHandle, but DriverBindingHandle.
This is typically the same as the driver's ImageHandle, but
it can be different if the driver produces multiple DriverBinding Protocols. it can be different if the driver produces multiple DriverBinding Protocols.
If the Driver Binding Protocol interface is NULL, then ASSERT (). If the Driver Binding Protocol interface is NULL, then ASSERT ().
If the installation fails, then ASSERT (). If the installation fails, then ASSERT ().
@ -1028,6 +1055,7 @@ AsciiPrintXY (
parameter is NULL, then a new handle is created. parameter is NULL, then a new handle is created.
@retval EFI_SUCCESS The protocol installation is completed successfully. @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 Others Status from gBS->InstallMultipleProtocolInterfaces().
**/ **/
@ -1043,8 +1071,9 @@ EfiLibInstallDriverBinding (
/** /**
Initializes a driver by installing the Driver Binding Protocol together with the optional Component Name, 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. This is Driver Configure and Driver Diagnostic Protocols onto the driver's DriverBindingHandle.
typically the same as the driver's ImageHandle, but it can be different if the driver produces multiple
This is typically the same as the driver's ImageHandle, but it can be different if the driver produces multiple
DriverBinding Protocols. DriverBinding Protocols.
If the Driver Binding Protocol interface is NULL, then ASSERT (). If the Driver Binding Protocol interface is NULL, then ASSERT ().
If the installation fails, then ASSERT (). If the installation fails, then ASSERT ().
@ -1110,7 +1139,9 @@ EfiLibInstallDriverBindingComponentName2 (
/** /**
Intialize a driver by installing the Driver Binding Protocol together with the optional Component Name, 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 Component Name 2, Driver Configure, Driver Diagnostic and Driver Diagnostic 2 Protocols onto the driver's
DriverBindingHandle. This is typically the same as the driver's ImageHandle, but it can be different if DriverBindingHandle.
This is typically the same as the driver's ImageHandle, but it can be different if
the driver produces multiple DriverBinding Protocols. the driver produces multiple DriverBinding Protocols.
If the Drvier Binding Protocol interface is NULL, then ASSERT (). If the Drvier Binding Protocol interface is NULL, then ASSERT ().
If the installation fails, then ASSERT (). If the installation fails, then ASSERT ().
@ -1152,10 +1183,9 @@ EfiLibInstallAllDriverProtocols2 (
If Lang is NULL, then ASSERT. If Lang is NULL, then ASSERT.
@param Lang Pointer of system language. Lang will always be filled with @param Lang Pointer of system language. Lang will always be filled with a valid RFC 3066
a valid RFC 3066 language string. If "PlatformLang" is not language string. If "PlatformLang" is not set in the system, the default
set in the system, the default language specifed by PcdUefiVariableDefaultPlatformLang language specifed by PcdUefiVariableDefaultPlatformLang is returned.
is returned.
@return EFI_SUCCESS If the EFI Variable with "PlatformLang" is set and return in Lang. @return EFI_SUCCESS If the EFI Variable with "PlatformLang" is set and return in Lang.
@return EFI_NOT_FOUND If the EFI Variable with "PlatformLang" is not set, but a valid default language is return in Lang. @return EFI_NOT_FOUND If the EFI Variable with "PlatformLang" is not set, but a valid default language is return in Lang.

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

@ -244,6 +244,8 @@ GetGlyphWidth (
} }
/** /**
Computes the display length of a Null-terminated Unicode String.
This function computes and returns the display length of This function computes and returns the display length of
the Null-terminated Unicode string specified by String. the Null-terminated Unicode string specified by String.
If String is NULL, then 0 is returned. If String is NULL, then 0 is returned.

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

@ -17,19 +17,22 @@
#include "UefiLibInternal.h" #include "UefiLibInternal.h"
/** /**
Intialize a driver by installing the Driver Binding Protocol onto the driver's Initializes a driver by installing the Driver Binding Protocol onto the driver's
DriverBindingHandle. This is typically the same as the driver's ImageHandle, but DriverBindingHandle.
This is typically the same as the driver's ImageHandle, but
it can be different if the driver produces multiple DriverBinding Protocols. it can be different if the driver produces multiple DriverBinding Protocols.
If the Drvier Binding Protocol interface is NULL, then ASSERT (). If the Driver Binding Protocol interface is NULL, then ASSERT ().
If the installation fails, then ASSERT (). If the installation fails, then ASSERT ().
@param ImageHandle The image handle of the driver. @param ImageHandle The image handle of the driver.
@param SystemTable The EFI System Table that was passed to the driver's entry point. @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 DriverBinding A Driver Binding Protocol instance that this driver is producing.
@param DriverBindingHandle The handle that DriverBinding is to be installe onto. If this @param DriverBindingHandle The handle that DriverBinding is to be installed onto. If this
parameter is NULL, then a new handle is created. parameter is NULL, then a new handle is created.
@retval EFI_SUCCESS The protocol installation is completed successfully. @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 Others Status from gBS->InstallMultipleProtocolInterfaces().
**/ **/
@ -67,17 +70,18 @@ EfiLibInstallDriverBinding (
/** /**
Intialize a driver by installing the Driver Binding Protocol together with the optional Component Name, 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. This is Driver Configure and Driver Diagnostic Protocols onto the driver's DriverBindingHandle.
typically the same as the driver's ImageHandle, but it can be different if the driver produces multiple
This is typically the same as the driver's ImageHandle, but it can be different if the driver produces multiple
DriverBinding Protocols. DriverBinding Protocols.
If the Drvier Binding Protocol interface is NULL, then ASSERT (). If the Driver Binding Protocol interface is NULL, then ASSERT ().
If the installation fails, then ASSERT (). If the installation fails, then ASSERT ().
@param ImageHandle The image handle of the driver. @param ImageHandle The image handle of the driver.
@param SystemTable The EFI System Table that was passed to the driver's entry point. @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 DriverBinding A Driver Binding Protocol instance that this driver is producing.
@param DriverBindingHandle The handle that DriverBinding is to be installe onto. If this @param DriverBindingHandle The handle that DriverBinding is to be installed onto. If this
parameter is NULL, then a new handle is created. parameter is NULL, then a new handle is created.
@param ComponentName A Component Name Protocol instance that this driver is producing. @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 DriverConfiguration A Driver Configuration Protocol instance that this driver is producing.
@ -279,7 +283,9 @@ EfiLibInstallDriverBindingComponentName2 (
/** /**
Intialize a driver by installing the Driver Binding Protocol together with the optional Component Name, 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 Component Name 2, Driver Configure, Driver Diagnostic and Driver Diagnostic 2 Protocols onto the driver's
DriverBindingHandle. This is typically the same as the driver's ImageHandle, but it can be different if DriverBindingHandle.
This is typically the same as the driver's ImageHandle, but it can be different if
the driver produces multiple DriverBinding Protocols. the driver produces multiple DriverBinding Protocols.
If the Drvier Binding Protocol interface is NULL, then ASSERT (). If the Drvier Binding Protocol interface is NULL, then ASSERT ().
If the installation fails, then ASSERT (). If the installation fails, then ASSERT ().

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

@ -45,10 +45,13 @@ CompareIso639LanguageCode (
} }
/** /**
This function searches the list of configuration tables stored in the EFI System Retrieves a pointer to the system configuration table from the EFI System Table
Table for a table with a GUID that matches TableGuid. If a match is found, based on a specified GUID.
then a pointer to the configuration table is returned in Table, and EFI_SUCCESS
is returned. If a matching GUID is not found, then EFI_NOT_FOUND is returned. This function searches the list of configuration tables stored in the EFI System Table
for a table with a GUID that matches TableGuid. If a match is found, then a pointer to
the configuration table is returned in Table., and EFI_SUCCESS is returned. If a matching GUID
is not found, then EFI_NOT_FOUND is returned.
If TableGuid is NULL, then ASSERT(). If TableGuid is NULL, then ASSERT().
If Table is NULL, then ASSERT(). If Table is NULL, then ASSERT().
@ -85,16 +88,26 @@ EfiGetSystemConfigurationTable (
} }
/** /**
This function causes the notification function to be executed for every protocol Creates and returns a notification event and registers that event with all the protocol
of type ProtocolGuid instance that exists in the system when this function is instances specified by ProtocolGuid.
invoked. In addition, every time a protocol of type ProtocolGuid instance is
installed or reinstalled, the notification function is also executed. This function causes the notification function to be executed for every protocol of type
ProtocolGuid instance that exists in the system when this function is invoked.
In addition, every time a protocol of type ProtocolGuid instance is installed or reinstalled,
the notification function is also executed. This function returns the notification event
that was created.
If ProtocolGuid is NULL, then ASSERT().
If NotifyTpl is not a legal TPL value, then ASSERT().
If NotifyFunction is NULL, then ASSERT().
If Registration is NULL, then ASSERT().
@param ProtocolGuid Supplies GUID of the protocol upon whose installation the event is fired. @param ProtocolGuid Supplies GUID of the protocol upon whose installation the event is fired.
@param NotifyTpl Supplies the task priority level of the event notifications. @param NotifyTpl Supplies the task priority level of the event notifications.
@param NotifyFunction Supplies the function to notify when the event is signaled. @param NotifyFunction Supplies the function to notify when the event is signaled.
@param NotifyContext The context parameter to pass to NotifyFunction. @param NotifyContext The context parameter to pass to NotifyFunction.
@param Registration A pointer to a memory location to receive the registration value. @param Registration A pointer to a memory location to receive the registration value.
This value is passed to LocateHandle() to obtain new handles that
have been added that support the ProtocolGuid-specified protocol.
@return The notification event that was created. @return The notification event that was created.
@ -112,6 +125,10 @@ EfiCreateProtocolNotifyEvent(
EFI_STATUS Status; EFI_STATUS Status;
EFI_EVENT Event; EFI_EVENT Event;
ASSERT (ProtocolGuid != NULL);
ASSERT (NotifyFunction != NULL);
ASSERT (Registration != NULL);
// //
// Create the event // Create the event
// //
@ -147,9 +164,11 @@ EfiCreateProtocolNotifyEvent(
} }
/** /**
Creates a named event that can be signaled with EfiNamedEventSignal().
This function creates an event using NotifyTpl, NoifyFunction, and NotifyContext. This function creates an event using NotifyTpl, NoifyFunction, and NotifyContext.
This event is signaled with EfiNamedEventSignal(). This provide the ability for This event is signaled with EfiNamedEventSignal(). This provides the ability for one or more
one or more listeners on the same event named by the GUID specified by Name. listeners on the same event named by the GUID specified by Name.
If Name is NULL, then ASSERT(). If Name is NULL, then ASSERT().
If NotifyTpl is not a legal TPL value, then ASSERT(). If NotifyTpl is not a legal TPL value, then ASSERT().
If NotifyFunction is NULL, then ASSERT(). If NotifyFunction is NULL, then ASSERT().
@ -157,7 +176,7 @@ EfiCreateProtocolNotifyEvent(
@param Name Supplies GUID name of the event. @param Name Supplies GUID name of the event.
@param NotifyTpl Supplies the task priority level of the event notifications. @param NotifyTpl Supplies the task priority level of the event notifications.
@param NotifyFunction Supplies the function to notify when the event is signaled. @param NotifyFunction Supplies the function to notify when the event is signaled.
@param NotifyContext The context parameter to pass to NotifyFunction. @param NotifyContext The context parameter to pass to NotifyFunction.
@param Registration A pointer to a memory location to receive the registration value. @param Registration A pointer to a memory location to receive the registration value.
@retval EFI_SUCCESS A named event was created. @retval EFI_SUCCESS A named event was created.
@ -219,8 +238,11 @@ EfiNamedEventListen (
} }
/** /**
This function signals the named event specified by Name. The named event must Signals a named event created with EfiNamedEventListen().
have been created with EfiNamedEventListen().
This function signals the named event specified by Name. The named event must have been
created with EfiNamedEventListen().
If Name is NULL, then ASSERT().
@param Name Supplies GUID name of the event. @param Name Supplies GUID name of the event.
@ -237,6 +259,8 @@ EfiNamedEventSignal (
EFI_STATUS Status; EFI_STATUS Status;
EFI_HANDLE Handle; EFI_HANDLE Handle;
ASSERT(Name != NULL);
Handle = NULL; Handle = NULL;
Status = gBS->InstallProtocolInterface ( Status = gBS->InstallProtocolInterface (
&Handle, &Handle,
@ -286,8 +310,10 @@ EfiGetCurrentTpl (
/** /**
This function initializes a basic mutual exclusion lock to the released state Initializes a basic mutual exclusion lock.
and returns the lock. Each lock provides mutual exclusion access at its task
This function initializes a basic mutual exclusion lock to the released state
and returns the lock. Each lock provides mutual exclusion access at its task
priority level. Since there is no preemption or multiprocessor support in EFI, priority level. Since there is no preemption or multiprocessor support in EFI,
acquiring the lock only consists of raising to the locks TPL. acquiring the lock only consists of raising to the locks TPL.
If Lock is NULL, then ASSERT(). If Lock is NULL, then ASSERT().
@ -316,14 +342,16 @@ EfiInitializeLock (
} }
/** /**
This function raises the system's current task priority level to the task Acquires ownership of a lock.
priority level of the mutual exclusion lock. Then, it places the lock in the
This function raises the system's current task priority level to the task
priority level of the mutual exclusion lock. Then, it places the lock in the
acquired state. acquired state.
If Lock is NULL, then ASSERT(). If Lock is NULL, then ASSERT().
If Lock is not initialized, then ASSERT(). If Lock is not initialized, then ASSERT().
If Lock is already in the acquired state, then ASSERT(). If Lock is already in the acquired state, then ASSERT().
@param Lock The task lock with priority level. @param Lock A pointer to the lock to acquire.
**/ **/
VOID VOID
@ -340,9 +368,13 @@ EfiAcquireLock (
} }
/** /**
This function raises the system's current task priority level to the task Acquires ownership of a lock. If the lock is already owned , then an error is returned.
priority level of the mutual exclusion lock. Then, it attempts to place the
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. lock in the acquired state.
If Lock is NULL, then ASSERT().
If Lock is not initialized, then ASSERT().
@param Lock A pointer to the lock to acquire. @param Lock A pointer to the lock to acquire.
@ -375,9 +407,14 @@ EfiAcquireLockOrFail (
} }
/** /**
This function transitions a mutual exclusion lock from the acquired state to Releases ownership of a lock.
the released state, and restores the system's task priority level to its
This function transitions a mutual exclusion lock from the acquired state to
the released state, and restores the system's task priority level to its
previous level. previous level.
If Lock is NULL, then ASSERT().
If Lock is not initialized, then ASSERT().
If Lock is already in the released state, then ASSERT().
@param Lock A pointer to the lock to release. @param Lock A pointer to the lock to release.
@ -527,50 +564,32 @@ EfiTestChildHandle (
/** /**
This function looks up a Unicode string in UnicodeStringTable. 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 If Language is a member of SupportedLanguages and a Unicode string is found in
language code for the Unicode UnicodeStringTable that matches the language code specified by Language, then it
string to look up and return. is returned in UnicodeString.
@param SupportedLanguages A pointer to the set of ISO
639-2language
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.
@retval EFI_SUCCESS The Unicode string that @param Language A pointer to the ISO 639-2 language code for the
matches the language specified Unicode string to look up and return.
by Language was found in the @param SupportedLanguages A pointer to the set of ISO 639-2 language codes
table of Unicoide strings that the Unicode string table supports. Language
UnicodeStringTable, and it was must be a member of this set.
returned in UnicodeString. @param UnicodeStringTable A pointer to the table of Unicode strings.
@param UnicodeString A pointer to the Unicode string from UnicodeStringTable
@retval EFI_INVALID_PARAMETER Language is NULL. that matches the language specified by Language.
@retval EFI_INVALID_PARAMETER UnicodeString is NULL. @retval EFI_SUCCESS The Unicode string that matches the language
@retval EFI_UNSUPPORTED SupportedLanguages is NULL. specified by Language was found
in the table of Unicoide strings UnicodeStringTable,
@retval EFI_UNSUPPORTED UnicodeStringTable is NULL. and it was returned in UnicodeString.
@retval EFI_INVALID_PARAMETER Language is NULL.
@retval EFI_UNSUPPORTED The language specified by @retval EFI_INVALID_PARAMETER UnicodeString is NULL.
Language is not a member @retval EFI_UNSUPPORTED SupportedLanguages is NULL.
ofSupportedLanguages. @retval EFI_UNSUPPORTED UnicodeStringTable is NULL.
@retval EFI_UNSUPPORTED The language specified by Language is not a
@retval EFI_UNSUPPORTED The language specified by member of SupportedLanguages.
Language is not supported by @retval EFI_UNSUPPORTED The language specified by Language is not
UnicodeStringTable. supported by UnicodeStringTable.
**/ **/
EFI_STATUS EFI_STATUS
@ -640,28 +659,23 @@ LookupUnicodeString (
@param Language A pointer to the ISO 639-2 or @param Language A pointer to the ISO 639-2 or
RFC 3066 language code for the RFC 3066 language code for the
Unicode string to look up and Unicode string to look up and
return. return.
@param SupportedLanguages A pointer to the set of ISO @param SupportedLanguages A pointer to the set of ISO
639-2 or RFC 3066 language 639-2 or RFC 3066 language
codes that the Unicode string codes that the Unicode string
table supports. Language must table supports. Language must
be a member of this set. be a member of this set.
@param UnicodeStringTable A pointer to the table of @param UnicodeStringTable A pointer to the table of
Unicode strings. Unicode strings.
@param UnicodeString A pointer to the Unicode @param UnicodeString A pointer to the Unicode
string from UnicodeStringTable string from UnicodeStringTable
that matches the language that matches the language
specified by Language. specified by Language.
@param Iso639Language Specify the language code @param Iso639Language Specify the language code
format supported. If true, format supported. If true,
then the format follow ISO then the format follow ISO
639-2. If false, then it 639-2. If false, then it
follows RFC3066. follows RFC3066.
@retval EFI_SUCCESS The Unicode string that @retval EFI_SUCCESS The Unicode string that
matches the language specified matches the language specified
by Language was found in the by Language was found in the
@ -669,18 +683,13 @@ LookupUnicodeString (
UnicodeStringTable, and it was UnicodeStringTable, and it was
returned in UnicodeString. returned in UnicodeString.
@retval EFI_INVALID_PARAMETER Language is NULL. @retval EFI_INVALID_PARAMETER Language is NULL.
@retval EFI_INVALID_PARAMETER UnicodeString is NULL.
@retval EFI_INVALID_PARAMETER UnicodeString is NULL. @retval EFI_UNSUPPORTED SupportedLanguages is NULL.
@retval EFI_UNSUPPORTED SupportedLanguages is NULL.
@retval EFI_UNSUPPORTED UnicodeStringTable is NULL. @retval EFI_UNSUPPORTED UnicodeStringTable is NULL.
@retval EFI_UNSUPPORTED The language specified by @retval EFI_UNSUPPORTED The language specified by
Language is not a member Language is not a member
ofSupportedLanguages. ofSupportedLanguages.
@retval EFI_UNSUPPORTED The language specified by @retval EFI_UNSUPPORTED The language specified by
Language is not supported by Language is not supported by
UnicodeStringTable. UnicodeStringTable.
@ -767,57 +776,36 @@ LookupUnicodeString2 (
/** /**
This function adds a Unicode string to UnicodeStringTable. This function adds a Unicode string to UnicodeStringTable.
If Language is a member of SupportedLanguages then
UnicodeString is added to UnicodeStringTable. New buffers are If Language is a member of SupportedLanguages then UnicodeString is added to
allocated for both Language and UnicodeString. The contents UnicodeStringTable. New buffers are allocated for both Language and
of Language and UnicodeString are copied into these new UnicodeString. The contents of Language and UnicodeString are copied into
buffers. These buffers are automatically freed when these new buffers. These buffers are automatically freed when
FreeUnicodeStringTable() is called. FreeUnicodeStringTable() is called.
@param Language A pointer to the ISO 639-2 @param Language A pointer to the ISO 639-2 language code for the Unicode
language code for the Unicode
string to add.
@param SupportedLanguages A pointer to the set of ISO
639-2 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. string to add.
@param SupportedLanguages A pointer to the set of ISO 639-2 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.
@retval EFI_SUCCESS The Unicode string that @retval EFI_SUCCESS The Unicode string that matches the language
matches the language specified specified by Language was found in the table of
by Language was found in the Unicode strings UnicodeStringTable, and it was
table of Unicode strings
UnicodeStringTable, and it was
returned in UnicodeString. returned in UnicodeString.
@retval EFI_INVALID_PARAMETER Language is NULL. @retval EFI_INVALID_PARAMETER Language is NULL.
@retval EFI_INVALID_PARAMETER UnicodeString is NULL. @retval EFI_INVALID_PARAMETER UnicodeString is NULL.
@retval EFI_INVALID_PARAMETER UnicodeString is an empty string. @retval EFI_INVALID_PARAMETER UnicodeString is an empty string.
@retval EFI_UNSUPPORTED SupportedLanguages is NULL. @retval EFI_UNSUPPORTED SupportedLanguages is NULL.
@retval EFI_ALREADY_STARTED A Unicode string with language Language is
@retval EFI_ALREADY_STARTED A Unicode string with language already present in UnicodeStringTable.
Language is already present in @retval EFI_OUT_OF_RESOURCES There is not enough memory to add another
UnicodeStringTable. Unicode string to UnicodeStringTable.
@retval EFI_UNSUPPORTED The language specified by Language is not a
@retval EFI_OUT_OF_RESOURCES There is not enough memory to member of SupportedLanguages.
add another Unicode string to
UnicodeStringTable.
@retval EFI_UNSUPPORTED The language specified by
Language is not a member of
SupportedLanguages.
**/ **/
EFI_STATUS EFI_STATUS
@ -956,8 +944,8 @@ AddUnicodeString (
/** /**
This function adds a Unicode string to UnicodeStringTable. This function adds a Unicode string to UnicodeStringTable.
If Language is a member of SupportedLanguages then If Language is a member of SupportedLanguages then
UnicodeString is added to UnicodeStringTable. New buffers are UnicodeString is added to UnicodeStringTable. New buffers are
allocated for both Language and UnicodeString. The contents allocated for both Language and UnicodeString. The contents
@ -967,26 +955,21 @@ AddUnicodeString (
@param Language A pointer to the ISO 639-2 or @param Language A pointer to the ISO 639-2 or
RFC 3066 language code for the RFC 3066 language code for the
Unicode string to add. Unicode string to add.
@param SupportedLanguages A pointer to the set of ISO @param SupportedLanguages A pointer to the set of ISO
639-2 or RFC 3.66 language 639-2 or RFC 3066 language
codes that the Unicode string codes that the Unicode string
table supports. Language must table supports. Language must
be a member of this set. be a member of this set.
@param UnicodeStringTable A pointer to the table of @param UnicodeStringTable A pointer to the table of
Unicode strings. Unicode strings.
@param UnicodeString A pointer to the Unicode @param UnicodeString A pointer to the Unicode
string to add. string to add.
@param Iso639Language Specify the language code @param Iso639Language Specify the language code
format supported. If true, format supported. If true,
then the format follow ISO then the format follow ISO
639-2. If false, then it 639-2. If false, then it
follows RFC3066. follows RFC3066.
@retval EFI_SUCCESS The Unicode string that @retval EFI_SUCCESS The Unicode string that
matches the language specified matches the language specified
by Language was found in the by Language was found in the
@ -994,22 +977,16 @@ AddUnicodeString (
UnicodeStringTable, and it was UnicodeStringTable, and it was
returned in UnicodeString. returned in UnicodeString.
@retval EFI_INVALID_PARAMETER Language is NULL. @retval EFI_INVALID_PARAMETER Language is NULL.
@retval EFI_INVALID_PARAMETER UnicodeString 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_INVALID_PARAMETER UnicodeString is an empty string.
@retval EFI_UNSUPPORTED SupportedLanguages is NULL.
@retval EFI_ALREADY_STARTED A Unicode string with language @retval EFI_ALREADY_STARTED A Unicode string with language
Language is already present in Language is already present in
UnicodeStringTable. UnicodeStringTable.
@retval EFI_OUT_OF_RESOURCES There is not enough memory to @retval EFI_OUT_OF_RESOURCES There is not enough memory to
add another Unicode string to add another Unicode string to
UnicodeStringTable. UnicodeStringTable.
@retval EFI_UNSUPPORTED The language specified by @retval EFI_UNSUPPORTED The language specified by
Language is not a member of Language is not a member of
SupportedLanguages. SupportedLanguages.
@ -1175,6 +1152,7 @@ AddUnicodeString2 (
/** /**
This function frees the table of Unicode strings in UnicodeStringTable. This function frees the table of Unicode strings in UnicodeStringTable.
If UnicodeStringTable is NULL, then EFI_SUCCESS is returned. If UnicodeStringTable is NULL, then EFI_SUCCESS is returned.
Otherwise, each language code, and each Unicode string in the Unicode string Otherwise, each language code, and each Unicode string in the Unicode string
table are freed, and EFI_SUCCESS is returned. table are freed, and EFI_SUCCESS is returned.
@ -1231,10 +1209,9 @@ FreeUnicodeStringTable (
If Lang is NULL, then ASSERT. If Lang is NULL, then ASSERT.
@param Lang Pointer of system language. Lang will always be filled with @param Lang Pointer of system language. Lang will always be filled with a valid RFC 3066
a valid RFC 3066 language string. If "PlatformLang" is not language string. If "PlatformLang" is not set in the system, the default
set in the system, the default language specifed by PcdUefiVariableDefaultPlatformLang language specifed by PcdUefiVariableDefaultPlatformLang is returned.
is returned.
@return EFI_SUCCESS If the EFI Variable with "PlatformLang" is set and return in Lang. @return EFI_SUCCESS If the EFI Variable with "PlatformLang" is set and return in Lang.
@return EFI_NOT_FOUND If the EFI Variable with "PlatformLang" is not set, but a valid default language is return in Lang. @return EFI_NOT_FOUND If the EFI Variable with "PlatformLang" is not set, but a valid default language is return in Lang.

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

@ -214,10 +214,12 @@ EfiCreateEventReadyToBootEx (
/** /**
Signal a Ready to Boot Event. Create, Signal, and Close the Ready to Boot event using EfiSignalEventReadyToBoot().
Create a Ready to Boot Event. Signal it and close it. This causes other This function abstracts the signaling of the Ready to Boot Event. The Framework moved
events of the same event group to be signaled in other modules. 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 VOID
@ -237,10 +239,12 @@ EfiSignalEventReadyToBoot (
} }
/** /**
Signal a Legacy Boot Event. Create, Signal, and Close the Ready to Boot event using EfiSignalEventLegacyBoot().
Create a legacy Boot Event. Signal it and close it. This causes other This function abstracts the signaling of the Legacy Boot Event. The Framework moved from
events of the same event group to be signaled in other modules. 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 VOID
@ -261,17 +265,18 @@ EfiSignalEventLegacyBoot (
/** /**
Check to see if the Firmware Volume (FV) Media Device Path is valid
The Framework FwVol Device Path changed to conform to the UEFI 2.0 specification. The Framework FwVol Device Path changed to conform to the UEFI 2.0 specification.
This library function abstracts validating a device path node. This library function abstracts validating a device path node.
Check the MEDIA_FW_VOL_FILEPATH_DEVICE_PATH data structure to see if it's valid. Check the MEDIA_FW_VOL_FILEPATH_DEVICE_PATH data structure to see if it's valid.
If it is valid, then return the GUID file name from the device path node. If it is valid, then return the GUID file name from the device path node. Otherwise,
Otherwise, return NULL. This device path changed in the DXE CIS version 0.92 return NULL. This device path changed in the DXE CIS version 0.92 in a non back ward
in a non back ward compatible way to not conflict with the UEFI 2.0 specification. compatible way to not conflict with the UEFI 2.0 specification. This function abstracts
This function abstracts the differences from the caller. the differences from the caller.
If FvDevicePathNode is NULL, then ASSERT(). If FvDevicePathNode is NULL, then ASSERT().
@param FvFileDevicePathNode Pointer to FV device path to check. @param FvDevicePathNode Pointer to FV device path to check.
@retval NULL FvDevicePathNode is not valid. @retval NULL FvDevicePathNode is not valid.
@retval Other FvDevicePathNode is valid and pointer to NameGuid was returned. @retval Other FvDevicePathNode is valid and pointer to NameGuid was returned.
@ -295,17 +300,18 @@ EfiGetNameGuidFromFwVolDevicePathNode (
/** /**
Initialize a Firmware Volume (FV) Media Device Path node.
The Framework FwVol Device Path changed to conform to the UEFI 2.0 specification. The Framework FwVol Device Path changed to conform to the UEFI 2.0 specification.
This library function abstracts initializing a device path node. This library function abstracts initializing a device path node.
Initialize the MEDIA_FW_VOL_FILEPATH_DEVICE_PATH data structure. This device Initialize the MEDIA_FW_VOL_FILEPATH_DEVICE_PATH data structure. This device
path changed in the DXE CIS version 0.92 in a non back ward compatible way to path changed in the DXE CIS version 0.92 in a non back ward compatible way to
not conflict with the UEFI 2.0 specification. This function abstracts the not conflict with the UEFI 2.0 specification. This function abstracts the
differences from the caller. differences from the caller.
If FvDevicePathNode is NULL, then ASSERT(). If FvDevicePathNode is NULL, then ASSERT().
If NameGuid is NULL, then ASSERT(). If NameGuid is NULL, then ASSERT().
@param FvFileDevicePathNode Pointer to a FV device path node to initialize @param FvDevicePathNode Pointer to a FV device path node to initialize
@param NameGuid FV file name to use in FvDevicePathNode @param NameGuid FV file name to use in FvDevicePathNode
**/ **/

22
MdePkg/Library/UefiRuntimeLib/RuntimeLib.c
View File

@ -152,9 +152,16 @@ RuntimeDriverLibDeconstruct (
} }
/** /**
Return TRUE if ExitBootServices () has been called. This function allows the caller to determine if UEFI ExitBootServices() has been called.
This function returns TRUE after all the EVT_SIGNAL_EXIT_BOOT_SERVICES functions have
executed as a result of the OS calling ExitBootServices(). Prior to this time FALSE
is returned. This function is used by runtime code to decide it is legal to access
services that go away after ExitBootServices().
@retval TRUE The system has finished executing the EVT_SIGNAL_EXIT_BOOT_SERVICES event.
@retval FALSE The system has not finished executing the EVT_SIGNAL_EXIT_BOOT_SERVICES event.
@retval TRUE If ExitBootServices () has been called
**/ **/
BOOLEAN BOOLEAN
EFIAPI EFIAPI
@ -166,9 +173,16 @@ EfiAtRuntime (
} }
/** /**
Return TRUE if SetVirtualAddressMap () has been called. This function allows the caller to determine if UEFI SetVirtualAddressMap() has been called.
This function returns TRUE after all the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE functions have
executed as a result of the OS calling SetVirtualAddressMap(). Prior to this time FALSE
is returned. This function is used by runtime code to decide it is legal to access services
that go away after SetVirtualAddressMap().
@retval TRUE The system has finished executing the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.
@retval FALSE The system has not finished executing the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.
@retval TRUE If SetVirtualAddressMap () has been called
**/ **/
BOOLEAN BOOLEAN
EFIAPI EFIAPI

168
MdePkg/Library/UefiRuntimeLib/RuntimeService.c
View File

@ -24,10 +24,19 @@
Resets the entire platform. Resets the entire platform.
@param ResetType The type of reset to perform. @param ResetType The type of reset to perform.
@param ResetStatus The status code for reset. @param ResetStatus The status code for the reset. If the system reset is part of a
@param DataSize The size in bytes of reset data. normal operation, the status code would be EFI_SUCCESS. If the system
@param ResetData Pointer to data buffer that includes reset is due to some type of failure the most appropriate EFI Status
Null-Terminated Unicode string. code would be used.
@param DataSizeThe size, in bytes, of ResetData.
@param ResetData For a ResetType of EfiResetCold, EfiResetWarm, or EfiResetShutdown
the data buffer starts with a Null-terminated Unicode string, optionally
followed by additional binary data. The string is a description that the
caller may use to further indicate the reason for the system reset. ResetData
is only valid if ResetStatus is something other then EFI_SUCCESS. This
pointer must be a physical address. For a ResetType of EfiRestUpdate the
data buffer also starts with a Null-terminated string that is followed by
a physical VOID * to an EFI_CAPSULE_HEADER.
**/ **/
VOID VOID
@ -44,15 +53,24 @@ EfiResetSystem (
/** /**
Return current time and date information, and time-keeping This service is a wrapper for the UEFI Runtime Service GetTime().
capabilities of hardware platform.
The GetTime() function returns a time that was valid sometime during the call to the function.
While the returned EFI_TIME structure contains TimeZone and Daylight savings time information,
the actual clock does not maintain these values. The current time zone and daylight saving time
information returned by GetTime() are the values that were last set via SetTime().
The GetTime() function should take approximately the same amount of time to read the time each
time it is called. All reported device capabilities are to be rounded up.
During runtime, if a PC-AT CMOS device is present in the platform the caller must synchronize
access to the device before calling GetTime().
@param Time A pointer to storage to receive a snapshot of the current time. @param Time A pointer to storage to receive a snapshot of the current time.
@param Capabilities An optional pointer to a buffer to receive the real time clock device's @param Capabilities An optional pointer to a buffer to receive the real time clock device's
capabilities. capabilities.
@retval EFI_SUCCESS Success to execute the function. @retval EFI_SUCCESS The operation completed successfully.
@retval !EFI_SUCCESS Failed to execute the function. @retval EFI_INVALID_PARAMETER Time is NULL.
@retval EFI_DEVICE_ERROR The time could not be retrieved due to a hardware error.
**/ **/
EFI_STATUS EFI_STATUS
@ -67,12 +85,25 @@ EfiGetTime (
/** /**
Set current time and date information. This service is a wrapper for the UEFI Runtime Service SetTime().
@param Time A pointer to cache of time setting. The SetTime() function sets the real time clock device to the supplied time, and records the
current time zone and daylight savings time information. The SetTime() function is not allowed
to loop based on the current time. For example, if the device does not support a hardware reset
for the sub-resolution time, the code is not to implement the feature by waiting for the time to
wrap.
During runtime, if a PC-AT CMOS device is present in the platform the caller must synchronize
access to the device before calling SetTime().
@retval EFI_SUCCESS Success to execute the function. @param Time A pointer to the current time. Type EFI_TIME is defined in the GetTime()
@retval !EFI_SUCCESS Failed to execute the function. function description. Full error checking is performed on the different
fields of the EFI_TIME structure (refer to the EFI_TIME definition in the
GetTime() function description for full details), and EFI_INVALID_PARAMETER
is returned if any field is out of range.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_INVALID_PARAMETER A time field is out of range.
@retval EFI_DEVICE_ERROR The time could not be set due to a hardware error.
**/ **/
EFI_STATUS EFI_STATUS
@ -86,14 +117,24 @@ EfiSetTime (
/** /**
Return current wakeup alarm clock setting. Returns the current wakeup alarm clock setting.
@param Enabled Indicate if the alarm clock is enabled or disabled. The alarm clock time may be rounded from the set alarm clock time to be within the resolution
@param Pending Indicate if the alarm signal is pending and requires acknowledgement. of the alarm clock device. The resolution of the alarm clock device is defined to be one second.
@param Time Current alarm clock setting. During runtime, if a PC-AT CMOS device is present in the platform the caller must synchronize
access to the device before calling GetWakeupTime().
@retval EFI_SUCCESS Success to execute the function. @param Enabled Indicates if the alarm is currently enabled or disabled.
@retval !EFI_SUCCESS Failed to execute the function. @param Pending Indicates if the alarm signal is pending and requires acknowledgement.
@param Time The current alarm setting. Type EFI_TIME is defined in the GetTime()
function description.
@retval EFI_SUCCESS The alarm settings were returned.
@retval EFI_INVALID_PARAMETER Enabled is NULL.
@retval EFI_INVALID_PARAMETER Pending is NULL.
@retval EFI_INVALID_PARAMETER Time is NULL.
@retval EFI_DEVICE_ERROR The wakeup time could not be retrieved due to a hardware error.
@retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
**/ **/
EFI_STATUS EFI_STATUS
@ -110,13 +151,18 @@ EfiGetWakeupTime (
/** /**
Set current wakeup alarm clock. Sets the system wakeup alarm clock time.
@param Enable Enable or disable current alarm clock.. @param Enable Enable or disable the wakeup alarm.
@param Time Point to alarm clock setting. @param Time If Enable is TRUE, the time to set the wakeup alarm for. Type EFI_TIME
is defined in the GetTime() function description. If Enable is FALSE,
then this parameter is optional, and may be NULL.
@retval EFI_SUCCESS Success to execute the function. @retval EFI_SUCCESS If Enable is TRUE, then the wakeup alarm was enabled.
@retval !EFI_SUCCESS Failed to execute the function. If Enable is FALSE, then the wakeup alarm was disabled.
@retval EFI_INVALID_PARAMETER A time field is out of range.
@retval EFI_DEVICE_ERROR The wakeup time could not be set due to a hardware error.
@retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
**/ **/
EFI_STATUS EFI_STATUS
@ -142,9 +188,16 @@ EfiSetWakeupTime (
As output, point to the actual size of the returned Data-Buffer. As output, point to the actual size of the returned Data-Buffer.
@param Data Point to return Data-Buffer. @param Data Point to return Data-Buffer.
@retval EFI_SUCCESS Success to execute the function. @retval EFI_SUCCESS The function completed successfully.
@retval !EFI_SUCCESS Failed to execute the function. @retval EFI_NOT_FOUND The variable was not found.
@retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result. DataSize has
been updated with the size needed to complete the request.
@retval EFI_INVALID_PARAMETER VariableName is NULL.
@retval EFI_INVALID_PARAMETER VendorGuid is NULL.
@retval EFI_INVALID_PARAMETER DataSize is NULL.
@retval EFI_INVALID_PARAMETER The DataSize is not too small and Data is NULL.
@retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
@retval EFI_SECURITY_VIOLATION The variable could not be retrieved due to an authentication failure.
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
@ -173,8 +226,15 @@ EfiGetVariable (
GetNextVriableName(). GetNextVriableName().
As output, returns the VendorGuid of the current variable. As output, returns the VendorGuid of the current variable.
@retval EFI_SUCCESS Success to execute the function. @retval EFI_SUCCESS The function completed successfully.
@retval !EFI_SUCCESS Failed to execute the function. @retval EFI_NOT_FOUND The next variable was not found.
@retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.
VariableNameSize has been updated with the size needed
to complete the request.
@retval EFI_INVALID_PARAMETER VariableNameSize is NULL.
@retval EFI_INVALID_PARAMETER VariableName is NULL.
@retval EFI_INVALID_PARAMETER VendorGuid is NULL.
@retval EFI_DEVICE_ERROR The variable name could not be retrieved due to a hardware error.
**/ **/
EFI_STATUS EFI_STATUS
@ -200,8 +260,19 @@ EfiGetNextVariableName (
@param DataSize The size in bytes of Data-Buffer. @param DataSize The size in bytes of Data-Buffer.
@param Data Point to the content of the variable. @param Data Point to the content of the variable.
@retval EFI_SUCCESS Success to execute the function. @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as
@retval !EFI_SUCCESS Failed to execute the function. defined by the Attributes.
@retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied, or the
DataSize exceeds the maximum allowed.
@retval EFI_INVALID_PARAMETER VariableName is an empty Unicode string.
@retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
@retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure.
@retval EFI_WRITE_PROTECTED The variable in question is read-only.
@retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.
@retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS
set but the AuthInfo does NOT pass the validation check carried
out by the firmware.
@retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.
**/ **/
EFI_STATUS EFI_STATUS
@ -223,8 +294,9 @@ EfiSetVariable (
@param HighCount Pointer to returned value. @param HighCount Pointer to returned value.
@retval EFI_SUCCESS Success to execute the function. @retval EFI_SUCCESS The next high monotonic count was returned.
@retval !EFI_SUCCESS Failed to execute the function. @retval EFI_DEVICE_ERROR The device is not functioning properly.
@retval EFI_INVALID_PARAMETER HighCount is NULL.
**/ **/
EFI_STATUS EFI_STATUS
@ -238,15 +310,18 @@ EfiGetNextHighMonotonicCount (
/** /**
Determines the new virtual address that is to be used on subsequent memory accesses. This service converts a function pointer from physical to virtual addressing.
@param DebugDisposition Supplies type information for the pointer being converted. @param DebugDisposition Supplies type information for the pointer being converted.
@param Address The pointer to a pointer that is to be fixed to be the @param Address The pointer to a pointer that is to be fixed to be the
value needed for the new virtual address mapping being value needed for the new virtual address mapping being
applied. applied.
@retval EFI_SUCCESS Success to execute the function. @retval EFI_SUCCESS The pointer pointed to by Address was modified.
@retval !EFI_SUCCESS Failed to execute the function. @retval EFI_NOT_FOUND The pointer pointed to by Address was not found to be part of
the current memory map. This is normally fatal.
@retval EFI_INVALID_PARAMETER Address is NULL.
@retval EFI_INVALID_PARAMETER *Address is NULL and DebugDispositio
**/ **/
EFI_STATUS EFI_STATUS
@ -279,8 +354,7 @@ EfiConvertPointer (
value needed for the new virtual address mapping being value needed for the new virtual address mapping being
applied. applied.
@retval EFI_SUCCESS Success to execute the function. @return EFI_STATUS value from EfiConvertPointer().
@retval !EFI_SUCCESS Failed to execute the function.
**/ **/
EFI_STATUS EFI_STATUS
@ -295,13 +369,17 @@ EfiConvertFunctionPointer (
/** /**
Conver the standard Lib double linked list to a virtual mapping. Convert the standard Lib double linked list to a virtual mapping.
This service uses EfiConvertPointer() to walk a double linked list and convert all the link
pointers to their virtual mappings. This function is only guaranteed to work during the
EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event and calling it at other times has undefined results.
@param DebugDisposition Supplies type information for the pointer being converted. @param DebugDisposition Supplies type information for the pointer being converted.
@param ListHead Head of linked list to convert. @param ListHead Head of linked list to convert.
@retval EFI_SUCCESS Success to execute the function. @retval EFI_SUCCESS Success to execute the function.
@retval !EFI_SUCCESS Failed to execute the function. @retval !EFI_SUCCESS Failed to e3xecute the function.
**/ **/
EFI_STATUS EFI_STATUS
@ -408,11 +486,13 @@ EfiSetVirtualAddressMap (
CapsuleHeaderArray. This parameter is only referenced if CapsuleHeaderArray. This parameter is only referenced if
the capsules are defined to persist across system reset. the capsules are defined to persist across system reset.
@retval EFI_SUCCESS Valid capsule was passed. I Valid capsule was passed. If @retval EFI_SUCCESS Valid capsule was passed. If CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set,
CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set, the the capsule has been successfully processed by the firmware.
capsule has been successfully processed by the firmware. @retval EFI_INVALID_PARAMETER CapsuleSize or HeaderSize is NULL.
@retval EFI_INVALID_PARAMETER CapsuleSize is NULL or ResetTye is NULL. @retval EFI_INVALID_PARAMETER CapsuleCount is 0
@retval EFI_DEVICE_ERROR The capsule update was started, but failed due to a device error. @retval EFI_DEVICE_ERROR The capsule update was started, but failed due to a device error.
@retval EFI_UNSUPPORTED The capsule type is not supported on this platform.
@retval EFI_OUT_OF_RESOURCES There were insufficient resources to process the capsule.
**/ **/
EFI_STATUS EFI_STATUS
@ -481,6 +561,8 @@ EfiQueryCapsuleCapabilities (
/** /**
Returns information about the EFI variables.
The QueryVariableInfo() function allows a caller to obtain the information about the The QueryVariableInfo() function allows a caller to obtain the information about the
maximum size of the storage space available for the EFI variables, the remaining size of the storage maximum size of the storage space available for the EFI variables, the remaining size of the storage
space available for the EFI variables and the maximum size of each individual EFI variable, space available for the EFI variables and the maximum size of each individual EFI variable,