]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Application/UiApp/FrontPageCustomizedUiSupport.c
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
MdeModulePkg UiApp: change code for easy customization.
[mirror_edk2.git] / MdeModulePkg / Application / UiApp / FrontPageCustomizedUiSupport.c
1 /** @file
2
3 This library class defines a set of interfaces to customize Ui module
4
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.
10
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.
13
14 **/
15 #include <Uefi.h>
16
17 #include <Guid/MdeModuleHii.h>
18 #include <Guid/GlobalVariable.h>
19
20 #include <Protocol/HiiConfigAccess.h>
21 #include <Protocol/HiiString.h>
22
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"
34
35 //
36 // This is the VFR compiler generated header file which defines the
37 // string identifiers.
38 //
39 #define PRINTABLE_LANGUAGE_NAME_STRING_ID 0x0001
40
41 #define UI_HII_DRIVER_LIST_SIZE 0x8
42
43 #define FRONT_PAGE_KEY_CONTINUE 0x1000
44 #define FRONT_PAGE_KEY_RESET 0x1001
45 #define FRONT_PAGE_KEY_LANGUAGE 0x1002
46
47 typedef struct {
48 EFI_STRING_ID PromptId;
49 EFI_STRING_ID HelpId;
50 EFI_STRING_ID DevicePathId;
51 EFI_GUID FormSetGuid;
52 BOOLEAN EmptyLineAfter;
53 } UI_HII_DRIVER_INSTANCE;
54
55 CHAR8 *gLanguageString;
56 EFI_STRING_ID *gLanguageToken;
57 UI_HII_DRIVER_INSTANCE *gHiiDriverList;
58 EFI_HII_HANDLE gHiiHandle;
59
60
61 /**
62 Get next language from language code list (with separator ';').
63
64 If LangCode is NULL, then ASSERT.
65 If Lang is NULL, then ASSERT.
66
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.
71
72 **/
73 VOID
74 GetNextLanguage (
75 IN OUT CHAR8 **LangCode,
76 OUT CHAR8 *Lang
77 )
78 {
79 UINTN Index;
80 CHAR8 *StringPtr;
81
82 ASSERT (LangCode != NULL);
83 ASSERT (*LangCode != NULL);
84 ASSERT (Lang != NULL);
85
86 Index = 0;
87 StringPtr = *LangCode;
88 while (StringPtr[Index] != 0 && StringPtr[Index] != ';') {
89 Index++;
90 }
91
92 CopyMem (Lang, StringPtr, Index);
93 Lang[Index] = 0;
94
95 if (StringPtr[Index] == ';') {
96 Index++;
97 }
98 *LangCode = StringPtr + Index;
99 }
100
101 /**
102 This function processes the language changes in configuration.
103
104 @param Value A pointer to the data being sent to the original exporting driver.
105
106
107 @retval TRUE The callback successfully handled the action.
108 @retval FALSE The callback not supported in this handler.
109
110 **/
111 EFI_STATUS
112 LanguageChangeHandler (
113 IN EFI_IFR_TYPE_VALUE *Value
114 )
115 {
116 CHAR8 *LangCode;
117 CHAR8 *Lang;
118 UINTN Index;
119 EFI_STATUS Status;
120
121 //
122 // Allocate working buffer for RFC 4646 language in supported LanguageString.
123 //
124 Lang = AllocatePool (AsciiStrSize (gLanguageString));
125 ASSERT (Lang != NULL);
126
127 Index = 0;
128 LangCode = gLanguageString;
129 while (*LangCode != 0) {
130 GetNextLanguage (&LangCode, Lang);
131
132 if (Index == Value->u8) {
133 break;
134 }
135
136 Index++;
137 }
138
139 if (Index == Value->u8) {
140 Status = gRT->SetVariable (
141 L"PlatformLang",
142 &gEfiGlobalVariableGuid,
143 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,
144 AsciiStrSize (Lang),
145 Lang
146 );
147 if (EFI_ERROR (Status)) {
148 FreePool (Lang);
149 return EFI_DEVICE_ERROR;
150 }
151 } else {
152 ASSERT (FALSE);
153 }
154 FreePool (Lang);
155
156 return EFI_SUCCESS;
157 }
158
159 /**
160 This function processes the results of changes in configuration.
161
162
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.
171
172 @retval TRUE The callback successfully handled the action.
173 @retval FALSE The callback not supported in this handler.
174
175 **/
176 BOOLEAN
177 UiSupportLibCallbackHandler (
178 IN EFI_HII_HANDLE HiiHandle,
179 IN EFI_BROWSER_ACTION Action,
180 IN EFI_QUESTION_ID QuestionId,
181 IN UINT8 Type,
182 IN EFI_IFR_TYPE_VALUE *Value,
183 OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest,
184 OUT EFI_STATUS *Status
185 )
186 {
187 if (QuestionId != FRONT_PAGE_KEY_CONTINUE &&
188 QuestionId != FRONT_PAGE_KEY_RESET &&
189 QuestionId != FRONT_PAGE_KEY_LANGUAGE) {
190 return FALSE;
191 }
192
193 if (Action != EFI_BROWSER_ACTION_CHANGED) {
194 //
195 // Do nothing for other UEFI Action. Only do call back when data is changed.
196 //
197 *Status = EFI_UNSUPPORTED;
198 }
199
200 if (Action == EFI_BROWSER_ACTION_CHANGED) {
201 if ((Value == NULL) || (ActionRequest == NULL)) {
202 *Status = EFI_INVALID_PARAMETER;
203 }
204
205 *Status = EFI_SUCCESS;
206 switch (QuestionId) {
207 case FRONT_PAGE_KEY_CONTINUE:
208 //
209 // This is the continue - clear the screen and return an error to get out of FrontPage loop
210 //
211 *ActionRequest = EFI_BROWSER_ACTION_REQUEST_EXIT;
212 break;
213
214 case FRONT_PAGE_KEY_LANGUAGE:
215 *Status = LanguageChangeHandler(Value);
216 break;
217
218 case FRONT_PAGE_KEY_RESET:
219 //
220 // Reset
221 //
222 gRT->ResetSystem (EfiResetCold, EFI_SUCCESS, 0, NULL);
223 *Status = EFI_UNSUPPORTED;
224
225 default:
226 break;
227 }
228 }
229
230 return TRUE;
231 }
232
233 /**
234 Create Select language menu in the front page with oneof opcode.
235
236 @param[in] HiiHandle The hii handle for the Uiapp driver.
237 @param[in] QuestionId Question ID
238 @param[in] StartOpCodeHandle The opcode handle to save the new opcode.
239
240 @retval EFI_SUCCESS Search the driver success
241
242 **/
243 VOID
244 UiCreateLanguageMenu (
245 IN EFI_HII_HANDLE HiiHandle,
246 IN VOID *StartOpCodeHandle
247 )
248 {
249 CHAR8 *LangCode;
250 CHAR8 *Lang;
251 CHAR8 *CurrentLang;
252 UINTN OptionCount;
253 CHAR16 *StringBuffer;
254 VOID *OptionsOpCodeHandle;
255 UINTN StringSize;
256 EFI_STATUS Status;
257 EFI_HII_STRING_PROTOCOL *HiiString;
258
259 Lang = NULL;
260 StringBuffer = NULL;
261
262 //
263 // Init OpCode Handle and Allocate space for creation of UpdateData Buffer
264 //
265 OptionsOpCodeHandle = HiiAllocateOpCodeHandle ();
266 ASSERT (OptionsOpCodeHandle != NULL);
267
268 GetEfiGlobalVariable2 (L"PlatformLang", (VOID**)&CurrentLang, NULL);
269
270 //
271 // Get Support language list from variable.
272 //
273 GetEfiGlobalVariable2 (L"PlatformLangCodes", (VOID**)&gLanguageString, NULL);
274 if (gLanguageString == NULL) {
275 gLanguageString = AllocateCopyPool (
276 AsciiStrSize ((CHAR8 *) PcdGetPtr (PcdUefiVariableDefaultPlatformLangCodes)),
277 (CHAR8 *) PcdGetPtr (PcdUefiVariableDefaultPlatformLangCodes)
278 );
279 ASSERT (gLanguageString != NULL);
280 }
281
282 if (gLanguageToken == NULL) {
283 //
284 // Count the language list number.
285 //
286 LangCode = gLanguageString;
287 Lang = AllocatePool (AsciiStrSize (gLanguageString));
288 ASSERT (Lang != NULL);
289
290 OptionCount = 0;
291 while (*LangCode != 0) {
292 GetNextLanguage (&LangCode, Lang);
293 OptionCount ++;
294 }
295
296 //
297 // Allocate extra 1 as the end tag.
298 //
299 gLanguageToken = AllocateZeroPool ((OptionCount + 1) * sizeof (EFI_STRING_ID));
300 ASSERT (gLanguageToken != NULL);
301
302 Status = gBS->LocateProtocol (&gEfiHiiStringProtocolGuid, NULL, (VOID **) &HiiString);
303 ASSERT_EFI_ERROR (Status);
304
305 LangCode = gLanguageString;
306 OptionCount = 0;
307 while (*LangCode != 0) {
308 GetNextLanguage (&LangCode, Lang);
309
310 StringSize = 0;
311 Status = HiiString->GetString (HiiString, Lang, HiiHandle, PRINTABLE_LANGUAGE_NAME_STRING_ID, StringBuffer, &StringSize, NULL);
312 if (Status == EFI_BUFFER_TOO_SMALL) {
313 StringBuffer = AllocateZeroPool (StringSize);
314 ASSERT (StringBuffer != NULL);
315 Status = HiiString->GetString (HiiString, Lang, HiiHandle, PRINTABLE_LANGUAGE_NAME_STRING_ID, StringBuffer, &StringSize, NULL);
316 ASSERT_EFI_ERROR (Status);
317 }
318
319 if (EFI_ERROR (Status)) {
320 StringBuffer = AllocatePool (AsciiStrSize (Lang) * sizeof (CHAR16));
321 ASSERT (StringBuffer != NULL);
322 AsciiStrToUnicodeStr (Lang, StringBuffer);
323 }
324
325 ASSERT (StringBuffer != NULL);
326 gLanguageToken[OptionCount] = HiiSetString (HiiHandle, 0, StringBuffer, NULL);
327 FreePool (StringBuffer);
328
329 OptionCount++;
330 }
331 }
332
333 ASSERT (gLanguageToken != NULL);
334 LangCode = gLanguageString;
335 OptionCount = 0;
336 if (Lang == NULL) {
337 Lang = AllocatePool (AsciiStrSize (gLanguageString));
338 ASSERT (Lang != NULL);
339 }
340 while (*LangCode != 0) {
341 GetNextLanguage (&LangCode, Lang);
342
343 if (CurrentLang != NULL && AsciiStrCmp (Lang, CurrentLang) == 0) {
344 HiiCreateOneOfOptionOpCode (
345 OptionsOpCodeHandle,
346 gLanguageToken[OptionCount],
347 EFI_IFR_OPTION_DEFAULT,
348 EFI_IFR_NUMERIC_SIZE_1,
349 (UINT8) OptionCount
350 );
351 } else {
352 HiiCreateOneOfOptionOpCode (
353 OptionsOpCodeHandle,
354 gLanguageToken[OptionCount],
355 0,
356 EFI_IFR_NUMERIC_SIZE_1,
357 (UINT8) OptionCount
358 );
359 }
360
361 OptionCount++;
362 }
363
364 if (CurrentLang != NULL) {
365 FreePool (CurrentLang);
366 }
367 FreePool (Lang);
368
369 HiiCreateOneOfOpCode (
370 StartOpCodeHandle,
371 FRONT_PAGE_KEY_LANGUAGE,
372 0,
373 0,
374 STRING_TOKEN (STR_LANGUAGE_SELECT),
375 STRING_TOKEN (STR_LANGUAGE_SELECT_HELP),
376 EFI_IFR_FLAG_CALLBACK,
377 EFI_IFR_NUMERIC_SIZE_1,
378 OptionsOpCodeHandle,
379 NULL
380 );
381 }
382
383 /**
384 Create continue menu in the front page.
385
386 @param[in] HiiHandle The hii handle for the Uiapp driver.
387 @param[in] StartOpCodeHandle The opcode handle to save the new opcode.
388
389 **/
390 VOID
391 UiCreateContinueMenu (
392 IN EFI_HII_HANDLE HiiHandle,
393 IN VOID *StartOpCodeHandle
394 )
395 {
396 HiiCreateActionOpCode (
397 StartOpCodeHandle,
398 FRONT_PAGE_KEY_CONTINUE,
399 STRING_TOKEN (STR_CONTINUE_PROMPT),
400 STRING_TOKEN (STR_CONTINUE_PROMPT),
401 EFI_IFR_FLAG_CALLBACK,
402 0
403 );
404 }
405
406 /**
407 Create empty line menu in the front page.
408
409 @param HiiHandle The hii handle for the Uiapp driver.
410 @param StartOpCodeHandle The opcode handle to save the new opcode.
411
412 **/
413 VOID
414 UiCreateEmptyLine (
415 IN EFI_HII_HANDLE HiiHandle,
416 IN VOID *StartOpCodeHandle
417 )
418 {
419 HiiCreateSubTitleOpCode (StartOpCodeHandle, STRING_TOKEN (STR_NULL_STRING), 0, 0, 0);
420 }
421
422 /**
423 Create Reset menu in the front page.
424
425 @param[in] HiiHandle The hii handle for the Uiapp driver.
426 @param[in] StartOpCodeHandle The opcode handle to save the new opcode.
427
428 **/
429 VOID
430 UiCreateResetMenu (
431 IN EFI_HII_HANDLE HiiHandle,
432 IN VOID *StartOpCodeHandle
433 )
434 {
435 HiiCreateActionOpCode (
436 StartOpCodeHandle,
437 FRONT_PAGE_KEY_RESET,
438 STRING_TOKEN (STR_RESET_STRING),
439 STRING_TOKEN (STR_RESET_STRING),
440 EFI_IFR_FLAG_CALLBACK,
441 0
442 );
443 }
444
445 /**
446 Extract device path for given HII handle and class guid.
447
448 @param Handle The HII handle.
449
450 @retval NULL Fail to get the device path string.
451 @return PathString Get the device path string.
452
453 **/
454 CHAR16 *
455 ExtractDevicePathFromHiiHandle (
456 IN EFI_HII_HANDLE Handle
457 )
458 {
459 EFI_STATUS Status;
460 EFI_HANDLE DriverHandle;
461
462 ASSERT (Handle != NULL);
463
464 if (Handle == NULL) {
465 return NULL;
466 }
467
468 Status = gHiiDatabase->GetPackageListHandle (gHiiDatabase, Handle, &DriverHandle);
469 if (EFI_ERROR (Status)) {
470 return NULL;
471 }
472
473 return ConvertDevicePathToText(DevicePathFromHandle (DriverHandle), FALSE, FALSE);
474 }
475
476 /**
477 Check whether this driver need to be shown in the front page.
478
479 @param HiiHandle The hii handle for the driver.
480 @param Guid The special guid for the driver which is the target.
481 @param PromptId Return the prompt string id.
482 @param HelpId Return the help string id.
483 @param FormsetGuid Return the formset guid info.
484
485 @retval EFI_SUCCESS Search the driver success
486
487 **/
488 BOOLEAN
489 RequiredDriver (
490 IN EFI_HII_HANDLE HiiHandle,
491 IN EFI_GUID *Guid,
492 OUT EFI_STRING_ID *PromptId,
493 OUT EFI_STRING_ID *HelpId,
494 OUT VOID *FormsetGuid
495 )
496 {
497 EFI_STATUS Status;
498 UINT8 ClassGuidNum;
499 EFI_GUID *ClassGuid;
500 EFI_IFR_FORM_SET *Buffer;
501 UINTN BufferSize;
502 UINT8 *Ptr;
503 UINTN TempSize;
504 BOOLEAN RetVal;
505
506 Status = HiiGetFormSetFromHiiHandle(HiiHandle, &Buffer,&BufferSize);
507 if (EFI_ERROR (Status)) {
508 return FALSE;
509 }
510
511 RetVal = FALSE;
512 TempSize = 0;
513 Ptr = (UINT8 *) Buffer;
514 while(TempSize < BufferSize) {
515 TempSize += ((EFI_IFR_OP_HEADER *) Ptr)->Length;
516
517 if (((EFI_IFR_OP_HEADER *) Ptr)->Length <= OFFSET_OF (EFI_IFR_FORM_SET, Flags)){
518 Ptr += ((EFI_IFR_OP_HEADER *) Ptr)->Length;
519 continue;
520 }
521
522 ClassGuidNum = (UINT8) (((EFI_IFR_FORM_SET *)Ptr)->Flags & 0x3);
523 ClassGuid = (EFI_GUID *) (VOID *)(Ptr + sizeof (EFI_IFR_FORM_SET));
524 while (ClassGuidNum-- > 0) {
525 if (!CompareGuid (Guid, ClassGuid)){
526 ClassGuid ++;
527 continue;
528 }
529
530 *PromptId = ((EFI_IFR_FORM_SET *)Ptr)->FormSetTitle;
531 *HelpId = ((EFI_IFR_FORM_SET *)Ptr)->Help;
532 CopyMem (FormsetGuid, &((EFI_IFR_FORM_SET *) Ptr)->Guid, sizeof (EFI_GUID));
533 RetVal = TRUE;
534 }
535 }
536
537 FreePool (Buffer);
538
539 return RetVal;
540 }
541
542 /**
543 Search the drivers in the system which need to show in the front page
544 and insert the menu to the front page.
545
546 @param HiiHandle The hii handle for the Uiapp driver.
547 @param ClassGuid The class guid for the driver which is the target.
548 @param StartOpCodeHandle The opcode handle to save the new opcode.
549 @param SpecialHandler The pointer to the specail handler function, if any.
550
551 @retval EFI_SUCCESS Search the driver success
552
553 **/
554 EFI_STATUS
555 UiListThirdPartyDrivers (
556 IN EFI_HII_HANDLE HiiHandle,
557 IN EFI_GUID *ClassGuid,
558 IN DRIVER_SPECIAL_HANDLER SpecialHandlerFn,
559 IN VOID *StartOpCodeHandle
560 )
561 {
562 UINTN Index;
563 EFI_STRING String;
564 EFI_STRING_ID Token;
565 EFI_STRING_ID TokenHelp;
566 EFI_HII_HANDLE *HiiHandles;
567 CHAR16 *DevicePathStr;
568 UINTN Count;
569 UINTN CurrentSize;
570 UI_HII_DRIVER_INSTANCE *DriverListPtr;
571 EFI_STRING NewName;
572 BOOLEAN EmptyLineAfter;
573
574 if (gHiiDriverList != NULL) {
575 FreePool (gHiiDriverList);
576 }
577
578 HiiHandles = HiiGetHiiHandles (NULL);
579 ASSERT (HiiHandles != NULL);
580
581 gHiiDriverList = AllocateZeroPool (UI_HII_DRIVER_LIST_SIZE * sizeof (UI_HII_DRIVER_INSTANCE));
582 ASSERT (gHiiDriverList != NULL);
583 DriverListPtr = gHiiDriverList;
584 CurrentSize = UI_HII_DRIVER_LIST_SIZE;
585
586 for (Index = 0, Count = 0; HiiHandles[Index] != NULL; Index++) {
587 if (!RequiredDriver (HiiHandles[Index], ClassGuid, &Token, &TokenHelp, &gHiiDriverList[Count].FormSetGuid)) {
588 continue;
589 }
590
591 String = HiiGetString (HiiHandles[Index], Token, NULL);
592 if (String == NULL) {
593 String = HiiGetString (gHiiHandle, STRING_TOKEN (STR_MISSING_STRING), NULL);
594 ASSERT (String != NULL);
595 } else if (SpecialHandlerFn != NULL) {
596 //
597 // Check whether need to rename the driver name.
598 //
599 EmptyLineAfter = FALSE;
600 if (SpecialHandlerFn (String, &NewName, &EmptyLineAfter)) {
601 FreePool (String);
602 String = NewName;
603 DriverListPtr[Count].EmptyLineAfter = EmptyLineAfter;
604 }
605 }
606 DriverListPtr[Count].PromptId = HiiSetString (HiiHandle, 0, String, NULL);
607 FreePool (String);
608
609 String = HiiGetString (HiiHandles[Index], TokenHelp, NULL);
610 if (String == NULL) {
611 String = HiiGetString (gHiiHandle, STRING_TOKEN (STR_MISSING_STRING), NULL);
612 ASSERT (String != NULL);
613 }
614 DriverListPtr[Count].HelpId = HiiSetString (HiiHandle, 0, String, NULL);
615 FreePool (String);
616
617 DevicePathStr = ExtractDevicePathFromHiiHandle(HiiHandles[Index]);
618 if (DevicePathStr != NULL){
619 DriverListPtr[Count].DevicePathId = HiiSetString (HiiHandle, 0, DevicePathStr, NULL);
620 FreePool (DevicePathStr);
621 } else {
622 DriverListPtr[Count].DevicePathId = 0;
623 }
624
625 Count++;
626 if (Count >= CurrentSize) {
627 DriverListPtr = AllocateCopyPool ((Count + UI_HII_DRIVER_LIST_SIZE) * sizeof (UI_HII_DRIVER_INSTANCE), gHiiDriverList);
628 ASSERT (DriverListPtr != NULL);
629 FreePool (gHiiDriverList);
630 gHiiDriverList = DriverListPtr;
631 CurrentSize += UI_HII_DRIVER_LIST_SIZE;
632 }
633 }
634
635 FreePool (HiiHandles);
636
637 Index = 0;
638 while (gHiiDriverList[Index].PromptId != 0) {
639 HiiCreateGotoExOpCode (
640 StartOpCodeHandle,
641 0,
642 gHiiDriverList[Index].PromptId,
643 gHiiDriverList[Index].HelpId,
644 0,
645 0,
646 0,
647 &gHiiDriverList[Index].FormSetGuid,
648 gHiiDriverList[Index].DevicePathId
649 );
650
651 if (gHiiDriverList[Index].EmptyLineAfter) {
652 UiCreateEmptyLine (HiiHandle, StartOpCodeHandle);
653 }
654
655 Index ++;
656 }
657
658 return EFI_SUCCESS;
659 }
EFI Development Kit II mirror for PVE