FdtPlatform: Expand search for overrides

- Scan all supported file systems (FAT, ext4) on the selected boot
device, rather than just the one containing the OS loader.

- Also look for base DTB overrides in `\dtb` and `\dtb\rockchip`. Fedora
images conveniently have a symlink to the current kernel DTBs in the
latter path, on the second ext4 boot partition.

- Add config options to allow specifying custom relative paths for the
base DTB override and overlays.

Signed-off-by: Mario Bălănică <mariobalanica02@gmail.com>

Author: mariobalanica

edk2-rockchip/Silicon/Rockchip/RK3588/Drivers/FdtPlatformDxe/FdtPlatformDxe.c

@@ -29,6 +29,7 @@
 [LibraryClasses]
   BaseLib
   DebugLib
+  DevicePathLib
   PrintLib
   DxeServicesLib
   MemoryAllocationLib
@@ -54,6 +55,8 @@
   gRK3588TokenSpaceGuid.PcdFdtForceGop
   gRK3588TokenSpaceGuid.PcdFdtSupportOverrides
   gRK3588TokenSpaceGuid.PcdFdtOverrideFixup
+  gRK3588TokenSpaceGuid.PcdFdtOverrideBasePath
+  gRK3588TokenSpaceGuid.PcdFdtOverrideOverlayPath
   gRK3588TokenSpaceGuid.PcdComboPhy0Mode
   gRK3588TokenSpaceGuid.PcdComboPhy1Mode
   gRK3588TokenSpaceGuid.PcdComboPhy2Mode

edk2-rockchip/Silicon/Rockchip/RK3588/Drivers/FdtPlatformDxe/FdtPlatformDxe.inf

@@ -7,6 +7,7 @@
  *
  **/
 
+#include <Library/BaseMemoryLib.h>
 #include <Library/DebugLib.h>
 #include <Library/RockchipPlatformLib.h>
 #include <Library/UefiRuntimeServicesTableLib.h>
