]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Universal/BdsDxe/FrontPage.c
Fix a typo in Pcd name
[mirror_edk2.git] / MdeModulePkg / Universal / BdsDxe / FrontPage.c
1 /** @file
2 FrontPage routines to handle the callbacks and browser calls
3
4 Copyright (c) 2004 - 2008, Intel Corporation. <BR>
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
9
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12
13 **/
14
15 #include "Bds.h"
16 #include "FrontPage.h"
17
18 EFI_GUID mFrontPageGuid = FRONT_PAGE_FORMSET_GUID;
19
20 BOOLEAN gConnectAllHappened = FALSE;
21 UINTN gCallbackKey;
22
23 EFI_HII_DATABASE_PROTOCOL *gHiiDatabase;
24 EFI_HII_STRING_PROTOCOL *gHiiString;
25 EFI_FORM_BROWSER2_PROTOCOL *gFormBrowser2;
26 EFI_HII_CONFIG_ROUTING_PROTOCOL *gHiiConfigRouting;
27
28 FRONT_PAGE_CALLBACK_DATA gFrontPagePrivate = {
29 FRONT_PAGE_CALLBACK_DATA_SIGNATURE,
30 NULL,
31 NULL,
32 NULL,
33 {
34 FakeExtractConfig,
35 FakeRouteConfig,
36 FrontPageCallback
37 }
38 };
39
40 /**
41 This function allows a caller to extract the current configuration for one
42 or more named elements from the target driver.
43
44
45 @param This - Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
46 @param Request - A null-terminated Unicode string in <ConfigRequest> format.
47 @param Progress - On return, points to a character in the Request string.
48 Points to the string's null terminator if request was successful.
49 Points to the most recent '&' before the first failing name/value
50 pair (or the beginning of the string if the failure is in the
51 first name/value pair) if the request was not successful.
52 @param Results - A null-terminated Unicode string in <ConfigAltResp> format which
53 has all values filled in for the names in the Request string.
54 String to be allocated by the called function.
55
56 @retval EFI_SUCCESS The Results is filled with the requested values.
57 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.
58 @retval EFI_INVALID_PARAMETER Request is NULL, illegal syntax, or unknown name.
59 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver.
60
61 **/
62 EFI_STATUS
63 EFIAPI
64 FakeExtractConfig (
65 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,
66 IN CONST EFI_STRING Request,
67 OUT EFI_STRING *Progress,
68 OUT EFI_STRING *Results
69 )
70 {
71 return EFI_NOT_FOUND;
72 }
73
74 /**
75 This function processes the results of changes in configuration.
76
77
78 @param This - Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
79 @param Configuration - A null-terminated Unicode string in <ConfigResp> format.
80 @param Progress - A pointer to a string filled in with the offset of the most
81 recent '&' before the first failing name/value pair (or the
82 beginning of the string if the failure is in the first
83 name/value pair) or the terminating NULL if all was successful.
84
85 @retval EFI_SUCCESS The Results is processed successfully.
86 @retval EFI_INVALID_PARAMETER Configuration is NULL.
87 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver.
88
89 **/
90 EFI_STATUS
91 EFIAPI
92 FakeRouteConfig (
93 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,
94 IN CONST EFI_STRING Configuration,
95 OUT EFI_STRING *Progress
96 )
97 {
98 return EFI_SUCCESS;
99 }
100
101 /**
102 This function processes the results of changes in configuration.
103
104
105 @param This - Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
106 @param Action - Specifies the type of action taken by the browser.
107 @param QuestionId - A unique value which is sent to the original exporting driver
108 so that it can identify the type of data to expect.
109 @param Type - The type of value for the question.
110 @param Value - A pointer to the data being sent to the original exporting driver.
111 @param ActionRequest - On return, points to the action requested by the callback function.
112
113 @retval EFI_SUCCESS The callback successfully handled the action.
114 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
115 @retval EFI_DEVICE_ERROR The variable could not be saved.
116 @retval EFI_UNSUPPORTED The specified Action is not supported by the callback.
117
118 **/
119 EFI_STATUS
120 EFIAPI
121 FrontPageCallback (
122 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,
123 IN EFI_BROWSER_ACTION Action,
124 IN EFI_QUESTION_ID QuestionId,
125 IN UINT8 Type,
126 IN EFI_IFR_TYPE_VALUE *Value,
127 OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest
128 )
129 {
130 CHAR8 *LanguageString;
131 CHAR8 *LangCode;
132 CHAR8 Lang[RFC_3066_ENTRY_SIZE];
133 CHAR8 OldLang[ISO_639_2_ENTRY_SIZE];
134 UINTN Index;
135 EFI_STATUS Status;
136
137 if ((Value == NULL) || (ActionRequest == NULL)) {
138 return EFI_INVALID_PARAMETER;
139 }
140
141 gCallbackKey = QuestionId;
142
143 //
144 // The first 4 entries in the Front Page are to be GUARANTEED to remain constant so IHV's can
145 // describe to their customers in documentation how to find their setup information (namely
146 // under the device manager and specific buckets)
147 //
148 switch (QuestionId) {
149 case FRONT_PAGE_KEY_CONTINUE:
150 //
151 // This is the continue - clear the screen and return an error to get out of FrontPage loop
152 //
153 break;
154
155 case FRONT_PAGE_KEY_LANGUAGE:
156 //
157 // Collect the languages from what our current Language support is based on our VFR
158 //
159 LanguageString = HiiLibGetSupportedLanguages (gFrontPagePrivate.HiiHandle);
160 ASSERT (LanguageString != NULL);
161
162 Index = 0;
163 LangCode = LanguageString;
164 while (*LangCode != 0) {
165 HiiLibGetNextLanguage (&LangCode, Lang);
166
167 if (Index == Value->u8) {
168 break;
169 }
170
171 Index++;
172 }
173
174 Status = gRT->SetVariable (
175 L"PlatformLang",
176 &gEfiGlobalVariableGuid,
177 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,
178 AsciiStrSize (Lang),
179 Lang
180 );
181
182 if (!FeaturePcdGet (PcdUefiVariableDefaultLangDeprecate)) {
183 //
184 // Set UEFI deprecated variable "Lang" for backwards compatibility
185 //
186 Status = ConvertRfc3066LanguageToIso639Language (Lang, OldLang);
187 if (!EFI_ERROR (Status)) {
188 Status = gRT->SetVariable (
189 L"Lang",
190 &gEfiGlobalVariableGuid,
191 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,
192 ISO_639_2_ENTRY_SIZE,
193 OldLang
194 );
195 }
196 }
197
198 FreePool (LanguageString);
199 break;
200
201 case FRONT_PAGE_KEY_BOOT_MANAGER:
202 //
203 // Boot Manager
204 //
205 break;
206
207 case FRONT_PAGE_KEY_DEVICE_MANAGER:
208 //
209 // Device Manager
210 //
211 break;
212
213 case FRONT_PAGE_KEY_BOOT_MAINTAIN:
214 //
215 // Boot Maintenance Manager
216 //
217 break;
218
219 default:
220 gCallbackKey = 0;
221 break;
222 }
223
224 *ActionRequest = EFI_BROWSER_ACTION_REQUEST_EXIT;
225
226 return EFI_SUCCESS;
227 }
228
229 /**
230 Initialize HII information for the FrontPage
231
232
233 @param InitializeHiiData TRUE if HII elements need to be initialized.
234
235 @retval EFI_SUCCESS The operation is successful.
236 @retval EFI_DEVICE_ERROR If the dynamic opcode creation failed.
237
238 **/
239 EFI_STATUS
240 InitializeFrontPage (
241 IN BOOLEAN InitializeHiiData
242 )
243 {
244 EFI_STATUS Status;
245 EFI_HII_PACKAGE_LIST_HEADER *PackageList;
246 EFI_HII_UPDATE_DATA UpdateData;
247 IFR_OPTION *OptionList;
248 CHAR8 *LanguageString;
249 CHAR8 *LangCode;
250 CHAR8 Lang[RFC_3066_ENTRY_SIZE];
251 CHAR8 CurrentLang[RFC_3066_ENTRY_SIZE];
252 UINTN OptionCount;
253 EFI_STRING_ID Token;
254 CHAR16 *StringBuffer;
255 UINTN BufferSize;
256 UINTN Index;
257 EFI_HII_HANDLE HiiHandle;
258
259 if (InitializeHiiData) {
260 //
261 // Initialize the Device Manager
262 //
263 InitializeDeviceManager ();
264
265 //
266 // Initialize the Device Manager
267 //
268 InitializeBootManager ();
269
270 gCallbackKey = 0;
271
272 //
273 // Locate Hii relative protocols
274 //
275 Status = gBS->LocateProtocol (&gEfiHiiDatabaseProtocolGuid, NULL, (VOID **) &gHiiDatabase);
276 if (EFI_ERROR (Status)) {
277 return Status;
278 }
279
280 Status = gBS->LocateProtocol (&gEfiHiiStringProtocolGuid, NULL, (VOID **) &gHiiString);
281 if (EFI_ERROR (Status)) {
282 return Status;
283 }
284
285 Status = gBS->LocateProtocol (&gEfiFormBrowser2ProtocolGuid, NULL, (VOID **) &gFormBrowser2);
286 if (EFI_ERROR (Status)) {
287 return Status;
288 }
289
290 Status = gBS->LocateProtocol (&gEfiHiiConfigRoutingProtocolGuid, NULL, (VOID **) &gHiiConfigRouting);
291 if (EFI_ERROR (Status)) {
292 return Status;
293 }
294
295 //
296 // Create driver handle used by HII database
297 //
298 Status = HiiLibCreateHiiDriverHandle (&gFrontPagePrivate.DriverHandle);
299 if (EFI_ERROR (Status)) {
300 return Status;
301 }
302
303 //
304 // Install Config Access protocol to driver handle
305 //
306 Status = gBS->InstallProtocolInterface (
307 &gFrontPagePrivate.DriverHandle,
308 &gEfiHiiConfigAccessProtocolGuid,
309 EFI_NATIVE_INTERFACE,
310 &gFrontPagePrivate.ConfigAccess
311 );
312 ASSERT_EFI_ERROR (Status);
313
314 //
315 // Publish our HII data
316 //
317 PackageList = HiiLibPreparePackageList (2, &mFrontPageGuid, FrontPageVfrBin, BdsDxeStrings);
318 ASSERT (PackageList != NULL);
319
320 Status = gHiiDatabase->NewPackageList (
321 gHiiDatabase,
322 PackageList,
323 gFrontPagePrivate.DriverHandle,
324 &gFrontPagePrivate.HiiHandle
325 );
326 FreePool (PackageList);
327 if (EFI_ERROR (Status)) {
328 return Status;
329 }
330 }
331
332 //
333 // Get current language setting
334 //
335 HiiLibGetCurrentLanguage (CurrentLang);
336
337 //
338 // Allocate space for creation of UpdateData Buffer
339 //
340 UpdateData.BufferSize = 0x1000;
341 UpdateData.Data = AllocateZeroPool (0x1000);
342 ASSERT (UpdateData.Data != NULL);
343
344 OptionList = AllocateZeroPool (0x1000);
345 ASSERT (OptionList != NULL);
346
347 //
348 // Collect the languages from what our current Language support is based on our VFR
349 //
350 HiiHandle = gFrontPagePrivate.HiiHandle;
351 LanguageString = HiiLibGetSupportedLanguages (HiiHandle);
352 ASSERT (LanguageString != NULL);
353
354 OptionCount = 0;
355 LangCode = LanguageString;
356 while (*LangCode != 0) {
357 HiiLibGetNextLanguage (&LangCode, Lang);
358
359 if (gFrontPagePrivate.LanguageToken == NULL) {
360 //
361 // Get Language Name from String Package. The StringId of Printable Language
362 // Name is always 1 which is generated by StringGather Tool.
363 //
364 BufferSize = 0x100;
365 StringBuffer = AllocatePool (BufferSize);
366 Status = gHiiString->GetString (
367 gHiiString,
368 Lang,
369 HiiHandle,
370 PRINTABLE_LANGUAGE_NAME_STRING_ID,
371 StringBuffer,
372 &BufferSize,
373 NULL
374 );
375 if (Status == EFI_BUFFER_TOO_SMALL) {
376 FreePool (StringBuffer);
377 StringBuffer = AllocatePool (BufferSize);
378 Status = gHiiString->GetString (
379 gHiiString,
380 Lang,
381 HiiHandle,
382 PRINTABLE_LANGUAGE_NAME_STRING_ID,
383 StringBuffer,
384 &BufferSize,
385 NULL
386 );
387 }
388 ASSERT_EFI_ERROR (Status);
389
390 Token = 0;
391 Status = HiiLibNewString (HiiHandle, &Token, StringBuffer);
392 FreePool (StringBuffer);
393 } else {
394 Token = gFrontPagePrivate.LanguageToken[OptionCount];
395 }
396
397 if (AsciiStrCmp (Lang, CurrentLang) == 0) {
398 OptionList[OptionCount].Flags = EFI_IFR_OPTION_DEFAULT;
399 } else {
400 OptionList[OptionCount].Flags = 0;
401 }
402 OptionList[OptionCount].StringToken = Token;
403 OptionList[OptionCount].Value.u8 = (UINT8) OptionCount;
404
405 OptionCount++;
406 }
407
408 FreePool (LanguageString);
409
410 UpdateData.Offset = 0;
411 CreateOneOfOpCode (
412 FRONT_PAGE_KEY_LANGUAGE,
413 0,
414 0,
415 STRING_TOKEN (STR_LANGUAGE_SELECT),
416 STRING_TOKEN (STR_LANGUAGE_SELECT_HELP),
417 EFI_IFR_FLAG_CALLBACK,
418 EFI_IFR_NUMERIC_SIZE_1,
419 OptionList,
420 OptionCount,
421 &UpdateData
422 );
423
424 Status = IfrLibUpdateForm (
425 HiiHandle,
426 &mFrontPageGuid,
427 FRONT_PAGE_FORM_ID,
428 LABEL_SELECT_LANGUAGE,
429 FALSE,
430 &UpdateData
431 );
432
433 //
434 // Save the string Id for each language
435 //
436 gFrontPagePrivate.LanguageToken = AllocatePool (OptionCount * sizeof (EFI_STRING_ID));
437 ASSERT (gFrontPagePrivate.LanguageToken != NULL);
438 for (Index = 0; Index < OptionCount; Index++) {
439 gFrontPagePrivate.LanguageToken[Index] = OptionList[Index].StringToken;
440 }
441
442 FreePool (UpdateData.Data);
443 FreePool (OptionList);
444 return Status;
445 }
446
447 /**
448 Call the browser and display the front page
449
450 @return Status code that will be returned by
451 EFI_FORM_BROWSER2_PROTOCOL.SendForm ().
452
453 **/
454 EFI_STATUS
455 CallFrontPage (
456 VOID
457 )
458 {
459 EFI_STATUS Status;
460 EFI_BROWSER_ACTION_REQUEST ActionRequest;
461
462 //
463 // Begin waiting for USER INPUT
464 //
465 REPORT_STATUS_CODE (
466 EFI_PROGRESS_CODE,
467 (EFI_SOFTWARE_DXE_BS_DRIVER | EFI_SW_PC_INPUT_WAIT)
468 );
469
470 ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;
471 Status = gFormBrowser2->SendForm (
472 gFormBrowser2,
473 &gFrontPagePrivate.HiiHandle,
474 1,
475 NULL,
476 0,
477 NULL,
478 &ActionRequest
479 );
480 //
481 // Check whether user change any option setting which needs a reset to be effective
482 //
483 if (ActionRequest == EFI_BROWSER_ACTION_REQUEST_RESET) {
484 EnableResetRequired ();
485 }
486
487 return Status;
488 }
489
490 /**
491 Acquire the string associated with the ProducerGuid and return it.
492
493
494 @param ProducerGuid - The Guid to search the HII database for
495 @param Token - The token value of the string to extract
496 @param String - The string that is extracted
497
498 @retval EFI_SUCCESS The function returns EFI_SUCCESS always.
499
500 **/
501 EFI_STATUS
502 GetProducerString (
503 IN EFI_GUID *ProducerGuid,
504 IN EFI_STRING_ID Token,
505 OUT CHAR16 **String
506 )
507 {
508 EFI_STATUS Status;
509
510 Status = HiiLibGetStringFromToken (ProducerGuid, Token, String);
511 if (EFI_ERROR (Status)) {
512 *String = GetStringById (STRING_TOKEN (STR_MISSING_STRING));
513 }
514
515 return EFI_SUCCESS;
516 }
517
518 /**
519 Convert Processor Frequency Data to a string
520
521
522 @param ProcessorFrequency - The frequency data to process
523 @param String - The string that is created
524
525 @return VOID.
526
527 **/
528 VOID
529 ConvertProcessorToString (
530 IN EFI_PROCESSOR_CORE_FREQUENCY_DATA *ProcessorFrequency,
531 OUT CHAR16 **String
532 )
533 {
534 CHAR16 *StringBuffer;
535 UINTN Index;
536 UINT32 FreqMhz;
537
538 if (ProcessorFrequency->Exponent >= 6) {
539 FreqMhz = ProcessorFrequency->Value;
540 for (Index = 0; Index < (UINTN) (ProcessorFrequency->Exponent - 6); Index++) {
541 FreqMhz *= 10;
542 }
543 } else {
544 FreqMhz = 0;
545 }
546
547 StringBuffer = AllocateZeroPool (0x20);
548 ASSERT (StringBuffer != NULL);
549 Index = UnicodeValueToString (StringBuffer, LEFT_JUSTIFY, FreqMhz / 1000, 3);
550 StrCat (StringBuffer, L".");
551 UnicodeValueToString (StringBuffer + Index + 1, PREFIX_ZERO, (FreqMhz % 1000) / 10, 2);
552 StrCat (StringBuffer, L" GHz");
553
554 *String = (CHAR16 *) StringBuffer;
555
556 return ;
557 }
558
559 /**
560 Convert Memory Size to a string.
561
562
563 @param MemorySize - The size of the memory to process
564 @param String - The string that is created
565
566 **/
567 VOID
568 ConvertMemorySizeToString (
569 IN UINT32 MemorySize,
570 OUT CHAR16 **String
571 )
572 {
573 CHAR16 *StringBuffer;
574
575 StringBuffer = AllocateZeroPool (0x20);
576 ASSERT (StringBuffer != NULL);
577 UnicodeValueToString (StringBuffer, LEFT_JUSTIFY, MemorySize, 6);
578 StrCat (StringBuffer, L" MB RAM");
579
580 *String = (CHAR16 *) StringBuffer;
581
582 return ;
583 }
584
585 /**
586 Update the banner information for the Front Page based on DataHub information.
587
588 **/
589 VOID
590 UpdateFrontPageStrings (
591 VOID
592 )
593 {
594 EFI_STATUS Status;
595 EFI_STRING_ID TokenToUpdate;
596 CHAR16 *NewString;
597 UINT64 MonotonicCount;
598 EFI_DATA_HUB_PROTOCOL *DataHub;
599 EFI_DATA_RECORD_HEADER *Record;
600 EFI_SUBCLASS_TYPE1_HEADER *DataHeader;
601 EFI_MISC_BIOS_VENDOR_DATA *BiosVendor;
602 EFI_MISC_SYSTEM_MANUFACTURER_DATA *SystemManufacturer;
603 EFI_PROCESSOR_VERSION_DATA *ProcessorVersion;
604 EFI_PROCESSOR_CORE_FREQUENCY_DATA *ProcessorFrequency;
605 EFI_MEMORY_ARRAY_START_ADDRESS_DATA *MemoryArray;
606 BOOLEAN Find[5];
607
608 ZeroMem (Find, sizeof (Find));
609
610 //
611 // Update Front Page strings
612 //
613 Status = gBS->LocateProtocol (
614 &gEfiDataHubProtocolGuid,
615 NULL,
616 (VOID **) &DataHub
617 );
618 ASSERT_EFI_ERROR (Status);
619
620 MonotonicCount = 0;
621 Record = NULL;
622 do {
623 Status = DataHub->GetNextRecord (DataHub, &MonotonicCount, NULL, &Record);
624 if (Record->DataRecordClass == EFI_DATA_RECORD_CLASS_DATA) {
625 DataHeader = (EFI_SUBCLASS_TYPE1_HEADER *) (Record + 1);
626 if (CompareGuid (&Record->DataRecordGuid, &gEfiMiscSubClassGuid) &&
627 (DataHeader->RecordType == EFI_MISC_BIOS_VENDOR_RECORD_NUMBER)
628 ) {
629 BiosVendor = (EFI_MISC_BIOS_VENDOR_DATA *) (DataHeader + 1);
630 GetProducerString (&Record->ProducerName, BiosVendor->BiosVersion, &NewString);
631 TokenToUpdate = STRING_TOKEN (STR_FRONT_PAGE_BIOS_VERSION);
632 HiiLibSetString (gFrontPagePrivate.HiiHandle, TokenToUpdate, NewString);
633 FreePool (NewString);
634 Find[0] = TRUE;
635 }
636
637 if (CompareGuid (&Record->DataRecordGuid, &gEfiMiscSubClassGuid) &&
638 (DataHeader->RecordType == EFI_MISC_SYSTEM_MANUFACTURER_RECORD_NUMBER)
639 ) {
640 SystemManufacturer = (EFI_MISC_SYSTEM_MANUFACTURER_DATA *) (DataHeader + 1);
641 GetProducerString (&Record->ProducerName, SystemManufacturer->SystemProductName, &NewString);
642 TokenToUpdate = STRING_TOKEN (STR_FRONT_PAGE_COMPUTER_MODEL);
643 HiiLibSetString (gFrontPagePrivate.HiiHandle, TokenToUpdate, NewString);
644 FreePool (NewString);
645 Find[1] = TRUE;
646 }
647
648 if (CompareGuid (&Record->DataRecordGuid, &gEfiProcessorSubClassGuid) &&
649 (DataHeader->RecordType == ProcessorVersionRecordType)
650 ) {
651 ProcessorVersion = (EFI_PROCESSOR_VERSION_DATA *) (DataHeader + 1);
652 GetProducerString (&Record->ProducerName, *ProcessorVersion, &NewString);
653 TokenToUpdate = STRING_TOKEN (STR_FRONT_PAGE_CPU_MODEL);
654 HiiLibSetString (gFrontPagePrivate.HiiHandle, TokenToUpdate, NewString);
655 FreePool (NewString);
656 Find[2] = TRUE;
657 }
658
659 if (CompareGuid (&Record->DataRecordGuid, &gEfiProcessorSubClassGuid) &&
660 (DataHeader->RecordType == ProcessorCoreFrequencyRecordType)
661 ) {
662 ProcessorFrequency = (EFI_PROCESSOR_CORE_FREQUENCY_DATA *) (DataHeader + 1);
663 ConvertProcessorToString (ProcessorFrequency, &NewString);
664 TokenToUpdate = STRING_TOKEN (STR_FRONT_PAGE_CPU_SPEED);
665 HiiLibSetString (gFrontPagePrivate.HiiHandle, TokenToUpdate, NewString);
666 FreePool (NewString);
667 Find[3] = TRUE;
668 }
669
670 if (CompareGuid (&Record->DataRecordGuid, &gEfiMemorySubClassGuid) &&
671 (DataHeader->RecordType == EFI_MEMORY_ARRAY_START_ADDRESS_RECORD_NUMBER)
672 ) {
673 MemoryArray = (EFI_MEMORY_ARRAY_START_ADDRESS_DATA *) (DataHeader + 1);
674 ConvertMemorySizeToString (
675 (UINT32)(RShiftU64((MemoryArray->MemoryArrayEndAddress - MemoryArray->MemoryArrayStartAddress + 1), 20)),
676 &NewString
677 );
678 TokenToUpdate = STRING_TOKEN (STR_FRONT_PAGE_MEMORY_SIZE);
679 HiiLibSetString (gFrontPagePrivate.HiiHandle, TokenToUpdate, NewString);
680 FreePool (NewString);
681 Find[4] = TRUE;
682 }
683 }
684 } while (!EFI_ERROR (Status) && (MonotonicCount != 0) && !(Find[0] && Find[1] && Find[2] && Find[3] && Find[4]));
685
686 return ;
687 }
688
689 /**
690 Function waits for a given event to fire, or for an optional timeout to expire.
691
692
693 @param Event The event to wait for
694
695 @param Timeout An optional timeout value in 100 ns units.
696
697 @retval EFI_SUCCESS Event fired before Timeout expired.
698 @retval EFI_TIME_OUT Timout expired before Event fired..
699
700 **/
701 EFI_STATUS
702 WaitForSingleEvent (
703 IN EFI_EVENT Event,
704 IN UINT64 Timeout OPTIONAL
705 )
706 {
707 EFI_STATUS Status;
708 UINTN Index;
709 EFI_EVENT TimerEvent;
710 EFI_EVENT WaitList[2];
711
712 if (Timeout != 0) {
713 //
714 // Create a timer event
715 //
716 Status = gBS->CreateEvent (EVT_TIMER, 0, NULL, NULL, &TimerEvent);
717 if (!EFI_ERROR (Status)) {
718 //
719 // Set the timer event
720 //
721 gBS->SetTimer (
722 TimerEvent,
723 TimerRelative,
724 Timeout
725 );
726
727 //
728 // Wait for the original event or the timer
729 //
730 WaitList[0] = Event;
731 WaitList[1] = TimerEvent;
732 Status = gBS->WaitForEvent (2, WaitList, &Index);
733 gBS->CloseEvent (TimerEvent);
734
735 //
736 // If the timer expired, change the return to timed out
737 //
738 if (!EFI_ERROR (Status) && Index == 1) {
739 Status = EFI_TIMEOUT;
740 }
741 }
742 } else {
743 //
744 // No timeout... just wait on the event
745 //
746 Status = gBS->WaitForEvent (1, &Event, &Index);
747 ASSERT (!EFI_ERROR (Status));
748 ASSERT (Index == 0);
749 }
750
751 return Status;
752 }
753
754 /**
755 Function show progress bar to wait for user input.
756
757
758 @param TimeoutDefault - The fault time out value before the system
759 continue to boot.
760
761 @retval EFI_SUCCESS User pressed some key except "Enter"
762 @retval EFI_TIME_OUT Timout expired or user press "Enter"
763
764 **/
765 EFI_STATUS
766 ShowProgress (
767 IN UINT16 TimeoutDefault
768 )
769 {
770 EFI_STATUS Status;
771 CHAR16 *TmpStr;
772 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground;
773 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background;
774 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Color;
775 EFI_INPUT_KEY Key;
776 UINT16 TimeoutRemain;
777
778 if (TimeoutDefault == 0) {
779 return EFI_TIMEOUT;
780 }
781
782 DEBUG ((EFI_D_INFO, "\n\nStart showing progress bar... Press any key to stop it! ...Zzz....\n"));
783
784 SetMem (&Foreground, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL), 0xff);
785 SetMem (&Background, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL), 0x0);
786 SetMem (&Color, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL), 0xff);
787
788 //
789 // Clear the progress status bar first
790 //
791 TmpStr = GetStringById (STRING_TOKEN (STR_START_BOOT_OPTION));
792 if (TmpStr != NULL) {
793 PlatformBdsShowProgress (Foreground, Background, TmpStr, Color, 0, 0);
794 }
795
796 TimeoutRemain = TimeoutDefault;
797 while (TimeoutRemain != 0) {
798 DEBUG ((EFI_D_INFO, "Showing progress bar...Remaining %d second!\n", TimeoutRemain));
799
800 Status = WaitForSingleEvent (gST->ConIn->WaitForKey, ONE_SECOND);
801 if (Status != EFI_TIMEOUT) {
802 break;
803 }
804 TimeoutRemain--;
805
806 //
807 // Show progress
808 //
809 if (TmpStr != NULL) {
810 PlatformBdsShowProgress (
811 Foreground,
812 Background,
813 TmpStr,
814 Color,
815 ((TimeoutDefault - TimeoutRemain) * 100 / TimeoutDefault),
816 0
817 );
818 }
819 }
820 gBS->FreePool (TmpStr);
821
822 //
823 // Timeout expired
824 //
825 if (TimeoutRemain == 0) {
826 return EFI_TIMEOUT;
827 }
828
829 //
830 // User pressed some key
831 //
832 Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);
833 if (EFI_ERROR (Status)) {
834 return Status;
835 }
836
837 if (Key.UnicodeChar == CHAR_CARRIAGE_RETURN) {
838 //
839 // User pressed enter, equivalent to select "continue"
840 //
841 return EFI_TIMEOUT;
842 }
843
844 return EFI_SUCCESS;
845 }
846
847 /**
848 This function is the main entry of the platform setup entry.
849 The function will present the main menu of the system setup,
850 this is the platform reference part and can be customize.
851
852
853 @param TimeoutDefault - The fault time out value before the system
854 continue to boot.
855 @param ConnectAllHappened - The indicater to check if the connect all have
856 already happended.
857
858 @return VOID.
859
860 **/
861 VOID
862 PlatformBdsEnterFrontPage (
863 IN UINT16 TimeoutDefault,
864 IN BOOLEAN ConnectAllHappened
865 )
866 {
867 EFI_STATUS Status;
868 EFI_CONSOLE_CONTROL_PROTOCOL *ConsoleControl;
869
870 PERF_START (0, "BdsTimeOut", "BDS", 0);
871 //
872 // Indicate if we need connect all in the platform setup
873 //
874 if (ConnectAllHappened) {
875 gConnectAllHappened = TRUE;
876 }
877
878 if (TimeoutDefault != 0xffff) {
879 Status = ShowProgress (TimeoutDefault);
880
881 //
882 // Ensure screen is clear when switch Console from Graphics mode to Text mode
883 //
884 gST->ConOut->EnableCursor (gST->ConOut, TRUE);
885 gST->ConOut->ClearScreen (gST->ConOut);
886
887 if (EFI_ERROR (Status)) {
888 //
889 // Timeout or user press enter to continue
890 //
891 goto Exit;
892 }
893 }
894
895 do {
896
897 InitializeFrontPage (FALSE);
898
899 //
900 // Update Front Page strings
901 //
902 UpdateFrontPageStrings ();
903
904 gCallbackKey = 0;
905 Status = CallFrontPage ();
906
907 //
908 // If gCallbackKey is greater than 1 and less or equal to 5,
909 // it will lauch configuration utilities.
910 // 2 = set language
911 // 3 = boot manager
912 // 4 = device manager
913 // 5 = boot maintainenance manager
914 //
915 if (gCallbackKey != 0) {
916 REPORT_STATUS_CODE (
917 EFI_PROGRESS_CODE,
918 (EFI_SOFTWARE_DXE_BS_DRIVER | EFI_SW_PC_USER_SETUP)
919 );
920 }
921 //
922 // Based on the key that was set, we can determine what to do
923 //
924 switch (gCallbackKey) {
925 //
926 // The first 4 entries in the Front Page are to be GUARANTEED to remain constant so IHV's can
927 // describe to their customers in documentation how to find their setup information (namely
928 // under the device manager and specific buckets)
929 //
930 // These entries consist of the Continue, Select language, Boot Manager, and Device Manager
931 //
932 case FRONT_PAGE_KEY_CONTINUE:
933 //
934 // User hit continue
935 //
936 break;
937
938 case FRONT_PAGE_KEY_LANGUAGE:
939 //
940 // User made a language setting change - display front page again
941 //
942 break;
943
944 case FRONT_PAGE_KEY_BOOT_MANAGER:
945 //
946 // User chose to run the Boot Manager
947 //
948 CallBootManager ();
949 break;
950
951 case FRONT_PAGE_KEY_DEVICE_MANAGER:
952 //
953 // Display the Device Manager
954 //
955 do {
956 CallDeviceManager();
957 } while (gCallbackKey == FRONT_PAGE_KEY_DEVICE_MANAGER);
958 break;
959
960 case FRONT_PAGE_KEY_BOOT_MAINTAIN:
961 //
962 // Display the Boot Maintenance Manager
963 //
964 BdsStartBootMaint ();
965 break;
966 }
967
968 } while ((Status == EFI_SUCCESS) && (gCallbackKey != FRONT_PAGE_KEY_CONTINUE));
969
970 //
971 //Will leave browser, check any reset required change is applied? if yes, reset system
972 //
973 SetupResetReminder ();
974
975 Exit:
976 //
977 // Automatically load current entry
978 // Note: The following lines of code only execute when Auto boot
979 // takes affect
980 //
981 PERF_END (0, "BdsTimeOut", "BDS", 0);
982 Status = gBS->LocateProtocol (&gEfiConsoleControlProtocolGuid, NULL, (VOID **) &ConsoleControl);
983 ConsoleControl->SetMode (ConsoleControl, EfiConsoleControlScreenText);
984
985 }