add a post-build command to patch board config into .bin/.uf2

bsstephan · bsstephan · commit a1a27f04b08f · 2025-02-10T09:11:13.000-06:00
this starts the replacement of BoardConfig.h + migration code with
shipped protobuf configs. this should help cleanup some code, and one
day will hopefully replace the need for per-board builds entirely,
greatly speeding up the GitHub build/creation of board binaries
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -121,6 +121,9 @@ add_compile_options(-Wall
 include(compile_proto.cmake)
 compile_proto()
 
+include(patch_board_config.cmake)
+patch_board_config()
+
 #pull in tinyUSB
 set(PICO_TINYUSB_PATH "${CMAKE_CURRENT_LIST_DIR}/lib/tinyusb")
 
diff --git a/compile_proto.cmake b/compile_proto.cmake
@@ -13,6 +13,7 @@ function (compile_proto)
 		DEPENDS ${CMAKE_SOURCE_DIR}/lib/nanopb/extra/requirements.txt
 		COMMAND ${Python3_EXECUTABLE} -m venv ${VENV}
 		COMMAND ${VENV_BIN_DIR}/pip --disable-pip-version-check install -r ${CMAKE_SOURCE_DIR}/lib/nanopb/extra/requirements.txt
+		COMMAND ${VENV_BIN_DIR}/pip --disable-pip-version-check install gp2040ce-binary-tools
 		COMMAND ${VENV_BIN_DIR}/pip freeze > ${VENV_FILE}
 		OUTPUT ${VENV_FILE}
 		COMMENT "Setting up Python Virtual Environment"
diff --git a/configs/ARCController/board-config.json b/configs/ARCController/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/BentoBox/board-config.json b/configs/BentoBox/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/Blank/board-config.json b/configs/Blank/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/FlatboxRev4/board-config.json b/configs/FlatboxRev4/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/FlatboxRev5/board-config.json b/configs/FlatboxRev5/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/FlatboxRev5RGB/board-config.json b/configs/FlatboxRev5RGB/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/FlatboxRev5Southpaw/board-config.json b/configs/FlatboxRev5Southpaw/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/FlatboxRev5USBPassthrough/board-config.json b/configs/FlatboxRev5USBPassthrough/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/Granola/board-config.json b/configs/Granola/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/Haute42COSMOX/board-config.json b/configs/Haute42COSMOX/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/KB2040/board-config.json b/configs/KB2040/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/KeyboardConverter/board-config.json b/configs/KeyboardConverter/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/Liatris/board-config.json b/configs/Liatris/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/MavercadeRev1/board-config.json b/configs/MavercadeRev1/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/MavercadeRev2/board-config.json b/configs/MavercadeRev2/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/MiSTercadeV2/board-config.json b/configs/MiSTercadeV2/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/OSUMGP-RP2040/board-config.json b/configs/OSUMGP-RP2040/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/OpenCore0/board-config.json b/configs/OpenCore0/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/OpenCore0WASD/board-config.json b/configs/OpenCore0WASD/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/PXPGamepad/board-config.json b/configs/PXPGamepad/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/Pico/board-config.json b/configs/Pico/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/PicoAnn/board-config.json b/configs/PicoAnn/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/PicoFightingBoard/board-config.json b/configs/PicoFightingBoard/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/PicoW/board-config.json b/configs/PicoW/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/RP2040AdvancedBreakoutBoard/board-config.json b/configs/RP2040AdvancedBreakoutBoard/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/RP2040AdvancedBreakoutBoardUSBPassthrough/board-config.json b/configs/RP2040AdvancedBreakoutBoardUSBPassthrough/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/RP2040MiniBreakoutBoard/board-config.json b/configs/RP2040MiniBreakoutBoard/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/RP2040MiniBreakoutBoardUSBPassthrough/board-config.json b/configs/RP2040MiniBreakoutBoardUSBPassthrough/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/ReflexCtrlGenesis6/board-config.json b/configs/ReflexCtrlGenesis6/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/ReflexCtrlNES/board-config.json b/configs/ReflexCtrlNES/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/ReflexCtrlSNES/board-config.json b/configs/ReflexCtrlSNES/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/ReflexCtrlSaturn/board-config.json b/configs/ReflexCtrlSaturn/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/ReflexCtrlVB/board-config.json b/configs/ReflexCtrlVB/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/ReflexEncodeV1.2/board-config.json b/configs/ReflexEncodeV1.2/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/ReflexEncodeV2.0/board-config.json b/configs/ReflexEncodeV2.0/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/SGFDevices/board-config.json b/configs/SGFDevices/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/SparkFunProMicro/board-config.json b/configs/SparkFunProMicro/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/Stress/board-config.json b/configs/Stress/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/WaveshareZero/board-config.json b/configs/WaveshareZero/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/configs/ZeroRhythm/board-config.json b/configs/ZeroRhythm/board-config.json
@@ -0,0 +1,3 @@
+{
+	"boardVersion": "v0.7.8"
+}
diff --git a/patch_board_config.cmake b/patch_board_config.cmake
@@ -0,0 +1,29 @@
+function (patch_board_config)
+	find_package(Python3 REQUIRED COMPONENTS Interpreter)
+
+	set(VENV ${CMAKE_CURRENT_BINARY_DIR}/venv)
+	if(CMAKE_HOST_WIN32)
+		set(VENV_BIN_DIR ${VENV}/Scripts)
+	else()
+		set(VENV_BIN_DIR ${VENV}/bin)
+	endif()
+
+	add_custom_target(
+		PatchBoardConfig ALL
+		DEPENDS ${PROJECT_NAME}
+		WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+		COMMAND ${VENV_BIN_DIR}/concatenate
+			-P ./proto
+			-P ./lib/nanopb/generator/proto
+			./build/${PROJECT_NAME}_${CMAKE_PROJECT_VERSION}_${GP2040_BOARDCONFIG}.bin
+			--json-board-config-filename ./configs/${GP2040_BOARDCONFIG}/board-config.json
+			--new-filename ./build/${PROJECT_NAME}_${CMAKE_PROJECT_VERSION}_${GP2040_BOARDCONFIG}.uf2
+		COMMAND ${VENV_BIN_DIR}/concatenate
+			-P ./proto
+			-P ./lib/nanopb/generator/proto
+			./build/${PROJECT_NAME}_${CMAKE_PROJECT_VERSION}_${GP2040_BOARDCONFIG}.bin
+			--json-board-config-filename ./configs/${GP2040_BOARDCONFIG}/board-config.json
+			--new-filename ./build/${PROJECT_NAME}_${CMAKE_PROJECT_VERSION}_${GP2040_BOARDCONFIG}.bin
+		COMMENT "Patching binary with board config"
+	)
+endfunction()

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "boardVersion": "v0.7.8"`
	`3`	`+}`