]> code.delx.au - refind/blobdiff - refind/main.c
Further legacy BIOS boot support tweaks
[refind] / refind / main.c
index 36fb5ce933dfaab9233b82a73243a0ca889a47a9..b0f769a806d5e671a08de5f604112f8176b54219 100644 (file)
 #include "driver_support.h"
 #include "../include/syslinux_mbr.h"
 
+#ifdef __MAKEWITH_TIANO
+#include "../EfiLib/BdsHelper.h"
+#endif // __MAKEWITH_TIANO
+
 // 
 // variables
 
@@ -89,7 +93,8 @@ static REFIT_MENU_ENTRY MenuEntryExit     = { L"Exit rEFInd", TAG_EXIT, 1, 0, 0,
 static REFIT_MENU_SCREEN MainMenu       = { L"Main Menu", NULL, 0, NULL, 0, NULL, 0, L"Automatic boot" };
 static REFIT_MENU_SCREEN AboutMenu      = { L"About", NULL, 0, NULL, 0, NULL, 0, NULL };
 
-REFIT_CONFIG GlobalConfig = { FALSE, FALSE, 0, 0, 20, 0, 0, GRAPHICS_FOR_OSX, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
+REFIT_CONFIG GlobalConfig = { FALSE, FALSE, 0, 0, 20, 0, 0, GRAPHICS_FOR_OSX, LEGACY_TYPE_MAC, 0,
+                              NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
                               {TAG_SHELL, TAG_ABOUT, TAG_SHUTDOWN, TAG_REBOOT, 0, 0, 0, 0, 0 }};
 
 // Structure used to hold boot loader filenames and time stamps in
@@ -110,7 +115,7 @@ static VOID AboutrEFInd(VOID)
 
     if (AboutMenu.EntryCount == 0) {
         AboutMenu.TitleImage = BuiltinIcon(BUILTIN_ICON_FUNC_ABOUT);
-        AddMenuInfoLine(&AboutMenu, L"rEFInd Version 0.4.4.1");
+        AddMenuInfoLine(&AboutMenu, L"rEFInd Version 0.4.5.5");
         AddMenuInfoLine(&AboutMenu, L"");
         AddMenuInfoLine(&AboutMenu, L"Copyright (c) 2006-2010 Christoph Pfisterer");
         AddMenuInfoLine(&AboutMenu, L"Copyright (c) 2012 Roderick W. Smith");
@@ -1130,7 +1135,7 @@ static VOID StartLegacy(IN LEGACY_ENTRY *Entry)
     UINTN               ErrorInStep = 0;
     EFI_DEVICE_PATH     *DiscoveredPathList[MAX_DISCOVERED_PATHS];
 
-    BeginExternalScreen(TRUE, L"Booting Legacy OS");
+    BeginExternalScreen(TRUE, L"Booting Legacy OS (Mac mode)");
 
     BootLogoImage = LoadOSIcon(Entry->Volume->OSIconName, L"legacy", TRUE);
     if (BootLogoImage != NULL)
@@ -1157,6 +1162,22 @@ static VOID StartLegacy(IN LEGACY_ENTRY *Entry)
     FinishExternalScreen();
 } /* static VOID StartLegacy() */
 
+// Start a device on a non-Mac using the EFI_LEGACY_BIOS_PROTOCOL
+#ifdef __MAKEWITH_TIANO
+static VOID StartLegacyUEFI(IN LEGACY_ENTRY *Entry)
+{
+    BeginExternalScreen(TRUE, L"Booting Legacy OS (UEFI mode)");
+
+    BdsLibConnectDevicePath (Entry->BdsOption->DevicePath);
+    BdsLibDoLegacyBoot(Entry->BdsOption);
+
+    // If we get here, it means that there was a failure....
+    Print(L"Failure booting legacy (BIOS) OS.");
+    PauseForKey();
+    FinishExternalScreen();
+} // static VOID StartLegacyUEFI()
+#endif // __MAKEWITH_TIANO
+
 static LEGACY_ENTRY * AddLegacyEntry(IN CHAR16 *LoaderTitle, IN REFIT_VOLUME *Volume)
 {
     LEGACY_ENTRY            *Entry, *SubEntry;
@@ -1212,6 +1233,131 @@ static LEGACY_ENTRY * AddLegacyEntry(IN CHAR16 *LoaderTitle, IN REFIT_VOLUME *Vo
     return Entry;
 } /* static LEGACY_ENTRY * AddLegacyEntry() */
 
+
+#ifdef __MAKEWITH_TIANO
+// default volume badge icon based on disk kind
+static EG_IMAGE * GetDiskBadge(IN UINTN DiskType) {
+   EG_IMAGE * Badge = NULL;
+
+   switch (DiskType) {
+      case BBS_HARDDISK:
+         Badge = BuiltinIcon(BUILTIN_ICON_VOL_INTERNAL);
+         break;
+      case BBS_USB:
+         Badge = BuiltinIcon(BUILTIN_ICON_VOL_EXTERNAL);
+         break;
+      case BBS_CDROM:
+         Badge = BuiltinIcon(BUILTIN_ICON_VOL_OPTICAL);
+         break;
+   } // switch()
+   return Badge;
+} // static EG_IMAGE * GetDiskBadge()
+
+/**
+    Create a rEFInd boot option from a Legacy BIOS protocol option.
+*/
+static LEGACY_ENTRY * AddLegacyEntryUEFI(BDS_COMMON_OPTION *BdsOption, IN UINT16 DiskType)
+{
+    LEGACY_ENTRY            *Entry, *SubEntry;
+    REFIT_MENU_SCREEN       *SubScreen;
+    CHAR16                  ShortcutLetter = 0;
+    CHAR16 *LegacyDescription = BdsOption->Description;
+
+    // prepare the menu entry
+    Entry = AllocateZeroPool(sizeof(LEGACY_ENTRY));
+    Entry->me.Title = AllocateZeroPool(256 * sizeof(CHAR16));
+    SPrint(Entry->me.Title, 255, L"Boot legacy target %s", LegacyDescription);
+    Entry->me.Tag          = TAG_LEGACY_NON_MAC;
+    Entry->me.Row          = 0;
+    Entry->me.ShortcutLetter = ShortcutLetter;
+    Entry->me.Image        = LoadOSIcon(L"legacy", L"legacy", TRUE);
+    Entry->LoadOptions     = (DiskType == BBS_CDROM) ? L"CD" :
+                             ((DiskType == BBS_USB) ? L"USB" : L"HD");
+    Entry->me.BadgeImage   = GetDiskBadge(DiskType);
+//    Entry->me.BadgeImage   = Volume->VolBadgeImage;
+    Entry->BdsOption       = BdsOption;
+    Entry->Enabled         = TRUE;
+
+    // create the submenu
+    SubScreen = AllocateZeroPool(sizeof(REFIT_MENU_SCREEN));
+    SubScreen->Title = AllocateZeroPool(256 * sizeof(CHAR16));
+    SPrint(SubScreen->Title, 255, L"No boot options for legacy target");
+    SubScreen->TitleImage = Entry->me.Image;
+
+    // default entry
+    SubEntry = AllocateZeroPool(sizeof(LEGACY_ENTRY));
+    SubEntry->me.Title = AllocateZeroPool(256 * sizeof(CHAR16));
+    SPrint(SubEntry->me.Title, 255, L"Boot %s", LegacyDescription);
+    SubEntry->me.Tag          = TAG_LEGACY_NON_MAC;
+    Entry->BdsOption          = BdsOption; 
+    AddMenuEntry(SubScreen, (REFIT_MENU_ENTRY *)SubEntry);
+
+    AddMenuEntry(SubScreen, &MenuEntryReturn);
+    Entry->me.SubScreen = SubScreen;
+    AddMenuEntry(&MainMenu, (REFIT_MENU_ENTRY *)Entry);
+    return Entry;
+} /* static LEGACY_ENTRY * AddLegacyEntryUEFI() */
+
+/**
+    Scan for legacy BIOS targets on machines that implement EFI_LEGACY_BIOS_PROTOCOL.
+    In testing, protocol has not been implemented on Macs but has been
+    implemented on several Dell PCs and an ASUS motherboard.
+    Restricts output to disks of the specified DiskType.
+*/
+static VOID ScanLegacyUEFI(IN UINTN DiskType)
+{
+    EFI_STATUS                Status;
+    EFI_LEGACY_BIOS_PROTOCOL  *LegacyBios;
+    UINT16                    *BootOrder = NULL;
+    UINTN                     Index = 0;
+    UINT16                    BootOption[10];
+    UINTN                     BootOrderSize = 0;
+    CHAR16            Buffer[20];
+    BDS_COMMON_OPTION *BdsOption;
+    LIST_ENTRY        TempList;
+    BBS_BBS_DEVICE_PATH * BbsDevicePath = NULL;
+//    REFIT_VOLUME          Volume;
+
+    InitializeListHead (&TempList);
+    ZeroMem (Buffer, sizeof (Buffer));
+
+    // If LegacyBios protocol is not implemented on this platform, then
+    //we do not support this type of legacy boot on this machine.
+    Status = gBS->LocateProtocol(&gEfiLegacyBootProtocolGuid, NULL, (VOID **) &LegacyBios);
+    if (EFI_ERROR (Status))
+        return;
+
+    // Grab the boot order
+    BootOrder = BdsLibGetVariableAndSize(L"BootOrder", &gEfiGlobalVariableGuid, &BootOrderSize);
+    if (BootOrder == NULL) {
+        BootOrderSize = 0;
+    }
+
+    Index = 0;
+    while (Index < BootOrderSize / sizeof (UINT16))
+    {
+        // Grab each boot option variable from the boot order, and convert
+        // the variable into a BDS boot option
+        UnicodeSPrint (BootOption, sizeof (BootOption), L"Boot%04x", BootOrder[Index]);
+        BdsOption = BdsLibVariableToOption (&TempList, BootOption);
+
+        if (BdsOption != NULL) {
+           //Print(L"Option description = '%s'\n", BdsOption->Description);
+           BbsDevicePath = (BBS_BBS_DEVICE_PATH *)BdsOption->DevicePath;
+
+           // Only add the entry if it is of a supported type (e.g. USB, HD)
+           // See BdsHelper.c for currently supported types
+           if (BbsDevicePath->DeviceType == DiskType) {
+              AddLegacyEntryUEFI(BdsOption, BbsDevicePath->DeviceType);
+           }
+        }
+        Index++;
+    }
+} /* static VOID ScanLegacyUEFI() */
+#else
+static VOID ScanLegacyUEFI(IN UINTN DiskType){}
+#endif // __MAKEWITH_TIANO
+
 static VOID ScanLegacyVolume(REFIT_VOLUME *Volume, UINTN VolumeIndex) {
    UINTN VolumeIndex2;
    BOOLEAN ShowVolume, HideIfOthersFound;
@@ -1249,11 +1395,15 @@ static VOID ScanLegacyDisc(VOID)
    UINTN                   VolumeIndex;
    REFIT_VOLUME            *Volume;
 
-   for (VolumeIndex = 0; VolumeIndex < VolumesCount; VolumeIndex++) {
-      Volume = Volumes[VolumeIndex];
-      if (Volume->DiskKind == DISK_KIND_OPTICAL)
-         ScanLegacyVolume(Volume, VolumeIndex);
-   } // for
+   if (GlobalConfig.LegacyType == LEGACY_TYPE_MAC) {
+      for (VolumeIndex = 0; VolumeIndex < VolumesCount; VolumeIndex++) {
+         Volume = Volumes[VolumeIndex];
+         if (Volume->DiskKind == DISK_KIND_OPTICAL)
+            ScanLegacyVolume(Volume, VolumeIndex);
+      } // for
+   } else if (GlobalConfig.LegacyType == LEGACY_TYPE_UEFI) {
+      ScanLegacyUEFI(BBS_CDROM);
+   }
 } /* static VOID ScanLegacyDisc() */
 
 // Scan internal hard disks for legacy (BIOS) boot code
@@ -1263,11 +1413,15 @@ static VOID ScanLegacyInternal(VOID)
     UINTN                   VolumeIndex;
     REFIT_VOLUME            *Volume;
 
-    for (VolumeIndex = 0; VolumeIndex < VolumesCount; VolumeIndex++) {
-        Volume = Volumes[VolumeIndex];
-        if (Volume->DiskKind == DISK_KIND_INTERNAL)
-            ScanLegacyVolume(Volume, VolumeIndex);
-    } // for
+    if (GlobalConfig.LegacyType == LEGACY_TYPE_MAC) {
+       for (VolumeIndex = 0; VolumeIndex < VolumesCount; VolumeIndex++) {
+           Volume = Volumes[VolumeIndex];
+           if (Volume->DiskKind == DISK_KIND_INTERNAL)
+               ScanLegacyVolume(Volume, VolumeIndex);
+       } // for
+    } else if (GlobalConfig.LegacyType == LEGACY_TYPE_UEFI) {
+       ScanLegacyUEFI(BBS_HARDDISK);
+    }
 } /* static VOID ScanLegacyInternal() */
 
 // Scan external disks for legacy (BIOS) boot code
@@ -1277,11 +1431,15 @@ static VOID ScanLegacyExternal(VOID)
    UINTN                   VolumeIndex;
    REFIT_VOLUME            *Volume;
 
-   for (VolumeIndex = 0; VolumeIndex < VolumesCount; VolumeIndex++) {
-      Volume = Volumes[VolumeIndex];
-      if (Volume->DiskKind == DISK_KIND_EXTERNAL)
-         ScanLegacyVolume(Volume, VolumeIndex);
-   } // for
+   if (GlobalConfig.LegacyType == LEGACY_TYPE_MAC) {
+      for (VolumeIndex = 0; VolumeIndex < VolumesCount; VolumeIndex++) {
+         Volume = Volumes[VolumeIndex];
+         if (Volume->DiskKind == DISK_KIND_EXTERNAL)
+            ScanLegacyVolume(Volume, VolumeIndex);
+      } // for
+   } else if (GlobalConfig.LegacyType == LEGACY_TYPE_UEFI) {
+      ScanLegacyUEFI(BBS_USB);
+   }
 } /* static VOID ScanLegacyExternal() */
 
 //
@@ -1460,8 +1618,35 @@ static VOID LoadDrivers(VOID)
        ConnectAllDriversToAllControllers();
 } /* static VOID LoadDrivers() */
 
