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_FORM_BROWSER2_PROTOCOL
*gFormBrowser2
;
26 FRONT_PAGE_CALLBACK_DATA gFrontPagePrivate
= {
27 FRONT_PAGE_CALLBACK_DATA_SIGNATURE
,
38 HII_VENDOR_DEVICE_PATH mFrontPageHiiVendorDevicePath
= {
44 (UINT8
) (sizeof (VENDOR_DEVICE_PATH
)),
45 (UINT8
) ((sizeof (VENDOR_DEVICE_PATH
)) >> 8)
49 // {8E6D99EE-7531-48f8-8745-7F6144468FF2}
51 { 0x8e6d99ee, 0x7531, 0x48f8, { 0x87, 0x45, 0x7f, 0x61, 0x44, 0x46, 0x8f, 0xf2 } }
55 END_ENTIRE_DEVICE_PATH_SUBTYPE
,
57 (UINT8
) (END_DEVICE_PATH_LENGTH
),
58 (UINT8
) ((END_DEVICE_PATH_LENGTH
) >> 8)
64 This function allows a caller to extract the current configuration for one
65 or more named elements from the target driver.
68 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
69 @param Request A null-terminated Unicode string in <ConfigRequest> format.
70 @param Progress On return, points to a character in the Request string.
71 Points to the string's null terminator if request was successful.
72 Points to the most recent '&' before the first failing name/value
73 pair (or the beginning of the string if the failure is in the
74 first name/value pair) if the request was not successful.
75 @param Results A null-terminated Unicode string in <ConfigAltResp> format which
76 has all values filled in for the names in the Request string.
77 String to be allocated by the called function.
79 @retval EFI_SUCCESS The Results is filled with the requested values.
80 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.
81 @retval EFI_INVALID_PARAMETER Request is illegal syntax, or unknown name.
82 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver.
88 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
89 IN CONST EFI_STRING Request
,
90 OUT EFI_STRING
*Progress
,
91 OUT EFI_STRING
*Results
94 if (Progress
== NULL
|| Results
== NULL
) {
95 return EFI_INVALID_PARAMETER
;
102 This function processes the results of changes in configuration.
105 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
106 @param Configuration A null-terminated Unicode string in <ConfigResp> format.
107 @param Progress A pointer to a string filled in with the offset of the most
108 recent '&' before the first failing name/value pair (or the
109 beginning of the string if the failure is in the first
110 name/value pair) or the terminating NULL if all was successful.
112 @retval EFI_SUCCESS The Results is processed successfully.
113 @retval EFI_INVALID_PARAMETER Configuration is NULL.
114 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver.
120 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
121 IN CONST EFI_STRING Configuration
,
122 OUT EFI_STRING
*Progress
125 if (Configuration
== NULL
|| Progress
== NULL
) {
126 return EFI_INVALID_PARAMETER
;
129 *Progress
= Configuration
;
130 if (!HiiIsConfigHdrMatch (Configuration
, &mBootMaintGuid
, mBootMaintStorageName
)
131 && !HiiIsConfigHdrMatch (Configuration
, &mFileExplorerGuid
, mFileExplorerStorageName
)) {
132 return EFI_NOT_FOUND
;
135 *Progress
= Configuration
+ StrLen (Configuration
);
140 This function processes the results of changes in configuration.
143 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
144 @param Action Specifies the type of action taken by the browser.
145 @param QuestionId A unique value which is sent to the original exporting driver
146 so that it can identify the type of data to expect.
147 @param Type The type of value for the question.
148 @param Value A pointer to the data being sent to the original exporting driver.
149 @param ActionRequest On return, points to the action requested by the callback function.
151 @retval EFI_SUCCESS The callback successfully handled the action.
152 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
153 @retval EFI_DEVICE_ERROR The variable could not be saved.
154 @retval EFI_UNSUPPORTED The specified Action is not supported by the callback.
160 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
161 IN EFI_BROWSER_ACTION Action
,
162 IN EFI_QUESTION_ID QuestionId
,
164 IN EFI_IFR_TYPE_VALUE
*Value
,
165 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest
168 CHAR8
*LanguageString
;
173 CHAR8
*PlatformSupportedLanguages
;
176 if ((Value
== NULL
) || (ActionRequest
== NULL
)) {
177 return EFI_INVALID_PARAMETER
;
180 gCallbackKey
= QuestionId
;
183 // The first 4 entries in the Front Page are to be GUARANTEED to remain constant so IHV's can
184 // describe to their customers in documentation how to find their setup information (namely
185 // under the device manager and specific buckets)
187 switch (QuestionId
) {
188 case FRONT_PAGE_KEY_CONTINUE
:
190 // This is the continue - clear the screen and return an error to get out of FrontPage loop
194 case FRONT_PAGE_KEY_LANGUAGE
:
196 // Collect the languages from what our current Language support is based on our VFR
198 LanguageString
= HiiGetSupportedLanguages (gFrontPagePrivate
.HiiHandle
);
199 ASSERT (LanguageString
!= NULL
);
201 // Allocate working buffer for RFC 4646 language in supported LanguageString.
203 Lang
= AllocatePool (AsciiStrSize (LanguageString
));
204 ASSERT (Lang
!= NULL
);
207 LangCode
= LanguageString
;
208 while (*LangCode
!= 0) {
209 GetNextLanguage (&LangCode
, Lang
);
211 if (Index
== Value
->u8
) {
218 PlatformSupportedLanguages
= GetEfiGlobalVariable (L
"PlatformLangCodes");
219 if (PlatformSupportedLanguages
== NULL
) {
220 PlatformSupportedLanguages
= AllocateCopyPool (
221 AsciiStrSize ((CHAR8
*) PcdGetPtr (PcdUefiVariableDefaultPlatformLangCodes
)),
222 (CHAR8
*) PcdGetPtr (PcdUefiVariableDefaultPlatformLangCodes
)
224 ASSERT (PlatformSupportedLanguages
!= NULL
);
228 // Select the best language in platform supported Language.
230 BestLanguage
= GetBestLanguage (
231 PlatformSupportedLanguages
,
236 if (BestLanguage
!= NULL
) {
237 Status
= gRT
->SetVariable (
239 &gEfiGlobalVariableGuid
,
240 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
241 AsciiStrSize (BestLanguage
),
244 ASSERT_EFI_ERROR(Status
);
245 FreePool (BestLanguage
);
250 FreePool (PlatformSupportedLanguages
);
252 FreePool (LanguageString
);
255 case FRONT_PAGE_KEY_BOOT_MANAGER
:
261 case FRONT_PAGE_KEY_DEVICE_MANAGER
:
267 case FRONT_PAGE_KEY_BOOT_MAINTAIN
:
269 // Boot Maintenance Manager
278 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_EXIT
;
284 Initialize HII information for the FrontPage
287 @param InitializeHiiData TRUE if HII elements need to be initialized.
289 @retval EFI_SUCCESS The operation is successful.
290 @retval EFI_DEVICE_ERROR If the dynamic opcode creation failed.
294 InitializeFrontPage (
295 IN BOOLEAN InitializeHiiData
299 CHAR8
*LanguageString
;
305 CHAR16
*StringBuffer
;
306 EFI_HII_HANDLE HiiHandle
;
307 VOID
*OptionsOpCodeHandle
;
308 VOID
*StartOpCodeHandle
;
309 VOID
*EndOpCodeHandle
;
310 EFI_IFR_GUID_LABEL
*StartLabel
;
311 EFI_IFR_GUID_LABEL
*EndLabel
;
315 if (InitializeHiiData
) {
317 // Initialize the Device Manager
319 InitializeDeviceManager ();
322 // Initialize the Device Manager
324 InitializeBootManager ();
329 // Locate Hii relative protocols
331 Status
= gBS
->LocateProtocol (&gEfiFormBrowser2ProtocolGuid
, NULL
, (VOID
**) &gFormBrowser2
);
332 if (EFI_ERROR (Status
)) {
337 // Install Device Path Protocol and Config Access protocol to driver handle
339 Status
= gBS
->InstallMultipleProtocolInterfaces (
340 &gFrontPagePrivate
.DriverHandle
,
341 &gEfiDevicePathProtocolGuid
,
342 &mFrontPageHiiVendorDevicePath
,
343 &gEfiHiiConfigAccessProtocolGuid
,
344 &gFrontPagePrivate
.ConfigAccess
,
347 ASSERT_EFI_ERROR (Status
);
350 // Publish our HII data
352 gFrontPagePrivate
.HiiHandle
= HiiAddPackages (
354 gFrontPagePrivate
.DriverHandle
,
359 if (gFrontPagePrivate
.HiiHandle
== NULL
) {
360 return EFI_OUT_OF_RESOURCES
;
366 // Init OpCode Handle and Allocate space for creation of UpdateData Buffer
368 StartOpCodeHandle
= HiiAllocateOpCodeHandle ();
369 ASSERT (StartOpCodeHandle
!= NULL
);
371 EndOpCodeHandle
= HiiAllocateOpCodeHandle ();
372 ASSERT (EndOpCodeHandle
!= NULL
);
374 OptionsOpCodeHandle
= HiiAllocateOpCodeHandle ();
375 ASSERT (OptionsOpCodeHandle
!= NULL
);
377 // Create Hii Extend Label OpCode as the start opcode
379 StartLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (StartOpCodeHandle
, &gEfiIfrTianoGuid
, NULL
, sizeof (EFI_IFR_GUID_LABEL
));
380 StartLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
381 StartLabel
->Number
= LABEL_SELECT_LANGUAGE
;
384 // Create Hii Extend Label OpCode as the end opcode
386 EndLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (EndOpCodeHandle
, &gEfiIfrTianoGuid
, NULL
, sizeof (EFI_IFR_GUID_LABEL
));
387 EndLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
388 EndLabel
->Number
= LABEL_END
;
391 // Collect the languages from what our current Language support is based on our VFR
393 HiiHandle
= gFrontPagePrivate
.HiiHandle
;
394 LanguageString
= HiiGetSupportedLanguages (HiiHandle
);
395 ASSERT (LanguageString
!= NULL
);
397 // Allocate working buffer for RFC 4646 language in supported LanguageString.
399 Lang
= AllocatePool (AsciiStrSize (LanguageString
));
400 ASSERT (Lang
!= NULL
);
402 CurrentLang
= GetEfiGlobalVariable (L
"PlatformLang");
404 // Select the best language in LanguageString as the default one.
406 BestLanguage
= GetBestLanguage (
409 (CurrentLang
!= NULL
) ? CurrentLang
: "",
410 (CHAR8
*) PcdGetPtr (PcdUefiVariableDefaultPlatformLang
),
415 // BestLanguage must be selected as it is the first language in LanguageString by default
417 ASSERT (BestLanguage
!= NULL
);
420 LangCode
= LanguageString
;
423 if (gFrontPagePrivate
.LanguageToken
== NULL
) {
424 while (*LangCode
!= 0) {
425 GetNextLanguage (&LangCode
, Lang
);
428 gFrontPagePrivate
.LanguageToken
= AllocatePool ((OptionCount
+ 1) * sizeof (EFI_STRING_ID
));
429 ASSERT (gFrontPagePrivate
.LanguageToken
!= NULL
);
433 Status
= gHiiString
->NewString (gHiiString
, HiiHandle
, &Temp
, "de-DE", L
"Dedede", L
"TEST", NULL
);
436 LangCode
= LanguageString
;
437 while (*LangCode
!= 0) {
438 GetNextLanguage (&LangCode
, Lang
);
441 StringBuffer
= HiiGetString (HiiHandle
, PRINTABLE_LANGUAGE_NAME_STRING_ID
, Lang
);
442 ASSERT_EFI_ERROR (StringBuffer
!= NULL
);
445 // Save the string Id for each language
447 gFrontPagePrivate
.LanguageToken
[OptionCount
] = HiiSetString (HiiHandle
, 0, StringBuffer
, NULL
);
448 FreePool (StringBuffer
);
451 if (AsciiStrCmp (Lang
, BestLanguage
) == 0) {
452 HiiCreateOneOfOptionOpCode (
454 gFrontPagePrivate
.LanguageToken
[OptionCount
],
455 EFI_IFR_OPTION_DEFAULT
,
456 EFI_IFR_NUMERIC_SIZE_1
,
460 HiiCreateOneOfOptionOpCode (
462 gFrontPagePrivate
.LanguageToken
[OptionCount
],
464 EFI_IFR_NUMERIC_SIZE_1
,
472 if (CurrentLang
!= NULL
) {
473 FreePool (CurrentLang
);
475 FreePool (BestLanguage
);
477 FreePool (LanguageString
);
479 HiiCreateOneOfOpCode (
481 FRONT_PAGE_KEY_LANGUAGE
,
484 STRING_TOKEN (STR_LANGUAGE_SELECT
),
485 STRING_TOKEN (STR_LANGUAGE_SELECT_HELP
),
486 EFI_IFR_FLAG_CALLBACK
,
487 EFI_IFR_NUMERIC_SIZE_1
,
492 Status
= HiiUpdateForm (
496 StartOpCodeHandle
, // LABEL_SELECT_LANGUAGE
497 EndOpCodeHandle
// LABEL_END
500 HiiFreeOpCodeHandle (StartOpCodeHandle
);
501 HiiFreeOpCodeHandle (EndOpCodeHandle
);
502 HiiFreeOpCodeHandle (OptionsOpCodeHandle
);
507 Call the browser and display the front page
509 @return Status code that will be returned by
510 EFI_FORM_BROWSER2_PROTOCOL.SendForm ().
519 EFI_BROWSER_ACTION_REQUEST ActionRequest
;
522 // Begin waiting for USER INPUT
526 (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_SW_PC_INPUT_WAIT
)
529 ActionRequest
= EFI_BROWSER_ACTION_REQUEST_NONE
;
530 Status
= gFormBrowser2
->SendForm (
532 &gFrontPagePrivate
.HiiHandle
,
540 // Check whether user change any option setting which needs a reset to be effective
542 if (ActionRequest
== EFI_BROWSER_ACTION_REQUEST_RESET
) {
543 EnableResetRequired ();
550 Acquire the string associated with the ProducerGuid and return it.
553 @param ProducerGuid The Guid to search the HII database for
554 @param Token The token value of the string to extract
555 @param String The string that is extracted
557 @retval EFI_SUCCESS The function returns EFI_SUCCESS always.
562 IN EFI_GUID
*ProducerGuid
,
563 IN EFI_STRING_ID Token
,
567 EFI_STRING TmpString
;
569 TmpString
= HiiGetPackageString (ProducerGuid
, Token
, NULL
);
570 if (TmpString
== NULL
) {
571 *String
= GetStringById (STRING_TOKEN (STR_MISSING_STRING
));
580 Convert Processor Frequency Data to a string.
582 @param ProcessorFrequency The frequency data to process
583 @param Base10Exponent The exponent based on 10
584 @param String The string that is created
588 ConvertProcessorToString (
589 IN UINT16 ProcessorFrequency
,
590 IN UINT16 Base10Exponent
,
594 CHAR16
*StringBuffer
;
598 if (Base10Exponent
>= 6) {
599 FreqMhz
= ProcessorFrequency
;
600 for (Index
= 0; Index
< (UINTN
) (Base10Exponent
- 6); Index
++) {
607 StringBuffer
= AllocateZeroPool (0x20);
608 ASSERT (StringBuffer
!= NULL
);
609 Index
= UnicodeValueToString (StringBuffer
, LEFT_JUSTIFY
, FreqMhz
/ 1000, 3);
610 StrCat (StringBuffer
, L
".");
611 UnicodeValueToString (StringBuffer
+ Index
+ 1, PREFIX_ZERO
, (FreqMhz
% 1000) / 10, 2);
612 StrCat (StringBuffer
, L
" GHz");
613 *String
= (CHAR16
*) StringBuffer
;
619 Convert Memory Size to a string.
621 @param MemorySize The size of the memory to process
622 @param String The string that is created
626 ConvertMemorySizeToString (
627 IN UINT32 MemorySize
,
631 CHAR16
*StringBuffer
;
633 StringBuffer
= AllocateZeroPool (0x20);
634 ASSERT (StringBuffer
!= NULL
);
635 UnicodeValueToString (StringBuffer
, LEFT_JUSTIFY
, MemorySize
, 6);
636 StrCat (StringBuffer
, L
" MB RAM");
638 *String
= (CHAR16
*) StringBuffer
;
645 Acquire the string associated with the Index from smbios structure and return it.
646 The caller is responsible for free the string buffer.
648 @param OptionalStrStart The start position to search the string
649 @param Index The index of the string to extract
650 @param String The string that is extracted
652 @retval EFI_SUCCESS The function returns EFI_SUCCESS always.
656 GetOptionalStringByIndex (
657 IN CHAR8
*OptionalStrStart
,
668 Status
= EFI_NOT_FOUND
;
669 CharInStr
= OptionalStrStart
;
674 // look for the two consecutive zeros, check the string limit by the way.
676 while (*CharInStr
!= 0 || *(CharInStr
+1) != 0) {
677 if (*CharInStr
== 0) {
682 if (StrNum
== Index
) {
683 Status
= EFI_SUCCESS
;
687 CurrentStrLen
= AsciiStrLen(CharInStr
);
690 // forward the pointer
692 OptionalStrStart
= CharInStr
;
693 CharInStr
+= CurrentStrLen
;
696 if (EFI_ERROR (Status
)) {
697 *String
= GetStringById (STRING_TOKEN (STR_MISSING_STRING
));
701 CurrentStrLen
= AsciiStrLen(CharInStr
);
704 *String
= AllocatePool((CurrentStrLen
+ 1)*sizeof(CHAR16
));
705 AsciiStrToUnicodeStr(OptionalStrStart
, *String
);
712 Update the banner information for the Front Page based on DataHub information.
716 UpdateFrontPageStrings (
724 EFI_STRING_ID TokenToUpdate
;
725 EFI_SMBIOS_HANDLE SmbiosHandle
;
726 EFI_SMBIOS_PROTOCOL
*Smbios
;
727 SMBIOS_TABLE_TYPE0
*Type0Record
;
728 SMBIOS_TABLE_TYPE1
*Type1Record
;
729 SMBIOS_TABLE_TYPE4
*Type4Record
;
730 SMBIOS_TABLE_TYPE19
*Type19Record
;
731 EFI_SMBIOS_TABLE_HEADER
*Record
;
733 ZeroMem (Find
, sizeof (Find
));
736 // Update Front Page strings
738 Status
= gBS
->LocateProtocol (
739 &gEfiSmbiosProtocolGuid
,
743 ASSERT_EFI_ERROR (Status
);
747 Status
= Smbios
->GetNext (Smbios
, &SmbiosHandle
, NULL
, &Record
, NULL
);
748 if (EFI_ERROR(Status
)) {
752 if (Record
->Type
== EFI_SMBIOS_TYPE_BIOS_INFORMATION
) {
753 Type0Record
= (SMBIOS_TABLE_TYPE0
*) Record
;
754 StrIndex
= Type0Record
->BiosVersion
;
755 GetOptionalStringByIndex ((CHAR8
*)((UINT8
*)Type0Record
+ Type0Record
->Hdr
.Length
), StrIndex
, &NewString
);
756 TokenToUpdate
= STRING_TOKEN (STR_FRONT_PAGE_BIOS_VERSION
);
757 HiiSetString (gFrontPagePrivate
.HiiHandle
, TokenToUpdate
, NewString
, NULL
);
758 FreePool (NewString
);
762 if (Record
->Type
== EFI_SMBIOS_TYPE_SYSTEM_INFORMATION
) {
763 Type1Record
= (SMBIOS_TABLE_TYPE1
*) Record
;
764 StrIndex
= Type1Record
->ProductName
;
765 GetOptionalStringByIndex ((CHAR8
*)((UINT8
*)Type1Record
+ Type1Record
->Hdr
.Length
), StrIndex
, &NewString
);
766 TokenToUpdate
= STRING_TOKEN (STR_FRONT_PAGE_COMPUTER_MODEL
);
767 HiiSetString (gFrontPagePrivate
.HiiHandle
, TokenToUpdate
, NewString
, NULL
);
768 FreePool (NewString
);
772 if (Record
->Type
== EFI_SMBIOS_TYPE_PROCESSOR_INFORMATION
) {
773 Type4Record
= (SMBIOS_TABLE_TYPE4
*) Record
;
774 StrIndex
= Type4Record
->ProcessorVersion
;
775 GetOptionalStringByIndex ((CHAR8
*)((UINT8
*)Type4Record
+ Type4Record
->Hdr
.Length
), StrIndex
, &NewString
);
776 TokenToUpdate
= STRING_TOKEN (STR_FRONT_PAGE_CPU_MODEL
);
777 HiiSetString (gFrontPagePrivate
.HiiHandle
, TokenToUpdate
, NewString
, NULL
);
778 FreePool (NewString
);
782 if (Record
->Type
== EFI_SMBIOS_TYPE_PROCESSOR_INFORMATION
) {
783 Type4Record
= (SMBIOS_TABLE_TYPE4
*) Record
;
784 ConvertProcessorToString(Type4Record
->CurrentSpeed
, 6, &NewString
);
785 TokenToUpdate
= STRING_TOKEN (STR_FRONT_PAGE_CPU_SPEED
);
786 HiiSetString (gFrontPagePrivate
.HiiHandle
, TokenToUpdate
, NewString
, NULL
);
787 FreePool (NewString
);
791 if ( Record
->Type
== EFI_SMBIOS_TYPE_MEMORY_ARRAY_MAPPED_ADDRESS
) {
792 Type19Record
= (SMBIOS_TABLE_TYPE19
*) Record
;
793 ConvertMemorySizeToString (
794 (UINT32
)(RShiftU64((Type19Record
->EndingAddress
- Type19Record
->StartingAddress
+ 1), 10)),
797 TokenToUpdate
= STRING_TOKEN (STR_FRONT_PAGE_MEMORY_SIZE
);
798 HiiSetString (gFrontPagePrivate
.HiiHandle
, TokenToUpdate
, NewString
, NULL
);
799 FreePool (NewString
);
802 } while ( !(Find
[0] && Find
[1] && Find
[2] && Find
[3] && Find
[4]));
808 Function waits for a given event to fire, or for an optional timeout to expire.
810 @param Event The event to wait for
811 @param Timeout An optional timeout value in 100 ns units.
813 @retval EFI_SUCCESS Event fired before Timeout expired.
814 @retval EFI_TIME_OUT Timout expired before Event fired..
820 IN UINT64 Timeout OPTIONAL
825 EFI_EVENT TimerEvent
;
826 EFI_EVENT WaitList
[2];
830 // Create a timer event
832 Status
= gBS
->CreateEvent (EVT_TIMER
, 0, NULL
, NULL
, &TimerEvent
);
833 if (!EFI_ERROR (Status
)) {
835 // Set the timer event
844 // Wait for the original event or the timer
847 WaitList
[1] = TimerEvent
;
848 Status
= gBS
->WaitForEvent (2, WaitList
, &Index
);
849 gBS
->CloseEvent (TimerEvent
);
852 // If the timer expired, change the return to timed out
854 if (!EFI_ERROR (Status
) && Index
== 1) {
855 Status
= EFI_TIMEOUT
;
860 // No timeout... just wait on the event
862 Status
= gBS
->WaitForEvent (1, &Event
, &Index
);
863 ASSERT (!EFI_ERROR (Status
));
871 Function show progress bar to wait for user input.
874 @param TimeoutDefault The fault time out value before the system continue to boot.
876 @retval EFI_SUCCESS User pressed some key except "Enter"
877 @retval EFI_TIME_OUT Timeout expired or user press "Enter"
882 IN UINT16 TimeoutDefault
886 UINT16 TimeoutRemain
;
889 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground
;
890 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background
;
891 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Color
;
893 if (TimeoutDefault
== 0) {
897 DEBUG ((EFI_D_INFO
, "\n\nStart showing progress bar... Press any key to stop it! ...Zzz....\n"));
899 SetMem (&Foreground
, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
), 0xff);
900 SetMem (&Background
, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
), 0x0);
901 SetMem (&Color
, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
), 0xff);
904 // Clear the progress status bar first
906 TmpStr
= GetStringById (STRING_TOKEN (STR_START_BOOT_OPTION
));
907 if (TmpStr
!= NULL
) {
908 PlatformBdsShowProgress (Foreground
, Background
, TmpStr
, Color
, 0, 0);
911 TimeoutRemain
= TimeoutDefault
;
912 while (TimeoutRemain
!= 0) {
913 DEBUG ((EFI_D_INFO
, "Showing progress bar...Remaining %d second!\n", TimeoutRemain
));
915 Status
= WaitForSingleEvent (gST
->ConIn
->WaitForKey
, ONE_SECOND
);
916 if (Status
!= EFI_TIMEOUT
) {
924 if (TmpStr
!= NULL
) {
925 PlatformBdsShowProgress (
930 ((TimeoutDefault
- TimeoutRemain
) * 100 / TimeoutDefault
),
935 gBS
->FreePool (TmpStr
);
940 if (TimeoutRemain
== 0) {
945 // User pressed some key
947 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
948 if (EFI_ERROR (Status
)) {
952 if (Key
.UnicodeChar
== CHAR_CARRIAGE_RETURN
) {
954 // User pressed enter, equivalent to select "continue"
963 This function is the main entry of the platform setup entry.
964 The function will present the main menu of the system setup,
965 this is the platform reference part and can be customize.
968 @param TimeoutDefault The fault time out value before the system
970 @param ConnectAllHappened The indicater to check if the connect all have
975 PlatformBdsEnterFrontPage (
976 IN UINT16 TimeoutDefault
,
977 IN BOOLEAN ConnectAllHappened
982 PERF_START (NULL
, "BdsTimeOut", "BDS", 0);
984 // Indicate if we need connect all in the platform setup
986 if (ConnectAllHappened
) {
987 gConnectAllHappened
= TRUE
;
990 if (TimeoutDefault
!= 0xffff) {
991 Status
= ShowProgress (TimeoutDefault
);
994 // Ensure screen is clear when switch Console from Graphics mode to Text mode
996 gST
->ConOut
->EnableCursor (gST
->ConOut
, TRUE
);
997 gST
->ConOut
->ClearScreen (gST
->ConOut
);
999 if (EFI_ERROR (Status
)) {
1001 // Timeout or user press enter to continue
1009 InitializeFrontPage (FALSE
);
1012 // Update Front Page strings
1014 UpdateFrontPageStrings ();
1017 Status
= CallFrontPage ();
1020 // If gCallbackKey is greater than 1 and less or equal to 5,
1021 // it will launch configuration utilities.
1024 // 4 = device manager
1025 // 5 = boot maintenance manager
1027 if (gCallbackKey
!= 0) {
1028 REPORT_STATUS_CODE (
1030 (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_SW_PC_USER_SETUP
)
1034 // Based on the key that was set, we can determine what to do
1036 switch (gCallbackKey
) {
1038 // The first 4 entries in the Front Page are to be GUARANTEED to remain constant so IHV's can
1039 // describe to their customers in documentation how to find their setup information (namely
1040 // under the device manager and specific buckets)
1042 // These entries consist of the Continue, Select language, Boot Manager, and Device Manager
1044 case FRONT_PAGE_KEY_CONTINUE
:
1046 // User hit continue
1050 case FRONT_PAGE_KEY_LANGUAGE
:
1052 // User made a language setting change - display front page again
1056 case FRONT_PAGE_KEY_BOOT_MANAGER
:
1058 // User chose to run the Boot Manager
1063 case FRONT_PAGE_KEY_DEVICE_MANAGER
:
1065 // Display the Device Manager
1068 CallDeviceManager ();
1069 } while (gCallbackKey
== FRONT_PAGE_KEY_DEVICE_MANAGER
);
1072 case FRONT_PAGE_KEY_BOOT_MAINTAIN
:
1074 // Display the Boot Maintenance Manager
1076 BdsStartBootMaint ();
1080 } while ((Status
== EFI_SUCCESS
) && (gCallbackKey
!= FRONT_PAGE_KEY_CONTINUE
));
1083 //Will leave browser, check any reset required change is applied? if yes, reset system
1085 SetupResetReminder ();
1089 // Automatically load current entry
1090 // Note: The following lines of code only execute when Auto boot
1093 PERF_END (NULL
, "BdsTimeOut", "BDS", 0);