Upgrade fwup-revert.conf to more capable fwup-ops.conf

fwup-revert.conf → fwup-ops.conf

@@ -1,17 +1,25 @@
-# Revert firmware for the Raspberry Pi 4
+# # Post-installation firmware operations for the Raspberry Pi 4
+#
+# Tasks include:
+#
+# * `factory-reset` - Clear out the writable filesystem and any other writable
+#                   areas so that they can be re-initialized on the next boot.
+# * `prevent-revert` - Prevent `revert` from working until the next firmware
+# * `revert` - Revert to the previous firmware if it's still available
+# * `validate` - Mark this firmware as a good update.
+# * `status` - Print out which partition is active (`a` or `b`)
 #
 # To use:
-#   1. Run `fwup -c -f fwup-revert.conf -o revert.fw` and copy revert.fw to
-#      the device. This is done automatically as part of the Nerves system
-#      build process. The file is stored in `/usr/share/fwup/revert.fw`.
-#   2. On the device, run `fwup -t revert revert.fw -d $NERVES_FW_DEVPATH`. If
-#      it succeeds, reboot. If not, then it's possible that there isn't a previous
-#      firmware or the metadata about what's stored where is corrupt or out of
-#      sync.
+#
+# 1. Run `fwup -c -f fwup-ops.conf -o ops.fw` and copy ops.fw to
+#    the device. This is done automatically as part of the Nerves system
+#    build process. The file is stored in `/usr/share/fwup/ops.fw`.
+# 2. On the device, run `fwup -t <task> -d /dev/rootdisk0 --enable-trim /usr/share/fwup/ops.fw`.
+# 3. Reboot after running `revert` or `factory-reset`.
 #
 # It is critical that this is kept in sync with the main fwup.conf.
 
-require-fwup-version="0.19.0"
+require-fwup-version="1.0.0"
 
 #
 # Firmware metadata
@@ -30,16 +38,8 @@ define(NERVES_FW_PLATFORM, "rpi4")
 define(NERVES_FW_ARCHITECTURE, "arm")
 define(NERVES_FW_AUTHOR, "The Nerves Team")
 
-define(NERVES_FW_DEVPATH, "/dev/mmcblk0")
-define(NERVES_FW_APPLICATION_PART0_DEVPATH, "/dev/mmcblk0p3") # Linux part number is 1-based
-define(NERVES_FW_APPLICATION_PART0_FSTYPE, "f2fs")
-define(NERVES_FW_APPLICATION_PART0_TARGET, "/root")
-
-# Default paths if not specified via the commandline
-define(ROOTFS, "${NERVES_SYSTEM}/images/rootfs.squashfs")
-
-# This configuration file will create an image that has an MBR and the
-# following 3 partitions:
+# This configuration file will create an image that
+# has an MBR and the following layout:
 #
 # +----------------------------+
 # | MBR                        |
@@ -150,6 +150,65 @@ uboot-environment uboot-env {
     block-count = ${UBOOT_ENV_COUNT}
 }
 
