2 FrontPage routines to handle the callbacks and browser calls
4 Copyright (c) 2004 - 2009, 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
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.
16 #include "FrontPage.h"
19 EFI_GUID mFrontPageGuid
= FRONT_PAGE_FORMSET_GUID
;
21 BOOLEAN gConnectAllHappened
= FALSE
;
24 EFI_HII_DATABASE_PROTOCOL
*gHiiDatabase
;
25 EFI_HII_STRING_PROTOCOL
*gHiiString
;
26 EFI_FORM_BROWSER2_PROTOCOL
*gFormBrowser2
;
27 EFI_HII_CONFIG_ROUTING_PROTOCOL
*gHiiConfigRouting
;
29 FRONT_PAGE_CALLBACK_DATA gFrontPagePrivate
= {
30 FRONT_PAGE_CALLBACK_DATA_SIGNATURE
,
41 HII_VENDOR_DEVICE_PATH mFrontPageHiiVendorDevicePath
= {
47 (UINT8
) (sizeof (VENDOR_DEVICE_PATH
)),
48 (UINT8
) ((sizeof (VENDOR_DEVICE_PATH
)) >> 8)
52 // {8E6D99EE-7531-48f8-8745-7F6144468FF2}
54 { 0x8e6d99ee, 0x7531, 0x48f8, { 0x87, 0x45, 0x7f, 0x61, 0x44, 0x46, 0x8f, 0xf2 } }
58 END_ENTIRE_DEVICE_PATH_SUBTYPE
,
60 (UINT8
) (END_DEVICE_PATH_LENGTH
),
61 (UINT8
) ((END_DEVICE_PATH_LENGTH
) >> 8)
67 This function allows a caller to extract the current configuration for one
68 or more named elements from the target driver.
71 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
72 @param Request A null-terminated Unicode string in <ConfigRequest> format.
73 @param Progress On return, points to a character in the Request string.
74 Points to the string's null terminator if request was successful.
75 Points to the most recent '&' before the first failing name/value
76 pair (or the beginning of the string if the failure is in the
77 first name/value pair) if the request was not successful.
78 @param Results A null-terminated Unicode string in <ConfigAltResp> format which
79 has all values filled in for the names in the Request string.
80 String to be allocated by the called function.
82 @retval EFI_SUCCESS The Results is filled with the requested values.
83 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.
84 @retval EFI_INVALID_PARAMETER Request is NULL, illegal syntax, or unknown name.
85 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver.
91 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
92 IN CONST EFI_STRING Request
,
93 OUT EFI_STRING
*Progress
,
94 OUT EFI_STRING
*Results
101 This function processes the results of changes in configuration.
104 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
105 @param Configuration A null-terminated Unicode string in <ConfigResp> format.
106 @param Progress A pointer to a string filled in with the offset of the most
107 recent '&' before the first failing name/value pair (or the
108 beginning of the string if the failure is in the first
109 name/value pair) or the terminating NULL if all was successful.
111 @retval EFI_SUCCESS The Results is processed successfully.
112 @retval EFI_INVALID_PARAMETER Configuration is NULL.
113 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver.
119 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
120 IN CONST EFI_STRING Configuration
,
121 OUT EFI_STRING
*Progress
128 This function processes the results of changes in configuration.
131 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
132 @param Action Specifies the type of action taken by the browser.
133 @param QuestionId A unique value which is sent to the original exporting driver
134 so that it can identify the type of data to expect.
135 @param Type The type of value for the question.
136 @param Value A pointer to the data being sent to the original exporting driver.
137 @param ActionRequest On return, points to the action requested by the callback function.
139 @retval EFI_SUCCESS The callback successfully handled the action.
140 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
141 @retval EFI_DEVICE_ERROR The variable could not be saved.
142 @retval EFI_UNSUPPORTED The specified Action is not supported by the callback.
148 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
149 IN EFI_BROWSER_ACTION Action
,
150 IN EFI_QUESTION_ID QuestionId
,
152 IN EFI_IFR_TYPE_VALUE
*Value
,
153 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest
156 CHAR8
*LanguageString
;
159 CHAR8 OldLang
[ISO_639_2_ENTRY_SIZE
];
162 CHAR8
*PlatformSupportedLanguages
;
165 if ((Value
== NULL
) || (ActionRequest
== NULL
)) {
166 return EFI_INVALID_PARAMETER
;
169 gCallbackKey
= QuestionId
;
172 // The first 4 entries in the Front Page are to be GUARANTEED to remain constant so IHV's can
173 // describe to their customers in documentation how to find their setup information (namely
174 // under the device manager and specific buckets)
176 switch (QuestionId
) {
177 case FRONT_PAGE_KEY_CONTINUE
:
179 // This is the continue - clear the screen and return an error to get out of FrontPage loop
183 case FRONT_PAGE_KEY_LANGUAGE
:
185 // Collect the languages from what our current Language support is based on our VFR
187 LanguageString
= HiiGetSupportedLanguages (gFrontPagePrivate
.HiiHandle
);
188 ASSERT (LanguageString
!= NULL
);
190 // Allocate working buffer for RFC 4646 language in supported LanguageString.
192 Lang
= AllocatePool (AsciiStrSize (LanguageString
));
193 ASSERT (Lang
!= NULL
);
196 LangCode
= LanguageString
;
197 while (*LangCode
!= 0) {
198 GetNextLanguage (&LangCode
, Lang
);
200 if (Index
== Value
->u8
) {
207 PlatformSupportedLanguages
= GetEfiGlobalVariable (L
"PlatformLangCodes");
208 if (PlatformSupportedLanguages
== NULL
) {
209 PlatformSupportedLanguages
= AllocateCopyPool (
210 AsciiStrSize ((CHAR8
*) PcdGetPtr (PcdUefiVariableDefaultPlatformLangCodes
)),
211 (CHAR8
*) PcdGetPtr (PcdUefiVariableDefaultPlatformLangCodes
)
213 ASSERT (PlatformSupportedLanguages
!= NULL
);
217 // Select the best language in platform supported Language.
219 BestLanguage
= GetBestLanguage (
220 PlatformSupportedLanguages
,
225 if (BestLanguage
!= NULL
) {
226 Status
= gRT
->SetVariable (
228 &gEfiGlobalVariableGuid
,
229 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
230 AsciiStrSize (BestLanguage
),
234 if (!FeaturePcdGet (PcdUefiVariableDefaultLangDeprecate
)) {
236 // Set UEFI deprecated variable "Lang" for backwards compatibility
238 Status
= ConvertRfc3066LanguageToIso639Language (BestLanguage
, OldLang
);
239 if (!EFI_ERROR (Status
)) {
240 Status
= gRT
->SetVariable (
242 &gEfiGlobalVariableGuid
,
243 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
244 ISO_639_2_ENTRY_SIZE
,
249 FreePool (BestLanguage
);
252 FreePool (PlatformSupportedLanguages
);
254 FreePool (LanguageString
);
257 case FRONT_PAGE_KEY_BOOT_MANAGER
:
263 case FRONT_PAGE_KEY_DEVICE_MANAGER
:
269 case FRONT_PAGE_KEY_BOOT_MAINTAIN
:
271 // Boot Maintenance Manager
280 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_EXIT
;
286 Initialize HII information for the FrontPage
289 @param InitializeHiiData TRUE if HII elements need to be initialized.
291 @retval EFI_SUCCESS The operation is successful.
292 @retval EFI_DEVICE_ERROR If the dynamic opcode creation failed.
296 InitializeFrontPage (
297 IN BOOLEAN InitializeHiiData
301 CHAR8
*LanguageString
;
307 CHAR16
*StringBuffer
;
309 EFI_HII_HANDLE HiiHandle
;
310 VOID
*OptionsOpCodeHandle
;
311 VOID
*StartOpCodeHandle
;
312 VOID
*EndOpCodeHandle
;
313 EFI_IFR_GUID_LABEL
*StartLabel
;
314 EFI_IFR_GUID_LABEL
*EndLabel
;
317 if (InitializeHiiData
) {
319 // Initialize the Device Manager
321 InitializeDeviceManager ();
324 // Initialize the Device Manager
326 InitializeBootManager ();
331 // Locate Hii relative protocols
333 Status
= gBS
->LocateProtocol (&gEfiHiiDatabaseProtocolGuid
, NULL
, (VOID
**) &gHiiDatabase
);
334 if (EFI_ERROR (Status
)) {
338 Status
= gBS
->LocateProtocol (&gEfiHiiStringProtocolGuid
, NULL
, (VOID
**) &gHiiString
);
339 if (EFI_ERROR (Status
)) {
343 Status
= gBS
->LocateProtocol (&gEfiFormBrowser2ProtocolGuid
, NULL
, (VOID
**) &gFormBrowser2
);
344 if (EFI_ERROR (Status
)) {
348 Status
= gBS
->LocateProtocol (&gEfiHiiConfigRoutingProtocolGuid
, NULL
, (VOID
**) &gHiiConfigRouting
);
349 if (EFI_ERROR (Status
)) {
354 // Install Device Path Protocol and Config Access protocol to driver handle
356 Status
= gBS
->InstallMultipleProtocolInterfaces (
357 &gFrontPagePrivate
.DriverHandle
,
358 &gEfiDevicePathProtocolGuid
,
359 &mFrontPageHiiVendorDevicePath
,
360 &gEfiHiiConfigAccessProtocolGuid
,
361 &gFrontPagePrivate
.ConfigAccess
,
364 ASSERT_EFI_ERROR (Status
);
367 // Publish our HII data
369 gFrontPagePrivate
.HiiHandle
= HiiAddPackages (
371 gFrontPagePrivate
.DriverHandle
,
376 if (gFrontPagePrivate
.HiiHandle
== NULL
) {
377 return EFI_OUT_OF_RESOURCES
;
383 // Init OpCode Handle and Allocate space for creation of UpdateData Buffer
385 StartOpCodeHandle
= HiiAllocateOpCodeHandle ();
386 ASSERT (StartOpCodeHandle
!= NULL
);
388 EndOpCodeHandle
= HiiAllocateOpCodeHandle ();
389 ASSERT (EndOpCodeHandle
!= NULL
);
391 OptionsOpCodeHandle
= HiiAllocateOpCodeHandle ();
392 ASSERT (OptionsOpCodeHandle
!= NULL
);
394 // Create Hii Extend Label OpCode as the start opcode
396 StartLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (StartOpCodeHandle
, &gEfiIfrTianoGuid
, NULL
, sizeof (EFI_IFR_GUID_LABEL
));
397 StartLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
398 StartLabel
->Number
= LABEL_SELECT_LANGUAGE
;
401 // Create Hii Extend Label OpCode as the end opcode
403 EndLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (EndOpCodeHandle
, &gEfiIfrTianoGuid
, NULL
, sizeof (EFI_IFR_GUID_LABEL
));
404 EndLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
405 EndLabel
->Number
= LABEL_END
;
408 // Collect the languages from what our current Language support is based on our VFR
410 HiiHandle
= gFrontPagePrivate
.HiiHandle
;
411 LanguageString
= HiiGetSupportedLanguages (HiiHandle
);
412 ASSERT (LanguageString
!= NULL
);
414 // Allocate working buffer for RFC 4646 language in supported LanguageString.
416 Lang
= AllocatePool (AsciiStrSize (LanguageString
));
417 ASSERT (Lang
!= NULL
);
419 CurrentLang
= GetEfiGlobalVariable (L
"PlatformLang");
421 // Select the best language in LanguageString as the default one.
423 BestLanguage
= GetBestLanguage (
426 (CurrentLang
!= NULL
) ? CurrentLang
: "",
427 (CHAR8
*) PcdGetPtr (PcdUefiVariableDefaultPlatformLang
),
432 // BestLanguage must be selected as it is the first language in LanguageString by default
434 ASSERT (BestLanguage
!= NULL
);
437 LangCode
= LanguageString
;
440 if (gFrontPagePrivate
.LanguageToken
== NULL
) {
441 while (*LangCode
!= 0) {
442 HiiLibGetNextLanguage (&LangCode
, Lang
);
445 gFrontPagePrivate
.LanguageToken
= AllocatePool (OptionCount
* sizeof (EFI_STRING_ID
));
446 ASSERT (gFrontPagePrivate
.LanguageToken
!= NULL
);
451 LangCode
= LanguageString
;
452 while (*LangCode
!= 0) {
453 GetNextLanguage (&LangCode
, Lang
);
457 // Get Language Name from String Package. The StringId of Printable Language
458 // Name is always 1 which is generated by StringGather Tool.
461 StringBuffer
= AllocatePool (BufferSize
);
462 Status
= gHiiString
->GetString (
466 PRINTABLE_LANGUAGE_NAME_STRING_ID
,
471 if (Status
== EFI_BUFFER_TOO_SMALL
) {
472 FreePool (StringBuffer
);
473 StringBuffer
= AllocatePool (BufferSize
);
474 Status
= gHiiString
->GetString (
478 PRINTABLE_LANGUAGE_NAME_STRING_ID
,
484 ASSERT_EFI_ERROR (Status
);
487 // Save the string Id for each language
489 gFrontPagePrivate
.LanguageToken
[OptionCount
] = HiiSetString (HiiHandle
, 0, StringBuffer
, NULL
);
490 FreePool (StringBuffer
);
493 if (AsciiStrCmp (Lang
, BestLanguage
) == 0) {
494 HiiCreateOneOfOptionOpCode (
496 gFrontPagePrivate
.LanguageToken
[OptionCount
],
497 EFI_IFR_OPTION_DEFAULT
,
498 EFI_IFR_NUMERIC_SIZE_1
,
502 HiiCreateOneOfOptionOpCode (
504 gFrontPagePrivate
.LanguageToken
[OptionCount
],
506 EFI_IFR_NUMERIC_SIZE_1
,
514 if (CurrentLang
!= NULL
) {
515 FreePool (CurrentLang
);
517 FreePool (BestLanguage
);
519 FreePool (LanguageString
);
521 HiiCreateOneOfOpCode (
523 FRONT_PAGE_KEY_LANGUAGE
,
526 STRING_TOKEN (STR_LANGUAGE_SELECT
),
527 STRING_TOKEN (STR_LANGUAGE_SELECT_HELP
),
528 EFI_IFR_FLAG_CALLBACK
,
529 EFI_IFR_NUMERIC_SIZE_1
,
534 Status
= HiiUpdateForm (
538 StartOpCodeHandle
, // LABEL_SELECT_LANGUAGE
539 EndOpCodeHandle
// LABEL_END
542 HiiFreeOpCodeHandle (StartOpCodeHandle
);
543 HiiFreeOpCodeHandle (EndOpCodeHandle
);
544 HiiFreeOpCodeHandle (OptionsOpCodeHandle
);
549 Call the browser and display the front page
551 @return Status code that will be returned by
552 EFI_FORM_BROWSER2_PROTOCOL.SendForm ().
561 EFI_BROWSER_ACTION_REQUEST ActionRequest
;
564 // Begin waiting for USER INPUT
568 (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_SW_PC_INPUT_WAIT
)
571 ActionRequest
= EFI_BROWSER_ACTION_REQUEST_NONE
;
572 Status
= gFormBrowser2
->SendForm (
574 &gFrontPagePrivate
.HiiHandle
,
582 // Check whether user change any option setting which needs a reset to be effective
584 if (ActionRequest
== EFI_BROWSER_ACTION_REQUEST_RESET
) {
585 EnableResetRequired ();
592 Acquire the string associated with the ProducerGuid and return it.
595 @param ProducerGuid The Guid to search the HII database for
596 @param Token The token value of the string to extract
597 @param String The string that is extracted
599 @retval EFI_SUCCESS The function returns EFI_SUCCESS always.
604 IN EFI_GUID
*ProducerGuid
,
605 IN EFI_STRING_ID Token
,
609 EFI_STRING TmpString
;
611 TmpString
= HiiGetPackageString (ProducerGuid
, Token
, NULL
);
612 if (TmpString
== NULL
) {
613 *String
= GetStringById (STRING_TOKEN (STR_MISSING_STRING
));
622 Convert Processor Frequency Data to a string
624 @param ProcessorFrequency The frequency data to process
625 @param String The string that is created
629 ConvertProcessorToString (
630 IN EFI_PROCESSOR_CORE_FREQUENCY_DATA
*ProcessorFrequency
,
634 CHAR16
*StringBuffer
;
638 if (ProcessorFrequency
->Exponent
>= 6) {
639 FreqMhz
= ProcessorFrequency
->Value
;
640 for (Index
= 0; Index
< (UINTN
) (ProcessorFrequency
->Exponent
- 6); Index
++) {
647 StringBuffer
= AllocateZeroPool (0x20);
648 ASSERT (StringBuffer
!= NULL
);
649 Index
= UnicodeValueToString (StringBuffer
, LEFT_JUSTIFY
, FreqMhz
/ 1000, 3);
650 StrCat (StringBuffer
, L
".");
651 UnicodeValueToString (StringBuffer
+ Index
+ 1, PREFIX_ZERO
, (FreqMhz
% 1000) / 10, 2);
652 StrCat (StringBuffer
, L
" GHz");
654 *String
= (CHAR16
*) StringBuffer
;
660 Convert Memory Size to a string.
662 @param MemorySize The size of the memory to process
663 @param String The string that is created
667 ConvertMemorySizeToString (
668 IN UINT32 MemorySize
,
672 CHAR16
*StringBuffer
;
674 StringBuffer
= AllocateZeroPool (0x20);
675 ASSERT (StringBuffer
!= NULL
);
676 UnicodeValueToString (StringBuffer
, LEFT_JUSTIFY
, MemorySize
, 6);
677 StrCat (StringBuffer
, L
" MB RAM");
679 *String
= (CHAR16
*) StringBuffer
;
685 Update the banner information for the Front Page based on DataHub information.
689 UpdateFrontPageStrings (
694 EFI_STRING_ID TokenToUpdate
;
696 UINT64 MonotonicCount
;
697 EFI_DATA_HUB_PROTOCOL
*DataHub
;
698 EFI_DATA_RECORD_HEADER
*Record
;
699 EFI_SUBCLASS_TYPE1_HEADER
*DataHeader
;
700 EFI_MISC_BIOS_VENDOR_DATA
*BiosVendor
;
701 EFI_MISC_SYSTEM_MANUFACTURER_DATA
*SystemManufacturer
;
702 EFI_PROCESSOR_VERSION_DATA
*ProcessorVersion
;
703 EFI_PROCESSOR_CORE_FREQUENCY_DATA
*ProcessorFrequency
;
704 EFI_MEMORY_ARRAY_START_ADDRESS_DATA
*MemoryArray
;
707 ZeroMem (Find
, sizeof (Find
));
710 // Update Front Page strings
712 Status
= gBS
->LocateProtocol (
713 &gEfiDataHubProtocolGuid
,
717 ASSERT_EFI_ERROR (Status
);
722 Status
= DataHub
->GetNextRecord (DataHub
, &MonotonicCount
, NULL
, &Record
);
723 if (Record
->DataRecordClass
== EFI_DATA_RECORD_CLASS_DATA
) {
724 DataHeader
= (EFI_SUBCLASS_TYPE1_HEADER
*) (Record
+ 1);
725 if (CompareGuid (&Record
->DataRecordGuid
, &gEfiMiscSubClassGuid
) &&
726 (DataHeader
->RecordType
== EFI_MISC_BIOS_VENDOR_RECORD_NUMBER
)
728 BiosVendor
= (EFI_MISC_BIOS_VENDOR_DATA
*) (DataHeader
+ 1);
729 GetProducerString (&Record
->ProducerName
, BiosVendor
->BiosVersion
, &NewString
);
730 TokenToUpdate
= STRING_TOKEN (STR_FRONT_PAGE_BIOS_VERSION
);
731 HiiSetString (gFrontPagePrivate
.HiiHandle
, TokenToUpdate
, NewString
, NULL
);
732 FreePool (NewString
);
736 if (CompareGuid (&Record
->DataRecordGuid
, &gEfiMiscSubClassGuid
) &&
737 (DataHeader
->RecordType
== EFI_MISC_SYSTEM_MANUFACTURER_RECORD_NUMBER
)
739 SystemManufacturer
= (EFI_MISC_SYSTEM_MANUFACTURER_DATA
*) (DataHeader
+ 1);
740 GetProducerString (&Record
->ProducerName
, SystemManufacturer
->SystemProductName
, &NewString
);
741 TokenToUpdate
= STRING_TOKEN (STR_FRONT_PAGE_COMPUTER_MODEL
);
742 HiiSetString (gFrontPagePrivate
.HiiHandle
, TokenToUpdate
, NewString
, NULL
);
743 FreePool (NewString
);
747 if (CompareGuid (&Record
->DataRecordGuid
, &gEfiProcessorSubClassGuid
) &&
748 (DataHeader
->RecordType
== ProcessorVersionRecordType
)
750 ProcessorVersion
= (EFI_PROCESSOR_VERSION_DATA
*) (DataHeader
+ 1);
751 GetProducerString (&Record
->ProducerName
, *ProcessorVersion
, &NewString
);
752 TokenToUpdate
= STRING_TOKEN (STR_FRONT_PAGE_CPU_MODEL
);
753 HiiSetString (gFrontPagePrivate
.HiiHandle
, TokenToUpdate
, NewString
, NULL
);
754 FreePool (NewString
);
758 if (CompareGuid (&Record
->DataRecordGuid
, &gEfiProcessorSubClassGuid
) &&
759 (DataHeader
->RecordType
== ProcessorCoreFrequencyRecordType
)
761 ProcessorFrequency
= (EFI_PROCESSOR_CORE_FREQUENCY_DATA
*) (DataHeader
+ 1);
762 ConvertProcessorToString (ProcessorFrequency
, &NewString
);
763 TokenToUpdate
= STRING_TOKEN (STR_FRONT_PAGE_CPU_SPEED
);
764 HiiSetString (gFrontPagePrivate
.HiiHandle
, TokenToUpdate
, NewString
, NULL
);
765 FreePool (NewString
);
769 if (CompareGuid (&Record
->DataRecordGuid
, &gEfiMemorySubClassGuid
) &&
770 (DataHeader
->RecordType
== EFI_MEMORY_ARRAY_START_ADDRESS_RECORD_NUMBER
)
772 MemoryArray
= (EFI_MEMORY_ARRAY_START_ADDRESS_DATA
*) (DataHeader
+ 1);
773 ConvertMemorySizeToString (
774 (UINT32
)(RShiftU64((MemoryArray
->MemoryArrayEndAddress
- MemoryArray
->MemoryArrayStartAddress
+ 1), 20)),
777 TokenToUpdate
= STRING_TOKEN (STR_FRONT_PAGE_MEMORY_SIZE
);
778 HiiSetString (gFrontPagePrivate
.HiiHandle
, TokenToUpdate
, NewString
, NULL
);
779 FreePool (NewString
);
783 } while (!EFI_ERROR (Status
) && (MonotonicCount
!= 0) && !(Find
[0] && Find
[1] && Find
[2] && Find
[3] && Find
[4]));
789 Function waits for a given event to fire, or for an optional timeout to expire.
791 @param Event The event to wait for
792 @param Timeout An optional timeout value in 100 ns units.
794 @retval EFI_SUCCESS Event fired before Timeout expired.
795 @retval EFI_TIME_OUT Timout expired before Event fired..
801 IN UINT64 Timeout OPTIONAL
806 EFI_EVENT TimerEvent
;
807 EFI_EVENT WaitList
[2];
811 // Create a timer event
813 Status
= gBS
->CreateEvent (EVT_TIMER
, 0, NULL
, NULL
, &TimerEvent
);
814 if (!EFI_ERROR (Status
)) {
816 // Set the timer event
825 // Wait for the original event or the timer
828 WaitList
[1] = TimerEvent
;
829 Status
= gBS
->WaitForEvent (2, WaitList
, &Index
);
830 gBS
->CloseEvent (TimerEvent
);
833 // If the timer expired, change the return to timed out
835 if (!EFI_ERROR (Status
) && Index
== 1) {
836 Status
= EFI_TIMEOUT
;
841 // No timeout... just wait on the event
843 Status
= gBS
->WaitForEvent (1, &Event
, &Index
);
844 ASSERT (!EFI_ERROR (Status
));
852 Function show progress bar to wait for user input.
855 @param TimeoutDefault The fault time out value before the system continue to boot.
857 @retval EFI_SUCCESS User pressed some key except "Enter"
858 @retval EFI_TIME_OUT Timout expired or user press "Enter"
863 IN UINT16 TimeoutDefault
868 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground
;
869 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background
;
870 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Color
;
872 UINT16 TimeoutRemain
;
874 if (TimeoutDefault
== 0) {
878 DEBUG ((EFI_D_INFO
, "\n\nStart showing progress bar... Press any key to stop it! ...Zzz....\n"));
880 SetMem (&Foreground
, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
), 0xff);
881 SetMem (&Background
, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
), 0x0);
882 SetMem (&Color
, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
), 0xff);
885 // Clear the progress status bar first
887 TmpStr
= GetStringById (STRING_TOKEN (STR_START_BOOT_OPTION
));
888 if (TmpStr
!= NULL
) {
889 PlatformBdsShowProgress (Foreground
, Background
, TmpStr
, Color
, 0, 0);
892 TimeoutRemain
= TimeoutDefault
;
893 while (TimeoutRemain
!= 0) {
894 DEBUG ((EFI_D_INFO
, "Showing progress bar...Remaining %d second!\n", TimeoutRemain
));
896 Status
= WaitForSingleEvent (gST
->ConIn
->WaitForKey
, ONE_SECOND
);
897 if (Status
!= EFI_TIMEOUT
) {
905 if (TmpStr
!= NULL
) {
906 PlatformBdsShowProgress (
911 ((TimeoutDefault
- TimeoutRemain
) * 100 / TimeoutDefault
),
916 gBS
->FreePool (TmpStr
);
921 if (TimeoutRemain
== 0) {
926 // User pressed some key
928 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
929 if (EFI_ERROR (Status
)) {
933 if (Key
.UnicodeChar
== CHAR_CARRIAGE_RETURN
) {
935 // User pressed enter, equivalent to select "continue"
944 This function is the main entry of the platform setup entry.
945 The function will present the main menu of the system setup,
946 this is the platform reference part and can be customize.
949 @param TimeoutDefault The fault time out value before the system
951 @param ConnectAllHappened The indicater to check if the connect all have
956 PlatformBdsEnterFrontPage (
957 IN UINT16 TimeoutDefault
,
958 IN BOOLEAN ConnectAllHappened
963 PERF_START (0, "BdsTimeOut", "BDS", 0);
965 // Indicate if we need connect all in the platform setup
967 if (ConnectAllHappened
) {
968 gConnectAllHappened
= TRUE
;
971 if (TimeoutDefault
!= 0xffff) {
972 Status
= ShowProgress (TimeoutDefault
);
975 // Ensure screen is clear when switch Console from Graphics mode to Text mode
977 gST
->ConOut
->EnableCursor (gST
->ConOut
, TRUE
);
978 gST
->ConOut
->ClearScreen (gST
->ConOut
);
980 if (EFI_ERROR (Status
)) {
982 // Timeout or user press enter to continue
990 InitializeFrontPage (FALSE
);
993 // Update Front Page strings
995 UpdateFrontPageStrings ();
998 Status
= CallFrontPage ();
1001 // If gCallbackKey is greater than 1 and less or equal to 5,
1002 // it will lauch configuration utilities.
1005 // 4 = device manager
1006 // 5 = boot maintainenance manager
1008 if (gCallbackKey
!= 0) {
1009 REPORT_STATUS_CODE (
1011 (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_SW_PC_USER_SETUP
)
1015 // Based on the key that was set, we can determine what to do
1017 switch (gCallbackKey
) {
1019 // The first 4 entries in the Front Page are to be GUARANTEED to remain constant so IHV's can
1020 // describe to their customers in documentation how to find their setup information (namely
1021 // under the device manager and specific buckets)
1023 // These entries consist of the Continue, Select language, Boot Manager, and Device Manager
1025 case FRONT_PAGE_KEY_CONTINUE
:
1027 // User hit continue
1031 case FRONT_PAGE_KEY_LANGUAGE
:
1033 // User made a language setting change - display front page again
1037 case FRONT_PAGE_KEY_BOOT_MANAGER
:
1039 // User chose to run the Boot Manager
1044 case FRONT_PAGE_KEY_DEVICE_MANAGER
:
1046 // Display the Device Manager
1049 CallDeviceManager();
1050 } while (gCallbackKey
== FRONT_PAGE_KEY_DEVICE_MANAGER
);
1053 case FRONT_PAGE_KEY_BOOT_MAINTAIN
:
1055 // Display the Boot Maintenance Manager
1057 BdsStartBootMaint ();
1061 } while ((Status
== EFI_SUCCESS
) && (gCallbackKey
!= FRONT_PAGE_KEY_CONTINUE
));
1064 //Will leave browser, check any reset required change is applied? if yes, reset system
1066 SetupResetReminder ();
1070 // Automatically load current entry
1071 // Note: The following lines of code only execute when Auto boot
1074 PERF_END (0, "BdsTimeOut", "BDS", 0);