OcApfsLib: Add `GlobalConnect` mode for device handle connection

closes acidanthera/bugtracker#960

Changelog.md

@@ -16,6 +16,7 @@ OpenCore Changelog
 - Fixed slide choice on platforms when 0 slide is unavailable, thx @zhen-zen
 - Fixed assertions caused by unaligned file path access in DEBUG builds
 - Renamed `ConfigValidity` utility to `ocvalidate` for consistency
+- Added `GlobalConnect` for APFS loading to workaround older firmware issues
 
 #### v0.5.9
 - Added full HiDPI support in OpenCanopy

Docs/Configuration.tex

@@ -4635,6 +4635,18 @@ functioning. Feature highlights:
   \texttt{ScanPolicy}. See more details in ``EFI Jumpstart'' section of
   \href{https://developer.apple.com/support/apple-file-system/Apple-File-System-Reference.pdf}{Apple File System Reference}.
 
+
+\item
+  \texttt{GlobalConnect}\\
+  \textbf{Type}: \texttt{plist\ boolean}\\
+  \textbf{Failsafe}: \texttt{false}\\
+  \textbf{Description}: Perform full device connection during APFS loading.
+
+  Instead of partition handle connection normally used for APFS driver loading
+  every handle is connected recursively. This may take more time than usual
+  but can be the only way to access APFS partitions on some firmwares like
+  those found on older HP laptops.
+
 \item
   \texttt{HideVerbose}\\
   \textbf{Type}: \texttt{plist\ boolean}\\

Docs/Differences/Differences.tex

 \documentclass[]{article}
 %DIF LATEXDIFF DIFFERENCE FILE
 %DIF DEL PreviousConfiguration.tex   Tue Jun  2 03:55:18 2020
-%DIF ADD ../Configuration.tex        Sun Jun 21 16:58:05 2020
+%DIF ADD ../Configuration.tex        Mon Jun 22 00:02:42 2020
 
 \usepackage{lmodern}
 \usepackage{amssymb,amsmath}
@@ -4732,8 +4732,22 @@ functioning. Feature highlights:
   \texttt{ScanPolicy}. See more details in ``EFI Jumpstart'' section of
   \href{https://developer.apple.com/support/apple-file-system/Apple-File-System-Reference.pdf}{Apple File System Reference}.
 
+
+\item
+  \DIFaddbegin \texttt{\DIFadd{GlobalConnect}}\\
+  \textbf{\DIFadd{Type}}\DIFadd{: }\texttt{\DIFadd{plist\ boolean}}\\
+  \textbf{\DIFadd{Failsafe}}\DIFadd{: }\texttt{\DIFadd{false}}\\
+  \textbf{\DIFadd{Description}}\DIFadd{: Perform full device connection during APFS loading.
+}
+
+  \DIFadd{Instead of partition handle connection normally used for APFS driver loading
+  every handle is connected recursively. This may take more time than usual
+  but can be the only way to access APFS partitions on some firmwares like
+  those found on older HP laptops.
+}
+
 \item
-  \texttt{HideVerbose}\\
+  \DIFaddend \texttt{HideVerbose}\\
   \textbf{Type}: \texttt{plist\ boolean}\\
   \textbf{Failsafe}: \texttt{false}\\
   \textbf{Description}: Hide verbose output from APFS driver.

Docs/Sample.plist

@@ -848,6 +848,8 @@
 		<dict>
 			<key>EnableJumpstart</key>
 			<true/>
+			<key>GlobalConnect</key>
+			<false/>
 			<key>HideVerbose</key>
 			<true/>
 			<key>JumpstartHotPlug</key>

Docs/SampleFull.plist

@@ -951,6 +951,8 @@
 		<dict>
 			<key>EnableJumpstart</key>
 			<true/>
+			<key>GlobalConnect</key>
+			<false/>
 			<key>HideVerbose</key>
 			<true/>
 			<key>JumpstartHotPlug</key>

Include/Acidanthera/Library/OcApfsLib.h

@@ -57,6 +57,7 @@
   @param[in] MinVersion     Minimal allowed APFS driver version to load.
   @param[in] MinDate        Minimal allowed APFS driver date to load.
   @param[in] ScanPolicy     OpenCore scan policy.
+  @param[in] GlobalConnect  Perform global device connection for APFS.
   @param[in] IgnoreVerbose  Avoid APFS driver verbose output.
 **/
 VOID
@@ -64,6 +65,7 @@ OcApfsConfigure (
   IN UINT64   MinVersion,
   IN UINT32   MinDate,
   IN UINT32   ScanPolicy,
+  IN BOOLEAN  GlobalConnect,
   IN BOOLEAN  IgnoreVerbose
   );
 

Include/Acidanthera/Library/OcConfigurationLib.h

@@ -479,6 +479,7 @@ typedef enum {
   _(UINT64                      , MinVersion         ,     , 0                             , ()) \
   _(UINT32                      , MinDate            ,     , 0                             , ()) \
   _(BOOLEAN                     , EnableJumpstart    ,     , FALSE                         , ()) \
+  _(BOOLEAN                     , GlobalConnect       ,     , FALSE                         , ()) \
   _(BOOLEAN                     , HideVerbose        ,     , FALSE                         , ()) \
   _(BOOLEAN                     , JumpstartHotPlug   ,     , FALSE                         , ())
   OC_DECLARE (OC_UEFI_APFS)

Library/OcApfsLib/OcApfsConnect.c

@@ -20,6 +20,7 @@
 #include <Library/OcAppleImageVerificationLib.h>
 #include <Library/OcBootManagementLib.h>
 #include <Library/OcConsoleLib.h>
+#include <Library/OcDriverConnectionLib.h>
 #include <Library/OcGuardLib.h>
 #include <Library/UefiBootServicesTableLib.h>
 #include <Library/UefiRuntimeServicesTableLib.h>
@@ -34,6 +35,7 @@ STATIC UINT64            mApfsMinimalVersion = OC_APFS_VERSION_DEFAULT;
 STATIC UINT32            mApfsMinimalDate    = OC_APFS_DATE_DEFAULT;
 STATIC UINT32            mOcScanPolicy;
 STATIC BOOLEAN           mIgnoreVerbose;
+STATIC BOOLEAN           mGlobalConnect;
 STATIC EFI_SYSTEM_TABLE  *mNullSystemTable;
 
 //
@@ -327,12 +329,23 @@ ApfsStartDriver (
     return Status;
   }
 
-  //
-  // Recursively connect controller to get apfs.efi loaded.
-  // We cannot use apfs.efi handle as it apparently creates new handles.
-  // This follows ApfsJumpStart driver implementation.
-  //
-  gBS->ConnectController (PrivateData->LocationInfo.ControllerHandle, NULL, NULL, TRUE);
+  if (mGlobalConnect) {
+    //
+    // Connect all devices when implicitly requested. This is a workaround
+    // for some older HP laptops, which for some reason fail to connect by both
+    // drive and partition handles.
+    // REF: https://github.com/acidanthera/bugtracker/issues/960
+    //
+    OcConnectDrivers ();
+  } else {
+    //
+    // Recursively connect controller to get apfs.efi loaded.
+    // We cannot use apfs.efi handle as it apparently creates new handles.
+    // This follows ApfsJumpStart driver implementation.
+    //
+    gBS->ConnectController (PrivateData->LocationInfo.ControllerHandle, NULL, NULL, TRUE);
+  }
+
   return EFI_SUCCESS;
 }
 
@@ -391,6 +404,7 @@ OcApfsConfigure (
   IN UINT64   MinVersion,
   IN UINT32   MinDate,
   IN UINT32   ScanPolicy,
+  IN BOOLEAN  GlobalConnect,
   IN BOOLEAN  IgnoreVerbose
   )
 {
@@ -413,8 +427,9 @@ OcApfsConfigure (
     mApfsMinimalDate = MinDate;
   }
 
-  mOcScanPolicy       = ScanPolicy;
-  mIgnoreVerbose      = IgnoreVerbose;
+  mOcScanPolicy  = ScanPolicy;
+  mIgnoreVerbose = IgnoreVerbose;
+  mGlobalConnect = GlobalConnect;
 }
 
 EFI_STATUS

Library/OcApfsLib/OcApfsLib.inf

@@ -57,6 +57,7 @@
   DebugLib
   OcAppleImageVerificationLib
   OcConsoleLib
+  OcDriverConnectionLib
   OcGuardLib
   OcMiscLib
   MemoryAllocationLib

Library/OcConfigurationLib/OcConfigurationLib.c

@@ -566,6 +566,7 @@ STATIC
 OC_SCHEMA
 mUefiApfsSchema[] = {
   OC_SCHEMA_BOOLEAN_IN ("EnableJumpstart",      OC_GLOBAL_CONFIG, Uefi.Apfs.EnableJumpstart),
+  OC_SCHEMA_BOOLEAN_IN ("GlobalConnect",        OC_GLOBAL_CONFIG, Uefi.Apfs.GlobalConnect),
   OC_SCHEMA_BOOLEAN_IN ("HideVerbose",          OC_GLOBAL_CONFIG, Uefi.Apfs.HideVerbose),
   OC_SCHEMA_BOOLEAN_IN ("JumpstartHotPlug",     OC_GLOBAL_CONFIG, Uefi.Apfs.JumpstartHotPlug),
   OC_SCHEMA_INTEGER_IN ("MinDate",              OC_GLOBAL_CONFIG, Uefi.Apfs.MinDate),

Platform/OpenCore/OpenCoreUefi.c

@@ -538,6 +538,7 @@ OcLoadUefiSupport (
       Config->Uefi.Apfs.MinVersion,
       Config->Uefi.Apfs.MinDate,
       Config->Misc.Security.ScanPolicy,
+      Config->Uefi.Apfs.GlobalConnect,
       Config->Uefi.Apfs.HideVerbose
       );