2 BDS Lib functions which relate with create or process the boot option.
4 Copyright (c) 2004 - 2011, 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 The constructor function register UNI strings into imageHandle.
24 It will ASSERT() if that operation fails and it will always return EFI_SUCCESS.
26 @param ImageHandle The firmware allocated handle for the EFI image.
27 @param SystemTable A pointer to the EFI System Table.
29 @retval EFI_SUCCESS The constructor successfully added string package.
30 @retval Other value The constructor can't add string package.
35 GenericBdsLibConstructor (
36 IN EFI_HANDLE ImageHandle
,
37 IN EFI_SYSTEM_TABLE
*SystemTable
41 gBdsLibStringPackHandle
= HiiAddPackages (
42 &gBdsLibStringPackageGuid
,
48 ASSERT (gBdsLibStringPackHandle
!= NULL
);
56 Boot the legacy system with the boot option
58 @param Option The legacy boot option which have BBS device path
60 @retval EFI_UNSUPPORTED There is no legacybios protocol, do not support
62 @retval EFI_STATUS Return the status of LegacyBios->LegacyBoot ().
67 IN BDS_COMMON_OPTION
*Option
71 EFI_LEGACY_BIOS_PROTOCOL
*LegacyBios
;
73 Status
= gBS
->LocateProtocol (&gEfiLegacyBiosProtocolGuid
, NULL
, (VOID
**) &LegacyBios
);
74 if (EFI_ERROR (Status
)) {
76 // If no LegacyBios protocol we do not support legacy boot
78 return EFI_UNSUPPORTED
;
81 // Notes: if we separate the int 19, then we don't need to refresh BBS
83 BdsRefreshBbsTableForBoot (Option
);
86 // Write boot to OS performance data for legacy boot.
89 WriteBootToOsPerformanceData ();
92 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Legacy Boot: %S\n", Option
->Description
));
93 return LegacyBios
->LegacyBoot (
95 (BBS_BBS_DEVICE_PATH
*) Option
->DevicePath
,
96 Option
->LoadOptionsSize
,
102 Internal function to check if the input boot option is a valid EFI NV Boot####.
104 @param OptionToCheck Boot option to be checked.
106 @retval TRUE This boot option matches a valid EFI NV Boot####.
107 @retval FALSE If not.
111 IsBootOptionValidNVVarialbe (
112 IN BDS_COMMON_OPTION
*OptionToCheck
116 BDS_COMMON_OPTION
*BootOption
;
118 CHAR16 OptionName
[20];
122 InitializeListHead (&TempList
);
123 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Boot%04x", OptionToCheck
->BootCurrent
);
125 BootOption
= BdsLibVariableToOption (&TempList
, OptionName
);
126 if (BootOption
== NULL
) {
131 // If the Boot Option Number and Device Path matches, OptionToCheck matches a
132 // valid EFI NV Boot####.
134 if ((OptionToCheck
->BootCurrent
== BootOption
->BootCurrent
) &&
135 (CompareMem (OptionToCheck
->DevicePath
, BootOption
->DevicePath
, GetDevicePathSize (OptionToCheck
->DevicePath
)) == 0))
140 FreePool (BootOption
);
146 Check whether a USB device match the specified USB Class device path. This
147 function follows "Load Option Processing" behavior in UEFI specification.
149 @param UsbIo USB I/O protocol associated with the USB device.
150 @param UsbClass The USB Class device path to match.
152 @retval TRUE The USB device match the USB Class device path.
153 @retval FALSE The USB device does not match the USB Class device path.
158 IN EFI_USB_IO_PROTOCOL
*UsbIo
,
159 IN USB_CLASS_DEVICE_PATH
*UsbClass
163 EFI_USB_DEVICE_DESCRIPTOR DevDesc
;
164 EFI_USB_INTERFACE_DESCRIPTOR IfDesc
;
166 UINT8 DeviceSubClass
;
167 UINT8 DeviceProtocol
;
169 if ((DevicePathType (UsbClass
) != MESSAGING_DEVICE_PATH
) ||
170 (DevicePathSubType (UsbClass
) != MSG_USB_CLASS_DP
)){
175 // Check Vendor Id and Product Id.
177 Status
= UsbIo
->UsbGetDeviceDescriptor (UsbIo
, &DevDesc
);
178 if (EFI_ERROR (Status
)) {
182 if ((UsbClass
->VendorId
!= 0xffff) &&
183 (UsbClass
->VendorId
!= DevDesc
.IdVendor
)) {
187 if ((UsbClass
->ProductId
!= 0xffff) &&
188 (UsbClass
->ProductId
!= DevDesc
.IdProduct
)) {
192 DeviceClass
= DevDesc
.DeviceClass
;
193 DeviceSubClass
= DevDesc
.DeviceSubClass
;
194 DeviceProtocol
= DevDesc
.DeviceProtocol
;
195 if (DeviceClass
== 0) {
197 // If Class in Device Descriptor is set to 0, use the Class, SubClass and
198 // Protocol in Interface Descriptor instead.
200 Status
= UsbIo
->UsbGetInterfaceDescriptor (UsbIo
, &IfDesc
);
201 if (EFI_ERROR (Status
)) {
205 DeviceClass
= IfDesc
.InterfaceClass
;
206 DeviceSubClass
= IfDesc
.InterfaceSubClass
;
207 DeviceProtocol
= IfDesc
.InterfaceProtocol
;
211 // Check Class, SubClass and Protocol.
213 if ((UsbClass
->DeviceClass
!= 0xff) &&
214 (UsbClass
->DeviceClass
!= DeviceClass
)) {
218 if ((UsbClass
->DeviceSubClass
!= 0xff) &&
219 (UsbClass
->DeviceSubClass
!= DeviceSubClass
)) {
223 if ((UsbClass
->DeviceProtocol
!= 0xff) &&
224 (UsbClass
->DeviceProtocol
!= DeviceProtocol
)) {
232 Check whether a USB device match the specified USB WWID device path. This
233 function follows "Load Option Processing" behavior in UEFI specification.
235 @param UsbIo USB I/O protocol associated with the USB device.
236 @param UsbWwid The USB WWID device path to match.
238 @retval TRUE The USB device match the USB WWID device path.
239 @retval FALSE The USB device does not match the USB WWID device path.
244 IN EFI_USB_IO_PROTOCOL
*UsbIo
,
245 IN USB_WWID_DEVICE_PATH
*UsbWwid
249 EFI_USB_DEVICE_DESCRIPTOR DevDesc
;
250 EFI_USB_INTERFACE_DESCRIPTOR IfDesc
;
256 CHAR16
*SerialNumberStr
;
259 if ((DevicePathType (UsbWwid
) != MESSAGING_DEVICE_PATH
) ||
260 (DevicePathSubType (UsbWwid
) != MSG_USB_WWID_DP
)){
265 // Check Vendor Id and Product Id.
267 Status
= UsbIo
->UsbGetDeviceDescriptor (UsbIo
, &DevDesc
);
268 if (EFI_ERROR (Status
)) {
271 if ((DevDesc
.IdVendor
!= UsbWwid
->VendorId
) ||
272 (DevDesc
.IdProduct
!= UsbWwid
->ProductId
)) {
277 // Check Interface Number.
279 Status
= UsbIo
->UsbGetInterfaceDescriptor (UsbIo
, &IfDesc
);
280 if (EFI_ERROR (Status
)) {
283 if (IfDesc
.InterfaceNumber
!= UsbWwid
->InterfaceNumber
) {
288 // Check Serial Number.
290 if (DevDesc
.StrSerialNumber
== 0) {
295 // Get all supported languages.
299 Status
= UsbIo
->UsbGetSupportedLanguages (UsbIo
, &LangIdTable
, &TableSize
);
300 if (EFI_ERROR (Status
) || (TableSize
== 0) || (LangIdTable
== NULL
)) {
305 // Serial number in USB WWID device path is the last 64-or-less UTF-16 characters.
307 CompareStr
= (CHAR16
*) (UINTN
) (UsbWwid
+ 1);
308 CompareLen
= (DevicePathNodeLength (UsbWwid
) - sizeof (USB_WWID_DEVICE_PATH
)) / sizeof (CHAR16
);
309 if (CompareStr
[CompareLen
- 1] == L
'\0') {
314 // Compare serial number in each supported language.
316 for (Index
= 0; Index
< TableSize
/ sizeof (UINT16
); Index
++) {
317 SerialNumberStr
= NULL
;
318 Status
= UsbIo
->UsbGetStringDescriptor (
321 DevDesc
.StrSerialNumber
,
324 if (EFI_ERROR (Status
) || (SerialNumberStr
== NULL
)) {
328 Length
= StrLen (SerialNumberStr
);
329 if ((Length
>= CompareLen
) &&
330 (CompareMem (SerialNumberStr
+ Length
- CompareLen
, CompareStr
, CompareLen
* sizeof (CHAR16
)) == 0)) {
331 FreePool (SerialNumberStr
);
335 FreePool (SerialNumberStr
);
342 Find a USB device path which match the specified short-form device path start
343 with USB Class or USB WWID device path and load the boot file then return the
344 image handle. If ParentDevicePath is NULL, this function will search in all USB
345 devices of the platform. If ParentDevicePath is not NULL,this function will only
346 search in its child devices.
348 @param ParentDevicePath The device path of the parent.
349 @param ShortFormDevicePath The USB Class or USB WWID device path to match.
351 @return The image Handle if find load file from specified short-form device path
352 or NULL if not found.
357 IN EFI_DEVICE_PATH_PROTOCOL
*ParentDevicePath
,
358 IN EFI_DEVICE_PATH_PROTOCOL
*ShortFormDevicePath
362 UINTN UsbIoHandleCount
;
363 EFI_HANDLE
*UsbIoHandleBuffer
;
364 EFI_DEVICE_PATH_PROTOCOL
*UsbIoDevicePath
;
365 EFI_USB_IO_PROTOCOL
*UsbIo
;
369 EFI_HANDLE ImageHandle
;
371 EFI_DEVICE_PATH_PROTOCOL
*FullDevicePath
;
372 EFI_DEVICE_PATH_PROTOCOL
*NextDevicePath
;
374 FullDevicePath
= NULL
;
378 // Get all UsbIo Handles.
380 UsbIoHandleCount
= 0;
381 UsbIoHandleBuffer
= NULL
;
382 Status
= gBS
->LocateHandleBuffer (
384 &gEfiUsbIoProtocolGuid
,
389 if (EFI_ERROR (Status
) || (UsbIoHandleCount
== 0) || (UsbIoHandleBuffer
== NULL
)) {
393 ParentSize
= (ParentDevicePath
== NULL
) ? 0 : GetDevicePathSize (ParentDevicePath
);
394 for (Index
= 0; Index
< UsbIoHandleCount
; Index
++) {
396 // Get the Usb IO interface.
398 Status
= gBS
->HandleProtocol(
399 UsbIoHandleBuffer
[Index
],
400 &gEfiUsbIoProtocolGuid
,
403 if (EFI_ERROR (Status
)) {
407 UsbIoDevicePath
= DevicePathFromHandle (UsbIoHandleBuffer
[Index
]);
408 if (UsbIoDevicePath
== NULL
) {
412 if (ParentDevicePath
!= NULL
) {
414 // Compare starting part of UsbIoHandle's device path with ParentDevicePath.
416 Size
= GetDevicePathSize (UsbIoDevicePath
);
417 if ((Size
< ParentSize
) ||
418 (CompareMem (UsbIoDevicePath
, ParentDevicePath
, ParentSize
- END_DEVICE_PATH_LENGTH
) != 0)) {
423 if (BdsMatchUsbClass (UsbIo
, (USB_CLASS_DEVICE_PATH
*) ShortFormDevicePath
) ||
424 BdsMatchUsbWwid (UsbIo
, (USB_WWID_DEVICE_PATH
*) ShortFormDevicePath
)) {
426 // Try to find if there is the boot file in this DevicePath
428 NextDevicePath
= NextDevicePathNode (ShortFormDevicePath
);
429 if (!IsDevicePathEnd (NextDevicePath
)) {
430 FullDevicePath
= AppendDevicePath (UsbIoDevicePath
, NextDevicePath
);
432 // Connect the full device path, so that Simple File System protocol
433 // could be installed for this USB device.
435 BdsLibConnectDevicePath (FullDevicePath
);
436 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, PcdGet32 (PcdProgressCodeOsLoaderLoad
));
437 Status
= gBS
->LoadImage (
445 FreePool (FullDevicePath
);
447 FullDevicePath
= UsbIoDevicePath
;
448 Status
= EFI_NOT_FOUND
;
452 // If we didn't find an image directly, we need to try as if it is a removable device boot option
453 // and load the image according to the default boot behavior for removable device.
455 if (EFI_ERROR (Status
)) {
457 // check if there is a bootable removable media could be found in this device path ,
458 // and get the bootable media handle
460 Handle
= BdsLibGetBootableHandle(UsbIoDevicePath
);
461 if (Handle
== NULL
) {
465 // Load the default boot file \EFI\BOOT\boot{machinename}.EFI from removable Media
466 // machinename is ia32, ia64, x64, ...
468 FullDevicePath
= FileDevicePath (Handle
, EFI_REMOVABLE_MEDIA_FILE_NAME
);
469 if (FullDevicePath
!= NULL
) {
470 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, PcdGet32 (PcdProgressCodeOsLoaderLoad
));
471 Status
= gBS
->LoadImage (
479 if (EFI_ERROR (Status
)) {
481 // The DevicePath failed, and it's not a valid
482 // removable media device.
494 FreePool (UsbIoHandleBuffer
);
499 Expand USB Class or USB WWID device path node to be full device path of a USB
500 device in platform then load the boot file on this full device path and return the
503 This function support following 4 cases:
504 1) Boot Option device path starts with a USB Class or USB WWID device path,
505 and there is no Media FilePath device path in the end.
506 In this case, it will follow Removable Media Boot Behavior.
507 2) Boot Option device path starts with a USB Class or USB WWID device path,
508 and ended with Media FilePath device path.
509 3) Boot Option device path starts with a full device path to a USB Host Controller,
510 contains a USB Class or USB WWID device path node, while not ended with Media
511 FilePath device path. In this case, it will follow Removable Media Boot Behavior.
512 4) Boot Option device path starts with a full device path to a USB Host Controller,
513 contains a USB Class or USB WWID device path node, and ended with Media
514 FilePath device path.
516 @param DevicePath The Boot Option device path.
518 @return The image handle of boot file, or NULL if there is no boot file found in
519 the specified USB Class or USB WWID device path.
523 BdsExpandUsbShortFormDevicePath (
524 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
527 EFI_HANDLE
*ImageHandle
;
528 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
529 EFI_DEVICE_PATH_PROTOCOL
*ShortFormDevicePath
;
532 // Search for USB Class or USB WWID device path node.
534 ShortFormDevicePath
= NULL
;
536 TempDevicePath
= DevicePath
;
537 while (!IsDevicePathEnd (TempDevicePath
)) {
538 if ((DevicePathType (TempDevicePath
) == MESSAGING_DEVICE_PATH
) &&
539 ((DevicePathSubType (TempDevicePath
) == MSG_USB_CLASS_DP
) ||
540 (DevicePathSubType (TempDevicePath
) == MSG_USB_WWID_DP
))) {
541 ShortFormDevicePath
= TempDevicePath
;
544 TempDevicePath
= NextDevicePathNode (TempDevicePath
);
547 if (ShortFormDevicePath
== NULL
) {
549 // No USB Class or USB WWID device path node found, do nothing.
554 if (ShortFormDevicePath
== DevicePath
) {
556 // Boot Option device path starts with USB Class or USB WWID device path.
558 ImageHandle
= BdsFindUsbDevice (NULL
, ShortFormDevicePath
);
559 if (ImageHandle
== NULL
) {
561 // Failed to find a match in existing devices, connect the short form USB
562 // device path and try again.
564 BdsLibConnectUsbDevByShortFormDP (0xff, ShortFormDevicePath
);
565 ImageHandle
= BdsFindUsbDevice (NULL
, ShortFormDevicePath
);
569 // Boot Option device path contains USB Class or USB WWID device path node.
573 // Prepare the parent device path for search.
575 TempDevicePath
= DuplicateDevicePath (DevicePath
);
576 ASSERT (TempDevicePath
!= NULL
);
577 SetDevicePathEndNode (((UINT8
*) TempDevicePath
) + ((UINTN
) ShortFormDevicePath
- (UINTN
) DevicePath
));
580 // The USB Host Controller device path is already in Boot Option device path
581 // and USB Bus driver already support RemainingDevicePath starts with USB
582 // Class or USB WWID device path, so just search in existing USB devices and
583 // doesn't perform ConnectController here.
585 ImageHandle
= BdsFindUsbDevice (TempDevicePath
, ShortFormDevicePath
);
586 FreePool (TempDevicePath
);
593 Process the boot option follow the UEFI specification and
594 special treat the legacy boot option with BBS_DEVICE_PATH.
596 @param Option The boot option need to be processed
597 @param DevicePath The device path which describe where to load the
598 boot image or the legacy BBS device path to boot
600 @param ExitDataSize The size of exit data.
601 @param ExitData Data returned when Boot image failed.
603 @retval EFI_SUCCESS Boot from the input boot option successfully.
604 @retval EFI_NOT_FOUND If the Device Path is not found in the system
609 BdsLibBootViaBootOption (
610 IN BDS_COMMON_OPTION
*Option
,
611 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
612 OUT UINTN
*ExitDataSize
,
613 OUT CHAR16
**ExitData OPTIONAL
618 EFI_HANDLE ImageHandle
;
619 EFI_DEVICE_PATH_PROTOCOL
*FilePath
;
620 EFI_LOADED_IMAGE_PROTOCOL
*ImageInfo
;
621 EFI_DEVICE_PATH_PROTOCOL
*WorkingDevicePath
;
622 EFI_ACPI_S3_SAVE_PROTOCOL
*AcpiS3Save
;
623 LIST_ENTRY TempBootLists
;
626 // Record the performance data for End of BDS
628 PERF_END(NULL
, "BDS", NULL
, 0);
634 // Notes: this code can be remove after the s3 script table
635 // hook on the event EVT_SIGNAL_READY_TO_BOOT or
636 // EVT_SIGNAL_LEGACY_BOOT
638 Status
= gBS
->LocateProtocol (&gEfiAcpiS3SaveProtocolGuid
, NULL
, (VOID
**) &AcpiS3Save
);
639 if (!EFI_ERROR (Status
)) {
640 AcpiS3Save
->S3Save (AcpiS3Save
, NULL
);
643 // If it's Device Path that starts with a hard drive path, append it with the front part to compose a
646 WorkingDevicePath
= NULL
;
647 if ((DevicePathType (DevicePath
) == MEDIA_DEVICE_PATH
) &&
648 (DevicePathSubType (DevicePath
) == MEDIA_HARDDRIVE_DP
)) {
649 WorkingDevicePath
= BdsExpandPartitionPartialDevicePathToFull (
650 (HARDDRIVE_DEVICE_PATH
*)DevicePath
652 if (WorkingDevicePath
!= NULL
) {
653 DevicePath
= WorkingDevicePath
;
658 // Signal the EVT_SIGNAL_READY_TO_BOOT event
660 EfiSignalEventReadyToBoot();
663 // Expand USB Class or USB WWID device path node to be full device path of a USB
664 // device in platform then load the boot file on this full device path and get the
667 ImageHandle
= BdsExpandUsbShortFormDevicePath (DevicePath
);
670 // Adjust the different type memory page number just before booting
671 // and save the updated info into the variable for next boot to use
673 BdsSetMemoryTypeInformationVariable ();
678 if (IsBootOptionValidNVVarialbe (Option
)) {
680 // For a temporary boot (i.e. a boot by selected a EFI Shell using "Boot From File"), Boot Current is actually not valid.
681 // In this case, "BootCurrent" is not created.
682 // Only create the BootCurrent variable when it points to a valid Boot#### variable.
686 &gEfiGlobalVariableGuid
,
687 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
694 // By expanding the USB Class or WWID device path, the ImageHandle has returnned.
695 // Here get the ImageHandle for the non USB class or WWID device path.
697 if (ImageHandle
== NULL
) {
698 ASSERT (Option
->DevicePath
!= NULL
);
699 if ((DevicePathType (Option
->DevicePath
) == BBS_DEVICE_PATH
) &&
700 (DevicePathSubType (Option
->DevicePath
) == BBS_BBS_DP
)
703 // Check to see if we should legacy BOOT. If yes then do the legacy boot
705 return BdsLibDoLegacyBoot (Option
);
709 // If the boot option point to Internal FV shell, make sure it is valid
711 Status
= BdsLibUpdateFvFileDevicePath (&DevicePath
, PcdGetPtr(PcdShellFile
));
712 if (!EFI_ERROR(Status
)) {
713 if (Option
->DevicePath
!= NULL
) {
714 FreePool(Option
->DevicePath
);
716 Option
->DevicePath
= AllocateZeroPool (GetDevicePathSize (DevicePath
));
717 ASSERT(Option
->DevicePath
!= NULL
);
718 CopyMem (Option
->DevicePath
, DevicePath
, GetDevicePathSize (DevicePath
));
720 // Update the shell boot option
722 InitializeListHead (&TempBootLists
);
723 BdsLibRegisterNewOption (&TempBootLists
, DevicePath
, L
"EFI Internal Shell", L
"BootOrder");
726 // free the temporary device path created by BdsLibUpdateFvFileDevicePath()
728 FreePool (DevicePath
);
729 DevicePath
= Option
->DevicePath
;
734 if (Option
->Description
== NULL
) {
735 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Booting from unknown device path\n"));
737 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Booting %S\n", Option
->Description
));
743 // Report status code for OS Loader LoadImage.
745 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, PcdGet32 (PcdProgressCodeOsLoaderLoad
));
746 Status
= gBS
->LoadImage (
756 // If we didn't find an image directly, we need to try as if it is a removable device boot option
757 // and load the image according to the default boot behavior for removable device.
759 if (EFI_ERROR (Status
)) {
761 // check if there is a bootable removable media could be found in this device path ,
762 // and get the bootable media handle
764 Handle
= BdsLibGetBootableHandle(DevicePath
);
765 if (Handle
== NULL
) {
769 // Load the default boot file \EFI\BOOT\boot{machinename}.EFI from removable Media
770 // machinename is ia32, ia64, x64, ...
772 FilePath
= FileDevicePath (Handle
, EFI_REMOVABLE_MEDIA_FILE_NAME
);
773 if (FilePath
!= NULL
) {
774 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, PcdGet32 (PcdProgressCodeOsLoaderLoad
));
775 Status
= gBS
->LoadImage (
783 if (EFI_ERROR (Status
)) {
785 // The DevicePath failed, and it's not a valid
786 // removable media device.
793 if (EFI_ERROR (Status
)) {
795 // It there is any error from the Boot attempt exit now.
801 // Provide the image with it's load options
803 if (ImageHandle
== NULL
) {
806 Status
= gBS
->HandleProtocol (ImageHandle
, &gEfiLoadedImageProtocolGuid
, (VOID
**) &ImageInfo
);
807 ASSERT_EFI_ERROR (Status
);
809 if (Option
->LoadOptionsSize
!= 0) {
810 ImageInfo
->LoadOptionsSize
= Option
->LoadOptionsSize
;
811 ImageInfo
->LoadOptions
= Option
->LoadOptions
;
814 // Before calling the image, enable the Watchdog Timer for
815 // the 5 Minute period
817 gBS
->SetWatchdogTimer (5 * 60, 0x0000, 0x00, NULL
);
820 // Write boot to OS performance data for UEFI boot
823 WriteBootToOsPerformanceData ();
827 // Report status code for OS Loader StartImage.
829 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, PcdGet32 (PcdProgressCodeOsLoaderStart
));
831 Status
= gBS
->StartImage (ImageHandle
, ExitDataSize
, ExitData
);
832 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Image Return Status = %r\n", Status
));
835 // Clear the Watchdog Timer after the image returns
837 gBS
->SetWatchdogTimer (0x0000, 0x0000, 0x0000, NULL
);
841 // Clear Boot Current
845 &gEfiGlobalVariableGuid
,
846 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
856 Expand a device path that starts with a hard drive media device path node to be a
857 full device path that includes the full hardware path to the device. We need
858 to do this so it can be booted. As an optimization the front match (the part point
859 to the partition node. E.g. ACPI() /PCI()/ATA()/Partition() ) is saved in a variable
860 so a connect all is not required on every boot. All successful history device path
861 which point to partition node (the front part) will be saved.
863 @param HardDriveDevicePath EFI Device Path to boot, if it starts with a hard
864 drive media device path.
865 @return A Pointer to the full device path or NULL if a valid Hard Drive devic path
869 EFI_DEVICE_PATH_PROTOCOL
*
871 BdsExpandPartitionPartialDevicePathToFull (
872 IN HARDDRIVE_DEVICE_PATH
*HardDriveDevicePath
876 UINTN BlockIoHandleCount
;
877 EFI_HANDLE
*BlockIoBuffer
;
878 EFI_DEVICE_PATH_PROTOCOL
*FullDevicePath
;
879 EFI_DEVICE_PATH_PROTOCOL
*BlockIoDevicePath
;
880 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
883 EFI_DEVICE_PATH_PROTOCOL
*CachedDevicePath
;
884 EFI_DEVICE_PATH_PROTOCOL
*TempNewDevicePath
;
885 UINTN CachedDevicePathSize
;
888 EFI_DEVICE_PATH_PROTOCOL
*Instance
;
891 FullDevicePath
= NULL
;
893 // Check if there is prestore HD_BOOT_DEVICE_PATH_VARIABLE_NAME variable.
894 // If exist, search the front path which point to partition node in the variable instants.
895 // If fail to find or HD_BOOT_DEVICE_PATH_VARIABLE_NAME not exist, reconnect all and search in all system
897 CachedDevicePath
= BdsLibGetVariableAndSize (
898 HD_BOOT_DEVICE_PATH_VARIABLE_NAME
,
899 &gHdBootDevicePathVariablGuid
,
900 &CachedDevicePathSize
903 if (CachedDevicePath
!= NULL
) {
904 TempNewDevicePath
= CachedDevicePath
;
909 // Check every instance of the variable
910 // First, check whether the instance contain the partition node, which is needed for distinguishing multi
911 // partial partition boot option. Second, check whether the instance could be connected.
913 Instance
= GetNextDevicePathInstance (&TempNewDevicePath
, &Size
);
914 if (MatchPartitionDevicePathNode (Instance
, HardDriveDevicePath
)) {
916 // Connect the device path instance, the device path point to hard drive media device path node
917 // e.g. ACPI() /PCI()/ATA()/Partition()
919 Status
= BdsLibConnectDevicePath (Instance
);
920 if (!EFI_ERROR (Status
)) {
926 // Come here means the first instance is not matched
930 } while (TempNewDevicePath
!= NULL
);
934 // Find the matched device path.
935 // Append the file path information from the boot option and return the fully expanded device path.
937 DevicePath
= NextDevicePathNode ((EFI_DEVICE_PATH_PROTOCOL
*) HardDriveDevicePath
);
938 FullDevicePath
= AppendDevicePath (Instance
, DevicePath
);
941 // Adjust the HD_BOOT_DEVICE_PATH_VARIABLE_NAME instances sequence if the matched one is not first one.
945 // First delete the matched instance.
947 TempNewDevicePath
= CachedDevicePath
;
948 CachedDevicePath
= BdsLibDelPartMatchInstance (CachedDevicePath
, Instance
);
949 FreePool (TempNewDevicePath
);
952 // Second, append the remaining path after the matched instance
954 TempNewDevicePath
= CachedDevicePath
;
955 CachedDevicePath
= AppendDevicePathInstance (Instance
, CachedDevicePath
);
956 FreePool (TempNewDevicePath
);
958 // Save the matching Device Path so we don't need to do a connect all next time
960 Status
= gRT
->SetVariable (
961 HD_BOOT_DEVICE_PATH_VARIABLE_NAME
,
962 &gHdBootDevicePathVariablGuid
,
963 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
964 GetDevicePathSize (CachedDevicePath
),
970 FreePool (CachedDevicePath
);
971 return FullDevicePath
;
976 // If we get here we fail to find or HD_BOOT_DEVICE_PATH_VARIABLE_NAME not exist, and now we need
977 // to search all devices in the system for a matched partition
979 BdsLibConnectAllDriversToAllControllers ();
980 Status
= gBS
->LocateHandleBuffer (ByProtocol
, &gEfiBlockIoProtocolGuid
, NULL
, &BlockIoHandleCount
, &BlockIoBuffer
);
981 if (EFI_ERROR (Status
) || BlockIoHandleCount
== 0 || BlockIoBuffer
== NULL
) {
983 // If there was an error or there are no device handles that support
984 // the BLOCK_IO Protocol, then return.
989 // Loop through all the device handles that support the BLOCK_IO Protocol
991 for (Index
= 0; Index
< BlockIoHandleCount
; Index
++) {
993 Status
= gBS
->HandleProtocol (BlockIoBuffer
[Index
], &gEfiDevicePathProtocolGuid
, (VOID
*) &BlockIoDevicePath
);
994 if (EFI_ERROR (Status
) || BlockIoDevicePath
== NULL
) {
998 if (MatchPartitionDevicePathNode (BlockIoDevicePath
, HardDriveDevicePath
)) {
1000 // Find the matched partition device path
1002 DevicePath
= NextDevicePathNode ((EFI_DEVICE_PATH_PROTOCOL
*) HardDriveDevicePath
);
1003 FullDevicePath
= AppendDevicePath (BlockIoDevicePath
, DevicePath
);
1006 // Save the matched partition device path in HD_BOOT_DEVICE_PATH_VARIABLE_NAME variable
1008 if (CachedDevicePath
!= NULL
) {
1010 // Save the matched partition device path as first instance of HD_BOOT_DEVICE_PATH_VARIABLE_NAME variable
1012 if (BdsLibMatchDevicePaths (CachedDevicePath
, BlockIoDevicePath
)) {
1013 TempNewDevicePath
= CachedDevicePath
;
1014 CachedDevicePath
= BdsLibDelPartMatchInstance (CachedDevicePath
, BlockIoDevicePath
);
1015 FreePool(TempNewDevicePath
);
1017 TempNewDevicePath
= CachedDevicePath
;
1018 CachedDevicePath
= AppendDevicePathInstance (BlockIoDevicePath
, CachedDevicePath
);
1019 if (TempNewDevicePath
!= NULL
) {
1020 FreePool(TempNewDevicePath
);
1023 TempNewDevicePath
= CachedDevicePath
;
1024 CachedDevicePath
= AppendDevicePathInstance (BlockIoDevicePath
, CachedDevicePath
);
1025 FreePool(TempNewDevicePath
);
1028 // Here limit the device path instance number to 12, which is max number for a system support 3 IDE controller
1029 // If the user try to boot many OS in different HDs or partitions, in theory,
1030 // the HD_BOOT_DEVICE_PATH_VARIABLE_NAME variable maybe become larger and larger.
1033 ASSERT (CachedDevicePath
!= NULL
);
1034 TempNewDevicePath
= CachedDevicePath
;
1035 while (!IsDevicePathEnd (TempNewDevicePath
)) {
1036 TempNewDevicePath
= NextDevicePathNode (TempNewDevicePath
);
1038 // Parse one instance
1040 while (!IsDevicePathEndType (TempNewDevicePath
)) {
1041 TempNewDevicePath
= NextDevicePathNode (TempNewDevicePath
);
1045 // If the CachedDevicePath variable contain too much instance, only remain 12 instances.
1047 if (InstanceNum
>= 12) {
1048 SetDevicePathEndNode (TempNewDevicePath
);
1053 CachedDevicePath
= DuplicateDevicePath (BlockIoDevicePath
);
1057 // Save the matching Device Path so we don't need to do a connect all next time
1059 Status
= gRT
->SetVariable (
1060 HD_BOOT_DEVICE_PATH_VARIABLE_NAME
,
1061 &gHdBootDevicePathVariablGuid
,
1062 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
1063 GetDevicePathSize (CachedDevicePath
),
1071 if (CachedDevicePath
!= NULL
) {
1072 FreePool (CachedDevicePath
);
1074 if (BlockIoBuffer
!= NULL
) {
1075 FreePool (BlockIoBuffer
);
1077 return FullDevicePath
;
1081 Check whether there is a instance in BlockIoDevicePath, which contain multi device path
1082 instances, has the same partition node with HardDriveDevicePath device path
1084 @param BlockIoDevicePath Multi device path instances which need to check
1085 @param HardDriveDevicePath A device path which starts with a hard drive media
1088 @retval TRUE There is a matched device path instance.
1089 @retval FALSE There is no matched device path instance.
1094 MatchPartitionDevicePathNode (
1095 IN EFI_DEVICE_PATH_PROTOCOL
*BlockIoDevicePath
,
1096 IN HARDDRIVE_DEVICE_PATH
*HardDriveDevicePath
1099 HARDDRIVE_DEVICE_PATH
*TmpHdPath
;
1100 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1102 EFI_DEVICE_PATH_PROTOCOL
*BlockIoHdDevicePathNode
;
1104 if ((BlockIoDevicePath
== NULL
) || (HardDriveDevicePath
== NULL
)) {
1109 // Make PreviousDevicePath == the device path node before the end node
1111 DevicePath
= BlockIoDevicePath
;
1112 BlockIoHdDevicePathNode
= NULL
;
1115 // find the partition device path node
1117 while (!IsDevicePathEnd (DevicePath
)) {
1118 if ((DevicePathType (DevicePath
) == MEDIA_DEVICE_PATH
) &&
1119 (DevicePathSubType (DevicePath
) == MEDIA_HARDDRIVE_DP
)
1121 BlockIoHdDevicePathNode
= DevicePath
;
1125 DevicePath
= NextDevicePathNode (DevicePath
);
1128 if (BlockIoHdDevicePathNode
== NULL
) {
1132 // See if the harddrive device path in blockio matches the orig Hard Drive Node
1134 TmpHdPath
= (HARDDRIVE_DEVICE_PATH
*) BlockIoHdDevicePathNode
;
1138 // Check for the match
1140 if ((TmpHdPath
->MBRType
== HardDriveDevicePath
->MBRType
) &&
1141 (TmpHdPath
->SignatureType
== HardDriveDevicePath
->SignatureType
)) {
1142 switch (TmpHdPath
->SignatureType
) {
1143 case SIGNATURE_TYPE_GUID
:
1144 Match
= CompareGuid ((EFI_GUID
*)TmpHdPath
->Signature
, (EFI_GUID
*)HardDriveDevicePath
->Signature
);
1146 case SIGNATURE_TYPE_MBR
:
1147 Match
= (BOOLEAN
)(*((UINT32
*)(&(TmpHdPath
->Signature
[0]))) == ReadUnaligned32((UINT32
*)(&(HardDriveDevicePath
->Signature
[0]))));
1159 Delete the boot option associated with the handle passed in.
1161 @param Handle The handle which present the device path to create
1164 @retval EFI_SUCCESS Delete the boot option success
1165 @retval EFI_NOT_FOUND If the Device Path is not found in the system
1166 @retval EFI_OUT_OF_RESOURCES Lack of memory resource
1167 @retval Other Error return value from SetVariable()
1171 BdsLibDeleteOptionFromHandle (
1172 IN EFI_HANDLE Handle
1176 UINT8
*BootOptionVar
;
1177 UINTN BootOrderSize
;
1178 UINTN BootOptionSize
;
1181 UINT16 BootOption
[BOOT_OPTION_MAX_CHAR
];
1182 UINTN DevicePathSize
;
1183 UINTN OptionDevicePathSize
;
1184 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1185 EFI_DEVICE_PATH_PROTOCOL
*OptionDevicePath
;
1188 Status
= EFI_SUCCESS
;
1193 // Check "BootOrder" variable, if no, means there is no any boot order.
1195 BootOrder
= BdsLibGetVariableAndSize (
1197 &gEfiGlobalVariableGuid
,
1200 if (BootOrder
== NULL
) {
1201 return EFI_NOT_FOUND
;
1205 // Convert device handle to device path protocol instance
1207 DevicePath
= DevicePathFromHandle (Handle
);
1208 if (DevicePath
== NULL
) {
1209 return EFI_NOT_FOUND
;
1211 DevicePathSize
= GetDevicePathSize (DevicePath
);
1214 // Loop all boot order variable and find the matching device path
1217 while (Index
< BootOrderSize
/ sizeof (UINT16
)) {
1218 UnicodeSPrint (BootOption
, sizeof (BootOption
), L
"Boot%04x", BootOrder
[Index
]);
1219 BootOptionVar
= BdsLibGetVariableAndSize (
1221 &gEfiGlobalVariableGuid
,
1225 if (BootOptionVar
== NULL
) {
1226 FreePool (BootOrder
);
1227 return EFI_OUT_OF_RESOURCES
;
1230 TempPtr
= BootOptionVar
;
1231 TempPtr
+= sizeof (UINT32
) + sizeof (UINT16
);
1232 TempPtr
+= StrSize ((CHAR16
*) TempPtr
);
1233 OptionDevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) TempPtr
;
1234 OptionDevicePathSize
= GetDevicePathSize (OptionDevicePath
);
1237 // Check whether the device path match
1239 if ((OptionDevicePathSize
== DevicePathSize
) &&
1240 (CompareMem (DevicePath
, OptionDevicePath
, DevicePathSize
) == 0)) {
1241 BdsDeleteBootOption (BootOrder
[Index
], BootOrder
, &BootOrderSize
);
1242 FreePool (BootOptionVar
);
1246 FreePool (BootOptionVar
);
1251 // Adjust number of boot option for "BootOrder" variable.
1253 Status
= gRT
->SetVariable (
1255 &gEfiGlobalVariableGuid
,
1256 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
1261 FreePool (BootOrder
);
1268 Delete all invalid EFI boot options.
1270 @retval EFI_SUCCESS Delete all invalid boot option success
1271 @retval EFI_NOT_FOUND Variable "BootOrder" is not found
1272 @retval EFI_OUT_OF_RESOURCES Lack of memory resource
1273 @retval Other Error return value from SetVariable()
1277 BdsDeleteAllInvalidEfiBootOption (
1282 UINT8
*BootOptionVar
;
1283 UINTN BootOrderSize
;
1284 UINTN BootOptionSize
;
1288 UINT16 BootOption
[BOOT_OPTION_MAX_CHAR
];
1289 EFI_DEVICE_PATH_PROTOCOL
*OptionDevicePath
;
1291 CHAR16
*Description
;
1293 Status
= EFI_SUCCESS
;
1298 // Check "BootOrder" variable firstly, this variable hold the number of boot options
1300 BootOrder
= BdsLibGetVariableAndSize (
1302 &gEfiGlobalVariableGuid
,
1305 if (NULL
== BootOrder
) {
1306 return EFI_NOT_FOUND
;
1310 while (Index
< BootOrderSize
/ sizeof (UINT16
)) {
1311 UnicodeSPrint (BootOption
, sizeof (BootOption
), L
"Boot%04x", BootOrder
[Index
]);
1312 BootOptionVar
= BdsLibGetVariableAndSize (
1314 &gEfiGlobalVariableGuid
,
1317 if (NULL
== BootOptionVar
) {
1318 FreePool (BootOrder
);
1319 return EFI_OUT_OF_RESOURCES
;
1322 TempPtr
= BootOptionVar
;
1323 TempPtr
+= sizeof (UINT32
) + sizeof (UINT16
);
1324 Description
= (CHAR16
*) TempPtr
;
1325 TempPtr
+= StrSize ((CHAR16
*) TempPtr
);
1326 OptionDevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) TempPtr
;
1329 // Skip legacy boot option (BBS boot device)
1331 if ((DevicePathType (OptionDevicePath
) == BBS_DEVICE_PATH
) &&
1332 (DevicePathSubType (OptionDevicePath
) == BBS_BBS_DP
)) {
1333 FreePool (BootOptionVar
);
1338 if (!BdsLibIsValidEFIBootOptDevicePathExt (OptionDevicePath
, FALSE
, Description
)) {
1340 // Delete this invalid boot option "Boot####"
1342 Status
= gRT
->SetVariable (
1344 &gEfiGlobalVariableGuid
,
1345 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
1350 // Mark this boot option in boot order as deleted
1352 BootOrder
[Index
] = 0xffff;
1355 FreePool (BootOptionVar
);
1360 // Adjust boot order array
1363 for (Index
= 0; Index
< BootOrderSize
/ sizeof (UINT16
); Index
++) {
1364 if (BootOrder
[Index
] != 0xffff) {
1365 BootOrder
[Index2
] = BootOrder
[Index
];
1369 Status
= gRT
->SetVariable (
1371 &gEfiGlobalVariableGuid
,
1372 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
1373 Index2
* sizeof (UINT16
),
1377 FreePool (BootOrder
);
1384 For EFI boot option, BDS separate them as six types:
1385 1. Network - The boot option points to the SimpleNetworkProtocol device.
1386 Bds will try to automatically create this type boot option when enumerate.
1387 2. Shell - The boot option points to internal flash shell.
1388 Bds will try to automatically create this type boot option when enumerate.
1389 3. Removable BlockIo - The boot option only points to the removable media
1390 device, like USB flash disk, DVD, Floppy etc.
1391 These device should contain a *removable* blockIo
1392 protocol in their device handle.
1393 Bds will try to automatically create this type boot option
1395 4. Fixed BlockIo - The boot option only points to a Fixed blockIo device,
1397 These device should contain a *fixed* blockIo
1398 protocol in their device handle.
1399 BDS will skip fixed blockIo devices, and NOT
1400 automatically create boot option for them. But BDS
1401 will help to delete those fixed blockIo boot option,
1402 whose description rule conflict with other auto-created
1404 5. Non-BlockIo Simplefile - The boot option points to a device whose handle
1405 has SimpleFileSystem Protocol, but has no blockio
1406 protocol. These devices do not offer blockIo
1407 protocol, but BDS still can get the
1408 \EFI\BOOT\boot{machinename}.EFI by SimpleFileSystem
1410 6. File - The boot option points to a file. These boot options are usually
1411 created by user manually or OS loader. BDS will not delete or modify
1414 This function will enumerate all possible boot device in the system, and
1415 automatically create boot options for Network, Shell, Removable BlockIo,
1416 and Non-BlockIo Simplefile devices.
1417 It will only execute once of every boot.
1419 @param BdsBootOptionList The header of the link list which indexed all
1420 current boot options
1422 @retval EFI_SUCCESS Finished all the boot device enumerate and create
1423 the boot option base on that boot device
1425 @retval EFI_OUT_OF_RESOURCES Failed to enumerate the boot device and create the boot option list
1429 BdsLibEnumerateAllBootOption (
1430 IN OUT LIST_ENTRY
*BdsBootOptionList
1434 UINT16 FloppyNumber
;
1435 UINT16 HarddriveNumber
;
1440 UINT16 NonBlockNumber
;
1441 UINTN NumberBlockIoHandles
;
1442 EFI_HANDLE
*BlockIoHandles
;
1443 EFI_BLOCK_IO_PROTOCOL
*BlkIo
;
1444 BOOLEAN Removable
[2];
1445 UINTN RemovableIndex
;
1447 UINTN NumOfLoadFileHandles
;
1448 EFI_HANDLE
*LoadFileHandles
;
1449 UINTN FvHandleCount
;
1450 EFI_HANDLE
*FvHandleBuffer
;
1451 EFI_FV_FILETYPE Type
;
1453 EFI_FV_FILE_ATTRIBUTES Attributes
;
1454 UINT32 AuthenticationStatus
;
1455 EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
;
1456 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1457 UINTN DevicePathType
;
1459 EFI_HANDLE
*FileSystemHandles
;
1460 UINTN NumberFileSystemHandles
;
1462 EFI_IMAGE_DOS_HEADER DosHeader
;
1465 EFI_IMAGE_OPTIONAL_HEADER_UNION HdrData
;
1466 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
;
1469 HarddriveNumber
= 0;
1476 ZeroMem (Buffer
, sizeof (Buffer
));
1479 // If the boot device enumerate happened, just get the boot
1480 // device from the boot order variable
1482 if (mEnumBootDevice
) {
1483 LastLang
= GetVariable (LAST_ENUM_LANGUAGE_VARIABLE_NAME
, &gLastEnumLangGuid
);
1484 PlatLang
= GetEfiGlobalVariable (L
"PlatformLang");
1485 ASSERT (PlatLang
!= NULL
);
1486 if ((LastLang
!= NULL
) && (AsciiStrCmp (LastLang
, PlatLang
) == 0)) {
1487 Status
= BdsLibBuildOptionFromVar (BdsBootOptionList
, L
"BootOrder");
1488 FreePool (LastLang
);
1489 FreePool (PlatLang
);
1492 Status
= gRT
->SetVariable (
1493 LAST_ENUM_LANGUAGE_VARIABLE_NAME
,
1495 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
1496 AsciiStrSize (PlatLang
),
1499 ASSERT_EFI_ERROR (Status
);
1501 if (LastLang
!= NULL
) {
1502 FreePool (LastLang
);
1504 FreePool (PlatLang
);
1509 // Notes: this dirty code is to get the legacy boot option from the
1510 // BBS table and create to variable as the EFI boot option, it should
1511 // be removed after the CSM can provide legacy boot option directly
1513 REFRESH_LEGACY_BOOT_OPTIONS
;
1516 // Delete invalid boot option
1518 BdsDeleteAllInvalidEfiBootOption ();
1521 // Parse removable media followed by fixed media.
1522 // The Removable[] array is used by the for-loop below to create removable media boot options
1523 // at first, and then to create fixed media boot options.
1525 Removable
[0] = FALSE
;
1526 Removable
[1] = TRUE
;
1528 gBS
->LocateHandleBuffer (
1530 &gEfiBlockIoProtocolGuid
,
1532 &NumberBlockIoHandles
,
1536 for (RemovableIndex
= 0; RemovableIndex
< 2; RemovableIndex
++) {
1537 for (Index
= 0; Index
< NumberBlockIoHandles
; Index
++) {
1538 Status
= gBS
->HandleProtocol (
1539 BlockIoHandles
[Index
],
1540 &gEfiBlockIoProtocolGuid
,
1544 // skip the fixed block io then the removable block io
1546 if (EFI_ERROR (Status
) || (BlkIo
->Media
->RemovableMedia
== Removable
[RemovableIndex
])) {
1549 DevicePath
= DevicePathFromHandle (BlockIoHandles
[Index
]);
1550 DevicePathType
= BdsGetBootTypeFromDevicePath (DevicePath
);
1552 switch (DevicePathType
) {
1553 case BDS_EFI_ACPI_FLOPPY_BOOT
:
1554 if (FloppyNumber
!= 0) {
1555 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_FLOPPY
)), FloppyNumber
);
1557 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_FLOPPY
)));
1559 BdsLibBuildOptionFromHandle (BlockIoHandles
[Index
], BdsBootOptionList
, Buffer
);
1564 // Assume a removable SATA device should be the DVD/CD device, a fixed SATA device should be the Hard Drive device.
1566 case BDS_EFI_MESSAGE_ATAPI_BOOT
:
1567 case BDS_EFI_MESSAGE_SATA_BOOT
:
1568 if (BlkIo
->Media
->RemovableMedia
) {
1569 if (CdromNumber
!= 0) {
1570 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_CD_DVD
)), CdromNumber
);
1572 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_CD_DVD
)));
1576 if (HarddriveNumber
!= 0) {
1577 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_HARDDRIVE
)), HarddriveNumber
);
1579 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_HARDDRIVE
)));
1583 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Buffer: %S\n", Buffer
));
1584 BdsLibBuildOptionFromHandle (BlockIoHandles
[Index
], BdsBootOptionList
, Buffer
);
1587 case BDS_EFI_MESSAGE_USB_DEVICE_BOOT
:
1588 if (UsbNumber
!= 0) {
1589 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_USB
)), UsbNumber
);
1591 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_USB
)));
1593 BdsLibBuildOptionFromHandle (BlockIoHandles
[Index
], BdsBootOptionList
, Buffer
);
1597 case BDS_EFI_MESSAGE_SCSI_BOOT
:
1598 if (ScsiNumber
!= 0) {
1599 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_SCSI
)), ScsiNumber
);
1601 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_SCSI
)));
1603 BdsLibBuildOptionFromHandle (BlockIoHandles
[Index
], BdsBootOptionList
, Buffer
);
1607 case BDS_EFI_MESSAGE_MISC_BOOT
:
1608 if (MiscNumber
!= 0) {
1609 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_MISC
)), MiscNumber
);
1611 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_MISC
)));
1613 BdsLibBuildOptionFromHandle (BlockIoHandles
[Index
], BdsBootOptionList
, Buffer
);
1623 if (NumberBlockIoHandles
!= 0) {
1624 FreePool (BlockIoHandles
);
1628 // If there is simple file protocol which does not consume block Io protocol, create a boot option for it here.
1631 gBS
->LocateHandleBuffer (
1633 &gEfiSimpleFileSystemProtocolGuid
,
1635 &NumberFileSystemHandles
,
1638 for (Index
= 0; Index
< NumberFileSystemHandles
; Index
++) {
1639 Status
= gBS
->HandleProtocol (
1640 FileSystemHandles
[Index
],
1641 &gEfiBlockIoProtocolGuid
,
1644 if (!EFI_ERROR (Status
)) {
1646 // Skip if the file system handle supports a BlkIo protocol,
1652 // Do the removable Media thing. \EFI\BOOT\boot{machinename}.EFI
1653 // machinename is ia32, ia64, x64, ...
1655 Hdr
.Union
= &HdrData
;
1657 Status
= BdsLibGetImageHeader (
1658 FileSystemHandles
[Index
],
1659 EFI_REMOVABLE_MEDIA_FILE_NAME
,
1663 if (!EFI_ERROR (Status
) &&
1664 EFI_IMAGE_MACHINE_TYPE_SUPPORTED (Hdr
.Pe32
->FileHeader
.Machine
) &&
1665 Hdr
.Pe32
->OptionalHeader
.Subsystem
== EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION
) {
1671 // No such file or the file is not a EFI application, delete this boot option
1673 BdsLibDeleteOptionFromHandle (FileSystemHandles
[Index
]);
1675 if (NonBlockNumber
!= 0) {
1676 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NON_BLOCK
)), NonBlockNumber
);
1678 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NON_BLOCK
)));
1680 BdsLibBuildOptionFromHandle (FileSystemHandles
[Index
], BdsBootOptionList
, Buffer
);
1685 if (NumberFileSystemHandles
!= 0) {
1686 FreePool (FileSystemHandles
);
1690 // Parse Network Boot Device
1692 NumOfLoadFileHandles
= 0;
1694 // Search Load File protocol for PXE boot option.
1696 gBS
->LocateHandleBuffer (
1698 &gEfiLoadFileProtocolGuid
,
1700 &NumOfLoadFileHandles
,
1704 for (Index
= 0; Index
< NumOfLoadFileHandles
; Index
++) {
1706 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NETWORK
)), Index
);
1708 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NETWORK
)));
1710 BdsLibBuildOptionFromHandle (LoadFileHandles
[Index
], BdsBootOptionList
, Buffer
);
1713 if (NumOfLoadFileHandles
!= 0) {
1714 FreePool (LoadFileHandles
);
1718 // Check if we have on flash shell
1720 gBS
->LocateHandleBuffer (
1722 &gEfiFirmwareVolume2ProtocolGuid
,
1727 for (Index
= 0; Index
< FvHandleCount
; Index
++) {
1728 gBS
->HandleProtocol (
1729 FvHandleBuffer
[Index
],
1730 &gEfiFirmwareVolume2ProtocolGuid
,
1734 Status
= Fv
->ReadFile (
1736 PcdGetPtr(PcdShellFile
),
1741 &AuthenticationStatus
1743 if (EFI_ERROR (Status
)) {
1745 // Skip if no shell file in the FV
1750 // Build the shell boot option
1752 BdsLibBuildOptionFromShell (FvHandleBuffer
[Index
], BdsBootOptionList
);
1755 if (FvHandleCount
!= 0) {
1756 FreePool (FvHandleBuffer
);
1759 // Make sure every boot only have one time
1760 // boot device enumerate
1762 Status
= BdsLibBuildOptionFromVar (BdsBootOptionList
, L
"BootOrder");
1763 mEnumBootDevice
= TRUE
;
1769 Build the boot option with the handle parsed in
1771 @param Handle The handle which present the device path to create
1773 @param BdsBootOptionList The header of the link list which indexed all
1774 current boot options
1775 @param String The description of the boot option.
1780 BdsLibBuildOptionFromHandle (
1781 IN EFI_HANDLE Handle
,
1782 IN LIST_ENTRY
*BdsBootOptionList
,
1786 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1788 DevicePath
= DevicePathFromHandle (Handle
);
1791 // Create and register new boot option
1793 BdsLibRegisterNewOption (BdsBootOptionList
, DevicePath
, String
, L
"BootOrder");
1798 Build the on flash shell boot option with the handle parsed in.
1800 @param Handle The handle which present the device path to create
1801 on flash shell boot option
1802 @param BdsBootOptionList The header of the link list which indexed all
1803 current boot options
1808 BdsLibBuildOptionFromShell (
1809 IN EFI_HANDLE Handle
,
1810 IN OUT LIST_ENTRY
*BdsBootOptionList
1813 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1814 MEDIA_FW_VOL_FILEPATH_DEVICE_PATH ShellNode
;
1816 DevicePath
= DevicePathFromHandle (Handle
);
1819 // Build the shell device path
1821 EfiInitializeFwVolDevicepathNode (&ShellNode
, PcdGetPtr(PcdShellFile
));
1823 DevicePath
= AppendDevicePathNode (DevicePath
, (EFI_DEVICE_PATH_PROTOCOL
*) &ShellNode
);
1826 // Create and register the shell boot option
1828 BdsLibRegisterNewOption (BdsBootOptionList
, DevicePath
, L
"EFI Internal Shell", L
"BootOrder");
1833 Boot from the UEFI spec defined "BootNext" variable.
1845 BDS_COMMON_OPTION
*BootOption
;
1846 LIST_ENTRY TempList
;
1851 // Init the boot option name buffer and temp link list
1853 InitializeListHead (&TempList
);
1854 ZeroMem (Buffer
, sizeof (Buffer
));
1856 BootNext
= BdsLibGetVariableAndSize (
1858 &gEfiGlobalVariableGuid
,
1863 // Clear the boot next variable first
1865 if (BootNext
!= NULL
) {
1868 &gEfiGlobalVariableGuid
,
1869 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
1875 // Start to build the boot option and try to boot
1877 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"Boot%04x", *BootNext
);
1878 BootOption
= BdsLibVariableToOption (&TempList
, Buffer
);
1879 ASSERT (BootOption
!= NULL
);
1880 BdsLibConnectDevicePath (BootOption
->DevicePath
);
1881 BdsLibBootViaBootOption (BootOption
, BootOption
->DevicePath
, &ExitDataSize
, &ExitData
);
1887 Return the bootable media handle.
1888 First, check the device is connected
1889 Second, check whether the device path point to a device which support SimpleFileSystemProtocol,
1890 Third, detect the the default boot file in the Media, and return the removable Media handle.
1892 @param DevicePath Device Path to a bootable device
1894 @return The bootable media handle. If the media on the DevicePath is not bootable, NULL will return.
1899 BdsLibGetBootableHandle (
1900 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
1905 EFI_DEVICE_PATH_PROTOCOL
*UpdatedDevicePath
;
1906 EFI_DEVICE_PATH_PROTOCOL
*DupDevicePath
;
1908 EFI_BLOCK_IO_PROTOCOL
*BlockIo
;
1910 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
1913 EFI_HANDLE ReturnHandle
;
1914 EFI_HANDLE
*SimpleFileSystemHandles
;
1916 UINTN NumberSimpleFileSystemHandles
;
1918 EFI_IMAGE_DOS_HEADER DosHeader
;
1919 EFI_IMAGE_OPTIONAL_HEADER_UNION HdrData
;
1920 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
;
1922 UpdatedDevicePath
= DevicePath
;
1925 // Enter to critical section to protect the acquired BlockIo instance
1926 // from getting released due to the USB mass storage hotplug event
1928 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1931 // Check whether the device is connected
1933 Status
= gBS
->LocateDevicePath (&gEfiBlockIoProtocolGuid
, &UpdatedDevicePath
, &Handle
);
1934 if (EFI_ERROR (Status
)) {
1936 // Skip the case that the boot option point to a simple file protocol which does not consume block Io protocol,
1938 Status
= gBS
->LocateDevicePath (&gEfiSimpleFileSystemProtocolGuid
, &UpdatedDevicePath
, &Handle
);
1939 if (EFI_ERROR (Status
)) {
1941 // Fail to find the proper BlockIo and simple file protocol, maybe because device not present, we need to connect it firstly
1943 UpdatedDevicePath
= DevicePath
;
1944 Status
= gBS
->LocateDevicePath (&gEfiDevicePathProtocolGuid
, &UpdatedDevicePath
, &Handle
);
1945 gBS
->ConnectController (Handle
, NULL
, NULL
, TRUE
);
1949 // For removable device boot option, its contained device path only point to the removable device handle,
1950 // should make sure all its children handles (its child partion or media handles) are created and connected.
1952 gBS
->ConnectController (Handle
, NULL
, NULL
, TRUE
);
1954 // Get BlockIo protocol and check removable attribute
1956 Status
= gBS
->HandleProtocol (Handle
, &gEfiBlockIoProtocolGuid
, (VOID
**)&BlockIo
);
1957 ASSERT_EFI_ERROR (Status
);
1960 // Issue a dummy read to the device to check for media change.
1961 // When the removable media is changed, any Block IO read/write will
1962 // cause the BlockIo protocol be reinstalled and EFI_MEDIA_CHANGED is
1963 // returned. After the Block IO protocol is reinstalled, subsequent
1964 // Block IO read/write will success.
1966 Buffer
= AllocatePool (BlockIo
->Media
->BlockSize
);
1967 if (Buffer
!= NULL
) {
1968 BlockIo
->ReadBlocks (
1970 BlockIo
->Media
->MediaId
,
1972 BlockIo
->Media
->BlockSize
,
1980 // Detect the the default boot file from removable Media
1984 // 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
1985 // Try to locate the USB node device path first, if fail then use its previous PCI node to search
1987 DupDevicePath
= DuplicateDevicePath (DevicePath
);
1988 ASSERT (DupDevicePath
!= NULL
);
1990 UpdatedDevicePath
= DupDevicePath
;
1991 Status
= gBS
->LocateDevicePath (&gEfiDevicePathProtocolGuid
, &UpdatedDevicePath
, &Handle
);
1993 // 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
1994 // Acpi()/Pci()/Usb() --> Acpi()/Pci()
1996 if ((DevicePathType (UpdatedDevicePath
) == MESSAGING_DEVICE_PATH
) &&
1997 (DevicePathSubType (UpdatedDevicePath
) == MSG_USB_DP
)) {
1999 // Remove the usb node, let the device path only point to PCI node
2001 SetDevicePathEndNode (UpdatedDevicePath
);
2002 UpdatedDevicePath
= DupDevicePath
;
2004 UpdatedDevicePath
= DevicePath
;
2008 // Get the device path size of boot option
2010 Size
= GetDevicePathSize(UpdatedDevicePath
) - sizeof (EFI_DEVICE_PATH_PROTOCOL
); // minus the end node
2011 ReturnHandle
= NULL
;
2012 gBS
->LocateHandleBuffer (
2014 &gEfiSimpleFileSystemProtocolGuid
,
2016 &NumberSimpleFileSystemHandles
,
2017 &SimpleFileSystemHandles
2019 for (Index
= 0; Index
< NumberSimpleFileSystemHandles
; Index
++) {
2021 // Get the device path size of SimpleFileSystem handle
2023 TempDevicePath
= DevicePathFromHandle (SimpleFileSystemHandles
[Index
]);
2024 TempSize
= GetDevicePathSize (TempDevicePath
)- sizeof (EFI_DEVICE_PATH_PROTOCOL
); // minus the end node
2026 // Check whether the device path of boot option is part of the SimpleFileSystem handle's device path
2028 if (Size
<= TempSize
&& CompareMem (TempDevicePath
, UpdatedDevicePath
, Size
)==0) {
2030 // Load the default boot file \EFI\BOOT\boot{machinename}.EFI from removable Media
2031 // machinename is ia32, ia64, x64, ...
2033 Hdr
.Union
= &HdrData
;
2034 Status
= BdsLibGetImageHeader (
2035 SimpleFileSystemHandles
[Index
],
2036 EFI_REMOVABLE_MEDIA_FILE_NAME
,
2040 if (!EFI_ERROR (Status
) &&
2041 EFI_IMAGE_MACHINE_TYPE_SUPPORTED (Hdr
.Pe32
->FileHeader
.Machine
) &&
2042 Hdr
.Pe32
->OptionalHeader
.Subsystem
== EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION
) {
2043 ReturnHandle
= SimpleFileSystemHandles
[Index
];
2049 FreePool(DupDevicePath
);
2051 if (SimpleFileSystemHandles
!= NULL
) {
2052 FreePool(SimpleFileSystemHandles
);
2055 gBS
->RestoreTPL (OldTpl
);
2057 return ReturnHandle
;
2061 Check to see if the network cable is plugged in. If the DevicePath is not
2062 connected it will be connected.
2064 @param DevicePath Device Path to check
2066 @retval TRUE DevicePath points to an Network that is connected
2067 @retval FALSE DevicePath does not point to a bootable network
2071 BdsLibNetworkBootWithMediaPresent (
2072 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
2076 EFI_DEVICE_PATH_PROTOCOL
*UpdatedDevicePath
;
2078 EFI_SIMPLE_NETWORK_PROTOCOL
*Snp
;
2079 BOOLEAN MediaPresent
;
2080 UINT32 InterruptStatus
;
2082 MediaPresent
= FALSE
;
2084 UpdatedDevicePath
= DevicePath
;
2086 // Locate Load File Protocol for PXE boot option first
2088 Status
= gBS
->LocateDevicePath (&gEfiLoadFileProtocolGuid
, &UpdatedDevicePath
, &Handle
);
2089 if (EFI_ERROR (Status
)) {
2091 // Device not present so see if we need to connect it
2093 Status
= BdsLibConnectDevicePath (DevicePath
);
2094 if (!EFI_ERROR (Status
)) {
2096 // This one should work after we did the connect
2098 Status
= gBS
->LocateDevicePath (&gEfiLoadFileProtocolGuid
, &UpdatedDevicePath
, &Handle
);
2102 if (!EFI_ERROR (Status
)) {
2103 Status
= gBS
->HandleProtocol (Handle
, &gEfiSimpleNetworkProtocolGuid
, (VOID
**)&Snp
);
2104 if (EFI_ERROR (Status
)) {
2106 // Failed to open SNP from this handle, try to get SNP from parent handle
2108 UpdatedDevicePath
= DevicePathFromHandle (Handle
);
2109 if (UpdatedDevicePath
!= NULL
) {
2110 Status
= gBS
->LocateDevicePath (&gEfiSimpleNetworkProtocolGuid
, &UpdatedDevicePath
, &Handle
);
2111 if (!EFI_ERROR (Status
)) {
2113 // SNP handle found, get SNP from it
2115 Status
= gBS
->HandleProtocol (Handle
, &gEfiSimpleNetworkProtocolGuid
, (VOID
**) &Snp
);
2120 if (!EFI_ERROR (Status
)) {
2121 if (Snp
->Mode
->MediaPresentSupported
) {
2122 if (Snp
->Mode
->State
== EfiSimpleNetworkInitialized
) {
2124 // Invoke Snp->GetStatus() to refresh the media status
2126 Snp
->GetStatus (Snp
, &InterruptStatus
, NULL
);
2129 // In case some one else is using the SNP check to see if it's connected
2131 MediaPresent
= Snp
->Mode
->MediaPresent
;
2134 // No one is using SNP so we need to Start and Initialize so
2135 // MediaPresent will be valid.
2137 Status
= Snp
->Start (Snp
);
2138 if (!EFI_ERROR (Status
)) {
2139 Status
= Snp
->Initialize (Snp
, 0, 0);
2140 if (!EFI_ERROR (Status
)) {
2141 MediaPresent
= Snp
->Mode
->MediaPresent
;
2142 Snp
->Shutdown (Snp
);
2148 MediaPresent
= TRUE
;
2153 return MediaPresent
;
2157 For a bootable Device path, return its boot type.
2159 @param DevicePath The bootable device Path to check
2161 @retval BDS_EFI_MEDIA_HD_BOOT If given device path contains MEDIA_DEVICE_PATH type device path node
2162 which subtype is MEDIA_HARDDRIVE_DP
2163 @retval BDS_EFI_MEDIA_CDROM_BOOT If given device path contains MEDIA_DEVICE_PATH type device path node
2164 which subtype is MEDIA_CDROM_DP
2165 @retval BDS_EFI_ACPI_FLOPPY_BOOT If given device path contains ACPI_DEVICE_PATH type device path node
2166 which HID is floppy device.
2167 @retval BDS_EFI_MESSAGE_ATAPI_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node
2168 and its last device path node's subtype is MSG_ATAPI_DP.
2169 @retval BDS_EFI_MESSAGE_SCSI_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node
2170 and its last device path node's subtype is MSG_SCSI_DP.
2171 @retval BDS_EFI_MESSAGE_USB_DEVICE_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node
2172 and its last device path node's subtype is MSG_USB_DP.
2173 @retval BDS_EFI_MESSAGE_MISC_BOOT If the device path not contains any media device path node, and
2174 its last device path node point to a message device path node.
2175 @retval BDS_LEGACY_BBS_BOOT If given device path contains BBS_DEVICE_PATH type device path node.
2176 @retval BDS_EFI_UNSUPPORT An EFI Removable BlockIO device path not point to a media and message device,
2181 BdsGetBootTypeFromDevicePath (
2182 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
2185 ACPI_HID_DEVICE_PATH
*Acpi
;
2186 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
2187 EFI_DEVICE_PATH_PROTOCOL
*LastDeviceNode
;
2190 if (NULL
== DevicePath
) {
2191 return BDS_EFI_UNSUPPORT
;
2194 TempDevicePath
= DevicePath
;
2196 while (!IsDevicePathEndType (TempDevicePath
)) {
2197 switch (DevicePathType (TempDevicePath
)) {
2198 case BBS_DEVICE_PATH
:
2199 return BDS_LEGACY_BBS_BOOT
;
2200 case MEDIA_DEVICE_PATH
:
2201 if (DevicePathSubType (TempDevicePath
) == MEDIA_HARDDRIVE_DP
) {
2202 return BDS_EFI_MEDIA_HD_BOOT
;
2203 } else if (DevicePathSubType (TempDevicePath
) == MEDIA_CDROM_DP
) {
2204 return BDS_EFI_MEDIA_CDROM_BOOT
;
2207 case ACPI_DEVICE_PATH
:
2208 Acpi
= (ACPI_HID_DEVICE_PATH
*) TempDevicePath
;
2209 if (EISA_ID_TO_NUM (Acpi
->HID
) == 0x0604) {
2210 return BDS_EFI_ACPI_FLOPPY_BOOT
;
2213 case MESSAGING_DEVICE_PATH
:
2215 // Get the last device path node
2217 LastDeviceNode
= NextDevicePathNode (TempDevicePath
);
2218 if (DevicePathSubType(LastDeviceNode
) == MSG_DEVICE_LOGICAL_UNIT_DP
) {
2220 // if the next node type is Device Logical Unit, which specify the Logical Unit Number (LUN),
2223 LastDeviceNode
= NextDevicePathNode (LastDeviceNode
);
2226 // if the device path not only point to driver device, it is not a messaging device path,
2228 if (!IsDevicePathEndType (LastDeviceNode
)) {
2232 switch (DevicePathSubType (TempDevicePath
)) {
2234 BootType
= BDS_EFI_MESSAGE_ATAPI_BOOT
;
2238 BootType
= BDS_EFI_MESSAGE_USB_DEVICE_BOOT
;
2242 BootType
= BDS_EFI_MESSAGE_SCSI_BOOT
;
2246 BootType
= BDS_EFI_MESSAGE_SATA_BOOT
;
2249 case MSG_MAC_ADDR_DP
:
2253 BootType
= BDS_EFI_MESSAGE_MAC_BOOT
;
2257 BootType
= BDS_EFI_MESSAGE_MISC_BOOT
;
2265 TempDevicePath
= NextDevicePathNode (TempDevicePath
);
2268 return BDS_EFI_UNSUPPORT
;
2272 Check whether the Device path in a boot option point to a valid bootable device,
2273 And if CheckMedia is true, check the device is ready to boot now.
2275 @param DevPath the Device path in a boot option
2276 @param CheckMedia if true, check the device is ready to boot now.
2278 @retval TRUE the Device path is valid
2279 @retval FALSE the Device path is invalid .
2284 BdsLibIsValidEFIBootOptDevicePath (
2285 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
,
2286 IN BOOLEAN CheckMedia
2289 return BdsLibIsValidEFIBootOptDevicePathExt (DevPath
, CheckMedia
, NULL
);
2293 Check whether the Device path in a boot option point to a valid bootable device,
2294 And if CheckMedia is true, check the device is ready to boot now.
2295 If Description is not NULL and the device path point to a fixed BlockIo
2296 device, check the description whether conflict with other auto-created
2299 @param DevPath the Device path in a boot option
2300 @param CheckMedia if true, check the device is ready to boot now.
2301 @param Description the description in a boot option
2303 @retval TRUE the Device path is valid
2304 @retval FALSE the Device path is invalid .
2309 BdsLibIsValidEFIBootOptDevicePathExt (
2310 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
,
2311 IN BOOLEAN CheckMedia
,
2312 IN CHAR16
*Description
2317 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
2318 EFI_DEVICE_PATH_PROTOCOL
*LastDeviceNode
;
2319 EFI_BLOCK_IO_PROTOCOL
*BlockIo
;
2321 TempDevicePath
= DevPath
;
2322 LastDeviceNode
= DevPath
;
2325 // Check if it's a valid boot option for network boot device.
2326 // Check if there is EfiLoadFileProtocol installed.
2327 // If yes, that means there is a boot option for network.
2329 Status
= gBS
->LocateDevicePath (
2330 &gEfiLoadFileProtocolGuid
,
2334 if (EFI_ERROR (Status
)) {
2336 // Device not present so see if we need to connect it
2338 TempDevicePath
= DevPath
;
2339 BdsLibConnectDevicePath (TempDevicePath
);
2340 Status
= gBS
->LocateDevicePath (
2341 &gEfiLoadFileProtocolGuid
,
2347 if (!EFI_ERROR (Status
)) {
2348 if (!IsDevicePathEnd (TempDevicePath
)) {
2350 // LoadFile protocol is not installed on handle with exactly the same DevPath
2357 // Test if it is ready to boot now
2359 if (BdsLibNetworkBootWithMediaPresent(DevPath
)) {
2368 // If the boot option point to a file, it is a valid EFI boot option,
2369 // and assume it is ready to boot now
2371 while (!IsDevicePathEnd (TempDevicePath
)) {
2373 // If there is USB Class or USB WWID device path node, treat it as valid EFI
2374 // Boot Option. BdsExpandUsbShortFormDevicePath () will be used to expand it
2375 // to full device path.
2377 if ((DevicePathType (TempDevicePath
) == MESSAGING_DEVICE_PATH
) &&
2378 ((DevicePathSubType (TempDevicePath
) == MSG_USB_CLASS_DP
) ||
2379 (DevicePathSubType (TempDevicePath
) == MSG_USB_WWID_DP
))) {
2383 LastDeviceNode
= TempDevicePath
;
2384 TempDevicePath
= NextDevicePathNode (TempDevicePath
);
2386 if ((DevicePathType (LastDeviceNode
) == MEDIA_DEVICE_PATH
) &&
2387 (DevicePathSubType (LastDeviceNode
) == MEDIA_FILEPATH_DP
)) {
2392 // Check if it's a valid boot option for internal FV application
2394 if (EfiGetNameGuidFromFwVolDevicePathNode ((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
*) LastDeviceNode
) != NULL
) {
2396 // If the boot option point to internal FV application, make sure it is valid
2398 TempDevicePath
= DevPath
;
2399 Status
= BdsLibUpdateFvFileDevicePath (
2401 EfiGetNameGuidFromFwVolDevicePathNode ((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
*) LastDeviceNode
)
2403 if (Status
== EFI_ALREADY_STARTED
) {
2406 if (Status
== EFI_SUCCESS
) {
2407 FreePool (TempDevicePath
);
2414 // If the boot option point to a blockIO device:
2415 // if it is a removable blockIo device, it is valid.
2416 // if it is a fixed blockIo device, check its description confliction.
2418 TempDevicePath
= DevPath
;
2419 Status
= gBS
->LocateDevicePath (&gEfiBlockIoProtocolGuid
, &TempDevicePath
, &Handle
);
2420 if (EFI_ERROR (Status
)) {
2422 // Device not present so see if we need to connect it
2424 Status
= BdsLibConnectDevicePath (DevPath
);
2425 if (!EFI_ERROR (Status
)) {
2427 // Try again to get the Block Io protocol after we did the connect
2429 TempDevicePath
= DevPath
;
2430 Status
= gBS
->LocateDevicePath (&gEfiBlockIoProtocolGuid
, &TempDevicePath
, &Handle
);
2434 if (!EFI_ERROR (Status
)) {
2435 Status
= gBS
->HandleProtocol (Handle
, &gEfiBlockIoProtocolGuid
, (VOID
**)&BlockIo
);
2436 if (!EFI_ERROR (Status
)) {
2439 // Test if it is ready to boot now
2441 if (BdsLibGetBootableHandle (DevPath
) != NULL
) {
2450 // 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,
2452 Status
= gBS
->LocateDevicePath (&gEfiSimpleFileSystemProtocolGuid
, &TempDevicePath
, &Handle
);
2453 if (!EFI_ERROR (Status
)) {
2456 // Test if it is ready to boot now
2458 if (BdsLibGetBootableHandle (DevPath
) != NULL
) {
2472 According to a file guild, check a Fv file device path is valid. If it is invalid,
2473 try to return the valid device path.
2474 FV address maybe changes for memory layout adjust from time to time, use this function
2475 could promise the Fv file device path is right.
2477 @param DevicePath on input, the Fv file device path need to check on
2478 output, the updated valid Fv file device path
2479 @param FileGuid the Fv file guild
2481 @retval EFI_INVALID_PARAMETER the input DevicePath or FileGuid is invalid
2483 @retval EFI_UNSUPPORTED the input DevicePath does not contain Fv file
2485 @retval EFI_ALREADY_STARTED the input DevicePath has pointed to Fv file, it is
2487 @retval EFI_SUCCESS has successfully updated the invalid DevicePath,
2488 and return the updated device path in DevicePath
2493 BdsLibUpdateFvFileDevicePath (
2494 IN OUT EFI_DEVICE_PATH_PROTOCOL
** DevicePath
,
2495 IN EFI_GUID
*FileGuid
2498 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
2499 EFI_DEVICE_PATH_PROTOCOL
*LastDeviceNode
;
2501 EFI_GUID
*GuidPoint
;
2503 UINTN FvHandleCount
;
2504 EFI_HANDLE
*FvHandleBuffer
;
2505 EFI_FV_FILETYPE Type
;
2507 EFI_FV_FILE_ATTRIBUTES Attributes
;
2508 UINT32 AuthenticationStatus
;
2510 EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
;
2511 EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
;
2512 MEDIA_FW_VOL_FILEPATH_DEVICE_PATH FvFileNode
;
2513 EFI_HANDLE FoundFvHandle
;
2514 EFI_DEVICE_PATH_PROTOCOL
*NewDevicePath
;
2516 if ((DevicePath
== NULL
) || (*DevicePath
== NULL
)) {
2517 return EFI_INVALID_PARAMETER
;
2519 if (FileGuid
== NULL
) {
2520 return EFI_INVALID_PARAMETER
;
2524 // Check whether the device path point to the default the input Fv file
2526 TempDevicePath
= *DevicePath
;
2527 LastDeviceNode
= TempDevicePath
;
2528 while (!IsDevicePathEnd (TempDevicePath
)) {
2529 LastDeviceNode
= TempDevicePath
;
2530 TempDevicePath
= NextDevicePathNode (TempDevicePath
);
2532 GuidPoint
= EfiGetNameGuidFromFwVolDevicePathNode (
2533 (MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
*) LastDeviceNode
2535 if (GuidPoint
== NULL
) {
2537 // if this option does not points to a Fv file, just return EFI_UNSUPPORTED
2539 return EFI_UNSUPPORTED
;
2541 if (!CompareGuid (GuidPoint
, FileGuid
)) {
2543 // If the Fv file is not the input file guid, just return EFI_UNSUPPORTED
2545 return EFI_UNSUPPORTED
;
2549 // Check whether the input Fv file device path is valid
2551 TempDevicePath
= *DevicePath
;
2552 FoundFvHandle
= NULL
;
2553 Status
= gBS
->LocateDevicePath (
2554 &gEfiFirmwareVolume2ProtocolGuid
,
2558 if (!EFI_ERROR (Status
)) {
2559 Status
= gBS
->HandleProtocol (
2561 &gEfiFirmwareVolume2ProtocolGuid
,
2564 if (!EFI_ERROR (Status
)) {
2566 // Set FV ReadFile Buffer as NULL, only need to check whether input Fv file exist there
2568 Status
= Fv
->ReadFile (
2575 &AuthenticationStatus
2577 if (!EFI_ERROR (Status
)) {
2578 return EFI_ALREADY_STARTED
;
2584 // Look for the input wanted FV file in current FV
2585 // First, try to look for in Bds own FV. Bds and input wanted FV file usually are in the same FV
2588 FoundFvHandle
= NULL
;
2589 Status
= gBS
->HandleProtocol (
2591 &gEfiLoadedImageProtocolGuid
,
2592 (VOID
**) &LoadedImage
2594 if (!EFI_ERROR (Status
)) {
2595 Status
= gBS
->HandleProtocol (
2596 LoadedImage
->DeviceHandle
,
2597 &gEfiFirmwareVolume2ProtocolGuid
,
2600 if (!EFI_ERROR (Status
)) {
2601 Status
= Fv
->ReadFile (
2608 &AuthenticationStatus
2610 if (!EFI_ERROR (Status
)) {
2612 FoundFvHandle
= LoadedImage
->DeviceHandle
;
2617 // Second, if fail to find, try to enumerate all FV
2620 FvHandleBuffer
= NULL
;
2621 gBS
->LocateHandleBuffer (
2623 &gEfiFirmwareVolume2ProtocolGuid
,
2628 for (Index
= 0; Index
< FvHandleCount
; Index
++) {
2629 gBS
->HandleProtocol (
2630 FvHandleBuffer
[Index
],
2631 &gEfiFirmwareVolume2ProtocolGuid
,
2635 Status
= Fv
->ReadFile (
2642 &AuthenticationStatus
2644 if (EFI_ERROR (Status
)) {
2646 // Skip if input Fv file not in the FV
2651 FoundFvHandle
= FvHandleBuffer
[Index
];
2655 if (FvHandleBuffer
!= NULL
) {
2656 FreePool (FvHandleBuffer
);
2662 // Build the shell device path
2664 NewDevicePath
= DevicePathFromHandle (FoundFvHandle
);
2665 EfiInitializeFwVolDevicepathNode (&FvFileNode
, FileGuid
);
2666 NewDevicePath
= AppendDevicePathNode (NewDevicePath
, (EFI_DEVICE_PATH_PROTOCOL
*) &FvFileNode
);
2667 *DevicePath
= NewDevicePath
;
2670 return EFI_NOT_FOUND
;