2 Framework to UEFI 2.1 HII Thunk. The driver consume UEFI HII protocols
3 to produce a Framework HII protocol.
5 Copyright (c) 2008 - 2011, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #include "HiiDatabase.h"
17 #include "HiiHandle.h"
19 HII_THUNK_PRIVATE_DATA
*mHiiThunkPrivateData
;
21 HII_THUNK_PRIVATE_DATA mHiiThunkPrivateDataTempate
= {
22 HII_THUNK_PRIVATE_DATA_SIGNATURE
,
35 HiiGetPrimaryLanguages
,
36 HiiGetSecondaryLanguages
,
55 EFI_FORMBROWSER_THUNK_PRIVATE_DATA mBrowserThunkPrivateDataTemplate
= {
56 EFI_FORMBROWSER_THUNK_PRIVATE_DATA_SIGNATURE
,
58 (HII_THUNK_PRIVATE_DATA
*) NULL
,
66 CONST EFI_HII_DATABASE_PROTOCOL
*mHiiDatabase
;
67 CONST EFI_HII_IMAGE_PROTOCOL
*mHiiImageProtocol
;
68 CONST EFI_HII_STRING_PROTOCOL
*mHiiStringProtocol
;
69 CONST EFI_HII_FONT_PROTOCOL
*mHiiFontProtocol
;
70 CONST EFI_HII_CONFIG_ROUTING_PROTOCOL
*mHiiConfigRoutingProtocol
;
71 CONST EFI_FORM_BROWSER2_PROTOCOL
*mFormBrowser2Protocol
;
75 This routine initializes the HII Database.
77 @param ImageHandle Image handle for PCD DXE driver.
78 @param SystemTable Pointer to SystemTable.
80 @retval EFI_SUCCESS The entry point alwasy return successfully.
84 InitializeHiiDatabase (
85 IN EFI_HANDLE ImageHandle
,
86 IN EFI_SYSTEM_TABLE
*SystemTable
89 HII_THUNK_PRIVATE_DATA
*Private
;
93 EFI_HII_HANDLE
*Buffer
;
95 HII_THUNK_CONTEXT
*ThunkContext
;
98 ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL
, &gEfiHiiCompatibilityProtocolGuid
);
99 ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL
, &gEfiFormBrowserCompatibilityProtocolGuid
);
101 Private
= AllocateCopyPool (sizeof (HII_THUNK_PRIVATE_DATA
), &mHiiThunkPrivateDataTempate
);
102 ASSERT (Private
!= NULL
);
103 InitializeListHead (&Private
->ThunkContextListHead
);
105 InitHiiHandleDatabase ();
107 mHiiThunkPrivateData
= Private
;
109 Status
= gBS
->LocateProtocol (
110 &gEfiHiiDatabaseProtocolGuid
,
112 (VOID
**) &mHiiDatabase
114 ASSERT_EFI_ERROR (Status
);
116 Status
= gBS
->LocateProtocol (
117 &gEfiHiiStringProtocolGuid
,
119 (VOID
**) &mHiiStringProtocol
121 ASSERT_EFI_ERROR (Status
);
123 Status
= gBS
->LocateProtocol (
124 &gEfiHiiFontProtocolGuid
,
126 (VOID
**) &mHiiFontProtocol
128 ASSERT_EFI_ERROR (Status
);
130 Status
= gBS
->LocateProtocol (
131 &gEfiHiiConfigRoutingProtocolGuid
,
133 (VOID
**) &mHiiConfigRoutingProtocol
135 ASSERT_EFI_ERROR (Status
);
138 Status
= gBS
->LocateProtocol (
139 &gEfiFormBrowser2ProtocolGuid
,
141 (VOID
**) &mFormBrowser2Protocol
143 ASSERT_EFI_ERROR (Status
);
149 // Install protocol interface
151 Status
= gBS
->InstallProtocolInterface (
153 &gEfiHiiCompatibilityProtocolGuid
,
154 EFI_NATIVE_INTERFACE
,
155 (VOID
*) &Private
->Hii
157 ASSERT_EFI_ERROR (Status
);
159 Status
= ListPackageLists (EFI_HII_PACKAGE_STRINGS
, NULL
, &BufferLength
, &Buffer
);
160 if (Status
== EFI_SUCCESS
) {
161 for (Index
= 0; Index
< BufferLength
/ sizeof (EFI_HII_HANDLE
); Index
++) {
162 ThunkContext
= CreateThunkContextForUefiHiiHandle (Buffer
[Index
]);
163 ASSERT (ThunkContext
!= NULL
);
165 InsertTailList (&Private
->ThunkContextListHead
, &ThunkContext
->Link
);
171 Status
= mHiiDatabase
->RegisterPackageNotify (
173 EFI_HII_PACKAGE_STRINGS
,
176 EFI_HII_DATABASE_NOTIFY_NEW_PACK
,
179 ASSERT_EFI_ERROR (Status
);
181 Status
= mHiiDatabase
->RegisterPackageNotify (
183 EFI_HII_PACKAGE_STRINGS
,
186 EFI_HII_DATABASE_NOTIFY_ADD_PACK
,
189 ASSERT_EFI_ERROR (Status
);
191 Status
= mHiiDatabase
->RegisterPackageNotify (
193 EFI_HII_PACKAGE_FORMS
,
196 EFI_HII_DATABASE_NOTIFY_NEW_PACK
,
199 ASSERT_EFI_ERROR (Status
);
201 Status
= mHiiDatabase
->RegisterPackageNotify (
203 EFI_HII_PACKAGE_FORMS
,
206 EFI_HII_DATABASE_NOTIFY_ADD_PACK
,
209 ASSERT_EFI_ERROR (Status
);
211 Status
= mHiiDatabase
->RegisterPackageNotify (
213 EFI_HII_PACKAGE_STRINGS
,
216 EFI_HII_DATABASE_NOTIFY_REMOVE_PACK
,
219 ASSERT_EFI_ERROR (Status
);
221 InitSetBrowserStrings ();
223 mBrowserThunkPrivateDataTemplate
.ThunkPrivate
= Private
;
224 Status
= gBS
->InstallProtocolInterface (
225 &mBrowserThunkPrivateDataTemplate
.Handle
,
226 &gEfiFormBrowserCompatibilityProtocolGuid
,
227 EFI_NATIVE_INTERFACE
,
228 (VOID
*) &mBrowserThunkPrivateDataTemplate
.FormBrowser
230 ASSERT_EFI_ERROR (Status
);
236 Determines the handles that are currently active in the database.
238 This function determines the handles that are currently active in the database.
239 For example, a program wishing to create a Setup-like configuration utility would use this call
240 to determine the handles that are available. It would then use calls defined in the forms section
241 below to extract forms and then interpret them.
243 @param This A pointer to the EFI_HII_PROTOCOL instance.
244 @param HandleBufferLength On input, a pointer to the length of the handle buffer.
245 On output, the length of the handle buffer that is required for the handles found.
246 @param Handle Pointer to an array of EFI_HII_HANDLE instances returned.
247 Type EFI_HII_HANDLE is defined in EFI_HII_PROTOCOL.NewPack() in the Packages section.
249 @retval EFI_SUCCESS Handle was updated successfully.
251 @retval EFI_BUFFER_TOO_SMALL The HandleBufferLength parameter indicates that Handle is too small
252 to support the number of handles. HandleBufferLength is updated with a value that
253 will enable the data to fit.
258 IN EFI_HII_PROTOCOL
*This
,
259 IN OUT UINT16
*HandleBufferLength
,
260 OUT FRAMEWORK_EFI_HII_HANDLE
*Handle
265 HII_THUNK_CONTEXT
*ThunkContext
;
266 HII_THUNK_PRIVATE_DATA
*Private
;
268 if (HandleBufferLength
== NULL
) {
269 return EFI_INVALID_PARAMETER
;
272 Private
= HII_THUNK_PRIVATE_DATA_FROM_THIS(This
);
275 // Count the number of handles.
278 Link
= GetFirstNode (&Private
->ThunkContextListHead
);
279 while (!IsNull (&Private
->ThunkContextListHead
, Link
)) {
281 Link
= GetNextNode (&Private
->ThunkContextListHead
, Link
);
284 if (Count
> *HandleBufferLength
) {
285 *HandleBufferLength
= (UINT16
) (Count
* sizeof (FRAMEWORK_EFI_HII_HANDLE
));
286 return EFI_BUFFER_TOO_SMALL
;
290 // Output the handles.
293 Link
= GetFirstNode (&Private
->ThunkContextListHead
);
294 while (!IsNull (&Private
->ThunkContextListHead
, Link
)) {
296 ThunkContext
= HII_THUNK_CONTEXT_FROM_LINK (Link
);
297 Handle
[Count
] = ThunkContext
->FwHiiHandle
;
300 Link
= GetNextNode (&Private
->ThunkContextListHead
, Link
);
304 *HandleBufferLength
= (UINT16
) (Count
* sizeof (FRAMEWORK_EFI_HII_HANDLE
));
309 Allows a program to determine the primary languages that are supported on a given handle.
311 This routine is intended to be used by drivers to query the interface database for supported languages.
312 This routine returns a string of concatenated 3-byte language identifiers, one per string package associated with the handle.
314 @param This A pointer to the EFI_HII_PROTOCOL instance.
315 @param Handle The handle on which the strings reside. Type EFI_HII_HANDLE is defined in EFI_HII_PROTOCOL.NewPack()
316 in the Packages section.
317 @param LanguageString A string allocated by GetPrimaryLanguages() that contains a list of all primary languages
318 registered on the handle. The routine will not return the three-spaces language identifier used in
319 other functions to indicate non-language-specific strings.
321 @retval EFI_SUCCESS LanguageString was correctly returned.
323 @retval EFI_INVALID_PARAMETER The Handle was unknown.
327 HiiGetPrimaryLanguages (
328 IN EFI_HII_PROTOCOL
*This
,
329 IN FRAMEWORK_EFI_HII_HANDLE Handle
,
330 OUT EFI_STRING
*LanguageString
333 HII_THUNK_PRIVATE_DATA
*Private
;
334 EFI_HII_HANDLE UefiHiiHandle
;
335 CHAR8
*LangCodes4646
;
336 CHAR16
*UnicodeLangCodes639
;
340 Private
= HII_THUNK_PRIVATE_DATA_FROM_THIS(This
);
342 UefiHiiHandle
= FwHiiHandleToUefiHiiHandle (Private
, Handle
);
343 if (UefiHiiHandle
== NULL
) {
344 return EFI_INVALID_PARAMETER
;
347 LangCodes4646
= HiiGetSupportedLanguages (UefiHiiHandle
);
349 if (LangCodes4646
== NULL
) {
350 return EFI_INVALID_PARAMETER
;
353 LangCodes639
= ConvertLanguagesRfc4646ToIso639 (LangCodes4646
);
354 if (LangCodes639
== NULL
) {
355 Status
= EFI_INVALID_PARAMETER
;
359 UnicodeLangCodes639
= AllocateZeroPool (AsciiStrSize (LangCodes639
) * sizeof (CHAR16
));
360 if (UnicodeLangCodes639
== NULL
) {
361 Status
= EFI_OUT_OF_RESOURCES
;
366 // The language returned is in RFC 639-2 format.
368 AsciiStrToUnicodeStr (LangCodes639
, UnicodeLangCodes639
);
369 *LanguageString
= UnicodeLangCodes639
;
370 Status
= EFI_SUCCESS
;
373 FreePool (LangCodes4646
);
374 if (LangCodes639
!= NULL
) {
375 FreePool (LangCodes639
);
382 This function returns the list of supported 2nd languages, in the format specified
383 in UEFI specification Appendix M.
385 If HiiHandle is not a valid Handle in the HII database, then ASSERT.
386 If not enough resource to complete the operation, then ASSERT.
388 @param HiiHandle The HII package list handle.
389 @param PrimaryLanguage Pointer to language name buffer.
391 @return The supported languages.
396 HiiGetSupportedSecondaryLanguages (
397 IN EFI_HII_HANDLE HiiHandle
,
398 IN CONST CHAR8
*PrimaryLanguage
403 CHAR8
*LanguageString
;
405 ASSERT (HiiHandle
!= NULL
);
408 // Collect current supported 2nd Languages for given HII handle
409 // First try allocate 4K buffer to store the current supported 2nd languages.
412 LanguageString
= AllocateZeroPool (BufferSize
);
413 if (LanguageString
== NULL
) {
417 Status
= mHiiStringProtocol
->GetSecondaryLanguages (mHiiStringProtocol
, HiiHandle
, PrimaryLanguage
, LanguageString
, &BufferSize
);
418 ASSERT (Status
!= EFI_NOT_FOUND
);
420 if (Status
== EFI_BUFFER_TOO_SMALL
) {
421 FreePool (LanguageString
);
422 LanguageString
= AllocateZeroPool (BufferSize
);
423 if (LanguageString
== NULL
) {
427 Status
= mHiiStringProtocol
->GetSecondaryLanguages (mHiiStringProtocol
, HiiHandle
, PrimaryLanguage
, LanguageString
, &BufferSize
);
430 if (EFI_ERROR (Status
)) {
431 LanguageString
= NULL
;
434 return LanguageString
;
438 Allows a program to determine which secondary languages are supported on a given handle for a given primary language
440 This routine is intended to be used by drivers to query the interface database for supported languages.
441 This routine returns a string of concatenated 3-byte language identifiers, one per string package associated with the handle.
443 @param This A pointer to the EFI_HII_PROTOCOL instance.
444 @param Handle The handle on which the strings reside. Type EFI_HII_HANDLE is defined in EFI_HII_PROTOCOL.NewPack()
445 in the Packages section.
446 @param PrimaryLanguage Pointer to a NULL-terminated string containing a single ISO 639-2 language identifier, indicating
447 the primary language.
448 @param LanguageString A string allocated by GetSecondaryLanguages() containing a list of all secondary languages registered
449 on the handle. The routine will not return the three-spaces language identifier used in other functions
450 to indicate non-language-specific strings, nor will it return the primary language. This function succeeds
451 but returns a NULL LanguageString if there are no secondary languages associated with the input Handle and
452 PrimaryLanguage pair. Type EFI_STRING is defined in String.
454 @retval EFI_SUCCESS LanguageString was correctly returned.
455 @retval EFI_INVALID_PARAMETER The Handle was unknown.
459 HiiGetSecondaryLanguages (
460 IN EFI_HII_PROTOCOL
*This
,
461 IN FRAMEWORK_EFI_HII_HANDLE Handle
,
462 IN CHAR16
*PrimaryLanguage
,
463 OUT EFI_STRING
*LanguageString
466 HII_THUNK_PRIVATE_DATA
*Private
;
467 EFI_HII_HANDLE UefiHiiHandle
;
468 CHAR8
*PrimaryLang4646
;
469 CHAR8
*PrimaryLang639
;
470 CHAR8
*SecLangCodes4646
;
471 CHAR8
*SecLangCodes639
;
472 CHAR16
*UnicodeSecLangCodes639
;
475 Private
= HII_THUNK_PRIVATE_DATA_FROM_THIS(This
);
477 SecLangCodes639
= NULL
;
478 SecLangCodes4646
= NULL
;
479 PrimaryLang4646
= NULL
;
480 UnicodeSecLangCodes639
= NULL
;
482 UefiHiiHandle
= FwHiiHandleToUefiHiiHandle (Private
, Handle
);
483 if (UefiHiiHandle
== NULL
) {
484 return EFI_INVALID_PARAMETER
;
487 PrimaryLang639
= AllocateZeroPool (StrLen (PrimaryLanguage
) + 1);
488 if (PrimaryLang639
== NULL
) {
489 Status
= EFI_OUT_OF_RESOURCES
;
493 UnicodeStrToAsciiStr (PrimaryLanguage
, PrimaryLang639
);
495 PrimaryLang4646
= ConvertLanguagesIso639ToRfc4646 (PrimaryLang639
);
496 ASSERT_EFI_ERROR (PrimaryLang4646
!= NULL
);
498 SecLangCodes4646
= HiiGetSupportedSecondaryLanguages (UefiHiiHandle
, PrimaryLang4646
);
500 if (SecLangCodes4646
== NULL
) {
501 Status
= EFI_INVALID_PARAMETER
;
505 SecLangCodes639
= ConvertLanguagesIso639ToRfc4646 (SecLangCodes4646
);
506 if (SecLangCodes639
== NULL
) {
507 Status
= EFI_INVALID_PARAMETER
;
511 UnicodeSecLangCodes639
= AllocateZeroPool (AsciiStrSize (SecLangCodes639
) * sizeof (CHAR16
));
512 if (UnicodeSecLangCodes639
== NULL
) {
513 Status
= EFI_OUT_OF_RESOURCES
;
518 // The language returned is in RFC 4646 format.
520 *LanguageString
= AsciiStrToUnicodeStr (SecLangCodes639
, UnicodeSecLangCodes639
);
521 Status
= EFI_SUCCESS
;
524 if (PrimaryLang639
!= NULL
) {
525 FreePool (PrimaryLang639
);
528 if (SecLangCodes639
!= NULL
) {
529 FreePool (SecLangCodes639
);
532 if (PrimaryLang4646
!= NULL
) {
533 FreePool (PrimaryLang4646
);
536 if (SecLangCodes4646
!= NULL
) {
537 FreePool (SecLangCodes4646
);
539 if (UnicodeSecLangCodes639
!= NULL
) {
540 FreePool (UnicodeSecLangCodes639
);