3 This library class defines a set of interfaces to customize Ui module
5 Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials are licensed and made available under
7 the terms and conditions of the BSD License that accompanies this distribution.
8 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.
17 #include <Guid/MdeModuleHii.h>
18 #include <Guid/GlobalVariable.h>
20 #include <Protocol/HiiConfigAccess.h>
21 #include <Protocol/HiiString.h>
23 #include <Library/HiiLib.h>
24 #include <Library/DebugLib.h>
25 #include <Library/UefiLib.h>
26 #include <Library/BaseMemoryLib.h>
27 #include <Library/PcdLib.h>
28 #include <Library/MemoryAllocationLib.h>
29 #include <Library/UefiRuntimeServicesTableLib.h>
30 #include <Library/UefiHiiServicesLib.h>
31 #include <Library/DevicePathLib.h>
32 #include <Library/UefiBootServicesTableLib.h>
33 #include "FrontPageCustomizedUiSupport.h"
36 // This is the VFR compiler generated header file which defines the
37 // string identifiers.
39 #define PRINTABLE_LANGUAGE_NAME_STRING_ID 0x0001
41 #define UI_HII_DRIVER_LIST_SIZE 0x8
43 #define FRONT_PAGE_KEY_CONTINUE 0x1000
44 #define FRONT_PAGE_KEY_RESET 0x1001
45 #define FRONT_PAGE_KEY_LANGUAGE 0x1002
48 EFI_STRING_ID PromptId
;
50 EFI_STRING_ID DevicePathId
;
52 BOOLEAN EmptyLineAfter
;
53 } UI_HII_DRIVER_INSTANCE
;
55 CHAR8
*gLanguageString
;
56 EFI_STRING_ID
*gLanguageToken
;
57 UI_HII_DRIVER_INSTANCE
*gHiiDriverList
;
58 EFI_HII_HANDLE gHiiHandle
;
62 Get next language from language code list (with separator ';').
64 If LangCode is NULL, then ASSERT.
65 If Lang is NULL, then ASSERT.
67 @param LangCode On input: point to first language in the list. On
68 output: point to next language in the list, or
69 NULL if no more language in the list.
70 @param Lang The first language in the list.
75 IN OUT CHAR8
**LangCode
,
82 ASSERT (LangCode
!= NULL
);
83 ASSERT (*LangCode
!= NULL
);
84 ASSERT (Lang
!= NULL
);
87 StringPtr
= *LangCode
;
88 while (StringPtr
[Index
] != 0 && StringPtr
[Index
] != ';') {
92 CopyMem (Lang
, StringPtr
, Index
);
95 if (StringPtr
[Index
] == ';') {
98 *LangCode
= StringPtr
+ Index
;
102 This function processes the language changes in configuration.
104 @param Value A pointer to the data being sent to the original exporting driver.
107 @retval TRUE The callback successfully handled the action.
108 @retval FALSE The callback not supported in this handler.
112 LanguageChangeHandler (
113 IN EFI_IFR_TYPE_VALUE
*Value
122 // Allocate working buffer for RFC 4646 language in supported LanguageString.
124 Lang
= AllocatePool (AsciiStrSize (gLanguageString
));
125 ASSERT (Lang
!= NULL
);
128 LangCode
= gLanguageString
;
129 while (*LangCode
!= 0) {
130 GetNextLanguage (&LangCode
, Lang
);
132 if (Index
== Value
->u8
) {
139 if (Index
== Value
->u8
) {
140 Status
= gRT
->SetVariable (
142 &gEfiGlobalVariableGuid
,
143 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
147 if (EFI_ERROR (Status
)) {
149 return EFI_DEVICE_ERROR
;
160 This function processes the results of changes in configuration.
163 @param HiiHandle Points to the hii handle for this formset.
164 @param Action Specifies the type of action taken by the browser.
165 @param QuestionId A unique value which is sent to the original exporting driver
166 so that it can identify the type of data to expect.
167 @param Type The type of value for the question.
168 @param Value A pointer to the data being sent to the original exporting driver.
169 @param ActionRequest On return, points to the action requested by the callback function.
170 @param Status Return the handle status.
172 @retval TRUE The callback successfully handled the action.
173 @retval FALSE The callback not supported in this handler.
177 UiSupportLibCallbackHandler (
178 IN EFI_HII_HANDLE HiiHandle
,
179 IN EFI_BROWSER_ACTION Action
,
180 IN EFI_QUESTION_ID QuestionId
,
182 IN EFI_IFR_TYPE_VALUE
*Value
,
183 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest
,
184 OUT EFI_STATUS
*Status
187 if (QuestionId
!= FRONT_PAGE_KEY_CONTINUE
&&
188 QuestionId
!= FRONT_PAGE_KEY_RESET
&&
189 QuestionId
!= FRONT_PAGE_KEY_LANGUAGE
) {
193 if (Action
!= EFI_BROWSER_ACTION_CHANGED
) {
195 // Do nothing for other UEFI Action. Only do call back when data is changed.
197 *Status
= EFI_UNSUPPORTED
;
201 if (Action
== EFI_BROWSER_ACTION_CHANGED
) {
202 if ((Value
== NULL
) || (ActionRequest
== NULL
)) {
203 *Status
= EFI_INVALID_PARAMETER
;
207 *Status
= EFI_SUCCESS
;
208 switch (QuestionId
) {
209 case FRONT_PAGE_KEY_CONTINUE
:
211 // This is the continue - clear the screen and return an error to get out of FrontPage loop
213 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_EXIT
;
216 case FRONT_PAGE_KEY_LANGUAGE
:
217 *Status
= LanguageChangeHandler(Value
);
220 case FRONT_PAGE_KEY_RESET
:
224 gRT
->ResetSystem (EfiResetCold
, EFI_SUCCESS
, 0, NULL
);
225 *Status
= EFI_UNSUPPORTED
;
236 Create Select language menu in the front page with oneof opcode.
238 @param[in] HiiHandle The hii handle for the Uiapp driver.
239 @param[in] StartOpCodeHandle The opcode handle to save the new opcode.
243 UiCreateLanguageMenu (
244 IN EFI_HII_HANDLE HiiHandle
,
245 IN VOID
*StartOpCodeHandle
252 CHAR16
*StringBuffer
;
253 VOID
*OptionsOpCodeHandle
;
256 EFI_HII_STRING_PROTOCOL
*HiiString
;
262 // Init OpCode Handle and Allocate space for creation of UpdateData Buffer
264 OptionsOpCodeHandle
= HiiAllocateOpCodeHandle ();
265 ASSERT (OptionsOpCodeHandle
!= NULL
);
267 GetEfiGlobalVariable2 (L
"PlatformLang", (VOID
**)&CurrentLang
, NULL
);
270 // Get Support language list from variable.
272 GetEfiGlobalVariable2 (L
"PlatformLangCodes", (VOID
**)&gLanguageString
, NULL
);
273 if (gLanguageString
== NULL
) {
274 gLanguageString
= AllocateCopyPool (
275 AsciiStrSize ((CHAR8
*) PcdGetPtr (PcdUefiVariableDefaultPlatformLangCodes
)),
276 (CHAR8
*) PcdGetPtr (PcdUefiVariableDefaultPlatformLangCodes
)
278 ASSERT (gLanguageString
!= NULL
);
281 if (gLanguageToken
== NULL
) {
283 // Count the language list number.
285 LangCode
= gLanguageString
;
286 Lang
= AllocatePool (AsciiStrSize (gLanguageString
));
287 ASSERT (Lang
!= NULL
);
290 while (*LangCode
!= 0) {
291 GetNextLanguage (&LangCode
, Lang
);
296 // Allocate extra 1 as the end tag.
298 gLanguageToken
= AllocateZeroPool ((OptionCount
+ 1) * sizeof (EFI_STRING_ID
));
299 ASSERT (gLanguageToken
!= NULL
);
301 Status
= gBS
->LocateProtocol (&gEfiHiiStringProtocolGuid
, NULL
, (VOID
**) &HiiString
);
302 ASSERT_EFI_ERROR (Status
);
304 LangCode
= gLanguageString
;
306 while (*LangCode
!= 0) {
307 GetNextLanguage (&LangCode
, Lang
);
310 Status
= HiiString
->GetString (HiiString
, Lang
, HiiHandle
, PRINTABLE_LANGUAGE_NAME_STRING_ID
, StringBuffer
, &StringSize
, NULL
);
311 if (Status
== EFI_BUFFER_TOO_SMALL
) {
312 StringBuffer
= AllocateZeroPool (StringSize
);
313 ASSERT (StringBuffer
!= NULL
);
314 Status
= HiiString
->GetString (HiiString
, Lang
, HiiHandle
, PRINTABLE_LANGUAGE_NAME_STRING_ID
, StringBuffer
, &StringSize
, NULL
);
315 ASSERT_EFI_ERROR (Status
);
318 if (EFI_ERROR (Status
)) {
319 StringBuffer
= AllocatePool (AsciiStrSize (Lang
) * sizeof (CHAR16
));
320 ASSERT (StringBuffer
!= NULL
);
321 AsciiStrToUnicodeStr (Lang
, StringBuffer
);
324 ASSERT (StringBuffer
!= NULL
);
325 gLanguageToken
[OptionCount
] = HiiSetString (HiiHandle
, 0, StringBuffer
, NULL
);
326 FreePool (StringBuffer
);
332 ASSERT (gLanguageToken
!= NULL
);
333 LangCode
= gLanguageString
;
336 Lang
= AllocatePool (AsciiStrSize (gLanguageString
));
337 ASSERT (Lang
!= NULL
);
339 while (*LangCode
!= 0) {
340 GetNextLanguage (&LangCode
, Lang
);
342 if (CurrentLang
!= NULL
&& AsciiStrCmp (Lang
, CurrentLang
) == 0) {
343 HiiCreateOneOfOptionOpCode (
345 gLanguageToken
[OptionCount
],
346 EFI_IFR_OPTION_DEFAULT
,
347 EFI_IFR_NUMERIC_SIZE_1
,
351 HiiCreateOneOfOptionOpCode (
353 gLanguageToken
[OptionCount
],
355 EFI_IFR_NUMERIC_SIZE_1
,
363 if (CurrentLang
!= NULL
) {
364 FreePool (CurrentLang
);
368 HiiCreateOneOfOpCode (
370 FRONT_PAGE_KEY_LANGUAGE
,
373 STRING_TOKEN (STR_LANGUAGE_SELECT
),
374 STRING_TOKEN (STR_LANGUAGE_SELECT_HELP
),
375 EFI_IFR_FLAG_CALLBACK
,
376 EFI_IFR_NUMERIC_SIZE_1
,
383 Create continue menu in the front page.
385 @param[in] HiiHandle The hii handle for the Uiapp driver.
386 @param[in] StartOpCodeHandle The opcode handle to save the new opcode.
390 UiCreateContinueMenu (
391 IN EFI_HII_HANDLE HiiHandle
,
392 IN VOID
*StartOpCodeHandle
395 HiiCreateActionOpCode (
397 FRONT_PAGE_KEY_CONTINUE
,
398 STRING_TOKEN (STR_CONTINUE_PROMPT
),
399 STRING_TOKEN (STR_CONTINUE_PROMPT
),
400 EFI_IFR_FLAG_CALLBACK
,
406 Create empty line menu in the front page.
408 @param HiiHandle The hii handle for the Uiapp driver.
409 @param StartOpCodeHandle The opcode handle to save the new opcode.
414 IN EFI_HII_HANDLE HiiHandle
,
415 IN VOID
*StartOpCodeHandle
418 HiiCreateSubTitleOpCode (StartOpCodeHandle
, STRING_TOKEN (STR_NULL_STRING
), 0, 0, 0);
422 Create Reset menu in the front page.
424 @param[in] HiiHandle The hii handle for the Uiapp driver.
425 @param[in] StartOpCodeHandle The opcode handle to save the new opcode.
430 IN EFI_HII_HANDLE HiiHandle
,
431 IN VOID
*StartOpCodeHandle
434 HiiCreateActionOpCode (
436 FRONT_PAGE_KEY_RESET
,
437 STRING_TOKEN (STR_RESET_STRING
),
438 STRING_TOKEN (STR_RESET_STRING
),
439 EFI_IFR_FLAG_CALLBACK
,
445 Extract device path for given HII handle and class guid.
447 @param Handle The HII handle.
449 @retval NULL Fail to get the device path string.
450 @return PathString Get the device path string.
454 ExtractDevicePathFromHiiHandle (
455 IN EFI_HII_HANDLE Handle
459 EFI_HANDLE DriverHandle
;
461 ASSERT (Handle
!= NULL
);
463 if (Handle
== NULL
) {
467 Status
= gHiiDatabase
->GetPackageListHandle (gHiiDatabase
, Handle
, &DriverHandle
);
468 if (EFI_ERROR (Status
)) {
472 return ConvertDevicePathToText(DevicePathFromHandle (DriverHandle
), FALSE
, FALSE
);
476 Check whether this driver need to be shown in the front page.
478 @param HiiHandle The hii handle for the driver.
479 @param Guid The special guid for the driver which is the target.
480 @param PromptId Return the prompt string id.
481 @param HelpId Return the help string id.
482 @param FormsetGuid Return the formset guid info.
484 @retval EFI_SUCCESS Search the driver success
489 IN EFI_HII_HANDLE HiiHandle
,
491 OUT EFI_STRING_ID
*PromptId
,
492 OUT EFI_STRING_ID
*HelpId
,
493 OUT VOID
*FormsetGuid
499 EFI_IFR_FORM_SET
*Buffer
;
505 Status
= HiiGetFormSetFromHiiHandle(HiiHandle
, &Buffer
,&BufferSize
);
506 if (EFI_ERROR (Status
)) {
512 Ptr
= (UINT8
*) Buffer
;
513 while(TempSize
< BufferSize
) {
514 TempSize
+= ((EFI_IFR_OP_HEADER
*) Ptr
)->Length
;
516 if (((EFI_IFR_OP_HEADER
*) Ptr
)->Length
<= OFFSET_OF (EFI_IFR_FORM_SET
, Flags
)){
517 Ptr
+= ((EFI_IFR_OP_HEADER
*) Ptr
)->Length
;
521 ClassGuidNum
= (UINT8
) (((EFI_IFR_FORM_SET
*)Ptr
)->Flags
& 0x3);
522 ClassGuid
= (EFI_GUID
*) (VOID
*)(Ptr
+ sizeof (EFI_IFR_FORM_SET
));
523 while (ClassGuidNum
-- > 0) {
524 if (!CompareGuid (Guid
, ClassGuid
)){
529 *PromptId
= ((EFI_IFR_FORM_SET
*)Ptr
)->FormSetTitle
;
530 *HelpId
= ((EFI_IFR_FORM_SET
*)Ptr
)->Help
;
531 CopyMem (FormsetGuid
, &((EFI_IFR_FORM_SET
*) Ptr
)->Guid
, sizeof (EFI_GUID
));
542 Search the drivers in the system which need to show in the front page
543 and insert the menu to the front page.
545 @param HiiHandle The hii handle for the Uiapp driver.
546 @param ClassGuid The class guid for the driver which is the target.
547 @param SpecialHandlerFn The pointer to the specail handler function, if any.
548 @param StartOpCodeHandle The opcode handle to save the new opcode.
550 @retval EFI_SUCCESS Search the driver success
554 UiListThirdPartyDrivers (
555 IN EFI_HII_HANDLE HiiHandle
,
556 IN EFI_GUID
*ClassGuid
,
557 IN DRIVER_SPECIAL_HANDLER SpecialHandlerFn
,
558 IN VOID
*StartOpCodeHandle
564 EFI_STRING_ID TokenHelp
;
565 EFI_HII_HANDLE
*HiiHandles
;
566 CHAR16
*DevicePathStr
;
569 UI_HII_DRIVER_INSTANCE
*DriverListPtr
;
571 BOOLEAN EmptyLineAfter
;
573 if (gHiiDriverList
!= NULL
) {
574 FreePool (gHiiDriverList
);
577 HiiHandles
= HiiGetHiiHandles (NULL
);
578 ASSERT (HiiHandles
!= NULL
);
580 gHiiDriverList
= AllocateZeroPool (UI_HII_DRIVER_LIST_SIZE
* sizeof (UI_HII_DRIVER_INSTANCE
));
581 ASSERT (gHiiDriverList
!= NULL
);
582 DriverListPtr
= gHiiDriverList
;
583 CurrentSize
= UI_HII_DRIVER_LIST_SIZE
;
585 for (Index
= 0, Count
= 0; HiiHandles
[Index
] != NULL
; Index
++) {
586 if (!RequiredDriver (HiiHandles
[Index
], ClassGuid
, &Token
, &TokenHelp
, &gHiiDriverList
[Count
].FormSetGuid
)) {
590 String
= HiiGetString (HiiHandles
[Index
], Token
, NULL
);
591 if (String
== NULL
) {
592 String
= HiiGetString (gHiiHandle
, STRING_TOKEN (STR_MISSING_STRING
), NULL
);
593 ASSERT (String
!= NULL
);
594 } else if (SpecialHandlerFn
!= NULL
) {
596 // Check whether need to rename the driver name.
598 EmptyLineAfter
= FALSE
;
599 if (SpecialHandlerFn (String
, &NewName
, &EmptyLineAfter
)) {
602 DriverListPtr
[Count
].EmptyLineAfter
= EmptyLineAfter
;
605 DriverListPtr
[Count
].PromptId
= HiiSetString (HiiHandle
, 0, String
, NULL
);
608 String
= HiiGetString (HiiHandles
[Index
], TokenHelp
, NULL
);
609 if (String
== NULL
) {
610 String
= HiiGetString (gHiiHandle
, STRING_TOKEN (STR_MISSING_STRING
), NULL
);
611 ASSERT (String
!= NULL
);
613 DriverListPtr
[Count
].HelpId
= HiiSetString (HiiHandle
, 0, String
, NULL
);
616 DevicePathStr
= ExtractDevicePathFromHiiHandle(HiiHandles
[Index
]);
617 if (DevicePathStr
!= NULL
){
618 DriverListPtr
[Count
].DevicePathId
= HiiSetString (HiiHandle
, 0, DevicePathStr
, NULL
);
619 FreePool (DevicePathStr
);
621 DriverListPtr
[Count
].DevicePathId
= 0;
625 if (Count
>= CurrentSize
) {
626 DriverListPtr
= AllocateCopyPool ((Count
+ UI_HII_DRIVER_LIST_SIZE
) * sizeof (UI_HII_DRIVER_INSTANCE
), gHiiDriverList
);
627 ASSERT (DriverListPtr
!= NULL
);
628 FreePool (gHiiDriverList
);
629 gHiiDriverList
= DriverListPtr
;
630 CurrentSize
+= UI_HII_DRIVER_LIST_SIZE
;
634 FreePool (HiiHandles
);
637 while (gHiiDriverList
[Index
].PromptId
!= 0) {
638 HiiCreateGotoExOpCode (
641 gHiiDriverList
[Index
].PromptId
,
642 gHiiDriverList
[Index
].HelpId
,
646 &gHiiDriverList
[Index
].FormSetGuid
,
647 gHiiDriverList
[Index
].DevicePathId
650 if (gHiiDriverList
[Index
].EmptyLineAfter
) {
651 UiCreateEmptyLine (HiiHandle
, StartOpCodeHandle
);