OcMiscLib: Workaround firmware not specifying image handle at bootstrap

references acidanthera/bugtracker#1502
ozzychow · Feb 18, 2021 · b4449f4 · b4449f4
1 parent 583e563
commit b4449f4
Show file tree

Hide file tree

Showing 4 changed files with 59 additions and 2 deletions.
diff --git a/Application/OpenCore/OpenCore.c b/Application/OpenCore/OpenCore.c
@@ -306,6 +306,13 @@ UefiMain (
     return EFI_NOT_FOUND;
   }
 
+  if (LoadedImage->DeviceHandle == NULL) {
+    DEBUG ((DEBUG_INFO, "OC: Missing boot device\n"));
+    //
+    // This is not critical as boot path may be complete.
+    //
+  }
+
   if (LoadedImage->FilePath == NULL) {
     DEBUG ((DEBUG_ERROR, "OC: Missing boot path\n"));
     return EFI_INVALID_PARAMETER;

diff --git a/Changelog.md b/Changelog.md
@@ -6,6 +6,8 @@ OpenCore Changelog
 - Improved CPU frequency calculation on Haswell and earlier
 - Fixed issues when applying certain patches
 - Added `SSN` (and `HW_SSN`) variable support
+- Added onscreen early logging in DEBUG builds for legacy firmware
+- Added workaround for firmware not specifying DeviceHandle at bootstrap
 
 #### v0.6.6
 - Added keyboard and pointer entry scroll support in OpenCanopy

diff --git a/Library/OcMiscLib/ImageRunner.c b/Library/OcMiscLib/ImageRunner.c
@@ -14,7 +14,11 @@
 
 #include <Uefi.h>
 #include <Library/DebugLib.h>
+#include <Library/DevicePathLib.h>
+#include <Library/MemoryAllocationLib.h>
 #include <Library/UefiBootServicesTableLib.h>
+#include <Protocol/LoadedImage.h>
+#include <Protocol/SimpleFileSystem.h>
 
 EFI_STATUS
 OcLoadAndRunImage (
@@ -24,8 +28,9 @@ OcLoadAndRunImage (
   OUT  EFI_HANDLE                *ImageHandle OPTIONAL
   )
 {
-  EFI_STATUS  Status;
-  EFI_HANDLE  NewHandle;
+  EFI_STATUS                 Status;
+  EFI_HANDLE                 NewHandle;
+  EFI_LOADED_IMAGE_PROTOCOL  *LoadedImage;
 
   //
   // Run OpenCore image
@@ -46,6 +51,48 @@ OcLoadAndRunImage (
 
   DEBUG ((DEBUG_INFO, "OCM: Loaded image at %p handle\n", NewHandle));
 
+  Status = gBS->HandleProtocol (
+    NewHandle,
+    &gEfiLoadedImageProtocolGuid,
+    (VOID **) &LoadedImage
+    );
+  if (!EFI_ERROR (Status)) {
+    DEBUG ((
+      DEBUG_INFO,
+      "OCM: Loaded image has DeviceHandle %p FilePath %p ours DevicePath %p\n",
+      LoadedImage->DeviceHandle,
+      LoadedImage->FilePath,
+      DevicePath
+      ));
+
+    //
+    // Some fragile firmware fail to properly set LoadedImage when buffer is provided.
+    // REF: https://github.com/acidanthera/bugtracker/issues/712
+    // REF: https://github.com/acidanthera/bugtracker/issues/1502
+    //
+    if (DevicePath != NULL && LoadedImage->DeviceHandle == NULL) {
+      Status = gBS->LocateDevicePath (
+        &gEfiSimpleFileSystemProtocolGuid,
+        &DevicePath,
+        &LoadedImage->DeviceHandle
+        );
+
+      DEBUG ((
+        DEBUG_INFO,
+        "OCM: LocateDevicePath on loaded handle %p - %r\n",
+        LoadedImage->DeviceHandle,
+        Status
+        ));
+
+      if (!EFI_ERROR (Status)) {
+        if (LoadedImage->FilePath != NULL) {
+          FreePool (LoadedImage->FilePath);
+        }
+        LoadedImage->FilePath = DuplicateDevicePath (DevicePath);
+      }
+    }
+  }
+
   Status = gBS->StartImage (
     NewHandle,
     NULL,

diff --git a/Library/OcMiscLib/OcMiscLib.inf b/Library/OcMiscLib/OcMiscLib.inf
@@ -35,6 +35,7 @@
   gEfiPciIoProtocolGuid
   gEfiShellParametersProtocolGuid
   gEfiLoadedImageProtocolGuid
+  gEfiSimpleFileSystemProtocolGuid
 
 [LibraryClasses]
   BaseLib