@@ -49,12 +50,13 @@ SetupConfigTableVariables (
   VOID
   )
 {
-  UINTN       Size;
-  UINT32      Var32;
-  UINT8       Var8;
-  EFI_STATUS  Status;
-  UINTN       Index;
-  UINT32      FirstFdtCompatModeSupported;
+  UINTN                            Size;
+  UINT32                           Var32;
+  UINT8                            Var8;
+  EFI_STATUS                       Status;
+  UINTN                            Index;
+  UINT32                           FirstFdtCompatModeSupported;
+  FDT_OVERRIDE_PATH_VARSTORE_DATA  FdtOverridePath;
 
   Size   = sizeof (UINT32);
   Status = gRT->GetVariable (
@@ -160,4 +162,44 @@ SetupConfigTableVariables (
     Status = PcdSet8S (PcdFdtOverrideFixup, FixedPcdGet8 (PcdFdtOverrideFixupDefault));
     ASSERT_EFI_ERROR (Status);
   }
+
+  Size   = sizeof (FDT_OVERRIDE_PATH_VARSTORE_DATA);
+  Status = gRT->GetVariable (
+                  L"FdtOverrideBasePath",
+                  &gRK3588DxeFormSetGuid,
+                  NULL,
+                  &Size,
+                  &FdtOverridePath
+                  );
+  if (EFI_ERROR (Status) || (FdtOverridePath.Path[0] == L' ')) {
+    if (FixedPcdGetSize (PcdFdtOverrideBasePathDefault) <= Size) {
+      Status = PcdSetPtrS (PcdFdtOverrideBasePath, &Size, FixedPcdGetPtr (PcdFdtOverrideBasePathDefault));
+    } else {
+      ASSERT (FALSE);
+      ZeroMem (&FdtOverridePath, Size);
+      Status = PcdSetPtrS (PcdFdtOverrideBasePath, &Size, &FdtOverridePath);
+    }
+
+    ASSERT_EFI_ERROR (Status);
+  }
+
+  Size   = sizeof (FDT_OVERRIDE_PATH_VARSTORE_DATA);
+  Status = gRT->GetVariable (
+                  L"FdtOverrideOverlayPath",
+                  &gRK3588DxeFormSetGuid,
+                  NULL,
+                  &Size,
+                  &FdtOverridePath
+                  );
+  if (EFI_ERROR (Status) || (FdtOverridePath.Path[0] == L' ')) {
+    if (FixedPcdGetSize (PcdFdtOverrideOverlayPathDefault) <= Size) {
+      Status = PcdSetPtrS (PcdFdtOverrideOverlayPath, &Size, FixedPcdGetPtr (PcdFdtOverrideOverlayPathDefault));
+    } else {
+      ASSERT (FALSE);
+      ZeroMem (&FdtOverridePath, Size);
+      Status = PcdSetPtrS (PcdFdtOverrideOverlayPath, &Size, &FdtOverridePath);
+    }
+
+    ASSERT_EFI_ERROR (Status);
+  }
 }

edk2-rockchip/Silicon/Rockchip/RK3588/Drivers/RK3588Dxe/ConfigTable.c

@@ -110,6 +110,10 @@
   gRK3588TokenSpaceGuid.PcdFdtSupportOverrides
   gRK3588TokenSpaceGuid.PcdFdtOverrideFixupDefault
   gRK3588TokenSpaceGuid.PcdFdtOverrideFixup
+  gRK3588TokenSpaceGuid.PcdFdtOverrideBasePathDefault
+  gRK3588TokenSpaceGuid.PcdFdtOverrideBasePath
+  gRK3588TokenSpaceGuid.PcdFdtOverrideOverlayPathDefault
+  gRK3588TokenSpaceGuid.PcdFdtOverrideOverlayPath
 
   gRK3588TokenSpaceGuid.PcdHasOnBoardFanOutput
   gRK3588TokenSpaceGuid.PcdCoolingFanState

edk2-rockchip/Silicon/Rockchip/RK3588/Drivers/RK3588Dxe/RK3588Dxe.inf

@@ -263,9 +263,38 @@
 #string STR_FDT_SUPPORT_OVERRIDES_PROMPT                   #language en-US "Support DTB override & overlays"
 #string STR_FDT_SUPPORT_OVERRIDES_HELP                     #language en-US "Enable or disable support for overriding the firmware-provided DTB and installing overlays.\n\nCheck firmware documentation for more details."
 
-#string STR_FDT_OVERRIDE_FIXUP_PROMPT                      #language en-US "Fix-up DTB override"
+#string STR_FDT_OVERRIDE_SUBTITLE                          #language en-US "DTB Override"
+
+#string STR_FDT_OVERRIDE_FIXUP_PROMPT                      #language en-US "Firmware Fix-ups"
 #string STR_FDT_OVERRIDE_FIXUP_HELP                        #language en-US "Enable or disable firmware fix-ups for the DTB override."
 
+#string STR_FDT_OVERRIDE_BASE_PATH_PROMPT                  #language en-US "Preferred Base DTB Path"
+#string STR_FDT_OVERRIDE_BASE_PATH_HELP                    #language en-US "Enter the preferred file or directory path for the base DTB override, relative to the file system root.\n\n"
+                                                                           "Once a boot device is selected, the firmware will scan all the supported file systems on it (FAT, ext4) and try to load the specified override.\n\n"
+                                                                           "- If a directory path is specified, the platform FDT file name will be appended to it (<PLATFORM-DT-NAME>).\n"
+                                                                           "- If a file path is specified, it will be used as is.\n"
+                                                                           "- If no override exists, the firmware-provided DTB will be used instead.\n\n"
+                                                                           "Examples:\n"
+                                                                           " \\dtbs\n"
+                                                                           " \\dtbs\\my-board.dtb\n\n"
+                                                                           "Default alternative paths:\n"
+                                                                           " \\dtb\n"
+                                                                           " \\dtb\\base\n"
+                                                                           " \\dtb\\rockchip\n\n"
+                                                                           "To reset this option to the default value, set it to a space character, save and reboot."
+
+#string STR_FDT_OVERRIDE_OVERLAY_PATH_PROMPT               #language en-US "Preferred Overlays Path"
+#string STR_FDT_OVERRIDE_OVERLAY_PATH_HELP                 #language en-US "Enter the preferred directory path for the DTB overlays, relative to the file system root.\n\n"
+                                                                           "Once a boot device is selected, the firmware will scan all the supported file systems on it (FAT, ext4) and try to load all overlays in the specified directory.\n\n"
+                                                                           "- If the installation of an overlay fails, all other overlays will be discarded.\n\n"
+                                                                           "Examples:\n"
+                                                                           " \\my-overlays\n"
+                                                                           " \\dtbs\\overlays\n\n"
+                                                                           "Default alternative paths:\n"
+                                                                           " \\dtb\\overlays\n"
+                                                                           " \\dtb\\overlays\\<PLATFORM-DT-NAME>\n\n"
+                                                                           "To reset this option to the default value, set it to a space character, save and reboot."
+
 /*
  * Cooling fan configuration
  */

edk2-rockchip/Silicon/Rockchip/RK3588/Drivers/RK3588Dxe/RK3588DxeHii.uni

@@ -218,6 +218,16 @@ formset
       name  = FdtOverrideFixup,
       guid  = RK3588DXE_FORMSET_GUID;
 
+    efivarstore FDT_OVERRIDE_PATH_VARSTORE_DATA,
+      attribute = EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,
+      name  = FdtOverrideBasePath,
+      guid  = RK3588DXE_FORMSET_GUID;
+
+    efivarstore FDT_OVERRIDE_PATH_VARSTORE_DATA,
+      attribute = EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,
+      name  = FdtOverrideOverlayPath,
+      guid  = RK3588DXE_FORMSET_GUID;
+
     efivarstore COOLING_FAN_STATE_VARSTORE_DATA,
       attribute = EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,
       name  = CoolingFanState,
@@ -859,6 +869,9 @@ formset
           endoneof;
 
           suppressif ideqval FdtSupportOverrides.State == 0;
+            subtitle text = STRING_TOKEN(STR_NULL_STRING);
+            subtitle text = STRING_TOKEN(STR_FDT_OVERRIDE_SUBTITLE);
+
             oneof varid = FdtOverrideFixup,
               prompt      = STRING_TOKEN(STR_FDT_OVERRIDE_FIXUP_PROMPT),
               help        = STRING_TOKEN(STR_FDT_OVERRIDE_FIXUP_HELP),
@@ -867,6 +880,24 @@ formset
               option text = STRING_TOKEN(STR_DISABLED), value = FALSE, flags = 0;
               option text = STRING_TOKEN(STR_ENABLED), value = TRUE, flags = 0;
             endoneof;
+
+            subtitle text = STRING_TOKEN(STR_NULL_STRING);
+
+            string varid = FdtOverrideBasePath.Path,
+              prompt  = STRING_TOKEN(STR_FDT_OVERRIDE_BASE_PATH_PROMPT),
+              help    = STRING_TOKEN(STR_FDT_OVERRIDE_BASE_PATH_HELP),
+              flags   = INTERACTIVE | RESET_REQUIRED,
+              minsize = 0,
+              maxsize = FDT_OVERRIDE_PATH_MAX_LEN,
+            endstring;
+
+            string varid = FdtOverrideOverlayPath.Path,
+              prompt  = STRING_TOKEN(STR_FDT_OVERRIDE_OVERLAY_PATH_PROMPT),
+              help    = STRING_TOKEN(STR_FDT_OVERRIDE_OVERLAY_PATH_HELP),
+              flags   = INTERACTIVE | RESET_REQUIRED,
+              minsize = 0,
+              maxsize = FDT_OVERRIDE_PATH_MAX_LEN,
+            endstring;
           endif;
         endif;
     endform;

edk2-rockchip/Silicon/Rockchip/RK3588/Drivers/RK3588Dxe/RK3588DxeHii.vfr

@@ -89,6 +89,12 @@ typedef struct {
   UINT8    State;
 } FDT_SUPPORT_OVERRIDES_VARSTORE_DATA;
 
+#define FDT_OVERRIDE_PATH_MAX_LEN   254
+#define FDT_OVERRIDE_PATH_MAX_SIZE  255
+typedef struct {
+  CHAR16    Path[FDT_OVERRIDE_PATH_MAX_SIZE];
+} FDT_OVERRIDE_PATH_VARSTORE_DATA;
+
 #define COOLING_FAN_STATE_DISABLED  0
 #define COOLING_FAN_STATE_ENABLED   1
 typedef struct {

edk2-rockchip/Silicon/Rockchip/RK3588/Include/VarStoreData.h

@@ -52,6 +52,8 @@
   gRK3588TokenSpaceGuid.PcdFdtForceGopDefault|0|UINT8|0x00010352
   gRK3588TokenSpaceGuid.PcdFdtSupportOverridesDefault|0|UINT8|0x00010353
   gRK3588TokenSpaceGuid.PcdFdtOverrideFixupDefault|0|UINT8|0x00010354
+  gRK3588TokenSpaceGuid.PcdFdtOverrideBasePathDefault|L""|VOID*|0x00010355
+  gRK3588TokenSpaceGuid.PcdFdtOverrideOverlayPathDefault|L""|VOID*|0x00010356
 
   gRK3588TokenSpaceGuid.PcdHasOnBoardFanOutput|FALSE|BOOLEAN|0x10401
 
@@ -122,6 +124,18 @@
   gRK3588TokenSpaceGuid.PcdFdtForceGop|0|UINT8|0x00000352
   gRK3588TokenSpaceGuid.PcdFdtSupportOverrides|0|UINT8|0x00000353
   gRK3588TokenSpaceGuid.PcdFdtOverrideFixup|0|UINT8|0x00000354
+  gRK3588TokenSpaceGuid.PcdFdtOverrideBasePath|{ 0x0 }|FDT_OVERRIDE_PATH_VARSTORE_DATA|0x00000355 {
+    <Packages>
+      Silicon/Rockchip/RK3588/RK3588.dec
+    <HeaderFiles>
+      VarStoreData.h
+  }
+  gRK3588TokenSpaceGuid.PcdFdtOverrideOverlayPath|{ 0x0 }|FDT_OVERRIDE_PATH_VARSTORE_DATA|0x00000356 {
+    <Packages>
+      Silicon/Rockchip/RK3588/RK3588.dec
+    <HeaderFiles>
+      VarStoreData.h
+  }
 
   gRK3588TokenSpaceGuid.PcdCoolingFanState|0|UINT32|0x00000401
   gRK3588TokenSpaceGuid.PcdCoolingFanSpeed|0|UINT32|0x00000402

edk2-rockchip/Silicon/Rockchip/RK3588/RK3588.dec

@@ -287,6 +287,8 @@
   gRK3588TokenSpaceGuid.PcdFdtForceGopDefault|FALSE
   gRK3588TokenSpaceGuid.PcdFdtSupportOverridesDefault|FALSE
   gRK3588TokenSpaceGuid.PcdFdtOverrideFixupDefault|TRUE
+  gRK3588TokenSpaceGuid.PcdFdtOverrideBasePathDefault|L""
+  gRK3588TokenSpaceGuid.PcdFdtOverrideOverlayPathDefault|L""
 
   #
   # Display support flags and default values
@@ -375,6 +377,8 @@
   gRK3588TokenSpaceGuid.PcdFdtForceGop|L"FdtForceGop"|gRK3588DxeFormSetGuid|0x0|gRK3588TokenSpaceGuid.PcdFdtForceGopDefault
   gRK3588TokenSpaceGuid.PcdFdtSupportOverrides|L"FdtSupportOverrides"|gRK3588DxeFormSetGuid|0x0|gRK3588TokenSpaceGuid.PcdFdtSupportOverridesDefault
   gRK3588TokenSpaceGuid.PcdFdtOverrideFixup|L"FdtOverrideFixup"|gRK3588DxeFormSetGuid|0x0|gRK3588TokenSpaceGuid.PcdFdtOverrideFixupDefault
+  gRK3588TokenSpaceGuid.PcdFdtOverrideBasePath|L"FdtOverrideBasePath"|gRK3588DxeFormSetGuid|0x0|{ 0x0 }
+  gRK3588TokenSpaceGuid.PcdFdtOverrideOverlayPath|L"FdtOverrideOverlayPath"|gRK3588DxeFormSetGuid|0x0|{ 0x0 }
 
   #
   # Cooling Fan