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 - 2017, 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 This program and the accompanying materials
12 are licensed and made available under the terms and conditions of the BSD License
13 which accompanies this distribution. The full text of the license may be found at
14 http://opensource.org/licenses/bsd-license.php
16 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
17 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
23 #include "HwErrRecSupport.h"
25 #define SET_BOOT_OPTION_SUPPORT_KEY_COUNT(a, c) { \
26 (a) = ((a) & ~EFI_BOOT_OPTION_SUPPORT_COUNT) | (((c) << LowBitSet32 (EFI_BOOT_OPTION_SUPPORT_COUNT)) & EFI_BOOT_OPTION_SUPPORT_COUNT); \
30 /// BDS arch protocol instance initial value.
32 EFI_BDS_ARCH_PROTOCOL gBds
= {
37 // gConnectConInEvent - Event which is signaled when ConIn connection is required
39 EFI_EVENT gConnectConInEvent
= NULL
;
42 /// The read-only variables defined in UEFI Spec.
44 CHAR16
*mReadOnlyVariables
[] = {
45 EFI_PLATFORM_LANG_CODES_VARIABLE_NAME
,
46 EFI_LANG_CODES_VARIABLE_NAME
,
47 EFI_BOOT_OPTION_SUPPORT_VARIABLE_NAME
,
48 EFI_HW_ERR_REC_SUPPORT_VARIABLE_NAME
,
49 EFI_OS_INDICATIONS_SUPPORT_VARIABLE_NAME
52 CHAR16
*mBdsLoadOptionName
[] = {
60 Event to Connect ConIn.
62 @param Event Event whose notification function is being invoked.
63 @param Context Pointer to the notification function's context,
64 which is implementation-dependent.
69 BdsDxeOnConnectConInCallBack (
77 // When Osloader call ReadKeyStroke to signal this event
78 // no driver dependency is assumed existing. So use a non-dispatch version
80 Status
= EfiBootManagerConnectConsoleVariable (ConIn
);
81 if (EFI_ERROR (Status
)) {
83 // Should not enter this case, if enter, the keyboard will not work.
84 // May need platfrom policy to connect keyboard.
86 DEBUG ((EFI_D_WARN
, "[Bds] Connect ConIn failed - %r!!!\n", Status
));
90 Notify function for event group EFI_EVENT_GROUP_READY_TO_BOOT. This is used to
91 check whether there is remaining deferred load images.
93 @param[in] Event The Event that is being processed.
94 @param[in] Context The Event Context.
99 CheckDeferredLoadImageOnReadyToBoot (
105 EFI_DEFERRED_IMAGE_LOAD_PROTOCOL
*DeferredImage
;
110 EFI_DEVICE_PATH_PROTOCOL
*ImageDevicePath
;
114 CHAR16
*DevicePathStr
;
117 // Find all the deferred image load protocols.
121 Status
= gBS
->LocateHandleBuffer (
123 &gEfiDeferredImageLoadProtocolGuid
,
128 if (EFI_ERROR (Status
)) {
132 for (Index
= 0; Index
< HandleCount
; Index
++) {
133 Status
= gBS
->HandleProtocol (Handles
[Index
], &gEfiDeferredImageLoadProtocolGuid
, (VOID
**) &DeferredImage
);
134 if (EFI_ERROR (Status
)) {
138 for (ImageIndex
= 0; ; ImageIndex
++) {
140 // Load all the deferred images in this protocol instance.
142 Status
= DeferredImage
->GetImageInfo (
150 if (EFI_ERROR (Status
)) {
153 DevicePathStr
= ConvertDevicePathToText (ImageDevicePath
, FALSE
, FALSE
);
154 DEBUG ((DEBUG_LOAD
, "[Bds] Image was deferred but not loaded: %s.\n", DevicePathStr
));
155 if (DevicePathStr
!= NULL
) {
156 FreePool (DevicePathStr
);
160 if (Handles
!= NULL
) {
167 Install Boot Device Selection Protocol
169 @param ImageHandle The image handle.
170 @param SystemTable The system table.
172 @retval EFI_SUCEESS BDS has finished initializing.
173 Return the dispatcher and recall BDS.Entry
174 @retval Other Return status from AllocatePool() or gBS->InstallProtocolInterface
180 IN EFI_HANDLE ImageHandle
,
181 IN EFI_SYSTEM_TABLE
*SystemTable
187 // Install protocol interface
190 Status
= gBS
->InstallMultipleProtocolInterfaces (
192 &gEfiBdsArchProtocolGuid
, &gBds
,
195 ASSERT_EFI_ERROR (Status
);
200 // Register notify function to check deferred images on ReadyToBoot Event.
202 Status
= gBS
->CreateEventEx (
205 CheckDeferredLoadImageOnReadyToBoot
,
207 &gEfiEventReadyToBootGuid
,
210 ASSERT_EFI_ERROR (Status
);
216 Function waits for a given event to fire, or for an optional timeout to expire.
218 @param Event The event to wait for
219 @param Timeout An optional timeout value in 100 ns units.
221 @retval EFI_SUCCESS Event fired before Timeout expired.
222 @retval EFI_TIME_OUT Timout expired before Event fired..
226 BdsWaitForSingleEvent (
228 IN UINT64 Timeout OPTIONAL
233 EFI_EVENT TimerEvent
;
234 EFI_EVENT WaitList
[2];
238 // Create a timer event
240 Status
= gBS
->CreateEvent (EVT_TIMER
, 0, NULL
, NULL
, &TimerEvent
);
241 if (!EFI_ERROR (Status
)) {
243 // Set the timer event
252 // Wait for the original event or the timer
255 WaitList
[1] = TimerEvent
;
256 Status
= gBS
->WaitForEvent (2, WaitList
, &Index
);
257 ASSERT_EFI_ERROR (Status
);
258 gBS
->CloseEvent (TimerEvent
);
261 // If the timer expired, change the return to timed out
264 Status
= EFI_TIMEOUT
;
269 // No timeout... just wait on the event
271 Status
= gBS
->WaitForEvent (1, &Event
, &Index
);
272 ASSERT (!EFI_ERROR (Status
));
280 The function reads user inputs.
291 if (PcdGetBool (PcdConInConnectOnDemand
)) {
295 while (gST
->ConIn
!= NULL
) {
297 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
299 if (EFI_ERROR (Status
)) {
309 The function waits for the boot manager timeout expires or hotkey is pressed.
311 It calls PlatformBootManagerWaitCallback each second.
313 @param HotkeyTriggered Input hotkey event.
317 IN EFI_EVENT HotkeyTriggered
321 UINT16 TimeoutRemain
;
323 DEBUG ((EFI_D_INFO
, "[Bds]BdsWait ...Zzzzzzzzzzzz...\n"));
325 TimeoutRemain
= PcdGet16 (PcdPlatformBootTimeOut
);
326 while (TimeoutRemain
!= 0) {
327 DEBUG ((EFI_D_INFO
, "[Bds]BdsWait(%d)..Zzzz...\n", (UINTN
) TimeoutRemain
));
328 PlatformBootManagerWaitCallback (TimeoutRemain
);
330 BdsReadKeys (); // BUGBUG: Only reading can signal HotkeyTriggered
331 // Can be removed after all keyboard drivers invoke callback in timer callback.
333 if (HotkeyTriggered
!= NULL
) {
334 Status
= BdsWaitForSingleEvent (HotkeyTriggered
, EFI_TIMER_PERIOD_SECONDS (1));
335 if (!EFI_ERROR (Status
)) {
339 gBS
->Stall (1000000);
343 // 0xffff means waiting forever
344 // BDS with no hotkey provided and 0xffff as timeout will "hang" in the loop
346 if (TimeoutRemain
!= 0xffff) {
350 DEBUG ((EFI_D_INFO
, "[Bds]Exit the waiting!\n"));
354 Attempt to boot each boot option in the BootOptions array.
356 @param BootOptions Input boot option array.
357 @param BootOptionCount Input boot option count.
358 @param BootManagerMenu Input boot manager menu.
360 @retval TRUE Successfully boot one of the boot options.
361 @retval FALSE Failed boot any of the boot options.
365 IN EFI_BOOT_MANAGER_LOAD_OPTION
*BootOptions
,
366 IN UINTN BootOptionCount
,
367 IN EFI_BOOT_MANAGER_LOAD_OPTION
*BootManagerMenu OPTIONAL
373 // Report Status Code to indicate BDS starts attempting booting from the UEFI BootOrder list.
375 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_SW_DXE_BS_PC_ATTEMPT_BOOT_ORDER_EVENT
));
378 // Attempt boot each boot option
380 for (Index
= 0; Index
< BootOptionCount
; Index
++) {
382 // According to EFI Specification, if a load option is not marked
383 // as LOAD_OPTION_ACTIVE, the boot manager will not automatically
386 if ((BootOptions
[Index
].Attributes
& LOAD_OPTION_ACTIVE
) == 0) {
391 // Boot#### load options with LOAD_OPTION_CATEGORY_APP are executables which are not
392 // part of the normal boot processing. Boot options with reserved category values will be
393 // ignored by the boot manager.
395 if ((BootOptions
[Index
].Attributes
& LOAD_OPTION_CATEGORY
) != LOAD_OPTION_CATEGORY_BOOT
) {
400 // All the driver options should have been processed since
401 // now boot will be performed.
403 EfiBootManagerBoot (&BootOptions
[Index
]);
406 // If the boot via Boot#### returns with a status of EFI_SUCCESS, platform firmware
407 // supports boot manager menu, and if firmware is configured to boot in an
408 // interactive mode, the boot manager will stop processing the BootOrder variable and
409 // present a boot manager menu to the user.
411 if ((BootManagerMenu
!= NULL
) && (BootOptions
[Index
].Status
== EFI_SUCCESS
)) {
412 EfiBootManagerBoot (BootManagerMenu
);
417 return (BOOLEAN
) (Index
< BootOptionCount
);
421 The function will load and start every Driver####, SysPrep#### or PlatformRecovery####.
423 @param LoadOptions Load option array.
424 @param LoadOptionCount Load option count.
428 IN EFI_BOOT_MANAGER_LOAD_OPTION
*LoadOptions
,
429 IN UINTN LoadOptionCount
434 BOOLEAN ReconnectAll
;
435 EFI_BOOT_MANAGER_LOAD_OPTION_TYPE LoadOptionType
;
437 ReconnectAll
= FALSE
;
438 LoadOptionType
= LoadOptionTypeMax
;
441 // Process the driver option
443 for (Index
= 0; Index
< LoadOptionCount
; Index
++) {
445 // All the load options in the array should be of the same type.
448 LoadOptionType
= LoadOptions
[Index
].OptionType
;
450 ASSERT (LoadOptionType
== LoadOptions
[Index
].OptionType
);
451 ASSERT (LoadOptionType
!= LoadOptionTypeBoot
);
453 Status
= EfiBootManagerProcessLoadOption (&LoadOptions
[Index
]);
456 // Status indicates whether the load option is loaded and executed
457 // LoadOptions[Index].Status is what the load option returns
459 if (!EFI_ERROR (Status
)) {
461 // Stop processing if any PlatformRecovery#### returns success.
463 if ((LoadOptions
[Index
].Status
== EFI_SUCCESS
) &&
464 (LoadOptionType
== LoadOptionTypePlatformRecovery
)) {
469 // Only set ReconnectAll flag when the load option executes successfully.
471 if (!EFI_ERROR (LoadOptions
[Index
].Status
) &&
472 (LoadOptions
[Index
].Attributes
& LOAD_OPTION_FORCE_RECONNECT
) != 0) {
479 // If a driver load option is marked as LOAD_OPTION_FORCE_RECONNECT,
480 // then all of the EFI drivers in the system will be disconnected and
481 // reconnected after the last driver load option is processed.
483 if (ReconnectAll
&& LoadOptionType
== LoadOptionTypeDriver
) {
484 EfiBootManagerDisconnectAll ();
485 EfiBootManagerConnectAll ();
491 Validate input console variable data.
493 If found the device path is not a valid device path, remove the variable.
495 @param VariableName Input console variable name.
499 BdsFormalizeConsoleVariable (
500 IN CHAR16
*VariableName
503 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
507 GetEfiGlobalVariable2 (VariableName
, (VOID
**) &DevicePath
, &VariableSize
);
508 if ((DevicePath
!= NULL
) && !IsDevicePathValid (DevicePath
, VariableSize
)) {
509 Status
= gRT
->SetVariable (
511 &gEfiGlobalVariableGuid
,
512 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
517 // Deleting variable with current variable implementation shouldn't fail.
519 ASSERT_EFI_ERROR (Status
);
522 if (DevicePath
!= NULL
) {
523 FreePool (DevicePath
);
528 Formalize OsIndication related variables.
530 For OsIndicationsSupported, Create a BS/RT/UINT64 variable to report caps
531 Delete OsIndications variable if it is not NV/BS/RT UINT64.
533 Item 3 is used to solve case when OS corrupts OsIndications. Here simply delete this NV variable.
535 Create a boot option for BootManagerMenu if it hasn't been created yet
539 BdsFormalizeOSIndicationVariable (
544 UINT64 OsIndicationSupport
;
548 EFI_BOOT_MANAGER_LOAD_OPTION BootManagerMenu
;
551 // OS indicater support variable
553 Status
= EfiBootManagerGetBootManagerMenu (&BootManagerMenu
);
554 if (Status
!= EFI_NOT_FOUND
) {
555 OsIndicationSupport
= EFI_OS_INDICATIONS_BOOT_TO_FW_UI
| EFI_OS_INDICATIONS_START_PLATFORM_RECOVERY
;
556 EfiBootManagerFreeLoadOption (&BootManagerMenu
);
558 OsIndicationSupport
= EFI_OS_INDICATIONS_START_PLATFORM_RECOVERY
;
561 Status
= gRT
->SetVariable (
562 EFI_OS_INDICATIONS_SUPPORT_VARIABLE_NAME
,
563 &gEfiGlobalVariableGuid
,
564 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
569 // Platform needs to make sure setting volatile variable before calling 3rd party code shouldn't fail.
571 ASSERT_EFI_ERROR (Status
);
574 // If OsIndications is invalid, remove it.
576 // 1. Data size != UINT64
577 // 2. OsIndication value inconsistence
578 // 3. OsIndication attribute inconsistence
582 DataSize
= sizeof(UINT64
);
583 Status
= gRT
->GetVariable (
584 EFI_OS_INDICATIONS_VARIABLE_NAME
,
585 &gEfiGlobalVariableGuid
,
590 if (Status
== EFI_NOT_FOUND
) {
594 if ((DataSize
!= sizeof (OsIndication
)) ||
595 ((OsIndication
& ~OsIndicationSupport
) != 0) ||
596 (Attributes
!= (EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
))
599 DEBUG ((EFI_D_ERROR
, "[Bds] Unformalized OsIndications variable exists. Delete it\n"));
600 Status
= gRT
->SetVariable (
601 EFI_OS_INDICATIONS_VARIABLE_NAME
,
602 &gEfiGlobalVariableGuid
,
608 // Deleting variable with current variable implementation shouldn't fail.
610 ASSERT_EFI_ERROR(Status
);
620 BdsFormalizeEfiGlobalVariable (
625 // Validate Console variable.
627 BdsFormalizeConsoleVariable (EFI_CON_IN_VARIABLE_NAME
);
628 BdsFormalizeConsoleVariable (EFI_CON_OUT_VARIABLE_NAME
);
629 BdsFormalizeConsoleVariable (EFI_ERR_OUT_VARIABLE_NAME
);
632 // Validate OSIndication related variable.
634 BdsFormalizeOSIndicationVariable ();
639 Allocate a block of memory that will contain performance data to OS.
643 BdsAllocateMemoryForPerformanceData (
648 EFI_PHYSICAL_ADDRESS AcpiLowMemoryBase
;
649 EDKII_VARIABLE_LOCK_PROTOCOL
*VariableLock
;
651 AcpiLowMemoryBase
= 0x0FFFFFFFFULL
;
654 // Allocate a block of memory that will contain performance data to OS.
656 Status
= gBS
->AllocatePages (
658 EfiReservedMemoryType
,
659 EFI_SIZE_TO_PAGES (PERF_DATA_MAX_LENGTH
),
662 if (!EFI_ERROR (Status
)) {
664 // Save the pointer to variable for use in S3 resume.
666 Status
= BdsDxeSetVariableAndReportStatusCodeOnError (
668 &gPerformanceProtocolGuid
,
669 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
670 sizeof (EFI_PHYSICAL_ADDRESS
),
673 if (EFI_ERROR (Status
)) {
674 DEBUG ((EFI_D_ERROR
, "[Bds] PerfDataMemAddr (%08x) cannot be saved to NV storage.\n", AcpiLowMemoryBase
));
677 // Mark L"PerfDataMemAddr" variable to read-only if the Variable Lock protocol exists
678 // Still lock it even the variable cannot be saved to prevent it's set by 3rd party code.
680 Status
= gBS
->LocateProtocol (&gEdkiiVariableLockProtocolGuid
, NULL
, (VOID
**) &VariableLock
);
681 if (!EFI_ERROR (Status
)) {
682 Status
= VariableLock
->RequestToLock (VariableLock
, L
"PerfDataMemAddr", &gPerformanceProtocolGuid
);
683 ASSERT_EFI_ERROR (Status
);
689 Enter an infinite loop of calling the Boot Manager Menu.
691 This is a last resort alternative to BdsEntry() giving up for good. This
692 function never returns.
694 @param[in] BootManagerMenu The EFI_BOOT_MANAGER_LOAD_OPTION located and/or
695 created by the EfiBootManagerGetBootManagerMenu()
699 BdsBootManagerMenuLoop (
700 IN EFI_BOOT_MANAGER_LOAD_OPTION
*BootManagerMenu
706 // Normally BdsDxe does not print anything to the system console, but this is
707 // a last resort -- the end-user will likely not see any DEBUG messages
708 // logged in this situation.
710 // AsciiPrint() will NULL-check gST->ConOut internally. We check gST->ConIn
711 // here to see if it makes sense to request and wait for a keypress.
713 if (gST
->ConIn
!= NULL
) {
715 "%a: No bootable option or device was found.\n"
716 "%a: Press any key to enter the Boot Manager Menu.\n",
720 BdsWaitForSingleEvent (gST
->ConIn
->WaitForKey
, 0);
723 // Drain any queued keys.
725 while (!EFI_ERROR (gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
))) {
727 // just throw away Key
733 EfiBootManagerBoot (BootManagerMenu
);
739 Service routine for BdsInstance->Entry(). Devices are connected, the
740 consoles are initialized, and the boot options are tried.
742 @param This Protocol Instance structure.
748 IN EFI_BDS_ARCH_PROTOCOL
*This
751 EFI_BOOT_MANAGER_LOAD_OPTION
*LoadOptions
;
752 UINTN LoadOptionCount
;
753 CHAR16
*FirmwareVendor
;
754 EFI_EVENT HotkeyTriggered
;
758 UINT32 BootOptionSupport
;
760 EDKII_VARIABLE_LOCK_PROTOCOL
*VariableLock
;
762 EFI_BOOT_MANAGER_LOAD_OPTION LoadOption
;
764 CHAR16 BootNextVariableName
[sizeof ("Boot####")];
765 EFI_BOOT_MANAGER_LOAD_OPTION BootManagerMenu
;
767 BOOLEAN PlatformRecovery
;
769 EFI_DEVICE_PATH_PROTOCOL
*FilePath
;
770 EFI_STATUS BootManagerMenuStatus
;
772 HotkeyTriggered
= NULL
;
773 Status
= EFI_SUCCESS
;
777 // Insert the performance probe
779 PERF_END (NULL
, "DXE", NULL
, 0);
780 PERF_START (NULL
, "BDS", NULL
, 0);
781 DEBUG ((EFI_D_INFO
, "[Bds] Entry...\n"));
784 BdsAllocateMemoryForPerformanceData ();
788 // Fill in FirmwareVendor and FirmwareRevision from PCDs
790 FirmwareVendor
= (CHAR16
*) PcdGetPtr (PcdFirmwareVendor
);
791 gST
->FirmwareVendor
= AllocateRuntimeCopyPool (StrSize (FirmwareVendor
), FirmwareVendor
);
792 ASSERT (gST
->FirmwareVendor
!= NULL
);
793 gST
->FirmwareRevision
= PcdGet32 (PcdFirmwareRevision
);
796 // Fixup Tasble CRC after we updated Firmware Vendor and Revision
799 gBS
->CalculateCrc32 ((VOID
*) gST
, sizeof (EFI_SYSTEM_TABLE
), &gST
->Hdr
.CRC32
);
802 // Validate Variable.
804 BdsFormalizeEfiGlobalVariable ();
807 // Mark the read-only variables if the Variable Lock protocol exists
809 Status
= gBS
->LocateProtocol (&gEdkiiVariableLockProtocolGuid
, NULL
, (VOID
**) &VariableLock
);
810 DEBUG ((EFI_D_INFO
, "[BdsDxe] Locate Variable Lock protocol - %r\n", Status
));
811 if (!EFI_ERROR (Status
)) {
812 for (Index
= 0; Index
< ARRAY_SIZE (mReadOnlyVariables
); Index
++) {
813 Status
= VariableLock
->RequestToLock (VariableLock
, mReadOnlyVariables
[Index
], &gEfiGlobalVariableGuid
);
814 ASSERT_EFI_ERROR (Status
);
818 InitializeHwErrRecSupport ();
821 // Initialize L"Timeout" EFI global variable.
823 BootTimeOut
= PcdGet16 (PcdPlatformBootTimeOut
);
824 if (BootTimeOut
!= 0xFFFF) {
826 // If time out value equal 0xFFFF, no need set to 0xFFFF to variable area because UEFI specification
827 // define same behavior between no value or 0xFFFF value for L"Timeout".
829 BdsDxeSetVariableAndReportStatusCodeOnError (
830 EFI_TIME_OUT_VARIABLE_NAME
,
831 &gEfiGlobalVariableGuid
,
832 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
839 // Initialize L"BootOptionSupport" EFI global variable.
840 // Lazy-ConIn implictly disables BDS hotkey.
842 BootOptionSupport
= EFI_BOOT_OPTION_SUPPORT_APP
| EFI_BOOT_OPTION_SUPPORT_SYSPREP
;
843 if (!PcdGetBool (PcdConInConnectOnDemand
)) {
844 BootOptionSupport
|= EFI_BOOT_OPTION_SUPPORT_KEY
;
845 SET_BOOT_OPTION_SUPPORT_KEY_COUNT (BootOptionSupport
, 3);
847 Status
= gRT
->SetVariable (
848 EFI_BOOT_OPTION_SUPPORT_VARIABLE_NAME
,
849 &gEfiGlobalVariableGuid
,
850 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
851 sizeof (BootOptionSupport
),
855 // Platform needs to make sure setting volatile variable before calling 3rd party code shouldn't fail.
857 ASSERT_EFI_ERROR (Status
);
860 // Cache the "BootNext" NV variable before calling any PlatformBootManagerLib APIs
861 // This could avoid the "BootNext" set by PlatformBootManagerLib be consumed in this boot.
863 GetEfiGlobalVariable2 (EFI_BOOT_NEXT_VARIABLE_NAME
, (VOID
**) &BootNext
, &DataSize
);
864 if (DataSize
!= sizeof (UINT16
)) {
865 if (BootNext
!= NULL
) {
872 // Initialize the platform language variables
874 InitializeLanguage (TRUE
);
877 // System firmware must include a PlatformRecovery#### variable specifying
878 // a short-form File Path Media Device Path containing the platform default
879 // file path for removable media
881 FilePath
= FileDevicePath (NULL
, EFI_REMOVABLE_MEDIA_FILE_NAME
);
882 Status
= EfiBootManagerInitializeLoadOption (
884 LoadOptionNumberUnassigned
,
885 LoadOptionTypePlatformRecovery
,
887 L
"Default PlatformRecovery",
892 ASSERT_EFI_ERROR (Status
);
893 LoadOptions
= EfiBootManagerGetLoadOptions (&LoadOptionCount
, LoadOptionTypePlatformRecovery
);
894 if (EfiBootManagerFindLoadOption (&LoadOption
, LoadOptions
, LoadOptionCount
) == -1) {
895 for (Index
= 0; Index
< LoadOptionCount
; Index
++) {
897 // The PlatformRecovery#### options are sorted by OptionNumber.
898 // Find the the smallest unused number as the new OptionNumber.
900 if (LoadOptions
[Index
].OptionNumber
!= Index
) {
904 LoadOption
.OptionNumber
= Index
;
905 Status
= EfiBootManagerLoadOptionToVariable (&LoadOption
);
906 ASSERT_EFI_ERROR (Status
);
908 EfiBootManagerFreeLoadOption (&LoadOption
);
910 EfiBootManagerFreeLoadOptions (LoadOptions
, LoadOptionCount
);
913 // Report Status Code to indicate connecting drivers will happen
917 (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_SW_DXE_BS_PC_BEGIN_CONNECTING_DRIVERS
)
921 // Initialize ConnectConIn event before calling platform code.
923 if (PcdGetBool (PcdConInConnectOnDemand
)) {
924 Status
= gBS
->CreateEventEx (
927 BdsDxeOnConnectConInCallBack
,
929 &gConnectConInEventGuid
,
932 if (EFI_ERROR (Status
)) {
933 gConnectConInEvent
= NULL
;
938 // Do the platform init, can be customized by OEM/IBV
939 // Possible things that can be done in PlatformBootManagerBeforeConsole:
940 // > Update console variable: 1. include hot-plug devices; 2. Clear ConIn and add SOL for AMT
941 // > Register new Driver#### or Boot####
942 // > Register new Key####: e.g.: F12
943 // > Signal ReadyToLock event
944 // > Authentication action: 1. connect Auth devices; 2. Identify auto logon user.
946 PERF_START (NULL
, "PlatformBootManagerBeforeConsole", "BDS", 0);
947 PlatformBootManagerBeforeConsole ();
948 PERF_END (NULL
, "PlatformBootManagerBeforeConsole", "BDS", 0);
951 // Initialize hotkey service
953 EfiBootManagerStartHotkeyService (&HotkeyTriggered
);
956 // Execute Driver Options
958 LoadOptions
= EfiBootManagerGetLoadOptions (&LoadOptionCount
, LoadOptionTypeDriver
);
959 ProcessLoadOptions (LoadOptions
, LoadOptionCount
);
960 EfiBootManagerFreeLoadOptions (LoadOptions
, LoadOptionCount
);
965 PERF_START (NULL
, "EfiBootManagerConnectAllDefaultConsoles", "BDS", 0);
966 if (PcdGetBool (PcdConInConnectOnDemand
)) {
967 EfiBootManagerConnectConsoleVariable (ConOut
);
968 EfiBootManagerConnectConsoleVariable (ErrOut
);
970 // Do not connect ConIn devices when lazy ConIn feature is ON.
973 EfiBootManagerConnectAllDefaultConsoles ();
975 PERF_END (NULL
, "EfiBootManagerConnectAllDefaultConsoles", "BDS", 0);
978 // Do the platform specific action after the console is ready
979 // Possible things that can be done in PlatformBootManagerAfterConsole:
980 // > Console post action:
981 // > Dynamically switch output mode from 100x31 to 80x25 for certain senarino
982 // > Signal console ready platform customized event
983 // > Run diagnostics like memory testing
984 // > Connect certain devices
985 // > Dispatch aditional option roms
986 // > Special boot: e.g.: USB boot, enter UI
988 PERF_START (NULL
, "PlatformBootManagerAfterConsole", "BDS", 0);
989 PlatformBootManagerAfterConsole ();
990 PERF_END (NULL
, "PlatformBootManagerAfterConsole", "BDS", 0);
992 // Boot to Boot Manager Menu when EFI_OS_INDICATIONS_BOOT_TO_FW_UI is set. Skip HotkeyBoot
994 DataSize
= sizeof (UINT64
);
995 Status
= gRT
->GetVariable (
996 EFI_OS_INDICATIONS_VARIABLE_NAME
,
997 &gEfiGlobalVariableGuid
,
1002 if (EFI_ERROR (Status
)) {
1007 EFI_BOOT_MANAGER_LOAD_OPTION_TYPE LoadOptionType
;
1008 DEBUG ((EFI_D_INFO
, "[Bds]OsIndication: %016x\n", OsIndication
));
1009 DEBUG ((EFI_D_INFO
, "[Bds]=============Begin Load Options Dumping ...=============\n"));
1010 for (LoadOptionType
= 0; LoadOptionType
< LoadOptionTypeMax
; LoadOptionType
++) {
1012 EFI_D_INFO
, " %s Options:\n",
1013 mBdsLoadOptionName
[LoadOptionType
]
1015 LoadOptions
= EfiBootManagerGetLoadOptions (&LoadOptionCount
, LoadOptionType
);
1016 for (Index
= 0; Index
< LoadOptionCount
; Index
++) {
1018 EFI_D_INFO
, " %s%04x: %s \t\t 0x%04x\n",
1019 mBdsLoadOptionName
[LoadOptionType
],
1020 LoadOptions
[Index
].OptionNumber
,
1021 LoadOptions
[Index
].Description
,
1022 LoadOptions
[Index
].Attributes
1025 EfiBootManagerFreeLoadOptions (LoadOptions
, LoadOptionCount
);
1027 DEBUG ((EFI_D_INFO
, "[Bds]=============End Load Options Dumping=============\n"));
1031 // BootManagerMenu doesn't contain the correct information when return status is EFI_NOT_FOUND.
1033 BootManagerMenuStatus
= EfiBootManagerGetBootManagerMenu (&BootManagerMenu
);
1035 BootFwUi
= (BOOLEAN
) ((OsIndication
& EFI_OS_INDICATIONS_BOOT_TO_FW_UI
) != 0);
1036 PlatformRecovery
= (BOOLEAN
) ((OsIndication
& EFI_OS_INDICATIONS_START_PLATFORM_RECOVERY
) != 0);
1038 // Clear EFI_OS_INDICATIONS_BOOT_TO_FW_UI to acknowledge OS
1040 if (BootFwUi
|| PlatformRecovery
) {
1041 OsIndication
&= ~((UINT64
) (EFI_OS_INDICATIONS_BOOT_TO_FW_UI
| EFI_OS_INDICATIONS_START_PLATFORM_RECOVERY
));
1042 Status
= gRT
->SetVariable (
1043 EFI_OS_INDICATIONS_VARIABLE_NAME
,
1044 &gEfiGlobalVariableGuid
,
1045 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
1050 // Changing the content without increasing its size with current variable implementation shouldn't fail.
1052 ASSERT_EFI_ERROR (Status
);
1056 // Launch Boot Manager Menu directly when EFI_OS_INDICATIONS_BOOT_TO_FW_UI is set. Skip HotkeyBoot
1058 if (BootFwUi
&& (BootManagerMenuStatus
!= EFI_NOT_FOUND
)) {
1060 // Follow generic rule, Call BdsDxeOnConnectConInCallBack to connect ConIn before enter UI
1062 if (PcdGetBool (PcdConInConnectOnDemand
)) {
1063 BdsDxeOnConnectConInCallBack (NULL
, NULL
);
1067 // Directly enter the setup page.
1069 EfiBootManagerBoot (&BootManagerMenu
);
1072 if (!PlatformRecovery
) {
1074 // Execute SysPrep####
1076 LoadOptions
= EfiBootManagerGetLoadOptions (&LoadOptionCount
, LoadOptionTypeSysPrep
);
1077 ProcessLoadOptions (LoadOptions
, LoadOptionCount
);
1078 EfiBootManagerFreeLoadOptions (LoadOptions
, LoadOptionCount
);
1083 PERF_START (NULL
, "BdsWait", "BDS", 0);
1084 BdsWait (HotkeyTriggered
);
1085 PERF_END (NULL
, "BdsWait", "BDS", 0);
1088 // BdsReadKeys() can be removed after all keyboard drivers invoke callback in timer callback.
1092 EfiBootManagerHotkeyBoot ();
1094 if (BootNext
!= NULL
) {
1096 // Delete "BootNext" NV variable before transferring control to it to prevent loops.
1098 Status
= gRT
->SetVariable (
1099 EFI_BOOT_NEXT_VARIABLE_NAME
,
1100 &gEfiGlobalVariableGuid
,
1106 // Deleting NV variable shouldn't fail unless it doesn't exist.
1108 ASSERT (Status
== EFI_SUCCESS
|| Status
== EFI_NOT_FOUND
);
1111 // Boot to "BootNext"
1113 UnicodeSPrint (BootNextVariableName
, sizeof (BootNextVariableName
), L
"Boot%04x", *BootNext
);
1114 Status
= EfiBootManagerVariableToLoadOption (BootNextVariableName
, &LoadOption
);
1115 if (!EFI_ERROR (Status
)) {
1116 EfiBootManagerBoot (&LoadOption
);
1117 EfiBootManagerFreeLoadOption (&LoadOption
);
1118 if ((LoadOption
.Status
== EFI_SUCCESS
) &&
1119 (BootManagerMenuStatus
!= EFI_NOT_FOUND
) &&
1120 (LoadOption
.OptionNumber
!= BootManagerMenu
.OptionNumber
)) {
1122 // Boot to Boot Manager Menu upon EFI_SUCCESS
1123 // Exception: Do not boot again when the BootNext points to Boot Manager Menu.
1125 EfiBootManagerBoot (&BootManagerMenu
);
1132 // Retry to boot if any of the boot succeeds
1134 LoadOptions
= EfiBootManagerGetLoadOptions (&LoadOptionCount
, LoadOptionTypeBoot
);
1135 BootSuccess
= BootBootOptions (LoadOptions
, LoadOptionCount
, (BootManagerMenuStatus
!= EFI_NOT_FOUND
) ? &BootManagerMenu
: NULL
);
1136 EfiBootManagerFreeLoadOptions (LoadOptions
, LoadOptionCount
);
1137 } while (BootSuccess
);
1141 LoadOptions
= EfiBootManagerGetLoadOptions (&LoadOptionCount
, LoadOptionTypePlatformRecovery
);
1142 ProcessLoadOptions (LoadOptions
, LoadOptionCount
);
1143 EfiBootManagerFreeLoadOptions (LoadOptions
, LoadOptionCount
);
1147 // If BootManagerMenu is available, fall back to it indefinitely.
1149 if (BootManagerMenuStatus
!= EFI_NOT_FOUND
) {
1150 BdsBootManagerMenuLoop (&BootManagerMenu
);
1153 DEBUG ((EFI_D_ERROR
, "[Bds] Unable to boot!\n"));
1158 Set the variable and report the error through status code upon failure.
1160 @param VariableName A Null-terminated string that is the name of the vendor's variable.
1161 Each VariableName is unique for each VendorGuid. VariableName must
1162 contain 1 or more characters. If VariableName is an empty string,
1163 then EFI_INVALID_PARAMETER is returned.
1164 @param VendorGuid A unique identifier for the vendor.
1165 @param Attributes Attributes bitmask to set for the variable.
1166 @param DataSize The size in bytes of the Data buffer. Unless the EFI_VARIABLE_APPEND_WRITE,
1167 or EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS attribute is set, a size of zero
1168 causes the variable to be deleted. When the EFI_VARIABLE_APPEND_WRITE attribute is
1169 set, then a SetVariable() call with a DataSize of zero will not cause any change to
1170 the variable value (the timestamp associated with the variable may be updated however
1171 even if no new data value is provided,see the description of the
1172 EFI_VARIABLE_AUTHENTICATION_2 descriptor below. In this case the DataSize will not
1173 be zero since the EFI_VARIABLE_AUTHENTICATION_2 descriptor will be populated).
1174 @param Data The contents for the variable.
1176 @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as
1177 defined by the Attributes.
1178 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits, name, and GUID was supplied, or the
1179 DataSize exceeds the maximum allowed.
1180 @retval EFI_INVALID_PARAMETER VariableName is an empty string.
1181 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
1182 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
1183 @retval EFI_WRITE_PROTECTED The variable in question is read-only.
1184 @retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.
1185 @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACESS
1186 being set, but the AuthInfo does NOT pass the validation check carried out by the firmware.
1188 @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.
1191 BdsDxeSetVariableAndReportStatusCodeOnError (
1192 IN CHAR16
*VariableName
,
1193 IN EFI_GUID
*VendorGuid
,
1194 IN UINT32 Attributes
,
1200 EDKII_SET_VARIABLE_STATUS
*SetVariableStatus
;
1203 Status
= gRT
->SetVariable (
1210 if (EFI_ERROR (Status
)) {
1211 NameSize
= StrSize (VariableName
);
1212 SetVariableStatus
= AllocatePool (sizeof (EDKII_SET_VARIABLE_STATUS
) + NameSize
+ DataSize
);
1213 if (SetVariableStatus
!= NULL
) {
1214 CopyGuid (&SetVariableStatus
->Guid
, VendorGuid
);
1215 SetVariableStatus
->NameSize
= NameSize
;
1216 SetVariableStatus
->DataSize
= DataSize
;
1217 SetVariableStatus
->SetStatus
= Status
;
1218 SetVariableStatus
->Attributes
= Attributes
;
1219 CopyMem (SetVariableStatus
+ 1, VariableName
, NameSize
);
1220 CopyMem (((UINT8
*) (SetVariableStatus
+ 1)) + NameSize
, Data
, DataSize
);
1222 REPORT_STATUS_CODE_EX (
1224 PcdGet32 (PcdErrorCodeSetVariable
),
1227 &gEdkiiStatusCodeDataTypeVariableGuid
,
1229 sizeof (EDKII_SET_VARIABLE_STATUS
) + NameSize
+ DataSize
1232 FreePool (SetVariableStatus
);