+##
+# factory-reset
+##
+task factory-reset {
+    on-init {
+        info("Erasing all writable data")
+        # This requires --enable-trim
+        # Trim may not work on MicroSD card, so don't rely on it
+        trim(${APP_PART_OFFSET}, ${APP_PART_COUNT})
+        raw_memset(${APP_PART_OFFSET}, 256, 0xff)
+    }
+}
+
+##
+# prevent-revert
+#
+# Pass `--enable-trim` to also clear out the partition that no longer should be used.
+##
+task prevent-revert.a {
+    # Check that we're running on B
+    require-partition-offset(0, ${BOOT_B_PART_OFFSET})
+    require-partition-offset(1, ${ROOTFS_B_PART_OFFSET})
+    require-uboot-variable(uboot-env, "nerves_fw_active", "b")
+
+    on-init {
+        info("Preventing reverts to partition A")
+        # Remove U-Boot variables that fwup uses to allow reverting images
+        uboot_unsetenv(uboot-env, "a.nerves_fw_platform")
+        uboot_unsetenv(uboot-env, "a.nerves_fw_architecture")
+        # Clear out the old image using TRIM. This requires --enable-trim
+        trim(${ROOTFS_A_PART_OFFSET}, ${ROOTFS_A_PART_COUNT})
+        trim(${BOOT_A_PART_OFFSET}, ${BOOT_A_PART_COUNT})
+    }
+}
+task prevent-revert.b {
+    # Check that we're running on A
+    require-partition-offset(0, ${BOOT_A_PART_OFFSET})
+    require-partition-offset(1, ${ROOTFS_A_PART_OFFSET})
+    require-uboot-variable(uboot-env, "nerves_fw_active", "a")
+
+    on-init {
+        info("Preventing reverts to partition B")
+        # Remove U-Boot variables that fwup uses to allow reverting images
+        uboot_unsetenv(uboot-env, "b.nerves_fw_platform")
+        uboot_unsetenv(uboot-env, "b.nerves_fw_architecture")
+        # Clear out the image using TRIM. This requires --enable-trim
+        trim(${ROOTFS_B_PART_OFFSET}, ${ROOTFS_B_PART_COUNT})
+        trim(${BOOT_B_PART_OFFSET}, ${BOOT_B_PART_COUNT})
+    }
+}
+task prevent-revert.fail {
+    on-init {
+        error("Error detecting active partition")
+    }
+}
+
+##
+# revert
+##
 task revert.a {
     # This task reverts to the A partition, so check that we're running on B
     require-partition-offset(0, ${BOOT_B_PART_OFFSET})
@@ -211,7 +270,11 @@ task revert.wrongplatform {
     }
 }
 
-# Run "fwup /usr/share/fwup/revert.fw -t status -d /dev/mmcblk0 -q -U" to check the status.
+##
+# status
+#
+# Run "fwup /usr/share/fwup/ops.fw -t status -d /dev/rootdisk0 -q -U" to check the status.
+##
 task status.aa {
     require-path-at-offset("/", ${ROOTFS_A_PART_OFFSET})
     require-uboot-variable(uboot-env, "nerves_fw_active", "a")
@@ -235,3 +298,15 @@ task status.ba {
 task status.fail {
     on-init { error("fail") }
 }
+
+##
+# validate
+#
+# The fwup configuration for this device always validates, so this doesn't do anything.
+##
+task validate {
+    on-init {
+        info("Validate")
+        uboot_setenv(uboot-env, "nerves_fw_validated", "1")
+    }
+}

mix.exs

@@ -104,7 +104,7 @@ defmodule NervesSystemRpi4.MixProject do
       "CHANGELOG.md",
       "cmdline.txt",
       "config.txt",
-      "fwup-revert.conf",
+      "fwup-ops.conf",
       "fwup.conf",
       "LICENSE",
       "linux-6.1.defconfig",

post-build.sh

@@ -19,10 +19,12 @@ function slim_down_dri_libs() {
 
 slim_down_dri_libs
 
-# Create the revert script for manually switching back to the previously
-# active firmware.
+# Create the fwup ops script to handling MicroSD/eMMC operations at runtime
+# NOTE: revert.fw is the previous, more limited version of this. ops.fw is
+#       backwards compatible.
 mkdir -p $TARGET_DIR/usr/share/fwup
-$HOST_DIR/usr/bin/fwup -c -f $NERVES_DEFCONFIG_DIR/fwup-revert.conf -o $TARGET_DIR/usr/share/fwup/revert.fw
+$HOST_DIR/usr/bin/fwup -c -f $NERVES_DEFCONFIG_DIR/fwup-ops.conf -o $TARGET_DIR/usr/share/fwup/ops.fw
+ln -sf ops.fw $TARGET_DIR/usr/share/fwup/revert.fw
 
 # Copy the fwup includes to the images dir
 cp -rf $NERVES_DEFCONFIG_DIR/fwup_include $BINARIES_DIR