2 FrontPage routines to handle the callbacks and browser calls
4 Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.<BR>
5 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"
20 BOOLEAN mModeInitialized
= FALSE
;
22 BOOLEAN gConnectAllHappened
= FALSE
;
24 CHAR8
*mLanguageString
;
27 // Boot video resolution and text mode.
29 UINT32 mBootHorizontalResolution
= 0;
30 UINT32 mBootVerticalResolution
= 0;
31 UINT32 mBootTextModeColumn
= 0;
32 UINT32 mBootTextModeRow
= 0;
34 // BIOS setup video resolution and text mode.
36 UINT32 mSetupTextModeColumn
= 0;
37 UINT32 mSetupTextModeRow
= 0;
38 UINT32 mSetupHorizontalResolution
= 0;
39 UINT32 mSetupVerticalResolution
= 0;
41 EFI_FORM_BROWSER2_PROTOCOL
*gFormBrowser2
;
43 FRONT_PAGE_CALLBACK_DATA gFrontPagePrivate
= {
44 FRONT_PAGE_CALLBACK_DATA_SIGNATURE
,
55 HII_VENDOR_DEVICE_PATH mFrontPageHiiVendorDevicePath
= {
61 (UINT8
) (sizeof (VENDOR_DEVICE_PATH
)),
62 (UINT8
) ((sizeof (VENDOR_DEVICE_PATH
)) >> 8)
65 FRONT_PAGE_FORMSET_GUID
69 END_ENTIRE_DEVICE_PATH_SUBTYPE
,
71 (UINT8
) (END_DEVICE_PATH_LENGTH
),
72 (UINT8
) ((END_DEVICE_PATH_LENGTH
) >> 8)
78 This function allows a caller to extract the current configuration for one
79 or more named elements from the target driver.
82 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
83 @param Request A null-terminated Unicode string in <ConfigRequest> format.
84 @param Progress On return, points to a character in the Request string.
85 Points to the string's null terminator if request was successful.
86 Points to the most recent '&' before the first failing name/value
87 pair (or the beginning of the string if the failure is in the
88 first name/value pair) if the request was not successful.
89 @param Results A null-terminated Unicode string in <ConfigAltResp> format which
90 has all values filled in for the names in the Request string.
91 String to be allocated by the called function.
93 @retval EFI_SUCCESS The Results is filled with the requested values.
94 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.
95 @retval EFI_INVALID_PARAMETER Request is illegal syntax, or unknown name.
96 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver.
102 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
103 IN CONST EFI_STRING Request
,
104 OUT EFI_STRING
*Progress
,
105 OUT EFI_STRING
*Results
108 if (Progress
== NULL
|| Results
== NULL
) {
109 return EFI_INVALID_PARAMETER
;
112 return EFI_NOT_FOUND
;
116 This function processes the results of changes in configuration.
119 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
120 @param Configuration A null-terminated Unicode string in <ConfigResp> format.
121 @param Progress A pointer to a string filled in with the offset of the most
122 recent '&' before the first failing name/value pair (or the
123 beginning of the string if the failure is in the first
124 name/value pair) or the terminating NULL if all was successful.
126 @retval EFI_SUCCESS The Results is processed successfully.
127 @retval EFI_INVALID_PARAMETER Configuration is NULL.
128 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver.
134 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
135 IN CONST EFI_STRING Configuration
,
136 OUT EFI_STRING
*Progress
139 if (Configuration
== NULL
|| Progress
== NULL
) {
140 return EFI_INVALID_PARAMETER
;
143 *Progress
= Configuration
;
144 if (!HiiIsConfigHdrMatch (Configuration
, &gBootMaintFormSetGuid
, mBootMaintStorageName
)
145 && !HiiIsConfigHdrMatch (Configuration
, &gFileExploreFormSetGuid
, mFileExplorerStorageName
)) {
146 return EFI_NOT_FOUND
;
149 *Progress
= Configuration
+ StrLen (Configuration
);
154 This function processes the results of changes in configuration.
157 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
158 @param Action Specifies the type of action taken by the browser.
159 @param QuestionId A unique value which is sent to the original exporting driver
160 so that it can identify the type of data to expect.
161 @param Type The type of value for the question.
162 @param Value A pointer to the data being sent to the original exporting driver.
163 @param ActionRequest On return, points to the action requested by the callback function.
165 @retval EFI_SUCCESS The callback successfully handled the action.
166 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
167 @retval EFI_DEVICE_ERROR The variable could not be saved.
168 @retval EFI_UNSUPPORTED The specified Action is not supported by the callback.
174 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
175 IN EFI_BROWSER_ACTION Action
,
176 IN EFI_QUESTION_ID QuestionId
,
178 IN EFI_IFR_TYPE_VALUE
*Value
,
179 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest
186 if (Action
!= EFI_BROWSER_ACTION_CHANGING
&& Action
!= EFI_BROWSER_ACTION_CHANGED
) {
188 // All other action return unsupported.
190 return EFI_UNSUPPORTED
;
193 gCallbackKey
= QuestionId
;
195 if (Action
== EFI_BROWSER_ACTION_CHANGED
) {
196 if ((Value
== NULL
) || (ActionRequest
== NULL
)) {
197 return EFI_INVALID_PARAMETER
;
200 switch (QuestionId
) {
201 case FRONT_PAGE_KEY_CONTINUE
:
203 // This is the continue - clear the screen and return an error to get out of FrontPage loop
205 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_EXIT
;
208 case FRONT_PAGE_KEY_LANGUAGE
:
210 // Allocate working buffer for RFC 4646 language in supported LanguageString.
212 Lang
= AllocatePool (AsciiStrSize (mLanguageString
));
213 ASSERT (Lang
!= NULL
);
216 LangCode
= mLanguageString
;
217 while (*LangCode
!= 0) {
218 GetNextLanguage (&LangCode
, Lang
);
220 if (Index
== Value
->u8
) {
227 if (Index
== Value
->u8
) {
228 BdsDxeSetVariableAndReportStatusCodeOnError (
230 &gEfiGlobalVariableGuid
,
231 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
239 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_EXIT
;
247 } else if (Action
== EFI_BROWSER_ACTION_CHANGING
) {
249 return EFI_INVALID_PARAMETER
;
253 // The first 4 entries in the Front Page are to be GUARANTEED to remain constant so IHV's can
254 // describe to their customers in documentation how to find their setup information (namely
255 // under the device manager and specific buckets)
257 switch (QuestionId
) {
258 case FRONT_PAGE_KEY_BOOT_MANAGER
:
264 case FRONT_PAGE_KEY_DEVICE_MANAGER
:
270 case FRONT_PAGE_KEY_BOOT_MAINTAIN
:
272 // Boot Maintenance Manager
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
306 CHAR16
*StringBuffer
;
307 EFI_HII_HANDLE HiiHandle
;
308 VOID
*OptionsOpCodeHandle
;
309 VOID
*StartOpCodeHandle
;
310 VOID
*EndOpCodeHandle
;
311 EFI_IFR_GUID_LABEL
*StartLabel
;
312 EFI_IFR_GUID_LABEL
*EndLabel
;
313 EFI_HII_STRING_PROTOCOL
*HiiString
;
319 if (InitializeHiiData
) {
321 // Initialize the Device Manager
323 InitializeDeviceManager ();
326 // Initialize the Device Manager
328 InitializeBootManager ();
333 // Locate Hii relative protocols
335 Status
= gBS
->LocateProtocol (&gEfiFormBrowser2ProtocolGuid
, NULL
, (VOID
**) &gFormBrowser2
);
336 if (EFI_ERROR (Status
)) {
341 // Install Device Path Protocol and Config Access protocol to driver handle
343 Status
= gBS
->InstallMultipleProtocolInterfaces (
344 &gFrontPagePrivate
.DriverHandle
,
345 &gEfiDevicePathProtocolGuid
,
346 &mFrontPageHiiVendorDevicePath
,
347 &gEfiHiiConfigAccessProtocolGuid
,
348 &gFrontPagePrivate
.ConfigAccess
,
351 ASSERT_EFI_ERROR (Status
);
354 // Publish our HII data
356 gFrontPagePrivate
.HiiHandle
= HiiAddPackages (
357 &gFrontPageFormSetGuid
,
358 gFrontPagePrivate
.DriverHandle
,
363 if (gFrontPagePrivate
.HiiHandle
== NULL
) {
364 return EFI_OUT_OF_RESOURCES
;
370 // Init OpCode Handle and Allocate space for creation of UpdateData Buffer
372 StartOpCodeHandle
= HiiAllocateOpCodeHandle ();
373 ASSERT (StartOpCodeHandle
!= NULL
);
375 EndOpCodeHandle
= HiiAllocateOpCodeHandle ();
376 ASSERT (EndOpCodeHandle
!= NULL
);
378 OptionsOpCodeHandle
= HiiAllocateOpCodeHandle ();
379 ASSERT (OptionsOpCodeHandle
!= NULL
);
381 // Create Hii Extend Label OpCode as the start opcode
383 StartLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (StartOpCodeHandle
, &gEfiIfrTianoGuid
, NULL
, sizeof (EFI_IFR_GUID_LABEL
));
384 StartLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
385 StartLabel
->Number
= LABEL_SELECT_LANGUAGE
;
388 // Create Hii Extend Label OpCode as the end opcode
390 EndLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (EndOpCodeHandle
, &gEfiIfrTianoGuid
, NULL
, sizeof (EFI_IFR_GUID_LABEL
));
391 EndLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
392 EndLabel
->Number
= LABEL_END
;
395 // Collect the languages from what our current Language support is based on our VFR
397 HiiHandle
= gFrontPagePrivate
.HiiHandle
;
399 GetEfiGlobalVariable2 (L
"PlatformLang", (VOID
**)&CurrentLang
, NULL
);
402 // Get Support language list from variable.
404 if (mLanguageString
== NULL
){
405 GetEfiGlobalVariable2 (L
"PlatformLangCodes", (VOID
**)&mLanguageString
, NULL
);
406 if (mLanguageString
== NULL
) {
407 mLanguageString
= AllocateCopyPool (
408 AsciiStrSize ((CHAR8
*) PcdGetPtr (PcdUefiVariableDefaultPlatformLangCodes
)),
409 (CHAR8
*) PcdGetPtr (PcdUefiVariableDefaultPlatformLangCodes
)
411 ASSERT (mLanguageString
!= NULL
);
415 if (gFrontPagePrivate
.LanguageToken
== NULL
) {
417 // Count the language list number.
419 LangCode
= mLanguageString
;
420 Lang
= AllocatePool (AsciiStrSize (mLanguageString
));
421 ASSERT (Lang
!= NULL
);
423 while (*LangCode
!= 0) {
424 GetNextLanguage (&LangCode
, Lang
);
429 // Allocate extra 1 as the end tag.
431 gFrontPagePrivate
.LanguageToken
= AllocateZeroPool ((OptionCount
+ 1) * sizeof (EFI_STRING_ID
));
432 ASSERT (gFrontPagePrivate
.LanguageToken
!= NULL
);
434 Status
= gBS
->LocateProtocol (&gEfiHiiStringProtocolGuid
, NULL
, (VOID
**) &HiiString
);
435 ASSERT_EFI_ERROR (Status
);
437 LangCode
= mLanguageString
;
439 while (*LangCode
!= 0) {
440 GetNextLanguage (&LangCode
, Lang
);
443 Status
= HiiString
->GetString (HiiString
, Lang
, HiiHandle
, PRINTABLE_LANGUAGE_NAME_STRING_ID
, StringBuffer
, &StringSize
, NULL
);
444 if (Status
== EFI_BUFFER_TOO_SMALL
) {
445 StringBuffer
= AllocateZeroPool (StringSize
);
446 ASSERT (StringBuffer
!= NULL
);
447 Status
= HiiString
->GetString (HiiString
, Lang
, HiiHandle
, PRINTABLE_LANGUAGE_NAME_STRING_ID
, StringBuffer
, &StringSize
, NULL
);
448 ASSERT_EFI_ERROR (Status
);
451 if (EFI_ERROR (Status
)) {
452 LangSize
= AsciiStrSize (Lang
);
453 StringBuffer
= AllocatePool (LangSize
* sizeof (CHAR16
));
454 ASSERT (StringBuffer
!= NULL
);
455 AsciiStrToUnicodeStrS (Lang
, StringBuffer
, LangSize
);
458 ASSERT (StringBuffer
!= NULL
);
459 gFrontPagePrivate
.LanguageToken
[OptionCount
] = HiiSetString (HiiHandle
, 0, StringBuffer
, NULL
);
460 FreePool (StringBuffer
);
466 ASSERT (gFrontPagePrivate
.LanguageToken
!= NULL
);
467 LangCode
= mLanguageString
;
470 Lang
= AllocatePool (AsciiStrSize (mLanguageString
));
471 ASSERT (Lang
!= NULL
);
473 while (*LangCode
!= 0) {
474 GetNextLanguage (&LangCode
, Lang
);
476 if (CurrentLang
!= NULL
&& AsciiStrCmp (Lang
, CurrentLang
) == 0) {
477 HiiCreateOneOfOptionOpCode (
479 gFrontPagePrivate
.LanguageToken
[OptionCount
],
480 EFI_IFR_OPTION_DEFAULT
,
481 EFI_IFR_NUMERIC_SIZE_1
,
485 HiiCreateOneOfOptionOpCode (
487 gFrontPagePrivate
.LanguageToken
[OptionCount
],
489 EFI_IFR_NUMERIC_SIZE_1
,
497 if (CurrentLang
!= NULL
) {
498 FreePool (CurrentLang
);
502 HiiCreateOneOfOpCode (
504 FRONT_PAGE_KEY_LANGUAGE
,
507 STRING_TOKEN (STR_LANGUAGE_SELECT
),
508 STRING_TOKEN (STR_LANGUAGE_SELECT_HELP
),
509 EFI_IFR_FLAG_CALLBACK
,
510 EFI_IFR_NUMERIC_SIZE_1
,
515 Status
= HiiUpdateForm (
517 &gFrontPageFormSetGuid
,
519 StartOpCodeHandle
, // LABEL_SELECT_LANGUAGE
520 EndOpCodeHandle
// LABEL_END
523 HiiFreeOpCodeHandle (StartOpCodeHandle
);
524 HiiFreeOpCodeHandle (EndOpCodeHandle
);
525 HiiFreeOpCodeHandle (OptionsOpCodeHandle
);
530 Call the browser and display the front page
532 @return Status code that will be returned by
533 EFI_FORM_BROWSER2_PROTOCOL.SendForm ().
542 EFI_BROWSER_ACTION_REQUEST ActionRequest
;
545 // Begin waiting for USER INPUT
549 (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_SW_PC_INPUT_WAIT
)
552 ActionRequest
= EFI_BROWSER_ACTION_REQUEST_NONE
;
553 Status
= gFormBrowser2
->SendForm (
555 &gFrontPagePrivate
.HiiHandle
,
557 &gFrontPageFormSetGuid
,
563 // Check whether user change any option setting which needs a reset to be effective
565 if (ActionRequest
== EFI_BROWSER_ACTION_REQUEST_RESET
) {
566 EnableResetRequired ();
573 Acquire the string associated with the ProducerGuid and return it.
576 @param ProducerGuid The Guid to search the HII database for
577 @param Token The token value of the string to extract
578 @param String The string that is extracted
580 @retval EFI_SUCCESS The function returns EFI_SUCCESS always.
585 IN EFI_GUID
*ProducerGuid
,
586 IN EFI_STRING_ID Token
,
590 EFI_STRING TmpString
;
592 TmpString
= HiiGetPackageString (ProducerGuid
, Token
, NULL
);
593 if (TmpString
== NULL
) {
594 *String
= GetStringById (STRING_TOKEN (STR_MISSING_STRING
));
603 Convert Processor Frequency Data to a string.
605 @param ProcessorFrequency The frequency data to process
606 @param Base10Exponent The exponent based on 10
607 @param String The string that is created
611 ConvertProcessorToString (
612 IN UINT16 ProcessorFrequency
,
613 IN UINT16 Base10Exponent
,
617 CHAR16
*StringBuffer
;
621 if (Base10Exponent
>= 6) {
622 FreqMhz
= ProcessorFrequency
;
623 for (Index
= 0; Index
< (UINTN
) (Base10Exponent
- 6); Index
++) {
630 StringBuffer
= AllocateZeroPool (0x20);
631 ASSERT (StringBuffer
!= NULL
);
632 Index
= UnicodeValueToString (StringBuffer
, LEFT_JUSTIFY
, FreqMhz
/ 1000, 3);
633 StrCatS (StringBuffer
, 0x20 / sizeof (CHAR16
), L
".");
634 UnicodeValueToString (StringBuffer
+ Index
+ 1, PREFIX_ZERO
, (FreqMhz
% 1000) / 10, 2);
635 StrCatS (StringBuffer
, 0x20 / sizeof (CHAR16
), L
" GHz");
636 *String
= (CHAR16
*) StringBuffer
;
642 Convert Memory Size to a string.
644 @param MemorySize The size of the memory to process
645 @param String The string that is created
649 ConvertMemorySizeToString (
650 IN UINT32 MemorySize
,
654 CHAR16
*StringBuffer
;
656 StringBuffer
= AllocateZeroPool (0x20);
657 ASSERT (StringBuffer
!= NULL
);
658 UnicodeValueToString (StringBuffer
, LEFT_JUSTIFY
, MemorySize
, 6);
659 StrCatS (StringBuffer
, 0x20 / sizeof (CHAR16
), L
" MB RAM");
661 *String
= (CHAR16
*) StringBuffer
;
668 Acquire the string associated with the Index from smbios structure and return it.
669 The caller is responsible for free the string buffer.
671 @param OptionalStrStart The start position to search the string
672 @param Index The index of the string to extract
673 @param String The string that is extracted
675 @retval EFI_SUCCESS The function returns EFI_SUCCESS always.
679 GetOptionalStringByIndex (
680 IN CHAR8
*OptionalStrStart
,
688 *String
= AllocateZeroPool (sizeof (CHAR16
));
695 OptionalStrStart
+= StrSize
;
696 StrSize
= AsciiStrSize (OptionalStrStart
);
697 } while (OptionalStrStart
[StrSize
] != 0 && Index
!= 0);
699 if ((Index
!= 0) || (StrSize
== 1)) {
701 // Meet the end of strings set but Index is non-zero, or
702 // Find an empty string
704 *String
= GetStringById (STRING_TOKEN (STR_MISSING_STRING
));
706 *String
= AllocatePool (StrSize
* sizeof (CHAR16
));
707 AsciiStrToUnicodeStrS (OptionalStrStart
, *String
, StrSize
);
715 Update the banner information for the Front Page based on DataHub information.
719 UpdateFrontPageStrings (
726 EFI_STRING_ID TokenToUpdate
;
727 EFI_SMBIOS_HANDLE SmbiosHandle
;
728 EFI_SMBIOS_PROTOCOL
*Smbios
;
729 SMBIOS_TABLE_TYPE0
*Type0Record
;
730 SMBIOS_TABLE_TYPE1
*Type1Record
;
731 SMBIOS_TABLE_TYPE4
*Type4Record
;
732 SMBIOS_TABLE_TYPE19
*Type19Record
;
733 EFI_SMBIOS_TABLE_HEADER
*Record
;
734 UINT64 InstalledMemory
;
739 // Update Front Page strings
741 Status
= gBS
->LocateProtocol (
742 &gEfiSmbiosProtocolGuid
,
746 if (!EFI_ERROR (Status
)) {
747 SmbiosHandle
= SMBIOS_HANDLE_PI_RESERVED
;
748 Status
= Smbios
->GetNext (Smbios
, &SmbiosHandle
, NULL
, &Record
, NULL
);
749 while (!EFI_ERROR(Status
)) {
750 if (Record
->Type
== EFI_SMBIOS_TYPE_BIOS_INFORMATION
) {
751 Type0Record
= (SMBIOS_TABLE_TYPE0
*) Record
;
752 StrIndex
= Type0Record
->BiosVersion
;
753 GetOptionalStringByIndex ((CHAR8
*)((UINT8
*)Type0Record
+ Type0Record
->Hdr
.Length
), StrIndex
, &NewString
);
754 TokenToUpdate
= STRING_TOKEN (STR_FRONT_PAGE_BIOS_VERSION
);
755 HiiSetString (gFrontPagePrivate
.HiiHandle
, TokenToUpdate
, NewString
, NULL
);
756 FreePool (NewString
);
759 if (Record
->Type
== EFI_SMBIOS_TYPE_SYSTEM_INFORMATION
) {
760 Type1Record
= (SMBIOS_TABLE_TYPE1
*) Record
;
761 StrIndex
= Type1Record
->ProductName
;
762 GetOptionalStringByIndex ((CHAR8
*)((UINT8
*)Type1Record
+ Type1Record
->Hdr
.Length
), StrIndex
, &NewString
);
763 TokenToUpdate
= STRING_TOKEN (STR_FRONT_PAGE_COMPUTER_MODEL
);
764 HiiSetString (gFrontPagePrivate
.HiiHandle
, TokenToUpdate
, NewString
, NULL
);
765 FreePool (NewString
);
768 if (Record
->Type
== EFI_SMBIOS_TYPE_PROCESSOR_INFORMATION
) {
769 Type4Record
= (SMBIOS_TABLE_TYPE4
*) Record
;
770 StrIndex
= Type4Record
->ProcessorVersion
;
771 GetOptionalStringByIndex ((CHAR8
*)((UINT8
*)Type4Record
+ Type4Record
->Hdr
.Length
), StrIndex
, &NewString
);
772 TokenToUpdate
= STRING_TOKEN (STR_FRONT_PAGE_CPU_MODEL
);
773 HiiSetString (gFrontPagePrivate
.HiiHandle
, TokenToUpdate
, NewString
, NULL
);
774 FreePool (NewString
);
777 if (Record
->Type
== EFI_SMBIOS_TYPE_PROCESSOR_INFORMATION
) {
778 Type4Record
= (SMBIOS_TABLE_TYPE4
*) Record
;
779 ConvertProcessorToString(Type4Record
->CurrentSpeed
, 6, &NewString
);
780 TokenToUpdate
= STRING_TOKEN (STR_FRONT_PAGE_CPU_SPEED
);
781 HiiSetString (gFrontPagePrivate
.HiiHandle
, TokenToUpdate
, NewString
, NULL
);
782 FreePool (NewString
);
785 if ( Record
->Type
== EFI_SMBIOS_TYPE_MEMORY_ARRAY_MAPPED_ADDRESS
) {
786 Type19Record
= (SMBIOS_TABLE_TYPE19
*) Record
;
787 if (Type19Record
->StartingAddress
!= 0xFFFFFFFF ) {
788 InstalledMemory
+= RShiftU64(Type19Record
->EndingAddress
-
789 Type19Record
->StartingAddress
+ 1, 10);
791 InstalledMemory
+= RShiftU64(Type19Record
->ExtendedEndingAddress
-
792 Type19Record
->ExtendedStartingAddress
+ 1, 20);
796 Status
= Smbios
->GetNext (Smbios
, &SmbiosHandle
, NULL
, &Record
, NULL
);
799 // now update the total installed RAM size
800 ConvertMemorySizeToString ((UINT32
)InstalledMemory
, &NewString
);
801 TokenToUpdate
= STRING_TOKEN (STR_FRONT_PAGE_MEMORY_SIZE
);
802 HiiSetString (gFrontPagePrivate
.HiiHandle
, TokenToUpdate
, NewString
, NULL
);
803 FreePool (NewString
);
811 Function waits for a given event to fire, or for an optional timeout to expire.
813 @param Event The event to wait for
814 @param Timeout An optional timeout value in 100 ns units.
816 @retval EFI_SUCCESS Event fired before Timeout expired.
817 @retval EFI_TIME_OUT Timout expired before Event fired..
823 IN UINT64 Timeout OPTIONAL
828 EFI_EVENT TimerEvent
;
829 EFI_EVENT WaitList
[2];
833 // Create a timer event
835 Status
= gBS
->CreateEvent (EVT_TIMER
, 0, NULL
, NULL
, &TimerEvent
);
836 if (!EFI_ERROR (Status
)) {
838 // Set the timer event
847 // Wait for the original event or the timer
850 WaitList
[1] = TimerEvent
;
851 Status
= gBS
->WaitForEvent (2, WaitList
, &Index
);
852 gBS
->CloseEvent (TimerEvent
);
855 // If the timer expired, change the return to timed out
857 if (!EFI_ERROR (Status
) && Index
== 1) {
858 Status
= EFI_TIMEOUT
;
863 // No timeout... just wait on the event
865 Status
= gBS
->WaitForEvent (1, &Event
, &Index
);
866 ASSERT (!EFI_ERROR (Status
));
874 Function show progress bar to wait for user input.
877 @param TimeoutDefault The fault time out value before the system continue to boot.
879 @retval EFI_SUCCESS User pressed some key except "Enter"
880 @retval EFI_TIME_OUT Timeout expired or user press "Enter"
885 IN UINT16 TimeoutDefault
889 UINT16 TimeoutRemain
;
892 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground
;
893 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background
;
894 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Color
;
896 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);
903 TmpStr
= GetStringById (STRING_TOKEN (STR_START_BOOT_OPTION
));
905 if (!FeaturePcdGet(PcdBootlogoOnlyEnable
)) {
907 // Clear the progress status bar first
909 if (TmpStr
!= NULL
) {
910 PlatformBdsShowProgress (Foreground
, Background
, TmpStr
, Color
, 0, 0);
915 TimeoutRemain
= TimeoutDefault
;
916 while (TimeoutRemain
!= 0) {
917 DEBUG ((EFI_D_INFO
, "Showing progress bar...Remaining %d second!\n", TimeoutRemain
));
919 Status
= WaitForSingleEvent (gST
->ConIn
->WaitForKey
, ONE_SECOND
);
920 if (Status
!= EFI_TIMEOUT
) {
925 if (!FeaturePcdGet(PcdBootlogoOnlyEnable
)) {
929 if (TmpStr
!= NULL
) {
930 PlatformBdsShowProgress (
935 ((TimeoutDefault
- TimeoutRemain
) * 100 / TimeoutDefault
),
942 if (TmpStr
!= NULL
) {
943 gBS
->FreePool (TmpStr
);
949 if (TimeoutRemain
== 0) {
955 // User pressed some key
957 if (!PcdGetBool (PcdConInConnectOnDemand
)) {
958 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
959 if (EFI_ERROR (Status
)) {
963 if (Key
.UnicodeChar
== CHAR_CARRIAGE_RETURN
) {
965 // User pressed enter, equivalent to select "continue"
975 This function is the main entry of the platform setup entry.
976 The function will present the main menu of the system setup,
977 this is the platform reference part and can be customize.
980 @param TimeoutDefault The fault time out value before the system
982 @param ConnectAllHappened The indicater to check if the connect all have
987 PlatformBdsEnterFrontPage (
988 IN UINT16 TimeoutDefault
,
989 IN BOOLEAN ConnectAllHappened
993 EFI_STATUS StatusHotkey
;
994 EFI_BOOT_LOGO_PROTOCOL
*BootLogo
;
995 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
;
996 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*SimpleTextOut
;
997 UINTN BootTextColumn
;
1003 GraphicsOutput
= NULL
;
1004 SimpleTextOut
= NULL
;
1006 PERF_START (NULL
, "BdsTimeOut", "BDS", 0);
1008 // Indicate if we need connect all in the platform setup
1010 if (ConnectAllHappened
) {
1011 gConnectAllHappened
= TRUE
;
1014 if (!mModeInitialized
) {
1016 // After the console is ready, get current video resolution
1017 // and text mode before launching setup at first time.
1019 Status
= gBS
->HandleProtocol (
1020 gST
->ConsoleOutHandle
,
1021 &gEfiGraphicsOutputProtocolGuid
,
1022 (VOID
**)&GraphicsOutput
1024 if (EFI_ERROR (Status
)) {
1025 GraphicsOutput
= NULL
;
1028 Status
= gBS
->HandleProtocol (
1029 gST
->ConsoleOutHandle
,
1030 &gEfiSimpleTextOutProtocolGuid
,
1031 (VOID
**)&SimpleTextOut
1033 if (EFI_ERROR (Status
)) {
1034 SimpleTextOut
= NULL
;
1037 if (GraphicsOutput
!= NULL
) {
1039 // Get current video resolution and text mode.
1041 mBootHorizontalResolution
= GraphicsOutput
->Mode
->Info
->HorizontalResolution
;
1042 mBootVerticalResolution
= GraphicsOutput
->Mode
->Info
->VerticalResolution
;
1045 if (SimpleTextOut
!= NULL
) {
1046 Status
= SimpleTextOut
->QueryMode (
1048 SimpleTextOut
->Mode
->Mode
,
1052 mBootTextModeColumn
= (UINT32
)BootTextColumn
;
1053 mBootTextModeRow
= (UINT32
)BootTextRow
;
1057 // Get user defined text mode for setup.
1059 mSetupHorizontalResolution
= PcdGet32 (PcdSetupVideoHorizontalResolution
);
1060 mSetupVerticalResolution
= PcdGet32 (PcdSetupVideoVerticalResolution
);
1061 mSetupTextModeColumn
= PcdGet32 (PcdSetupConOutColumn
);
1062 mSetupTextModeRow
= PcdGet32 (PcdSetupConOutRow
);
1064 mModeInitialized
= TRUE
;
1069 // goto FrontPage directly when EFI_OS_INDICATIONS_BOOT_TO_FW_UI is set
1072 DataSize
= sizeof(UINT64
);
1073 Status
= gRT
->GetVariable (
1075 &gEfiGlobalVariableGuid
,
1082 // goto FrontPage directly when EFI_OS_INDICATIONS_BOOT_TO_FW_UI is set. Skip HotkeyBoot
1084 if (!EFI_ERROR(Status
) && ((OsIndication
& EFI_OS_INDICATIONS_BOOT_TO_FW_UI
) != 0)) {
1086 // Clear EFI_OS_INDICATIONS_BOOT_TO_FW_UI to acknowledge OS
1088 OsIndication
&= ~((UINT64
)EFI_OS_INDICATIONS_BOOT_TO_FW_UI
);
1089 Status
= gRT
->SetVariable (
1091 &gEfiGlobalVariableGuid
,
1092 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
1097 // Changing the content without increasing its size with current variable implementation shouldn't fail.
1099 ASSERT_EFI_ERROR (Status
);
1102 // Follow generic rule, Call ReadKeyStroke to connect ConIn before enter UI
1104 if (PcdGetBool (PcdConInConnectOnDemand
)) {
1105 gST
->ConIn
->ReadKeyStroke(gST
->ConIn
, &Key
);
1109 // Ensure screen is clear when switch Console from Graphics mode to Text mode
1111 gST
->ConOut
->EnableCursor (gST
->ConOut
, TRUE
);
1112 gST
->ConOut
->ClearScreen (gST
->ConOut
);
1117 if (TimeoutDefault
!= 0xffff) {
1118 Status
= ShowProgress (TimeoutDefault
);
1119 StatusHotkey
= HotkeyBoot ();
1121 if (!FeaturePcdGet(PcdBootlogoOnlyEnable
) || !EFI_ERROR(Status
) || !EFI_ERROR(StatusHotkey
)){
1123 // Ensure screen is clear when switch Console from Graphics mode to Text mode
1124 // Skip it in normal boot
1126 gST
->ConOut
->EnableCursor (gST
->ConOut
, TRUE
);
1127 gST
->ConOut
->ClearScreen (gST
->ConOut
);
1130 if (EFI_ERROR (Status
)) {
1132 // Timeout or user press enter to continue
1140 // Boot Logo is corrupted, report it using Boot Logo protocol.
1142 Status
= gBS
->LocateProtocol (&gEfiBootLogoProtocolGuid
, NULL
, (VOID
**) &BootLogo
);
1143 if (!EFI_ERROR (Status
) && (BootLogo
!= NULL
)) {
1144 BootLogo
->SetBootLogo (BootLogo
, NULL
, 0, 0, 0, 0);
1148 // Install BM HiiPackages.
1149 // Keep BootMaint HiiPackage, so that it can be covered by global setting.
1153 Status
= EFI_SUCCESS
;
1156 // Set proper video resolution and text mode for setup
1158 BdsSetConsoleMode (TRUE
);
1160 InitializeFrontPage (FALSE
);
1163 // Update Front Page strings
1165 UpdateFrontPageStrings ();
1171 // If gCallbackKey is greater than 1 and less or equal to 5,
1172 // it will launch configuration utilities.
1175 // 4 = device manager
1176 // 5 = boot maintenance manager
1178 if (gCallbackKey
!= 0) {
1179 REPORT_STATUS_CODE (
1181 (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_SW_PC_USER_SETUP
)
1185 // Based on the key that was set, we can determine what to do
1187 switch (gCallbackKey
) {
1189 // The first 4 entries in the Front Page are to be GUARANTEED to remain constant so IHV's can
1190 // describe to their customers in documentation how to find their setup information (namely
1191 // under the device manager and specific buckets)
1193 // These entries consist of the Continue, Select language, Boot Manager, and Device Manager
1195 case FRONT_PAGE_KEY_CONTINUE
:
1197 // User hit continue
1201 case FRONT_PAGE_KEY_LANGUAGE
:
1203 // User made a language setting change - display front page again
1207 case FRONT_PAGE_KEY_BOOT_MANAGER
:
1209 // Remove the installed BootMaint HiiPackages when exit.
1214 // User chose to run the Boot Manager
1219 // Reinstall BootMaint HiiPackages after exiting from Boot Manager.
1224 case FRONT_PAGE_KEY_DEVICE_MANAGER
:
1226 // Display the Device Manager
1229 CallDeviceManager ();
1230 } while (gCallbackKey
== FRONT_PAGE_KEY_DEVICE_MANAGER
);
1233 case FRONT_PAGE_KEY_BOOT_MAINTAIN
:
1235 // Display the Boot Maintenance Manager
1237 BdsStartBootMaint ();
1241 } while ((Status
== EFI_SUCCESS
) && (gCallbackKey
!= FRONT_PAGE_KEY_CONTINUE
));
1243 if (mLanguageString
!= NULL
) {
1244 FreePool (mLanguageString
);
1245 mLanguageString
= NULL
;
1248 //Will leave browser, check any reset required change is applied? if yes, reset system
1250 SetupResetReminder ();
1253 // Remove the installed BootMaint HiiPackages when exit.
1259 // Automatically load current entry
1260 // Note: The following lines of code only execute when Auto boot
1263 PERF_END (NULL
, "BdsTimeOut", "BDS", 0);
1267 This function will change video resolution and text mode
1268 according to defined setup mode or defined boot mode
1270 @param IsSetupMode Indicate mode is changed to setup mode or boot mode.
1272 @retval EFI_SUCCESS Mode is changed successfully.
1273 @retval Others Mode failed to be changed.
1282 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
;
1283 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*SimpleTextOut
;
1285 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*Info
;
1289 UINT32 NewHorizontalResolution
;
1290 UINT32 NewVerticalResolution
;
1294 EFI_HANDLE
*HandleBuffer
;
1297 UINTN CurrentColumn
;
1304 // Get current video resolution and text mode
1306 Status
= gBS
->HandleProtocol (
1307 gST
->ConsoleOutHandle
,
1308 &gEfiGraphicsOutputProtocolGuid
,
1309 (VOID
**)&GraphicsOutput
1311 if (EFI_ERROR (Status
)) {
1312 GraphicsOutput
= NULL
;
1315 Status
= gBS
->HandleProtocol (
1316 gST
->ConsoleOutHandle
,
1317 &gEfiSimpleTextOutProtocolGuid
,
1318 (VOID
**)&SimpleTextOut
1320 if (EFI_ERROR (Status
)) {
1321 SimpleTextOut
= NULL
;
1324 if ((GraphicsOutput
== NULL
) || (SimpleTextOut
== NULL
)) {
1325 return EFI_UNSUPPORTED
;
1330 // The requried resolution and text mode is setup mode.
1332 NewHorizontalResolution
= mSetupHorizontalResolution
;
1333 NewVerticalResolution
= mSetupVerticalResolution
;
1334 NewColumns
= mSetupTextModeColumn
;
1335 NewRows
= mSetupTextModeRow
;
1338 // The required resolution and text mode is boot mode.
1340 NewHorizontalResolution
= mBootHorizontalResolution
;
1341 NewVerticalResolution
= mBootVerticalResolution
;
1342 NewColumns
= mBootTextModeColumn
;
1343 NewRows
= mBootTextModeRow
;
1346 if (GraphicsOutput
!= NULL
) {
1347 MaxGopMode
= GraphicsOutput
->Mode
->MaxMode
;
1350 if (SimpleTextOut
!= NULL
) {
1351 MaxTextMode
= SimpleTextOut
->Mode
->MaxMode
;
1355 // 1. If current video resolution is same with required video resolution,
1356 // video resolution need not be changed.
1357 // 1.1. If current text mode is same with required text mode, text mode need not be changed.
1358 // 1.2. If current text mode is different from required text mode, text mode need be changed.
1359 // 2. If current video resolution is different from required video resolution, we need restart whole console drivers.
1361 for (ModeNumber
= 0; ModeNumber
< MaxGopMode
; ModeNumber
++) {
1362 Status
= GraphicsOutput
->QueryMode (
1368 if (!EFI_ERROR (Status
)) {
1369 if ((Info
->HorizontalResolution
== NewHorizontalResolution
) &&
1370 (Info
->VerticalResolution
== NewVerticalResolution
)) {
1371 if ((GraphicsOutput
->Mode
->Info
->HorizontalResolution
== NewHorizontalResolution
) &&
1372 (GraphicsOutput
->Mode
->Info
->VerticalResolution
== NewVerticalResolution
)) {
1374 // Current resolution is same with required resolution, check if text mode need be set
1376 Status
= SimpleTextOut
->QueryMode (SimpleTextOut
, SimpleTextOut
->Mode
->Mode
, &CurrentColumn
, &CurrentRow
);
1377 ASSERT_EFI_ERROR (Status
);
1378 if (CurrentColumn
== NewColumns
&& CurrentRow
== NewRows
) {
1380 // If current text mode is same with required text mode. Do nothing
1386 // If current text mode is different from requried text mode. Set new video mode
1388 for (Index
= 0; Index
< MaxTextMode
; Index
++) {
1389 Status
= SimpleTextOut
->QueryMode (SimpleTextOut
, Index
, &CurrentColumn
, &CurrentRow
);
1390 if (!EFI_ERROR(Status
)) {
1391 if ((CurrentColumn
== NewColumns
) && (CurrentRow
== NewRows
)) {
1393 // Required text mode is supported, set it.
1395 Status
= SimpleTextOut
->SetMode (SimpleTextOut
, Index
);
1396 ASSERT_EFI_ERROR (Status
);
1398 // Update text mode PCD.
1400 Status
= PcdSet32S (PcdConOutColumn
, mSetupTextModeColumn
);
1401 ASSERT_EFI_ERROR (Status
);
1402 Status
= PcdSet32S (PcdConOutRow
, mSetupTextModeRow
);
1403 ASSERT_EFI_ERROR (Status
);
1409 if (Index
== MaxTextMode
) {
1411 // If requried text mode is not supported, return error.
1414 return EFI_UNSUPPORTED
;
1419 // If current video resolution is not same with the new one, set new video resolution.
1420 // In this case, the driver which produces simple text out need be restarted.
1422 Status
= GraphicsOutput
->SetMode (GraphicsOutput
, ModeNumber
);
1423 if (!EFI_ERROR (Status
)) {
1433 if (ModeNumber
== MaxGopMode
) {
1435 // If the resolution is not supported, return error.
1437 return EFI_UNSUPPORTED
;
1441 // Set PCD to Inform GraphicsConsole to change video resolution.
1442 // Set PCD to Inform Consplitter to change text mode.
1444 Status
= PcdSet32S (PcdVideoHorizontalResolution
, NewHorizontalResolution
);
1445 ASSERT_EFI_ERROR (Status
);
1446 Status
= PcdSet32S (PcdVideoVerticalResolution
, NewVerticalResolution
);
1447 ASSERT_EFI_ERROR (Status
);
1448 Status
= PcdSet32S (PcdConOutColumn
, NewColumns
);
1449 ASSERT_EFI_ERROR (Status
);
1450 Status
= PcdSet32S (PcdConOutRow
, NewRows
);
1451 ASSERT_EFI_ERROR (Status
);
1455 // Video mode is changed, so restart graphics console driver and higher level driver.
1456 // Reconnect graphics console driver and higher level driver.
1457 // Locate all the handles with GOP protocol and reconnect it.
1459 Status
= gBS
->LocateHandleBuffer (
1461 &gEfiSimpleTextOutProtocolGuid
,
1466 if (!EFI_ERROR (Status
)) {
1467 for (Index
= 0; Index
< HandleCount
; Index
++) {
1468 gBS
->DisconnectController (HandleBuffer
[Index
], NULL
, NULL
);
1470 for (Index
= 0; Index
< HandleCount
; Index
++) {
1471 gBS
->ConnectController (HandleBuffer
[Index
], NULL
, NULL
, TRUE
);
1473 if (HandleBuffer
!= NULL
) {
1474 FreePool (HandleBuffer
);