@retval FALSE If not.\r
\r
**/\r
-\r
BOOLEAN\r
IsBootOptionValidNVVarialbe (\r
IN BDS_COMMON_OPTION *OptionToCheck\r
//\r
// If the boot option point to Internal FV shell, make sure it is valid\r
//\r
- Status = BdsLibUpdateFvFileDevicePath (&DevicePath, &gEfiShellFileGuid);\r
+ Status = BdsLibUpdateFvFileDevicePath (&DevicePath, PcdGetPtr(PcdShellFile));\r
if (!EFI_ERROR(Status)) {\r
if (Option->DevicePath != NULL) {\r
FreePool(Option->DevicePath);\r
\r
\r
/**\r
- Delete all invalid EFI boot options. The probable invalid boot option could\r
- be Removable media or Network boot device.\r
+ Delete all invalid EFI boot options.\r
\r
@retval EFI_SUCCESS Delete all invalid boot option success\r
@retval EFI_NOT_FOUND Variable "BootOrder" is not found\r
UINT16 BootOption[BOOT_OPTION_MAX_CHAR];\r
EFI_DEVICE_PATH_PROTOCOL *OptionDevicePath;\r
UINT8 *TempPtr;\r
+ CHAR16 *Description;\r
\r
Status = EFI_SUCCESS;\r
BootOrder = NULL;\r
\r
TempPtr = BootOptionVar;\r
TempPtr += sizeof (UINT32) + sizeof (UINT16);\r
+ Description = (CHAR16 *) TempPtr;\r
TempPtr += StrSize ((CHAR16 *) TempPtr);\r
OptionDevicePath = (EFI_DEVICE_PATH_PROTOCOL *) TempPtr;\r
\r
continue;\r
}\r
\r
- if (!BdsLibIsValidEFIBootOptDevicePath (OptionDevicePath, FALSE)) {\r
+ if (!BdsLibIsValidEFIBootOptDevicePathExt (OptionDevicePath, FALSE, Description)) {\r
//\r
// Delete this invalid boot option "Boot####"\r
//\r
\r
\r
/**\r
- This function will enumerate all possible boot device in the system,\r
- it will only execute once of every boot.\r
-\r
+ For EFI boot option, BDS separate them as six types:\r
+ 1. Network - The boot option points to the SimpleNetworkProtocol device. \r
+ Bds will try to automatically create this type boot option when enumerate.\r
+ 2. Shell - The boot option points to internal flash shell. \r
+ Bds will try to automatically create this type boot option when enumerate.\r
+ 3. Removable BlockIo - The boot option only points to the removable media\r
+ device, like USB flash disk, DVD, Floppy etc.\r
+ These device should contain a *removable* blockIo\r
+ protocol in their device handle.\r
+ Bds will try to automatically create this type boot option \r
+ when enumerate.\r
+ 4. Fixed BlockIo - The boot option only points to a Fixed blockIo device, \r
+ like HardDisk.\r
+ These device should contain a *fixed* blockIo\r
+ protocol in their device handle.\r
+ BDS will skip fixed blockIo devices, and NOT\r
+ automatically create boot option for them. But BDS \r
+ will help to delete those fixed blockIo boot option, \r
+ whose description rule conflict with other auto-created\r
+ boot options.\r
+ 5. Non-BlockIo Simplefile - The boot option points to a device whose handle \r
+ has SimpleFileSystem Protocol, but has no blockio\r
+ protocol. These devices do not offer blockIo\r
+ protocol, but BDS still can get the \r
+ \EFI\BOOT\boot{machinename}.EFI by SimpleFileSystem\r
+ Protocol.\r
+ 6. File - The boot option points to a file. These boot options are usually \r
+ created by user manually or OS loader. BDS will not delete or modify\r
+ these boot options. \r
+ \r
+ This function will enumerate all possible boot device in the system, and\r
+ automatically create boot options for Network, Shell, Removable BlockIo, \r
+ and Non-BlockIo Simplefile devices.\r
+ It will only execute once of every boot.\r
+ \r
@param BdsBootOptionList The header of the link list which indexed all\r
current boot options\r
\r
@retval EFI_SUCCESS Finished all the boot device enumerate and create\r
the boot option base on that boot device\r
\r
+ @retval EFI_OUT_OF_RESOURCES Failed to enumerate the boot device and create the boot option list\r
**/\r
EFI_STATUS\r
EFIAPI\r
UINT16 CdromNumber;\r
UINT16 UsbNumber;\r
UINT16 MiscNumber;\r
+ UINT16 ScsiNumber;\r
UINT16 NonBlockNumber;\r
UINTN NumberBlockIoHandles;\r
EFI_HANDLE *BlockIoHandles;\r
UINTN Size;\r
EFI_FV_FILE_ATTRIBUTES Attributes;\r
UINT32 AuthenticationStatus;\r
- EFI_FIRMWARE_VOLUME2_PROTOCOL *Fv;\r
- EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
+ EFI_FIRMWARE_VOLUME2_PROTOCOL *Fv;\r
+ EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
UINTN DevicePathType;\r
CHAR16 Buffer[40];\r
EFI_HANDLE *FileSystemHandles;\r
CdromNumber = 0;\r
UsbNumber = 0;\r
MiscNumber = 0;\r
+ ScsiNumber = 0;\r
ZeroMem (Buffer, sizeof (Buffer));\r
\r
//\r
// device from the boot order variable\r
//\r
if (mEnumBootDevice) {\r
- BdsLibBuildOptionFromVar (BdsBootOptionList, L"BootOrder");\r
- return EFI_SUCCESS;\r
+ Status = BdsLibBuildOptionFromVar (BdsBootOptionList, L"BootOrder");\r
+ return Status;\r
}\r
\r
//\r
\r
switch (DevicePathType) {\r
case BDS_EFI_ACPI_FLOPPY_BOOT:\r
- if (FloppyNumber == 0) {\r
- UnicodeSPrint (Buffer, sizeof (Buffer), L"EFI Floppy");\r
- } else {\r
- UnicodeSPrint (Buffer, sizeof (Buffer), L"EFI Floppy %d", FloppyNumber);\r
- }\r
+ UnicodeSPrint (Buffer, sizeof (Buffer), DESCRIPTION_FLOPPY_NUM, FloppyNumber); \r
BdsLibBuildOptionFromHandle (BlockIoHandles[Index], BdsBootOptionList, Buffer);\r
FloppyNumber++;\r
break;\r
-\r
+ \r
+ //\r
+ // Assume a removable SATA device should be the DVD/CD device\r
+ //\r
case BDS_EFI_MESSAGE_ATAPI_BOOT:\r
- if (CdromNumber == 0) {\r
- UnicodeSPrint (Buffer, sizeof (Buffer), L"EFI DVD/CDROM");\r
- } else {\r
- UnicodeSPrint (Buffer, sizeof (Buffer), L"EFI DVD/CDROM %d", CdromNumber);\r
- }\r
+ case BDS_EFI_MESSAGE_SATA_BOOT:\r
+ UnicodeSPrint (Buffer, sizeof (Buffer), DESCRIPTION_DVD_NUM, CdromNumber);\r
BdsLibBuildOptionFromHandle (BlockIoHandles[Index], BdsBootOptionList, Buffer);\r
CdromNumber++;\r
break;\r
\r
case BDS_EFI_MESSAGE_USB_DEVICE_BOOT:\r
- if (UsbNumber == 0) {\r
- UnicodeSPrint (Buffer, sizeof (Buffer), L"EFI USB Device");\r
- } else {\r
- UnicodeSPrint (Buffer, sizeof (Buffer), L"EFI USB Device %d", UsbNumber);\r
- }\r
+ UnicodeSPrint (Buffer, sizeof (Buffer), DESCRIPTION_USB_NUM, UsbNumber);\r
BdsLibBuildOptionFromHandle (BlockIoHandles[Index], BdsBootOptionList, Buffer);\r
UsbNumber++;\r
break;\r
\r
case BDS_EFI_MESSAGE_SCSI_BOOT:\r
- if (UsbNumber == 0) {\r
- UnicodeSPrint (Buffer, sizeof (Buffer), L"EFI SCSI Device");\r
- } else {\r
- UnicodeSPrint (Buffer, sizeof (Buffer), L"EFI SCSI Device %d", UsbNumber);\r
- }\r
- BdsLibBuildOptionFromHandle (BlockIoHandles[Index], BdsBootOptionList, Buffer);\r
- UsbNumber++;\r
+ UnicodeSPrint (Buffer, sizeof (Buffer), DESCRIPTION_SCSI_NUM, ScsiNumber);\r
+ BdsLibBuildOptionFromHandle (BlockIoHandles[Index], BdsBootOptionList, Buffer); \r
+ ScsiNumber++;\r
break;\r
\r
case BDS_EFI_MESSAGE_MISC_BOOT:\r
- if (MiscNumber == 0) {\r
- UnicodeSPrint (Buffer, sizeof (Buffer), L"EFI Misc Device");\r
- } else {\r
- UnicodeSPrint (Buffer, sizeof (Buffer), L"EFI Misc Device %d", MiscNumber);\r
- }\r
- BdsLibBuildOptionFromHandle (BlockIoHandles[Index], BdsBootOptionList, Buffer);\r
+ UnicodeSPrint (Buffer, sizeof (Buffer), DESCRIPTION_MISC_NUM, MiscNumber);\r
+ BdsLibBuildOptionFromHandle (BlockIoHandles[Index], BdsBootOptionList, Buffer); \r
MiscNumber++;\r
break;\r
\r
//\r
BdsLibDeleteOptionFromHandle (FileSystemHandles[Index]);\r
} else {\r
- if (NonBlockNumber == 0) {\r
- UnicodeSPrint (Buffer, sizeof (Buffer), L"EFI Non-Block Boot Device");\r
- } else {\r
- UnicodeSPrint (Buffer, sizeof (Buffer), L"EFI Non-Block Boot Device %d", NonBlockNumber);\r
- }\r
+ UnicodeSPrint (Buffer, sizeof (Buffer), DESCRIPTION_NON_BLOCK_NUM, NonBlockNumber);\r
BdsLibBuildOptionFromHandle (FileSystemHandles[Index], BdsBootOptionList, Buffer);\r
NonBlockNumber++;\r
}\r
&NumberSimpleNetworkHandles,\r
&SimpleNetworkHandles\r
);\r
+\r
for (Index = 0; Index < NumberSimpleNetworkHandles; Index++) {\r
- if (Index == 0) {\r
- UnicodeSPrint (Buffer, sizeof (Buffer), L"EFI Network");\r
- } else {\r
- UnicodeSPrint (Buffer, sizeof (Buffer), L"EFI Network %d", Index);\r
- }\r
+ UnicodeSPrint (Buffer, sizeof (Buffer), DESCRIPTION_NETWORK_NUM, Index);\r
BdsLibBuildOptionFromHandle (SimpleNetworkHandles[Index], BdsBootOptionList, Buffer);\r
}\r
\r
\r
Status = Fv->ReadFile (\r
Fv,\r
- &gEfiShellFileGuid,\r
+ PcdGetPtr(PcdShellFile),\r
NULL,\r
&Size,\r
&Type,\r
// Make sure every boot only have one time\r
// boot device enumerate\r
//\r
- BdsLibBuildOptionFromVar (BdsBootOptionList, L"BootOrder");\r
+ Status = BdsLibBuildOptionFromVar (BdsBootOptionList, L"BootOrder");\r
mEnumBootDevice = TRUE;\r
\r
- return EFI_SUCCESS;\r
+ return Status;\r
}\r
\r
/**\r
{\r
EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
\r
- DevicePath = DevicePathFromHandle (Handle);\r
+ DevicePath = DevicePathFromHandle (Handle);\r
\r
//\r
// Create and register new boot option\r
//\r
// Build the shell device path\r
//\r
- EfiInitializeFwVolDevicepathNode (&ShellNode, &gEfiShellFileGuid);\r
+ EfiInitializeFwVolDevicepathNode (&ShellNode, PcdGetPtr(PcdShellFile));\r
\r
DevicePath = AppendDevicePathNode (DevicePath, (EFI_DEVICE_PATH_PROTOCOL *) &ShellNode);\r
\r
Second, check whether the device path point to a device which support SimpleFileSystemProtocol,\r
Third, detect the the default boot file in the Media, and return the removable Media handle.\r
\r
- @param DevicePath Device Path to a bootable device\r
+ @param DevicePath Device Path to a bootable device\r
\r
- @retval NULL The media on the DevicePath is not bootable\r
+ @return The bootable media handle. If the media on the DevicePath is not bootable, NULL will return.\r
\r
**/\r
EFI_HANDLE\r
\r
@param DevicePath The bootable device Path to check\r
\r
- @retval BDS_EFI_MEDIA_HD_BOOT If the device path contains any media device path node, it is media boot type\r
- For the floppy node, handle it as media node\r
- @retval BDS_EFI_MEDIA_CDROM_BOOT If the device path contains any media device path node, it is media boot type\r
- For the floppy node, handle it as media node\r
- @retval BDS_EFI_ACPI_FLOPPY_BOOT If the device path contains any media device path node, it is media boot type\r
- For the floppy node, handle it as media node\r
- @retval BDS_EFI_MESSAGE_ATAPI_BOOT If the device path not contains any media device path node, and\r
- its last device path node point to a message device path node, it is\r
- \r
- @retval BDS_EFI_MESSAGE_SCSI_BOOT If the device path not contains any media device path node, and\r
- its last device path node point to a message device path node, it is\r
- @retval BDS_EFI_MESSAGE_USB_DEVICE_BOOT If the device path not contains any media device path node, and\r
- its last device path node point to a message device path node, it is\r
+ @retval BDS_EFI_MEDIA_HD_BOOT If given device path contains MEDIA_DEVICE_PATH type device path node \r
+ which subtype is MEDIA_HARDDRIVE_DP\r
+ @retval BDS_EFI_MEDIA_CDROM_BOOT If given device path contains MEDIA_DEVICE_PATH type device path node\r
+ which subtype is MEDIA_CDROM_DP\r
+ @retval BDS_EFI_ACPI_FLOPPY_BOOT If given device path contains ACPI_DEVICE_PATH type device path node\r
+ which HID is floppy device.\r
+ @retval BDS_EFI_MESSAGE_ATAPI_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node\r
+ and its last device path node's subtype is MSG_ATAPI_DP.\r
+ @retval BDS_EFI_MESSAGE_SCSI_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node\r
+ and its last device path node's subtype is MSG_SCSI_DP.\r
+ @retval BDS_EFI_MESSAGE_USB_DEVICE_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node\r
+ and its last device path node's subtype is MSG_USB_DP.\r
@retval BDS_EFI_MESSAGE_MISC_BOOT If the device path not contains any media device path node, and\r
- its last device path node point to a message device path node, it is\r
- @retval BDS_LEGACY_BBS_BOOT Legacy boot type\r
+ its last device path node point to a message device path node.\r
+ @retval BDS_LEGACY_BBS_BOOT If given device path contains BBS_DEVICE_PATH type device path node.\r
@retval BDS_EFI_UNSUPPORT An EFI Removable BlockIO device path not point to a media and message device, \r
\r
**/\r
return BDS_EFI_MESSAGE_USB_DEVICE_BOOT;\r
} else if (DevicePathSubType(TempDevicePath) == MSG_SCSI_DP) {\r
return BDS_EFI_MESSAGE_SCSI_BOOT;\r
+ } else if (DevicePathSubType(TempDevicePath) == MSG_SATA_DP) {\r
+ return BDS_EFI_MESSAGE_SATA_BOOT;\r
}\r
return BDS_EFI_MESSAGE_MISC_BOOT;\r
default:\r
return BDS_EFI_UNSUPPORT;\r
}\r
\r
+\r
+/** \r
+ Check whether the descriptionis is conflict with the description reserved for\r
+ auto-created boot options.\r
+\r
+ @param Description The Description in a boot option\r
+ \r
+ @retval TRUE The description is conflict with the description reserved for\r
+ auto-created boot options.\r
+ @retval FALSE The description is not conflict with the description reserved.\r
+ \r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+CheckDescritptionConflict (\r
+ IN CHAR16 *Description\r
+ )\r
+{\r
+ if (Description == NULL) {\r
+ return FALSE; \r
+ }\r
+ if ((CompareMem (Description, DESCRIPTION_FLOPPY, StrLen (DESCRIPTION_FLOPPY) * sizeof (CHAR16)) == 0) ||\r
+ (CompareMem (Description, DESCRIPTION_DVD, StrLen (DESCRIPTION_DVD) * sizeof (CHAR16)) == 0) ||\r
+ (CompareMem (Description, DESCRIPTION_USB, StrLen (DESCRIPTION_USB) * sizeof (CHAR16)) == 0) ||\r
+ (CompareMem (Description, DESCRIPTION_SCSI, StrLen (DESCRIPTION_SCSI) * sizeof (CHAR16)) == 0) ||\r
+ (CompareMem (Description, DESCRIPTION_MISC, StrLen (DESCRIPTION_MISC) * sizeof (CHAR16)) == 0) ||\r
+ (CompareMem (Description, DESCRIPTION_NETWORK, StrLen (DESCRIPTION_NETWORK) * sizeof (CHAR16)) == 0)||\r
+ (CompareMem (Description, DESCRIPTION_NON_BLOCK, StrLen (DESCRIPTION_NON_BLOCK) * sizeof (CHAR16)) == 0)) { \r
+ return TRUE;\r
+ }\r
+\r
+ return FALSE;\r
+}\r
+\r
+\r
/**\r
Check whether the Device path in a boot option point to a valid bootable device,\r
And if CheckMedia is true, check the device is ready to boot now.\r
IN EFI_DEVICE_PATH_PROTOCOL *DevPath,\r
IN BOOLEAN CheckMedia\r
)\r
+{\r
+ return BdsLibIsValidEFIBootOptDevicePathExt (DevPath, CheckMedia, NULL);\r
+}\r
+\r
+/**\r
+ Check whether the Device path in a boot option point to a valid bootable device,\r
+ And if CheckMedia is true, check the device is ready to boot now.\r
+ If Description is not NULL and the device path point to a fixed BlockIo\r
+ device, check the description whether conflict with other auto-created\r
+ boot options.\r
+\r
+ @param DevPath the Device path in a boot option\r
+ @param CheckMedia if true, check the device is ready to boot now.\r
+ @param Description the description in a boot option\r
+\r
+ @retval TRUE the Device path is valid\r
+ @retval FALSE the Device path is invalid .\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+BdsLibIsValidEFIBootOptDevicePathExt (\r
+ IN EFI_DEVICE_PATH_PROTOCOL *DevPath,\r
+ IN BOOLEAN CheckMedia,\r
+ IN CHAR16 *Description\r
+ )\r
{\r
EFI_STATUS Status;\r
EFI_HANDLE Handle;\r
// If the boot option point to Internal FV shell, make sure it is valid\r
//\r
TempDevicePath = DevPath; \r
- Status = BdsLibUpdateFvFileDevicePath (&TempDevicePath, &gEfiShellFileGuid);\r
+ Status = BdsLibUpdateFvFileDevicePath (&TempDevicePath, PcdGetPtr(PcdShellFile));\r
if (Status == EFI_ALREADY_STARTED) {\r
return TRUE;\r
} else {\r
}\r
\r
//\r
- // If the boot option point to a blockIO device, no matter whether or not it is a removeable device, it is a valid EFI boot option\r
+ // If the boot option point to a blockIO device:\r
+ // if it is a removable blockIo device, it is valid.\r
+ // if it is a fixed blockIo device, check its description confliction. \r
//\r
TempDevicePath = DevPath;\r
Status = gBS->LocateDevicePath (&gEfiBlockIoProtocolGuid, &TempDevicePath, &Handle);\r
if (!EFI_ERROR (Status)) {\r
Status = gBS->HandleProtocol (Handle, &gEfiBlockIoProtocolGuid, (VOID **)&BlockIo);\r
if (!EFI_ERROR (Status)) {\r
+ if (!BlockIo->Media->RemovableMedia) {\r
+ //\r
+ // For the Fixed block devices, check its description whether conflict\r
+ // with other auto-created boot options. BDS permit a boot option point to \r
+ // Fixed block device, but not permit it use the description reserved for\r
+ // auto-created boot options.\r
+ // The check is to cover the bug, that replace a removable BlockIo device\r
+ // with a fixed BlockIo device at the same port, but the removable device's\r
+ // boot option can not be automatically deleted.\r
+ //\r
+ if (CheckDescritptionConflict (Description)) {\r
+ return FALSE; \r
+ }\r
+ } \r
if (CheckMedia) {\r
//\r
// Test if it is ready to boot now\r
projects / mirror_edk2.git / blobdiff