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