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
;
161 CHAR8
*PlatformSupportedLanguages
;
164 if ((Value
== NULL
) || (ActionRequest
== NULL
)) {
165 return EFI_INVALID_PARAMETER
;
168 gCallbackKey
= QuestionId
;
171 // The first 4 entries in the Front Page are to be GUARANTEED to remain constant so IHV's can
172 // describe to their customers in documentation how to find their setup information (namely
173 // under the device manager and specific buckets)
175 switch (QuestionId
) {
176 case FRONT_PAGE_KEY_CONTINUE
:
178 // This is the continue - clear the screen and return an error to get out of FrontPage loop
182 case FRONT_PAGE_KEY_LANGUAGE
:
184 // Collect the languages from what our current Language support is based on our VFR
186 LanguageString
= HiiGetSupportedLanguages (gFrontPagePrivate
.HiiHandle
);
187 ASSERT (LanguageString
!= NULL
);
189 // Allocate working buffer for RFC 4646 language in supported LanguageString.
191 Lang
= AllocatePool (AsciiStrSize (LanguageString
));
192 ASSERT (Lang
!= NULL
);
195 LangCode
= LanguageString
;
196 while (*LangCode
!= 0) {
197 GetNextLanguage (&LangCode
, Lang
);
199 if (Index
== Value
->u8
) {
206 PlatformSupportedLanguages
= GetEfiGlobalVariable (L
"PlatformLangCodes");
207 if (PlatformSupportedLanguages
== NULL
) {
208 PlatformSupportedLanguages
= AllocateCopyPool (
209 AsciiStrSize ((CHAR8
*) PcdGetPtr (PcdUefiVariableDefaultPlatformLangCodes
)),
210 (CHAR8
*) PcdGetPtr (PcdUefiVariableDefaultPlatformLangCodes
)
212 ASSERT (PlatformSupportedLanguages
!= NULL
);
216 // Select the best language in platform supported Language.
218 BestLanguage
= GetBestLanguage (
219 PlatformSupportedLanguages
,
224 if (BestLanguage
!= NULL
) {
225 Status
= gRT
->SetVariable (
227 &gEfiGlobalVariableGuid
,
228 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
229 AsciiStrSize (BestLanguage
),
232 FreePool (BestLanguage
);
237 FreePool (PlatformSupportedLanguages
);
239 FreePool (LanguageString
);
242 case FRONT_PAGE_KEY_BOOT_MANAGER
:
248 case FRONT_PAGE_KEY_DEVICE_MANAGER
:
254 case FRONT_PAGE_KEY_BOOT_MAINTAIN
:
256 // Boot Maintenance Manager
265 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_EXIT
;
271 Initialize HII information for the FrontPage
274 @param InitializeHiiData TRUE if HII elements need to be initialized.
276 @retval EFI_SUCCESS The operation is successful.
277 @retval EFI_DEVICE_ERROR If the dynamic opcode creation failed.
281 InitializeFrontPage (
282 IN BOOLEAN InitializeHiiData
286 CHAR8
*LanguageString
;
292 CHAR16
*StringBuffer
;
294 EFI_HII_HANDLE HiiHandle
;
295 VOID
*OptionsOpCodeHandle
;
296 VOID
*StartOpCodeHandle
;
297 VOID
*EndOpCodeHandle
;
298 EFI_IFR_GUID_LABEL
*StartLabel
;
299 EFI_IFR_GUID_LABEL
*EndLabel
;
302 if (InitializeHiiData
) {
304 // Initialize the Device Manager
306 InitializeDeviceManager ();
309 // Initialize the Device Manager
311 InitializeBootManager ();
316 // Locate Hii relative protocols
318 Status
= gBS
->LocateProtocol (&gEfiHiiDatabaseProtocolGuid
, NULL
, (VOID
**) &gHiiDatabase
);
319 if (EFI_ERROR (Status
)) {
323 Status
= gBS
->LocateProtocol (&gEfiHiiStringProtocolGuid
, NULL
, (VOID
**) &gHiiString
);
324 if (EFI_ERROR (Status
)) {
328 Status
= gBS
->LocateProtocol (&gEfiFormBrowser2ProtocolGuid
, NULL
, (VOID
**) &gFormBrowser2
);
329 if (EFI_ERROR (Status
)) {
333 Status
= gBS
->LocateProtocol (&gEfiHiiConfigRoutingProtocolGuid
, NULL
, (VOID
**) &gHiiConfigRouting
);
334 if (EFI_ERROR (Status
)) {
339 // Install Device Path Protocol and Config Access protocol to driver handle
341 Status
= gBS
->InstallMultipleProtocolInterfaces (
342 &gFrontPagePrivate
.DriverHandle
,
343 &gEfiDevicePathProtocolGuid
,
344 &mFrontPageHiiVendorDevicePath
,
345 &gEfiHiiConfigAccessProtocolGuid
,
346 &gFrontPagePrivate
.ConfigAccess
,
349 ASSERT_EFI_ERROR (Status
);
352 // Publish our HII data
354 gFrontPagePrivate
.HiiHandle
= HiiAddPackages (
356 gFrontPagePrivate
.DriverHandle
,
361 if (gFrontPagePrivate
.HiiHandle
== NULL
) {
362 return EFI_OUT_OF_RESOURCES
;
368 // Init OpCode Handle and Allocate space for creation of UpdateData Buffer
370 StartOpCodeHandle
= HiiAllocateOpCodeHandle ();
371 ASSERT (StartOpCodeHandle
!= NULL
);
373 EndOpCodeHandle
= HiiAllocateOpCodeHandle ();
374 ASSERT (EndOpCodeHandle
!= NULL
);
376 OptionsOpCodeHandle
= HiiAllocateOpCodeHandle ();
377 ASSERT (OptionsOpCodeHandle
!= NULL
);
379 // Create Hii Extend Label OpCode as the start opcode
381 StartLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (StartOpCodeHandle
, &gEfiIfrTianoGuid
, NULL
, sizeof (EFI_IFR_GUID_LABEL
));
382 StartLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
383 StartLabel
->Number
= LABEL_SELECT_LANGUAGE
;
386 // Create Hii Extend Label OpCode as the end opcode
388 EndLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (EndOpCodeHandle
, &gEfiIfrTianoGuid
, NULL
, sizeof (EFI_IFR_GUID_LABEL
));
389 EndLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
390 EndLabel
->Number
= LABEL_END
;
393 // Collect the languages from what our current Language support is based on our VFR
395 HiiHandle
= gFrontPagePrivate
.HiiHandle
;
396 LanguageString
= HiiGetSupportedLanguages (HiiHandle
);
397 ASSERT (LanguageString
!= NULL
);
399 // Allocate working buffer for RFC 4646 language in supported LanguageString.
401 Lang
= AllocatePool (AsciiStrSize (LanguageString
));
402 ASSERT (Lang
!= NULL
);
404 CurrentLang
= GetEfiGlobalVariable (L
"PlatformLang");
406 // Select the best language in LanguageString as the default one.
408 BestLanguage
= GetBestLanguage (
411 (CurrentLang
!= NULL
) ? CurrentLang
: "",
412 (CHAR8
*) PcdGetPtr (PcdUefiVariableDefaultPlatformLang
),
417 // BestLanguage must be selected as it is the first language in LanguageString by default
419 ASSERT (BestLanguage
!= NULL
);
422 LangCode
= LanguageString
;
425 if (gFrontPagePrivate
.LanguageToken
== NULL
) {
426 while (*LangCode
!= 0) {
427 GetNextLanguage (&LangCode
, Lang
);
430 gFrontPagePrivate
.LanguageToken
= AllocatePool (OptionCount
* sizeof (EFI_STRING_ID
));
431 ASSERT (gFrontPagePrivate
.LanguageToken
!= NULL
);
436 LangCode
= LanguageString
;
437 while (*LangCode
!= 0) {
438 GetNextLanguage (&LangCode
, Lang
);
442 // Get Language Name from String Package. The StringId of Printable Language
443 // Name is always 1 which is generated by StringGather Tool.
446 StringBuffer
= AllocatePool (BufferSize
);
447 Status
= gHiiString
->GetString (
451 PRINTABLE_LANGUAGE_NAME_STRING_ID
,
456 if (Status
== EFI_BUFFER_TOO_SMALL
) {
457 FreePool (StringBuffer
);
458 StringBuffer
= AllocatePool (BufferSize
);
459 Status
= gHiiString
->GetString (
463 PRINTABLE_LANGUAGE_NAME_STRING_ID
,
469 ASSERT_EFI_ERROR (Status
);
472 // Save the string Id for each language
474 gFrontPagePrivate
.LanguageToken
[OptionCount
] = HiiSetString (HiiHandle
, 0, StringBuffer
, NULL
);
475 FreePool (StringBuffer
);
478 if (AsciiStrCmp (Lang
, BestLanguage
) == 0) {
479 HiiCreateOneOfOptionOpCode (
481 gFrontPagePrivate
.LanguageToken
[OptionCount
],
482 EFI_IFR_OPTION_DEFAULT
,
483 EFI_IFR_NUMERIC_SIZE_1
,
487 HiiCreateOneOfOptionOpCode (
489 gFrontPagePrivate
.LanguageToken
[OptionCount
],
491 EFI_IFR_NUMERIC_SIZE_1
,
499 if (CurrentLang
!= NULL
) {
500 FreePool (CurrentLang
);
502 FreePool (BestLanguage
);
504 FreePool (LanguageString
);
506 HiiCreateOneOfOpCode (
508 FRONT_PAGE_KEY_LANGUAGE
,
511 STRING_TOKEN (STR_LANGUAGE_SELECT
),
512 STRING_TOKEN (STR_LANGUAGE_SELECT_HELP
),
513 EFI_IFR_FLAG_CALLBACK
,
514 EFI_IFR_NUMERIC_SIZE_1
,
519 Status
= HiiUpdateForm (
523 StartOpCodeHandle
, // LABEL_SELECT_LANGUAGE
524 EndOpCodeHandle
// LABEL_END
527 HiiFreeOpCodeHandle (StartOpCodeHandle
);
528 HiiFreeOpCodeHandle (EndOpCodeHandle
);
529 HiiFreeOpCodeHandle (OptionsOpCodeHandle
);
534 Call the browser and display the front page
536 @return Status code that will be returned by
537 EFI_FORM_BROWSER2_PROTOCOL.SendForm ().
546 EFI_BROWSER_ACTION_REQUEST ActionRequest
;
549 // Begin waiting for USER INPUT
553 (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_SW_PC_INPUT_WAIT
)
556 ActionRequest
= EFI_BROWSER_ACTION_REQUEST_NONE
;
557 Status
= gFormBrowser2
->SendForm (
559 &gFrontPagePrivate
.HiiHandle
,
567 // Check whether user change any option setting which needs a reset to be effective
569 if (ActionRequest
== EFI_BROWSER_ACTION_REQUEST_RESET
) {
570 EnableResetRequired ();
577 Acquire the string associated with the ProducerGuid and return it.
580 @param ProducerGuid The Guid to search the HII database for
581 @param Token The token value of the string to extract
582 @param String The string that is extracted
584 @retval EFI_SUCCESS The function returns EFI_SUCCESS always.
589 IN EFI_GUID
*ProducerGuid
,
590 IN EFI_STRING_ID Token
,
594 EFI_STRING TmpString
;
596 TmpString
= HiiGetPackageString (ProducerGuid
, Token
, NULL
);
597 if (TmpString
== NULL
) {
598 *String
= GetStringById (STRING_TOKEN (STR_MISSING_STRING
));
607 Convert Processor Frequency Data to a string
609 @param ProcessorFrequency The frequency data to process
610 @param String The string that is created
614 ConvertProcessorToString (
615 IN EFI_PROCESSOR_CORE_FREQUENCY_DATA
*ProcessorFrequency
,
619 CHAR16
*StringBuffer
;
623 if (ProcessorFrequency
->Exponent
>= 6) {
624 FreqMhz
= ProcessorFrequency
->Value
;
625 for (Index
= 0; Index
< (UINTN
) (ProcessorFrequency
->Exponent
- 6); Index
++) {
632 StringBuffer
= AllocateZeroPool (0x20);
633 ASSERT (StringBuffer
!= NULL
);
634 Index
= UnicodeValueToString (StringBuffer
, LEFT_JUSTIFY
, FreqMhz
/ 1000, 3);
635 StrCat (StringBuffer
, L
".");
636 UnicodeValueToString (StringBuffer
+ Index
+ 1, PREFIX_ZERO
, (FreqMhz
% 1000) / 10, 2);
637 StrCat (StringBuffer
, L
" GHz");
639 *String
= (CHAR16
*) StringBuffer
;
645 Convert Memory Size to a string.
647 @param MemorySize The size of the memory to process
648 @param String The string that is created
652 ConvertMemorySizeToString (
653 IN UINT32 MemorySize
,
657 CHAR16
*StringBuffer
;
659 StringBuffer
= AllocateZeroPool (0x20);
660 ASSERT (StringBuffer
!= NULL
);
661 UnicodeValueToString (StringBuffer
, LEFT_JUSTIFY
, MemorySize
, 6);
662 StrCat (StringBuffer
, L
" MB RAM");
664 *String
= (CHAR16
*) StringBuffer
;
670 Update the banner information for the Front Page based on DataHub information.
674 UpdateFrontPageStrings (
679 EFI_STRING_ID TokenToUpdate
;
681 UINT64 MonotonicCount
;
682 EFI_DATA_HUB_PROTOCOL
*DataHub
;
683 EFI_DATA_RECORD_HEADER
*Record
;
684 EFI_SUBCLASS_TYPE1_HEADER
*DataHeader
;
685 EFI_MISC_BIOS_VENDOR_DATA
*BiosVendor
;
686 EFI_MISC_SYSTEM_MANUFACTURER_DATA
*SystemManufacturer
;
687 EFI_PROCESSOR_VERSION_DATA
*ProcessorVersion
;
688 EFI_PROCESSOR_CORE_FREQUENCY_DATA
*ProcessorFrequency
;
689 EFI_MEMORY_ARRAY_START_ADDRESS_DATA
*MemoryArray
;
692 ZeroMem (Find
, sizeof (Find
));
695 // Update Front Page strings
697 Status
= gBS
->LocateProtocol (
698 &gEfiDataHubProtocolGuid
,
702 ASSERT_EFI_ERROR (Status
);
707 Status
= DataHub
->GetNextRecord (DataHub
, &MonotonicCount
, NULL
, &Record
);
708 if (Record
->DataRecordClass
== EFI_DATA_RECORD_CLASS_DATA
) {
709 DataHeader
= (EFI_SUBCLASS_TYPE1_HEADER
*) (Record
+ 1);
710 if (CompareGuid (&Record
->DataRecordGuid
, &gEfiMiscSubClassGuid
) &&
711 (DataHeader
->RecordType
== EFI_MISC_BIOS_VENDOR_RECORD_NUMBER
)
713 BiosVendor
= (EFI_MISC_BIOS_VENDOR_DATA
*) (DataHeader
+ 1);
714 GetProducerString (&Record
->ProducerName
, BiosVendor
->BiosVersion
, &NewString
);
715 TokenToUpdate
= STRING_TOKEN (STR_FRONT_PAGE_BIOS_VERSION
);
716 HiiSetString (gFrontPagePrivate
.HiiHandle
, TokenToUpdate
, NewString
, NULL
);
717 FreePool (NewString
);
721 if (CompareGuid (&Record
->DataRecordGuid
, &gEfiMiscSubClassGuid
) &&
722 (DataHeader
->RecordType
== EFI_MISC_SYSTEM_MANUFACTURER_RECORD_NUMBER
)
724 SystemManufacturer
= (EFI_MISC_SYSTEM_MANUFACTURER_DATA
*) (DataHeader
+ 1);
725 GetProducerString (&Record
->ProducerName
, SystemManufacturer
->SystemProductName
, &NewString
);
726 TokenToUpdate
= STRING_TOKEN (STR_FRONT_PAGE_COMPUTER_MODEL
);
727 HiiSetString (gFrontPagePrivate
.HiiHandle
, TokenToUpdate
, NewString
, NULL
);
728 FreePool (NewString
);
732 if (CompareGuid (&Record
->DataRecordGuid
, &gEfiProcessorSubClassGuid
) &&
733 (DataHeader
->RecordType
== ProcessorVersionRecordType
)
735 ProcessorVersion
= (EFI_PROCESSOR_VERSION_DATA
*) (DataHeader
+ 1);
736 GetProducerString (&Record
->ProducerName
, *ProcessorVersion
, &NewString
);
737 TokenToUpdate
= STRING_TOKEN (STR_FRONT_PAGE_CPU_MODEL
);
738 HiiSetString (gFrontPagePrivate
.HiiHandle
, TokenToUpdate
, NewString
, NULL
);
739 FreePool (NewString
);
743 if (CompareGuid (&Record
->DataRecordGuid
, &gEfiProcessorSubClassGuid
) &&
744 (DataHeader
->RecordType
== ProcessorCoreFrequencyRecordType
)
746 ProcessorFrequency
= (EFI_PROCESSOR_CORE_FREQUENCY_DATA
*) (DataHeader
+ 1);
747 ConvertProcessorToString (ProcessorFrequency
, &NewString
);
748 TokenToUpdate
= STRING_TOKEN (STR_FRONT_PAGE_CPU_SPEED
);
749 HiiSetString (gFrontPagePrivate
.HiiHandle
, TokenToUpdate
, NewString
, NULL
);
750 FreePool (NewString
);
754 if (CompareGuid (&Record
->DataRecordGuid
, &gEfiMemorySubClassGuid
) &&
755 (DataHeader
->RecordType
== EFI_MEMORY_ARRAY_START_ADDRESS_RECORD_NUMBER
)
757 MemoryArray
= (EFI_MEMORY_ARRAY_START_ADDRESS_DATA
*) (DataHeader
+ 1);
758 ConvertMemorySizeToString (
759 (UINT32
)(RShiftU64((MemoryArray
->MemoryArrayEndAddress
- MemoryArray
->MemoryArrayStartAddress
+ 1), 20)),
762 TokenToUpdate
= STRING_TOKEN (STR_FRONT_PAGE_MEMORY_SIZE
);
763 HiiSetString (gFrontPagePrivate
.HiiHandle
, TokenToUpdate
, NewString
, NULL
);
764 FreePool (NewString
);
768 } while (!EFI_ERROR (Status
) && (MonotonicCount
!= 0) && !(Find
[0] && Find
[1] && Find
[2] && Find
[3] && Find
[4]));
774 Function waits for a given event to fire, or for an optional timeout to expire.
776 @param Event The event to wait for
777 @param Timeout An optional timeout value in 100 ns units.
779 @retval EFI_SUCCESS Event fired before Timeout expired.
780 @retval EFI_TIME_OUT Timout expired before Event fired..
786 IN UINT64 Timeout OPTIONAL
791 EFI_EVENT TimerEvent
;
792 EFI_EVENT WaitList
[2];
796 // Create a timer event
798 Status
= gBS
->CreateEvent (EVT_TIMER
, 0, NULL
, NULL
, &TimerEvent
);
799 if (!EFI_ERROR (Status
)) {
801 // Set the timer event
810 // Wait for the original event or the timer
813 WaitList
[1] = TimerEvent
;
814 Status
= gBS
->WaitForEvent (2, WaitList
, &Index
);
815 gBS
->CloseEvent (TimerEvent
);
818 // If the timer expired, change the return to timed out
820 if (!EFI_ERROR (Status
) && Index
== 1) {
821 Status
= EFI_TIMEOUT
;
826 // No timeout... just wait on the event
828 Status
= gBS
->WaitForEvent (1, &Event
, &Index
);
829 ASSERT (!EFI_ERROR (Status
));
837 Function show progress bar to wait for user input.
840 @param TimeoutDefault The fault time out value before the system continue to boot.
842 @retval EFI_SUCCESS User pressed some key except "Enter"
843 @retval EFI_TIME_OUT Timout expired or user press "Enter"
848 IN UINT16 TimeoutDefault
853 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground
;
854 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background
;
855 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Color
;
857 UINT16 TimeoutRemain
;
859 if (TimeoutDefault
== 0) {
863 DEBUG ((EFI_D_INFO
, "\n\nStart showing progress bar... Press any key to stop it! ...Zzz....\n"));
865 SetMem (&Foreground
, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
), 0xff);
866 SetMem (&Background
, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
), 0x0);
867 SetMem (&Color
, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
), 0xff);
870 // Clear the progress status bar first
872 TmpStr
= GetStringById (STRING_TOKEN (STR_START_BOOT_OPTION
));
873 if (TmpStr
!= NULL
) {
874 PlatformBdsShowProgress (Foreground
, Background
, TmpStr
, Color
, 0, 0);
877 TimeoutRemain
= TimeoutDefault
;
878 while (TimeoutRemain
!= 0) {
879 DEBUG ((EFI_D_INFO
, "Showing progress bar...Remaining %d second!\n", TimeoutRemain
));
881 Status
= WaitForSingleEvent (gST
->ConIn
->WaitForKey
, ONE_SECOND
);
882 if (Status
!= EFI_TIMEOUT
) {
890 if (TmpStr
!= NULL
) {
891 PlatformBdsShowProgress (
896 ((TimeoutDefault
- TimeoutRemain
) * 100 / TimeoutDefault
),
901 gBS
->FreePool (TmpStr
);
906 if (TimeoutRemain
== 0) {
911 // User pressed some key
913 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
914 if (EFI_ERROR (Status
)) {
918 if (Key
.UnicodeChar
== CHAR_CARRIAGE_RETURN
) {
920 // User pressed enter, equivalent to select "continue"
929 This function is the main entry of the platform setup entry.
930 The function will present the main menu of the system setup,
931 this is the platform reference part and can be customize.
934 @param TimeoutDefault The fault time out value before the system
936 @param ConnectAllHappened The indicater to check if the connect all have
941 PlatformBdsEnterFrontPage (
942 IN UINT16 TimeoutDefault
,
943 IN BOOLEAN ConnectAllHappened
948 PERF_START (0, "BdsTimeOut", "BDS", 0);
950 // Indicate if we need connect all in the platform setup
952 if (ConnectAllHappened
) {
953 gConnectAllHappened
= TRUE
;
956 if (TimeoutDefault
!= 0xffff) {
957 Status
= ShowProgress (TimeoutDefault
);
960 // Ensure screen is clear when switch Console from Graphics mode to Text mode
962 gST
->ConOut
->EnableCursor (gST
->ConOut
, TRUE
);
963 gST
->ConOut
->ClearScreen (gST
->ConOut
);
965 if (EFI_ERROR (Status
)) {
967 // Timeout or user press enter to continue
975 InitializeFrontPage (FALSE
);
978 // Update Front Page strings
980 UpdateFrontPageStrings ();
983 Status
= CallFrontPage ();
986 // If gCallbackKey is greater than 1 and less or equal to 5,
987 // it will lauch configuration utilities.
990 // 4 = device manager
991 // 5 = boot maintainenance manager
993 if (gCallbackKey
!= 0) {
996 (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_SW_PC_USER_SETUP
)
1000 // Based on the key that was set, we can determine what to do
1002 switch (gCallbackKey
) {
1004 // The first 4 entries in the Front Page are to be GUARANTEED to remain constant so IHV's can
1005 // describe to their customers in documentation how to find their setup information (namely
1006 // under the device manager and specific buckets)
1008 // These entries consist of the Continue, Select language, Boot Manager, and Device Manager
1010 case FRONT_PAGE_KEY_CONTINUE
:
1012 // User hit continue
1016 case FRONT_PAGE_KEY_LANGUAGE
:
1018 // User made a language setting change - display front page again
1022 case FRONT_PAGE_KEY_BOOT_MANAGER
:
1024 // User chose to run the Boot Manager
1029 case FRONT_PAGE_KEY_DEVICE_MANAGER
:
1031 // Display the Device Manager
1034 CallDeviceManager();
1035 } while (gCallbackKey
== FRONT_PAGE_KEY_DEVICE_MANAGER
);
1038 case FRONT_PAGE_KEY_BOOT_MAINTAIN
:
1040 // Display the Boot Maintenance Manager
1042 BdsStartBootMaint ();
1046 } while ((Status
== EFI_SUCCESS
) && (gCallbackKey
!= FRONT_PAGE_KEY_CONTINUE
));
1049 //Will leave browser, check any reset required change is applied? if yes, reset system
1051 SetupResetReminder ();
1055 // Automatically load current entry
1056 // Note: The following lines of code only execute when Auto boot
1059 PERF_END (0, "BdsTimeOut", "BDS", 0);