2 Library functions which relates with booting.
4 Copyright (c) 2011 - 2017, Intel Corporation. All rights reserved.<BR>
5 (C) Copyright 2015-2016 Hewlett Packard Enterprise Development LP<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #include "InternalBm.h"
18 EFI_RAM_DISK_PROTOCOL
*mRamDisk
= NULL
;
20 EFI_BOOT_MANAGER_REFRESH_LEGACY_BOOT_OPTION mBmRefreshLegacyBootOption
= NULL
;
21 EFI_BOOT_MANAGER_LEGACY_BOOT mBmLegacyBoot
= NULL
;
24 /// This GUID is used for an EFI Variable that stores the front device pathes
25 /// for a partial device path that starts with the HD node.
27 EFI_GUID mBmHardDriveBootVariableGuid
= { 0xfab7e9e1, 0x39dd, 0x4f2b, { 0x84, 0x08, 0xe2, 0x0e, 0x90, 0x6c, 0xb6, 0xde } };
28 EFI_GUID mBmAutoCreateBootOptionGuid
= { 0x8108ac4e, 0x9f11, 0x4d59, { 0x85, 0x0e, 0xe2, 0x1a, 0x52, 0x2c, 0x59, 0xb2 } };
31 The function registers the legacy boot support capabilities.
33 @param RefreshLegacyBootOption The function pointer to create all the legacy boot options.
34 @param LegacyBoot The function pointer to boot the legacy boot option.
38 EfiBootManagerRegisterLegacyBootSupport (
39 EFI_BOOT_MANAGER_REFRESH_LEGACY_BOOT_OPTION RefreshLegacyBootOption
,
40 EFI_BOOT_MANAGER_LEGACY_BOOT LegacyBoot
43 mBmRefreshLegacyBootOption
= RefreshLegacyBootOption
;
44 mBmLegacyBoot
= LegacyBoot
;
48 Return TRUE when the boot option is auto-created instead of manually added.
50 @param BootOption Pointer to the boot option to check.
52 @retval TRUE The boot option is auto-created.
53 @retval FALSE The boot option is manually added.
56 BmIsAutoCreateBootOption (
57 EFI_BOOT_MANAGER_LOAD_OPTION
*BootOption
60 if ((BootOption
->OptionalDataSize
== sizeof (EFI_GUID
)) &&
61 CompareGuid ((EFI_GUID
*) BootOption
->OptionalData
, &mBmAutoCreateBootOptionGuid
)
70 Find the boot option in the NV storage and return the option number.
72 @param OptionToFind Boot option to be checked.
74 @return The option number of the found boot option.
78 BmFindBootOptionInVariable (
79 IN EFI_BOOT_MANAGER_LOAD_OPTION
*OptionToFind
83 EFI_BOOT_MANAGER_LOAD_OPTION BootOption
;
85 CHAR16 OptionName
[BM_OPTION_NAME_LEN
];
86 EFI_BOOT_MANAGER_LOAD_OPTION
*BootOptions
;
87 UINTN BootOptionCount
;
90 OptionNumber
= LoadOptionNumberUnassigned
;
93 // Try to match the variable exactly if the option number is assigned
95 if (OptionToFind
->OptionNumber
!= LoadOptionNumberUnassigned
) {
97 OptionName
, sizeof (OptionName
), L
"%s%04x",
98 mBmLoadOptionName
[OptionToFind
->OptionType
], OptionToFind
->OptionNumber
100 Status
= EfiBootManagerVariableToLoadOption (OptionName
, &BootOption
);
102 if (!EFI_ERROR (Status
)) {
103 ASSERT (OptionToFind
->OptionNumber
== BootOption
.OptionNumber
);
104 if ((OptionToFind
->Attributes
== BootOption
.Attributes
) &&
105 (StrCmp (OptionToFind
->Description
, BootOption
.Description
) == 0) &&
106 (CompareMem (OptionToFind
->FilePath
, BootOption
.FilePath
, GetDevicePathSize (OptionToFind
->FilePath
)) == 0) &&
107 (OptionToFind
->OptionalDataSize
== BootOption
.OptionalDataSize
) &&
108 (CompareMem (OptionToFind
->OptionalData
, BootOption
.OptionalData
, OptionToFind
->OptionalDataSize
) == 0)
110 OptionNumber
= OptionToFind
->OptionNumber
;
112 EfiBootManagerFreeLoadOption (&BootOption
);
117 // The option number assigned is either incorrect or unassigned.
119 if (OptionNumber
== LoadOptionNumberUnassigned
) {
120 BootOptions
= EfiBootManagerGetLoadOptions (&BootOptionCount
, LoadOptionTypeBoot
);
122 Index
= EfiBootManagerFindLoadOption (OptionToFind
, BootOptions
, BootOptionCount
);
124 OptionNumber
= BootOptions
[Index
].OptionNumber
;
127 EfiBootManagerFreeLoadOptions (BootOptions
, BootOptionCount
);
134 Get the file buffer using a Memory Mapped Device Path.
136 FV address may change across reboot. This routine promises the FV file device path is right.
138 @param FilePath The Memory Mapped Device Path to get the file buffer.
139 @param FullPath Receive the updated FV Device Path pointint to the file.
140 @param FileSize Receive the file buffer size.
142 @return The file buffer.
145 BmGetFileBufferByFvFilePath (
146 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
,
147 OUT EFI_DEVICE_PATH_PROTOCOL
**FullPath
,
153 EFI_DEVICE_PATH_PROTOCOL
*FvFileNode
;
155 EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
;
156 UINT32 AuthenticationStatus
;
158 EFI_HANDLE
*FvHandles
;
159 EFI_DEVICE_PATH_PROTOCOL
*NewDevicePath
;
163 // Get the file buffer by using the exactly FilePath.
165 FvFileNode
= FilePath
;
166 Status
= gBS
->LocateDevicePath (&gEfiFirmwareVolume2ProtocolGuid
, &FvFileNode
, &FvHandle
);
167 if (!EFI_ERROR (Status
)) {
168 FileBuffer
= GetFileBufferByFilePath (TRUE
, FilePath
, FileSize
, &AuthenticationStatus
);
169 if (FileBuffer
!= NULL
) {
170 *FullPath
= DuplicateDevicePath (FilePath
);
176 // Only wide match other FVs if it's a memory mapped FV file path.
178 if ((DevicePathType (FilePath
) != HARDWARE_DEVICE_PATH
) || (DevicePathSubType (FilePath
) != HW_MEMMAP_DP
)) {
182 FvFileNode
= NextDevicePathNode (FilePath
);
185 // Firstly find the FV file in current FV
187 gBS
->HandleProtocol (
189 &gEfiLoadedImageProtocolGuid
,
190 (VOID
**) &LoadedImage
192 NewDevicePath
= AppendDevicePathNode (DevicePathFromHandle (LoadedImage
->DeviceHandle
), FvFileNode
);
193 FileBuffer
= BmGetFileBufferByFvFilePath (NewDevicePath
, FullPath
, FileSize
);
194 FreePool (NewDevicePath
);
196 if (FileBuffer
!= NULL
) {
201 // Secondly find the FV file in all other FVs
203 gBS
->LocateHandleBuffer (
205 &gEfiFirmwareVolume2ProtocolGuid
,
210 for (Index
= 0; (Index
< FvHandleCount
) && (FileBuffer
== NULL
); Index
++) {
211 if (FvHandles
[Index
] == LoadedImage
->DeviceHandle
) {
217 NewDevicePath
= AppendDevicePathNode (DevicePathFromHandle (FvHandles
[Index
]), FvFileNode
);
218 FileBuffer
= BmGetFileBufferByFvFilePath (NewDevicePath
, FullPath
, FileSize
);
219 FreePool (NewDevicePath
);
222 if (FvHandles
!= NULL
) {
223 FreePool (FvHandles
);
229 Check if it's a Device Path pointing to FV file.
231 The function doesn't garentee the device path points to existing FV file.
233 @param DevicePath Input device path.
235 @retval TRUE The device path is a FV File Device Path.
236 @retval FALSE The device path is NOT a FV File Device Path.
240 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
245 EFI_DEVICE_PATH_PROTOCOL
*Node
;
248 Status
= gBS
->LocateDevicePath (&gEfiFirmwareVolume2ProtocolGuid
, &Node
, &Handle
);
249 if (!EFI_ERROR (Status
)) {
253 if ((DevicePathType (DevicePath
) == HARDWARE_DEVICE_PATH
) && (DevicePathSubType (DevicePath
) == HW_MEMMAP_DP
)) {
254 DevicePath
= NextDevicePathNode (DevicePath
);
255 if ((DevicePathType (DevicePath
) == MEDIA_DEVICE_PATH
) && (DevicePathSubType (DevicePath
) == MEDIA_PIWG_FW_FILE_DP
)) {
256 return IsDevicePathEnd (NextDevicePathNode (DevicePath
));
263 Check whether a USB device match the specified USB Class device path. This
264 function follows "Load Option Processing" behavior in UEFI specification.
266 @param UsbIo USB I/O protocol associated with the USB device.
267 @param UsbClass The USB Class device path to match.
269 @retval TRUE The USB device match the USB Class device path.
270 @retval FALSE The USB device does not match the USB Class device path.
275 IN EFI_USB_IO_PROTOCOL
*UsbIo
,
276 IN USB_CLASS_DEVICE_PATH
*UsbClass
280 EFI_USB_DEVICE_DESCRIPTOR DevDesc
;
281 EFI_USB_INTERFACE_DESCRIPTOR IfDesc
;
283 UINT8 DeviceSubClass
;
284 UINT8 DeviceProtocol
;
286 if ((DevicePathType (UsbClass
) != MESSAGING_DEVICE_PATH
) ||
287 (DevicePathSubType (UsbClass
) != MSG_USB_CLASS_DP
)){
292 // Check Vendor Id and Product Id.
294 Status
= UsbIo
->UsbGetDeviceDescriptor (UsbIo
, &DevDesc
);
295 if (EFI_ERROR (Status
)) {
299 if ((UsbClass
->VendorId
!= 0xffff) &&
300 (UsbClass
->VendorId
!= DevDesc
.IdVendor
)) {
304 if ((UsbClass
->ProductId
!= 0xffff) &&
305 (UsbClass
->ProductId
!= DevDesc
.IdProduct
)) {
309 DeviceClass
= DevDesc
.DeviceClass
;
310 DeviceSubClass
= DevDesc
.DeviceSubClass
;
311 DeviceProtocol
= DevDesc
.DeviceProtocol
;
312 if (DeviceClass
== 0) {
314 // If Class in Device Descriptor is set to 0, use the Class, SubClass and
315 // Protocol in Interface Descriptor instead.
317 Status
= UsbIo
->UsbGetInterfaceDescriptor (UsbIo
, &IfDesc
);
318 if (EFI_ERROR (Status
)) {
322 DeviceClass
= IfDesc
.InterfaceClass
;
323 DeviceSubClass
= IfDesc
.InterfaceSubClass
;
324 DeviceProtocol
= IfDesc
.InterfaceProtocol
;
328 // Check Class, SubClass and Protocol.
330 if ((UsbClass
->DeviceClass
!= 0xff) &&
331 (UsbClass
->DeviceClass
!= DeviceClass
)) {
335 if ((UsbClass
->DeviceSubClass
!= 0xff) &&
336 (UsbClass
->DeviceSubClass
!= DeviceSubClass
)) {
340 if ((UsbClass
->DeviceProtocol
!= 0xff) &&
341 (UsbClass
->DeviceProtocol
!= DeviceProtocol
)) {
349 Check whether a USB device match the specified USB WWID device path. This
350 function follows "Load Option Processing" behavior in UEFI specification.
352 @param UsbIo USB I/O protocol associated with the USB device.
353 @param UsbWwid The USB WWID device path to match.
355 @retval TRUE The USB device match the USB WWID device path.
356 @retval FALSE The USB device does not match the USB WWID device path.
361 IN EFI_USB_IO_PROTOCOL
*UsbIo
,
362 IN USB_WWID_DEVICE_PATH
*UsbWwid
366 EFI_USB_DEVICE_DESCRIPTOR DevDesc
;
367 EFI_USB_INTERFACE_DESCRIPTOR IfDesc
;
373 CHAR16
*SerialNumberStr
;
376 if ((DevicePathType (UsbWwid
) != MESSAGING_DEVICE_PATH
) ||
377 (DevicePathSubType (UsbWwid
) != MSG_USB_WWID_DP
)) {
382 // Check Vendor Id and Product Id.
384 Status
= UsbIo
->UsbGetDeviceDescriptor (UsbIo
, &DevDesc
);
385 if (EFI_ERROR (Status
)) {
388 if ((DevDesc
.IdVendor
!= UsbWwid
->VendorId
) ||
389 (DevDesc
.IdProduct
!= UsbWwid
->ProductId
)) {
394 // Check Interface Number.
396 Status
= UsbIo
->UsbGetInterfaceDescriptor (UsbIo
, &IfDesc
);
397 if (EFI_ERROR (Status
)) {
400 if (IfDesc
.InterfaceNumber
!= UsbWwid
->InterfaceNumber
) {
405 // Check Serial Number.
407 if (DevDesc
.StrSerialNumber
== 0) {
412 // Get all supported languages.
416 Status
= UsbIo
->UsbGetSupportedLanguages (UsbIo
, &LangIdTable
, &TableSize
);
417 if (EFI_ERROR (Status
) || (TableSize
== 0) || (LangIdTable
== NULL
)) {
422 // Serial number in USB WWID device path is the last 64-or-less UTF-16 characters.
424 CompareStr
= (CHAR16
*) (UINTN
) (UsbWwid
+ 1);
425 CompareLen
= (DevicePathNodeLength (UsbWwid
) - sizeof (USB_WWID_DEVICE_PATH
)) / sizeof (CHAR16
);
426 if (CompareStr
[CompareLen
- 1] == L
'\0') {
431 // Compare serial number in each supported language.
433 for (Index
= 0; Index
< TableSize
/ sizeof (UINT16
); Index
++) {
434 SerialNumberStr
= NULL
;
435 Status
= UsbIo
->UsbGetStringDescriptor (
438 DevDesc
.StrSerialNumber
,
441 if (EFI_ERROR (Status
) || (SerialNumberStr
== NULL
)) {
445 Length
= StrLen (SerialNumberStr
);
446 if ((Length
>= CompareLen
) &&
447 (CompareMem (SerialNumberStr
+ Length
- CompareLen
, CompareStr
, CompareLen
* sizeof (CHAR16
)) == 0)) {
448 FreePool (SerialNumberStr
);
452 FreePool (SerialNumberStr
);
459 Find a USB device which match the specified short-form device path start with
460 USB Class or USB WWID device path. If ParentDevicePath is NULL, this function
461 will search in all USB devices of the platform. If ParentDevicePath is not NULL,
462 this function will only search in its child devices.
464 @param DevicePath The device path that contains USB Class or USB WWID device path.
465 @param ParentDevicePathSize The length of the device path before the USB Class or
466 USB WWID device path.
467 @param UsbIoHandleCount A pointer to the count of the returned USB IO handles.
469 @retval NULL The matched USB IO handles cannot be found.
470 @retval other The matched USB IO handles.
475 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
476 IN UINTN ParentDevicePathSize
,
477 OUT UINTN
*UsbIoHandleCount
481 EFI_HANDLE
*UsbIoHandles
;
482 EFI_DEVICE_PATH_PROTOCOL
*UsbIoDevicePath
;
483 EFI_USB_IO_PROTOCOL
*UsbIo
;
487 ASSERT (UsbIoHandleCount
!= NULL
);
490 // Get all UsbIo Handles.
492 Status
= gBS
->LocateHandleBuffer (
494 &gEfiUsbIoProtocolGuid
,
499 if (EFI_ERROR (Status
)) {
500 *UsbIoHandleCount
= 0;
504 for (Index
= 0; Index
< *UsbIoHandleCount
; ) {
506 // Get the Usb IO interface.
508 Status
= gBS
->HandleProtocol(
510 &gEfiUsbIoProtocolGuid
,
513 UsbIoDevicePath
= DevicePathFromHandle (UsbIoHandles
[Index
]);
515 if (!EFI_ERROR (Status
) && (UsbIoDevicePath
!= NULL
)) {
518 // Compare starting part of UsbIoHandle's device path with ParentDevicePath.
520 if (CompareMem (UsbIoDevicePath
, DevicePath
, ParentDevicePathSize
) == 0) {
521 if (BmMatchUsbClass (UsbIo
, (USB_CLASS_DEVICE_PATH
*) ((UINTN
) DevicePath
+ ParentDevicePathSize
)) ||
522 BmMatchUsbWwid (UsbIo
, (USB_WWID_DEVICE_PATH
*) ((UINTN
) DevicePath
+ ParentDevicePathSize
))) {
529 (*UsbIoHandleCount
) --;
530 CopyMem (&UsbIoHandles
[Index
], &UsbIoHandles
[Index
+ 1], (*UsbIoHandleCount
- Index
) * sizeof (EFI_HANDLE
));
540 Expand USB Class or USB WWID device path node to be full device path of a USB
543 This function support following 4 cases:
544 1) Boot Option device path starts with a USB Class or USB WWID device path,
545 and there is no Media FilePath device path in the end.
546 In this case, it will follow Removable Media Boot Behavior.
547 2) Boot Option device path starts with a USB Class or USB WWID device path,
548 and ended with Media FilePath device path.
549 3) Boot Option device path starts with a full device path to a USB Host Controller,
550 contains a USB Class or USB WWID device path node, while not ended with Media
551 FilePath device path. In this case, it will follow Removable Media Boot Behavior.
552 4) Boot Option device path starts with a full device path to a USB Host Controller,
553 contains a USB Class or USB WWID device path node, and ended with Media
554 FilePath device path.
556 @param FilePath The device path pointing to a load option.
557 It could be a short-form device path.
558 @param FullPath Return the full device path of the load option after
559 short-form device path expanding.
560 Caller is responsible to free it.
561 @param FileSize Return the load option size.
562 @param ShortformNode Pointer to the USB short-form device path node in the FilePath buffer.
564 @return The load option buffer. Caller is responsible to free the memory.
567 BmExpandUsbDevicePath (
568 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
,
569 OUT EFI_DEVICE_PATH_PROTOCOL
**FullPath
,
571 IN EFI_DEVICE_PATH_PROTOCOL
*ShortformNode
574 UINTN ParentDevicePathSize
;
575 EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
;
576 EFI_DEVICE_PATH_PROTOCOL
*FullDevicePath
;
582 ParentDevicePathSize
= (UINTN
) ShortformNode
- (UINTN
) FilePath
;
583 RemainingDevicePath
= NextDevicePathNode (ShortformNode
);
585 Handles
= BmFindUsbDevice (FilePath
, ParentDevicePathSize
, &HandleCount
);
587 for (Index
= 0; (Index
< HandleCount
) && (FileBuffer
== NULL
); Index
++) {
588 FullDevicePath
= AppendDevicePath (DevicePathFromHandle (Handles
[Index
]), RemainingDevicePath
);
589 FileBuffer
= EfiBootManagerGetLoadOptionBuffer (FullDevicePath
, FullPath
, FileSize
);
590 FreePool (FullDevicePath
);
593 if (Handles
!= NULL
) {
601 Expand File-path device path node to be full device path in platform.
603 @param FilePath The device path pointing to a load option.
604 It could be a short-form device path.
605 @param FullPath Return the full device path of the load option after
606 short-form device path expanding.
607 Caller is responsible to free it.
608 @param FileSize Return the load option size.
610 @return The load option buffer. Caller is responsible to free the memory.
613 BmExpandFileDevicePath (
614 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
,
615 OUT EFI_DEVICE_PATH_PROTOCOL
**FullPath
,
623 EFI_BLOCK_IO_PROTOCOL
*BlockIo
;
625 EFI_DEVICE_PATH_PROTOCOL
*FullDevicePath
;
627 UINT32 AuthenticationStatus
;
629 EfiBootManagerConnectAll ();
630 Status
= gBS
->LocateHandleBuffer (ByProtocol
, &gEfiSimpleFileSystemProtocolGuid
, NULL
, &HandleCount
, &Handles
);
631 if (EFI_ERROR (Status
)) {
637 // Enumerate all removable media devices followed by all fixed media devices,
638 // followed by media devices which don't layer on block io.
640 for (MediaType
= 0; MediaType
< 3; MediaType
++) {
641 for (Index
= 0; Index
< HandleCount
; Index
++) {
642 Status
= gBS
->HandleProtocol (Handles
[Index
], &gEfiBlockIoProtocolGuid
, (VOID
*) &BlockIo
);
643 if (EFI_ERROR (Status
)) {
646 if ((MediaType
== 0 && BlockIo
!= NULL
&& BlockIo
->Media
->RemovableMedia
) ||
647 (MediaType
== 1 && BlockIo
!= NULL
&& !BlockIo
->Media
->RemovableMedia
) ||
648 (MediaType
== 2 && BlockIo
== NULL
)
650 FullDevicePath
= AppendDevicePath (DevicePathFromHandle (Handles
[Index
]), FilePath
);
651 FileBuffer
= GetFileBufferByFilePath (TRUE
, FullDevicePath
, FileSize
, &AuthenticationStatus
);
652 if (FileBuffer
!= NULL
) {
653 *FullPath
= FullDevicePath
;
657 FreePool (FullDevicePath
);
662 if (Handles
!= NULL
) {
671 Expand URI device path node to be full device path in platform.
673 @param FilePath The device path pointing to a load option.
674 It could be a short-form device path.
675 @param FullPath Return the full device path of the load option after
676 short-form device path expanding.
677 Caller is responsible to free it.
678 @param FileSize Return the load option size.
680 @return The load option buffer. Caller is responsible to free the memory.
683 BmExpandUriDevicePath (
684 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
,
685 OUT EFI_DEVICE_PATH_PROTOCOL
**FullPath
,
695 EfiBootManagerConnectAll ();
696 Status
= gBS
->LocateHandleBuffer (ByProtocol
, &gEfiLoadFileProtocolGuid
, NULL
, &HandleCount
, &Handles
);
697 if (EFI_ERROR (Status
)) {
703 for (Index
= 0; Index
< HandleCount
; Index
++) {
704 FileBuffer
= BmGetFileBufferFromLoadFile (Handles
[Index
], FilePath
, FullPath
, FileSize
);
705 if (FileBuffer
!= NULL
) {
710 if (Handles
!= NULL
) {
718 Save the partition DevicePath to the CachedDevicePath as the first instance.
720 @param CachedDevicePath The device path cache.
721 @param DevicePath The partition device path to be cached.
724 BmCachePartitionDevicePath (
725 IN OUT EFI_DEVICE_PATH_PROTOCOL
**CachedDevicePath
,
726 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
729 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
732 if (BmMatchDevicePaths (*CachedDevicePath
, DevicePath
)) {
733 TempDevicePath
= *CachedDevicePath
;
734 *CachedDevicePath
= BmDelPartMatchInstance (*CachedDevicePath
, DevicePath
);
735 FreePool (TempDevicePath
);
738 if (*CachedDevicePath
== NULL
) {
739 *CachedDevicePath
= DuplicateDevicePath (DevicePath
);
743 TempDevicePath
= *CachedDevicePath
;
744 *CachedDevicePath
= AppendDevicePathInstance (DevicePath
, *CachedDevicePath
);
745 if (TempDevicePath
!= NULL
) {
746 FreePool (TempDevicePath
);
750 // Here limit the device path instance number to 12, which is max number for a system support 3 IDE controller
751 // If the user try to boot many OS in different HDs or partitions, in theory, the 'HDDP' variable maybe become larger and larger.
754 TempDevicePath
= *CachedDevicePath
;
755 while (!IsDevicePathEnd (TempDevicePath
)) {
756 TempDevicePath
= NextDevicePathNode (TempDevicePath
);
758 // Parse one instance
760 while (!IsDevicePathEndType (TempDevicePath
)) {
761 TempDevicePath
= NextDevicePathNode (TempDevicePath
);
765 // If the CachedDevicePath variable contain too much instance, only remain 12 instances.
768 SetDevicePathEndNode (TempDevicePath
);
775 Expand a device path that starts with a hard drive media device path node to be a
776 full device path that includes the full hardware path to the device. We need
777 to do this so it can be booted. As an optimization the front match (the part point
778 to the partition node. E.g. ACPI() /PCI()/ATA()/Partition() ) is saved in a variable
779 so a connect all is not required on every boot. All successful history device path
780 which point to partition node (the front part) will be saved.
782 @param FilePath The device path pointing to a load option.
783 It could be a short-form device path.
784 @param FullPath Return the full device path of the load option after
785 short-form device path expanding.
786 Caller is responsible to free it.
787 @param FileSize Return the load option size.
789 @return The load option buffer. Caller is responsible to free the memory.
792 BmExpandPartitionDevicePath (
793 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
,
794 OUT EFI_DEVICE_PATH_PROTOCOL
**FullPath
,
799 UINTN BlockIoHandleCount
;
800 EFI_HANDLE
*BlockIoBuffer
;
802 EFI_DEVICE_PATH_PROTOCOL
*BlockIoDevicePath
;
804 EFI_DEVICE_PATH_PROTOCOL
*CachedDevicePath
;
805 EFI_DEVICE_PATH_PROTOCOL
*TempNewDevicePath
;
806 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
807 UINTN CachedDevicePathSize
;
809 EFI_DEVICE_PATH_PROTOCOL
*Instance
;
814 // Check if there is prestore 'HDDP' variable.
815 // If exist, search the front path which point to partition node in the variable instants.
816 // If fail to find or 'HDDP' not exist, reconnect all and search in all system
818 GetVariable2 (L
"HDDP", &mBmHardDriveBootVariableGuid
, (VOID
**) &CachedDevicePath
, &CachedDevicePathSize
);
821 // Delete the invalid 'HDDP' variable.
823 if ((CachedDevicePath
!= NULL
) && !IsDevicePathValid (CachedDevicePath
, CachedDevicePathSize
)) {
824 FreePool (CachedDevicePath
);
825 CachedDevicePath
= NULL
;
826 Status
= gRT
->SetVariable (
828 &mBmHardDriveBootVariableGuid
,
833 ASSERT_EFI_ERROR (Status
);
836 if (CachedDevicePath
!= NULL
) {
837 TempNewDevicePath
= CachedDevicePath
;
841 // Check every instance of the variable
842 // First, check whether the instance contain the partition node, which is needed for distinguishing multi
843 // partial partition boot option. Second, check whether the instance could be connected.
845 Instance
= GetNextDevicePathInstance (&TempNewDevicePath
, &Size
);
846 if (BmMatchPartitionDevicePathNode (Instance
, (HARDDRIVE_DEVICE_PATH
*) FilePath
)) {
848 // Connect the device path instance, the device path point to hard drive media device path node
849 // e.g. ACPI() /PCI()/ATA()/Partition()
851 Status
= EfiBootManagerConnectDevicePath (Instance
, NULL
);
852 if (!EFI_ERROR (Status
)) {
853 TempDevicePath
= AppendDevicePath (Instance
, NextDevicePathNode (FilePath
));
854 FileBuffer
= EfiBootManagerGetLoadOptionBuffer (TempDevicePath
, FullPath
, FileSize
);
855 FreePool (TempDevicePath
);
857 if (FileBuffer
!= NULL
) {
859 // Adjust the 'HDDP' instances sequence if the matched one is not first one.
862 BmCachePartitionDevicePath (&CachedDevicePath
, Instance
);
864 // Save the matching Device Path so we don't need to do a connect all next time
865 // Failing to save only impacts performance next time expanding the short-form device path
867 Status
= gRT
->SetVariable (
869 &mBmHardDriveBootVariableGuid
,
870 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
871 GetDevicePathSize (CachedDevicePath
),
877 FreePool (CachedDevicePath
);
883 // Come here means the first instance is not matched
887 } while (TempNewDevicePath
!= NULL
);
891 // If we get here we fail to find or 'HDDP' not exist, and now we need
892 // to search all devices in the system for a matched partition
894 EfiBootManagerConnectAll ();
895 Status
= gBS
->LocateHandleBuffer (ByProtocol
, &gEfiBlockIoProtocolGuid
, NULL
, &BlockIoHandleCount
, &BlockIoBuffer
);
896 if (EFI_ERROR (Status
)) {
897 BlockIoHandleCount
= 0;
898 BlockIoBuffer
= NULL
;
901 // Loop through all the device handles that support the BLOCK_IO Protocol
903 for (Index
= 0; Index
< BlockIoHandleCount
; Index
++) {
904 BlockIoDevicePath
= DevicePathFromHandle (BlockIoBuffer
[Index
]);
905 if (BlockIoDevicePath
== NULL
) {
909 if (BmMatchPartitionDevicePathNode (BlockIoDevicePath
, (HARDDRIVE_DEVICE_PATH
*) FilePath
)) {
911 // Find the matched partition device path
913 TempDevicePath
= AppendDevicePath (BlockIoDevicePath
, NextDevicePathNode (FilePath
));
914 FileBuffer
= EfiBootManagerGetLoadOptionBuffer (TempDevicePath
, FullPath
, FileSize
);
915 FreePool (TempDevicePath
);
917 if (FileBuffer
!= NULL
) {
918 BmCachePartitionDevicePath (&CachedDevicePath
, BlockIoDevicePath
);
921 // Save the matching Device Path so we don't need to do a connect all next time
922 // Failing to save only impacts performance next time expanding the short-form device path
924 Status
= gRT
->SetVariable (
926 &mBmHardDriveBootVariableGuid
,
927 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
928 GetDevicePathSize (CachedDevicePath
),
937 if (CachedDevicePath
!= NULL
) {
938 FreePool (CachedDevicePath
);
940 if (BlockIoBuffer
!= NULL
) {
941 FreePool (BlockIoBuffer
);
947 Expand the media device path which points to a BlockIo or SimpleFileSystem instance
948 by appending EFI_REMOVABLE_MEDIA_FILE_NAME.
950 @param DevicePath The media device path pointing to a BlockIo or SimpleFileSystem instance.
951 @param FullPath Return the full device path pointing to the load option.
952 @param FileSize Return the size of the load option.
954 @return The load option buffer.
957 BmExpandMediaDevicePath (
958 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
959 OUT EFI_DEVICE_PATH_PROTOCOL
**FullPath
,
965 EFI_BLOCK_IO_PROTOCOL
*BlockIo
;
967 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
970 EFI_HANDLE
*SimpleFileSystemHandles
;
971 UINTN NumberSimpleFileSystemHandles
;
974 UINT32 AuthenticationStatus
;
977 // Check whether the device is connected
979 TempDevicePath
= DevicePath
;
980 Status
= gBS
->LocateDevicePath (&gEfiSimpleFileSystemProtocolGuid
, &TempDevicePath
, &Handle
);
981 if (!EFI_ERROR (Status
)) {
982 ASSERT (IsDevicePathEnd (TempDevicePath
));
984 TempDevicePath
= FileDevicePath (Handle
, EFI_REMOVABLE_MEDIA_FILE_NAME
);
985 FileBuffer
= GetFileBufferByFilePath (TRUE
, TempDevicePath
, FileSize
, &AuthenticationStatus
);
986 if (FileBuffer
== NULL
) {
987 FreePool (TempDevicePath
);
988 TempDevicePath
= NULL
;
990 *FullPath
= TempDevicePath
;
994 Status
= gBS
->LocateDevicePath (&gEfiBlockIoProtocolGuid
, &TempDevicePath
, &Handle
);
995 ASSERT_EFI_ERROR (Status
);
998 // For device boot option only pointing to the removable device handle,
999 // should make sure all its children handles (its child partion or media handles)
1000 // are created and connected.
1002 gBS
->ConnectController (Handle
, NULL
, NULL
, TRUE
);
1005 // Issue a dummy read to the device to check for media change.
1006 // When the removable media is changed, any Block IO read/write will
1007 // cause the BlockIo protocol be reinstalled and EFI_MEDIA_CHANGED is
1008 // returned. After the Block IO protocol is reinstalled, subsequent
1009 // Block IO read/write will success.
1011 Status
= gBS
->HandleProtocol (Handle
, &gEfiBlockIoProtocolGuid
, (VOID
**) &BlockIo
);
1012 ASSERT_EFI_ERROR (Status
);
1013 Buffer
= AllocatePool (BlockIo
->Media
->BlockSize
);
1014 if (Buffer
!= NULL
) {
1015 BlockIo
->ReadBlocks (
1017 BlockIo
->Media
->MediaId
,
1019 BlockIo
->Media
->BlockSize
,
1026 // Detect the the default boot file from removable Media
1030 Size
= GetDevicePathSize (DevicePath
) - END_DEVICE_PATH_LENGTH
;
1031 gBS
->LocateHandleBuffer (
1033 &gEfiSimpleFileSystemProtocolGuid
,
1035 &NumberSimpleFileSystemHandles
,
1036 &SimpleFileSystemHandles
1038 for (Index
= 0; Index
< NumberSimpleFileSystemHandles
; Index
++) {
1040 // Get the device path size of SimpleFileSystem handle
1042 TempDevicePath
= DevicePathFromHandle (SimpleFileSystemHandles
[Index
]);
1043 TempSize
= GetDevicePathSize (TempDevicePath
) - END_DEVICE_PATH_LENGTH
;
1045 // Check whether the device path of boot option is part of the SimpleFileSystem handle's device path
1047 if ((Size
<= TempSize
) && (CompareMem (TempDevicePath
, DevicePath
, Size
) == 0)) {
1048 TempDevicePath
= FileDevicePath (SimpleFileSystemHandles
[Index
], EFI_REMOVABLE_MEDIA_FILE_NAME
);
1049 FileBuffer
= GetFileBufferByFilePath (TRUE
, TempDevicePath
, FileSize
, &AuthenticationStatus
);
1050 if (FileBuffer
!= NULL
) {
1051 *FullPath
= TempDevicePath
;
1054 FreePool (TempDevicePath
);
1058 if (SimpleFileSystemHandles
!= NULL
) {
1059 FreePool (SimpleFileSystemHandles
);
1066 Check whether Left and Right are the same without matching the specific
1067 device path data in IP device path and URI device path node.
1069 @retval TRUE Left and Right are the same.
1070 @retval FALSE Left and Right are the different.
1073 BmMatchHttpBootDevicePath (
1074 IN EFI_DEVICE_PATH_PROTOCOL
*Left
,
1075 IN EFI_DEVICE_PATH_PROTOCOL
*Right
1078 for (; !IsDevicePathEnd (Left
) && !IsDevicePathEnd (Right
)
1079 ; Left
= NextDevicePathNode (Left
), Right
= NextDevicePathNode (Right
)
1081 if (CompareMem (Left
, Right
, DevicePathNodeLength (Left
)) != 0) {
1082 if ((DevicePathType (Left
) != MESSAGING_DEVICE_PATH
) || (DevicePathType (Right
) != MESSAGING_DEVICE_PATH
)) {
1086 if (((DevicePathSubType (Left
) != MSG_IPv4_DP
) || (DevicePathSubType (Right
) != MSG_IPv4_DP
)) &&
1087 ((DevicePathSubType (Left
) != MSG_IPv6_DP
) || (DevicePathSubType (Right
) != MSG_IPv6_DP
)) &&
1088 ((DevicePathSubType (Left
) != MSG_URI_DP
) || (DevicePathSubType (Right
) != MSG_URI_DP
))
1094 return (BOOLEAN
) (IsDevicePathEnd (Left
) && IsDevicePathEnd (Right
));
1098 Get the file buffer from the file system produced by Load File instance.
1100 @param LoadFileHandle The handle of LoadFile instance.
1101 @param FullPath Return the full device path pointing to the load option.
1102 @param FileSize Return the size of the load option.
1103 @param RamDiskHandle Return the RAM Disk handle.
1105 @return The load option buffer.
1108 BmGetFileBufferFromLoadFileSystem (
1109 IN EFI_HANDLE LoadFileHandle
,
1110 OUT EFI_DEVICE_PATH_PROTOCOL
**FullPath
,
1111 OUT UINTN
*FileSize
,
1112 OUT EFI_HANDLE
*RamDiskHandle
1117 EFI_HANDLE
*Handles
;
1120 EFI_DEVICE_PATH_PROTOCOL
*Node
;
1122 Status
= gBS
->LocateHandleBuffer (
1124 &gEfiBlockIoProtocolGuid
,
1129 if (EFI_ERROR (Status
)) {
1135 for (Index
= 0; Index
< HandleCount
; Index
++) {
1136 Node
= DevicePathFromHandle (Handles
[Index
]);
1137 Status
= gBS
->LocateDevicePath (&gEfiLoadFileProtocolGuid
, &Node
, &Handle
);
1138 if (!EFI_ERROR (Status
) &&
1139 (Handle
== LoadFileHandle
) &&
1140 (DevicePathType (Node
) == MEDIA_DEVICE_PATH
) && (DevicePathSubType (Node
) == MEDIA_RAM_DISK_DP
)) {
1141 Handle
= Handles
[Index
];
1146 if (Handles
!= NULL
) {
1150 if (Index
== HandleCount
) {
1154 *RamDiskHandle
= Handle
;
1156 if (Handle
!= NULL
) {
1157 return BmExpandMediaDevicePath (DevicePathFromHandle (Handle
), FullPath
, FileSize
);
1165 Return the RAM Disk device path created by LoadFile.
1167 @param FilePath The source file path.
1169 @return Callee-to-free RAM Disk device path
1171 EFI_DEVICE_PATH_PROTOCOL
*
1172 BmGetRamDiskDevicePath (
1173 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
1177 EFI_DEVICE_PATH_PROTOCOL
*RamDiskDevicePath
;
1178 EFI_DEVICE_PATH_PROTOCOL
*Node
;
1182 Status
= gBS
->LocateDevicePath (&gEfiLoadFileProtocolGuid
, &Node
, &Handle
);
1183 if (!EFI_ERROR (Status
) &&
1184 (DevicePathType (Node
) == MEDIA_DEVICE_PATH
) &&
1185 (DevicePathSubType (Node
) == MEDIA_RAM_DISK_DP
)
1189 // Construct the device path pointing to RAM Disk
1191 Node
= NextDevicePathNode (Node
);
1192 RamDiskDevicePath
= DuplicateDevicePath (FilePath
);
1193 ASSERT (RamDiskDevicePath
!= NULL
);
1194 SetDevicePathEndNode ((VOID
*) ((UINTN
) RamDiskDevicePath
+ ((UINTN
) Node
- (UINTN
) FilePath
)));
1195 return RamDiskDevicePath
;
1202 Return the buffer and buffer size occupied by the RAM Disk.
1204 @param RamDiskDevicePath RAM Disk device path.
1205 @param RamDiskSizeInPages Return RAM Disk size in pages.
1207 @retval RAM Disk buffer.
1210 BmGetRamDiskMemoryInfo (
1211 IN EFI_DEVICE_PATH_PROTOCOL
*RamDiskDevicePath
,
1212 OUT UINTN
*RamDiskSizeInPages
1218 UINT64 StartingAddr
;
1221 ASSERT (RamDiskDevicePath
!= NULL
);
1223 *RamDiskSizeInPages
= 0;
1226 // Get the buffer occupied by RAM Disk.
1228 Status
= gBS
->LocateDevicePath (&gEfiLoadFileProtocolGuid
, &RamDiskDevicePath
, &Handle
);
1229 ASSERT_EFI_ERROR (Status
);
1230 ASSERT ((DevicePathType (RamDiskDevicePath
) == MEDIA_DEVICE_PATH
) &&
1231 (DevicePathSubType (RamDiskDevicePath
) == MEDIA_RAM_DISK_DP
));
1232 StartingAddr
= ReadUnaligned64 ((UINT64
*) ((MEDIA_RAM_DISK_DEVICE_PATH
*) RamDiskDevicePath
)->StartingAddr
);
1233 EndingAddr
= ReadUnaligned64 ((UINT64
*) ((MEDIA_RAM_DISK_DEVICE_PATH
*) RamDiskDevicePath
)->EndingAddr
);
1234 *RamDiskSizeInPages
= EFI_SIZE_TO_PAGES ((UINTN
) (EndingAddr
- StartingAddr
+ 1));
1235 return (VOID
*) (UINTN
) StartingAddr
;
1239 Destroy the RAM Disk.
1241 The destroy operation includes to call RamDisk.Unregister to
1242 unregister the RAM DISK from RAM DISK driver, free the memory
1243 allocated for the RAM Disk.
1245 @param RamDiskDevicePath RAM Disk device path.
1249 IN EFI_DEVICE_PATH_PROTOCOL
*RamDiskDevicePath
1253 VOID
*RamDiskBuffer
;
1254 UINTN RamDiskSizeInPages
;
1256 ASSERT (RamDiskDevicePath
!= NULL
);
1258 RamDiskBuffer
= BmGetRamDiskMemoryInfo (RamDiskDevicePath
, &RamDiskSizeInPages
);
1261 // Destroy RAM Disk.
1263 if (mRamDisk
== NULL
) {
1264 Status
= gBS
->LocateProtocol (&gEfiRamDiskProtocolGuid
, NULL
, (VOID
*) &mRamDisk
);
1265 ASSERT_EFI_ERROR (Status
);
1267 Status
= mRamDisk
->Unregister (RamDiskDevicePath
);
1268 ASSERT_EFI_ERROR (Status
);
1269 FreePages (RamDiskBuffer
, RamDiskSizeInPages
);
1273 Get the file buffer from the specified Load File instance.
1275 @param LoadFileHandle The specified Load File instance.
1276 @param FilePath The file path which will pass to LoadFile().
1277 @param FullPath Return the full device path pointing to the load option.
1278 @param FileSize Return the size of the load option.
1280 @return The load option buffer or NULL if fails.
1283 BmGetFileBufferFromLoadFile (
1284 IN EFI_HANDLE LoadFileHandle
,
1285 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
,
1286 OUT EFI_DEVICE_PATH_PROTOCOL
**FullPath
,
1291 EFI_LOAD_FILE_PROTOCOL
*LoadFile
;
1293 BOOLEAN LoadFileSystem
;
1294 EFI_HANDLE RamDiskHandle
;
1299 Status
= gBS
->OpenProtocol (
1301 &gEfiLoadFileProtocolGuid
,
1302 (VOID
**) &LoadFile
,
1305 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1307 ASSERT_EFI_ERROR (Status
);
1311 Status
= LoadFile
->LoadFile (LoadFile
, FilePath
, TRUE
, &BufferSize
, FileBuffer
);
1312 if ((Status
!= EFI_WARN_FILE_SYSTEM
) && (Status
!= EFI_BUFFER_TOO_SMALL
)) {
1316 LoadFileSystem
= (BOOLEAN
) (Status
== EFI_WARN_FILE_SYSTEM
);
1317 FileBuffer
= LoadFileSystem
? AllocateReservedPages (EFI_SIZE_TO_PAGES (BufferSize
)) : AllocatePool (BufferSize
);
1318 if (FileBuffer
== NULL
) {
1322 Status
= LoadFile
->LoadFile (LoadFile
, FilePath
, TRUE
, &BufferSize
, FileBuffer
);
1323 if (EFI_ERROR (Status
)) {
1324 if (LoadFileSystem
) {
1325 FreePages (FileBuffer
, EFI_SIZE_TO_PAGES (BufferSize
));
1327 FreePool (FileBuffer
);
1332 if (LoadFileSystem
) {
1333 FileBuffer
= BmGetFileBufferFromLoadFileSystem (LoadFileHandle
, FullPath
, FileSize
, &RamDiskHandle
);
1334 if (FileBuffer
== NULL
) {
1336 // If there is no bootable executable in the populated
1338 BmDestroyRamDisk (DevicePathFromHandle (RamDiskHandle
));
1341 *FileSize
= BufferSize
;
1342 *FullPath
= DuplicateDevicePath (DevicePathFromHandle (LoadFileHandle
));
1349 Get the file buffer from all the Load File instances.
1351 @param FilePath The media device path pointing to a LoadFile instance.
1352 @param FullPath Return the full device path pointing to the load option.
1353 @param FileSize Return the size of the load option.
1355 @return The load option buffer.
1358 BmGetFileBufferFromLoadFiles (
1359 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
,
1360 OUT EFI_DEVICE_PATH_PROTOCOL
**FullPath
,
1366 EFI_HANDLE
*Handles
;
1369 EFI_DEVICE_PATH_PROTOCOL
*Node
;
1372 // Get file buffer from load file instance.
1375 Status
= gBS
->LocateDevicePath (&gEfiLoadFileProtocolGuid
, &Node
, &Handle
);
1376 if (!EFI_ERROR (Status
) && IsDevicePathEnd (Node
)) {
1378 // When wide match happens, pass full device path to LoadFile (),
1379 // otherwise, pass remaining device path to LoadFile ().
1385 // Use wide match algorithm to find one when
1386 // cannot find a LoadFile instance to exactly match the FilePath
1388 Status
= gBS
->LocateHandleBuffer (
1390 &gEfiLoadFileProtocolGuid
,
1395 if (EFI_ERROR (Status
)) {
1399 for (Index
= 0; Index
< HandleCount
; Index
++) {
1400 if (BmMatchHttpBootDevicePath (DevicePathFromHandle (Handles
[Index
]), FilePath
)) {
1401 Handle
= Handles
[Index
];
1405 if (Handles
!= NULL
) {
1410 if (Handle
== NULL
) {
1414 return BmGetFileBufferFromLoadFile (Handle
, FilePath
, FullPath
, FileSize
);
1418 Get the load option by its device path.
1420 @param FilePath The device path pointing to a load option.
1421 It could be a short-form device path.
1422 @param FullPath Return the full device path of the load option after
1423 short-form device path expanding.
1424 Caller is responsible to free it.
1425 @param FileSize Return the load option size.
1427 @return The load option buffer. Caller is responsible to free the memory.
1431 EfiBootManagerGetLoadOptionBuffer (
1432 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
,
1433 OUT EFI_DEVICE_PATH_PROTOCOL
**FullPath
,
1439 UINT32 AuthenticationStatus
;
1440 EFI_DEVICE_PATH_PROTOCOL
*Node
;
1443 ASSERT ((FilePath
!= NULL
) && (FullPath
!= NULL
) && (FileSize
!= NULL
));
1445 EfiBootManagerConnectDevicePath (FilePath
, NULL
);
1452 // Boot from media device by adding a default file name \EFI\BOOT\BOOT{machine type short-name}.EFI
1455 Status
= gBS
->LocateDevicePath (&gEfiSimpleFileSystemProtocolGuid
, &Node
, &Handle
);
1456 if (EFI_ERROR (Status
)) {
1457 Status
= gBS
->LocateDevicePath (&gEfiBlockIoProtocolGuid
, &Node
, &Handle
);
1460 if (!EFI_ERROR (Status
) && IsDevicePathEnd (Node
)) {
1461 return BmExpandMediaDevicePath (FilePath
, FullPath
, FileSize
);
1465 // Expand the short-form device path to full device path
1467 if ((DevicePathType (FilePath
) == MEDIA_DEVICE_PATH
) &&
1468 (DevicePathSubType (FilePath
) == MEDIA_HARDDRIVE_DP
)) {
1470 // Expand the Harddrive device path
1472 return BmExpandPartitionDevicePath (FilePath
, FullPath
, FileSize
);
1473 } else if ((DevicePathType (FilePath
) == MEDIA_DEVICE_PATH
) &&
1474 (DevicePathSubType (FilePath
) == MEDIA_FILEPATH_DP
)) {
1476 // Expand the File-path device path
1478 return BmExpandFileDevicePath (FilePath
, FullPath
, FileSize
);
1479 } else if ((DevicePathType (FilePath
) == MESSAGING_DEVICE_PATH
) &&
1480 (DevicePathSubType (FilePath
) == MSG_URI_DP
)) {
1482 // Expand the URI device path
1484 return BmExpandUriDevicePath (FilePath
, FullPath
, FileSize
);
1486 for (Node
= FilePath
; !IsDevicePathEnd (Node
); Node
= NextDevicePathNode (Node
)) {
1487 if ((DevicePathType (Node
) == MESSAGING_DEVICE_PATH
) &&
1488 ((DevicePathSubType (Node
) == MSG_USB_CLASS_DP
) || (DevicePathSubType (Node
) == MSG_USB_WWID_DP
))) {
1493 if (!IsDevicePathEnd (Node
)) {
1495 // Expand the USB WWID/Class device path
1497 FileBuffer
= BmExpandUsbDevicePath (FilePath
, FullPath
, FileSize
, Node
);
1498 if ((FileBuffer
== NULL
) && (FilePath
== Node
)) {
1500 // Boot Option device path starts with USB Class or USB WWID device path.
1501 // For Boot Option device path which doesn't begin with the USB Class or
1502 // USB WWID device path, it's not needed to connect again here.
1504 BmConnectUsbShortFormDevicePath (FilePath
);
1505 FileBuffer
= BmExpandUsbDevicePath (FilePath
, FullPath
, FileSize
, Node
);
1512 // Get file buffer from FV file path.
1514 if (BmIsFvFilePath (FilePath
)) {
1515 return BmGetFileBufferByFvFilePath (FilePath
, FullPath
, FileSize
);
1519 // Get file buffer from simple file system.
1522 Status
= gBS
->LocateDevicePath (&gEfiSimpleFileSystemProtocolGuid
, &Node
, &Handle
);
1523 if (!EFI_ERROR (Status
)) {
1524 FileBuffer
= GetFileBufferByFilePath (TRUE
, FilePath
, FileSize
, &AuthenticationStatus
);
1525 if (FileBuffer
!= NULL
) {
1526 *FullPath
= DuplicateDevicePath (FilePath
);
1531 return BmGetFileBufferFromLoadFiles (FilePath
, FullPath
, FileSize
);
1535 Check if it's a Device Path pointing to BootManagerMenu.
1537 @param DevicePath Input device path.
1539 @retval TRUE The device path is BootManagerMenu File Device Path.
1540 @retval FALSE The device path is NOT BootManagerMenu File Device Path.
1543 BmIsBootManagerMenuFilePath (
1544 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
1547 EFI_HANDLE FvHandle
;
1551 Status
= gBS
->LocateDevicePath (&gEfiFirmwareVolume2ProtocolGuid
, &DevicePath
, &FvHandle
);
1552 if (!EFI_ERROR (Status
)) {
1553 NameGuid
= EfiGetNameGuidFromFwVolDevicePathNode ((CONST MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
*) DevicePath
);
1554 if (NameGuid
!= NULL
) {
1555 return CompareGuid (NameGuid
, PcdGetPtr (PcdBootManagerMenuFile
));
1563 Attempt to boot the EFI boot option. This routine sets L"BootCurent" and
1564 also signals the EFI ready to boot event. If the device path for the option
1565 starts with a BBS device path a legacy boot is attempted via the registered
1566 gLegacyBoot function. Short form device paths are also supported via this
1567 rountine. A device path starting with MEDIA_HARDDRIVE_DP, MSG_USB_WWID_DP,
1568 MSG_USB_CLASS_DP gets expaned out to find the first device that matches.
1569 If the BootOption Device Path fails the removable media boot algorithm
1570 is attempted (\EFI\BOOTIA32.EFI, \EFI\BOOTX64.EFI,... only one file type
1571 is tried per processor type)
1573 @param BootOption Boot Option to try and boot.
1574 On return, BootOption->Status contains the boot status.
1575 EFI_SUCCESS BootOption was booted
1576 EFI_UNSUPPORTED A BBS device path was found with no valid callback
1577 registered via EfiBootManagerInitialize().
1578 EFI_NOT_FOUND The BootOption was not found on the system
1579 !EFI_SUCCESS BootOption failed with this error status
1584 EfiBootManagerBoot (
1585 IN EFI_BOOT_MANAGER_LOAD_OPTION
*BootOption
1589 EFI_HANDLE ImageHandle
;
1590 EFI_LOADED_IMAGE_PROTOCOL
*ImageInfo
;
1593 UINTN OriginalOptionNumber
;
1594 EFI_DEVICE_PATH_PROTOCOL
*FilePath
;
1595 EFI_DEVICE_PATH_PROTOCOL
*RamDiskDevicePath
;
1598 EFI_BOOT_LOGO_PROTOCOL
*BootLogo
;
1599 EFI_EVENT LegacyBootEvent
;
1601 if (BootOption
== NULL
) {
1605 if (BootOption
->FilePath
== NULL
|| BootOption
->OptionType
!= LoadOptionTypeBoot
) {
1606 BootOption
->Status
= EFI_INVALID_PARAMETER
;
1611 // 1. Create Boot#### for a temporary boot if there is no match Boot#### (i.e. a boot by selected a EFI Shell using "Boot From File")
1613 OptionNumber
= BmFindBootOptionInVariable (BootOption
);
1614 if (OptionNumber
== LoadOptionNumberUnassigned
) {
1615 Status
= BmGetFreeOptionNumber (LoadOptionTypeBoot
, &Uint16
);
1616 if (!EFI_ERROR (Status
)) {
1618 // Save the BootOption->OptionNumber to restore later
1620 OptionNumber
= Uint16
;
1621 OriginalOptionNumber
= BootOption
->OptionNumber
;
1622 BootOption
->OptionNumber
= OptionNumber
;
1623 Status
= EfiBootManagerLoadOptionToVariable (BootOption
);
1624 BootOption
->OptionNumber
= OriginalOptionNumber
;
1627 if (EFI_ERROR (Status
)) {
1628 DEBUG ((EFI_D_ERROR
, "[Bds] Failed to create Boot#### for a temporary boot - %r!\n", Status
));
1629 BootOption
->Status
= Status
;
1635 // 2. Set BootCurrent
1637 Uint16
= (UINT16
) OptionNumber
;
1638 BmSetVariableAndReportStatusCodeOnError (
1640 &gEfiGlobalVariableGuid
,
1641 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
1647 // 3. Signal the EVT_SIGNAL_READY_TO_BOOT event when we are about to load and execute
1650 if (BmIsBootManagerMenuFilePath (BootOption
->FilePath
)) {
1651 DEBUG ((EFI_D_INFO
, "[Bds] Booting Boot Manager Menu.\n"));
1652 BmStopHotkeyService (NULL
, NULL
);
1654 EfiSignalEventReadyToBoot();
1656 // Report Status Code to indicate ReadyToBoot was signalled
1658 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_SW_DXE_BS_PC_READY_TO_BOOT_EVENT
));
1660 // 4. Repair system through DriverHealth protocol
1662 BmRepairAllControllers ();
1665 PERF_START_EX (gImageHandle
, "BdsAttempt", NULL
, 0, (UINT32
) OptionNumber
);
1668 // 5. Adjust the different type memory page number just before booting
1669 // and save the updated info into the variable for next boot to use
1671 BmSetMemoryTypeInformationVariable (
1672 (BOOLEAN
) ((BootOption
->Attributes
& LOAD_OPTION_CATEGORY
) == LOAD_OPTION_CATEGORY_BOOT
)
1676 // 6. Load EFI boot option to ImageHandle
1678 DEBUG_CODE_BEGIN ();
1679 if (BootOption
->Description
== NULL
) {
1680 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "[Bds]Booting from unknown device path\n"));
1682 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "[Bds]Booting %s\n", BootOption
->Description
));
1687 RamDiskDevicePath
= NULL
;
1688 if (DevicePathType (BootOption
->FilePath
) != BBS_DEVICE_PATH
) {
1689 Status
= EFI_NOT_FOUND
;
1690 FileBuffer
= EfiBootManagerGetLoadOptionBuffer (BootOption
->FilePath
, &FilePath
, &FileSize
);
1691 if (FileBuffer
!= NULL
) {
1692 RamDiskDevicePath
= BmGetRamDiskDevicePath (FilePath
);
1695 if (FileBuffer
!= NULL
&& CompareMem (BootOption
->FilePath
, FilePath
, GetDevicePathSize (FilePath
)) != 0) {
1696 DEBUG ((EFI_D_INFO
, "[Bds] DevicePath expand: "));
1697 BmPrintDp (BootOption
->FilePath
);
1698 DEBUG ((EFI_D_INFO
, " -> "));
1699 BmPrintDp (FilePath
);
1700 DEBUG ((EFI_D_INFO
, "\n"));
1703 if (BmIsLoadOptionPeHeaderValid (BootOption
->OptionType
, FileBuffer
, FileSize
)) {
1704 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, PcdGet32 (PcdProgressCodeOsLoaderLoad
));
1705 Status
= gBS
->LoadImage (
1714 if (FileBuffer
!= NULL
) {
1715 FreePool (FileBuffer
);
1717 if (FilePath
!= NULL
) {
1718 FreePool (FilePath
);
1721 if (EFI_ERROR (Status
)) {
1723 // Report Status Code to indicate that the failure to load boot option
1725 REPORT_STATUS_CODE (
1726 EFI_ERROR_CODE
| EFI_ERROR_MINOR
,
1727 (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_SW_DXE_BS_EC_BOOT_OPTION_LOAD_ERROR
)
1729 BootOption
->Status
= Status
;
1731 // Destroy the RAM disk
1733 if (RamDiskDevicePath
!= NULL
) {
1734 BmDestroyRamDisk (RamDiskDevicePath
);
1735 FreePool (RamDiskDevicePath
);
1742 // Check to see if we should legacy BOOT. If yes then do the legacy boot
1743 // Write boot to OS performance data for Legacy boot
1745 if ((DevicePathType (BootOption
->FilePath
) == BBS_DEVICE_PATH
) && (DevicePathSubType (BootOption
->FilePath
) == BBS_BBS_DP
)) {
1746 if (mBmLegacyBoot
!= NULL
) {
1748 // Write boot to OS performance data for legacy boot.
1752 // Create an event to be signalled when Legacy Boot occurs to write performance data.
1754 Status
= EfiCreateEventLegacyBootEx(
1756 BmWriteBootToOsPerformanceData
,
1760 ASSERT_EFI_ERROR (Status
);
1763 mBmLegacyBoot (BootOption
);
1765 BootOption
->Status
= EFI_UNSUPPORTED
;
1768 PERF_END_EX (gImageHandle
, "BdsAttempt", NULL
, 0, (UINT32
) OptionNumber
);
1773 // Provide the image with its load options
1775 Status
= gBS
->HandleProtocol (ImageHandle
, &gEfiLoadedImageProtocolGuid
, (VOID
**) &ImageInfo
);
1776 ASSERT_EFI_ERROR (Status
);
1778 if (!BmIsAutoCreateBootOption (BootOption
)) {
1779 ImageInfo
->LoadOptionsSize
= BootOption
->OptionalDataSize
;
1780 ImageInfo
->LoadOptions
= BootOption
->OptionalData
;
1784 // Clean to NULL because the image is loaded directly from the firmwares boot manager.
1786 ImageInfo
->ParentHandle
= NULL
;
1789 // Before calling the image, enable the Watchdog Timer for 5 minutes period
1791 gBS
->SetWatchdogTimer (5 * 60, 0x0000, 0x00, NULL
);
1794 // Write boot to OS performance data for UEFI boot
1797 BmWriteBootToOsPerformanceData (NULL
, NULL
);
1800 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, PcdGet32 (PcdProgressCodeOsLoaderStart
));
1802 Status
= gBS
->StartImage (ImageHandle
, &BootOption
->ExitDataSize
, &BootOption
->ExitData
);
1803 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Image Return Status = %r\n", Status
));
1804 BootOption
->Status
= Status
;
1805 if (EFI_ERROR (Status
)) {
1807 // Report Status Code to indicate that boot failure
1809 REPORT_STATUS_CODE (
1810 EFI_ERROR_CODE
| EFI_ERROR_MINOR
,
1811 (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_SW_DXE_BS_EC_BOOT_OPTION_FAILED
)
1814 PERF_END_EX (gImageHandle
, "BdsAttempt", NULL
, 0, (UINT32
) OptionNumber
);
1817 // Destroy the RAM disk
1819 if (RamDiskDevicePath
!= NULL
) {
1820 BmDestroyRamDisk (RamDiskDevicePath
);
1821 FreePool (RamDiskDevicePath
);
1825 // Clear the Watchdog Timer after the image returns
1827 gBS
->SetWatchdogTimer (0x0000, 0x0000, 0x0000, NULL
);
1830 // Set Logo status invalid after trying one boot option
1833 Status
= gBS
->LocateProtocol (&gEfiBootLogoProtocolGuid
, NULL
, (VOID
**) &BootLogo
);
1834 if (!EFI_ERROR (Status
) && (BootLogo
!= NULL
)) {
1835 Status
= BootLogo
->SetBootLogo (BootLogo
, NULL
, 0, 0, 0, 0);
1836 ASSERT_EFI_ERROR (Status
);
1840 // Clear Boot Current
1842 Status
= gRT
->SetVariable (
1844 &gEfiGlobalVariableGuid
,
1850 // Deleting variable with current variable implementation shouldn't fail.
1851 // When BootXXXX (e.g.: BootManagerMenu) boots BootYYYY, exiting BootYYYY causes BootCurrent deleted,
1852 // exiting BootXXXX causes deleting BootCurrent returns EFI_NOT_FOUND.
1854 ASSERT (Status
== EFI_SUCCESS
|| Status
== EFI_NOT_FOUND
);
1858 Check whether there is a instance in BlockIoDevicePath, which contain multi device path
1859 instances, has the same partition node with HardDriveDevicePath device path
1861 @param BlockIoDevicePath Multi device path instances which need to check
1862 @param HardDriveDevicePath A device path which starts with a hard drive media
1865 @retval TRUE There is a matched device path instance.
1866 @retval FALSE There is no matched device path instance.
1870 BmMatchPartitionDevicePathNode (
1871 IN EFI_DEVICE_PATH_PROTOCOL
*BlockIoDevicePath
,
1872 IN HARDDRIVE_DEVICE_PATH
*HardDriveDevicePath
1875 HARDDRIVE_DEVICE_PATH
*Node
;
1877 if ((BlockIoDevicePath
== NULL
) || (HardDriveDevicePath
== NULL
)) {
1882 // find the partition device path node
1884 while (!IsDevicePathEnd (BlockIoDevicePath
)) {
1885 if ((DevicePathType (BlockIoDevicePath
) == MEDIA_DEVICE_PATH
) &&
1886 (DevicePathSubType (BlockIoDevicePath
) == MEDIA_HARDDRIVE_DP
)
1891 BlockIoDevicePath
= NextDevicePathNode (BlockIoDevicePath
);
1894 if (IsDevicePathEnd (BlockIoDevicePath
)) {
1899 // See if the harddrive device path in blockio matches the orig Hard Drive Node
1901 Node
= (HARDDRIVE_DEVICE_PATH
*) BlockIoDevicePath
;
1904 // Match Signature and PartitionNumber.
1905 // Unused bytes in Signature are initiaized with zeros.
1908 (Node
->PartitionNumber
== HardDriveDevicePath
->PartitionNumber
) &&
1909 (Node
->MBRType
== HardDriveDevicePath
->MBRType
) &&
1910 (Node
->SignatureType
== HardDriveDevicePath
->SignatureType
) &&
1911 (CompareMem (Node
->Signature
, HardDriveDevicePath
->Signature
, sizeof (Node
->Signature
)) == 0)
1916 Emuerate all possible bootable medias in the following order:
1917 1. Removable BlockIo - The boot option only points to the removable media
1918 device, like USB key, DVD, Floppy etc.
1919 2. Fixed BlockIo - The boot option only points to a Fixed blockIo device,
1921 3. Non-BlockIo SimpleFileSystem - The boot option points to a device supporting
1922 SimpleFileSystem Protocol, but not supporting BlockIo
1924 4. LoadFile - The boot option points to the media supporting
1926 Reference: UEFI Spec chapter 3.3 Boot Option Variables Default Boot Behavior
1928 @param BootOptionCount Return the boot option count which has been found.
1930 @retval Pointer to the boot option array.
1932 EFI_BOOT_MANAGER_LOAD_OPTION
*
1933 BmEnumerateBootOptions (
1934 UINTN
*BootOptionCount
1938 EFI_BOOT_MANAGER_LOAD_OPTION
*BootOptions
;
1940 EFI_HANDLE
*Handles
;
1941 EFI_BLOCK_IO_PROTOCOL
*BlkIo
;
1944 CHAR16
*Description
;
1946 ASSERT (BootOptionCount
!= NULL
);
1948 *BootOptionCount
= 0;
1952 // Parse removable block io followed by fixed block io
1954 gBS
->LocateHandleBuffer (
1956 &gEfiBlockIoProtocolGuid
,
1962 for (Removable
= 0; Removable
< 2; Removable
++) {
1963 for (Index
= 0; Index
< HandleCount
; Index
++) {
1964 Status
= gBS
->HandleProtocol (
1966 &gEfiBlockIoProtocolGuid
,
1969 if (EFI_ERROR (Status
)) {
1974 // Skip the logical partitions
1976 if (BlkIo
->Media
->LogicalPartition
) {
1981 // Skip the fixed block io then the removable block io
1983 if (BlkIo
->Media
->RemovableMedia
== ((Removable
== 0) ? FALSE
: TRUE
)) {
1987 Description
= BmGetBootDescription (Handles
[Index
]);
1988 BootOptions
= ReallocatePool (
1989 sizeof (EFI_BOOT_MANAGER_LOAD_OPTION
) * (*BootOptionCount
),
1990 sizeof (EFI_BOOT_MANAGER_LOAD_OPTION
) * (*BootOptionCount
+ 1),
1993 ASSERT (BootOptions
!= NULL
);
1995 Status
= EfiBootManagerInitializeLoadOption (
1996 &BootOptions
[(*BootOptionCount
)++],
1997 LoadOptionNumberUnassigned
,
2001 DevicePathFromHandle (Handles
[Index
]),
2005 ASSERT_EFI_ERROR (Status
);
2007 FreePool (Description
);
2011 if (HandleCount
!= 0) {
2016 // Parse simple file system not based on block io
2018 gBS
->LocateHandleBuffer (
2020 &gEfiSimpleFileSystemProtocolGuid
,
2025 for (Index
= 0; Index
< HandleCount
; Index
++) {
2026 Status
= gBS
->HandleProtocol (
2028 &gEfiBlockIoProtocolGuid
,
2031 if (!EFI_ERROR (Status
)) {
2033 // Skip if the file system handle supports a BlkIo protocol, which we've handled in above
2037 Description
= BmGetBootDescription (Handles
[Index
]);
2038 BootOptions
= ReallocatePool (
2039 sizeof (EFI_BOOT_MANAGER_LOAD_OPTION
) * (*BootOptionCount
),
2040 sizeof (EFI_BOOT_MANAGER_LOAD_OPTION
) * (*BootOptionCount
+ 1),
2043 ASSERT (BootOptions
!= NULL
);
2045 Status
= EfiBootManagerInitializeLoadOption (
2046 &BootOptions
[(*BootOptionCount
)++],
2047 LoadOptionNumberUnassigned
,
2051 DevicePathFromHandle (Handles
[Index
]),
2055 ASSERT_EFI_ERROR (Status
);
2056 FreePool (Description
);
2059 if (HandleCount
!= 0) {
2064 // Parse load file protocol
2066 gBS
->LocateHandleBuffer (
2068 &gEfiLoadFileProtocolGuid
,
2073 for (Index
= 0; Index
< HandleCount
; Index
++) {
2075 // Ignore BootManagerMenu. its boot option will be created by EfiBootManagerGetBootManagerMenu().
2077 if (BmIsBootManagerMenuFilePath (DevicePathFromHandle (Handles
[Index
]))) {
2081 Description
= BmGetBootDescription (Handles
[Index
]);
2082 BootOptions
= ReallocatePool (
2083 sizeof (EFI_BOOT_MANAGER_LOAD_OPTION
) * (*BootOptionCount
),
2084 sizeof (EFI_BOOT_MANAGER_LOAD_OPTION
) * (*BootOptionCount
+ 1),
2087 ASSERT (BootOptions
!= NULL
);
2089 Status
= EfiBootManagerInitializeLoadOption (
2090 &BootOptions
[(*BootOptionCount
)++],
2091 LoadOptionNumberUnassigned
,
2095 DevicePathFromHandle (Handles
[Index
]),
2099 ASSERT_EFI_ERROR (Status
);
2100 FreePool (Description
);
2103 if (HandleCount
!= 0) {
2107 BmMakeBootOptionDescriptionUnique (BootOptions
, *BootOptionCount
);
2112 The function enumerates all boot options, creates them and registers them in the BootOrder variable.
2116 EfiBootManagerRefreshAllBootOption (
2121 EFI_BOOT_MANAGER_LOAD_OPTION
*NvBootOptions
;
2122 UINTN NvBootOptionCount
;
2123 EFI_BOOT_MANAGER_LOAD_OPTION
*BootOptions
;
2124 UINTN BootOptionCount
;
2128 // Optionally refresh the legacy boot option
2130 if (mBmRefreshLegacyBootOption
!= NULL
) {
2131 mBmRefreshLegacyBootOption ();
2134 BootOptions
= BmEnumerateBootOptions (&BootOptionCount
);
2135 NvBootOptions
= EfiBootManagerGetLoadOptions (&NvBootOptionCount
, LoadOptionTypeBoot
);
2138 // Mark the boot option as added by BDS by setting OptionalData to a special GUID
2140 for (Index
= 0; Index
< BootOptionCount
; Index
++) {
2141 BootOptions
[Index
].OptionalData
= AllocateCopyPool (sizeof (EFI_GUID
), &mBmAutoCreateBootOptionGuid
);
2142 BootOptions
[Index
].OptionalDataSize
= sizeof (EFI_GUID
);
2146 // Remove invalid EFI boot options from NV
2148 for (Index
= 0; Index
< NvBootOptionCount
; Index
++) {
2149 if (((DevicePathType (NvBootOptions
[Index
].FilePath
) != BBS_DEVICE_PATH
) ||
2150 (DevicePathSubType (NvBootOptions
[Index
].FilePath
) != BBS_BBS_DP
)
2151 ) && BmIsAutoCreateBootOption (&NvBootOptions
[Index
])
2154 // Only check those added by BDS
2155 // so that the boot options added by end-user or OS installer won't be deleted
2157 if (EfiBootManagerFindLoadOption (&NvBootOptions
[Index
], BootOptions
, BootOptionCount
) == -1) {
2158 Status
= EfiBootManagerDeleteLoadOptionVariable (NvBootOptions
[Index
].OptionNumber
, LoadOptionTypeBoot
);
2160 // Deleting variable with current variable implementation shouldn't fail.
2162 ASSERT_EFI_ERROR (Status
);
2168 // Add new EFI boot options to NV
2170 for (Index
= 0; Index
< BootOptionCount
; Index
++) {
2171 if (EfiBootManagerFindLoadOption (&BootOptions
[Index
], NvBootOptions
, NvBootOptionCount
) == -1) {
2172 EfiBootManagerAddLoadOptionVariable (&BootOptions
[Index
], (UINTN
) -1);
2174 // Try best to add the boot options so continue upon failure.
2179 EfiBootManagerFreeLoadOptions (BootOptions
, BootOptionCount
);
2180 EfiBootManagerFreeLoadOptions (NvBootOptions
, NvBootOptionCount
);
2184 This function is called to get or create the boot option for the Boot Manager Menu.
2186 The Boot Manager Menu is shown after successfully booting a boot option.
2187 Assume the BootManagerMenuFile is in the same FV as the module links to this library.
2189 @param BootOption Return the boot option of the Boot Manager Menu
2191 @retval EFI_SUCCESS Successfully register the Boot Manager Menu.
2192 @retval EFI_NOT_FOUND The Boot Manager Menu cannot be found.
2193 @retval others Return status of gRT->SetVariable (). BootOption still points
2194 to the Boot Manager Menu even the Status is not EFI_SUCCESS
2198 BmRegisterBootManagerMenu (
2199 OUT EFI_BOOT_MANAGER_LOAD_OPTION
*BootOption
2203 CHAR16
*Description
;
2204 UINTN DescriptionLength
;
2205 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
2206 EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
;
2207 MEDIA_FW_VOL_FILEPATH_DEVICE_PATH FileNode
;
2209 EFI_HANDLE
*Handles
;
2217 // Try to find BootManagerMenu from LoadFile protocol
2219 gBS
->LocateHandleBuffer (
2221 &gEfiLoadFileProtocolGuid
,
2226 for (Index
= 0; Index
< HandleCount
; Index
++) {
2227 if (BmIsBootManagerMenuFilePath (DevicePathFromHandle (Handles
[Index
]))) {
2228 DevicePath
= DuplicateDevicePath (DevicePathFromHandle (Handles
[Index
]));
2229 Description
= BmGetBootDescription (Handles
[Index
]);
2233 if (HandleCount
!= 0) {
2237 if (DevicePath
== NULL
) {
2239 Status
= GetSectionFromFv (
2240 PcdGetPtr (PcdBootManagerMenuFile
),
2249 if (EFI_ERROR (Status
)) {
2250 DEBUG ((EFI_D_WARN
, "[Bds]BootManagerMenu FFS section can not be found, skip its boot option registration\n"));
2251 return EFI_NOT_FOUND
;
2255 // Get BootManagerMenu application's description from EFI User Interface Section.
2257 Status
= GetSectionFromFv (
2258 PcdGetPtr (PcdBootManagerMenuFile
),
2259 EFI_SECTION_USER_INTERFACE
,
2261 (VOID
**) &Description
,
2264 if (EFI_ERROR (Status
)) {
2268 EfiInitializeFwVolDevicepathNode (&FileNode
, PcdGetPtr (PcdBootManagerMenuFile
));
2269 Status
= gBS
->HandleProtocol (
2271 &gEfiLoadedImageProtocolGuid
,
2272 (VOID
**) &LoadedImage
2274 ASSERT_EFI_ERROR (Status
);
2275 DevicePath
= AppendDevicePathNode (
2276 DevicePathFromHandle (LoadedImage
->DeviceHandle
),
2277 (EFI_DEVICE_PATH_PROTOCOL
*) &FileNode
2279 ASSERT (DevicePath
!= NULL
);
2282 Status
= EfiBootManagerInitializeLoadOption (
2284 LoadOptionNumberUnassigned
,
2286 LOAD_OPTION_CATEGORY_APP
| LOAD_OPTION_ACTIVE
| LOAD_OPTION_HIDDEN
,
2287 (Description
!= NULL
) ? Description
: L
"Boot Manager Menu",
2292 ASSERT_EFI_ERROR (Status
);
2293 FreePool (DevicePath
);
2294 if (Description
!= NULL
) {
2295 FreePool (Description
);
2299 EFI_BOOT_MANAGER_LOAD_OPTION
*BootOptions
;
2300 UINTN BootOptionCount
;
2302 BootOptions
= EfiBootManagerGetLoadOptions (&BootOptionCount
, LoadOptionTypeBoot
);
2303 ASSERT (EfiBootManagerFindLoadOption (BootOption
, BootOptions
, BootOptionCount
) == -1);
2304 EfiBootManagerFreeLoadOptions (BootOptions
, BootOptionCount
);
2307 return EfiBootManagerAddLoadOptionVariable (BootOption
, 0);
2311 Return the boot option corresponding to the Boot Manager Menu.
2312 It may automatically create one if the boot option hasn't been created yet.
2314 @param BootOption Return the Boot Manager Menu.
2316 @retval EFI_SUCCESS The Boot Manager Menu is successfully returned.
2317 @retval EFI_NOT_FOUND The Boot Manager Menu cannot be found.
2318 @retval others Return status of gRT->SetVariable (). BootOption still points
2319 to the Boot Manager Menu even the Status is not EFI_SUCCESS
2324 EfiBootManagerGetBootManagerMenu (
2325 EFI_BOOT_MANAGER_LOAD_OPTION
*BootOption
2329 UINTN BootOptionCount
;
2330 EFI_BOOT_MANAGER_LOAD_OPTION
*BootOptions
;
2333 BootOptions
= EfiBootManagerGetLoadOptions (&BootOptionCount
, LoadOptionTypeBoot
);
2335 for (Index
= 0; Index
< BootOptionCount
; Index
++) {
2336 if (BmIsBootManagerMenuFilePath (BootOptions
[Index
].FilePath
)) {
2337 Status
= EfiBootManagerInitializeLoadOption (
2339 BootOptions
[Index
].OptionNumber
,
2340 BootOptions
[Index
].OptionType
,
2341 BootOptions
[Index
].Attributes
,
2342 BootOptions
[Index
].Description
,
2343 BootOptions
[Index
].FilePath
,
2344 BootOptions
[Index
].OptionalData
,
2345 BootOptions
[Index
].OptionalDataSize
2347 ASSERT_EFI_ERROR (Status
);
2352 EfiBootManagerFreeLoadOptions (BootOptions
, BootOptionCount
);
2355 // Automatically create the Boot#### for Boot Manager Menu when not found.
2357 if (Index
== BootOptionCount
) {
2358 return BmRegisterBootManagerMenu (BootOption
);