Reduce fwup redundancy by using an EEx template

The final fwup.conf file is still being committed to allow time to grow
trust in using a template language to generate the fwup.conf.

This refactor is really needed for TRYBOOT support due to significantly
more fwup.conf redundancy to migrate pre-TRYBOOT devices.

Author: fhunleth

REUSE.toml

@@ -54,6 +54,7 @@ SPDX-License-Identifier = "GPL-2.0-only"
 path = [
  "fwup-ops.conf",
  "fwup.conf",
+ "fwup.conf.eex",
  "fwup_include/*"
 ]
 precedence = "aggregate"

fwup.conf

@@ -1,5 +1,8 @@
 # Firmware configuration file for the Raspberry Pi 4
-
+#
+# IMPORTANT:
+# Edit `fwup.conf.eex` and run `mix generate_fwup_conf` to generate fwup.conf.
+#
 require-fwup-version="0.15.0"  # For the trim() call
 
 include("${NERVES_SDK_IMAGES:-.}/fwup_include/fwup-common.conf")
@@ -12,9 +15,7 @@ file-resource start4.elf { host-path = "${NERVES_SYSTEM}/images/rpi-firmware/sta
 file-resource config.txt { host-path = "${NERVES_SYSTEM}/images/config.txt" }
 file-resource cmdline.txt { host-path = "${NERVES_SYSTEM}/images/cmdline.txt" }
 file-resource kernel8.img { host-path = "${NERVES_SYSTEM}/images/Image" }
-file-resource bcm2711-rpi-4-b.dtb { host-path = "${NERVES_SYSTEM}/images/bcm2711-rpi-4-b.dtb" }
-file-resource bcm2711-rpi-cm4.dtb { host-path = "${NERVES_SYSTEM}/images/bcm2711-rpi-cm4.dtb" }
-file-resource bcm2711-rpi-400.dtb { host-path = "${NERVES_SYSTEM}/images/bcm2711-rpi-400.dtb" }
+file-resource bcm2708-rpi-b.dtb { host-path = "${NERVES_SYSTEM}/images/bcm2708-rpi-b.dtb" }
 file-resource overlays/dwc2.dtbo { host-path = "${NERVES_SYSTEM}/images/rpi-firmware/overlays/dwc2.dtbo" }
 file-resource overlays/i2c-mux.dtbo { host-path = "${NERVES_SYSTEM}/images/rpi-firmware/overlays/i2c-mux.dtbo" }
 file-resource overlays/imx219.dtbo { host-path = "${NERVES_SYSTEM}/images/rpi-firmware/overlays/imx219.dtbo" }
@@ -77,14 +78,12 @@ task complete {
         uboot_setenv(uboot-env, "a.nerves_fw_uuid", "\${FWUP_META_UUID}")
     }
 
+    on-resource fixup4.dat { fat_write(${BOOT_A_PART_OFFSET}, "fixup4.dat") }
+    on-resource start4.elf { fat_write(${BOOT_A_PART_OFFSET}, "start4.elf") }
     on-resource config.txt { fat_write(${BOOT_A_PART_OFFSET}, "config.txt") }
     on-resource cmdline.txt { fat_write(${BOOT_A_PART_OFFSET}, "cmdline.txt") }
-    on-resource start4.elf { fat_write(${BOOT_A_PART_OFFSET}, "start4.elf") }
-    on-resource fixup4.dat { fat_write(${BOOT_A_PART_OFFSET}, "fixup4.dat") }
     on-resource kernel8.img { fat_write(${BOOT_A_PART_OFFSET}, "kernel8.img") }
-    on-resource bcm2711-rpi-4-b.dtb { fat_write(${BOOT_A_PART_OFFSET}, "bcm2711-rpi-4-b.dtb") }
-    on-resource bcm2711-rpi-cm4.dtb { fat_write(${BOOT_A_PART_OFFSET}, "bcm2711-rpi-cm4.dtb") }
-    on-resource bcm2711-rpi-400.dtb { fat_write(${BOOT_A_PART_OFFSET}, "bcm2711-rpi-400.dtb") }
+    on-resource bcm2708-rpi-b.dtb { fat_write(${BOOT_A_PART_OFFSET}, "bcm2708-rpi-b.dtb") }
     on-resource overlays/dwc2.dtbo { fat_write(${BOOT_A_PART_OFFSET}, "overlays/dwc2.dtbo") }
     on-resource overlays/i2c-mux.dtbo { fat_write(${BOOT_A_PART_OFFSET}, "overlays/i2c-mux.dtbo") }
     on-resource overlays/imx219.dtbo { fat_write(${BOOT_A_PART_OFFSET}, "overlays/imx219.dtbo") }
@@ -159,14 +158,12 @@ task upgrade.a {
     # Write the new boot partition files and rootfs. The MBR still points
     # to the B partition, so an error or power failure during this part
     # won't hurt anything.
+    on-resource fixup4.dat { fat_write(${BOOT_A_PART_OFFSET}, "fixup4.dat") }
+    on-resource start4.elf { fat_write(${BOOT_A_PART_OFFSET}, "start4.elf") }
     on-resource config.txt { fat_write(${BOOT_A_PART_OFFSET}, "config.txt") }
     on-resource cmdline.txt { fat_write(${BOOT_A_PART_OFFSET}, "cmdline.txt") }
-    on-resource start4.elf { fat_write(${BOOT_A_PART_OFFSET}, "start4.elf") }
-    on-resource fixup4.dat { fat_write(${BOOT_A_PART_OFFSET}, "fixup4.dat") }
     on-resource kernel8.img { fat_write(${BOOT_A_PART_OFFSET}, "kernel8.img") }
-    on-resource bcm2711-rpi-4-b.dtb { fat_write(${BOOT_A_PART_OFFSET}, "bcm2711-rpi-4-b.dtb") }
-    on-resource bcm2711-rpi-cm4.dtb { fat_write(${BOOT_A_PART_OFFSET}, "bcm2711-rpi-cm4.dtb") }
-    on-resource bcm2711-rpi-400.dtb { fat_write(${BOOT_A_PART_OFFSET}, "bcm2711-rpi-400.dtb") }
+    on-resource bcm2708-rpi-b.dtb { fat_write(${BOOT_A_PART_OFFSET}, "bcm2708-rpi-b.dtb") }
     on-resource overlays/dwc2.dtbo { fat_write(${BOOT_A_PART_OFFSET}, "overlays/dwc2.dtbo") }
     on-resource overlays/i2c-mux.dtbo { fat_write(${BOOT_A_PART_OFFSET}, "overlays/i2c-mux.dtbo") }
     on-resource overlays/imx219.dtbo { fat_write(${BOOT_A_PART_OFFSET}, "overlays/imx219.dtbo") }
@@ -210,10 +207,10 @@ task upgrade.a {
         uboot_setenv(uboot-env, "a.nerves_fw_misc", ${NERVES_FW_MISC})
         uboot_setenv(uboot-env, "a.nerves_fw_uuid", "\${FWUP_META_UUID}")
 
-	# Switch over to boot the new firmware
-	# NOTE: The mbr_write is the important step. Automatic fallback is not supported, so
-	#       setting the variables is a formality for Nerves.Runtime.firmware_validation_status and
-	#       other code.
+        # Switch over to boot the new firmware
+        # NOTE: The mbr_write is the important step. Automatic fallback is not supported, so
+        #       setting the variables is a formality for Nerves.Runtime.firmware_validation_status and
+        #       other code.
         uboot_setenv(uboot-env, "nerves_fw_active", "a")
         uboot_setenv(uboot-env, "a.nerves_fw_validated", "1")
         mbr_write(mbr-a)
@@ -253,14 +250,12 @@ task upgrade.b {
     # Write the new boot partition files and rootfs. The MBR still points
     # to the A partition, so an error or power failure during this part
     # won't hurt anything.
+    on-resource fixup4.dat { fat_write(${BOOT_B_PART_OFFSET}, "fixup4.dat") }
+    on-resource start4.elf { fat_write(${BOOT_B_PART_OFFSET}, "start4.elf") }
     on-resource config.txt { fat_write(${BOOT_B_PART_OFFSET}, "config.txt") }
     on-resource cmdline.txt { fat_write(${BOOT_B_PART_OFFSET}, "cmdline.txt") }
-    on-resource start4.elf { fat_write(${BOOT_B_PART_OFFSET}, "start4.elf") }
-    on-resource fixup4.dat { fat_write(${BOOT_B_PART_OFFSET}, "fixup4.dat") }
     on-resource kernel8.img { fat_write(${BOOT_B_PART_OFFSET}, "kernel8.img") }
-    on-resource bcm2711-rpi-4-b.dtb { fat_write(${BOOT_B_PART_OFFSET}, "bcm2711-rpi-4-b.dtb") }
-    on-resource bcm2711-rpi-cm4.dtb { fat_write(${BOOT_B_PART_OFFSET}, "bcm2711-rpi-cm4.dtb") }
-    on-resource bcm2711-rpi-400.dtb { fat_write(${BOOT_B_PART_OFFSET}, "bcm2711-rpi-400.dtb") }
+    on-resource bcm2708-rpi-b.dtb { fat_write(${BOOT_B_PART_OFFSET}, "bcm2708-rpi-b.dtb") }
     on-resource overlays/dwc2.dtbo { fat_write(${BOOT_B_PART_OFFSET}, "overlays/dwc2.dtbo") }
     on-resource overlays/i2c-mux.dtbo { fat_write(${BOOT_B_PART_OFFSET}, "overlays/i2c-mux.dtbo") }
     on-resource overlays/imx219.dtbo { fat_write(${BOOT_B_PART_OFFSET}, "overlays/imx219.dtbo") }
@@ -304,10 +299,10 @@ task upgrade.b {
         uboot_setenv(uboot-env, "b.nerves_fw_misc", ${NERVES_FW_MISC})
         uboot_setenv(uboot-env, "b.nerves_fw_uuid", "\${FWUP_META_UUID}")
 
-	# Switch over to boot the new firmware
-	# NOTE: The mbr_write is the important step. Automatic fallback is not supported, so
-	#       setting the variables is a formality for Nerves.Runtime.firmware_validation_status and
-	#       other code.
+        # Switch over to boot the new firmware
+        # NOTE: The mbr_write is the important step. Automatic fallback is not supported, so
+        #       setting the variables is a formality for Nerves.Runtime.firmware_validation_status and
+        #       other code.
         uboot_setenv(uboot-env, "nerves_fw_active", "b")
         uboot_setenv(uboot-env, "b.nerves_fw_validated", "1")
         mbr_write(mbr-b)