]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Universal/BdsDxe/FrontPage.c
Code scrub for BdsDxe module.
[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 (PcdUefiVariableDefaultLangDepricate)) {
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
471 //
472 // Drop the TPL level from TPL_APPLICATION to TPL_APPLICATION
473 //
474 gBS->RestoreTPL (TPL_APPLICATION);
475
476 ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;
477 Status = gFormBrowser2->SendForm (
478 gFormBrowser2,
479 &gFrontPagePrivate.HiiHandle,
480 1,
481 NULL,
482 0,
483 NULL,
484 &ActionRequest
485 );
486 //
487 // Check whether user change any option setting which needs a reset to be effective
488 //
489 if (ActionRequest == EFI_BROWSER_ACTION_REQUEST_RESET) {
490 EnableResetRequired ();
491 }
492
493 gBS->RaiseTPL (TPL_APPLICATION);
494 return Status;
495 }
496
497 /**
498 Acquire the string associated with the ProducerGuid and return it.
499
500
501 @param ProducerGuid - The Guid to search the HII database for
502 @param Token - The token value of the string to extract
503 @param String - The string that is extracted
504
505 @retval EFI_SUCCESS The function returns EFI_SUCCESS always.
506
507 **/
508 EFI_STATUS
509 GetProducerString (
510 IN EFI_GUID *ProducerGuid,
511 IN EFI_STRING_ID Token,
512 OUT CHAR16 **String
513 )
514 {
515 EFI_STATUS Status;
516
517 Status = HiiLibGetStringFromToken (ProducerGuid, Token, String);
518 if (EFI_ERROR (Status)) {
519 *String = GetStringById (STRING_TOKEN (STR_MISSING_STRING));
520 }
521
522 return EFI_SUCCESS;
523 }
524
525 /**
526 Convert Processor Frequency Data to a string
527
528
529 @param ProcessorFrequency - The frequency data to process
530 @param String - The string that is created
531
532 @return VOID.
533
534 **/
535 VOID
536 ConvertProcessorToString (
537 IN EFI_PROCESSOR_CORE_FREQUENCY_DATA *ProcessorFrequency,
538 OUT CHAR16 **String
539 )
540 {
541 CHAR16 *StringBuffer;
542 UINTN Index;
543 UINT32 FreqMhz;
544
545 if (ProcessorFrequency->Exponent >= 6) {
546 FreqMhz = ProcessorFrequency->Value;
547 for (Index = 0; Index < (UINTN) (ProcessorFrequency->Exponent - 6); Index++) {
548 FreqMhz *= 10;
549 }
550 } else {
551 FreqMhz = 0;
552 }
553
554 StringBuffer = AllocateZeroPool (0x20);
555 ASSERT (StringBuffer != NULL);
556 Index = UnicodeValueToString (StringBuffer, LEFT_JUSTIFY, FreqMhz / 1000, 3);
557 StrCat (StringBuffer, L".");
558 UnicodeValueToString (StringBuffer + Index + 1, PREFIX_ZERO, (FreqMhz % 1000) / 10, 2);
559 StrCat (StringBuffer, L" GHz");
560
561 *String = (CHAR16 *) StringBuffer;
562
563 return ;
564 }
565
566 /**
567 Convert Memory Size to a string
568
569
570 @param MemorySize - The size of the memory to process
571 @param String - The string that is created
572
573 **/
574 VOID
575 ConvertMemorySizeToString (
576 IN UINT32 MemorySize,
577 OUT CHAR16 **String
578 )
579 {
580 CHAR16 *StringBuffer;
581
582 StringBuffer = AllocateZeroPool (0x20);
583 ASSERT (StringBuffer != NULL);
584 UnicodeValueToString (StringBuffer, LEFT_JUSTIFY, MemorySize, 6);
585 StrCat (StringBuffer, L" MB RAM");
586
587 *String = (CHAR16 *) StringBuffer;
588
589 return ;
590 }
591
592 /**
593 Update the banner information for the Front Page based on DataHub information.
594
595 **/
596 VOID
597 UpdateFrontPageStrings (
598 VOID
599 )
600 {
601 EFI_STATUS Status;
602 EFI_STRING_ID TokenToUpdate;
603 CHAR16 *NewString;
604 UINT64 MonotonicCount;
605 EFI_DATA_HUB_PROTOCOL *DataHub;
606 EFI_DATA_RECORD_HEADER *Record;
607 EFI_SUBCLASS_TYPE1_HEADER *DataHeader;
608 EFI_MISC_BIOS_VENDOR_DATA *BiosVendor;
609 EFI_MISC_SYSTEM_MANUFACTURER_DATA *SystemManufacturer;
610 EFI_PROCESSOR_VERSION_DATA *ProcessorVersion;
611 EFI_PROCESSOR_CORE_FREQUENCY_DATA *ProcessorFrequency;
612 EFI_MEMORY_ARRAY_START_ADDRESS_DATA *MemoryArray;
613 BOOLEAN Find[5];
614
615 ZeroMem (Find, sizeof (Find));
616
617 //
618 // Update Front Page strings
619 //
620 Status = gBS->LocateProtocol (
621 &gEfiDataHubProtocolGuid,
622 NULL,
623 (VOID **) &DataHub
624 );
625 ASSERT_EFI_ERROR (Status);
626
627 MonotonicCount = 0;
628 Record = NULL;
629 do {
630 Status = DataHub->GetNextRecord (DataHub, &MonotonicCount, NULL, &Record);
631 if (Record->DataRecordClass == EFI_DATA_RECORD_CLASS_DATA) {
632 DataHeader = (EFI_SUBCLASS_TYPE1_HEADER *) (Record + 1);
633 if (CompareGuid (&Record->DataRecordGuid, &gEfiMiscSubClassGuid) &&
634 (DataHeader->RecordType == EFI_MISC_BIOS_VENDOR_RECORD_NUMBER)
635 ) {
636 BiosVendor = (EFI_MISC_BIOS_VENDOR_DATA *) (DataHeader + 1);
637 GetProducerString (&Record->ProducerName, BiosVendor->BiosVersion, &NewString);
638 TokenToUpdate = STRING_TOKEN (STR_FRONT_PAGE_BIOS_VERSION);
639 HiiLibSetString (gFrontPagePrivate.HiiHandle, TokenToUpdate, NewString);
640 FreePool (NewString);
641 Find[0] = TRUE;
642 }
643
644 if (CompareGuid (&Record->DataRecordGuid, &gEfiMiscSubClassGuid) &&
645 (DataHeader->RecordType == EFI_MISC_SYSTEM_MANUFACTURER_RECORD_NUMBER)
646 ) {
647 SystemManufacturer = (EFI_MISC_SYSTEM_MANUFACTURER_DATA *) (DataHeader + 1);
648 GetProducerString (&Record->ProducerName, SystemManufacturer->SystemProductName, &NewString);
649 TokenToUpdate = STRING_TOKEN (STR_FRONT_PAGE_COMPUTER_MODEL);
650 HiiLibSetString (gFrontPagePrivate.HiiHandle, TokenToUpdate, NewString);
651 FreePool (NewString);
652 Find[1] = TRUE;
653 }
654
655 if (CompareGuid (&Record->DataRecordGuid, &gEfiProcessorSubClassGuid) &&
656 (DataHeader->RecordType == ProcessorVersionRecordType)
657 ) {
658 ProcessorVersion = (EFI_PROCESSOR_VERSION_DATA *) (DataHeader + 1);
659 GetProducerString (&Record->ProducerName, *ProcessorVersion, &NewString);
660 TokenToUpdate = STRING_TOKEN (STR_FRONT_PAGE_CPU_MODEL);
661 HiiLibSetString (gFrontPagePrivate.HiiHandle, TokenToUpdate, NewString);
662 FreePool (NewString);
663 Find[2] = TRUE;
664 }
665
666 if (CompareGuid (&Record->DataRecordGuid, &gEfiProcessorSubClassGuid) &&
667 (DataHeader->RecordType == ProcessorCoreFrequencyRecordType)
668 ) {
669 ProcessorFrequency = (EFI_PROCESSOR_CORE_FREQUENCY_DATA *) (DataHeader + 1);
670 ConvertProcessorToString (ProcessorFrequency, &NewString);
671 TokenToUpdate = STRING_TOKEN (STR_FRONT_PAGE_CPU_SPEED);
672 HiiLibSetString (gFrontPagePrivate.HiiHandle, TokenToUpdate, NewString);
673 FreePool (NewString);
674 Find[3] = TRUE;
675 }
676
677 if (CompareGuid (&Record->DataRecordGuid, &gEfiMemorySubClassGuid) &&
678 (DataHeader->RecordType == EFI_MEMORY_ARRAY_START_ADDRESS_RECORD_NUMBER)
679 ) {
680 MemoryArray = (EFI_MEMORY_ARRAY_START_ADDRESS_DATA *) (DataHeader + 1);
681 ConvertMemorySizeToString (
682 (UINT32)(RShiftU64((MemoryArray->MemoryArrayEndAddress - MemoryArray->MemoryArrayStartAddress + 1), 20)),
683 &NewString
684 );
685 TokenToUpdate = STRING_TOKEN (STR_FRONT_PAGE_MEMORY_SIZE);
686 HiiLibSetString (gFrontPagePrivate.HiiHandle, TokenToUpdate, NewString);
687 FreePool (NewString);
688 Find[4] = TRUE;
689 }
690 }
691 } while (!EFI_ERROR (Status) && (MonotonicCount != 0) && !(Find[0] && Find[1] && Find[2] && Find[3] && Find[4]));
692
693 return ;
694 }
695
696 /**
697 Function waits for a given event to fire, or for an optional timeout to expire.
698
699
700 @param Event The event to wait for
701
702 @param Timeout An optional timeout value in 100 ns units.
703
704 @retval EFI_SUCCESS Event fired before Timeout expired.
705 @retval EFI_TIME_OUT Timout expired before Event fired..
706
707 **/
708 EFI_STATUS
709 WaitForSingleEvent (
710 IN EFI_EVENT Event,
711 IN UINT64 Timeout OPTIONAL
712 )
713 {
714 EFI_STATUS Status;
715 UINTN Index;
716 EFI_EVENT TimerEvent;
717 EFI_EVENT WaitList[2];
718
719 if (Timeout != 0) {
720 //
721 // Create a timer event
722 //
723 Status = gBS->CreateEvent (EVT_TIMER, 0, NULL, NULL, &TimerEvent);
724 if (!EFI_ERROR (Status)) {
725 //
726 // Set the timer event
727 //
728 gBS->SetTimer (
729 TimerEvent,
730 TimerRelative,
731 Timeout
732 );
733
734 //
735 // Wait for the original event or the timer
736 //
737 WaitList[0] = Event;
738 WaitList[1] = TimerEvent;
739 Status = gBS->WaitForEvent (2, WaitList, &Index);
740 gBS->CloseEvent (TimerEvent);
741
742 //
743 // If the timer expired, change the return to timed out
744 //
745 if (!EFI_ERROR (Status) && Index == 1) {
746 Status = EFI_TIMEOUT;
747 }
748 }
749 } else {
750 //
751 // No timeout... just wait on the event
752 //
753 Status = gBS->WaitForEvent (1, &Event, &Index);
754 ASSERT (!EFI_ERROR (Status));
755 ASSERT (Index == 0);
756 }
757
758 return Status;
759 }
760
761 /**
762 Function show progress bar to wait for user input.
763
764
765 @param TimeoutDefault - The fault time out value before the system
766 continue to boot.
767
768 @retval EFI_SUCCESS User pressed some key except "Enter"
769 @retval EFI_TIME_OUT Timout expired or user press "Enter"
770
771 **/
772 EFI_STATUS
773 ShowProgress (
774 IN UINT16 TimeoutDefault
775 )
776 {
777 EFI_STATUS Status;
778 CHAR16 *TmpStr;
779 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground;
780 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background;
781 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Color;
782 EFI_INPUT_KEY Key;
783 UINT16 TimeoutRemain;
784
785 if (TimeoutDefault == 0) {
786 return EFI_TIMEOUT;
787 }
788
789 DEBUG ((EFI_D_INFO, "\n\nStart showing progress bar... Press any key to stop it! ...Zzz....\n"));
790
791 SetMem (&Foreground, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL), 0xff);
792 SetMem (&Background, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL), 0x0);
793 SetMem (&Color, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL), 0xff);
794
795 //
796 // Clear the progress status bar first
797 //
798 TmpStr = GetStringById (STRING_TOKEN (STR_START_BOOT_OPTION));
799 if (TmpStr != NULL) {
800 PlatformBdsShowProgress (Foreground, Background, TmpStr, Color, 0, 0);
801 }
802
803 TimeoutRemain = TimeoutDefault;
804 while (TimeoutRemain != 0) {
805 DEBUG ((EFI_D_INFO, "Showing progress bar...Remaining %d second!\n", TimeoutRemain));
806
807 Status = WaitForSingleEvent (gST->ConIn->WaitForKey, ONE_SECOND);
808 if (Status != EFI_TIMEOUT) {
809 break;
810 }
811 TimeoutRemain--;
812
813 //
814 // Show progress
815 //
816 if (TmpStr != NULL) {
817 PlatformBdsShowProgress (
818 Foreground,
819 Background,
820 TmpStr,
821 Color,
822 ((TimeoutDefault - TimeoutRemain) * 100 / TimeoutDefault),
823 0
824 );
825 }
826 }
827 gBS->FreePool (TmpStr);
828
829 //
830 // Timeout expired
831 //
832 if (TimeoutRemain == 0) {
833 return EFI_TIMEOUT;
834 }
835
836 //
837 // User pressed some key
838 //
839 Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);
840 if (EFI_ERROR (Status)) {
841 return Status;
842 }
843
844 if (Key.UnicodeChar == CHAR_CARRIAGE_RETURN) {
845 //
846 // User pressed enter, equivalent to select "continue"
847 //
848 return EFI_TIMEOUT;
849 }
850
851 return EFI_SUCCESS;
852 }
853
854 /**
855 This function is the main entry of the platform setup entry.
856 The function will present the main menu of the system setup,
857 this is the platform reference part and can be customize.
858
859
860 @param TimeoutDefault - The fault time out value before the system
861 continue to boot.
862 @param ConnectAllHappened - The indicater to check if the connect all have
863 already happended.
864
865 @return VOID.
866
867 **/
868 VOID
869 PlatformBdsEnterFrontPage (
870 IN UINT16 TimeoutDefault,
871 IN BOOLEAN ConnectAllHappened
872 )
873 {
874 EFI_STATUS Status;
875 EFI_CONSOLE_CONTROL_PROTOCOL *ConsoleControl;
876
877 PERF_START (0, "BdsTimeOut", "BDS", 0);
878 //
879 // Indicate if we need connect all in the platform setup
880 //
881 if (ConnectAllHappened) {
882 gConnectAllHappened = TRUE;
883 }
884
885 if (TimeoutDefault != 0xffff) {
886 gBS->RestoreTPL (TPL_APPLICATION);
887 Status = ShowProgress (TimeoutDefault);
888 gBS->RaiseTPL (TPL_APPLICATION);
889
890 if (EFI_ERROR (Status)) {
891 //
892 // Timeout or user press enter to continue
893 //
894 gST->ConOut->EnableCursor (gST->ConOut, TRUE);
895 gST->ConOut->ClearScreen (gST->ConOut);
896 goto Exit;
897 }
898 }
899
900 do {
901
902 InitializeFrontPage (FALSE);
903
904 //
905 // Update Front Page strings
906 //
907 UpdateFrontPageStrings ();
908
909 gCallbackKey = 0;
910 Status = CallFrontPage ();
911
912 //
913 // If gCallbackKey is greater than 1 and less or equal to 5,
914 // it will lauch configuration utilities.
915 // 2 = set language
916 // 3 = boot manager
917 // 4 = device manager
918 // 5 = boot maintainenance manager
919 //
920 if (gCallbackKey != 0) {
921 REPORT_STATUS_CODE (
922 EFI_PROGRESS_CODE,
923 (EFI_SOFTWARE_DXE_BS_DRIVER | EFI_SW_PC_USER_SETUP)
924 );
925 }
926 //
927 // Based on the key that was set, we can determine what to do
928 //
929 switch (gCallbackKey) {
930 //
931 // The first 4 entries in the Front Page are to be GUARANTEED to remain constant so IHV's can
932 // describe to their customers in documentation how to find their setup information (namely
933 // under the device manager and specific buckets)
934 //
935 // These entries consist of the Continue, Select language, Boot Manager, and Device Manager
936 //
937 case FRONT_PAGE_KEY_CONTINUE:
938 //
939 // User hit continue
940 //
941 break;
942
943 case FRONT_PAGE_KEY_LANGUAGE:
944 //
945 // User made a language setting change - display front page again
946 //
947 break;
948
949 case FRONT_PAGE_KEY_BOOT_MANAGER:
950 //
951 // User chose to run the Boot Manager
952 //
953 CallBootManager ();
954 break;
955
956 case FRONT_PAGE_KEY_DEVICE_MANAGER:
957 //
958 // Display the Device Manager
959 //
960 do {
961 CallDeviceManager();
962 } while (gCallbackKey == FRONT_PAGE_KEY_DEVICE_MANAGER);
963 break;
964
965 case FRONT_PAGE_KEY_BOOT_MAINTAIN:
966 //
967 // Display the Boot Maintenance Manager
968 //
969 BdsStartBootMaint ();
970 break;
971 }
972
973 } while ((Status == EFI_SUCCESS) && (gCallbackKey != FRONT_PAGE_KEY_CONTINUE));
974
975 //
976 //Will leave browser, check any reset required change is applied? if yes, reset system
977 //
978 gBS->RestoreTPL (TPL_APPLICATION);
979 SetupResetReminder ();
980 gBS->RaiseTPL (TPL_APPLICATION);
981
982 Exit:
983 //
984 // Automatically load current entry
985 // Note: The following lines of code only execute when Auto boot
986 // takes affect
987 //
988 PERF_END (0, "BdsTimeOut", "BDS", 0);
989 Status = gBS->LocateProtocol (&gEfiConsoleControlProtocolGuid, NULL, (VOID **) &ConsoleControl);
990 ConsoleControl->SetMode (ConsoleControl, EfiConsoleControlScreenText);
991
992 }