espressif: generate combined.bin and combined_ota.bin (for 4MB board) as post_build, copy artifacts as post_build.

Author: hathach

.github/workflows/build_util.yml

@@ -58,7 +58,7 @@ jobs:
 
       - name: Build using ESP-IDF docker
         if: inputs.toolchain == 'esp-idf'
-        run: docker run --rm -v $PWD:/project -w /project espressif/idf:${{ inputs.toolchain_version }} /bin/bash -c "git config --global --add safe.directory /project && make -C ports/espressif/ BOARD=${{ matrix.board }} all copy-artifact"
+        run: docker run --rm -v $PWD:/project -w /project espressif/idf:${{ inputs.toolchain_version }} /bin/bash -c "git config --global --add safe.directory /project && idf.py -C ports/espressif -DBOARD=${{ matrix.board }} build"
 
       - uses: actions/upload-artifact@v4
         with:

.github/workflows/ci_set_matrix.py

@@ -18,8 +18,8 @@ def set_matrix_json():
                     if b.is_dir():
                         matrix[p.name]['board'].append(b.name)
                         # For quick testing by only build 1 espressif board
-                        #if p.name == 'espressif':
-                        #    break
+                        if p.name == 'espressif':
+                           break
     print(json.dumps(matrix))
 
 

ports/espressif/CMakeLists.txt

@@ -28,26 +28,67 @@ add_compile_definitions(
   UF2_VERSION_BASE="${GIT_VERSION}"
   UF2_VERSION="${GIT_VERSION} - ${GIT_SUBMODULE_VERSIONS}"
   )
-
 cmake_print_variables(GIT_VERSION GIT_SUBMODULE_VERSIONS)
 
 project(tinyuf2)
 
 # Post build: generate bootloader_bin.c for self-update and combined.bin
-add_custom_command(TARGET app POST_BUILD
+add_custom_command(TARGET tinyuf2.elf POST_BUILD
   COMMAND ${Python_EXECUTABLE} ${UF2CONV_PY} --carray -o ${CMAKE_CURRENT_LIST_DIR}/apps/self_update/main/bootloader_bin.c ${CMAKE_BINARY_DIR}/tinyuf2.bin
   )
 
+add_custom_command(TARGET tinyuf2.elf POST_BUILD
+  BYPRODUCTS ${CMAKE_BINARY_DIR}/combined.bin
+  COMMAND ${CMAKE_COMMAND} -E echo "Creating combined.bin"
+  COMMAND bash -c "esptool.py --chip ${IDF_TARGET} merge_bin --output combined.bin $(tr '\\n' ' ' < ${CMAKE_BINARY_DIR}/flash_args)"
+  VERBATIM
+  )
+
+## Post build: copy binaries for artifact
+set(ARTIFACT_PATH ${CMAKE_CURRENT_LIST_DIR}/_bin/${BOARD})
+add_custom_command(TARGET tinyuf2.elf POST_BUILD
+  COMMAND ${CMAKE_COMMAND} -E echo "Copy binaries for artifact"
+  COMMAND mkdir -p ${ARTIFACT_PATH}
+  COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/bootloader/bootloader.bin ${ARTIFACT_PATH}/bootloader.bin
+  COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/ota_data_initial.bin ${ARTIFACT_PATH}/ota_data_initial.bin
+  COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/partition_table/partition-table.bin ${ARTIFACT_PATH}/partition-table.bin
+  COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/tinyuf2.bin ${ARTIFACT_PATH}/tinyuf2.bin
+  COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/combined.bin ${ARTIFACT_PATH}/combined.bin
+  VERBATIM
+  )
+
+# check if board is 4MB flash and create combined-ota.bin
+file(READ ${CMAKE_CURRENT_LIST_DIR}/boards/${BOARD}/sdkconfig BOARD_SDKCONFIG_CONTENTS)
+string(FIND ${BOARD_SDKCONFIG_CONTENTS} "partitions-4MB-noota.csv" MATCH_INDEX)
+if(NOT MATCH_INDEX EQUAL -1)
+  add_custom_command(TARGET tinyuf2.elf POST_BUILD
+    BYPRODUCTS ${CMAKE_BINARY_DIR}/combined_ota.bin
+    COMMAND ${CMAKE_COMMAND} -E echo "Creating combined_ota.bin"
+    COMMAND gen_esp32part.py ${CMAKE_CURRENT_LIST_DIR}/partitions-4MB.csv ${CMAKE_BINARY_DIR}/partition_table/partitions-table-4MB-ota.bin
+    COMMAND bash -c "esptool.py --chip ${IDF_TARGET} merge_bin --output combined_ota.bin $(tr '\\n' ' ' < ${CMAKE_BINARY_DIR}/flash_args | sed 's/partition-table.bin/partitions-table-4MB-ota.bin/g')"
+    COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/combined_ota.bin ${ARTIFACT_PATH}/combined_ota.bin
+    VERBATIM
+    )
+endif()
+
 # External project for self-update
 externalproject_add(self_update
   SOURCE_DIR ${CMAKE_CURRENT_LIST_DIR}/apps/self_update
   BINARY_DIR ${CMAKE_BINARY_DIR}/self_update
-  # Modiying the list separator for the arguments, as such, we won't need to manually
+  # Modifying the list separator for the arguments, as such, we won't need to manually
   # replace the new separator by the default ';' in the subproject
   CMAKE_ARGS -DBOARD=${BOARD}
   INSTALL_COMMAND ""
   BUILD_ALWAYS 1
-  DEPENDS app
+  DEPENDS tinyuf2.elf
+  )
+
+# flash combined.bin
+add_custom_target(combined-flash
+  DEPENDS tinyuf2.elf
+  COMMAND ${CMAKE_COMMAND} -E echo "Flashing combined.bin"
+  COMMAND esptool.py --chip ${IDF_TARGET} write_flash 0x0 combined.bin
+  VERBATIM
   )
 
 # -------------------------------------------------------------
@@ -61,7 +102,7 @@ if (0)
     COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/bootloader/bootloader.bin ${ARDUINO_VARIANT_DIR}/bootloader-tinyuf2.bin
     )
 
