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 - 2016, 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 // Attempt boot each boot option
375 for (Index
= 0; Index
< BootOptionCount
; Index
++) {
377 // According to EFI Specification, if a load option is not marked
378 // as LOAD_OPTION_ACTIVE, the boot manager will not automatically
381 if ((BootOptions
[Index
].Attributes
& LOAD_OPTION_ACTIVE
) == 0) {
386 // Boot#### load options with LOAD_OPTION_CATEGORY_APP are executables which are not
387 // part of the normal boot processing. Boot options with reserved category values will be
388 // ignored by the boot manager.
390 if ((BootOptions
[Index
].Attributes
& LOAD_OPTION_CATEGORY
) != LOAD_OPTION_CATEGORY_BOOT
) {
395 // All the driver options should have been processed since
396 // now boot will be performed.
398 EfiBootManagerBoot (&BootOptions
[Index
]);
401 // If the boot via Boot#### returns with a status of EFI_SUCCESS, platform firmware
402 // supports boot manager menu, and if firmware is configured to boot in an
403 // interactive mode, the boot manager will stop processing the BootOrder variable and
404 // present a boot manager menu to the user.
406 if ((BootManagerMenu
!= NULL
) && (BootOptions
[Index
].Status
== EFI_SUCCESS
)) {
407 EfiBootManagerBoot (BootManagerMenu
);
412 return (BOOLEAN
) (Index
< BootOptionCount
);
416 The function will load and start every Driver####, SysPrep#### or PlatformRecovery####.
418 @param LoadOptions Load option array.
419 @param LoadOptionCount Load option count.
423 IN EFI_BOOT_MANAGER_LOAD_OPTION
*LoadOptions
,
424 IN UINTN LoadOptionCount
429 BOOLEAN ReconnectAll
;
430 EFI_BOOT_MANAGER_LOAD_OPTION_TYPE LoadOptionType
;
432 ReconnectAll
= FALSE
;
433 LoadOptionType
= LoadOptionTypeMax
;
436 // Process the driver option
438 for (Index
= 0; Index
< LoadOptionCount
; Index
++) {
440 // All the load options in the array should be of the same type.
443 LoadOptionType
= LoadOptions
[Index
].OptionType
;
445 ASSERT (LoadOptionType
== LoadOptions
[Index
].OptionType
);
446 ASSERT (LoadOptionType
!= LoadOptionTypeBoot
);
448 Status
= EfiBootManagerProcessLoadOption (&LoadOptions
[Index
]);
451 // Status indicates whether the load option is loaded and executed
452 // LoadOptions[Index].Status is what the load option returns
454 if (!EFI_ERROR (Status
)) {
456 // Stop processing if any PlatformRecovery#### returns success.
458 if ((LoadOptions
[Index
].Status
== EFI_SUCCESS
) &&
459 (LoadOptionType
== LoadOptionTypePlatformRecovery
)) {
464 // Only set ReconnectAll flag when the load option executes successfully.
466 if (!EFI_ERROR (LoadOptions
[Index
].Status
) &&
467 (LoadOptions
[Index
].Attributes
& LOAD_OPTION_FORCE_RECONNECT
) != 0) {
474 // If a driver load option is marked as LOAD_OPTION_FORCE_RECONNECT,
475 // then all of the EFI drivers in the system will be disconnected and
476 // reconnected after the last driver load option is processed.
478 if (ReconnectAll
&& LoadOptionType
== LoadOptionTypeDriver
) {
479 EfiBootManagerDisconnectAll ();
480 EfiBootManagerConnectAll ();
486 Validate input console variable data.
488 If found the device path is not a valid device path, remove the variable.
490 @param VariableName Input console variable name.
494 BdsFormalizeConsoleVariable (
495 IN CHAR16
*VariableName
498 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
502 GetEfiGlobalVariable2 (VariableName
, (VOID
**) &DevicePath
, &VariableSize
);
503 if ((DevicePath
!= NULL
) && !IsDevicePathValid (DevicePath
, VariableSize
)) {
504 Status
= gRT
->SetVariable (
506 &gEfiGlobalVariableGuid
,
507 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
512 // Deleting variable with current variable implementation shouldn't fail.
514 ASSERT_EFI_ERROR (Status
);
517 if (DevicePath
!= NULL
) {
518 FreePool (DevicePath
);
523 Formalize OsIndication related variables.
525 For OsIndicationsSupported, Create a BS/RT/UINT64 variable to report caps
526 Delete OsIndications variable if it is not NV/BS/RT UINT64.
528 Item 3 is used to solve case when OS corrupts OsIndications. Here simply delete this NV variable.
530 Create a boot option for BootManagerMenu if it hasn't been created yet
534 BdsFormalizeOSIndicationVariable (
539 UINT64 OsIndicationSupport
;
543 EFI_BOOT_MANAGER_LOAD_OPTION BootManagerMenu
;
546 // OS indicater support variable
548 Status
= EfiBootManagerGetBootManagerMenu (&BootManagerMenu
);
549 if (Status
!= EFI_NOT_FOUND
) {
550 OsIndicationSupport
= EFI_OS_INDICATIONS_BOOT_TO_FW_UI
| EFI_OS_INDICATIONS_START_PLATFORM_RECOVERY
;
551 EfiBootManagerFreeLoadOption (&BootManagerMenu
);
553 OsIndicationSupport
= EFI_OS_INDICATIONS_START_PLATFORM_RECOVERY
;
556 Status
= gRT
->SetVariable (
557 EFI_OS_INDICATIONS_SUPPORT_VARIABLE_NAME
,
558 &gEfiGlobalVariableGuid
,
559 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
564 // Platform needs to make sure setting volatile variable before calling 3rd party code shouldn't fail.
566 ASSERT_EFI_ERROR (Status
);
569 // If OsIndications is invalid, remove it.
571 // 1. Data size != UINT64
572 // 2. OsIndication value inconsistence
573 // 3. OsIndication attribute inconsistence
577 DataSize
= sizeof(UINT64
);
578 Status
= gRT
->GetVariable (
579 EFI_OS_INDICATIONS_VARIABLE_NAME
,
580 &gEfiGlobalVariableGuid
,
585 if (Status
== EFI_NOT_FOUND
) {
589 if ((DataSize
!= sizeof (OsIndication
)) ||
590 ((OsIndication
& ~OsIndicationSupport
) != 0) ||
591 (Attributes
!= (EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
))
594 DEBUG ((EFI_D_ERROR
, "[Bds] Unformalized OsIndications variable exists. Delete it\n"));
595 Status
= gRT
->SetVariable (
596 EFI_OS_INDICATIONS_VARIABLE_NAME
,
597 &gEfiGlobalVariableGuid
,
603 // Deleting variable with current variable implementation shouldn't fail.
605 ASSERT_EFI_ERROR(Status
);
615 BdsFormalizeEfiGlobalVariable (
620 // Validate Console variable.
622 BdsFormalizeConsoleVariable (EFI_CON_IN_VARIABLE_NAME
);
623 BdsFormalizeConsoleVariable (EFI_CON_OUT_VARIABLE_NAME
);
624 BdsFormalizeConsoleVariable (EFI_ERR_OUT_VARIABLE_NAME
);
627 // Validate OSIndication related variable.
629 BdsFormalizeOSIndicationVariable ();
634 Allocate a block of memory that will contain performance data to OS.
638 BdsAllocateMemoryForPerformanceData (
643 EFI_PHYSICAL_ADDRESS AcpiLowMemoryBase
;
644 EDKII_VARIABLE_LOCK_PROTOCOL
*VariableLock
;
646 AcpiLowMemoryBase
= 0x0FFFFFFFFULL
;
649 // Allocate a block of memory that will contain performance data to OS.
651 Status
= gBS
->AllocatePages (
653 EfiReservedMemoryType
,
654 EFI_SIZE_TO_PAGES (PERF_DATA_MAX_LENGTH
),
657 if (!EFI_ERROR (Status
)) {
659 // Save the pointer to variable for use in S3 resume.
661 Status
= BdsDxeSetVariableAndReportStatusCodeOnError (
663 &gPerformanceProtocolGuid
,
664 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
665 sizeof (EFI_PHYSICAL_ADDRESS
),
668 if (EFI_ERROR (Status
)) {
669 DEBUG ((EFI_D_ERROR
, "[Bds] PerfDataMemAddr (%08x) cannot be saved to NV storage.\n", AcpiLowMemoryBase
));
672 // Mark L"PerfDataMemAddr" variable to read-only if the Variable Lock protocol exists
673 // Still lock it even the variable cannot be saved to prevent it's set by 3rd party code.
675 Status
= gBS
->LocateProtocol (&gEdkiiVariableLockProtocolGuid
, NULL
, (VOID
**) &VariableLock
);
676 if (!EFI_ERROR (Status
)) {
677 Status
= VariableLock
->RequestToLock (VariableLock
, L
"PerfDataMemAddr", &gPerformanceProtocolGuid
);
678 ASSERT_EFI_ERROR (Status
);
685 Service routine for BdsInstance->Entry(). Devices are connected, the
686 consoles are initialized, and the boot options are tried.
688 @param This Protocol Instance structure.
694 IN EFI_BDS_ARCH_PROTOCOL
*This
697 EFI_BOOT_MANAGER_LOAD_OPTION
*LoadOptions
;
698 UINTN LoadOptionCount
;
699 CHAR16
*FirmwareVendor
;
700 EFI_EVENT HotkeyTriggered
;
704 UINT32 BootOptionSupport
;
706 EDKII_VARIABLE_LOCK_PROTOCOL
*VariableLock
;
708 EFI_BOOT_MANAGER_LOAD_OPTION LoadOption
;
710 CHAR16 BootNextVariableName
[sizeof ("Boot####")];
711 EFI_BOOT_MANAGER_LOAD_OPTION BootManagerMenu
;
713 BOOLEAN PlatformRecovery
;
715 EFI_DEVICE_PATH_PROTOCOL
*FilePath
;
716 EFI_STATUS BootManagerMenuStatus
;
718 HotkeyTriggered
= NULL
;
719 Status
= EFI_SUCCESS
;
723 // Insert the performance probe
725 PERF_END (NULL
, "DXE", NULL
, 0);
726 PERF_START (NULL
, "BDS", NULL
, 0);
727 DEBUG ((EFI_D_INFO
, "[Bds] Entry...\n"));
730 BdsAllocateMemoryForPerformanceData ();
734 // Fill in FirmwareVendor and FirmwareRevision from PCDs
736 FirmwareVendor
= (CHAR16
*) PcdGetPtr (PcdFirmwareVendor
);
737 gST
->FirmwareVendor
= AllocateRuntimeCopyPool (StrSize (FirmwareVendor
), FirmwareVendor
);
738 ASSERT (gST
->FirmwareVendor
!= NULL
);
739 gST
->FirmwareRevision
= PcdGet32 (PcdFirmwareRevision
);
742 // Fixup Tasble CRC after we updated Firmware Vendor and Revision
745 gBS
->CalculateCrc32 ((VOID
*) gST
, sizeof (EFI_SYSTEM_TABLE
), &gST
->Hdr
.CRC32
);
748 // Validate Variable.
750 BdsFormalizeEfiGlobalVariable ();
753 // Mark the read-only variables if the Variable Lock protocol exists
755 Status
= gBS
->LocateProtocol (&gEdkiiVariableLockProtocolGuid
, NULL
, (VOID
**) &VariableLock
);
756 DEBUG ((EFI_D_INFO
, "[BdsDxe] Locate Variable Lock protocol - %r\n", Status
));
757 if (!EFI_ERROR (Status
)) {
758 for (Index
= 0; Index
< ARRAY_SIZE (mReadOnlyVariables
); Index
++) {
759 Status
= VariableLock
->RequestToLock (VariableLock
, mReadOnlyVariables
[Index
], &gEfiGlobalVariableGuid
);
760 ASSERT_EFI_ERROR (Status
);
764 InitializeHwErrRecSupport ();
767 // Initialize L"Timeout" EFI global variable.
769 BootTimeOut
= PcdGet16 (PcdPlatformBootTimeOut
);
770 if (BootTimeOut
!= 0xFFFF) {
772 // If time out value equal 0xFFFF, no need set to 0xFFFF to variable area because UEFI specification
773 // define same behavior between no value or 0xFFFF value for L"Timeout".
775 BdsDxeSetVariableAndReportStatusCodeOnError (
776 EFI_TIME_OUT_VARIABLE_NAME
,
777 &gEfiGlobalVariableGuid
,
778 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
785 // Initialize L"BootOptionSupport" EFI global variable.
786 // Lazy-ConIn implictly disables BDS hotkey.
788 BootOptionSupport
= EFI_BOOT_OPTION_SUPPORT_APP
| EFI_BOOT_OPTION_SUPPORT_SYSPREP
;
789 if (!PcdGetBool (PcdConInConnectOnDemand
)) {
790 BootOptionSupport
|= EFI_BOOT_OPTION_SUPPORT_KEY
;
791 SET_BOOT_OPTION_SUPPORT_KEY_COUNT (BootOptionSupport
, 3);
793 Status
= gRT
->SetVariable (
794 EFI_BOOT_OPTION_SUPPORT_VARIABLE_NAME
,
795 &gEfiGlobalVariableGuid
,
796 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
797 sizeof (BootOptionSupport
),
801 // Platform needs to make sure setting volatile variable before calling 3rd party code shouldn't fail.
803 ASSERT_EFI_ERROR (Status
);
806 // Cache and remove the "BootNext" NV variable.
808 GetEfiGlobalVariable2 (EFI_BOOT_NEXT_VARIABLE_NAME
, (VOID
**) &BootNext
, &DataSize
);
809 if (DataSize
!= sizeof (UINT16
)) {
810 if (BootNext
!= NULL
) {
815 Status
= gRT
->SetVariable (
816 EFI_BOOT_NEXT_VARIABLE_NAME
,
817 &gEfiGlobalVariableGuid
,
823 // Deleting NV variable shouldn't fail unless it doesn't exist.
825 ASSERT (Status
== EFI_SUCCESS
|| Status
== EFI_NOT_FOUND
);
828 // Initialize the platform language variables
830 InitializeLanguage (TRUE
);
833 // System firmware must include a PlatformRecovery#### variable specifying
834 // a short-form File Path Media Device Path containing the platform default
835 // file path for removable media
837 FilePath
= FileDevicePath (NULL
, EFI_REMOVABLE_MEDIA_FILE_NAME
);
838 Status
= EfiBootManagerInitializeLoadOption (
840 LoadOptionNumberUnassigned
,
841 LoadOptionTypePlatformRecovery
,
843 L
"Default PlatformRecovery",
848 ASSERT_EFI_ERROR (Status
);
849 LoadOptions
= EfiBootManagerGetLoadOptions (&LoadOptionCount
, LoadOptionTypePlatformRecovery
);
850 if (EfiBootManagerFindLoadOption (&LoadOption
, LoadOptions
, LoadOptionCount
) == -1) {
851 for (Index
= 0; Index
< LoadOptionCount
; Index
++) {
853 // The PlatformRecovery#### options are sorted by OptionNumber.
854 // Find the the smallest unused number as the new OptionNumber.
856 if (LoadOptions
[Index
].OptionNumber
!= Index
) {
860 LoadOption
.OptionNumber
= Index
;
861 Status
= EfiBootManagerLoadOptionToVariable (&LoadOption
);
862 ASSERT_EFI_ERROR (Status
);
864 EfiBootManagerFreeLoadOption (&LoadOption
);
866 EfiBootManagerFreeLoadOptions (LoadOptions
, LoadOptionCount
);
869 // Report Status Code to indicate connecting drivers will happen
873 (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_SW_DXE_BS_PC_BEGIN_CONNECTING_DRIVERS
)
877 // Do the platform init, can be customized by OEM/IBV
878 // Possible things that can be done in PlatformBootManagerBeforeConsole:
879 // > Update console variable: 1. include hot-plug devices; 2. Clear ConIn and add SOL for AMT
880 // > Register new Driver#### or Boot####
881 // > Register new Key####: e.g.: F12
882 // > Signal ReadyToLock event
883 // > Authentication action: 1. connect Auth devices; 2. Identify auto logon user.
885 PERF_START (NULL
, "PlatformBootManagerBeforeConsole", "BDS", 0);
886 PlatformBootManagerBeforeConsole ();
887 PERF_END (NULL
, "PlatformBootManagerBeforeConsole", "BDS", 0);
890 // Initialize hotkey service
892 EfiBootManagerStartHotkeyService (&HotkeyTriggered
);
895 // Execute Driver Options
897 LoadOptions
= EfiBootManagerGetLoadOptions (&LoadOptionCount
, LoadOptionTypeDriver
);
898 ProcessLoadOptions (LoadOptions
, LoadOptionCount
);
899 EfiBootManagerFreeLoadOptions (LoadOptions
, LoadOptionCount
);
904 PERF_START (NULL
, "EfiBootManagerConnectAllDefaultConsoles", "BDS", 0);
905 if (PcdGetBool (PcdConInConnectOnDemand
)) {
906 EfiBootManagerConnectConsoleVariable (ConOut
);
907 EfiBootManagerConnectConsoleVariable (ErrOut
);
910 // Initialize ConnectConIn event
912 Status
= gBS
->CreateEventEx (
915 BdsDxeOnConnectConInCallBack
,
917 &gConnectConInEventGuid
,
920 if (EFI_ERROR (Status
)) {
921 gConnectConInEvent
= NULL
;
924 EfiBootManagerConnectAllDefaultConsoles ();
926 PERF_END (NULL
, "EfiBootManagerConnectAllDefaultConsoles", "BDS", 0);
929 // Do the platform specific action after the console is ready
930 // Possible things that can be done in PlatformBootManagerAfterConsole:
931 // > Console post action:
932 // > Dynamically switch output mode from 100x31 to 80x25 for certain senarino
933 // > Signal console ready platform customized event
934 // > Run diagnostics like memory testing
935 // > Connect certain devices
936 // > Dispatch aditional option roms
937 // > Special boot: e.g.: USB boot, enter UI
939 PERF_START (NULL
, "PlatformBootManagerAfterConsole", "BDS", 0);
940 PlatformBootManagerAfterConsole ();
941 PERF_END (NULL
, "PlatformBootManagerAfterConsole", "BDS", 0);
943 // Boot to Boot Manager Menu when EFI_OS_INDICATIONS_BOOT_TO_FW_UI is set. Skip HotkeyBoot
945 DataSize
= sizeof (UINT64
);
946 Status
= gRT
->GetVariable (
947 EFI_OS_INDICATIONS_VARIABLE_NAME
,
948 &gEfiGlobalVariableGuid
,
953 if (EFI_ERROR (Status
)) {
958 EFI_BOOT_MANAGER_LOAD_OPTION_TYPE LoadOptionType
;
959 DEBUG ((EFI_D_INFO
, "[Bds]OsIndication: %016x\n", OsIndication
));
960 DEBUG ((EFI_D_INFO
, "[Bds]=============Begin Load Options Dumping ...=============\n"));
961 for (LoadOptionType
= 0; LoadOptionType
< LoadOptionTypeMax
; LoadOptionType
++) {
963 EFI_D_INFO
, " %s Options:\n",
964 mBdsLoadOptionName
[LoadOptionType
]
966 LoadOptions
= EfiBootManagerGetLoadOptions (&LoadOptionCount
, LoadOptionType
);
967 for (Index
= 0; Index
< LoadOptionCount
; Index
++) {
969 EFI_D_INFO
, " %s%04x: %s \t\t 0x%04x\n",
970 mBdsLoadOptionName
[LoadOptionType
],
971 LoadOptions
[Index
].OptionNumber
,
972 LoadOptions
[Index
].Description
,
973 LoadOptions
[Index
].Attributes
976 EfiBootManagerFreeLoadOptions (LoadOptions
, LoadOptionCount
);
978 DEBUG ((EFI_D_INFO
, "[Bds]=============End Load Options Dumping=============\n"));
982 // BootManagerMenu doesn't contain the correct information when return status is EFI_NOT_FOUND.
984 BootManagerMenuStatus
= EfiBootManagerGetBootManagerMenu (&BootManagerMenu
);
986 BootFwUi
= (BOOLEAN
) ((OsIndication
& EFI_OS_INDICATIONS_BOOT_TO_FW_UI
) != 0);
987 PlatformRecovery
= (BOOLEAN
) ((OsIndication
& EFI_OS_INDICATIONS_START_PLATFORM_RECOVERY
) != 0);
989 // Clear EFI_OS_INDICATIONS_BOOT_TO_FW_UI to acknowledge OS
991 if (BootFwUi
|| PlatformRecovery
) {
992 OsIndication
&= ~((UINT64
) (EFI_OS_INDICATIONS_BOOT_TO_FW_UI
| EFI_OS_INDICATIONS_START_PLATFORM_RECOVERY
));
993 Status
= gRT
->SetVariable (
994 EFI_OS_INDICATIONS_VARIABLE_NAME
,
995 &gEfiGlobalVariableGuid
,
996 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
1001 // Changing the content without increasing its size with current variable implementation shouldn't fail.
1003 ASSERT_EFI_ERROR (Status
);
1007 // Launch Boot Manager Menu directly when EFI_OS_INDICATIONS_BOOT_TO_FW_UI is set. Skip HotkeyBoot
1009 if (BootFwUi
&& (BootManagerMenuStatus
!= EFI_NOT_FOUND
)) {
1011 // Follow generic rule, Call BdsDxeOnConnectConInCallBack to connect ConIn before enter UI
1013 if (PcdGetBool (PcdConInConnectOnDemand
)) {
1014 BdsDxeOnConnectConInCallBack (NULL
, NULL
);
1018 // Directly enter the setup page.
1020 EfiBootManagerBoot (&BootManagerMenu
);
1023 if (!PlatformRecovery
) {
1025 // Execute SysPrep####
1027 LoadOptions
= EfiBootManagerGetLoadOptions (&LoadOptionCount
, LoadOptionTypeSysPrep
);
1028 ProcessLoadOptions (LoadOptions
, LoadOptionCount
);
1029 EfiBootManagerFreeLoadOptions (LoadOptions
, LoadOptionCount
);
1034 PERF_START (NULL
, "BdsWait", "BDS", 0);
1035 BdsWait (HotkeyTriggered
);
1036 PERF_END (NULL
, "BdsWait", "BDS", 0);
1039 // BdsReadKeys() can be removed after all keyboard drivers invoke callback in timer callback.
1043 EfiBootManagerHotkeyBoot ();
1046 // Boot to "BootNext"
1048 if (BootNext
!= NULL
) {
1049 UnicodeSPrint (BootNextVariableName
, sizeof (BootNextVariableName
), L
"Boot%04x", *BootNext
);
1050 Status
= EfiBootManagerVariableToLoadOption (BootNextVariableName
, &LoadOption
);
1051 if (!EFI_ERROR (Status
)) {
1052 EfiBootManagerBoot (&LoadOption
);
1053 EfiBootManagerFreeLoadOption (&LoadOption
);
1054 if ((LoadOption
.Status
== EFI_SUCCESS
) &&
1055 (BootManagerMenuStatus
!= EFI_NOT_FOUND
) &&
1056 (LoadOption
.OptionNumber
!= BootManagerMenu
.OptionNumber
)) {
1058 // Boot to Boot Manager Menu upon EFI_SUCCESS
1059 // Exception: Do not boot again when the BootNext points to Boot Manager Menu.
1061 EfiBootManagerBoot (&BootManagerMenu
);
1068 // Retry to boot if any of the boot succeeds
1070 LoadOptions
= EfiBootManagerGetLoadOptions (&LoadOptionCount
, LoadOptionTypeBoot
);
1071 BootSuccess
= BootBootOptions (LoadOptions
, LoadOptionCount
, (BootManagerMenuStatus
!= EFI_NOT_FOUND
) ? &BootManagerMenu
: NULL
);
1072 EfiBootManagerFreeLoadOptions (LoadOptions
, LoadOptionCount
);
1073 } while (BootSuccess
);
1076 if (BootManagerMenuStatus
!= EFI_NOT_FOUND
) {
1077 EfiBootManagerFreeLoadOption (&BootManagerMenu
);
1081 LoadOptions
= EfiBootManagerGetLoadOptions (&LoadOptionCount
, LoadOptionTypePlatformRecovery
);
1082 ProcessLoadOptions (LoadOptions
, LoadOptionCount
);
1083 EfiBootManagerFreeLoadOptions (LoadOptions
, LoadOptionCount
);
1086 DEBUG ((EFI_D_ERROR
, "[Bds] Unable to boot!\n"));
1091 Set the variable and report the error through status code upon failure.
1093 @param VariableName A Null-terminated string that is the name of the vendor's variable.
1094 Each VariableName is unique for each VendorGuid. VariableName must
1095 contain 1 or more characters. If VariableName is an empty string,
1096 then EFI_INVALID_PARAMETER is returned.
1097 @param VendorGuid A unique identifier for the vendor.
1098 @param Attributes Attributes bitmask to set for the variable.
1099 @param DataSize The size in bytes of the Data buffer. Unless the EFI_VARIABLE_APPEND_WRITE,
1100 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS, or
1101 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS attribute is set, a size of zero
1102 causes the variable to be deleted. When the EFI_VARIABLE_APPEND_WRITE attribute is
1103 set, then a SetVariable() call with a DataSize of zero will not cause any change to
1104 the variable value (the timestamp associated with the variable may be updated however
1105 even if no new data value is provided,see the description of the
1106 EFI_VARIABLE_AUTHENTICATION_2 descriptor below. In this case the DataSize will not
1107 be zero since the EFI_VARIABLE_AUTHENTICATION_2 descriptor will be populated).
1108 @param Data The contents for the variable.
1110 @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as
1111 defined by the Attributes.
1112 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits, name, and GUID was supplied, or the
1113 DataSize exceeds the maximum allowed.
1114 @retval EFI_INVALID_PARAMETER VariableName is an empty string.
1115 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
1116 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
1117 @retval EFI_WRITE_PROTECTED The variable in question is read-only.
1118 @retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.
1119 @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS
1120 or EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACESS being set, but the AuthInfo
1121 does NOT pass the validation check carried out by the firmware.
1123 @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.
1126 BdsDxeSetVariableAndReportStatusCodeOnError (
1127 IN CHAR16
*VariableName
,
1128 IN EFI_GUID
*VendorGuid
,
1129 IN UINT32 Attributes
,
1135 EDKII_SET_VARIABLE_STATUS
*SetVariableStatus
;
1138 Status
= gRT
->SetVariable (
1145 if (EFI_ERROR (Status
)) {
1146 NameSize
= StrSize (VariableName
);
1147 SetVariableStatus
= AllocatePool (sizeof (EDKII_SET_VARIABLE_STATUS
) + NameSize
+ DataSize
);
1148 if (SetVariableStatus
!= NULL
) {
1149 CopyGuid (&SetVariableStatus
->Guid
, VendorGuid
);
1150 SetVariableStatus
->NameSize
= NameSize
;
1151 SetVariableStatus
->DataSize
= DataSize
;
1152 SetVariableStatus
->SetStatus
= Status
;
1153 SetVariableStatus
->Attributes
= Attributes
;
1154 CopyMem (SetVariableStatus
+ 1, VariableName
, NameSize
);
1155 CopyMem (((UINT8
*) (SetVariableStatus
+ 1)) + NameSize
, Data
, DataSize
);
1157 REPORT_STATUS_CODE_EX (
1159 PcdGet32 (PcdErrorCodeSetVariable
),
1162 &gEdkiiStatusCodeDataTypeVariableGuid
,
1164 sizeof (EDKII_SET_VARIABLE_STATUS
) + NameSize
+ DataSize
1167 FreePool (SetVariableStatus
);