From ce05f4e44cb797f33248341ad028bcd0b8df3bc3 Mon Sep 17 00:00:00 2001
From: Daniel Barlow <dan@telent.net>
Date: Fri, 17 Mar 2023 12:22:20 +0000
Subject: [PATCH] extract phram.mtd ramdisk support from tftpboot module

also rename tftproot output to tftpboot for consistency
---
 devices/gl-ar750/default.nix     |  2 +-
 devices/gl-mt300a/default.nix    |  2 +-
 devices/gl-mt300n-v2/default.nix |  2 +-
 doc/developer.rst                |  2 +-
 modules/ramdisk.nix              | 34 ++++++++++++++++++++++++++++++++
 modules/tftpboot.nix             | 32 +++++++-----------------------
 6 files changed, 45 insertions(+), 29 deletions(-)
 create mode 100644 modules/ramdisk.nix

diff --git a/devices/gl-ar750/default.nix b/devices/gl-ar750/default.nix
index cde65a2..686ab38 100644
--- a/devices/gl-ar750/default.nix
+++ b/devices/gl-ar750/default.nix
@@ -87,7 +87,7 @@
       inherit (pkgs.liminix.networking) interface;
     in {
       hardware = {
-        defaultOutput = "tftproot";
+        defaultOutput = "tftpboot";
         loadAddress = "0x80060000";
         entryPoint  = "0x80060000";
         flash = {
diff --git a/devices/gl-mt300a/default.nix b/devices/gl-mt300a/default.nix
index 8f2a23e..50ba15c 100644
--- a/devices/gl-mt300a/default.nix
+++ b/devices/gl-mt300a/default.nix
@@ -34,7 +34,7 @@
       };
      in {
       hardware = {
-        defaultOutput = "tftproot";
+        defaultOutput = "tftpboot";
         loadAddress = "0x80000000";
         entryPoint  = "0x80000000";
 
diff --git a/devices/gl-mt300n-v2/default.nix b/devices/gl-mt300n-v2/default.nix
index 82a9fe3..48f2c36 100644
--- a/devices/gl-mt300n-v2/default.nix
+++ b/devices/gl-mt300n-v2/default.nix
@@ -41,7 +41,7 @@
         };
       };
       hardware = {
-        defaultOutput = "tftproot";
+        defaultOutput = "tftpboot";
         loadAddress = "0x80000000";
         entryPoint  = "0x80000000";
 
diff --git a/doc/developer.rst b/doc/developer.rst
index 9cf8413..bc18e2f 100644
--- a/doc/developer.rst
+++ b/doc/developer.rst
@@ -121,7 +121,7 @@ image instead of flashing. In your device configuration add
     ipaddr = "192.168.200.251";
   };
 
-and then build ``outputs.tftproot``. This creates a file in
+and then build ``outputs.tftpboot``. This creates a file in
 ``result/`` called ``boot.scr``, which you can copy and paste into
 U-Boot to transfer the kernel and filesystem over TFTP and boot the
 kernel from RAM.
diff --git a/modules/ramdisk.nix b/modules/ramdisk.nix
new file mode 100644
index 0000000..c2052b6
--- /dev/null
+++ b/modules/ramdisk.nix
@@ -0,0 +1,34 @@
+{
+  config
+, pkgs
+, lib
+, ...
+}:
+let
+  inherit (lib) mkIf mkEnableOption mkOption; # types concatStringsSep;
+in {
+  options = {
+    boot = {
+      ramdisk = {
+        enable = mkEnableOption (lib.mdDoc ''
+          Configure kernel to enable reserving part of memory as
+          an MTD-based RAM disk.  Needed for TFTP booting or for
+          kexec-based revertable upgrade
+        '');
+      };
+    };
+  };
+  config = mkIf config.boot.ramdisk.enable {
+    kernel = {
+      config = {
+        MTD = "y";
+        MTD_PHRAM = "y";
+        MTD_CMDLINE_PARTS = "y";
+        MTD_OF_PARTS = "y";
+        PARTITION_ADVANCED = "y";
+        MTD_BLKDEVS = "y";
+        MTD_BLOCK = "y";
+      };
+    };
+  };
+}
diff --git a/modules/tftpboot.nix b/modules/tftpboot.nix
index fda301f..cd11ecb 100644
--- a/modules/tftpboot.nix
+++ b/modules/tftpboot.nix
@@ -20,32 +20,14 @@ in {
       };
     };
   };
+  imports = [ ./ramdisk.nix ];
   config = {
-    kernel = {
-      config = {
-        MTD = "y";
-        MTD_PHRAM = "y";
-        MTD_CMDLINE_PARTS = "y";
-        MIPS_CMDLINE_FROM_BOOTLOADER = "y";
+    boot.ramdisk.enable = true;
+    kernel.config.MIPS_CMDLINE_FROM_BOOTLOADER = "y";
 
-        # one or more of the following is required to get from
-        # VFS: Cannot open root device "1f00" or unknown-block(31,0): error -6
-        # to
-        # VFS: Mounted root (squashfs filesystem) readonly on device 31:0.
-        MTD_OF_PARTS = "y";
-        PARTITION_ADVANCED = "y";
-        MSDOS_PARTITION = "y";
-        EFI_PARTITION = "y";
-        MTD_BLKDEVS = "y";
-        MTD_BLOCK = "y";
-
-        # CONFIG_MTD_MTDRAM=m         c'est quoi?
-      };
-
-    };
-    outputs.tftproot =
+    outputs.tftpboot =
       let o = config.outputs; in
-      pkgs.runCommand "tftproot" {} ''
+      pkgs.runCommand "tftpboot" {} ''
         mkdir $out
         cd $out
         ln -s ${o.squashfs} squashfs
@@ -60,12 +42,13 @@ in {
       let
         inherit (pkgs.lib.trivial) toHexString;
       in
-        pkgs.buildPackages.runCommand "" {} ''
+        pkgs.buildPackages.runCommand "boot-scr" {} ''
           uimageSize=$(($(stat -L -c %s ${config.outputs.uimage}) + 0x1000 &(~0xfff)))
           squashfsStart=0x$(printf %x $((${cfg.loadAddress} + 0x100000 + $uimageSize)))
           squashfsBytes=$(($(stat -L -c %s ${config.outputs.squashfs}) + 0x100000 &(~0xfffff)))
           squashfsMb=$(($squashfsBytes >> 20))
           cmd="mtdparts=phram0:''${squashfsMb}M(nix) phram.phram=phram0,''${squashfsStart},''${squashfsMb}Mi memmap=''${squashfsMb}M\$''${squashfsStart} root=1f00";
+
           cat > $out << EOF
           setenv serverip ${cfg.serverip}
           setenv ipaddr ${cfg.ipaddr}
@@ -74,6 +57,5 @@ in {
           bootm 0x$(printf %x ${cfg.loadAddress})
           EOF
         '';
-
   };
 }