From f841a0b3d7e130a6e12acc80de8ba94b6e5a9879 Mon Sep 17 00:00:00 2001
From: David Holdeman <dave@holdemanenterprises.com>
Date: Wed, 28 Feb 2024 15:02:07 -0600
Subject: [PATCH] Move ramdisk creation to its own script and make target

---
 .github/workflows/hw-ci/build_for_hw_ci.sh |  6 +++--
 firmware/bin/gen_image_board.sh            | 30 ++++++++++++++++++++++
 firmware/gen_config.sh                     |  4 ++-
 firmware/gen_config_board.sh               | 21 ---------------
 firmware/gen_config_default.sh             |  2 ++
 firmware/rusefi_config.mk                  | 14 +++++++---
 6 files changed, 50 insertions(+), 27 deletions(-)
 create mode 100644 firmware/bin/gen_image_board.sh

diff --git a/.github/workflows/hw-ci/build_for_hw_ci.sh b/.github/workflows/hw-ci/build_for_hw_ci.sh
index 9a873dd34e..c6f956a985 100755
--- a/.github/workflows/hw-ci/build_for_hw_ci.sh
+++ b/.github/workflows/hw-ci/build_for_hw_ci.sh
@@ -16,8 +16,10 @@ cd firmware
 export BOARD_META_PATH=$(bash bin/find_meta_info.sh ${HW_FOLDER} ${HW_TARGET})
 source config/boards/common_script_read_meta_env.inc "${BOARD_META_PATH}"
 
-./gen_live_documentation.sh
-./gen_config_board.sh $HW_FOLDER $HW_TARGET
+bash gen_live_documentation.sh
+bash gen_signature.sh $HW_TARGET
+bash gen_config_board.sh $HW_FOLDER $HW_TARGET
+bash bin/gen_image_board.sh $HW_FOLDER $HW_TARGET
 
 echo "[build_for_hw_ci.sh] We aren't guaranteed a clean machine every time, so manually clean the output."
 make clean
diff --git a/firmware/bin/gen_image_board.sh b/firmware/bin/gen_image_board.sh
new file mode 100644
index 0000000000..39f4c23c21
--- /dev/null
+++ b/firmware/bin/gen_image_board.sh
@@ -0,0 +1,30 @@
+#!/usr/bin/env bash
+
+BOARD_DIR=${1:-$BOARD_DIR}
+SHORT_BOARD_NAME=${2:-$SHORT_BOARD_NAME}
+INI=${3:-"rusefi_$SHORT_BOARD_NAME.ini"}
+
+which realpath >/dev/null 2>&1 || (which grealpath >/dev/null 2>&1 && alias realpath='grealpath')
+FDIR=$(realpath $(dirname "$0")/..)
+BOARD_DIR=$(realpath --relative-to "$FDIR" "$BOARD_DIR")
+
+cd "$FDIR"
+
+PREPEND_FILE=${BOARD_DIR}/prepend.txt
+
+BOARD_SPECIFIC_URL=$(cat $PREPEND_FILE | grep MAIN_HELP_URL | cut -d " " -f 3 | sed -e 's/^"//' -e 's/"$//')
+
+echo "BOARD_SPECIFIC_URL=[$BOARD_SPECIFIC_URL] for [$SHORT_BOARD_NAME] from [$BOARD_DIR]"
+if [ "" = "$BOARD_SPECIFIC_URL" ]; then
+  BOARD_SPECIFIC_URL=https://rusefi.com/s/wiki
+fi
+echo "BOARD_SPECIFIC_URL=[$BOARD_SPECIFIC_URL]"
+
+# we generate both versions of the header but only one would be actually included due to conditional compilation see EFI_USE_COMPRESSED_INI_MSD
+# todo: make things consistent by
+# 0) having generated content not in the same folder with the tool generating content?
+# 1) using unique file name for each configuration?
+# 2) leverage consistent caching mechanism so that image is generated only in case of fresh .ini. Laziest approach would be to return exit code from java process above
+#
+hw_layer/mass_storage/create_ini_image.sh            ${META_OUTPUT_ROOT_FOLDER}tunerstudio/generated/${INI} ./hw_layer/mass_storage/ramdisk_image.h             128 ${SHORT_BOARD_NAME} ${BOARD_SPECIFIC_URL}
+hw_layer/mass_storage/create_ini_image_compressed.sh ${META_OUTPUT_ROOT_FOLDER}tunerstudio/generated/${INI} ./hw_layer/mass_storage/ramdisk_image_compressed.h 1088 ${SHORT_BOARD_NAME} ${BOARD_SPECIFIC_URL}
diff --git a/firmware/gen_config.sh b/firmware/gen_config.sh
index 7815add572..529b63e5aa 100755
--- a/firmware/gen_config.sh
+++ b/firmware/gen_config.sh
@@ -73,7 +73,9 @@ for BOARD in \
    ; do
  BOARD_DIR=$(echo "$BOARD" | cut -d " " -f 1)
  BOARD_SHORT_NAME=$(echo "$BOARD" | cut -d " " -f 2)
- ./gen_config_board.sh $BOARD_DIR $BOARD_SHORT_NAME
+ bash gen_signature.sh ${SHORT_BOARD_NAME}
+ bash gen_config_board.sh $BOARD_DIR $BOARD_SHORT_NAME
+ bash bin/gen_image_board.sh $BOARD_DIR $BOARD_SHORT_NAME
  [ $? -eq 0 ] || { echo "ERROR generating board dir=[$BOARD_DIR] short=[$BOARD_SHORT_NAME]"; exit 1; }
 done
 
