2 This module produce main entry for BDS phase - BdsEntry.
3 When this module was dispatched by DxeCore, gEfiBdsArchProtocolGuid will be installed
4 which contains interface of BdsEntry.
5 After DxeCore finish DXE phase, gEfiBdsArchProtocolGuid->BdsEntry will be invoked
8 Copyright (c) 2004 - 2019, Intel Corporation. All rights reserved.<BR>
9 (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>
10 (C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>
11 SPDX-License-Identifier: BSD-2-Clause-Patent
17 #include "HwErrRecSupport.h"
19 #define SET_BOOT_OPTION_SUPPORT_KEY_COUNT(a, c) { \
20 (a) = ((a) & ~EFI_BOOT_OPTION_SUPPORT_COUNT) | (((c) << LowBitSet32 (EFI_BOOT_OPTION_SUPPORT_COUNT)) & EFI_BOOT_OPTION_SUPPORT_COUNT); \
24 /// BDS arch protocol instance initial value.
26 EFI_BDS_ARCH_PROTOCOL gBds
= {
31 // gConnectConInEvent - Event which is signaled when ConIn connection is required
33 EFI_EVENT gConnectConInEvent
= NULL
;
36 /// The read-only variables defined in UEFI Spec.
38 CHAR16
*mReadOnlyVariables
[] = {
39 EFI_PLATFORM_LANG_CODES_VARIABLE_NAME
,
40 EFI_LANG_CODES_VARIABLE_NAME
,
41 EFI_BOOT_OPTION_SUPPORT_VARIABLE_NAME
,
42 EFI_HW_ERR_REC_SUPPORT_VARIABLE_NAME
,
43 EFI_OS_INDICATIONS_SUPPORT_VARIABLE_NAME
46 CHAR16
*mBdsLoadOptionName
[] = {
54 Event to Connect ConIn.
56 @param Event Event whose notification function is being invoked.
57 @param Context Pointer to the notification function's context,
58 which is implementation-dependent.
63 BdsDxeOnConnectConInCallBack (
71 // When Osloader call ReadKeyStroke to signal this event
72 // no driver dependency is assumed existing. So use a non-dispatch version
74 Status
= EfiBootManagerConnectConsoleVariable (ConIn
);
75 if (EFI_ERROR (Status
)) {
77 // Should not enter this case, if enter, the keyboard will not work.
78 // May need platfrom policy to connect keyboard.
80 DEBUG ((EFI_D_WARN
, "[Bds] Connect ConIn failed - %r!!!\n", Status
));
84 Notify function for event group EFI_EVENT_GROUP_READY_TO_BOOT. This is used to
85 check whether there is remaining deferred load images.
87 @param[in] Event The Event that is being processed.
88 @param[in] Context The Event Context.
93 CheckDeferredLoadImageOnReadyToBoot (
99 EFI_DEFERRED_IMAGE_LOAD_PROTOCOL
*DeferredImage
;
104 EFI_DEVICE_PATH_PROTOCOL
*ImageDevicePath
;
108 CHAR16
*DevicePathStr
;
111 // Find all the deferred image load protocols.
115 Status
= gBS
->LocateHandleBuffer (
117 &gEfiDeferredImageLoadProtocolGuid
,
122 if (EFI_ERROR (Status
)) {
126 for (Index
= 0; Index
< HandleCount
; Index
++) {
127 Status
= gBS
->HandleProtocol (Handles
[Index
], &gEfiDeferredImageLoadProtocolGuid
, (VOID
**) &DeferredImage
);
128 if (EFI_ERROR (Status
)) {
132 for (ImageIndex
= 0; ; ImageIndex
++) {
134 // Load all the deferred images in this protocol instance.
136 Status
= DeferredImage
->GetImageInfo (
144 if (EFI_ERROR (Status
)) {
147 DevicePathStr
= ConvertDevicePathToText (ImageDevicePath
, FALSE
, FALSE
);
148 DEBUG ((DEBUG_LOAD
, "[Bds] Image was deferred but not loaded: %s.\n", DevicePathStr
));
149 if (DevicePathStr
!= NULL
) {
150 FreePool (DevicePathStr
);
154 if (Handles
!= NULL
) {
161 Install Boot Device Selection Protocol
163 @param ImageHandle The image handle.
164 @param SystemTable The system table.
166 @retval EFI_SUCEESS BDS has finished initializing.
167 Return the dispatcher and recall BDS.Entry
168 @retval Other Return status from AllocatePool() or gBS->InstallProtocolInterface
174 IN EFI_HANDLE ImageHandle
,
175 IN EFI_SYSTEM_TABLE
*SystemTable
181 // Install protocol interface
184 Status
= gBS
->InstallMultipleProtocolInterfaces (
186 &gEfiBdsArchProtocolGuid
, &gBds
,
189 ASSERT_EFI_ERROR (Status
);
194 // Register notify function to check deferred images on ReadyToBoot Event.
196 Status
= gBS
->CreateEventEx (
199 CheckDeferredLoadImageOnReadyToBoot
,
201 &gEfiEventReadyToBootGuid
,
204 ASSERT_EFI_ERROR (Status
);
210 Function waits for a given event to fire, or for an optional timeout to expire.
212 @param Event The event to wait for
213 @param Timeout An optional timeout value in 100 ns units.
215 @retval EFI_SUCCESS Event fired before Timeout expired.
216 @retval EFI_TIME_OUT Timout expired before Event fired..
220 BdsWaitForSingleEvent (
222 IN UINT64 Timeout OPTIONAL
227 EFI_EVENT TimerEvent
;
228 EFI_EVENT WaitList
[2];
232 // Create a timer event
234 Status
= gBS
->CreateEvent (EVT_TIMER
, 0, NULL
, NULL
, &TimerEvent
);
235 if (!EFI_ERROR (Status
)) {
237 // Set the timer event
246 // Wait for the original event or the timer
249 WaitList
[1] = TimerEvent
;
250 Status
= gBS
->WaitForEvent (2, WaitList
, &Index
);
251 ASSERT_EFI_ERROR (Status
);
252 gBS
->CloseEvent (TimerEvent
);
255 // If the timer expired, change the return to timed out
258 Status
= EFI_TIMEOUT
;
263 // No timeout... just wait on the event
265 Status
= gBS
->WaitForEvent (1, &Event
, &Index
);
266 ASSERT (!EFI_ERROR (Status
));
274 The function reads user inputs.
285 if (PcdGetBool (PcdConInConnectOnDemand
)) {
289 while (gST
->ConIn
!= NULL
) {
291 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
293 if (EFI_ERROR (Status
)) {
303 The function waits for the boot manager timeout expires or hotkey is pressed.
305 It calls PlatformBootManagerWaitCallback each second.
307 @param HotkeyTriggered Input hotkey event.
311 IN EFI_EVENT HotkeyTriggered
315 UINT16 TimeoutRemain
;
317 DEBUG ((EFI_D_INFO
, "[Bds]BdsWait ...Zzzzzzzzzzzz...\n"));
319 TimeoutRemain
= PcdGet16 (PcdPlatformBootTimeOut
);
320 while (TimeoutRemain
!= 0) {
321 DEBUG ((EFI_D_INFO
, "[Bds]BdsWait(%d)..Zzzz...\n", (UINTN
) TimeoutRemain
));
322 PlatformBootManagerWaitCallback (TimeoutRemain
);
324 BdsReadKeys (); // BUGBUG: Only reading can signal HotkeyTriggered
325 // Can be removed after all keyboard drivers invoke callback in timer callback.
327 if (HotkeyTriggered
!= NULL
) {
328 Status
= BdsWaitForSingleEvent (HotkeyTriggered
, EFI_TIMER_PERIOD_SECONDS (1));
329 if (!EFI_ERROR (Status
)) {
333 gBS
->Stall (1000000);
337 // 0xffff means waiting forever
338 // BDS with no hotkey provided and 0xffff as timeout will "hang" in the loop
340 if (TimeoutRemain
!= 0xffff) {
344 DEBUG ((EFI_D_INFO
, "[Bds]Exit the waiting!\n"));
348 Attempt to boot each boot option in the BootOptions array.
350 @param BootOptions Input boot option array.
351 @param BootOptionCount Input boot option count.
352 @param BootManagerMenu Input boot manager menu.
354 @retval TRUE Successfully boot one of the boot options.
355 @retval FALSE Failed boot any of the boot options.
359 IN EFI_BOOT_MANAGER_LOAD_OPTION
*BootOptions
,
360 IN UINTN BootOptionCount
,
361 IN EFI_BOOT_MANAGER_LOAD_OPTION
*BootManagerMenu OPTIONAL
367 // Report Status Code to indicate BDS starts attempting booting from the UEFI BootOrder list.
369 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_SW_DXE_BS_PC_ATTEMPT_BOOT_ORDER_EVENT
));
372 // Attempt boot each boot option
374 for (Index
= 0; Index
< BootOptionCount
; Index
++) {
376 // According to EFI Specification, if a load option is not marked
377 // as LOAD_OPTION_ACTIVE, the boot manager will not automatically
380 if ((BootOptions
[Index
].Attributes
& LOAD_OPTION_ACTIVE
) == 0) {
385 // Boot#### load options with LOAD_OPTION_CATEGORY_APP are executables which are not
386 // part of the normal boot processing. Boot options with reserved category values will be
387 // ignored by the boot manager.
389 if ((BootOptions
[Index
].Attributes
& LOAD_OPTION_CATEGORY
) != LOAD_OPTION_CATEGORY_BOOT
) {
394 // All the driver options should have been processed since
395 // now boot will be performed.
397 EfiBootManagerBoot (&BootOptions
[Index
]);
400 // If the boot via Boot#### returns with a status of EFI_SUCCESS, platform firmware
401 // supports boot manager menu, and if firmware is configured to boot in an
402 // interactive mode, the boot manager will stop processing the BootOrder variable and
403 // present a boot manager menu to the user.
405 if ((BootManagerMenu
!= NULL
) && (BootOptions
[Index
].Status
== EFI_SUCCESS
)) {
406 EfiBootManagerBoot (BootManagerMenu
);
411 return (BOOLEAN
) (Index
< BootOptionCount
);
415 The function will load and start every Driver####, SysPrep#### or PlatformRecovery####.
417 @param LoadOptions Load option array.
418 @param LoadOptionCount Load option count.
422 IN EFI_BOOT_MANAGER_LOAD_OPTION
*LoadOptions
,
423 IN UINTN LoadOptionCount
428 BOOLEAN ReconnectAll
;
429 EFI_BOOT_MANAGER_LOAD_OPTION_TYPE LoadOptionType
;
431 ReconnectAll
= FALSE
;
432 LoadOptionType
= LoadOptionTypeMax
;
435 // Process the driver option
437 for (Index
= 0; Index
< LoadOptionCount
; Index
++) {
439 // All the load options in the array should be of the same type.
442 LoadOptionType
= LoadOptions
[Index
].OptionType
;
444 ASSERT (LoadOptionType
== LoadOptions
[Index
].OptionType
);
445 ASSERT (LoadOptionType
!= LoadOptionTypeBoot
);
447 Status
= EfiBootManagerProcessLoadOption (&LoadOptions
[Index
]);
450 // Status indicates whether the load option is loaded and executed
451 // LoadOptions[Index].Status is what the load option returns
453 if (!EFI_ERROR (Status
)) {
455 // Stop processing if any PlatformRecovery#### returns success.
457 if ((LoadOptions
[Index
].Status
== EFI_SUCCESS
) &&
458 (LoadOptionType
== LoadOptionTypePlatformRecovery
)) {
463 // Only set ReconnectAll flag when the load option executes successfully.
465 if (!EFI_ERROR (LoadOptions
[Index
].Status
) &&
466 (LoadOptions
[Index
].Attributes
& LOAD_OPTION_FORCE_RECONNECT
) != 0) {
473 // If a driver load option is marked as LOAD_OPTION_FORCE_RECONNECT,
474 // then all of the EFI drivers in the system will be disconnected and
475 // reconnected after the last driver load option is processed.
477 if (ReconnectAll
&& LoadOptionType
== LoadOptionTypeDriver
) {
478 EfiBootManagerDisconnectAll ();
479 EfiBootManagerConnectAll ();
485 Validate input console variable data.
487 If found the device path is not a valid device path, remove the variable.
489 @param VariableName Input console variable name.
493 BdsFormalizeConsoleVariable (
494 IN CHAR16
*VariableName
497 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
501 GetEfiGlobalVariable2 (VariableName
, (VOID
**) &DevicePath
, &VariableSize
);
502 if ((DevicePath
!= NULL
) && !IsDevicePathValid (DevicePath
, VariableSize
)) {
503 Status
= gRT
->SetVariable (
505 &gEfiGlobalVariableGuid
,
506 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
511 // Deleting variable with current variable implementation shouldn't fail.
513 ASSERT_EFI_ERROR (Status
);
516 if (DevicePath
!= NULL
) {
517 FreePool (DevicePath
);
522 Formalize OsIndication related variables.
524 For OsIndicationsSupported, Create a BS/RT/UINT64 variable to report caps
525 Delete OsIndications variable if it is not NV/BS/RT UINT64.
527 Item 3 is used to solve case when OS corrupts OsIndications. Here simply delete this NV variable.
529 Create a boot option for BootManagerMenu if it hasn't been created yet
533 BdsFormalizeOSIndicationVariable (
538 UINT64 OsIndicationSupport
;
542 EFI_BOOT_MANAGER_LOAD_OPTION BootManagerMenu
;
545 // OS indicater support variable
547 Status
= EfiBootManagerGetBootManagerMenu (&BootManagerMenu
);
548 if (Status
!= EFI_NOT_FOUND
) {
549 OsIndicationSupport
= EFI_OS_INDICATIONS_BOOT_TO_FW_UI
;
550 EfiBootManagerFreeLoadOption (&BootManagerMenu
);
552 OsIndicationSupport
= 0;
555 if (PcdGetBool (PcdPlatformRecoverySupport
)) {
556 OsIndicationSupport
|= EFI_OS_INDICATIONS_START_PLATFORM_RECOVERY
;
559 if (PcdGetBool(PcdCapsuleOnDiskSupport
)) {
560 OsIndicationSupport
|= EFI_OS_INDICATIONS_FILE_CAPSULE_DELIVERY_SUPPORTED
;
563 Status
= gRT
->SetVariable (
564 EFI_OS_INDICATIONS_SUPPORT_VARIABLE_NAME
,
565 &gEfiGlobalVariableGuid
,
566 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
571 // Platform needs to make sure setting volatile variable before calling 3rd party code shouldn't fail.
573 ASSERT_EFI_ERROR (Status
);
576 // If OsIndications is invalid, remove it.
578 // 1. Data size != UINT64
579 // 2. OsIndication value inconsistence
580 // 3. OsIndication attribute inconsistence
584 DataSize
= sizeof(UINT64
);
585 Status
= gRT
->GetVariable (
586 EFI_OS_INDICATIONS_VARIABLE_NAME
,
587 &gEfiGlobalVariableGuid
,
592 if (Status
== EFI_NOT_FOUND
) {
596 if ((DataSize
!= sizeof (OsIndication
)) ||
597 ((OsIndication
& ~OsIndicationSupport
) != 0) ||
598 (Attributes
!= (EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
))
601 DEBUG ((EFI_D_ERROR
, "[Bds] Unformalized OsIndications variable exists. Delete it\n"));
602 Status
= gRT
->SetVariable (
603 EFI_OS_INDICATIONS_VARIABLE_NAME
,
604 &gEfiGlobalVariableGuid
,
610 // Deleting variable with current variable implementation shouldn't fail.
612 ASSERT_EFI_ERROR(Status
);
622 BdsFormalizeEfiGlobalVariable (
627 // Validate Console variable.
629 BdsFormalizeConsoleVariable (EFI_CON_IN_VARIABLE_NAME
);
630 BdsFormalizeConsoleVariable (EFI_CON_OUT_VARIABLE_NAME
);
631 BdsFormalizeConsoleVariable (EFI_ERR_OUT_VARIABLE_NAME
);
634 // Validate OSIndication related variable.
636 BdsFormalizeOSIndicationVariable ();
641 Service routine for BdsInstance->Entry(). Devices are connected, the
642 consoles are initialized, and the boot options are tried.
644 @param This Protocol Instance structure.
650 IN EFI_BDS_ARCH_PROTOCOL
*This
653 EFI_BOOT_MANAGER_LOAD_OPTION
*LoadOptions
;
654 UINTN LoadOptionCount
;
655 CHAR16
*FirmwareVendor
;
656 EFI_EVENT HotkeyTriggered
;
660 UINT32 BootOptionSupport
;
662 EDKII_VARIABLE_LOCK_PROTOCOL
*VariableLock
;
664 EFI_BOOT_MANAGER_LOAD_OPTION LoadOption
;
666 CHAR16 BootNextVariableName
[sizeof ("Boot####")];
667 EFI_BOOT_MANAGER_LOAD_OPTION BootManagerMenu
;
669 BOOLEAN PlatformRecovery
;
671 EFI_DEVICE_PATH_PROTOCOL
*FilePath
;
672 EFI_STATUS BootManagerMenuStatus
;
673 EFI_BOOT_MANAGER_LOAD_OPTION PlatformDefaultBootOption
;
675 HotkeyTriggered
= NULL
;
676 Status
= EFI_SUCCESS
;
680 // Insert the performance probe
682 PERF_CROSSMODULE_END("DXE");
683 PERF_CROSSMODULE_BEGIN("BDS");
684 DEBUG ((EFI_D_INFO
, "[Bds] Entry...\n"));
687 // Fill in FirmwareVendor and FirmwareRevision from PCDs
689 FirmwareVendor
= (CHAR16
*) PcdGetPtr (PcdFirmwareVendor
);
690 gST
->FirmwareVendor
= AllocateRuntimeCopyPool (StrSize (FirmwareVendor
), FirmwareVendor
);
691 ASSERT (gST
->FirmwareVendor
!= NULL
);
692 gST
->FirmwareRevision
= PcdGet32 (PcdFirmwareRevision
);
695 // Fixup Tasble CRC after we updated Firmware Vendor and Revision
698 gBS
->CalculateCrc32 ((VOID
*) gST
, sizeof (EFI_SYSTEM_TABLE
), &gST
->Hdr
.CRC32
);
701 // Validate Variable.
703 BdsFormalizeEfiGlobalVariable ();
706 // Mark the read-only variables if the Variable Lock protocol exists
708 Status
= gBS
->LocateProtocol (&gEdkiiVariableLockProtocolGuid
, NULL
, (VOID
**) &VariableLock
);
709 DEBUG ((EFI_D_INFO
, "[BdsDxe] Locate Variable Lock protocol - %r\n", Status
));
710 if (!EFI_ERROR (Status
)) {
711 for (Index
= 0; Index
< ARRAY_SIZE (mReadOnlyVariables
); Index
++) {
712 Status
= VariableLock
->RequestToLock (VariableLock
, mReadOnlyVariables
[Index
], &gEfiGlobalVariableGuid
);
713 ASSERT_EFI_ERROR (Status
);
717 InitializeHwErrRecSupport ();
720 // Initialize L"Timeout" EFI global variable.
722 BootTimeOut
= PcdGet16 (PcdPlatformBootTimeOut
);
723 if (BootTimeOut
!= 0xFFFF) {
725 // If time out value equal 0xFFFF, no need set to 0xFFFF to variable area because UEFI specification
726 // define same behavior between no value or 0xFFFF value for L"Timeout".
728 BdsDxeSetVariableAndReportStatusCodeOnError (
729 EFI_TIME_OUT_VARIABLE_NAME
,
730 &gEfiGlobalVariableGuid
,
731 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
738 // Initialize L"BootOptionSupport" EFI global variable.
739 // Lazy-ConIn implictly disables BDS hotkey.
741 BootOptionSupport
= EFI_BOOT_OPTION_SUPPORT_APP
| EFI_BOOT_OPTION_SUPPORT_SYSPREP
;
742 if (!PcdGetBool (PcdConInConnectOnDemand
)) {
743 BootOptionSupport
|= EFI_BOOT_OPTION_SUPPORT_KEY
;
744 SET_BOOT_OPTION_SUPPORT_KEY_COUNT (BootOptionSupport
, 3);
746 Status
= gRT
->SetVariable (
747 EFI_BOOT_OPTION_SUPPORT_VARIABLE_NAME
,
748 &gEfiGlobalVariableGuid
,
749 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
750 sizeof (BootOptionSupport
),
754 // Platform needs to make sure setting volatile variable before calling 3rd party code shouldn't fail.
756 ASSERT_EFI_ERROR (Status
);
759 // Cache the "BootNext" NV variable before calling any PlatformBootManagerLib APIs
760 // This could avoid the "BootNext" set by PlatformBootManagerLib be consumed in this boot.
762 GetEfiGlobalVariable2 (EFI_BOOT_NEXT_VARIABLE_NAME
, (VOID
**) &BootNext
, &DataSize
);
763 if (DataSize
!= sizeof (UINT16
)) {
764 if (BootNext
!= NULL
) {
771 // Initialize the platform language variables
773 InitializeLanguage (TRUE
);
775 FilePath
= FileDevicePath (NULL
, EFI_REMOVABLE_MEDIA_FILE_NAME
);
776 if (FilePath
== NULL
) {
777 DEBUG ((DEBUG_ERROR
, "Fail to allocate memory for defualt boot file path. Unable to boot.\n"));
780 Status
= EfiBootManagerInitializeLoadOption (
781 &PlatformDefaultBootOption
,
782 LoadOptionNumberUnassigned
,
783 LoadOptionTypePlatformRecovery
,
785 L
"Default PlatformRecovery",
790 ASSERT_EFI_ERROR (Status
);
793 // System firmware must include a PlatformRecovery#### variable specifying
794 // a short-form File Path Media Device Path containing the platform default
795 // file path for removable media if the platform supports Platform Recovery.
797 if (PcdGetBool (PcdPlatformRecoverySupport
)) {
798 LoadOptions
= EfiBootManagerGetLoadOptions (&LoadOptionCount
, LoadOptionTypePlatformRecovery
);
799 if (EfiBootManagerFindLoadOption (&PlatformDefaultBootOption
, LoadOptions
, LoadOptionCount
) == -1) {
800 for (Index
= 0; Index
< LoadOptionCount
; Index
++) {
802 // The PlatformRecovery#### options are sorted by OptionNumber.
803 // Find the the smallest unused number as the new OptionNumber.
805 if (LoadOptions
[Index
].OptionNumber
!= Index
) {
809 PlatformDefaultBootOption
.OptionNumber
= Index
;
810 Status
= EfiBootManagerLoadOptionToVariable (&PlatformDefaultBootOption
);
811 ASSERT_EFI_ERROR (Status
);
813 EfiBootManagerFreeLoadOptions (LoadOptions
, LoadOptionCount
);
818 // Report Status Code to indicate connecting drivers will happen
822 (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_SW_DXE_BS_PC_BEGIN_CONNECTING_DRIVERS
)
826 // Initialize ConnectConIn event before calling platform code.
828 if (PcdGetBool (PcdConInConnectOnDemand
)) {
829 Status
= gBS
->CreateEventEx (
832 BdsDxeOnConnectConInCallBack
,
834 &gConnectConInEventGuid
,
837 if (EFI_ERROR (Status
)) {
838 gConnectConInEvent
= NULL
;
843 // Do the platform init, can be customized by OEM/IBV
844 // Possible things that can be done in PlatformBootManagerBeforeConsole:
845 // > Update console variable: 1. include hot-plug devices; 2. Clear ConIn and add SOL for AMT
846 // > Register new Driver#### or Boot####
847 // > Register new Key####: e.g.: F12
848 // > Signal ReadyToLock event
849 // > Authentication action: 1. connect Auth devices; 2. Identify auto logon user.
851 PERF_INMODULE_BEGIN("PlatformBootManagerBeforeConsole");
852 PlatformBootManagerBeforeConsole ();
853 PERF_INMODULE_END("PlatformBootManagerBeforeConsole");
856 // Initialize hotkey service
858 EfiBootManagerStartHotkeyService (&HotkeyTriggered
);
861 // Execute Driver Options
863 LoadOptions
= EfiBootManagerGetLoadOptions (&LoadOptionCount
, LoadOptionTypeDriver
);
864 ProcessLoadOptions (LoadOptions
, LoadOptionCount
);
865 EfiBootManagerFreeLoadOptions (LoadOptions
, LoadOptionCount
);
870 PERF_INMODULE_BEGIN("EfiBootManagerConnectAllDefaultConsoles");
871 if (PcdGetBool (PcdConInConnectOnDemand
)) {
872 EfiBootManagerConnectConsoleVariable (ConOut
);
873 EfiBootManagerConnectConsoleVariable (ErrOut
);
875 // Do not connect ConIn devices when lazy ConIn feature is ON.
878 EfiBootManagerConnectAllDefaultConsoles ();
880 PERF_INMODULE_END("EfiBootManagerConnectAllDefaultConsoles");
883 // Do the platform specific action after the console is ready
884 // Possible things that can be done in PlatformBootManagerAfterConsole:
885 // > Console post action:
886 // > Dynamically switch output mode from 100x31 to 80x25 for certain senarino
887 // > Signal console ready platform customized event
888 // > Run diagnostics like memory testing
889 // > Connect certain devices
890 // > Dispatch aditional option roms
891 // > Special boot: e.g.: USB boot, enter UI
893 PERF_INMODULE_BEGIN("PlatformBootManagerAfterConsole");
894 PlatformBootManagerAfterConsole ();
895 PERF_INMODULE_END("PlatformBootManagerAfterConsole");
898 // If any component set PcdTestKeyUsed to TRUE because use of a test key
899 // was detected, then display a warning message on the debug log and the console
901 if (PcdGetBool (PcdTestKeyUsed
)) {
902 DEBUG ((DEBUG_ERROR
, "**********************************\n"));
903 DEBUG ((DEBUG_ERROR
, "** WARNING: Test Key is used. **\n"));
904 DEBUG ((DEBUG_ERROR
, "**********************************\n"));
905 Print (L
"** WARNING: Test Key is used. **\n");
909 // Boot to Boot Manager Menu when EFI_OS_INDICATIONS_BOOT_TO_FW_UI is set. Skip HotkeyBoot
911 DataSize
= sizeof (UINT64
);
912 Status
= gRT
->GetVariable (
913 EFI_OS_INDICATIONS_VARIABLE_NAME
,
914 &gEfiGlobalVariableGuid
,
919 if (EFI_ERROR (Status
)) {
924 EFI_BOOT_MANAGER_LOAD_OPTION_TYPE LoadOptionType
;
925 DEBUG ((EFI_D_INFO
, "[Bds]OsIndication: %016x\n", OsIndication
));
926 DEBUG ((EFI_D_INFO
, "[Bds]=============Begin Load Options Dumping ...=============\n"));
927 for (LoadOptionType
= 0; LoadOptionType
< LoadOptionTypeMax
; LoadOptionType
++) {
929 EFI_D_INFO
, " %s Options:\n",
930 mBdsLoadOptionName
[LoadOptionType
]
932 LoadOptions
= EfiBootManagerGetLoadOptions (&LoadOptionCount
, LoadOptionType
);
933 for (Index
= 0; Index
< LoadOptionCount
; Index
++) {
935 EFI_D_INFO
, " %s%04x: %s \t\t 0x%04x\n",
936 mBdsLoadOptionName
[LoadOptionType
],
937 LoadOptions
[Index
].OptionNumber
,
938 LoadOptions
[Index
].Description
,
939 LoadOptions
[Index
].Attributes
942 EfiBootManagerFreeLoadOptions (LoadOptions
, LoadOptionCount
);
944 DEBUG ((EFI_D_INFO
, "[Bds]=============End Load Options Dumping=============\n"));
948 // BootManagerMenu doesn't contain the correct information when return status is EFI_NOT_FOUND.
950 BootManagerMenuStatus
= EfiBootManagerGetBootManagerMenu (&BootManagerMenu
);
952 BootFwUi
= (BOOLEAN
) ((OsIndication
& EFI_OS_INDICATIONS_BOOT_TO_FW_UI
) != 0);
953 PlatformRecovery
= (BOOLEAN
) ((OsIndication
& EFI_OS_INDICATIONS_START_PLATFORM_RECOVERY
) != 0);
955 // Clear EFI_OS_INDICATIONS_BOOT_TO_FW_UI to acknowledge OS
957 if (BootFwUi
|| PlatformRecovery
) {
958 OsIndication
&= ~((UINT64
) (EFI_OS_INDICATIONS_BOOT_TO_FW_UI
| EFI_OS_INDICATIONS_START_PLATFORM_RECOVERY
));
959 Status
= gRT
->SetVariable (
960 EFI_OS_INDICATIONS_VARIABLE_NAME
,
961 &gEfiGlobalVariableGuid
,
962 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
967 // Changing the content without increasing its size with current variable implementation shouldn't fail.
969 ASSERT_EFI_ERROR (Status
);
973 // Launch Boot Manager Menu directly when EFI_OS_INDICATIONS_BOOT_TO_FW_UI is set. Skip HotkeyBoot
975 if (BootFwUi
&& (BootManagerMenuStatus
!= EFI_NOT_FOUND
)) {
977 // Follow generic rule, Call BdsDxeOnConnectConInCallBack to connect ConIn before enter UI
979 if (PcdGetBool (PcdConInConnectOnDemand
)) {
980 BdsDxeOnConnectConInCallBack (NULL
, NULL
);
984 // Directly enter the setup page.
986 EfiBootManagerBoot (&BootManagerMenu
);
989 if (!PlatformRecovery
) {
991 // Execute SysPrep####
993 LoadOptions
= EfiBootManagerGetLoadOptions (&LoadOptionCount
, LoadOptionTypeSysPrep
);
994 ProcessLoadOptions (LoadOptions
, LoadOptionCount
);
995 EfiBootManagerFreeLoadOptions (LoadOptions
, LoadOptionCount
);
1000 PERF_INMODULE_BEGIN ("BdsWait");
1001 BdsWait (HotkeyTriggered
);
1002 PERF_INMODULE_END ("BdsWait");
1004 // BdsReadKeys() can be removed after all keyboard drivers invoke callback in timer callback.
1008 EfiBootManagerHotkeyBoot ();
1010 if (BootNext
!= NULL
) {
1012 // Delete "BootNext" NV variable before transferring control to it to prevent loops.
1014 Status
= gRT
->SetVariable (
1015 EFI_BOOT_NEXT_VARIABLE_NAME
,
1016 &gEfiGlobalVariableGuid
,
1022 // Deleting NV variable shouldn't fail unless it doesn't exist.
1024 ASSERT (Status
== EFI_SUCCESS
|| Status
== EFI_NOT_FOUND
);
1027 // Boot to "BootNext"
1029 UnicodeSPrint (BootNextVariableName
, sizeof (BootNextVariableName
), L
"Boot%04x", *BootNext
);
1030 Status
= EfiBootManagerVariableToLoadOption (BootNextVariableName
, &LoadOption
);
1031 if (!EFI_ERROR (Status
)) {
1032 EfiBootManagerBoot (&LoadOption
);
1033 EfiBootManagerFreeLoadOption (&LoadOption
);
1034 if ((LoadOption
.Status
== EFI_SUCCESS
) &&
1035 (BootManagerMenuStatus
!= EFI_NOT_FOUND
) &&
1036 (LoadOption
.OptionNumber
!= BootManagerMenu
.OptionNumber
)) {
1038 // Boot to Boot Manager Menu upon EFI_SUCCESS
1039 // Exception: Do not boot again when the BootNext points to Boot Manager Menu.
1041 EfiBootManagerBoot (&BootManagerMenu
);
1048 // Retry to boot if any of the boot succeeds
1050 LoadOptions
= EfiBootManagerGetLoadOptions (&LoadOptionCount
, LoadOptionTypeBoot
);
1051 BootSuccess
= BootBootOptions (LoadOptions
, LoadOptionCount
, (BootManagerMenuStatus
!= EFI_NOT_FOUND
) ? &BootManagerMenu
: NULL
);
1052 EfiBootManagerFreeLoadOptions (LoadOptions
, LoadOptionCount
);
1053 } while (BootSuccess
);
1056 if (BootManagerMenuStatus
!= EFI_NOT_FOUND
) {
1057 EfiBootManagerFreeLoadOption (&BootManagerMenu
);
1061 if (PlatformRecovery
) {
1062 LoadOptions
= EfiBootManagerGetLoadOptions (&LoadOptionCount
, LoadOptionTypePlatformRecovery
);
1063 ProcessLoadOptions (LoadOptions
, LoadOptionCount
);
1064 EfiBootManagerFreeLoadOptions (LoadOptions
, LoadOptionCount
);
1067 // When platform recovery is not enabled, still boot to platform default file path.
1069 EfiBootManagerProcessLoadOption (&PlatformDefaultBootOption
);
1072 EfiBootManagerFreeLoadOption (&PlatformDefaultBootOption
);
1074 DEBUG ((EFI_D_ERROR
, "[Bds] Unable to boot!\n"));
1075 PlatformBootManagerUnableToBoot ();
1080 Set the variable and report the error through status code upon failure.
1082 @param VariableName A Null-terminated string that is the name of the vendor's variable.
1083 Each VariableName is unique for each VendorGuid. VariableName must
1084 contain 1 or more characters. If VariableName is an empty string,
1085 then EFI_INVALID_PARAMETER is returned.
1086 @param VendorGuid A unique identifier for the vendor.
1087 @param Attributes Attributes bitmask to set for the variable.
1088 @param DataSize The size in bytes of the Data buffer. Unless the EFI_VARIABLE_APPEND_WRITE,
1089 or EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS attribute is set, a size of zero
1090 causes the variable to be deleted. When the EFI_VARIABLE_APPEND_WRITE attribute is
1091 set, then a SetVariable() call with a DataSize of zero will not cause any change to
1092 the variable value (the timestamp associated with the variable may be updated however
1093 even if no new data value is provided,see the description of the
1094 EFI_VARIABLE_AUTHENTICATION_2 descriptor below. In this case the DataSize will not
1095 be zero since the EFI_VARIABLE_AUTHENTICATION_2 descriptor will be populated).
1096 @param Data The contents for the variable.
1098 @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as
1099 defined by the Attributes.
1100 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits, name, and GUID was supplied, or the
1101 DataSize exceeds the maximum allowed.
1102 @retval EFI_INVALID_PARAMETER VariableName is an empty string.
1103 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
1104 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
1105 @retval EFI_WRITE_PROTECTED The variable in question is read-only.
1106 @retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.
1107 @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACESS
1108 being set, but the AuthInfo does NOT pass the validation check carried out by the firmware.
1110 @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.
1113 BdsDxeSetVariableAndReportStatusCodeOnError (
1114 IN CHAR16
*VariableName
,
1115 IN EFI_GUID
*VendorGuid
,
1116 IN UINT32 Attributes
,
1122 EDKII_SET_VARIABLE_STATUS
*SetVariableStatus
;
1125 Status
= gRT
->SetVariable (
1132 if (EFI_ERROR (Status
)) {
1133 NameSize
= StrSize (VariableName
);
1134 SetVariableStatus
= AllocatePool (sizeof (EDKII_SET_VARIABLE_STATUS
) + NameSize
+ DataSize
);
1135 if (SetVariableStatus
!= NULL
) {
1136 CopyGuid (&SetVariableStatus
->Guid
, VendorGuid
);
1137 SetVariableStatus
->NameSize
= NameSize
;
1138 SetVariableStatus
->DataSize
= DataSize
;
1139 SetVariableStatus
->SetStatus
= Status
;
1140 SetVariableStatus
->Attributes
= Attributes
;
1141 CopyMem (SetVariableStatus
+ 1, VariableName
, NameSize
);
1142 CopyMem (((UINT8
*) (SetVariableStatus
+ 1)) + NameSize
, Data
, DataSize
);
1144 REPORT_STATUS_CODE_EX (
1146 PcdGet32 (PcdErrorCodeSetVariable
),
1149 &gEdkiiStatusCodeDataTypeVariableGuid
,
1151 sizeof (EDKII_SET_VARIABLE_STATUS
) + NameSize
+ DataSize
1154 FreePool (SetVariableStatus
);