2 BDS Lib functions which relate with create or process the boot option.
4 Copyright (c) 2004 - 2010, 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.
15 #include "InternalBdsLib.h"
18 BOOLEAN mEnumBootDevice
= FALSE
;
19 EFI_HII_HANDLE gBdsLibStringPackHandle
= NULL
;
22 /// This GUID is used for an EFI Variable that stores the front device pathes
23 /// for a partial device path that starts with the HD node.
25 EFI_GUID mHdBootVariablePrivateGuid
= { 0xfab7e9e1, 0x39dd, 0x4f2b, { 0x84, 0x8, 0xe2, 0xe, 0x90, 0x6c, 0xb6, 0xde } };
28 /// This GUID is used for register UNI string.
30 EFI_GUID mBdsLibStringPackGuid
= { 0x3b4d9b23, 0x95ac, 0x44f6, { 0x9f, 0xcd, 0xe, 0x95, 0x94, 0x58, 0x6c, 0x72 } };
33 /// This GUID is used for Set/Get platform language into/from variable at last time enumeration to ensure the enumeration will
34 /// only execute once.
36 EFI_GUID mBdsLibLastLangGuid
= { 0xe8c545b, 0xa2ee, 0x470d, { 0x8e, 0x26, 0xbd, 0xa1, 0xa1, 0x3c, 0xa, 0xa3 } };
39 The constructor function register UNI strings into imageHandle.
41 It will ASSERT() if that operation fails and it will always return EFI_SUCCESS.
43 @param ImageHandle The firmware allocated handle for the EFI image.
44 @param SystemTable A pointer to the EFI System Table.
46 @retval EFI_SUCCESS The constructor successfully added string package.
47 @retval Other value The constructor can't add string package.
52 GenericBdsLibConstructor (
53 IN EFI_HANDLE ImageHandle
,
54 IN EFI_SYSTEM_TABLE
*SystemTable
58 gBdsLibStringPackHandle
= HiiAddPackages (
59 &mBdsLibStringPackGuid
,
65 ASSERT (gBdsLibStringPackHandle
!= NULL
);
73 Boot the legacy system with the boot option
75 @param Option The legacy boot option which have BBS device path
77 @retval EFI_UNSUPPORTED There is no legacybios protocol, do not support
79 @retval EFI_STATUS Return the status of LegacyBios->LegacyBoot ().
84 IN BDS_COMMON_OPTION
*Option
88 EFI_LEGACY_BIOS_PROTOCOL
*LegacyBios
;
90 Status
= gBS
->LocateProtocol (&gEfiLegacyBiosProtocolGuid
, NULL
, (VOID
**) &LegacyBios
);
91 if (EFI_ERROR (Status
)) {
93 // If no LegacyBios protocol we do not support legacy boot
95 return EFI_UNSUPPORTED
;
98 // Notes: if we separate the int 19, then we don't need to refresh BBS
100 BdsRefreshBbsTableForBoot (Option
);
103 // Write boot to OS performance data for legacy boot.
106 WriteBootToOsPerformanceData ();
109 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Legacy Boot: %S\n", Option
->Description
));
110 return LegacyBios
->LegacyBoot (
112 (BBS_BBS_DEVICE_PATH
*) Option
->DevicePath
,
113 Option
->LoadOptionsSize
,
119 Internal function to check if the input boot option is a valid EFI NV Boot####.
121 @param OptionToCheck Boot option to be checked.
123 @retval TRUE This boot option matches a valid EFI NV Boot####.
124 @retval FALSE If not.
128 IsBootOptionValidNVVarialbe (
129 IN BDS_COMMON_OPTION
*OptionToCheck
133 BDS_COMMON_OPTION
*BootOption
;
135 CHAR16 OptionName
[20];
139 InitializeListHead (&TempList
);
140 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Boot%04x", OptionToCheck
->BootCurrent
);
142 BootOption
= BdsLibVariableToOption (&TempList
, OptionName
);
143 if (BootOption
== NULL
) {
148 // If the Boot Option Number and Device Path matches, OptionToCheck matches a
149 // valid EFI NV Boot####.
151 if ((OptionToCheck
->BootCurrent
== BootOption
->BootCurrent
) &&
152 (CompareMem (OptionToCheck
->DevicePath
, BootOption
->DevicePath
, GetDevicePathSize (OptionToCheck
->DevicePath
)) == 0))
157 FreePool (BootOption
);
162 Process the boot option follow the UEFI specification and
163 special treat the legacy boot option with BBS_DEVICE_PATH.
165 @param Option The boot option need to be processed
166 @param DevicePath The device path which describe where to load the
167 boot image or the legacy BBS device path to boot
169 @param ExitDataSize The size of exit data.
170 @param ExitData Data returned when Boot image failed.
172 @retval EFI_SUCCESS Boot from the input boot option successfully.
173 @retval EFI_NOT_FOUND If the Device Path is not found in the system
178 BdsLibBootViaBootOption (
179 IN BDS_COMMON_OPTION
*Option
,
180 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
181 OUT UINTN
*ExitDataSize
,
182 OUT CHAR16
**ExitData OPTIONAL
187 EFI_HANDLE ImageHandle
;
188 EFI_DEVICE_PATH_PROTOCOL
*FilePath
;
189 EFI_LOADED_IMAGE_PROTOCOL
*ImageInfo
;
190 EFI_DEVICE_PATH_PROTOCOL
*WorkingDevicePath
;
191 EFI_ACPI_S3_SAVE_PROTOCOL
*AcpiS3Save
;
192 LIST_ENTRY TempBootLists
;
195 // Record the performance data for End of BDS
197 PERF_END(NULL
, "BDS", NULL
, 0);
203 // Notes: this code can be remove after the s3 script table
204 // hook on the event EVT_SIGNAL_READY_TO_BOOT or
205 // EVT_SIGNAL_LEGACY_BOOT
207 Status
= gBS
->LocateProtocol (&gEfiAcpiS3SaveProtocolGuid
, NULL
, (VOID
**) &AcpiS3Save
);
208 if (!EFI_ERROR (Status
)) {
209 AcpiS3Save
->S3Save (AcpiS3Save
, NULL
);
212 // If it's Device Path that starts with a hard drive path, append it with the front part to compose a
215 WorkingDevicePath
= NULL
;
216 if ((DevicePathType (DevicePath
) == MEDIA_DEVICE_PATH
) &&
217 (DevicePathSubType (DevicePath
) == MEDIA_HARDDRIVE_DP
)) {
218 WorkingDevicePath
= BdsExpandPartitionPartialDevicePathToFull (
219 (HARDDRIVE_DEVICE_PATH
*)DevicePath
221 if (WorkingDevicePath
!= NULL
) {
222 DevicePath
= WorkingDevicePath
;
226 // Signal the EVT_SIGNAL_READY_TO_BOOT event
228 EfiSignalEventReadyToBoot();
231 // Adjust the different type memory page number just before booting
232 // and save the updated info into the variable for next boot to use
234 BdsSetMemoryTypeInformationVariable ();
240 if (IsBootOptionValidNVVarialbe (Option
)) {
242 // For a temporary boot (i.e. a boot by selected a EFI Shell using "Boot From File"), Boot Current is actually not valid.
243 // In this case, "BootCurrent" is not created.
244 // Only create the BootCurrent variable when it points to a valid Boot#### variable.
248 &gEfiGlobalVariableGuid
,
249 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
255 ASSERT (Option
->DevicePath
!= NULL
);
256 if ((DevicePathType (Option
->DevicePath
) == BBS_DEVICE_PATH
) &&
257 (DevicePathSubType (Option
->DevicePath
) == BBS_BBS_DP
)
260 // Check to see if we should legacy BOOT. If yes then do the legacy boot
262 return BdsLibDoLegacyBoot (Option
);
266 // If the boot option point to Internal FV shell, make sure it is valid
268 Status
= BdsLibUpdateFvFileDevicePath (&DevicePath
, PcdGetPtr(PcdShellFile
));
269 if (!EFI_ERROR(Status
)) {
270 if (Option
->DevicePath
!= NULL
) {
271 FreePool(Option
->DevicePath
);
273 Option
->DevicePath
= AllocateZeroPool (GetDevicePathSize (DevicePath
));
274 ASSERT(Option
->DevicePath
!= NULL
);
275 CopyMem (Option
->DevicePath
, DevicePath
, GetDevicePathSize (DevicePath
));
277 // Update the shell boot option
279 InitializeListHead (&TempBootLists
);
280 BdsLibRegisterNewOption (&TempBootLists
, DevicePath
, L
"EFI Internal Shell", L
"BootOrder");
283 // free the temporary device path created by BdsLibUpdateFvFileDevicePath()
285 FreePool (DevicePath
);
286 DevicePath
= Option
->DevicePath
;
291 if (Option
->Description
== NULL
) {
292 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Booting from unknown device path\n"));
294 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Booting %S\n", Option
->Description
));
299 Status
= gBS
->LoadImage (
309 // If we didn't find an image directly, we need to try as if it is a removable device boot option
310 // and load the image according to the default boot behavior for removable device.
312 if (EFI_ERROR (Status
)) {
314 // check if there is a bootable removable media could be found in this device path ,
315 // and get the bootable media handle
317 Handle
= BdsLibGetBootableHandle(DevicePath
);
318 if (Handle
== NULL
) {
322 // Load the default boot file \EFI\BOOT\boot{machinename}.EFI from removable Media
323 // machinename is ia32, ia64, x64, ...
325 FilePath
= FileDevicePath (Handle
, EFI_REMOVABLE_MEDIA_FILE_NAME
);
326 if (FilePath
!= NULL
) {
327 Status
= gBS
->LoadImage (
335 if (EFI_ERROR (Status
)) {
337 // The DevicePath failed, and it's not a valid
338 // removable media device.
345 if (EFI_ERROR (Status
)) {
347 // It there is any error from the Boot attempt exit now.
352 // Provide the image with it's load options
354 Status
= gBS
->HandleProtocol (ImageHandle
, &gEfiLoadedImageProtocolGuid
, (VOID
**) &ImageInfo
);
355 ASSERT_EFI_ERROR (Status
);
357 if (Option
->LoadOptionsSize
!= 0) {
358 ImageInfo
->LoadOptionsSize
= Option
->LoadOptionsSize
;
359 ImageInfo
->LoadOptions
= Option
->LoadOptions
;
362 // Before calling the image, enable the Watchdog Timer for
363 // the 5 Minute period
365 gBS
->SetWatchdogTimer (5 * 60, 0x0000, 0x00, NULL
);
368 // Write boot to OS performance data for UEFI boot
371 WriteBootToOsPerformanceData ();
374 Status
= gBS
->StartImage (ImageHandle
, ExitDataSize
, ExitData
);
375 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Image Return Status = %r\n", Status
));
378 // Clear the Watchdog Timer after the image returns
380 gBS
->SetWatchdogTimer (0x0000, 0x0000, 0x0000, NULL
);
384 // Clear Boot Current
388 &gEfiGlobalVariableGuid
,
389 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
399 Expand a device path that starts with a hard drive media device path node to be a
400 full device path that includes the full hardware path to the device. We need
401 to do this so it can be booted. As an optimization the front match (the part point
402 to the partition node. E.g. ACPI() /PCI()/ATA()/Partition() ) is saved in a variable
403 so a connect all is not required on every boot. All successful history device path
404 which point to partition node (the front part) will be saved.
406 @param HardDriveDevicePath EFI Device Path to boot, if it starts with a hard
407 drive media device path.
408 @return A Pointer to the full device path or NULL if a valid Hard Drive devic path
412 EFI_DEVICE_PATH_PROTOCOL
*
414 BdsExpandPartitionPartialDevicePathToFull (
415 IN HARDDRIVE_DEVICE_PATH
*HardDriveDevicePath
419 UINTN BlockIoHandleCount
;
420 EFI_HANDLE
*BlockIoBuffer
;
421 EFI_DEVICE_PATH_PROTOCOL
*FullDevicePath
;
422 EFI_DEVICE_PATH_PROTOCOL
*BlockIoDevicePath
;
423 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
426 EFI_DEVICE_PATH_PROTOCOL
*CachedDevicePath
;
427 EFI_DEVICE_PATH_PROTOCOL
*TempNewDevicePath
;
428 UINTN CachedDevicePathSize
;
431 EFI_DEVICE_PATH_PROTOCOL
*Instance
;
434 FullDevicePath
= NULL
;
436 // Check if there is prestore 'HDDP' variable.
437 // If exist, search the front path which point to partition node in the variable instants.
438 // If fail to find or 'HDDP' not exist, reconnect all and search in all system
440 CachedDevicePath
= BdsLibGetVariableAndSize (
442 &mHdBootVariablePrivateGuid
,
443 &CachedDevicePathSize
446 if (CachedDevicePath
!= NULL
) {
447 TempNewDevicePath
= CachedDevicePath
;
452 // Check every instance of the variable
453 // First, check whether the instance contain the partition node, which is needed for distinguishing multi
454 // partial partition boot option. Second, check whether the instance could be connected.
456 Instance
= GetNextDevicePathInstance (&TempNewDevicePath
, &Size
);
457 if (MatchPartitionDevicePathNode (Instance
, HardDriveDevicePath
)) {
459 // Connect the device path instance, the device path point to hard drive media device path node
460 // e.g. ACPI() /PCI()/ATA()/Partition()
462 Status
= BdsLibConnectDevicePath (Instance
);
463 if (!EFI_ERROR (Status
)) {
469 // Come here means the first instance is not matched
473 } while (TempNewDevicePath
!= NULL
);
477 // Find the matched device path.
478 // Append the file path information from the boot option and return the fully expanded device path.
480 DevicePath
= NextDevicePathNode ((EFI_DEVICE_PATH_PROTOCOL
*) HardDriveDevicePath
);
481 FullDevicePath
= AppendDevicePath (Instance
, DevicePath
);
484 // Adjust the 'HDDP' instances sequence if the matched one is not first one.
488 // First delete the matched instance.
490 TempNewDevicePath
= CachedDevicePath
;
491 CachedDevicePath
= BdsLibDelPartMatchInstance (CachedDevicePath
, Instance
);
492 FreePool (TempNewDevicePath
);
495 // Second, append the remaining path after the matched instance
497 TempNewDevicePath
= CachedDevicePath
;
498 CachedDevicePath
= AppendDevicePathInstance (Instance
, CachedDevicePath
);
499 FreePool (TempNewDevicePath
);
501 // Save the matching Device Path so we don't need to do a connect all next time
503 Status
= gRT
->SetVariable (
505 &mHdBootVariablePrivateGuid
,
506 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
507 GetDevicePathSize (CachedDevicePath
),
513 FreePool (CachedDevicePath
);
514 return FullDevicePath
;
519 // If we get here we fail to find or 'HDDP' not exist, and now we need
520 // to search all devices in the system for a matched partition
522 BdsLibConnectAllDriversToAllControllers ();
523 Status
= gBS
->LocateHandleBuffer (ByProtocol
, &gEfiBlockIoProtocolGuid
, NULL
, &BlockIoHandleCount
, &BlockIoBuffer
);
524 if (EFI_ERROR (Status
) || BlockIoHandleCount
== 0 || BlockIoBuffer
== NULL
) {
526 // If there was an error or there are no device handles that support
527 // the BLOCK_IO Protocol, then return.
532 // Loop through all the device handles that support the BLOCK_IO Protocol
534 for (Index
= 0; Index
< BlockIoHandleCount
; Index
++) {
536 Status
= gBS
->HandleProtocol (BlockIoBuffer
[Index
], &gEfiDevicePathProtocolGuid
, (VOID
*) &BlockIoDevicePath
);
537 if (EFI_ERROR (Status
) || BlockIoDevicePath
== NULL
) {
541 if (MatchPartitionDevicePathNode (BlockIoDevicePath
, HardDriveDevicePath
)) {
543 // Find the matched partition device path
545 DevicePath
= NextDevicePathNode ((EFI_DEVICE_PATH_PROTOCOL
*) HardDriveDevicePath
);
546 FullDevicePath
= AppendDevicePath (BlockIoDevicePath
, DevicePath
);
549 // Save the matched partition device path in 'HDDP' variable
551 if (CachedDevicePath
!= NULL
) {
553 // Save the matched partition device path as first instance of 'HDDP' variable
555 if (BdsLibMatchDevicePaths (CachedDevicePath
, BlockIoDevicePath
)) {
556 TempNewDevicePath
= CachedDevicePath
;
557 CachedDevicePath
= BdsLibDelPartMatchInstance (CachedDevicePath
, BlockIoDevicePath
);
558 FreePool(TempNewDevicePath
);
560 TempNewDevicePath
= CachedDevicePath
;
561 CachedDevicePath
= AppendDevicePathInstance (BlockIoDevicePath
, CachedDevicePath
);
562 if (TempNewDevicePath
!= NULL
) {
563 FreePool(TempNewDevicePath
);
566 TempNewDevicePath
= CachedDevicePath
;
567 CachedDevicePath
= AppendDevicePathInstance (BlockIoDevicePath
, CachedDevicePath
);
568 FreePool(TempNewDevicePath
);
571 // Here limit the device path instance number to 12, which is max number for a system support 3 IDE controller
572 // If the user try to boot many OS in different HDs or partitions, in theory, the 'HDDP' variable maybe become larger and larger.
575 ASSERT (CachedDevicePath
!= NULL
);
576 TempNewDevicePath
= CachedDevicePath
;
577 while (!IsDevicePathEnd (TempNewDevicePath
)) {
578 TempNewDevicePath
= NextDevicePathNode (TempNewDevicePath
);
580 // Parse one instance
582 while (!IsDevicePathEndType (TempNewDevicePath
)) {
583 TempNewDevicePath
= NextDevicePathNode (TempNewDevicePath
);
587 // If the CachedDevicePath variable contain too much instance, only remain 12 instances.
589 if (InstanceNum
>= 12) {
590 SetDevicePathEndNode (TempNewDevicePath
);
595 CachedDevicePath
= DuplicateDevicePath (BlockIoDevicePath
);
599 // Save the matching Device Path so we don't need to do a connect all next time
601 Status
= gRT
->SetVariable (
603 &mHdBootVariablePrivateGuid
,
604 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
605 GetDevicePathSize (CachedDevicePath
),
613 if (CachedDevicePath
!= NULL
) {
614 FreePool (CachedDevicePath
);
616 if (BlockIoBuffer
!= NULL
) {
617 FreePool (BlockIoBuffer
);
619 return FullDevicePath
;
623 Check whether there is a instance in BlockIoDevicePath, which contain multi device path
624 instances, has the same partition node with HardDriveDevicePath device path
626 @param BlockIoDevicePath Multi device path instances which need to check
627 @param HardDriveDevicePath A device path which starts with a hard drive media
630 @retval TRUE There is a matched device path instance.
631 @retval FALSE There is no matched device path instance.
636 MatchPartitionDevicePathNode (
637 IN EFI_DEVICE_PATH_PROTOCOL
*BlockIoDevicePath
,
638 IN HARDDRIVE_DEVICE_PATH
*HardDriveDevicePath
641 HARDDRIVE_DEVICE_PATH
*TmpHdPath
;
642 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
644 EFI_DEVICE_PATH_PROTOCOL
*BlockIoHdDevicePathNode
;
646 if ((BlockIoDevicePath
== NULL
) || (HardDriveDevicePath
== NULL
)) {
651 // Make PreviousDevicePath == the device path node before the end node
653 DevicePath
= BlockIoDevicePath
;
654 BlockIoHdDevicePathNode
= NULL
;
657 // find the partition device path node
659 while (!IsDevicePathEnd (DevicePath
)) {
660 if ((DevicePathType (DevicePath
) == MEDIA_DEVICE_PATH
) &&
661 (DevicePathSubType (DevicePath
) == MEDIA_HARDDRIVE_DP
)
663 BlockIoHdDevicePathNode
= DevicePath
;
667 DevicePath
= NextDevicePathNode (DevicePath
);
670 if (BlockIoHdDevicePathNode
== NULL
) {
674 // See if the harddrive device path in blockio matches the orig Hard Drive Node
676 TmpHdPath
= (HARDDRIVE_DEVICE_PATH
*) BlockIoHdDevicePathNode
;
680 // Check for the match
682 if ((TmpHdPath
->MBRType
== HardDriveDevicePath
->MBRType
) &&
683 (TmpHdPath
->SignatureType
== HardDriveDevicePath
->SignatureType
)) {
684 switch (TmpHdPath
->SignatureType
) {
685 case SIGNATURE_TYPE_GUID
:
686 Match
= CompareGuid ((EFI_GUID
*)TmpHdPath
->Signature
, (EFI_GUID
*)HardDriveDevicePath
->Signature
);
688 case SIGNATURE_TYPE_MBR
:
689 Match
= (BOOLEAN
)(*((UINT32
*)(&(TmpHdPath
->Signature
[0]))) == ReadUnaligned32((UINT32
*)(&(HardDriveDevicePath
->Signature
[0]))));
701 Delete the boot option associated with the handle passed in.
703 @param Handle The handle which present the device path to create
706 @retval EFI_SUCCESS Delete the boot option success
707 @retval EFI_NOT_FOUND If the Device Path is not found in the system
708 @retval EFI_OUT_OF_RESOURCES Lack of memory resource
709 @retval Other Error return value from SetVariable()
713 BdsLibDeleteOptionFromHandle (
718 UINT8
*BootOptionVar
;
720 UINTN BootOptionSize
;
723 UINT16 BootOption
[BOOT_OPTION_MAX_CHAR
];
724 UINTN DevicePathSize
;
725 UINTN OptionDevicePathSize
;
726 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
727 EFI_DEVICE_PATH_PROTOCOL
*OptionDevicePath
;
730 Status
= EFI_SUCCESS
;
735 // Check "BootOrder" variable, if no, means there is no any boot order.
737 BootOrder
= BdsLibGetVariableAndSize (
739 &gEfiGlobalVariableGuid
,
742 if (BootOrder
== NULL
) {
743 return EFI_NOT_FOUND
;
747 // Convert device handle to device path protocol instance
749 DevicePath
= DevicePathFromHandle (Handle
);
750 if (DevicePath
== NULL
) {
751 return EFI_NOT_FOUND
;
753 DevicePathSize
= GetDevicePathSize (DevicePath
);
756 // Loop all boot order variable and find the matching device path
759 while (Index
< BootOrderSize
/ sizeof (UINT16
)) {
760 UnicodeSPrint (BootOption
, sizeof (BootOption
), L
"Boot%04x", BootOrder
[Index
]);
761 BootOptionVar
= BdsLibGetVariableAndSize (
763 &gEfiGlobalVariableGuid
,
767 if (BootOptionVar
== NULL
) {
768 FreePool (BootOrder
);
769 return EFI_OUT_OF_RESOURCES
;
772 TempPtr
= BootOptionVar
;
773 TempPtr
+= sizeof (UINT32
) + sizeof (UINT16
);
774 TempPtr
+= StrSize ((CHAR16
*) TempPtr
);
775 OptionDevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) TempPtr
;
776 OptionDevicePathSize
= GetDevicePathSize (OptionDevicePath
);
779 // Check whether the device path match
781 if ((OptionDevicePathSize
== DevicePathSize
) &&
782 (CompareMem (DevicePath
, OptionDevicePath
, DevicePathSize
) == 0)) {
783 BdsDeleteBootOption (BootOrder
[Index
], BootOrder
, &BootOrderSize
);
784 FreePool (BootOptionVar
);
788 FreePool (BootOptionVar
);
793 // Adjust number of boot option for "BootOrder" variable.
795 Status
= gRT
->SetVariable (
797 &gEfiGlobalVariableGuid
,
798 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
803 FreePool (BootOrder
);
810 Delete all invalid EFI boot options.
812 @retval EFI_SUCCESS Delete all invalid boot option success
813 @retval EFI_NOT_FOUND Variable "BootOrder" is not found
814 @retval EFI_OUT_OF_RESOURCES Lack of memory resource
815 @retval Other Error return value from SetVariable()
819 BdsDeleteAllInvalidEfiBootOption (
824 UINT8
*BootOptionVar
;
826 UINTN BootOptionSize
;
830 UINT16 BootOption
[BOOT_OPTION_MAX_CHAR
];
831 EFI_DEVICE_PATH_PROTOCOL
*OptionDevicePath
;
835 Status
= EFI_SUCCESS
;
840 // Check "BootOrder" variable firstly, this variable hold the number of boot options
842 BootOrder
= BdsLibGetVariableAndSize (
844 &gEfiGlobalVariableGuid
,
847 if (NULL
== BootOrder
) {
848 return EFI_NOT_FOUND
;
852 while (Index
< BootOrderSize
/ sizeof (UINT16
)) {
853 UnicodeSPrint (BootOption
, sizeof (BootOption
), L
"Boot%04x", BootOrder
[Index
]);
854 BootOptionVar
= BdsLibGetVariableAndSize (
856 &gEfiGlobalVariableGuid
,
859 if (NULL
== BootOptionVar
) {
860 FreePool (BootOrder
);
861 return EFI_OUT_OF_RESOURCES
;
864 TempPtr
= BootOptionVar
;
865 TempPtr
+= sizeof (UINT32
) + sizeof (UINT16
);
866 Description
= (CHAR16
*) TempPtr
;
867 TempPtr
+= StrSize ((CHAR16
*) TempPtr
);
868 OptionDevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) TempPtr
;
871 // Skip legacy boot option (BBS boot device)
873 if ((DevicePathType (OptionDevicePath
) == BBS_DEVICE_PATH
) &&
874 (DevicePathSubType (OptionDevicePath
) == BBS_BBS_DP
)) {
875 FreePool (BootOptionVar
);
880 if (!BdsLibIsValidEFIBootOptDevicePathExt (OptionDevicePath
, FALSE
, Description
)) {
882 // Delete this invalid boot option "Boot####"
884 Status
= gRT
->SetVariable (
886 &gEfiGlobalVariableGuid
,
887 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
892 // Mark this boot option in boot order as deleted
894 BootOrder
[Index
] = 0xffff;
897 FreePool (BootOptionVar
);
902 // Adjust boot order array
905 for (Index
= 0; Index
< BootOrderSize
/ sizeof (UINT16
); Index
++) {
906 if (BootOrder
[Index
] != 0xffff) {
907 BootOrder
[Index2
] = BootOrder
[Index
];
911 Status
= gRT
->SetVariable (
913 &gEfiGlobalVariableGuid
,
914 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
915 Index2
* sizeof (UINT16
),
919 FreePool (BootOrder
);
926 For EFI boot option, BDS separate them as six types:
927 1. Network - The boot option points to the SimpleNetworkProtocol device.
928 Bds will try to automatically create this type boot option when enumerate.
929 2. Shell - The boot option points to internal flash shell.
930 Bds will try to automatically create this type boot option when enumerate.
931 3. Removable BlockIo - The boot option only points to the removable media
932 device, like USB flash disk, DVD, Floppy etc.
933 These device should contain a *removable* blockIo
934 protocol in their device handle.
935 Bds will try to automatically create this type boot option
937 4. Fixed BlockIo - The boot option only points to a Fixed blockIo device,
939 These device should contain a *fixed* blockIo
940 protocol in their device handle.
941 BDS will skip fixed blockIo devices, and NOT
942 automatically create boot option for them. But BDS
943 will help to delete those fixed blockIo boot option,
944 whose description rule conflict with other auto-created
946 5. Non-BlockIo Simplefile - The boot option points to a device whose handle
947 has SimpleFileSystem Protocol, but has no blockio
948 protocol. These devices do not offer blockIo
949 protocol, but BDS still can get the
950 \EFI\BOOT\boot{machinename}.EFI by SimpleFileSystem
952 6. File - The boot option points to a file. These boot options are usually
953 created by user manually or OS loader. BDS will not delete or modify
956 This function will enumerate all possible boot device in the system, and
957 automatically create boot options for Network, Shell, Removable BlockIo,
958 and Non-BlockIo Simplefile devices.
959 It will only execute once of every boot.
961 @param BdsBootOptionList The header of the link list which indexed all
964 @retval EFI_SUCCESS Finished all the boot device enumerate and create
965 the boot option base on that boot device
967 @retval EFI_OUT_OF_RESOURCES Failed to enumerate the boot device and create the boot option list
971 BdsLibEnumerateAllBootOption (
972 IN OUT LIST_ENTRY
*BdsBootOptionList
981 UINT16 NonBlockNumber
;
982 UINTN NumberBlockIoHandles
;
983 EFI_HANDLE
*BlockIoHandles
;
984 EFI_BLOCK_IO_PROTOCOL
*BlkIo
;
986 UINTN NumOfLoadFileHandles
;
987 EFI_HANDLE
*LoadFileHandles
;
989 EFI_HANDLE
*FvHandleBuffer
;
990 EFI_FV_FILETYPE Type
;
992 EFI_FV_FILE_ATTRIBUTES Attributes
;
993 UINT32 AuthenticationStatus
;
994 EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
;
995 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
996 UINTN DevicePathType
;
998 EFI_HANDLE
*FileSystemHandles
;
999 UINTN NumberFileSystemHandles
;
1001 EFI_IMAGE_DOS_HEADER DosHeader
;
1004 EFI_IMAGE_OPTIONAL_HEADER_UNION HdrData
;
1005 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
;
1014 ZeroMem (Buffer
, sizeof (Buffer
));
1017 // If the boot device enumerate happened, just get the boot
1018 // device from the boot order variable
1020 if (mEnumBootDevice
) {
1021 LastLang
= GetVariable (L
"LastEnumLang", &mBdsLibLastLangGuid
);
1022 PlatLang
= GetEfiGlobalVariable (L
"PlatformLang");
1023 ASSERT (PlatLang
!= NULL
);
1024 if ((LastLang
!= NULL
) && (AsciiStrCmp (LastLang
, PlatLang
) == 0)) {
1025 Status
= BdsLibBuildOptionFromVar (BdsBootOptionList
, L
"BootOrder");
1026 FreePool (LastLang
);
1027 FreePool (PlatLang
);
1030 Status
= gRT
->SetVariable (
1032 &mBdsLibLastLangGuid
,
1033 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
1034 AsciiStrSize (PlatLang
),
1037 ASSERT_EFI_ERROR (Status
);
1039 if (LastLang
!= NULL
) {
1040 FreePool (LastLang
);
1042 FreePool (PlatLang
);
1047 // Notes: this dirty code is to get the legacy boot option from the
1048 // BBS table and create to variable as the EFI boot option, it should
1049 // be removed after the CSM can provide legacy boot option directly
1051 REFRESH_LEGACY_BOOT_OPTIONS
;
1054 // Delete invalid boot option
1056 BdsDeleteAllInvalidEfiBootOption ();
1059 // Parse removable media
1061 gBS
->LocateHandleBuffer (
1063 &gEfiBlockIoProtocolGuid
,
1065 &NumberBlockIoHandles
,
1069 for (Index
= 0; Index
< NumberBlockIoHandles
; Index
++) {
1070 Status
= gBS
->HandleProtocol (
1071 BlockIoHandles
[Index
],
1072 &gEfiBlockIoProtocolGuid
,
1075 if (!EFI_ERROR (Status
)) {
1076 if (!BlkIo
->Media
->RemovableMedia
) {
1078 // skip the non-removable block devices
1083 DevicePath
= DevicePathFromHandle (BlockIoHandles
[Index
]);
1084 DevicePathType
= BdsGetBootTypeFromDevicePath (DevicePath
);
1086 switch (DevicePathType
) {
1087 case BDS_EFI_ACPI_FLOPPY_BOOT
:
1088 if (FloppyNumber
!= 0) {
1089 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_FLOPPY
)), FloppyNumber
);
1091 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_FLOPPY
)));
1093 BdsLibBuildOptionFromHandle (BlockIoHandles
[Index
], BdsBootOptionList
, Buffer
);
1098 // Assume a removable SATA device should be the DVD/CD device
1100 case BDS_EFI_MESSAGE_ATAPI_BOOT
:
1101 case BDS_EFI_MESSAGE_SATA_BOOT
:
1102 if (CdromNumber
!= 0) {
1103 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_CD_DVD
)), CdromNumber
);
1105 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_CD_DVD
)));
1107 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Buffer: %S\n", Buffer
));
1108 BdsLibBuildOptionFromHandle (BlockIoHandles
[Index
], BdsBootOptionList
, Buffer
);
1112 case BDS_EFI_MESSAGE_USB_DEVICE_BOOT
:
1113 if (UsbNumber
!= 0) {
1114 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_USB
)), UsbNumber
);
1116 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_USB
)));
1118 BdsLibBuildOptionFromHandle (BlockIoHandles
[Index
], BdsBootOptionList
, Buffer
);
1122 case BDS_EFI_MESSAGE_SCSI_BOOT
:
1123 if (ScsiNumber
!= 0) {
1124 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_SCSI
)), ScsiNumber
);
1126 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_SCSI
)));
1128 BdsLibBuildOptionFromHandle (BlockIoHandles
[Index
], BdsBootOptionList
, Buffer
);
1132 case BDS_EFI_MESSAGE_MISC_BOOT
:
1133 if (MiscNumber
!= 0) {
1134 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_MISC
)), MiscNumber
);
1136 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_MISC
)));
1138 BdsLibBuildOptionFromHandle (BlockIoHandles
[Index
], BdsBootOptionList
, Buffer
);
1147 if (NumberBlockIoHandles
!= 0) {
1148 FreePool (BlockIoHandles
);
1152 // If there is simple file protocol which does not consume block Io protocol, create a boot option for it here.
1155 gBS
->LocateHandleBuffer (
1157 &gEfiSimpleFileSystemProtocolGuid
,
1159 &NumberFileSystemHandles
,
1162 for (Index
= 0; Index
< NumberFileSystemHandles
; Index
++) {
1163 Status
= gBS
->HandleProtocol (
1164 FileSystemHandles
[Index
],
1165 &gEfiBlockIoProtocolGuid
,
1168 if (!EFI_ERROR (Status
)) {
1170 // Skip if the file system handle supports a BlkIo protocol,
1176 // Do the removable Media thing. \EFI\BOOT\boot{machinename}.EFI
1177 // machinename is ia32, ia64, x64, ...
1179 Hdr
.Union
= &HdrData
;
1181 Status
= BdsLibGetImageHeader (
1182 FileSystemHandles
[Index
],
1183 EFI_REMOVABLE_MEDIA_FILE_NAME
,
1187 if (!EFI_ERROR (Status
) &&
1188 EFI_IMAGE_MACHINE_TYPE_SUPPORTED (Hdr
.Pe32
->FileHeader
.Machine
) &&
1189 Hdr
.Pe32
->OptionalHeader
.Subsystem
== EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION
) {
1195 // No such file or the file is not a EFI application, delete this boot option
1197 BdsLibDeleteOptionFromHandle (FileSystemHandles
[Index
]);
1199 if (NonBlockNumber
!= 0) {
1200 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NON_BLOCK
)), NonBlockNumber
);
1202 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NON_BLOCK
)));
1204 BdsLibBuildOptionFromHandle (FileSystemHandles
[Index
], BdsBootOptionList
, Buffer
);
1209 if (NumberFileSystemHandles
!= 0) {
1210 FreePool (FileSystemHandles
);
1214 // Parse Network Boot Device
1216 NumOfLoadFileHandles
= 0;
1218 // Search Load File protocol for PXE boot option.
1220 gBS
->LocateHandleBuffer (
1222 &gEfiLoadFileProtocolGuid
,
1224 &NumOfLoadFileHandles
,
1228 for (Index
= 0; Index
< NumOfLoadFileHandles
; Index
++) {
1230 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NETWORK
)), Index
);
1232 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NETWORK
)));
1234 BdsLibBuildOptionFromHandle (LoadFileHandles
[Index
], BdsBootOptionList
, Buffer
);
1237 if (NumOfLoadFileHandles
!= 0) {
1238 FreePool (LoadFileHandles
);
1242 // Check if we have on flash shell
1244 gBS
->LocateHandleBuffer (
1246 &gEfiFirmwareVolume2ProtocolGuid
,
1251 for (Index
= 0; Index
< FvHandleCount
; Index
++) {
1252 gBS
->HandleProtocol (
1253 FvHandleBuffer
[Index
],
1254 &gEfiFirmwareVolume2ProtocolGuid
,
1258 Status
= Fv
->ReadFile (
1260 PcdGetPtr(PcdShellFile
),
1265 &AuthenticationStatus
1267 if (EFI_ERROR (Status
)) {
1269 // Skip if no shell file in the FV
1274 // Build the shell boot option
1276 BdsLibBuildOptionFromShell (FvHandleBuffer
[Index
], BdsBootOptionList
);
1279 if (FvHandleCount
!= 0) {
1280 FreePool (FvHandleBuffer
);
1283 // Make sure every boot only have one time
1284 // boot device enumerate
1286 Status
= BdsLibBuildOptionFromVar (BdsBootOptionList
, L
"BootOrder");
1287 mEnumBootDevice
= TRUE
;
1293 Build the boot option with the handle parsed in
1295 @param Handle The handle which present the device path to create
1297 @param BdsBootOptionList The header of the link list which indexed all
1298 current boot options
1299 @param String The description of the boot option.
1304 BdsLibBuildOptionFromHandle (
1305 IN EFI_HANDLE Handle
,
1306 IN LIST_ENTRY
*BdsBootOptionList
,
1310 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1312 DevicePath
= DevicePathFromHandle (Handle
);
1315 // Create and register new boot option
1317 BdsLibRegisterNewOption (BdsBootOptionList
, DevicePath
, String
, L
"BootOrder");
1322 Build the on flash shell boot option with the handle parsed in.
1324 @param Handle The handle which present the device path to create
1325 on flash shell boot option
1326 @param BdsBootOptionList The header of the link list which indexed all
1327 current boot options
1332 BdsLibBuildOptionFromShell (
1333 IN EFI_HANDLE Handle
,
1334 IN OUT LIST_ENTRY
*BdsBootOptionList
1337 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1338 MEDIA_FW_VOL_FILEPATH_DEVICE_PATH ShellNode
;
1340 DevicePath
= DevicePathFromHandle (Handle
);
1343 // Build the shell device path
1345 EfiInitializeFwVolDevicepathNode (&ShellNode
, PcdGetPtr(PcdShellFile
));
1347 DevicePath
= AppendDevicePathNode (DevicePath
, (EFI_DEVICE_PATH_PROTOCOL
*) &ShellNode
);
1350 // Create and register the shell boot option
1352 BdsLibRegisterNewOption (BdsBootOptionList
, DevicePath
, L
"EFI Internal Shell", L
"BootOrder");
1357 Boot from the UEFI spec defined "BootNext" variable.
1369 BDS_COMMON_OPTION
*BootOption
;
1370 LIST_ENTRY TempList
;
1375 // Init the boot option name buffer and temp link list
1377 InitializeListHead (&TempList
);
1378 ZeroMem (Buffer
, sizeof (Buffer
));
1380 BootNext
= BdsLibGetVariableAndSize (
1382 &gEfiGlobalVariableGuid
,
1387 // Clear the boot next variable first
1389 if (BootNext
!= NULL
) {
1392 &gEfiGlobalVariableGuid
,
1393 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
1399 // Start to build the boot option and try to boot
1401 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"Boot%04x", *BootNext
);
1402 BootOption
= BdsLibVariableToOption (&TempList
, Buffer
);
1403 ASSERT (BootOption
!= NULL
);
1404 BdsLibConnectDevicePath (BootOption
->DevicePath
);
1405 BdsLibBootViaBootOption (BootOption
, BootOption
->DevicePath
, &ExitDataSize
, &ExitData
);
1411 Return the bootable media handle.
1412 First, check the device is connected
1413 Second, check whether the device path point to a device which support SimpleFileSystemProtocol,
1414 Third, detect the the default boot file in the Media, and return the removable Media handle.
1416 @param DevicePath Device Path to a bootable device
1418 @return The bootable media handle. If the media on the DevicePath is not bootable, NULL will return.
1423 BdsLibGetBootableHandle (
1424 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
1428 EFI_DEVICE_PATH_PROTOCOL
*UpdatedDevicePath
;
1429 EFI_DEVICE_PATH_PROTOCOL
*DupDevicePath
;
1431 EFI_BLOCK_IO_PROTOCOL
*BlockIo
;
1433 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
1436 EFI_HANDLE ReturnHandle
;
1437 EFI_HANDLE
*SimpleFileSystemHandles
;
1439 UINTN NumberSimpleFileSystemHandles
;
1441 EFI_IMAGE_DOS_HEADER DosHeader
;
1442 EFI_IMAGE_OPTIONAL_HEADER_UNION HdrData
;
1443 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
;
1445 UpdatedDevicePath
= DevicePath
;
1448 // Check whether the device is connected
1450 Status
= gBS
->LocateDevicePath (&gEfiBlockIoProtocolGuid
, &UpdatedDevicePath
, &Handle
);
1451 if (EFI_ERROR (Status
)) {
1453 // Skip the case that the boot option point to a simple file protocol which does not consume block Io protocol,
1455 Status
= gBS
->LocateDevicePath (&gEfiSimpleFileSystemProtocolGuid
, &UpdatedDevicePath
, &Handle
);
1456 if (EFI_ERROR (Status
)) {
1458 // Fail to find the proper BlockIo and simple file protocol, maybe because device not present, we need to connect it firstly
1460 UpdatedDevicePath
= DevicePath
;
1461 Status
= gBS
->LocateDevicePath (&gEfiDevicePathProtocolGuid
, &UpdatedDevicePath
, &Handle
);
1462 gBS
->ConnectController (Handle
, NULL
, NULL
, TRUE
);
1466 // For removable device boot option, its contained device path only point to the removable device handle,
1467 // should make sure all its children handles (its child partion or media handles) are created and connected.
1469 gBS
->ConnectController (Handle
, NULL
, NULL
, TRUE
);
1471 // Get BlockIo protocol and check removable attribute
1473 Status
= gBS
->HandleProtocol (Handle
, &gEfiBlockIoProtocolGuid
, (VOID
**)&BlockIo
);
1475 // Issue a dummy read to the device to check for media change.
1476 // When the removable media is changed, any Block IO read/write will
1477 // cause the BlockIo protocol be reinstalled and EFI_MEDIA_CHANGED is
1478 // returned. After the Block IO protocol is reinstalled, subsequent
1479 // Block IO read/write will success.
1481 Buffer
= AllocatePool (BlockIo
->Media
->BlockSize
);
1482 if (Buffer
!= NULL
) {
1483 BlockIo
->ReadBlocks (
1485 BlockIo
->Media
->MediaId
,
1487 BlockIo
->Media
->BlockSize
,
1495 // Detect the the default boot file from removable Media
1499 // If fail to get bootable handle specified by a USB boot option, the BDS should try to find other bootable device in the same USB bus
1500 // Try to locate the USB node device path first, if fail then use its previous PCI node to search
1502 DupDevicePath
= DuplicateDevicePath (DevicePath
);
1503 ASSERT (DupDevicePath
!= NULL
);
1505 UpdatedDevicePath
= DupDevicePath
;
1506 Status
= gBS
->LocateDevicePath (&gEfiDevicePathProtocolGuid
, &UpdatedDevicePath
, &Handle
);
1508 // if the resulting device path point to a usb node, and the usb node is a dummy node, should only let device path only point to the previous Pci node
1509 // Acpi()/Pci()/Usb() --> Acpi()/Pci()
1511 if ((DevicePathType (UpdatedDevicePath
) == MESSAGING_DEVICE_PATH
) &&
1512 (DevicePathSubType (UpdatedDevicePath
) == MSG_USB_DP
)) {
1514 // Remove the usb node, let the device path only point to PCI node
1516 SetDevicePathEndNode (UpdatedDevicePath
);
1517 UpdatedDevicePath
= DupDevicePath
;
1519 UpdatedDevicePath
= DevicePath
;
1523 // Get the device path size of boot option
1525 Size
= GetDevicePathSize(UpdatedDevicePath
) - sizeof (EFI_DEVICE_PATH_PROTOCOL
); // minus the end node
1526 ReturnHandle
= NULL
;
1527 gBS
->LocateHandleBuffer (
1529 &gEfiSimpleFileSystemProtocolGuid
,
1531 &NumberSimpleFileSystemHandles
,
1532 &SimpleFileSystemHandles
1534 for (Index
= 0; Index
< NumberSimpleFileSystemHandles
; Index
++) {
1536 // Get the device path size of SimpleFileSystem handle
1538 TempDevicePath
= DevicePathFromHandle (SimpleFileSystemHandles
[Index
]);
1539 TempSize
= GetDevicePathSize (TempDevicePath
)- sizeof (EFI_DEVICE_PATH_PROTOCOL
); // minus the end node
1541 // Check whether the device path of boot option is part of the SimpleFileSystem handle's device path
1543 if (Size
<= TempSize
&& CompareMem (TempDevicePath
, UpdatedDevicePath
, Size
)==0) {
1545 // Load the default boot file \EFI\BOOT\boot{machinename}.EFI from removable Media
1546 // machinename is ia32, ia64, x64, ...
1548 Hdr
.Union
= &HdrData
;
1549 Status
= BdsLibGetImageHeader (
1550 SimpleFileSystemHandles
[Index
],
1551 EFI_REMOVABLE_MEDIA_FILE_NAME
,
1555 if (!EFI_ERROR (Status
) &&
1556 EFI_IMAGE_MACHINE_TYPE_SUPPORTED (Hdr
.Pe32
->FileHeader
.Machine
) &&
1557 Hdr
.Pe32
->OptionalHeader
.Subsystem
== EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION
) {
1558 ReturnHandle
= SimpleFileSystemHandles
[Index
];
1564 FreePool(DupDevicePath
);
1566 if (SimpleFileSystemHandles
!= NULL
) {
1567 FreePool(SimpleFileSystemHandles
);
1570 return ReturnHandle
;
1574 Check to see if the network cable is plugged in. If the DevicePath is not
1575 connected it will be connected.
1577 @param DevicePath Device Path to check
1579 @retval TRUE DevicePath points to an Network that is connected
1580 @retval FALSE DevicePath does not point to a bootable network
1584 BdsLibNetworkBootWithMediaPresent (
1585 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
1589 EFI_DEVICE_PATH_PROTOCOL
*UpdatedDevicePath
;
1591 EFI_SIMPLE_NETWORK_PROTOCOL
*Snp
;
1592 BOOLEAN MediaPresent
;
1593 UINT32 InterruptStatus
;
1595 MediaPresent
= FALSE
;
1597 UpdatedDevicePath
= DevicePath
;
1599 // Locate Load File Protocol for PXE boot option first
1601 Status
= gBS
->LocateDevicePath (&gEfiLoadFileProtocolGuid
, &UpdatedDevicePath
, &Handle
);
1602 if (EFI_ERROR (Status
)) {
1604 // Device not present so see if we need to connect it
1606 Status
= BdsLibConnectDevicePath (DevicePath
);
1607 if (!EFI_ERROR (Status
)) {
1609 // This one should work after we did the connect
1611 Status
= gBS
->LocateDevicePath (&gEfiLoadFileProtocolGuid
, &UpdatedDevicePath
, &Handle
);
1615 if (!EFI_ERROR (Status
)) {
1616 Status
= gBS
->HandleProtocol (Handle
, &gEfiSimpleNetworkProtocolGuid
, (VOID
**)&Snp
);
1617 if (EFI_ERROR (Status
)) {
1619 // Failed to open SNP from this handle, try to get SNP from parent handle
1621 UpdatedDevicePath
= DevicePathFromHandle (Handle
);
1622 if (UpdatedDevicePath
!= NULL
) {
1623 Status
= gBS
->LocateDevicePath (&gEfiSimpleNetworkProtocolGuid
, &UpdatedDevicePath
, &Handle
);
1624 if (!EFI_ERROR (Status
)) {
1626 // SNP handle found, get SNP from it
1628 Status
= gBS
->HandleProtocol (Handle
, &gEfiSimpleNetworkProtocolGuid
, (VOID
**) &Snp
);
1633 if (!EFI_ERROR (Status
)) {
1634 if (Snp
->Mode
->MediaPresentSupported
) {
1635 if (Snp
->Mode
->State
== EfiSimpleNetworkInitialized
) {
1637 // Invoke Snp->GetStatus() to refresh the media status
1639 Snp
->GetStatus (Snp
, &InterruptStatus
, NULL
);
1642 // In case some one else is using the SNP check to see if it's connected
1644 MediaPresent
= Snp
->Mode
->MediaPresent
;
1647 // No one is using SNP so we need to Start and Initialize so
1648 // MediaPresent will be valid.
1650 Status
= Snp
->Start (Snp
);
1651 if (!EFI_ERROR (Status
)) {
1652 Status
= Snp
->Initialize (Snp
, 0, 0);
1653 if (!EFI_ERROR (Status
)) {
1654 MediaPresent
= Snp
->Mode
->MediaPresent
;
1655 Snp
->Shutdown (Snp
);
1661 MediaPresent
= TRUE
;
1666 return MediaPresent
;
1670 For a bootable Device path, return its boot type.
1672 @param DevicePath The bootable device Path to check
1674 @retval BDS_EFI_MEDIA_HD_BOOT If given device path contains MEDIA_DEVICE_PATH type device path node
1675 which subtype is MEDIA_HARDDRIVE_DP
1676 @retval BDS_EFI_MEDIA_CDROM_BOOT If given device path contains MEDIA_DEVICE_PATH type device path node
1677 which subtype is MEDIA_CDROM_DP
1678 @retval BDS_EFI_ACPI_FLOPPY_BOOT If given device path contains ACPI_DEVICE_PATH type device path node
1679 which HID is floppy device.
1680 @retval BDS_EFI_MESSAGE_ATAPI_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node
1681 and its last device path node's subtype is MSG_ATAPI_DP.
1682 @retval BDS_EFI_MESSAGE_SCSI_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node
1683 and its last device path node's subtype is MSG_SCSI_DP.
1684 @retval BDS_EFI_MESSAGE_USB_DEVICE_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node
1685 and its last device path node's subtype is MSG_USB_DP.
1686 @retval BDS_EFI_MESSAGE_MISC_BOOT If the device path not contains any media device path node, and
1687 its last device path node point to a message device path node.
1688 @retval BDS_LEGACY_BBS_BOOT If given device path contains BBS_DEVICE_PATH type device path node.
1689 @retval BDS_EFI_UNSUPPORT An EFI Removable BlockIO device path not point to a media and message device,
1694 BdsGetBootTypeFromDevicePath (
1695 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
1698 ACPI_HID_DEVICE_PATH
*Acpi
;
1699 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
1700 EFI_DEVICE_PATH_PROTOCOL
*LastDeviceNode
;
1703 if (NULL
== DevicePath
) {
1704 return BDS_EFI_UNSUPPORT
;
1707 TempDevicePath
= DevicePath
;
1709 while (!IsDevicePathEndType (TempDevicePath
)) {
1710 switch (DevicePathType (TempDevicePath
)) {
1711 case BBS_DEVICE_PATH
:
1712 return BDS_LEGACY_BBS_BOOT
;
1713 case MEDIA_DEVICE_PATH
:
1714 if (DevicePathSubType (TempDevicePath
) == MEDIA_HARDDRIVE_DP
) {
1715 return BDS_EFI_MEDIA_HD_BOOT
;
1716 } else if (DevicePathSubType (TempDevicePath
) == MEDIA_CDROM_DP
) {
1717 return BDS_EFI_MEDIA_CDROM_BOOT
;
1720 case ACPI_DEVICE_PATH
:
1721 Acpi
= (ACPI_HID_DEVICE_PATH
*) TempDevicePath
;
1722 if (EISA_ID_TO_NUM (Acpi
->HID
) == 0x0604) {
1723 return BDS_EFI_ACPI_FLOPPY_BOOT
;
1726 case MESSAGING_DEVICE_PATH
:
1728 // Get the last device path node
1730 LastDeviceNode
= NextDevicePathNode (TempDevicePath
);
1731 if (DevicePathSubType(LastDeviceNode
) == MSG_DEVICE_LOGICAL_UNIT_DP
) {
1733 // if the next node type is Device Logical Unit, which specify the Logical Unit Number (LUN),
1736 LastDeviceNode
= NextDevicePathNode (LastDeviceNode
);
1739 // if the device path not only point to driver device, it is not a messaging device path,
1741 if (!IsDevicePathEndType (LastDeviceNode
)) {
1745 switch (DevicePathSubType (TempDevicePath
)) {
1747 BootType
= BDS_EFI_MESSAGE_ATAPI_BOOT
;
1751 BootType
= BDS_EFI_MESSAGE_USB_DEVICE_BOOT
;
1755 BootType
= BDS_EFI_MESSAGE_SCSI_BOOT
;
1759 BootType
= BDS_EFI_MESSAGE_SATA_BOOT
;
1762 case MSG_MAC_ADDR_DP
:
1766 BootType
= BDS_EFI_MESSAGE_MAC_BOOT
;
1770 BootType
= BDS_EFI_MESSAGE_MISC_BOOT
;
1778 TempDevicePath
= NextDevicePathNode (TempDevicePath
);
1781 return BDS_EFI_UNSUPPORT
;
1785 Check whether the Device path in a boot option point to a valid bootable device,
1786 And if CheckMedia is true, check the device is ready to boot now.
1788 @param DevPath the Device path in a boot option
1789 @param CheckMedia if true, check the device is ready to boot now.
1791 @retval TRUE the Device path is valid
1792 @retval FALSE the Device path is invalid .
1797 BdsLibIsValidEFIBootOptDevicePath (
1798 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
,
1799 IN BOOLEAN CheckMedia
1802 return BdsLibIsValidEFIBootOptDevicePathExt (DevPath
, CheckMedia
, NULL
);
1806 Check whether the Device path in a boot option point to a valid bootable device,
1807 And if CheckMedia is true, check the device is ready to boot now.
1808 If Description is not NULL and the device path point to a fixed BlockIo
1809 device, check the description whether conflict with other auto-created
1812 @param DevPath the Device path in a boot option
1813 @param CheckMedia if true, check the device is ready to boot now.
1814 @param Description the description in a boot option
1816 @retval TRUE the Device path is valid
1817 @retval FALSE the Device path is invalid .
1822 BdsLibIsValidEFIBootOptDevicePathExt (
1823 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
,
1824 IN BOOLEAN CheckMedia
,
1825 IN CHAR16
*Description
1830 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
1831 EFI_DEVICE_PATH_PROTOCOL
*LastDeviceNode
;
1832 EFI_BLOCK_IO_PROTOCOL
*BlockIo
;
1834 TempDevicePath
= DevPath
;
1835 LastDeviceNode
= DevPath
;
1838 // Check if it's a valid boot option for network boot device.
1839 // Check if there is EfiLoadFileProtocol installed.
1840 // If yes, that means there is a boot option for network.
1842 Status
= gBS
->LocateDevicePath (
1843 &gEfiLoadFileProtocolGuid
,
1847 if (EFI_ERROR (Status
)) {
1849 // Device not present so see if we need to connect it
1851 TempDevicePath
= DevPath
;
1852 BdsLibConnectDevicePath (TempDevicePath
);
1853 Status
= gBS
->LocateDevicePath (
1854 &gEfiLoadFileProtocolGuid
,
1860 if (!EFI_ERROR (Status
)) {
1861 if (!IsDevicePathEnd (TempDevicePath
)) {
1863 // LoadFile protocol is not installed on handle with exactly the same DevPath
1870 // Test if it is ready to boot now
1872 if (BdsLibNetworkBootWithMediaPresent(DevPath
)) {
1881 // If the boot option point to a file, it is a valid EFI boot option,
1882 // and assume it is ready to boot now
1884 while (!IsDevicePathEnd (TempDevicePath
)) {
1885 LastDeviceNode
= TempDevicePath
;
1886 TempDevicePath
= NextDevicePathNode (TempDevicePath
);
1888 if ((DevicePathType (LastDeviceNode
) == MEDIA_DEVICE_PATH
) &&
1889 (DevicePathSubType (LastDeviceNode
) == MEDIA_FILEPATH_DP
)) {
1894 // Check if it's a valid boot option for internal Shell
1896 if (EfiGetNameGuidFromFwVolDevicePathNode ((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
*) LastDeviceNode
) != NULL
) {
1898 // If the boot option point to Internal FV shell, make sure it is valid
1900 TempDevicePath
= DevPath
;
1901 Status
= BdsLibUpdateFvFileDevicePath (&TempDevicePath
, PcdGetPtr(PcdShellFile
));
1902 if (Status
== EFI_ALREADY_STARTED
) {
1905 if (Status
== EFI_SUCCESS
) {
1906 FreePool (TempDevicePath
);
1913 // If the boot option point to a blockIO device:
1914 // if it is a removable blockIo device, it is valid.
1915 // if it is a fixed blockIo device, check its description confliction.
1917 TempDevicePath
= DevPath
;
1918 Status
= gBS
->LocateDevicePath (&gEfiBlockIoProtocolGuid
, &TempDevicePath
, &Handle
);
1919 if (EFI_ERROR (Status
)) {
1921 // Device not present so see if we need to connect it
1923 Status
= BdsLibConnectDevicePath (DevPath
);
1924 if (!EFI_ERROR (Status
)) {
1926 // Try again to get the Block Io protocol after we did the connect
1928 TempDevicePath
= DevPath
;
1929 Status
= gBS
->LocateDevicePath (&gEfiBlockIoProtocolGuid
, &TempDevicePath
, &Handle
);
1933 if (!EFI_ERROR (Status
)) {
1934 Status
= gBS
->HandleProtocol (Handle
, &gEfiBlockIoProtocolGuid
, (VOID
**)&BlockIo
);
1935 if (!EFI_ERROR (Status
)) {
1938 // Test if it is ready to boot now
1940 if (BdsLibGetBootableHandle (DevPath
) != NULL
) {
1949 // if the boot option point to a simple file protocol which does not consume block Io protocol, it is also a valid EFI boot option,
1951 Status
= gBS
->LocateDevicePath (&gEfiSimpleFileSystemProtocolGuid
, &TempDevicePath
, &Handle
);
1952 if (!EFI_ERROR (Status
)) {
1955 // Test if it is ready to boot now
1957 if (BdsLibGetBootableHandle (DevPath
) != NULL
) {
1971 According to a file guild, check a Fv file device path is valid. If it is invalid,
1972 try to return the valid device path.
1973 FV address maybe changes for memory layout adjust from time to time, use this function
1974 could promise the Fv file device path is right.
1976 @param DevicePath on input, the Fv file device path need to check on
1977 output, the updated valid Fv file device path
1978 @param FileGuid the Fv file guild
1980 @retval EFI_INVALID_PARAMETER the input DevicePath or FileGuid is invalid
1982 @retval EFI_UNSUPPORTED the input DevicePath does not contain Fv file
1984 @retval EFI_ALREADY_STARTED the input DevicePath has pointed to Fv file, it is
1986 @retval EFI_SUCCESS has successfully updated the invalid DevicePath,
1987 and return the updated device path in DevicePath
1992 BdsLibUpdateFvFileDevicePath (
1993 IN OUT EFI_DEVICE_PATH_PROTOCOL
** DevicePath
,
1994 IN EFI_GUID
*FileGuid
1997 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
1998 EFI_DEVICE_PATH_PROTOCOL
*LastDeviceNode
;
2000 EFI_GUID
*GuidPoint
;
2002 UINTN FvHandleCount
;
2003 EFI_HANDLE
*FvHandleBuffer
;
2004 EFI_FV_FILETYPE Type
;
2006 EFI_FV_FILE_ATTRIBUTES Attributes
;
2007 UINT32 AuthenticationStatus
;
2009 EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
;
2010 EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
;
2011 MEDIA_FW_VOL_FILEPATH_DEVICE_PATH FvFileNode
;
2012 EFI_HANDLE FoundFvHandle
;
2013 EFI_DEVICE_PATH_PROTOCOL
*NewDevicePath
;
2015 if ((DevicePath
== NULL
) || (*DevicePath
== NULL
)) {
2016 return EFI_INVALID_PARAMETER
;
2018 if (FileGuid
== NULL
) {
2019 return EFI_INVALID_PARAMETER
;
2023 // Check whether the device path point to the default the input Fv file
2025 TempDevicePath
= *DevicePath
;
2026 LastDeviceNode
= TempDevicePath
;
2027 while (!IsDevicePathEnd (TempDevicePath
)) {
2028 LastDeviceNode
= TempDevicePath
;
2029 TempDevicePath
= NextDevicePathNode (TempDevicePath
);
2031 GuidPoint
= EfiGetNameGuidFromFwVolDevicePathNode (
2032 (MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
*) LastDeviceNode
2034 if (GuidPoint
== NULL
) {
2036 // if this option does not points to a Fv file, just return EFI_UNSUPPORTED
2038 return EFI_UNSUPPORTED
;
2040 if (!CompareGuid (GuidPoint
, FileGuid
)) {
2042 // If the Fv file is not the input file guid, just return EFI_UNSUPPORTED
2044 return EFI_UNSUPPORTED
;
2048 // Check whether the input Fv file device path is valid
2050 TempDevicePath
= *DevicePath
;
2051 FoundFvHandle
= NULL
;
2052 Status
= gBS
->LocateDevicePath (
2053 &gEfiFirmwareVolume2ProtocolGuid
,
2057 if (!EFI_ERROR (Status
)) {
2058 Status
= gBS
->HandleProtocol (
2060 &gEfiFirmwareVolume2ProtocolGuid
,
2063 if (!EFI_ERROR (Status
)) {
2065 // Set FV ReadFile Buffer as NULL, only need to check whether input Fv file exist there
2067 Status
= Fv
->ReadFile (
2074 &AuthenticationStatus
2076 if (!EFI_ERROR (Status
)) {
2077 return EFI_ALREADY_STARTED
;
2083 // Look for the input wanted FV file in current FV
2084 // First, try to look for in Bds own FV. Bds and input wanted FV file usually are in the same FV
2087 FoundFvHandle
= NULL
;
2088 Status
= gBS
->HandleProtocol (
2090 &gEfiLoadedImageProtocolGuid
,
2091 (VOID
**) &LoadedImage
2093 if (!EFI_ERROR (Status
)) {
2094 Status
= gBS
->HandleProtocol (
2095 LoadedImage
->DeviceHandle
,
2096 &gEfiFirmwareVolume2ProtocolGuid
,
2099 if (!EFI_ERROR (Status
)) {
2100 Status
= Fv
->ReadFile (
2107 &AuthenticationStatus
2109 if (!EFI_ERROR (Status
)) {
2111 FoundFvHandle
= LoadedImage
->DeviceHandle
;
2116 // Second, if fail to find, try to enumerate all FV
2119 FvHandleBuffer
= NULL
;
2120 gBS
->LocateHandleBuffer (
2122 &gEfiFirmwareVolume2ProtocolGuid
,
2127 for (Index
= 0; Index
< FvHandleCount
; Index
++) {
2128 gBS
->HandleProtocol (
2129 FvHandleBuffer
[Index
],
2130 &gEfiFirmwareVolume2ProtocolGuid
,
2134 Status
= Fv
->ReadFile (
2141 &AuthenticationStatus
2143 if (EFI_ERROR (Status
)) {
2145 // Skip if input Fv file not in the FV
2150 FoundFvHandle
= FvHandleBuffer
[Index
];
2154 if (FvHandleBuffer
!= NULL
) {
2155 FreePool (FvHandleBuffer
);
2161 // Build the shell device path
2163 NewDevicePath
= DevicePathFromHandle (FoundFvHandle
);
2164 EfiInitializeFwVolDevicepathNode (&FvFileNode
, FileGuid
);
2165 NewDevicePath
= AppendDevicePathNode (NewDevicePath
, (EFI_DEVICE_PATH_PROTOCOL
*) &FvFileNode
);
2166 *DevicePath
= NewDevicePath
;
2169 return EFI_NOT_FOUND
;