X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;ds=sidebyside;f=IntelFrameworkModulePkg%2FLibrary%2FGenericBdsLib%2FBdsBoot.c;h=6f06ac9a850d3ea2546df6c14553a01b0056abb8;hb=2df686c67c7819e01a1487dd703faffef2b59dce;hp=df8be070e7a2567219071714799b4672d8372ce1;hpb=c62dbf318535e2560ff56ba4afe7f082e4b4832a;p=mirror_edk2.git diff --git a/IntelFrameworkModulePkg/Library/GenericBdsLib/BdsBoot.c b/IntelFrameworkModulePkg/Library/GenericBdsLib/BdsBoot.c index df8be070e7..6f06ac9a85 100644 --- a/IntelFrameworkModulePkg/Library/GenericBdsLib/BdsBoot.c +++ b/IntelFrameworkModulePkg/Library/GenericBdsLib/BdsBoot.c @@ -1,8 +1,8 @@ /** @file BDS Lib functions which relate with create or process the boot option. -Copyright (c) 2004 - 2008, Intel Corporation.
-All rights reserved. This program and the accompanying materials +Copyright (c) 2004 - 2012, Intel Corporation. All rights reserved.
+This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php @@ -13,14 +13,42 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ #include "InternalBdsLib.h" +#include "String.h" BOOLEAN mEnumBootDevice = FALSE; +EFI_HII_HANDLE gBdsLibStringPackHandle = NULL; -/// -/// This GUID is used for an EFI Variable that stores the front device pathes -/// for a partial device path that starts with the HD node. -/// -EFI_GUID mHdBootVariablePrivateGuid = { 0xfab7e9e1, 0x39dd, 0x4f2b, { 0x84, 0x8, 0xe2, 0xe, 0x90, 0x6c, 0xb6, 0xde } }; +/** + The constructor function register UNI strings into imageHandle. + + It will ASSERT() if that operation fails and it will always return EFI_SUCCESS. + + @param ImageHandle The firmware allocated handle for the EFI image. + @param SystemTable A pointer to the EFI System Table. + + @retval EFI_SUCCESS The constructor successfully added string package. + @retval Other value The constructor can't add string package. + +**/ +EFI_STATUS +EFIAPI +GenericBdsLibConstructor ( + IN EFI_HANDLE ImageHandle, + IN EFI_SYSTEM_TABLE *SystemTable + ) +{ + + gBdsLibStringPackHandle = HiiAddPackages ( + &gBdsLibStringPackageGuid, + &ImageHandle, + GenericBdsLibStrings, + NULL + ); + + ASSERT (gBdsLibStringPackHandle != NULL); + + return EFI_SUCCESS; +} @@ -55,7 +83,7 @@ BdsLibDoLegacyBoot ( BdsRefreshBbsTableForBoot (Option); // - // Write boot to OS performance data to a file + // Write boot to OS performance data for legacy boot. // PERF_CODE ( WriteBootToOsPerformanceData (); @@ -77,9 +105,8 @@ BdsLibDoLegacyBoot ( @retval TRUE This boot option matches a valid EFI NV Boot####. @retval FALSE If not. - -**/ +**/ BOOLEAN IsBootOptionValidNVVarialbe ( IN BDS_COMMON_OPTION *OptionToCheck @@ -101,7 +128,7 @@ IsBootOptionValidNVVarialbe ( } // - // If the Boot Option Number and Device Path matches, OptionToCheck matches a + // If the Boot Option Number and Device Path matches, OptionToCheck matches a // valid EFI NV Boot####. // if ((OptionToCheck->BootCurrent == BootOption->BootCurrent) && @@ -111,9 +138,457 @@ IsBootOptionValidNVVarialbe ( } FreePool (BootOption); - + return Valid; } + +/** + Check whether a USB device match the specified USB Class device path. This + function follows "Load Option Processing" behavior in UEFI specification. + + @param UsbIo USB I/O protocol associated with the USB device. + @param UsbClass The USB Class device path to match. + + @retval TRUE The USB device match the USB Class device path. + @retval FALSE The USB device does not match the USB Class device path. + +**/ +BOOLEAN +BdsMatchUsbClass ( + IN EFI_USB_IO_PROTOCOL *UsbIo, + IN USB_CLASS_DEVICE_PATH *UsbClass + ) +{ + EFI_STATUS Status; + EFI_USB_DEVICE_DESCRIPTOR DevDesc; + EFI_USB_INTERFACE_DESCRIPTOR IfDesc; + UINT8 DeviceClass; + UINT8 DeviceSubClass; + UINT8 DeviceProtocol; + + if ((DevicePathType (UsbClass) != MESSAGING_DEVICE_PATH) || + (DevicePathSubType (UsbClass) != MSG_USB_CLASS_DP)){ + return FALSE; + } + + // + // Check Vendor Id and Product Id. + // + Status = UsbIo->UsbGetDeviceDescriptor (UsbIo, &DevDesc); + if (EFI_ERROR (Status)) { + return FALSE; + } + + if ((UsbClass->VendorId != 0xffff) && + (UsbClass->VendorId != DevDesc.IdVendor)) { + return FALSE; + } + + if ((UsbClass->ProductId != 0xffff) && + (UsbClass->ProductId != DevDesc.IdProduct)) { + return FALSE; + } + + DeviceClass = DevDesc.DeviceClass; + DeviceSubClass = DevDesc.DeviceSubClass; + DeviceProtocol = DevDesc.DeviceProtocol; + if (DeviceClass == 0) { + // + // If Class in Device Descriptor is set to 0, use the Class, SubClass and + // Protocol in Interface Descriptor instead. + // + Status = UsbIo->UsbGetInterfaceDescriptor (UsbIo, &IfDesc); + if (EFI_ERROR (Status)) { + return FALSE; + } + + DeviceClass = IfDesc.InterfaceClass; + DeviceSubClass = IfDesc.InterfaceSubClass; + DeviceProtocol = IfDesc.InterfaceProtocol; + } + + // + // Check Class, SubClass and Protocol. + // + if ((UsbClass->DeviceClass != 0xff) && + (UsbClass->DeviceClass != DeviceClass)) { + return FALSE; + } + + if ((UsbClass->DeviceSubClass != 0xff) && + (UsbClass->DeviceSubClass != DeviceSubClass)) { + return FALSE; + } + + if ((UsbClass->DeviceProtocol != 0xff) && + (UsbClass->DeviceProtocol != DeviceProtocol)) { + return FALSE; + } + + return TRUE; +} + +/** + Check whether a USB device match the specified USB WWID device path. This + function follows "Load Option Processing" behavior in UEFI specification. + + @param UsbIo USB I/O protocol associated with the USB device. + @param UsbWwid The USB WWID device path to match. + + @retval TRUE The USB device match the USB WWID device path. + @retval FALSE The USB device does not match the USB WWID device path. + +**/ +BOOLEAN +BdsMatchUsbWwid ( + IN EFI_USB_IO_PROTOCOL *UsbIo, + IN USB_WWID_DEVICE_PATH *UsbWwid + ) +{ + EFI_STATUS Status; + EFI_USB_DEVICE_DESCRIPTOR DevDesc; + EFI_USB_INTERFACE_DESCRIPTOR IfDesc; + UINT16 *LangIdTable; + UINT16 TableSize; + UINT16 Index; + CHAR16 *CompareStr; + UINTN CompareLen; + CHAR16 *SerialNumberStr; + UINTN Length; + + if ((DevicePathType (UsbWwid) != MESSAGING_DEVICE_PATH) || + (DevicePathSubType (UsbWwid) != MSG_USB_WWID_DP )){ + return FALSE; + } + + // + // Check Vendor Id and Product Id. + // + Status = UsbIo->UsbGetDeviceDescriptor (UsbIo, &DevDesc); + if (EFI_ERROR (Status)) { + return FALSE; + } + if ((DevDesc.IdVendor != UsbWwid->VendorId) || + (DevDesc.IdProduct != UsbWwid->ProductId)) { + return FALSE; + } + + // + // Check Interface Number. + // + Status = UsbIo->UsbGetInterfaceDescriptor (UsbIo, &IfDesc); + if (EFI_ERROR (Status)) { + return FALSE; + } + if (IfDesc.InterfaceNumber != UsbWwid->InterfaceNumber) { + return FALSE; + } + + // + // Check Serial Number. + // + if (DevDesc.StrSerialNumber == 0) { + return FALSE; + } + + // + // Get all supported languages. + // + TableSize = 0; + LangIdTable = NULL; + Status = UsbIo->UsbGetSupportedLanguages (UsbIo, &LangIdTable, &TableSize); + if (EFI_ERROR (Status) || (TableSize == 0) || (LangIdTable == NULL)) { + return FALSE; + } + + // + // Serial number in USB WWID device path is the last 64-or-less UTF-16 characters. + // + CompareStr = (CHAR16 *) (UINTN) (UsbWwid + 1); + CompareLen = (DevicePathNodeLength (UsbWwid) - sizeof (USB_WWID_DEVICE_PATH)) / sizeof (CHAR16); + if (CompareStr[CompareLen - 1] == L'\0') { + CompareLen--; + } + + // + // Compare serial number in each supported language. + // + for (Index = 0; Index < TableSize / sizeof (UINT16); Index++) { + SerialNumberStr = NULL; + Status = UsbIo->UsbGetStringDescriptor ( + UsbIo, + LangIdTable[Index], + DevDesc.StrSerialNumber, + &SerialNumberStr + ); + if (EFI_ERROR (Status) || (SerialNumberStr == NULL)) { + continue; + } + + Length = StrLen (SerialNumberStr); + if ((Length >= CompareLen) && + (CompareMem (SerialNumberStr + Length - CompareLen, CompareStr, CompareLen * sizeof (CHAR16)) == 0)) { + FreePool (SerialNumberStr); + return TRUE; + } + + FreePool (SerialNumberStr); + } + + return FALSE; +} + +/** + Find a USB device path which match the specified short-form device path start + with USB Class or USB WWID device path and load the boot file then return the + image handle. If ParentDevicePath is NULL, this function will search in all USB + devices of the platform. If ParentDevicePath is not NULL,this function will only + search in its child devices. + + @param ParentDevicePath The device path of the parent. + @param ShortFormDevicePath The USB Class or USB WWID device path to match. + + @return The image Handle if find load file from specified short-form device path + or NULL if not found. + +**/ +EFI_HANDLE * +BdsFindUsbDevice ( + IN EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath, + IN EFI_DEVICE_PATH_PROTOCOL *ShortFormDevicePath + ) +{ + EFI_STATUS Status; + UINTN UsbIoHandleCount; + EFI_HANDLE *UsbIoHandleBuffer; + EFI_DEVICE_PATH_PROTOCOL *UsbIoDevicePath; + EFI_USB_IO_PROTOCOL *UsbIo; + UINTN Index; + UINTN ParentSize; + UINTN Size; + EFI_HANDLE ImageHandle; + EFI_HANDLE Handle; + EFI_DEVICE_PATH_PROTOCOL *FullDevicePath; + EFI_DEVICE_PATH_PROTOCOL *NextDevicePath; + + FullDevicePath = NULL; + ImageHandle = NULL; + + // + // Get all UsbIo Handles. + // + UsbIoHandleCount = 0; + UsbIoHandleBuffer = NULL; + Status = gBS->LocateHandleBuffer ( + ByProtocol, + &gEfiUsbIoProtocolGuid, + NULL, + &UsbIoHandleCount, + &UsbIoHandleBuffer + ); + if (EFI_ERROR (Status) || (UsbIoHandleCount == 0) || (UsbIoHandleBuffer == NULL)) { + return NULL; + } + + ParentSize = (ParentDevicePath == NULL) ? 0 : GetDevicePathSize (ParentDevicePath); + for (Index = 0; Index < UsbIoHandleCount; Index++) { + // + // Get the Usb IO interface. + // + Status = gBS->HandleProtocol( + UsbIoHandleBuffer[Index], + &gEfiUsbIoProtocolGuid, + (VOID **) &UsbIo + ); + if (EFI_ERROR (Status)) { + continue; + } + + UsbIoDevicePath = DevicePathFromHandle (UsbIoHandleBuffer[Index]); + if (UsbIoDevicePath == NULL) { + continue; + } + + if (ParentDevicePath != NULL) { + // + // Compare starting part of UsbIoHandle's device path with ParentDevicePath. + // + Size = GetDevicePathSize (UsbIoDevicePath); + if ((Size < ParentSize) || + (CompareMem (UsbIoDevicePath, ParentDevicePath, ParentSize - END_DEVICE_PATH_LENGTH) != 0)) { + continue; + } + } + + if (BdsMatchUsbClass (UsbIo, (USB_CLASS_DEVICE_PATH *) ShortFormDevicePath) || + BdsMatchUsbWwid (UsbIo, (USB_WWID_DEVICE_PATH *) ShortFormDevicePath)) { + // + // Try to find if there is the boot file in this DevicePath + // + NextDevicePath = NextDevicePathNode (ShortFormDevicePath); + if (!IsDevicePathEnd (NextDevicePath)) { + FullDevicePath = AppendDevicePath (UsbIoDevicePath, NextDevicePath); + // + // Connect the full device path, so that Simple File System protocol + // could be installed for this USB device. + // + BdsLibConnectDevicePath (FullDevicePath); + REPORT_STATUS_CODE (EFI_PROGRESS_CODE, PcdGet32 (PcdProgressCodeOsLoaderLoad)); + Status = gBS->LoadImage ( + TRUE, + gImageHandle, + FullDevicePath, + NULL, + 0, + &ImageHandle + ); + FreePool (FullDevicePath); + } else { + FullDevicePath = UsbIoDevicePath; + Status = EFI_NOT_FOUND; + } + + // + // If we didn't find an image directly, we need to try as if it is a removable device boot option + // and load the image according to the default boot behavior for removable device. + // + if (EFI_ERROR (Status)) { + // + // check if there is a bootable removable media could be found in this device path , + // and get the bootable media handle + // + Handle = BdsLibGetBootableHandle(UsbIoDevicePath); + if (Handle == NULL) { + continue; + } + // + // Load the default boot file \EFI\BOOT\boot{machinename}.EFI from removable Media + // machinename is ia32, ia64, x64, ... + // + FullDevicePath = FileDevicePath (Handle, EFI_REMOVABLE_MEDIA_FILE_NAME); + if (FullDevicePath != NULL) { + REPORT_STATUS_CODE (EFI_PROGRESS_CODE, PcdGet32 (PcdProgressCodeOsLoaderLoad)); + Status = gBS->LoadImage ( + TRUE, + gImageHandle, + FullDevicePath, + NULL, + 0, + &ImageHandle + ); + if (EFI_ERROR (Status)) { + // + // The DevicePath failed, and it's not a valid + // removable media device. + // + continue; + } + } else { + continue; + } + } + break; + } + } + + FreePool (UsbIoHandleBuffer); + return ImageHandle; +} + +/** + Expand USB Class or USB WWID device path node to be full device path of a USB + device in platform then load the boot file on this full device path and return the + image handle. + + This function support following 4 cases: + 1) Boot Option device path starts with a USB Class or USB WWID device path, + and there is no Media FilePath device path in the end. + In this case, it will follow Removable Media Boot Behavior. + 2) Boot Option device path starts with a USB Class or USB WWID device path, + and ended with Media FilePath device path. + 3) Boot Option device path starts with a full device path to a USB Host Controller, + contains a USB Class or USB WWID device path node, while not ended with Media + FilePath device path. In this case, it will follow Removable Media Boot Behavior. + 4) Boot Option device path starts with a full device path to a USB Host Controller, + contains a USB Class or USB WWID device path node, and ended with Media + FilePath device path. + + @param DevicePath The Boot Option device path. + + @return The image handle of boot file, or NULL if there is no boot file found in + the specified USB Class or USB WWID device path. + +**/ +EFI_HANDLE * +BdsExpandUsbShortFormDevicePath ( + IN EFI_DEVICE_PATH_PROTOCOL *DevicePath + ) +{ + EFI_HANDLE *ImageHandle; + EFI_DEVICE_PATH_PROTOCOL *TempDevicePath; + EFI_DEVICE_PATH_PROTOCOL *ShortFormDevicePath; + + // + // Search for USB Class or USB WWID device path node. + // + ShortFormDevicePath = NULL; + ImageHandle = NULL; + TempDevicePath = DevicePath; + while (!IsDevicePathEnd (TempDevicePath)) { + if ((DevicePathType (TempDevicePath) == MESSAGING_DEVICE_PATH) && + ((DevicePathSubType (TempDevicePath) == MSG_USB_CLASS_DP) || + (DevicePathSubType (TempDevicePath) == MSG_USB_WWID_DP))) { + ShortFormDevicePath = TempDevicePath; + break; + } + TempDevicePath = NextDevicePathNode (TempDevicePath); + } + + if (ShortFormDevicePath == NULL) { + // + // No USB Class or USB WWID device path node found, do nothing. + // + return NULL; + } + + if (ShortFormDevicePath == DevicePath) { + // + // Boot Option device path starts with USB Class or USB WWID device path. + // + ImageHandle = BdsFindUsbDevice (NULL, ShortFormDevicePath); + if (ImageHandle == NULL) { + // + // Failed to find a match in existing devices, connect the short form USB + // device path and try again. + // + BdsLibConnectUsbDevByShortFormDP (0xff, ShortFormDevicePath); + ImageHandle = BdsFindUsbDevice (NULL, ShortFormDevicePath); + } + } else { + // + // Boot Option device path contains USB Class or USB WWID device path node. + // + + // + // Prepare the parent device path for search. + // + TempDevicePath = DuplicateDevicePath (DevicePath); + ASSERT (TempDevicePath != NULL); + SetDevicePathEndNode (((UINT8 *) TempDevicePath) + ((UINTN) ShortFormDevicePath - (UINTN) DevicePath)); + + // + // The USB Host Controller device path is already in Boot Option device path + // and USB Bus driver already support RemainingDevicePath starts with USB + // Class or USB WWID device path, so just search in existing USB devices and + // doesn't perform ConnectController here. + // + ImageHandle = BdsFindUsbDevice (TempDevicePath, ShortFormDevicePath); + FreePool (TempDevicePath); + } + + return ImageHandle; +} + /** Process the boot option follow the UEFI specification and special treat the legacy boot option with BBS_DEVICE_PATH. @@ -139,6 +614,7 @@ BdsLibBootViaBootOption ( ) { EFI_STATUS Status; + EFI_STATUS StatusLogo; EFI_HANDLE Handle; EFI_HANDLE ImageHandle; EFI_DEVICE_PATH_PROTOCOL *FilePath; @@ -146,20 +622,16 @@ BdsLibBootViaBootOption ( EFI_DEVICE_PATH_PROTOCOL *WorkingDevicePath; EFI_ACPI_S3_SAVE_PROTOCOL *AcpiS3Save; LIST_ENTRY TempBootLists; + EFI_BOOT_LOGO_PROTOCOL *BootLogo; // // Record the performance data for End of BDS // - PERF_END (0, "BDS", NULL, 0); + PERF_END(NULL, "BDS", NULL, 0); *ExitDataSize = 0; *ExitData = NULL; - // - // Notes: put EFI64 ROM Shadow Solution - // - EFI64_SHADOW_ALL_LEGACY_ROM (); - // // Notes: this code can be remove after the s3 script table // hook on the event EVT_SIGNAL_READY_TO_BOOT or @@ -183,12 +655,7 @@ BdsLibBootViaBootOption ( DevicePath = WorkingDevicePath; } } - // - // Signal the EVT_SIGNAL_READY_TO_BOOT event - // - EfiSignalEventReadyToBoot(); - - + // // Set Boot Current // @@ -207,97 +674,137 @@ BdsLibBootViaBootOption ( ); } - ASSERT (Option->DevicePath != NULL); - if ((DevicePathType (Option->DevicePath) == BBS_DEVICE_PATH) && - (DevicePathSubType (Option->DevicePath) == BBS_BBS_DP) - ) { - // - // Check to see if we should legacy BOOT. If yes then do the legacy boot - // - return BdsLibDoLegacyBoot (Option); - } + // + // Signal the EVT_SIGNAL_READY_TO_BOOT event + // + EfiSignalEventReadyToBoot(); + + // + // Expand USB Class or USB WWID device path node to be full device path of a USB + // device in platform then load the boot file on this full device path and get the + // image handle. + // + ImageHandle = BdsExpandUsbShortFormDevicePath (DevicePath); + + // + // Adjust the different type memory page number just before booting + // and save the updated info into the variable for next boot to use + // + BdsSetMemoryTypeInformationVariable (); // - // If the boot option point to Internal FV shell, make sure it is valid + // By expanding the USB Class or WWID device path, the ImageHandle has returnned. + // Here get the ImageHandle for the non USB class or WWID device path. // - Status = BdsLibUpdateFvFileDevicePath (&DevicePath, &gEfiShellFileGuid); - if (!EFI_ERROR(Status)) { - if (Option->DevicePath != NULL) { - FreePool(Option->DevicePath); + if (ImageHandle == NULL) { + ASSERT (Option->DevicePath != NULL); + if ((DevicePathType (Option->DevicePath) == BBS_DEVICE_PATH) && + (DevicePathSubType (Option->DevicePath) == BBS_BBS_DP) + ) { + // + // Check to see if we should legacy BOOT. If yes then do the legacy boot + // + return BdsLibDoLegacyBoot (Option); } - Option->DevicePath = AllocateZeroPool (GetDevicePathSize (DevicePath)); - ASSERT(Option->DevicePath != NULL); - CopyMem (Option->DevicePath, DevicePath, GetDevicePathSize (DevicePath)); - // - // Update the shell boot option - // - InitializeListHead (&TempBootLists); - BdsLibRegisterNewOption (&TempBootLists, DevicePath, L"EFI Internal Shell", L"BootOrder"); - + // - // free the temporary device path created by BdsLibUpdateFvFileDevicePath() + // If the boot option point to Internal FV shell, make sure it is valid // - FreePool (DevicePath); - DevicePath = Option->DevicePath; - } + Status = BdsLibUpdateFvFileDevicePath (&DevicePath, PcdGetPtr(PcdShellFile)); + if (!EFI_ERROR(Status)) { + if (Option->DevicePath != NULL) { + FreePool(Option->DevicePath); + } + Option->DevicePath = AllocateZeroPool (GetDevicePathSize (DevicePath)); + ASSERT(Option->DevicePath != NULL); + CopyMem (Option->DevicePath, DevicePath, GetDevicePathSize (DevicePath)); + // + // Update the shell boot option + // + InitializeListHead (&TempBootLists); + BdsLibRegisterNewOption (&TempBootLists, DevicePath, L"EFI Internal Shell", L"BootOrder"); - DEBUG ((DEBUG_INFO | DEBUG_LOAD, "Booting %S\n", Option->Description)); + // + // free the temporary device path created by BdsLibUpdateFvFileDevicePath() + // + FreePool (DevicePath); + DevicePath = Option->DevicePath; + } - Status = gBS->LoadImage ( - TRUE, - mBdsImageHandle, - DevicePath, - NULL, - 0, - &ImageHandle - ); + DEBUG_CODE_BEGIN(); - // - // If we didn't find an image directly, we need to try as if it is a removable device boot opotion - // and load the image according to the default boot behavior for removable device. - // - if (EFI_ERROR (Status)) { + if (Option->Description == NULL) { + DEBUG ((DEBUG_INFO | DEBUG_LOAD, "Booting from unknown device path\n")); + } else { + DEBUG ((DEBUG_INFO | DEBUG_LOAD, "Booting %S\n", Option->Description)); + } + + DEBUG_CODE_END(); + // - // check if there is a bootable removable media could be found in this device path , - // and get the bootable media handle + // Report status code for OS Loader LoadImage. // - Handle = BdsLibGetBootableHandle(DevicePath); - if (Handle == NULL) { - goto Done; - } + REPORT_STATUS_CODE (EFI_PROGRESS_CODE, PcdGet32 (PcdProgressCodeOsLoaderLoad)); + Status = gBS->LoadImage ( + TRUE, + gImageHandle, + DevicePath, + NULL, + 0, + &ImageHandle + ); + // - // Load the default boot file \EFI\BOOT\boot{machinename}.EFI from removable Media - // machinename is ia32, ia64, x64, ... + // If we didn't find an image directly, we need to try as if it is a removable device boot option + // and load the image according to the default boot behavior for removable device. // - FilePath = FileDevicePath (Handle, EFI_REMOVABLE_MEDIA_FILE_NAME); - if (FilePath != NULL) { - Status = gBS->LoadImage ( - TRUE, - mBdsImageHandle, - FilePath, - NULL, - 0, - &ImageHandle - ); - if (EFI_ERROR (Status)) { - // - // The DevicePath failed, and it's not a valid - // removable media device. - // + if (EFI_ERROR (Status)) { + // + // check if there is a bootable removable media could be found in this device path , + // and get the bootable media handle + // + Handle = BdsLibGetBootableHandle(DevicePath); + if (Handle == NULL) { goto Done; } + // + // Load the default boot file \EFI\BOOT\boot{machinename}.EFI from removable Media + // machinename is ia32, ia64, x64, ... + // + FilePath = FileDevicePath (Handle, EFI_REMOVABLE_MEDIA_FILE_NAME); + if (FilePath != NULL) { + REPORT_STATUS_CODE (EFI_PROGRESS_CODE, PcdGet32 (PcdProgressCodeOsLoaderLoad)); + Status = gBS->LoadImage ( + TRUE, + gImageHandle, + FilePath, + NULL, + 0, + &ImageHandle + ); + if (EFI_ERROR (Status)) { + // + // The DevicePath failed, and it's not a valid + // removable media device. + // + goto Done; + } + } } - } - if (EFI_ERROR (Status)) { - // - // It there is any error from the Boot attempt exit now. - // - goto Done; + if (EFI_ERROR (Status)) { + // + // It there is any error from the Boot attempt exit now. + // + goto Done; + } } // // Provide the image with it's load options // + if (ImageHandle == NULL) { + goto Done; + } Status = gBS->HandleProtocol (ImageHandle, &gEfiLoadedImageProtocolGuid, (VOID **) &ImageInfo); ASSERT_EFI_ERROR (Status); @@ -311,6 +818,18 @@ BdsLibBootViaBootOption ( // gBS->SetWatchdogTimer (5 * 60, 0x0000, 0x00, NULL); + // + // Write boot to OS performance data for UEFI boot + // + PERF_CODE ( + WriteBootToOsPerformanceData (); + ); + + // + // Report status code for OS Loader StartImage. + // + REPORT_STATUS_CODE (EFI_PROGRESS_CODE, PcdGet32 (PcdProgressCodeOsLoaderStart)); + Status = gBS->StartImage (ImageHandle, ExitDataSize, ExitData); DEBUG ((DEBUG_INFO | DEBUG_LOAD, "Image Return Status = %r\n", Status)); @@ -320,6 +839,15 @@ BdsLibBootViaBootOption ( gBS->SetWatchdogTimer (0x0000, 0x0000, 0x0000, NULL); Done: + // + // Set Logo status invalid after trying one boot option + // + BootLogo = NULL; + StatusLogo = gBS->LocateProtocol (&gEfiBootLogoProtocolGuid, NULL, (VOID **) &BootLogo); + if (!EFI_ERROR (StatusLogo) && (BootLogo != NULL)) { + BootLogo->SetBootLogo (BootLogo, NULL, 0, 0, 0, 0); + } + // // Clear Boot Current // @@ -373,16 +901,16 @@ BdsExpandPartitionPartialDevicePathToFull ( FullDevicePath = NULL; // - // Check if there is prestore 'HDDP' variable. + // Check if there is prestore HD_BOOT_DEVICE_PATH_VARIABLE_NAME variable. // If exist, search the front path which point to partition node in the variable instants. - // If fail to find or 'HDDP' not exist, reconnect all and search in all system + // If fail to find or HD_BOOT_DEVICE_PATH_VARIABLE_NAME not exist, reconnect all and search in all system // CachedDevicePath = BdsLibGetVariableAndSize ( - L"HDDP", - &mHdBootVariablePrivateGuid, + HD_BOOT_DEVICE_PATH_VARIABLE_NAME, + &gHdBootDevicePathVariablGuid, &CachedDevicePathSize ); - + if (CachedDevicePath != NULL) { TempNewDevicePath = CachedDevicePath; DeviceExist = FALSE; @@ -421,7 +949,7 @@ BdsExpandPartitionPartialDevicePathToFull ( FullDevicePath = AppendDevicePath (Instance, DevicePath); // - // Adjust the 'HDDP' instances sequence if the matched one is not first one. + // Adjust the HD_BOOT_DEVICE_PATH_VARIABLE_NAME instances sequence if the matched one is not first one. // if (NeedAdjust) { // @@ -430,7 +958,7 @@ BdsExpandPartitionPartialDevicePathToFull ( TempNewDevicePath = CachedDevicePath; CachedDevicePath = BdsLibDelPartMatchInstance (CachedDevicePath, Instance ); FreePool (TempNewDevicePath); - + // // Second, append the remaining path after the matched instance // @@ -441,14 +969,14 @@ BdsExpandPartitionPartialDevicePathToFull ( // Save the matching Device Path so we don't need to do a connect all next time // Status = gRT->SetVariable ( - L"HDDP", - &mHdBootVariablePrivateGuid, + HD_BOOT_DEVICE_PATH_VARIABLE_NAME, + &gHdBootDevicePathVariablGuid, EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE, GetDevicePathSize (CachedDevicePath), CachedDevicePath ); } - + FreePool (Instance); FreePool (CachedDevicePath); return FullDevicePath; @@ -456,7 +984,7 @@ BdsExpandPartitionPartialDevicePathToFull ( } // - // If we get here we fail to find or 'HDDP' not exist, and now we need + // If we get here we fail to find or HD_BOOT_DEVICE_PATH_VARIABLE_NAME not exist, and now we need // to search all devices in the system for a matched partition // BdsLibConnectAllDriversToAllControllers (); @@ -486,11 +1014,11 @@ BdsExpandPartitionPartialDevicePathToFull ( FullDevicePath = AppendDevicePath (BlockIoDevicePath, DevicePath); // - // Save the matched partition device path in 'HDDP' variable + // Save the matched partition device path in HD_BOOT_DEVICE_PATH_VARIABLE_NAME variable // if (CachedDevicePath != NULL) { // - // Save the matched partition device path as first instance of 'HDDP' variable + // Save the matched partition device path as first instance of HD_BOOT_DEVICE_PATH_VARIABLE_NAME variable // if (BdsLibMatchDevicePaths (CachedDevicePath, BlockIoDevicePath)) { TempNewDevicePath = CachedDevicePath; @@ -499,7 +1027,9 @@ BdsExpandPartitionPartialDevicePathToFull ( TempNewDevicePath = CachedDevicePath; CachedDevicePath = AppendDevicePathInstance (BlockIoDevicePath, CachedDevicePath); - FreePool(TempNewDevicePath); + if (TempNewDevicePath != NULL) { + FreePool(TempNewDevicePath); + } } else { TempNewDevicePath = CachedDevicePath; CachedDevicePath = AppendDevicePathInstance (BlockIoDevicePath, CachedDevicePath); @@ -507,7 +1037,8 @@ BdsExpandPartitionPartialDevicePathToFull ( } // // Here limit the device path instance number to 12, which is max number for a system support 3 IDE controller - // If the user try to boot many OS in different HDs or partitions, in theory, the 'HDDP' variable maybe become larger and larger. + // If the user try to boot many OS in different HDs or partitions, in theory, + // the HD_BOOT_DEVICE_PATH_VARIABLE_NAME variable maybe become larger and larger. // InstanceNum = 0; ASSERT (CachedDevicePath != NULL); @@ -537,8 +1068,8 @@ BdsExpandPartitionPartialDevicePathToFull ( // Save the matching Device Path so we don't need to do a connect all next time // Status = gRT->SetVariable ( - L"HDDP", - &mHdBootVariablePrivateGuid, + HD_BOOT_DEVICE_PATH_VARIABLE_NAME, + &gHdBootDevicePathVariablGuid, EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE, GetDevicePathSize (CachedDevicePath), CachedDevicePath @@ -547,8 +1078,10 @@ BdsExpandPartitionPartialDevicePathToFull ( break; } } - - FreePool (CachedDevicePath); + + if (CachedDevicePath != NULL) { + FreePool (CachedDevicePath); + } if (BlockIoBuffer != NULL) { FreePool (BlockIoBuffer); } @@ -582,7 +1115,7 @@ MatchPartitionDevicePathNode ( if ((BlockIoDevicePath == NULL) || (HardDriveDevicePath == NULL)) { return FALSE; } - + // // Make PreviousDevicePath == the device path node before the end node // @@ -611,7 +1144,7 @@ MatchPartitionDevicePathNode ( // TmpHdPath = (HARDDRIVE_DEVICE_PATH *) BlockIoHdDevicePathNode; Match = FALSE; - + // // Check for the match // @@ -699,7 +1232,7 @@ BdsLibDeleteOptionFromHandle ( &gEfiGlobalVariableGuid, &BootOptionSize ); - + if (BootOptionVar == NULL) { FreePool (BootOrder); return EFI_OUT_OF_RESOURCES; @@ -743,8 +1276,7 @@ BdsLibDeleteOptionFromHandle ( /** - Delete all invalid EFI boot options. The probable invalid boot option could - be Removable media or Network boot device. + Delete all invalid EFI boot options. @retval EFI_SUCCESS Delete all invalid boot option success @retval EFI_NOT_FOUND Variable "BootOrder" is not found @@ -767,6 +1299,7 @@ BdsDeleteAllInvalidEfiBootOption ( UINT16 BootOption[BOOT_OPTION_MAX_CHAR]; EFI_DEVICE_PATH_PROTOCOL *OptionDevicePath; UINT8 *TempPtr; + CHAR16 *Description; Status = EFI_SUCCESS; BootOrder = NULL; @@ -799,6 +1332,7 @@ BdsDeleteAllInvalidEfiBootOption ( TempPtr = BootOptionVar; TempPtr += sizeof (UINT32) + sizeof (UINT16); + Description = (CHAR16 *) TempPtr; TempPtr += StrSize ((CHAR16 *) TempPtr); OptionDevicePath = (EFI_DEVICE_PATH_PROTOCOL *) TempPtr; @@ -812,7 +1346,7 @@ BdsDeleteAllInvalidEfiBootOption ( continue; } - if (!BdsLibIsValidEFIBootOptDevicePath (OptionDevicePath, FALSE)) { + if (!BdsLibIsValidEFIBootOptDevicePathExt (OptionDevicePath, FALSE, Description)) { // // Delete this invalid boot option "Boot####" // @@ -858,8 +1392,40 @@ BdsDeleteAllInvalidEfiBootOption ( /** - This function will enumerate all possible boot device in the system, - it will only execute once of every boot. + For EFI boot option, BDS separate them as six types: + 1. Network - The boot option points to the SimpleNetworkProtocol device. + Bds will try to automatically create this type boot option when enumerate. + 2. Shell - The boot option points to internal flash shell. + Bds will try to automatically create this type boot option when enumerate. + 3. Removable BlockIo - The boot option only points to the removable media + device, like USB flash disk, DVD, Floppy etc. + These device should contain a *removable* blockIo + protocol in their device handle. + Bds will try to automatically create this type boot option + when enumerate. + 4. Fixed BlockIo - The boot option only points to a Fixed blockIo device, + like HardDisk. + These device should contain a *fixed* blockIo + protocol in their device handle. + BDS will skip fixed blockIo devices, and NOT + automatically create boot option for them. But BDS + will help to delete those fixed blockIo boot option, + whose description rule conflict with other auto-created + boot options. + 5. Non-BlockIo Simplefile - The boot option points to a device whose handle + has SimpleFileSystem Protocol, but has no blockio + protocol. These devices do not offer blockIo + protocol, but BDS still can get the + \EFI\BOOT\boot{machinename}.EFI by SimpleFileSystem + Protocol. + 6. File - The boot option points to a file. These boot options are usually + created by user manually or OS loader. BDS will not delete or modify + these boot options. + + This function will enumerate all possible boot device in the system, and + automatically create boot options for Network, Shell, Removable BlockIo, + and Non-BlockIo Simplefile devices. + It will only execute once of every boot. @param BdsBootOptionList The header of the link list which indexed all current boot options @@ -867,6 +1433,7 @@ BdsDeleteAllInvalidEfiBootOption ( @retval EFI_SUCCESS Finished all the boot device enumerate and create the boot option base on that boot device + @retval EFI_OUT_OF_RESOURCES Failed to enumerate the boot device and create the boot option list **/ EFI_STATUS EFIAPI @@ -876,48 +1443,79 @@ BdsLibEnumerateAllBootOption ( { EFI_STATUS Status; UINT16 FloppyNumber; + UINT16 HarddriveNumber; UINT16 CdromNumber; UINT16 UsbNumber; UINT16 MiscNumber; + UINT16 ScsiNumber; UINT16 NonBlockNumber; UINTN NumberBlockIoHandles; EFI_HANDLE *BlockIoHandles; EFI_BLOCK_IO_PROTOCOL *BlkIo; + BOOLEAN Removable[2]; + UINTN RemovableIndex; UINTN Index; - UINTN NumberSimpleNetworkHandles; - EFI_HANDLE *SimpleNetworkHandles; + UINTN NumOfLoadFileHandles; + EFI_HANDLE *LoadFileHandles; UINTN FvHandleCount; EFI_HANDLE *FvHandleBuffer; EFI_FV_FILETYPE Type; UINTN Size; EFI_FV_FILE_ATTRIBUTES Attributes; UINT32 AuthenticationStatus; - EFI_FIRMWARE_VOLUME2_PROTOCOL *Fv; - EFI_DEVICE_PATH_PROTOCOL *DevicePath; + EFI_FIRMWARE_VOLUME2_PROTOCOL *Fv; + EFI_DEVICE_PATH_PROTOCOL *DevicePath; UINTN DevicePathType; CHAR16 Buffer[40]; EFI_HANDLE *FileSystemHandles; UINTN NumberFileSystemHandles; BOOLEAN NeedDelete; EFI_IMAGE_DOS_HEADER DosHeader; + CHAR8 *PlatLang; + CHAR8 *LastLang; EFI_IMAGE_OPTIONAL_HEADER_UNION HdrData; EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr; - FloppyNumber = 0; - CdromNumber = 0; - UsbNumber = 0; - MiscNumber = 0; + FloppyNumber = 0; + HarddriveNumber = 0; + CdromNumber = 0; + UsbNumber = 0; + MiscNumber = 0; + ScsiNumber = 0; + PlatLang = NULL; + LastLang = NULL; ZeroMem (Buffer, sizeof (Buffer)); - + // // If the boot device enumerate happened, just get the boot // device from the boot order variable // if (mEnumBootDevice) { - BdsLibBuildOptionFromVar (BdsBootOptionList, L"BootOrder"); - return EFI_SUCCESS; + LastLang = GetVariable (LAST_ENUM_LANGUAGE_VARIABLE_NAME, &gLastEnumLangGuid); + PlatLang = GetEfiGlobalVariable (L"PlatformLang"); + ASSERT (PlatLang != NULL); + if ((LastLang != NULL) && (AsciiStrCmp (LastLang, PlatLang) == 0)) { + Status = BdsLibBuildOptionFromVar (BdsBootOptionList, L"BootOrder"); + FreePool (LastLang); + FreePool (PlatLang); + return Status; + } else { + Status = gRT->SetVariable ( + LAST_ENUM_LANGUAGE_VARIABLE_NAME, + &gLastEnumLangGuid, + EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_NON_VOLATILE, + AsciiStrSize (PlatLang), + PlatLang + ); + ASSERT_EFI_ERROR (Status); + + if (LastLang != NULL) { + FreePool (LastLang); + } + FreePool (PlatLang); + } } - + // // Notes: this dirty code is to get the legacy boot option from the // BBS table and create to variable as the EFI boot option, it should @@ -929,10 +1527,15 @@ BdsLibEnumerateAllBootOption ( // Delete invalid boot option // BdsDeleteAllInvalidEfiBootOption (); - + // - // Parse removable media + // Parse removable media followed by fixed media. + // The Removable[] array is used by the for-loop below to create removable media boot options + // at first, and then to create fixed media boot options. // + Removable[0] = FALSE; + Removable[1] = TRUE; + gBS->LocateHandleBuffer ( ByProtocol, &gEfiBlockIoProtocolGuid, @@ -940,77 +1543,91 @@ BdsLibEnumerateAllBootOption ( &NumberBlockIoHandles, &BlockIoHandles ); - - for (Index = 0; Index < NumberBlockIoHandles; Index++) { - Status = gBS->HandleProtocol ( - BlockIoHandles[Index], - &gEfiBlockIoProtocolGuid, - (VOID **) &BlkIo - ); - if (!EFI_ERROR (Status)) { - if (!BlkIo->Media->RemovableMedia) { - // - // skip the non-removable block devices - // + + for (RemovableIndex = 0; RemovableIndex < 2; RemovableIndex++) { + for (Index = 0; Index < NumberBlockIoHandles; Index++) { + Status = gBS->HandleProtocol ( + BlockIoHandles[Index], + &gEfiBlockIoProtocolGuid, + (VOID **) &BlkIo + ); + // + // skip the fixed block io then the removable block io + // + if (EFI_ERROR (Status) || (BlkIo->Media->RemovableMedia == Removable[RemovableIndex])) { continue; } - } - DevicePath = DevicePathFromHandle (BlockIoHandles[Index]); - DevicePathType = BdsGetBootTypeFromDevicePath (DevicePath); + DevicePath = DevicePathFromHandle (BlockIoHandles[Index]); + DevicePathType = BdsGetBootTypeFromDevicePath (DevicePath); - switch (DevicePathType) { - case BDS_EFI_ACPI_FLOPPY_BOOT: - if (FloppyNumber == 0) { - UnicodeSPrint (Buffer, sizeof (Buffer), L"EFI Floppy"); - } else { - UnicodeSPrint (Buffer, sizeof (Buffer), L"EFI Floppy %d", FloppyNumber); - } - BdsLibBuildOptionFromHandle (BlockIoHandles[Index], BdsBootOptionList, Buffer); - FloppyNumber++; - break; + switch (DevicePathType) { + case BDS_EFI_ACPI_FLOPPY_BOOT: + if (FloppyNumber != 0) { + UnicodeSPrint (Buffer, sizeof (Buffer), L"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_FLOPPY)), FloppyNumber); + } else { + UnicodeSPrint (Buffer, sizeof (Buffer), L"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_FLOPPY))); + } + BdsLibBuildOptionFromHandle (BlockIoHandles[Index], BdsBootOptionList, Buffer); + FloppyNumber++; + break; - case BDS_EFI_MESSAGE_ATAPI_BOOT: - if (CdromNumber == 0) { - UnicodeSPrint (Buffer, sizeof (Buffer), L"EFI DVD/CDROM"); - } else { - UnicodeSPrint (Buffer, sizeof (Buffer), L"EFI DVD/CDROM %d", CdromNumber); - } - BdsLibBuildOptionFromHandle (BlockIoHandles[Index], BdsBootOptionList, Buffer); - CdromNumber++; - break; + // + // Assume a removable SATA device should be the DVD/CD device, a fixed SATA device should be the Hard Drive device. + // + case BDS_EFI_MESSAGE_ATAPI_BOOT: + case BDS_EFI_MESSAGE_SATA_BOOT: + if (BlkIo->Media->RemovableMedia) { + if (CdromNumber != 0) { + UnicodeSPrint (Buffer, sizeof (Buffer), L"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_CD_DVD)), CdromNumber); + } else { + UnicodeSPrint (Buffer, sizeof (Buffer), L"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_CD_DVD))); + } + CdromNumber++; + } else { + if (HarddriveNumber != 0) { + UnicodeSPrint (Buffer, sizeof (Buffer), L"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_HARDDRIVE)), HarddriveNumber); + } else { + UnicodeSPrint (Buffer, sizeof (Buffer), L"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_HARDDRIVE))); + } + HarddriveNumber++; + } + DEBUG ((DEBUG_INFO | DEBUG_LOAD, "Buffer: %S\n", Buffer)); + BdsLibBuildOptionFromHandle (BlockIoHandles[Index], BdsBootOptionList, Buffer); + break; - case BDS_EFI_MESSAGE_USB_DEVICE_BOOT: - if (UsbNumber == 0) { - UnicodeSPrint (Buffer, sizeof (Buffer), L"EFI USB Device"); - } else { - UnicodeSPrint (Buffer, sizeof (Buffer), L"EFI USB Device %d", UsbNumber); - } - BdsLibBuildOptionFromHandle (BlockIoHandles[Index], BdsBootOptionList, Buffer); - UsbNumber++; - break; + case BDS_EFI_MESSAGE_USB_DEVICE_BOOT: + if (UsbNumber != 0) { + UnicodeSPrint (Buffer, sizeof (Buffer), L"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_USB)), UsbNumber); + } else { + UnicodeSPrint (Buffer, sizeof (Buffer), L"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_USB))); + } + BdsLibBuildOptionFromHandle (BlockIoHandles[Index], BdsBootOptionList, Buffer); + UsbNumber++; + break; - case BDS_EFI_MESSAGE_SCSI_BOOT: - if (UsbNumber == 0) { - UnicodeSPrint (Buffer, sizeof (Buffer), L"EFI SCSI Device"); - } else { - UnicodeSPrint (Buffer, sizeof (Buffer), L"EFI SCSI Device %d", UsbNumber); - } - BdsLibBuildOptionFromHandle (BlockIoHandles[Index], BdsBootOptionList, Buffer); - UsbNumber++; - break; + case BDS_EFI_MESSAGE_SCSI_BOOT: + if (ScsiNumber != 0) { + UnicodeSPrint (Buffer, sizeof (Buffer), L"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_SCSI)), ScsiNumber); + } else { + UnicodeSPrint (Buffer, sizeof (Buffer), L"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_SCSI))); + } + BdsLibBuildOptionFromHandle (BlockIoHandles[Index], BdsBootOptionList, Buffer); + ScsiNumber++; + break; - case BDS_EFI_MESSAGE_MISC_BOOT: - if (MiscNumber == 0) { - UnicodeSPrint (Buffer, sizeof (Buffer), L"EFI Misc Device"); - } else { - UnicodeSPrint (Buffer, sizeof (Buffer), L"EFI Misc Device %d", MiscNumber); - } - BdsLibBuildOptionFromHandle (BlockIoHandles[Index], BdsBootOptionList, Buffer); - MiscNumber++; - break; + case BDS_EFI_MESSAGE_MISC_BOOT: + if (MiscNumber != 0) { + UnicodeSPrint (Buffer, sizeof (Buffer), L"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_MISC)), MiscNumber); + } else { + UnicodeSPrint (Buffer, sizeof (Buffer), L"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_MISC))); + } + BdsLibBuildOptionFromHandle (BlockIoHandles[Index], BdsBootOptionList, Buffer); + MiscNumber++; + break; - default: - break; + default: + break; + } } } @@ -1046,7 +1663,7 @@ BdsLibEnumerateAllBootOption ( // Do the removable Media thing. \EFI\BOOT\boot{machinename}.EFI // machinename is ia32, ia64, x64, ... // - Hdr.Union = &HdrData; + Hdr.Union = &HdrData; NeedDelete = TRUE; Status = BdsLibGetImageHeader ( FileSystemHandles[Index], @@ -1066,10 +1683,10 @@ BdsLibEnumerateAllBootOption ( // BdsLibDeleteOptionFromHandle (FileSystemHandles[Index]); } else { - if (NonBlockNumber == 0) { - UnicodeSPrint (Buffer, sizeof (Buffer), L"EFI Non-Block Boot Device"); + if (NonBlockNumber != 0) { + UnicodeSPrint (Buffer, sizeof (Buffer), L"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NON_BLOCK)), NonBlockNumber); } else { - UnicodeSPrint (Buffer, sizeof (Buffer), L"EFI Non-Block Boot Device %d", NonBlockNumber); + UnicodeSPrint (Buffer, sizeof (Buffer), L"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NON_BLOCK))); } BdsLibBuildOptionFromHandle (FileSystemHandles[Index], BdsBootOptionList, Buffer); NonBlockNumber++; @@ -1083,24 +1700,29 @@ BdsLibEnumerateAllBootOption ( // // Parse Network Boot Device // + NumOfLoadFileHandles = 0; + // + // Search Load File protocol for PXE boot option. + // gBS->LocateHandleBuffer ( ByProtocol, - &gEfiSimpleNetworkProtocolGuid, + &gEfiLoadFileProtocolGuid, NULL, - &NumberSimpleNetworkHandles, - &SimpleNetworkHandles + &NumOfLoadFileHandles, + &LoadFileHandles ); - for (Index = 0; Index < NumberSimpleNetworkHandles; Index++) { - if (Index == 0) { - UnicodeSPrint (Buffer, sizeof (Buffer), L"EFI Network"); + + for (Index = 0; Index < NumOfLoadFileHandles; Index++) { + if (Index != 0) { + UnicodeSPrint (Buffer, sizeof (Buffer), L"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NETWORK)), Index); } else { - UnicodeSPrint (Buffer, sizeof (Buffer), L"EFI Network %d", Index); + UnicodeSPrint (Buffer, sizeof (Buffer), L"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NETWORK))); } - BdsLibBuildOptionFromHandle (SimpleNetworkHandles[Index], BdsBootOptionList, Buffer); + BdsLibBuildOptionFromHandle (LoadFileHandles[Index], BdsBootOptionList, Buffer); } - if (NumberSimpleNetworkHandles != 0) { - FreePool (SimpleNetworkHandles); + if (NumOfLoadFileHandles != 0) { + FreePool (LoadFileHandles); } // @@ -1122,7 +1744,7 @@ BdsLibEnumerateAllBootOption ( Status = Fv->ReadFile ( Fv, - &gEfiShellFileGuid, + PcdGetPtr(PcdShellFile), NULL, &Size, &Type, @@ -1148,10 +1770,10 @@ BdsLibEnumerateAllBootOption ( // Make sure every boot only have one time // boot device enumerate // - BdsLibBuildOptionFromVar (BdsBootOptionList, L"BootOrder"); + Status = BdsLibBuildOptionFromVar (BdsBootOptionList, L"BootOrder"); mEnumBootDevice = TRUE; - return EFI_SUCCESS; + return Status; } /** @@ -1174,7 +1796,7 @@ BdsLibBuildOptionFromHandle ( { EFI_DEVICE_PATH_PROTOCOL *DevicePath; - DevicePath = DevicePathFromHandle (Handle); + DevicePath = DevicePathFromHandle (Handle); // // Create and register new boot option @@ -1207,7 +1829,7 @@ BdsLibBuildOptionFromShell ( // // Build the shell device path // - EfiInitializeFwVolDevicepathNode (&ShellNode, &gEfiShellFileGuid); + EfiInitializeFwVolDevicepathNode (&ShellNode, PcdGetPtr(PcdShellFile)); DevicePath = AppendDevicePathNode (DevicePath, (EFI_DEVICE_PATH_PROTOCOL *) &ShellNode); @@ -1278,9 +1900,9 @@ BdsLibBootNext ( Second, check whether the device path point to a device which support SimpleFileSystemProtocol, Third, detect the the default boot file in the Media, and return the removable Media handle. - @param DevicePath Device Path to a bootable device + @param DevicePath Device Path to a bootable device - @retval NULL The media on the DevicePath is not bootable + @return The bootable media handle. If the media on the DevicePath is not bootable, NULL will return. **/ EFI_HANDLE @@ -1290,6 +1912,7 @@ BdsLibGetBootableHandle ( ) { EFI_STATUS Status; + EFI_TPL OldTpl; EFI_DEVICE_PATH_PROTOCOL *UpdatedDevicePath; EFI_DEVICE_PATH_PROTOCOL *DupDevicePath; EFI_HANDLE Handle; @@ -1308,7 +1931,13 @@ BdsLibGetBootableHandle ( EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr; UpdatedDevicePath = DevicePath; - + + // + // Enter to critical section to protect the acquired BlockIo instance + // from getting released due to the USB mass storage hotplug event + // + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + // // Check whether the device is connected // @@ -1327,10 +1956,17 @@ BdsLibGetBootableHandle ( gBS->ConnectController (Handle, NULL, NULL, TRUE); } } else { + // + // For removable device boot option, its contained device path only point to the removable device handle, + // should make sure all its children handles (its child partion or media handles) are created and connected. + // + gBS->ConnectController (Handle, NULL, NULL, TRUE); // // Get BlockIo protocol and check removable attribute // Status = gBS->HandleProtocol (Handle, &gEfiBlockIoProtocolGuid, (VOID **)&BlockIo); + ASSERT_EFI_ERROR (Status); + // // Issue a dummy read to the device to check for media change. // When the removable media is changed, any Block IO read/write will @@ -1361,7 +1997,7 @@ BdsLibGetBootableHandle ( // DupDevicePath = DuplicateDevicePath (DevicePath); ASSERT (DupDevicePath != NULL); - + UpdatedDevicePath = DupDevicePath; Status = gBS->LocateDevicePath (&gEfiDevicePathProtocolGuid, &UpdatedDevicePath, &Handle); // @@ -1427,6 +2063,8 @@ BdsLibGetBootableHandle ( FreePool(SimpleFileSystemHandles); } + gBS->RestoreTPL (OldTpl); + return ReturnHandle; } @@ -1450,11 +2088,15 @@ BdsLibNetworkBootWithMediaPresent ( EFI_HANDLE Handle; EFI_SIMPLE_NETWORK_PROTOCOL *Snp; BOOLEAN MediaPresent; + UINT32 InterruptStatus; MediaPresent = FALSE; UpdatedDevicePath = DevicePath; - Status = gBS->LocateDevicePath (&gEfiSimpleNetworkProtocolGuid, &UpdatedDevicePath, &Handle); + // + // Locate Load File Protocol for PXE boot option first + // + Status = gBS->LocateDevicePath (&gEfiLoadFileProtocolGuid, &UpdatedDevicePath, &Handle); if (EFI_ERROR (Status)) { // // Device not present so see if we need to connect it @@ -1464,15 +2106,36 @@ BdsLibNetworkBootWithMediaPresent ( // // This one should work after we did the connect // - Status = gBS->LocateDevicePath (&gEfiSimpleNetworkProtocolGuid, &UpdatedDevicePath, &Handle); + Status = gBS->LocateDevicePath (&gEfiLoadFileProtocolGuid, &UpdatedDevicePath, &Handle); } } if (!EFI_ERROR (Status)) { Status = gBS->HandleProtocol (Handle, &gEfiSimpleNetworkProtocolGuid, (VOID **)&Snp); + if (EFI_ERROR (Status)) { + // + // Failed to open SNP from this handle, try to get SNP from parent handle + // + UpdatedDevicePath = DevicePathFromHandle (Handle); + if (UpdatedDevicePath != NULL) { + Status = gBS->LocateDevicePath (&gEfiSimpleNetworkProtocolGuid, &UpdatedDevicePath, &Handle); + if (!EFI_ERROR (Status)) { + // + // SNP handle found, get SNP from it + // + Status = gBS->HandleProtocol (Handle, &gEfiSimpleNetworkProtocolGuid, (VOID **) &Snp); + } + } + } + if (!EFI_ERROR (Status)) { if (Snp->Mode->MediaPresentSupported) { if (Snp->Mode->State == EfiSimpleNetworkInitialized) { + // + // Invoke Snp->GetStatus() to refresh the media status + // + Snp->GetStatus (Snp, &InterruptStatus, NULL); + // // In case some one else is using the SNP check to see if it's connected // @@ -1506,23 +2169,22 @@ BdsLibNetworkBootWithMediaPresent ( @param DevicePath The bootable device Path to check - @retval BDS_EFI_MEDIA_HD_BOOT If the device path contains any media device path node, it is media boot type - For the floppy node, handle it as media node - @retval BDS_EFI_MEDIA_CDROM_BOOT If the device path contains any media device path node, it is media boot type - For the floppy node, handle it as media node - @retval BDS_EFI_ACPI_FLOPPY_BOOT If the device path contains any media device path node, it is media boot type - For the floppy node, handle it as media node - @retval BDS_EFI_MESSAGE_ATAPI_BOOT If the device path not contains any media device path node, and - its last device path node point to a message device path node, it is - - @retval BDS_EFI_MESSAGE_SCSI_BOOT If the device path not contains any media device path node, and - its last device path node point to a message device path node, it is - @retval BDS_EFI_MESSAGE_USB_DEVICE_BOOT If the device path not contains any media device path node, and - its last device path node point to a message device path node, it is + @retval BDS_EFI_MEDIA_HD_BOOT If given device path contains MEDIA_DEVICE_PATH type device path node + which subtype is MEDIA_HARDDRIVE_DP + @retval BDS_EFI_MEDIA_CDROM_BOOT If given device path contains MEDIA_DEVICE_PATH type device path node + which subtype is MEDIA_CDROM_DP + @retval BDS_EFI_ACPI_FLOPPY_BOOT If given device path contains ACPI_DEVICE_PATH type device path node + which HID is floppy device. + @retval BDS_EFI_MESSAGE_ATAPI_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node + and its last device path node's subtype is MSG_ATAPI_DP. + @retval BDS_EFI_MESSAGE_SCSI_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node + and its last device path node's subtype is MSG_SCSI_DP. + @retval BDS_EFI_MESSAGE_USB_DEVICE_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node + and its last device path node's subtype is MSG_USB_DP. @retval BDS_EFI_MESSAGE_MISC_BOOT If the device path not contains any media device path node, and - its last device path node point to a message device path node, it is - @retval BDS_LEGACY_BBS_BOOT Legacy boot type - @retval BDS_EFI_UNSUPPORT An EFI Removable BlockIO device path not point to a media and message device, + its last device path node point to a message device path node. + @retval BDS_LEGACY_BBS_BOOT If given device path contains BBS_DEVICE_PATH type device path node. + @retval BDS_EFI_UNSUPPORT An EFI Removable BlockIO device path not point to a media and message device, **/ UINT32 @@ -1534,7 +2196,7 @@ BdsGetBootTypeFromDevicePath ( ACPI_HID_DEVICE_PATH *Acpi; EFI_DEVICE_PATH_PROTOCOL *TempDevicePath; EFI_DEVICE_PATH_PROTOCOL *LastDeviceNode; - + UINT32 BootType; if (NULL == DevicePath) { return BDS_EFI_UNSUPPORT; @@ -1567,7 +2229,7 @@ BdsGetBootTypeFromDevicePath ( if (DevicePathSubType(LastDeviceNode) == MSG_DEVICE_LOGICAL_UNIT_DP) { // // if the next node type is Device Logical Unit, which specify the Logical Unit Number (LUN), - // skit it + // skip it // LastDeviceNode = NextDevicePathNode (LastDeviceNode); } @@ -1575,17 +2237,39 @@ BdsGetBootTypeFromDevicePath ( // if the device path not only point to driver device, it is not a messaging device path, // if (!IsDevicePathEndType (LastDeviceNode)) { - break; + break; } - if (DevicePathSubType(TempDevicePath) == MSG_ATAPI_DP) { - return BDS_EFI_MESSAGE_ATAPI_BOOT; - } else if (DevicePathSubType(TempDevicePath) == MSG_USB_DP) { - return BDS_EFI_MESSAGE_USB_DEVICE_BOOT; - } else if (DevicePathSubType(TempDevicePath) == MSG_SCSI_DP) { - return BDS_EFI_MESSAGE_SCSI_BOOT; + switch (DevicePathSubType (TempDevicePath)) { + case MSG_ATAPI_DP: + BootType = BDS_EFI_MESSAGE_ATAPI_BOOT; + break; + + case MSG_USB_DP: + BootType = BDS_EFI_MESSAGE_USB_DEVICE_BOOT; + break; + + case MSG_SCSI_DP: + BootType = BDS_EFI_MESSAGE_SCSI_BOOT; + break; + + case MSG_SATA_DP: + BootType = BDS_EFI_MESSAGE_SATA_BOOT; + break; + + case MSG_MAC_ADDR_DP: + case MSG_VLAN_DP: + case MSG_IPv4_DP: + case MSG_IPv6_DP: + BootType = BDS_EFI_MESSAGE_MAC_BOOT; + break; + + default: + BootType = BDS_EFI_MESSAGE_MISC_BOOT; + break; } - return BDS_EFI_MESSAGE_MISC_BOOT; + return BootType; + default: break; } @@ -1612,6 +2296,32 @@ BdsLibIsValidEFIBootOptDevicePath ( IN EFI_DEVICE_PATH_PROTOCOL *DevPath, IN BOOLEAN CheckMedia ) +{ + return BdsLibIsValidEFIBootOptDevicePathExt (DevPath, CheckMedia, NULL); +} + +/** + Check whether the Device path in a boot option point to a valid bootable device, + And if CheckMedia is true, check the device is ready to boot now. + If Description is not NULL and the device path point to a fixed BlockIo + device, check the description whether conflict with other auto-created + boot options. + + @param DevPath the Device path in a boot option + @param CheckMedia if true, check the device is ready to boot now. + @param Description the description in a boot option + + @retval TRUE the Device path is valid + @retval FALSE the Device path is invalid . + +**/ +BOOLEAN +EFIAPI +BdsLibIsValidEFIBootOptDevicePathExt ( + IN EFI_DEVICE_PATH_PROTOCOL *DevPath, + IN BOOLEAN CheckMedia, + IN CHAR16 *Description + ) { EFI_STATUS Status; EFI_HANDLE Handle; @@ -1621,14 +2331,14 @@ BdsLibIsValidEFIBootOptDevicePath ( TempDevicePath = DevPath; LastDeviceNode = DevPath; - + // - // Check if it's a valid boot option for network boot device - // Only check if there is SimpleNetworkProtocol installed. If yes, that means - // there is the network card there. + // Check if it's a valid boot option for network boot device. + // Check if there is EfiLoadFileProtocol installed. + // If yes, that means there is a boot option for network. // Status = gBS->LocateDevicePath ( - &gEfiSimpleNetworkProtocolGuid, + &gEfiLoadFileProtocolGuid, &TempDevicePath, &Handle ); @@ -1639,13 +2349,20 @@ BdsLibIsValidEFIBootOptDevicePath ( TempDevicePath = DevPath; BdsLibConnectDevicePath (TempDevicePath); Status = gBS->LocateDevicePath ( - &gEfiSimpleNetworkProtocolGuid, + &gEfiLoadFileProtocolGuid, &TempDevicePath, &Handle ); } - + if (!EFI_ERROR (Status)) { + if (!IsDevicePathEnd (TempDevicePath)) { + // + // LoadFile protocol is not installed on handle with exactly the same DevPath + // + return FALSE; + } + if (CheckMedia) { // // Test if it is ready to boot now @@ -1655,7 +2372,7 @@ BdsLibIsValidEFIBootOptDevicePath ( } } else { return TRUE; - } + } } // @@ -1663,8 +2380,19 @@ BdsLibIsValidEFIBootOptDevicePath ( // and assume it is ready to boot now // while (!IsDevicePathEnd (TempDevicePath)) { - LastDeviceNode = TempDevicePath; - TempDevicePath = NextDevicePathNode (TempDevicePath); + // + // If there is USB Class or USB WWID device path node, treat it as valid EFI + // Boot Option. BdsExpandUsbShortFormDevicePath () will be used to expand it + // to full device path. + // + if ((DevicePathType (TempDevicePath) == MESSAGING_DEVICE_PATH) && + ((DevicePathSubType (TempDevicePath) == MSG_USB_CLASS_DP) || + (DevicePathSubType (TempDevicePath) == MSG_USB_WWID_DP))) { + return TRUE; + } + + LastDeviceNode = TempDevicePath; + TempDevicePath = NextDevicePathNode (TempDevicePath); } if ((DevicePathType (LastDeviceNode) == MEDIA_DEVICE_PATH) && (DevicePathSubType (LastDeviceNode) == MEDIA_FILEPATH_DP)) { @@ -1672,26 +2400,31 @@ BdsLibIsValidEFIBootOptDevicePath ( } // - // Check if it's a valid boot option for internal Shell + // Check if it's a valid boot option for internal FV application // if (EfiGetNameGuidFromFwVolDevicePathNode ((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *) LastDeviceNode) != NULL) { // - // If the boot option point to Internal FV shell, make sure it is valid + // If the boot option point to internal FV application, make sure it is valid // - TempDevicePath = DevPath; - Status = BdsLibUpdateFvFileDevicePath (&TempDevicePath, &gEfiShellFileGuid); + TempDevicePath = DevPath; + Status = BdsLibUpdateFvFileDevicePath ( + &TempDevicePath, + EfiGetNameGuidFromFwVolDevicePathNode ((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *) LastDeviceNode) + ); if (Status == EFI_ALREADY_STARTED) { return TRUE; } else { if (Status == EFI_SUCCESS) { - FreePool (TempDevicePath); + FreePool (TempDevicePath); } return FALSE; } } - + // - // 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 + // If the boot option point to a blockIO device: + // if it is a removable blockIo device, it is valid. + // if it is a fixed blockIo device, check its description confliction. // TempDevicePath = DevPath; Status = gBS->LocateDevicePath (&gEfiBlockIoProtocolGuid, &TempDevicePath, &Handle); @@ -1708,7 +2441,7 @@ BdsLibIsValidEFIBootOptDevicePath ( Status = gBS->LocateDevicePath (&gEfiBlockIoProtocolGuid, &TempDevicePath, &Handle); } } - + if (!EFI_ERROR (Status)) { Status = gBS->HandleProtocol (Handle, &gEfiBlockIoProtocolGuid, (VOID **)&BlockIo); if (!EFI_ERROR (Status)) { @@ -1797,7 +2530,7 @@ BdsLibUpdateFvFileDevicePath ( if (FileGuid == NULL) { return EFI_INVALID_PARAMETER; } - + // // Check whether the device path point to the default the input Fv file // @@ -1865,7 +2598,7 @@ BdsLibUpdateFvFileDevicePath ( FindFvFile = FALSE; FoundFvHandle = NULL; Status = gBS->HandleProtocol ( - mBdsImageHandle, + gImageHandle, &gEfiLoadedImageProtocolGuid, (VOID **) &LoadedImage ); @@ -1931,7 +2664,7 @@ BdsLibUpdateFvFileDevicePath ( } if (FvHandleBuffer != NULL) { - FreePool (FvHandleBuffer); + FreePool (FvHandleBuffer); } }