+// Determine what (if any) type of legacy (BIOS) boot support is available
+static VOID FindLegacyBootType(VOID) {
+#ifdef __MAKEWITH_TIANO
+   EFI_STATUS                Status;
+   EFI_LEGACY_BIOS_PROTOCOL  *LegacyBios;
+#endif
+
+   GlobalConfig.LegacyType = LEGACY_TYPE_NONE;
+
+   // UEFI-style legacy BIOS support is available only with the TianoCore EDK2
+   // build environment, and then only with some implementations....
+#ifdef __MAKEWITH_TIANO
+   Status = gBS->LocateProtocol (&gEfiLegacyBootProtocolGuid, NULL, (VOID **) &LegacyBios);
+   if (!EFI_ERROR (Status))
+      GlobalConfig.LegacyType = LEGACY_TYPE_UEFI;
+#endif
+
+   // Macs have their own system. If the firmware vendor code contains the
+   // string "Apple", assume it's available. Note that this overrides the
+   // UEFI type, and might yield false positives if the vendor string
+   // contains "Apple" as part of something bigger, so this isn't 100%
+   // perfect.
+   if (StriSubCmp(L"Apple", ST->FirmwareVendor))
+      GlobalConfig.LegacyType = LEGACY_TYPE_MAC;
+} // static VOID FindLegacyBootType
+
+// Locates boot loaders. NOTE: This assumes that GlobalConfig.LegacyType is set correctly.
 static VOID ScanForBootloaders(VOID) {
-   UINTN i;
+   UINTN                     i;
 
    ScanVolumes();
 
@@ -1578,6 +1763,7 @@ static VOID InitializeLib(IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *System
    //    gImageHandle   = ImageHandle;
    gBS            = SystemTable->BootServices;
    //    gRS            = SystemTable->RuntimeServices;
+   gRT = SystemTable->RuntimeServices; // Some BDS functions need gRT to be set
    EfiGetSystemConfigurationTable (&gEfiDxeServicesTableGuid, (VOID **) &gDS);
 
    InitializeConsoleSim();
@@ -1595,8 +1781,9 @@ efi_main (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
     EFI_STATUS         Status;
     BOOLEAN            MainLoopRunning = TRUE;
     REFIT_MENU_ENTRY   *ChosenEntry;
-    UINTN              MenuExit;
+    UINTN              MenuExit, i;
     CHAR16             *Selection;
+    EG_PIXEL           BGColor;
 
     // bootstrap
     InitializeLib(ImageHandle, SystemTable);
@@ -1606,7 +1793,7 @@ efi_main (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
         return Status;
 
     // read configuration
-    CopyMem(GlobalConfig.ScanFor, "ieo       ", NUM_SCAN_OPTIONS);
+    CopyMem(GlobalConfig.ScanFor, "ieom      ", NUM_SCAN_OPTIONS);
     ReadConfig();
     MainMenu.TimeoutSeconds = GlobalConfig.Timeout;
 
@@ -1614,7 +1801,17 @@ efi_main (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
     refit_call4_wrapper(BS->SetWatchdogTimer, 0x0000, 0x0000, 0x0000, NULL);
 
     // further bootstrap (now with config available)
+    FindLegacyBootType();
     SetupScreen();
+    if (GlobalConfig.ScanDelay > 0) {
+       BGColor.b = 255;
+       BGColor.g = 175;
+       BGColor.r = 100;
+       BGColor.a = 0;
+       egDisplayMessage(L"Pausing before disk scan; please wait....", &BGColor);
+       for (i = 0; i < GlobalConfig.ScanDelay; i++)
+          refit_call1_wrapper(BS->Stall, 1000000);
+    } // if
     LoadDrivers();
     ScanForBootloaders();
     ScanForTools();
@@ -1655,6 +1852,12 @@ efi_main (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
                 StartLegacy((LEGACY_ENTRY *)ChosenEntry);
                 break;
 
+#ifdef __MAKEWITH_TIANO
+            case TAG_LEGACY_NON_MAC: // Boot a legacy OS on a non-Mac
+                StartLegacyUEFI((LEGACY_ENTRY *)ChosenEntry);
+                break;
+#endif // __MAKEWITH_TIANO
+
             case TAG_TOOL:     // Start a EFI tool
                 StartTool((LOADER_ENTRY *)ChosenEntry);
                 break;