| /** @file | |
| Framework to UEFI 2.1 HII Thunk. The driver consume UEFI HII protocols | |
| to produce a Framework HII protocol. | |
| Copyright (c) 2008 - 2014, Intel Corporation. All rights reserved.<BR> | |
| 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. | |
| **/ | |
| #include "HiiDatabase.h" | |
| #include "HiiHandle.h" | |
| HII_THUNK_PRIVATE_DATA *mHiiThunkPrivateData; | |
| HII_THUNK_PRIVATE_DATA mHiiThunkPrivateDataTempate = { | |
| HII_THUNK_PRIVATE_DATA_SIGNATURE, | |
| (EFI_HANDLE) NULL, | |
| { | |
| HiiNewPack, | |
| HiiRemovePack, | |
| HiiFindHandles, | |
| HiiExportDatabase, | |
| HiiTestString, | |
| HiiGetGlyph, | |
| HiiGlyphToBlt, | |
| HiiNewString, | |
| HiiGetPrimaryLanguages, | |
| HiiGetSecondaryLanguages, | |
| HiiThunkGetString, | |
| HiiResetStrings, | |
| HiiGetLine, | |
| HiiGetForms, | |
| HiiGetDefaultImage, | |
| HiiThunkUpdateForm, | |
| HiiGetKeyboardLayout | |
| }, | |
| { | |
| /// | |
| /// HiiHandleLinkList | |
| /// | |
| NULL, NULL | |
| }, | |
| }; | |
| EFI_FORMBROWSER_THUNK_PRIVATE_DATA mBrowserThunkPrivateDataTemplate = { | |
| EFI_FORMBROWSER_THUNK_PRIVATE_DATA_SIGNATURE, | |
| (EFI_HANDLE) NULL, | |
| (HII_THUNK_PRIVATE_DATA *) NULL, | |
| { | |
| ThunkSendForm, | |
| ThunkCreatePopUp | |
| } | |
| }; | |
| CONST EFI_HII_DATABASE_PROTOCOL *mHiiDatabase; | |
| CONST EFI_HII_IMAGE_PROTOCOL *mHiiImageProtocol; | |
| CONST EFI_HII_STRING_PROTOCOL *mHiiStringProtocol; | |
| CONST EFI_HII_FONT_PROTOCOL *mHiiFontProtocol; | |
| CONST EFI_HII_CONFIG_ROUTING_PROTOCOL *mHiiConfigRoutingProtocol; | |
| CONST EFI_FORM_BROWSER2_PROTOCOL *mFormBrowser2Protocol; | |
| /** | |
| This routine initializes the HII Database. | |
| @param ImageHandle Image handle for PCD DXE driver. | |
| @param SystemTable Pointer to SystemTable. | |
| @retval EFI_SUCCESS The entry point alwasy return successfully. | |
| **/ | |
| EFI_STATUS | |
| EFIAPI | |
| InitializeHiiDatabase ( | |
| IN EFI_HANDLE ImageHandle, | |
| IN EFI_SYSTEM_TABLE *SystemTable | |
| ) | |
| { | |
| HII_THUNK_PRIVATE_DATA *Private; | |
| EFI_HANDLE Handle; | |
| EFI_STATUS Status; | |
| UINTN BufferLength; | |
| EFI_HII_HANDLE *Buffer; | |
| UINTN Index; | |
| HII_THUNK_CONTEXT *ThunkContext; | |
| ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL, &gEfiHiiCompatibilityProtocolGuid); | |
| ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL, &gEfiFormBrowserCompatibilityProtocolGuid); | |
| Private = AllocateCopyPool (sizeof (HII_THUNK_PRIVATE_DATA), &mHiiThunkPrivateDataTempate); | |
| ASSERT (Private != NULL); | |
| InitializeListHead (&Private->ThunkContextListHead); | |
| InitHiiHandleDatabase (); | |
| mHiiThunkPrivateData = Private; | |
| Status = gBS->LocateProtocol ( | |
| &gEfiHiiDatabaseProtocolGuid, | |
| NULL, | |
| (VOID **) &mHiiDatabase | |
| ); | |
| ASSERT_EFI_ERROR (Status); | |
| Status = gBS->LocateProtocol ( | |
| &gEfiHiiStringProtocolGuid, | |
| NULL, | |
| (VOID **) &mHiiStringProtocol | |
| ); | |
| ASSERT_EFI_ERROR (Status); | |
| Status = gBS->LocateProtocol ( | |
| &gEfiHiiFontProtocolGuid, | |
| NULL, | |
| (VOID **) &mHiiFontProtocol | |
| ); | |
| ASSERT_EFI_ERROR (Status); | |
| Status = gBS->LocateProtocol ( | |
| &gEfiHiiConfigRoutingProtocolGuid, | |
| NULL, | |
| (VOID **) &mHiiConfigRoutingProtocol | |
| ); | |
| ASSERT_EFI_ERROR (Status); | |
| Status = gBS->LocateProtocol ( | |
| &gEfiFormBrowser2ProtocolGuid, | |
| NULL, | |
| (VOID **) &mFormBrowser2Protocol | |
| ); | |
| ASSERT_EFI_ERROR (Status); | |
| // | |
| // Install protocol interface | |
| // | |
| Status = gBS->InstallProtocolInterface ( | |
| &Private->Handle, | |
| &gEfiHiiCompatibilityProtocolGuid, | |
| EFI_NATIVE_INTERFACE, | |
| (VOID *) &Private->Hii | |
| ); | |
| ASSERT_EFI_ERROR (Status); | |
| Status = ListPackageLists (EFI_HII_PACKAGE_STRINGS, NULL, &BufferLength, &Buffer); | |
| if (Status == EFI_SUCCESS) { | |
| ASSERT (Buffer != NULL); | |
| for (Index = 0; Index < BufferLength / sizeof (EFI_HII_HANDLE); Index++) { | |
| ThunkContext = CreateThunkContextForUefiHiiHandle (Buffer[Index]); | |
| ASSERT (ThunkContext!= NULL); | |
| InsertTailList (&Private->ThunkContextListHead, &ThunkContext->Link); | |
| } | |
| FreePool (Buffer); | |
| } | |
| Status = mHiiDatabase->RegisterPackageNotify ( | |
| mHiiDatabase, | |
| EFI_HII_PACKAGE_STRINGS, | |
| NULL, | |
| NewOrAddPackNotify, | |
| EFI_HII_DATABASE_NOTIFY_NEW_PACK, | |
| &Handle | |
| ); | |
| ASSERT_EFI_ERROR (Status); | |
| Status = mHiiDatabase->RegisterPackageNotify ( | |
| mHiiDatabase, | |
| EFI_HII_PACKAGE_STRINGS, | |
| NULL, | |
| NewOrAddPackNotify, | |
| EFI_HII_DATABASE_NOTIFY_ADD_PACK, | |
| &Handle | |
| ); | |
| ASSERT_EFI_ERROR (Status); | |
| Status = mHiiDatabase->RegisterPackageNotify ( | |
| mHiiDatabase, | |
| EFI_HII_PACKAGE_FORMS, | |
| NULL, | |
| NewOrAddPackNotify, | |
| EFI_HII_DATABASE_NOTIFY_NEW_PACK, | |
| &Handle | |
| ); | |
| ASSERT_EFI_ERROR (Status); | |
| Status = mHiiDatabase->RegisterPackageNotify ( | |
| mHiiDatabase, | |
| EFI_HII_PACKAGE_FORMS, | |
| NULL, | |
| NewOrAddPackNotify, | |
| EFI_HII_DATABASE_NOTIFY_ADD_PACK, | |
| &Handle | |
| ); | |
| ASSERT_EFI_ERROR (Status); | |
| Status = mHiiDatabase->RegisterPackageNotify ( | |
| mHiiDatabase, | |
| EFI_HII_PACKAGE_STRINGS, | |
| NULL, | |
| RemovePackNotify, | |
| EFI_HII_DATABASE_NOTIFY_REMOVE_PACK, | |
| &Handle | |
| ); | |
| ASSERT_EFI_ERROR (Status); | |
| InitSetBrowserStrings (); | |
| mBrowserThunkPrivateDataTemplate.ThunkPrivate = Private; | |
| Status = gBS->InstallProtocolInterface ( | |
| &mBrowserThunkPrivateDataTemplate.Handle, | |
| &gEfiFormBrowserCompatibilityProtocolGuid, | |
| EFI_NATIVE_INTERFACE, | |
| (VOID *) &mBrowserThunkPrivateDataTemplate.FormBrowser | |
| ); | |
| ASSERT_EFI_ERROR (Status); | |
| return Status; | |
| } | |
| /** | |
| Determines the handles that are currently active in the database. | |
| This function determines the handles that are currently active in the database. | |
| For example, a program wishing to create a Setup-like configuration utility would use this call | |
| to determine the handles that are available. It would then use calls defined in the forms section | |
| below to extract forms and then interpret them. | |
| @param This A pointer to the EFI_HII_PROTOCOL instance. | |
| @param HandleBufferLength On input, a pointer to the length of the handle buffer. | |
| On output, the length of the handle buffer that is required for the handles found. | |
| @param Handle Pointer to an array of EFI_HII_HANDLE instances returned. | |
| Type EFI_HII_HANDLE is defined in EFI_HII_PROTOCOL.NewPack() in the Packages section. | |
| @retval EFI_SUCCESS Handle was updated successfully. | |
| @retval EFI_BUFFER_TOO_SMALL The HandleBufferLength parameter indicates that Handle is too small | |
| to support the number of handles. HandleBufferLength is updated with a value that | |
| will enable the data to fit. | |
| **/ | |
| EFI_STATUS | |
| EFIAPI | |
| HiiFindHandles ( | |
| IN EFI_HII_PROTOCOL *This, | |
| IN OUT UINT16 *HandleBufferLength, | |
| OUT FRAMEWORK_EFI_HII_HANDLE *Handle | |
| ) | |
| { | |
| UINT16 Count; | |
| LIST_ENTRY *Link; | |
| HII_THUNK_CONTEXT *ThunkContext; | |
| HII_THUNK_PRIVATE_DATA *Private; | |
| if (HandleBufferLength == NULL) { | |
| return EFI_INVALID_PARAMETER; | |
| } | |
| Private = HII_THUNK_PRIVATE_DATA_FROM_THIS(This); | |
| // | |
| // Count the number of handles. | |
| // | |
| Count = 0; | |
| Link = GetFirstNode (&Private->ThunkContextListHead); | |
| while (!IsNull (&Private->ThunkContextListHead, Link)) { | |
| Count++; | |
| Link = GetNextNode (&Private->ThunkContextListHead, Link); | |
| } | |
| if (Count > *HandleBufferLength) { | |
| *HandleBufferLength = (UINT16) (Count * sizeof (FRAMEWORK_EFI_HII_HANDLE)); | |
| return EFI_BUFFER_TOO_SMALL; | |
| } | |
| // | |
| // Output the handles. | |
| // | |
| Count = 0; | |
| Link = GetFirstNode (&Private->ThunkContextListHead); | |
| while (!IsNull (&Private->ThunkContextListHead, Link)) { | |
| ThunkContext = HII_THUNK_CONTEXT_FROM_LINK (Link); | |
| Handle[Count] = ThunkContext->FwHiiHandle; | |
| Count++; | |
| Link = GetNextNode (&Private->ThunkContextListHead, Link); | |
| } | |
| *HandleBufferLength = (UINT16) (Count * sizeof (FRAMEWORK_EFI_HII_HANDLE)); | |
| return EFI_SUCCESS; | |
| } | |
| /** | |
| Allows a program to determine the primary languages that are supported on a given handle. | |
| This routine is intended to be used by drivers to query the interface database for supported languages. | |
| This routine returns a string of concatenated 3-byte language identifiers, one per string package associated with the handle. | |
| @param This A pointer to the EFI_HII_PROTOCOL instance. | |
| @param Handle The handle on which the strings reside. Type EFI_HII_HANDLE is defined in EFI_HII_PROTOCOL.NewPack() | |
| in the Packages section. | |
| @param LanguageString A string allocated by GetPrimaryLanguages() that contains a list of all primary languages | |
| registered on the handle. The routine will not return the three-spaces language identifier used in | |
| other functions to indicate non-language-specific strings. | |
| @retval EFI_SUCCESS LanguageString was correctly returned. | |
| @retval EFI_INVALID_PARAMETER The Handle was unknown. | |
| **/ | |
| EFI_STATUS | |
| EFIAPI | |
| HiiGetPrimaryLanguages ( | |
| IN EFI_HII_PROTOCOL *This, | |
| IN FRAMEWORK_EFI_HII_HANDLE Handle, | |
| OUT EFI_STRING *LanguageString | |
| ) | |
| { | |
| HII_THUNK_PRIVATE_DATA *Private; | |
| EFI_HII_HANDLE UefiHiiHandle; | |
| CHAR8 *LangCodes4646; | |
| CHAR16 *UnicodeLangCodes639; | |
| CHAR8 *LangCodes639; | |
| EFI_STATUS Status; | |
| Private = HII_THUNK_PRIVATE_DATA_FROM_THIS(This); | |
| UefiHiiHandle = FwHiiHandleToUefiHiiHandle (Private, Handle); | |
| if (UefiHiiHandle == NULL) { | |
| return EFI_INVALID_PARAMETER; | |
| } | |
| LangCodes4646 = HiiGetSupportedLanguages (UefiHiiHandle); | |
| if (LangCodes4646 == NULL) { | |
| return EFI_INVALID_PARAMETER; | |
| } | |
| LangCodes639 = ConvertLanguagesRfc4646ToIso639 (LangCodes4646); | |
| if (LangCodes639 == NULL) { | |
| Status = EFI_INVALID_PARAMETER; | |
| goto Done; | |
| } | |
| UnicodeLangCodes639 = AllocateZeroPool (AsciiStrSize (LangCodes639) * sizeof (CHAR16)); | |
| if (UnicodeLangCodes639 == NULL) { | |
| Status = EFI_OUT_OF_RESOURCES; | |
| goto Done; | |
| } | |
| // | |
| // The language returned is in RFC 639-2 format. | |
| // | |
| AsciiStrToUnicodeStr (LangCodes639, UnicodeLangCodes639); | |
| *LanguageString = UnicodeLangCodes639; | |
| Status = EFI_SUCCESS; | |
| Done: | |
| FreePool (LangCodes4646); | |
| if (LangCodes639 != NULL) { | |
| FreePool (LangCodes639); | |
| } | |
| return Status; | |
| } | |
| /** | |
| This function returns the list of supported 2nd languages, in the format specified | |
| in UEFI specification Appendix M. | |
| If HiiHandle is not a valid Handle in the HII database, then ASSERT. | |
| If not enough resource to complete the operation, then ASSERT. | |
| @param HiiHandle The HII package list handle. | |
| @param PrimaryLanguage Pointer to language name buffer. | |
| @return The supported languages. | |
| **/ | |
| CHAR8 * | |
| EFIAPI | |
| HiiGetSupportedSecondaryLanguages ( | |
| IN EFI_HII_HANDLE HiiHandle, | |
| IN CONST CHAR8 *PrimaryLanguage | |
| ) | |
| { | |
| EFI_STATUS Status; | |
| UINTN BufferSize; | |
| CHAR8 *LanguageString; | |
| ASSERT (HiiHandle != NULL); | |
| // | |
| // Collect current supported 2nd Languages for given HII handle | |
| // First try allocate 4K buffer to store the current supported 2nd languages. | |
| // | |
| BufferSize = 0x1000; | |
| LanguageString = AllocateZeroPool (BufferSize); | |
| if (LanguageString == NULL) { | |
| return NULL; | |
| } | |
| Status = mHiiStringProtocol->GetSecondaryLanguages (mHiiStringProtocol, HiiHandle, PrimaryLanguage, LanguageString, &BufferSize); | |
| ASSERT (Status != EFI_NOT_FOUND); | |
| if (Status == EFI_BUFFER_TOO_SMALL) { | |
| FreePool (LanguageString); | |
| LanguageString = AllocateZeroPool (BufferSize); | |
| if (LanguageString == NULL) { | |
| return NULL; | |
| } | |
| Status = mHiiStringProtocol->GetSecondaryLanguages (mHiiStringProtocol, HiiHandle, PrimaryLanguage, LanguageString, &BufferSize); | |
| } | |
| if (EFI_ERROR (Status)) { | |
| LanguageString = NULL; | |
| } | |
| return LanguageString; | |
| } | |
| /** | |
| Allows a program to determine which secondary languages are supported on a given handle for a given primary language | |
| This routine is intended to be used by drivers to query the interface database for supported languages. | |
| This routine returns a string of concatenated 3-byte language identifiers, one per string package associated with the handle. | |
| @param This A pointer to the EFI_HII_PROTOCOL instance. | |
| @param Handle The handle on which the strings reside. Type EFI_HII_HANDLE is defined in EFI_HII_PROTOCOL.NewPack() | |
| in the Packages section. | |
| @param PrimaryLanguage Pointer to a NULL-terminated string containing a single ISO 639-2 language identifier, indicating | |
| the primary language. | |
| @param LanguageString A string allocated by GetSecondaryLanguages() containing a list of all secondary languages registered | |
| on the handle. The routine will not return the three-spaces language identifier used in other functions | |
| to indicate non-language-specific strings, nor will it return the primary language. This function succeeds | |
| but returns a NULL LanguageString if there are no secondary languages associated with the input Handle and | |
| PrimaryLanguage pair. Type EFI_STRING is defined in String. | |
| @retval EFI_SUCCESS LanguageString was correctly returned. | |
| @retval EFI_INVALID_PARAMETER The Handle was unknown. | |
| **/ | |
| EFI_STATUS | |
| EFIAPI | |
| HiiGetSecondaryLanguages ( | |
| IN EFI_HII_PROTOCOL *This, | |
| IN FRAMEWORK_EFI_HII_HANDLE Handle, | |
| IN CHAR16 *PrimaryLanguage, | |
| OUT EFI_STRING *LanguageString | |
| ) | |
| { | |
| HII_THUNK_PRIVATE_DATA *Private; | |
| EFI_HII_HANDLE UefiHiiHandle; | |
| CHAR8 *PrimaryLang4646; | |
| CHAR8 *PrimaryLang639; | |
| CHAR8 *SecLangCodes4646; | |
| CHAR8 *SecLangCodes639; | |
| CHAR16 *UnicodeSecLangCodes639; | |
| EFI_STATUS Status; | |
| Private = HII_THUNK_PRIVATE_DATA_FROM_THIS(This); | |
| SecLangCodes639 = NULL; | |
| SecLangCodes4646 = NULL; | |
| PrimaryLang4646 = NULL; | |
| UnicodeSecLangCodes639 = NULL; | |
| UefiHiiHandle = FwHiiHandleToUefiHiiHandle (Private, Handle); | |
| if (UefiHiiHandle == NULL) { | |
| return EFI_INVALID_PARAMETER; | |
| } | |
| PrimaryLang639 = AllocateZeroPool (StrLen (PrimaryLanguage) + 1); | |
| if (PrimaryLang639 == NULL) { | |
| Status = EFI_OUT_OF_RESOURCES; | |
| goto Done; | |
| } | |
| UnicodeStrToAsciiStr (PrimaryLanguage, PrimaryLang639); | |
| PrimaryLang4646 = ConvertLanguagesIso639ToRfc4646 (PrimaryLang639); | |
| ASSERT (PrimaryLang4646 != NULL); | |
| SecLangCodes4646 = HiiGetSupportedSecondaryLanguages (UefiHiiHandle, PrimaryLang4646); | |
| if (SecLangCodes4646 == NULL) { | |
| Status = EFI_INVALID_PARAMETER; | |
| goto Done; | |
| } | |
| SecLangCodes639 = ConvertLanguagesIso639ToRfc4646 (SecLangCodes4646); | |
| if (SecLangCodes639 == NULL) { | |
| Status = EFI_INVALID_PARAMETER; | |
| goto Done; | |
| } | |
| UnicodeSecLangCodes639 = AllocateZeroPool (AsciiStrSize (SecLangCodes639) * sizeof (CHAR16)); | |
| if (UnicodeSecLangCodes639 == NULL) { | |
| Status = EFI_OUT_OF_RESOURCES; | |
| goto Done; | |
| } | |
| // | |
| // The language returned is in RFC 4646 format. | |
| // | |
| *LanguageString = AsciiStrToUnicodeStr (SecLangCodes639, UnicodeSecLangCodes639); | |
| Status = EFI_SUCCESS; | |
| Done: | |
| if (PrimaryLang639 != NULL) { | |
| FreePool (PrimaryLang639); | |
| } | |
| if (SecLangCodes639 != NULL) { | |
| FreePool (SecLangCodes639); | |
| } | |
| if (PrimaryLang4646 != NULL) { | |
| FreePool (PrimaryLang4646); | |
| } | |
| if (SecLangCodes4646 != NULL) { | |
| FreePool (SecLangCodes4646); | |
| } | |
| if (UnicodeSecLangCodes639 != NULL) { | |
| FreePool (UnicodeSecLangCodes639); | |
| } | |
| return Status; | |
| } | |