Streamline ESP32 image creation

Modifies the ESP32 build configuration and mkimage tool to automatically detect the image flavor
based on the partition table used. By checking the offset of the application partition the correct
flavor of language support is used when creating images. Adds a config option to configure an
Elixir supported build by using `idf.py fullclean reconfigure -DAVM_ELIXIR_BOOT="y"` (sdkconfig
must be deleted first).

Signed-off-by: Winford <[email protected]>

Author: UncleGrumpy

.github/workflows/esp32-mkimage.yaml

@@ -148,9 +148,7 @@ jobs:
         then
           ./mkimage.sh
         else
-          FLAVOR_SUFFIX=$(echo "${{ matrix.flavor }}" | sed 's/-//g')
-          BOOT_FILE="../../../../build/libs/esp32boot/${FLAVOR_SUFFIX}_esp32boot.avm"
-          ./mkimage.sh --boot "$BOOT_FILE"
+          ./mkimage.sh
           mv atomvm-${{ matrix.soc }}.img atomvm-${{ matrix.soc }}${{ matrix.flavor }}.img
         fi
         ls -l *.img

src/platforms/esp32/.gitignore

@@ -0,0 +1,6 @@
+# Copyright 2017-2025 Davide Bettio <[email protected]>
+# Copyright 2025 Winford (Uncle Grumpy) <[email protected]>
+#
+# SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later
+
+sdkconfig.defaults

src/platforms/esp32/CMakeLists.txt

@@ -51,6 +51,15 @@ endif()
 # On Esp32, select is run in a loop in a dedicated task
 set(AVM_SELECT_IN_TASK ON)
 
+## Configure partiton table based on boot flavor
+if (${AVM_ELIXIR_BOOT} MATCHES "ON|On|on|Y|y|YES|Yes|yes")
+    set(AVM_PARTITION_TABLE_FILENAME "partitions-elixir.csv")
+else()
+    set(AVM_PARTITION_TABLE_FILENAME "partitions.csv")
+endif()
+
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/sdkconfig.defaults.in ${CMAKE_CURRENT_SOURCE_DIR}/sdkconfig.defaults @ONLY)
+
 project(atomvm-esp32)
 
 # esp-idf does not use compile_feature but instead sets version in

src/platforms/esp32/GetBootAVM.cmake

@@ -0,0 +1,29 @@
+#
+# This file is part of AtomVM.
+#
+# Copyright 2025 Winford (Uncle Grumpy) <[email protected]>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later
+#
+
+partition_table_get_partition_info(app_offset "--partition-name main.avm" "offset")
+if ("${app_offset}" STREQUAL "0x210000")
+    set(BOOT_LIBS "esp32boot.avm")
+elseif ("${app_offset}" STREQUAL "0x250000")
+    set(BOOT_LIBS "elixir_esp32boot.avm")
+else()
+    message(FATAL_ERROR "Unable to determine esp32boot flavor from offset: ${app_offset}")
+endif()
+

src/platforms/esp32/sdkconfig.defaults

@@ -0,0 +1,6 @@
+CONFIG_PARTITION_TABLE_CUSTOM=y
+CONFIG_ESPTOOLPY_FLASHSIZE_4MB=y
+CONFIG_MBEDTLS_ECP_FIXED_POINT_OPTIM=y
+CONFIG_LWIP_IPV6=n
+CONFIG_PARTITION_TABLE_CUSTOM_FILENAME="@AVM_PARTITION_TABLE_FILENAME@"
+CONFIG_PARTITION_TABLE_FILENAME="@AVM_PARTITION_TABLE_FILENAME@"

src/platforms/esp32/sdkconfig.defaults.in

@@ -22,6 +22,7 @@ cmake_minimum_required (VERSION 3.13)
 project (ReleaseEsp32)
 include(../../../../version.cmake)
 include(../../../../CMakeModules/GetVersion.cmake)
+include(../GetBootAVM.cmake)
 
 ## Build image tools for target chip
 
@@ -45,6 +46,13 @@ elseif(${CONFIG_IDF_TARGET} STREQUAL "esp32p4")
     set(BOOTLOADER_OFFSET "0x2000")
 endif()
 
+if (NOT EXISTS ../../../../build/libs/esp32boot/${BOOT_LIBS})
+    message(WARNING "A generic_unix build must be done first in the top level AtomVM/build directory! \n\
+    Consult https://doc.atomvm.org/main/build-instructions.html for build instructions.")
+endif()
+
+set(ROOT_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../../../../")
+
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/mkimage.config.in ${CMAKE_BINARY_DIR}/mkimage.config)
 
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/../../../../tools/dev/flash.sh ${CMAKE_BINARY_DIR}/${CMAKE_FILES_DIRECTORY}/flash.sh COPYONLY)
@@ -64,7 +72,3 @@ file(COPY ${CMAKE_BINARY_DIR}/${CMAKE_FILES_DIRECTORY}/flash.sh
     FILE_PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE GROUP_READ GROUP_EXECUTE WORLD_READ WORLD_EXECUTE
 )
 
-if (NOT EXISTS ../../../../build/libs/esp32boot/${BOOT_LIBS})
-    message(WARNING "A generic_unix build must be done first in the top level AtomVM/build directory! \n\
-    Consult https://doc.atomvm.org/main/build-instructions.html for build instructions.")
-endif()

src/platforms/esp32/tools/CMakeLists.txt

@@ -33,12 +33,12 @@
         #{
             name => "AtomVM Virtual Machine",
             offset => "0x10000",
-            path => ["${BUILD_DIR}/atomvm-esp32.bin", "${ROOT_DIR}/src/platforms/esp32/build/atomvvm-esp32.bin"]
+            path => ["${BUILD_DIR}/atomvm-esp32.bin", "${ROOT_DIR}/src/platforms/esp32/build/atomvm-esp32.bin"]
         },
         #{
             name => "AtomVM Boot and Core BEAM Library",
             offset =>  "0x1D0000",
-            path => ["$[BOOT_FILE]"]
+            path => ["${ROOT_DIR}/build/libs/esp32boot/${BOOT_LIBS}"]
         }
     ]
 }.

src/platforms/esp32/tools/mkimage.config.in

@@ -43,7 +43,7 @@ do_main(Argv) ->
                     try
                         Config = load_config(maps:get(config, Opts, "mkimage.config")),
                         BuildDir = get_build_dir(Opts, RootDir),
-                        BootFile = BuildDir ++ "/libs/esp32boot/esp32boot.avm",
+                        BootFile = maps:get(boot, Opts, BuildDir ++ "/libs/esp32boot/esp32boot.avm"),
                         mkimage(
                             RootDir,
                             BuildDir,

src/platforms/esp32/tools/mkimage.erl

@@ -23,10 +23,11 @@ escript "@CMAKE_BINARY_DIR@/mkimage.erl" \
     --root_dir "@CMAKE_BINARY_DIR@/../../../.." \
     --config "@CMAKE_BINARY_DIR@/mkimage.config" \
     --out "@CMAKE_BINARY_DIR@/atomvm-@[email protected]" \
+    --boot "@CMAKE_BINARY_DIR@/../../../../build/libs/esp32boot/@BOOT_LIBS@"
     "$@"
 
 echo "============================================="
 
 echo ""
-echo "AtomVM @CONFIG_IDF_TARGET@ version @ATOMVM_VERSION@ image written to:"
+echo "AtomVM @CONFIG_IDF_TARGET@ version @ATOMVM_VERSION@ image with @BOOT_LIBS@ libraries written to:"
 echo "@CMAKE_BINARY_DIR@/atomvm-@[email protected]"