-  add_custom_command(TARGET app POST_BUILD
+  add_custom_command(TARGET tinyuf2.elf POST_BUILD
     COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/tinyuf2.bin ${ARDUINO_VARIANT_DIR}/tinyuf2.bin
     )
 endif ()

ports/espressif/Makefile

@@ -3,9 +3,6 @@
 .PHONY: all build clean flash monitor erase
 .DEFAULT_GOAL := all
 
-# Set default python interpreters
-PYTHON3 ?= python3
-
 # Build directory
 BUILD = _build/$(BOARD)
 BIN = _bin/$(BOARD)
@@ -15,9 +12,6 @@ ifdef SERIAL
 SERIAL_OPT = --port $(SERIAL)
 endif
 
-UF2_FAMILY_ID_esp32s2 = 0xbfdd4eee
-UF2_FAMILY_ID_esp32s3 = 0xc47e5767
-
 BOARD_CMAKE := $(file < boards/$(BOARD)/board.cmake)
 ifneq ($(findstring esp32s2,$(BOARD_CMAKE)),)
 	IDF_TARGET = esp32s2
@@ -40,31 +34,12 @@ fullclean:
 app bootloader clean flash bootloader-flash app-flash erase-flash monitor dfu-flash dfu size size-components size-files:
 	idf.py -B$(BUILD) -DBOARD=$(BOARD) $(SERIAL_OPT) $@
 
-combined.bin: $(BUILD)/combined.bin
-
+# combined.bin is POST build step, generated by cmake app target
 $(BUILD)/combined.bin: app
-	cd $(BUILD); \
-	esptool.py --chip $(IDF_TARGET) merge_bin --output combined.bin $(strip $(file < $(BUILD)/flash_args))
-
 combined-flash: $(BUILD)/combined.bin
 	esptool.py --chip $(IDF_TARGET) write_flash 0x0 $<
 
-#-------------- Self Update --------------
 # Self_update is a sub/external project, will be built by cmake's all target
 SELF_BUILD = ${BUILD}/self_update
 
-#-------------- Artifacts --------------
-$(BIN):
-	@mkdir -p $@
-
-# get the partition csv from sdkconfig
-PARTITION_CSV := $(strip $(foreach csv,$(wildcard partitions-*.csv),$(findstring $(csv),$(file < boards/$(BOARD)/sdkconfig))))
-
-copy-artifact: $(BIN) all $(BUILD)/combined.bin
-	@cp $(BUILD)/bootloader/bootloader.bin $<
-	@cp $(BUILD)/partition_table/partition-table.bin $<
-	@cp $(BUILD)/ota_data_initial.bin $<
-	@cp $(BUILD)/tinyuf2.bin $<
-	@cp $(BUILD)/combined.bin $<
-	@cp $(SELF_BUILD)/update-tinyuf2.uf2 $<
-	@cp $(PARTITION_CSV) $<
+# Artifacts is generated as Cmake post build

ports/espressif/apps/self_update/CMakeLists.txt

@@ -16,8 +16,10 @@ add_compile_definitions(TINYUF2_SELF_UPDATE)
 
 project(update-tinyuf2)
 
+set(ARTIFACT_PATH ${CMAKE_CURRENT_LIST_DIR}/../../_bin/${BOARD})
 add_custom_command(TARGET app POST_BUILD
   COMMAND ${Python_EXECUTABLE} ${UF2CONV_PY} -f ${UF2_FAMILY_ID_${IDF_TARGET}} -b 0x0 -c -o ${CMAKE_BINARY_DIR}/update-tinyuf2.uf2 ${CMAKE_BINARY_DIR}/update-tinyuf2.bin
+  COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/update-tinyuf2.uf2 ${ARTIFACT_PATH}/update-tinyuf2.uf2
   VERBATIM
   )