| /** @file | |
| MDE UEFI library functions and macros | |
| Copyright (c) 2006, Intel Corporation | |
| All rights reserved. This program and the accompanying materials | |
| are licensed and made available under the terms and conditions of the BSD License | |
| which accompanies this distribution. The full text of the license may be found at | |
| http://opensource.org/licenses/bsd-license.php | |
| THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, | |
| WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. | |
| **/ | |
| #ifndef __UEFI_LIB_H__ | |
| #define __UEFI_LIB_H__ | |
| // | |
| // Unicode String Table | |
| // | |
| typedef struct { | |
| CHAR8 *Language; | |
| CHAR16 *UnicodeString; | |
| } EFI_UNICODE_STRING_TABLE; | |
| // | |
| // EFI Lock Status | |
| // | |
| typedef enum { | |
| EfiLockUninitialized = 0, | |
| EfiLockReleased = 1, | |
| EfiLockAcquired = 2 | |
| } EFI_LOCK_STATE; | |
| // | |
| // EFI Lock | |
| // | |
| typedef struct { | |
| EFI_TPL Tpl; | |
| EFI_TPL OwnerTpl; | |
| EFI_LOCK_STATE Lock; | |
| } EFI_LOCK; | |
| /** | |
| 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. | |
| @param TableGuid Pointer to table's GUID type.. | |
| @param Table Pointer to the table associated with TableGuid in the EFI System Table. | |
| @retval EFI_SUCCESS A configuration table matching TableGuid was found. | |
| @retval EFI_NOT_FOUND A configuration table matching TableGuid could not be found. | |
| **/ | |
| EFI_STATUS | |
| EFIAPI | |
| EfiGetSystemConfigurationTable ( | |
| IN EFI_GUID *TableGuid, | |
| OUT VOID **Table | |
| ); | |
| /** | |
| 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. | |
| @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 NotifyFunction Supplies the function to notify when the event is signaled. | |
| @param NotifyContext The context parameter to pass to NotifyFunction. | |
| @param Registration A pointer to a memory location to receive the registration value. | |
| @return The notification event that was created. | |
| **/ | |
| EFI_EVENT | |
| EFIAPI | |
| EfiCreateProtocolNotifyEvent( | |
| IN EFI_GUID *ProtocolGuid, | |
| IN EFI_TPL NotifyTpl, | |
| IN EFI_EVENT_NOTIFY NotifyFunction, | |
| IN VOID *NotifyContext, OPTIONAL | |
| OUT VOID *Registration | |
| ); | |
| /** | |
| This function creates an event using NotifyTpl, NoifyFunction, and NotifyContext. | |
| This event is signaled with EfiNamedEventSignal(). This provide the ability for | |
| one or more listeners on the same event named by the GUID specified by Name. | |
| @param Name Supplies GUID name of the event. | |
| @param NotifyTpl Supplies the task priority level of the event notifications. | |
| @param NotifyFunction Supplies the function to notify when the event is signaled. | |
| @param NotifyContext The context parameter to pass to NotifyFunction. | |
| @param Registration A pointer to a memory location to receive the registration value. | |
| @retval EFI_SUCCESS A named event was created. | |
| @retval EFI_OUT_OF_RESOURCES There are not enough resource to create the named event. | |
| **/ | |
| EFI_STATUS | |
| EFIAPI | |
| EfiNamedEventListen ( | |
| IN CONST EFI_GUID *Name, | |
| IN EFI_TPL NotifyTpl, | |
| IN EFI_EVENT_NOTIFY NotifyFunction, | |
| IN CONST VOID *NotifyContext, OPTIONAL | |
| OUT VOID *Registration OPTIONAL | |
| ); | |
| /** | |
| This function signals the named event specified by Name. The named event must | |
| have been created with EfiNamedEventListen(). | |
| @param Name Supplies GUID name of the event. | |
| @retval EFI_SUCCESS A named event was signaled. | |
| @retval EFI_OUT_OF_RESOURCES There are not enough resource to signal the named event. | |
| **/ | |
| EFI_STATUS | |
| EFIAPI | |
| EfiNamedEventSignal ( | |
| IN CONST EFI_GUID *Name | |
| ); | |
| /** | |
| 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, | |
| acquiring the lock only consists of raising to the locks TPL. | |
| @param Lock A pointer to the lock data structure to initialize. | |
| @param Priority EFI TPL associated with the lock. | |
| @return The lock. | |
| **/ | |
| EFI_LOCK * | |
| EFIAPI | |
| EfiInitializeLock ( | |
| IN OUT EFI_LOCK *Lock, | |
| IN EFI_TPL Priority | |
| ); | |
| /** | |
| This macro initializes the contents of a basic mutual exclusion lock to the | |
| released state. Each lock provides mutual exclusion access at its task | |
| priority level. Since there is no preemption or multiprocessor support in EFI, | |
| acquiring the lock only consists of raising to the locks TPL. | |
| @param Lock A pointer to the lock data structure to initialize. | |
| @param Priority The task priority level of the lock. | |
| @return The lock. | |
| **/ | |
| #define EFI_INITIALIZE_LOCK_VARIABLE(Priority) \ | |
| {Priority, EFI_TPL_APPLICATION, EfiLockReleased } | |
| /** | |
| Macro that calls DebugAssert() if an EFI_LOCK structure is not in the locked state. | |
| If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set, | |
| 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 | |
| filename, source line number, and Lock. | |
| If Lock is NULL, then ASSERT(). | |
| @param LockParameter A pointer to the lock to acquire. | |
| **/ | |
| #define ASSERT_LOCKED(LockParameter) \ | |
| do { \ | |
| if (DebugAssertEnabled ()) { \ | |
| ASSERT (LockParameter != NULL); \ | |
| if ((LockParameter)->Lock != EfiLockAcquired) { \ | |
| _ASSERT (LockParameter not locked); \ | |
| } \ | |
| } \ | |
| } while (FALSE) | |
| /** | |
| 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. | |
| @param Priority The task priority level of the lock. | |
| **/ | |
| VOID | |
| EFIAPI | |
| EfiAcquireLock ( | |
| IN EFI_LOCK *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. | |
| @param Lock A pointer to the lock to acquire. | |
| @retval EFI_SUCCESS The lock was acquired. | |
| @retval EFI_ACCESS_DENIED The lock could not be acquired because it is already owned. | |
| **/ | |
| EFI_STATUS | |
| EFIAPI | |
| EfiAcquireLockOrFail ( | |
| IN EFI_LOCK *Lock | |
| ); | |
| /** | |
| 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. | |
| @param Lock A pointer to the lock to release. | |
| **/ | |
| VOID | |
| EFIAPI | |
| EfiReleaseLock ( | |
| IN EFI_LOCK *Lock | |
| ); | |
| /** | |
| 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 language code for the | |
| Unicode string to look up and return. | |
| @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 from UnicodeStringTable | |
| that matches the language specified by Language. | |
| @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. | |
| @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 of SupportedLanguages. | |
| @retval EFI_UNSUPPORTED The language specified by Language is not | |
| supported by UnicodeStringTable. | |
| **/ | |
| EFI_STATUS | |
| EFIAPI | |
| LookupUnicodeString ( | |
| IN CONST CHAR8 *Language, | |
| IN CONST CHAR8 *SupportedLanguages, | |
| IN CONST EFI_UNICODE_STRING_TABLE *UnicodeStringTable, | |
| OUT CHAR16 **UnicodeString | |
| ); | |
| /** | |
| This function adds a Unicode string 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. | |
| @param Language A pointer to the ISO 639-2 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. | |
| @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. | |
| **/ | |
| EFI_STATUS | |
| EFIAPI | |
| AddUnicodeString ( | |
| IN CONST CHAR8 *Language, | |
| IN CONST CHAR8 *SupportedLanguages, | |
| IN EFI_UNICODE_STRING_TABLE **UnicodeStringTable, | |
| IN CONST CHAR16 *UnicodeString | |
| ); | |
| /** | |
| This function frees the table of Unicode strings in UnicodeStringTable. | |
| If UnicodeStringTable is NULL, then EFI_SUCCESS is returned. | |
| Otherwise, each language code, and each Unicode string in the Unicode string | |
| table are freed, and EFI_SUCCESS is returned. | |
| @param UnicodeStringTable A pointer to the table of Unicode strings. | |
| @retval EFI_SUCCESS The Unicode string table was freed. | |
| **/ | |
| EFI_STATUS | |
| EFIAPI | |
| FreeUnicodeStringTable ( | |
| IN EFI_UNICODE_STRING_TABLE *UnicodeStringTable | |
| ); | |
| /** | |
| This function computes and returns the width of the Unicode character | |
| specified by UnicodeChar. | |
| @param UnicodeChar A Unicode character. | |
| @retval 0 The width if UnicodeChar could not be determined. | |
| @retval 1 UnicodeChar is a narrow glyph. | |
| @retval 2 UnicodeChar is a wide glyph. | |
| **/ | |
| UINTN | |
| EFIAPI | |
| GetGlyphWidth ( | |
| IN CHAR16 UnicodeChar | |
| ); | |
| /** | |
| 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. | |
| @param String A pointer to a Null-terminated Unicode string. | |
| @return The display length of the Null-terminated Unicode string specified by String. | |
| **/ | |
| UINTN | |
| EFIAPI | |
| UnicodeStringDisplayLength ( | |
| IN CONST CHAR16 *String | |
| ); | |
| // | |
| // Functions that abstract early Framework contamination of UEFI. | |
| // | |
| /** | |
| Signal a Ready to Boot Event. | |
| Create a Ready to Boot Event. Signal it and close it. This causes other | |
| events of the same event group to be signaled in other modules. | |
| **/ | |
| VOID | |
| EFIAPI | |
| EfiSignalEventReadyToBoot ( | |
| VOID | |
| ); | |
| /** | |
| Signal a Legacy Boot Event. | |
| Create a legacy Boot Event. Signal it and close it. This causes other | |
| events of the same event group to be signaled in other modules. | |
| **/ | |
| VOID | |
| EFIAPI | |
| EfiSignalEventLegacyBoot ( | |
| VOID | |
| ); | |
| /** | |
| Create a Legacy Boot Event. | |
| Tiano extended the CreateEvent Type enum to add a legacy boot event type. | |
| This was bad as Tiano did not own the enum. In UEFI 2.0 CreateEventEx was | |
| added and now it's possible to not voilate the UEFI specification by | |
| declaring a GUID for the legacy boot event class. This library supports | |
| the R8.5/EFI 1.10 form and R9/UEFI 2.0 form and allows common code to | |
| work both ways. | |
| @param LegacyBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex). | |
| @retval EFI_SUCCESS Event was created. | |
| @retval Other Event was not created. | |
| **/ | |
| EFI_STATUS | |
| EFIAPI | |
| EfiCreateEventLegacyBoot ( | |
| OUT EFI_EVENT *LegacyBootEvent | |
| ); | |
| /** | |
| Create a Read to Boot Event. | |
| Tiano extended the CreateEvent Type enum to add a ready to boot event type. | |
| This was bad as Tiano did not own the enum. In UEFI 2.0 CreateEventEx was | |
| added and now it's possible to not voilate the UEFI specification and use | |
| the ready to boot event class defined in UEFI 2.0. This library supports | |
| the R8.5/EFI 1.10 form and R9/UEFI 2.0 form and allows common code to | |
| work both ways. | |
| @param LegacyBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex). | |
| @retval EFI_SUCCESS Event was created. | |
| @retval Other Event was not created. | |
| **/ | |
| EFI_STATUS | |
| EFIAPI | |
| EfiCreateEventReadyToBoot ( | |
| OUT EFI_EVENT *ReadyToBootEvent | |
| ); | |
| /** | |
| Initialize a Firmware Volume (FV) Media Device Path node. | |
| Tiano extended the EFI 1.10 device path nodes. Tiano does not own this enum | |
| so as we move to UEFI 2.0 support we must use a mechanism that conforms with | |
| the UEFI 2.0 specification to define the FV device path. An UEFI GUIDed | |
| device path is defined for PIWG extensions of device path. If the code | |
| is compiled to conform with the UEFI 2.0 specification use the new device path | |
| else use the old form for backwards compatability. | |
| @param FvDevicePathNode Pointer to a FV device path node to initialize | |
| @param NameGuid FV file name to use in FvDevicePathNode | |
| **/ | |
| VOID | |
| EFIAPI | |
| EfiInitializeFwVolDevicepathNode ( | |
| IN OUT MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *FvDevicePathNode, | |
| IN CONST EFI_GUID *NameGuid | |
| ); | |
| /** | |
| Check to see if the Firmware Volume (FV) Media Device Path is valid | |
| Tiano extended the EFI 1.10 device path nodes. Tiano does not own this enum | |
| so as we move to UEFI 2.0 support we must use a mechanism that conforms with | |
| the UEFI 2.0 specification to define the FV device path. An UEFI GUIDed | |
| device path is defined for PIWG extensions of device path. If the code | |
| is compiled to conform with the UEFI 2.0 specification use the new device path | |
| else use the old form for backwards compatability. The return value to this | |
| function points to a location in FvDevicePathNode and it does not allocate | |
| new memory for the GUID pointer that is returned. | |
| @param FvDevicePathNode Pointer to FV device path to check. | |
| @retval NULL FvDevicePathNode is not valid. | |
| @retval Other FvDevicePathNode is valid and pointer to NameGuid was returned. | |
| **/ | |
| EFI_GUID * | |
| EFIAPI | |
| EfiGetNameGuidFromFwVolDevicePathNode ( | |
| IN CONST MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *FvDevicePathNode | |
| ); | |
| #endif |