diff --git a/firmware/gen_config_board.sh b/firmware/gen_config_board.sh
index ce5c470660..fe100d7ea0 100755
--- a/firmware/gen_config_board.sh
+++ b/firmware/gen_config_board.sh
@@ -37,18 +37,6 @@ BOARD_DIR=$(realpath --relative-to "$FDIR" "$BOARD_DIR")
 
 cd "$FDIR"
 
-bash gen_signature.sh ${SHORT_BOARD_NAME}
-
-PREPEND_FILE=${BOARD_DIR}/prepend.txt
-
-BOARD_SPECIFIC_URL=$(cat $PREPEND_FILE | grep MAIN_HELP_URL | cut -d " " -f 3 | sed -e 's/^"//' -e 's/"$//')
-
-echo "BOARD_SPECIFIC_URL=[$BOARD_SPECIFIC_URL] for [$SHORT_BOARD_NAME] from [$BOARD_DIR]"
-if [ "" = "$BOARD_SPECIFIC_URL" ]; then
-  BOARD_SPECIFIC_URL=https://rusefi.com/s/wiki
-fi
-echo "BOARD_SPECIFIC_URL=[$BOARD_SPECIFIC_URL]"
-
 source gen_config_common.sh
 echo "Using COMMON_GEN_CONFIG [$COMMON_GEN_CONFIG]"
 
@@ -68,14 +56,5 @@ if [ -z "META_OUTPUT_ROOT_FOLDER" ]; then
 	META_OUTPUT_ROOT_FOLDER=""
 fi
 
-# we generate both versions of the header but only one would be actually included due to conditional compilation see EFI_USE_COMPRESSED_INI_MSD
-# todo: make things consistent by
-# 0) having generated content not in the same folder with the tool generating content?
-# 1) using unique file name for each configuration?
-# 2) leverage consistent caching mechanism so that image is generated only in case of fresh .ini. Laziest approach would be to return exit code from java process above
-#
-hw_layer/mass_storage/create_ini_image.sh            ${META_OUTPUT_ROOT_FOLDER}tunerstudio/generated/${INI} ./hw_layer/mass_storage/ramdisk_image.h             128 ${SHORT_BOARD_NAME} ${BOARD_SPECIFIC_URL}
-hw_layer/mass_storage/create_ini_image_compressed.sh ${META_OUTPUT_ROOT_FOLDER}tunerstudio/generated/${INI} ./hw_layer/mass_storage/ramdisk_image_compressed.h 1088 ${SHORT_BOARD_NAME} ${BOARD_SPECIFIC_URL}
-
 echo "Happy ${SHORT_BOARD_NAME}!"
 exit 0
diff --git a/firmware/gen_config_default.sh b/firmware/gen_config_default.sh
index 3e4c958331..5218e2c037 100755
--- a/firmware/gen_config_default.sh
+++ b/firmware/gen_config_default.sh
@@ -5,5 +5,7 @@ cd ../java_tools
 ./gradlew :config_definition:shadowJar
 cd ../firmware
 
+bash gen_signature.sh f407-discovery
 bash gen_config_board.sh config/boards/f407-discovery f407-discovery rusefi.ini
+bash bin/gen_image_board.sh config/boards/f407-discovery f407-discovery rusefi.ini
 exit $?
diff --git a/firmware/rusefi_config.mk b/firmware/rusefi_config.mk
index 807bd8a859..8f299045f4 100644
--- a/firmware/rusefi_config.mk
+++ b/firmware/rusefi_config.mk
@@ -3,12 +3,14 @@ include $(PROJECT_DIR)/../java_tools/java_tools.mk
 INI_FILE = $(META_OUTPUT_ROOT_FOLDER)tunerstudio/generated/rusefi_$(SHORT_BOARD_NAME).ini
 SIG_FILE = $(PROJECT_DIR)/tunerstudio/generated/signature_$(SHORT_BOARD_NAME).txt
 
+RAMDISK = \
+  $(PROJECT_DIR)/hw_layer/mass_storage/ramdisk_image.h \
+  $(PROJECT_DIR)/hw_layer/mass_storage/ramdisk_image_compressed.h
+
 CONFIG_FILES = \
-  $(PROJECT_DIR)/$(INI_FILE) \
+  $(INI_FILE) \
   $(PROJECT_DIR)/controllers/generated/rusefi_generated_$(SHORT_BOARD_NAME).h \
   $(PROJECT_DIR)/controllers/generated/signature_$(SHORT_BOARD_NAME).h \
-  $(PROJECT_DIR)/hw_layer/mass_storage/ramdisk_image.h \
-  $(PROJECT_DIR)/hw_layer/mass_storage/ramdisk_image_compressed.h \
   $(PROJECT_DIR)/$(BOARD_DIR)/connectors/generated_outputs.h \
   $(PROJECT_DIR)/$(BOARD_DIR)/connectors/generated_ts_name_by_pin.cpp \
   $(FIELDS)
@@ -16,10 +18,16 @@ CONFIG_FILES = \
 .FORCE:
 
 $(TCOBJS): $(CONFIG_FILES)
+$(TCPPOBJS): $(RAMDISK)
 
 $(SIG_FILE): .FORCE
 	bash $(PROJECT_DIR)/gen_signature.sh $(SHORT_BOARD_NAME)
 
+$(RAMDISK): .ramdisk-sentinel ;
+
+.ramdisk-sentinel: $(INI_FILE)
+	bash $(PROJECT_DIR)/bin/gen_image_board.sh $(BOARD_DIR) $(SHORT_BOARD_NAME)
+
 $(CONFIG_FILES): .config-sentinel ;
 
 .config-sentinel: $(SIG_FILE) .FORCE