if(NOT IDF_BUILD_ARTIFACTS) return() endif() # Set some global esptool.py variables # # Many of these are read when generating flash_app_args & flash_project_args set(ESPTOOLPY ${PYTHON} "${CMAKE_CURRENT_LIST_DIR}/esptool/esptool.py" --chip esp32) set(ESPSECUREPY ${PYTHON} "${CMAKE_CURRENT_LIST_DIR}/esptool/espsecure.py") set(ESPEFUSEPY ${PYTHON} "${CMAKE_CURRENT_LIST_DIR}/esptool/espefuse.py") set(ESPFLASHMODE ${CONFIG_ESPTOOLPY_FLASHMODE}) set(ESPFLASHFREQ ${CONFIG_ESPTOOLPY_FLASHFREQ}) set(ESPFLASHSIZE ${CONFIG_ESPTOOLPY_FLASHSIZE}) set(ESPTOOLPY_BEFORE "${CONFIG_ESPTOOLPY_BEFORE}") set(ESPTOOLPY_AFTER "${CONFIG_ESPTOOLPY_AFTER}") if(CONFIG_SECURE_BOOT_ENABLED OR CONFIG_FLASH_ENCRYPTION_ENABLED) # If security enabled then override post flash option set(ESPTOOLPY_AFTER "no_reset") endif() set(ESPTOOLPY_SERIAL "${ESPTOOLPY}" --port "${ESPPORT}" --baud ${ESPBAUD} --before "${ESPTOOLPY_BEFORE}" --after "${ESPTOOLPY_AFTER}" ) if(CONFIG_ESPTOOLPY_COMPRESSED) set(ESPTOOLPY_COMPRESSED_OPT -z) else() set(ESPTOOLPY_COMPRESSED_OPT -u) endif() set(ESPTOOLPY_ELF2IMAGE_FLASH_OPTIONS --flash_mode ${ESPFLASHMODE} --flash_freq ${ESPFLASHFREQ} --flash_size ${ESPFLASHSIZE} ) # String for printing flash command string(REPLACE ";" " " ESPTOOLPY_WRITE_FLASH_STR "${ESPTOOLPY} --port (PORT) --baud (BAUD) --before ${ESPTOOLPY_BEFORE} --after ${ESPTOOLPY_AFTER} " "write_flash ${ESPTOOLPY_ELF2IMAGE_FLASH_OPTIONS} ${ESPTOOLPY_EXTRA_FLASH_OPTIONS} ${ESPTOOLPY_COMPRESSED_OPT}") if(CONFIG_SECURE_BOOT_ENABLED AND NOT CONFIG_SECURE_BOOT_ALLOW_SHORT_APP_PARTITION AND NOT BOOTLOADER_BUILD) set(ESPTOOLPY_ELF2IMAGE_FLASH_OPTIONS ${ESPTOOLPY_ELF2IMAGE_FLASH_OPTIONS} --secure-pad) endif() if(NOT BOOTLOADER_BUILD) set(ESPTOOLPY_ELF2IMAGE_OPTIONS --elf-sha256-offset 0xb0) endif() if(CONFIG_ESPTOOLPY_FLASHSIZE_DETECT) # Set ESPFLASHSIZE to 'detect' *after* elf2image options are generated, # as elf2image can't have 'detect' as an option... set(ESPFLASHSIZE detect) endif() get_filename_component(IDF_PROJECT_NAME ${IDF_PROJECT_EXECUTABLE} NAME_WE) if(CONFIG_SECURE_BOOT_BUILD_SIGNED_BINARIES AND NOT BOOTLOADER_BUILD) set(unsigned_project_binary "${IDF_PROJECT_NAME}-unsigned.bin") else() set(unsigned_project_binary "${IDF_PROJECT_NAME}.bin") endif() # # Add 'app.bin' target - generates with elf2image # add_custom_command(OUTPUT "${IDF_BUILD_ARTIFACTS_DIR}/${unsigned_project_binary}" COMMAND ${ESPTOOLPY} elf2image ${ESPTOOLPY_ELF2IMAGE_FLASH_OPTIONS} ${ESPTOOLPY_ELF2IMAGE_OPTIONS} -o "${IDF_BUILD_ARTIFACTS_DIR}/${unsigned_project_binary}" "${IDF_PROJECT_EXECUTABLE}" DEPENDS ${IDF_PROJECT_EXECUTABLE} VERBATIM WORKING_DIRECTORY ${CMAKE_BINARY_DIR} ) get_filename_component(IDF_PROJECT_BIN ${IDF_PROJECT_EXECUTABLE} NAME_WE) set(IDF_PROJECT_BIN ${IDF_PROJECT_BIN}.bin) if(NOT BOOTLOADER_BUILD AND CONFIG_SECURE_BOOT_BUILD_SIGNED_BINARIES) # for locally signed secure boot image, add a signing step to get from unsigned app to signed app add_custom_target(gen_unsigned_project_binary ALL DEPENDS "${IDF_BUILD_ARTIFACTS_DIR}/${unsigned_project_binary}") add_custom_command(OUTPUT "${IDF_BUILD_ARTIFACTS_DIR}/${IDF_PROJECT_BIN}" COMMAND ${ESPSECUREPY} sign_data --keyfile ${secure_boot_signing_key} -o "${IDF_BUILD_ARTIFACTS_DIR}/${IDF_PROJECT_BIN}" "${IDF_BUILD_ARTIFACTS_DIR}/${unsigned_project_binary}" DEPENDS gen_unsigned_project_binary VERBATIM ) endif() if(NOT BOOTLOADER_BUILD) add_custom_target(app ALL DEPENDS "${IDF_BUILD_ARTIFACTS_DIR}/${IDF_PROJECT_BIN}") else() add_custom_target(bootloader ALL DEPENDS "${IDF_BUILD_ARTIFACTS_DIR}/${IDF_PROJECT_BIN}") endif() if(NOT BOOTLOADER_BUILD AND CONFIG_SECURE_BOOT_ENABLED AND NOT CONFIG_SECURE_BOOT_BUILD_SIGNED_BINARIES) add_custom_command(TARGET app POST_BUILD COMMAND ${CMAKE_COMMAND} -E echo "App built but not signed. Sign app before flashing" COMMAND ${CMAKE_COMMAND} -E echo "\t${ESPSECUREPY} sign_data --keyfile KEYFILE ${IDF_BUILD_ARTIFACTS_DIR}/${IDF_PROJECT_BIN}" VERBATIM) endif() # # Add 'flash' target - not all build systems can run this directly # function(esptool_py_custom_target target_name flasher_filename dependencies) add_custom_target(${target_name} DEPENDS ${dependencies} COMMAND ${CMAKE_COMMAND} -D IDF_PATH="${IDF_PATH}" -D ESPTOOLPY="${ESPTOOLPY}" -D ESPTOOL_ARGS="write_flash;@flash_${flasher_filename}_args" -D ESPTOOL_WORKING_DIR="${IDF_BUILD_ARTIFACTS_DIR}" -P run_esptool.cmake WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR} USES_TERMINAL ) endfunction() esptool_py_custom_target(flash project "app;partition_table;bootloader") esptool_py_custom_target(app-flash app "app") esptool_py_custom_target(bootloader-flash bootloader "bootloader") add_custom_target(flash_project_args_target) # esptool_py_flash_project_args # # Add file to the flasher args list, to be flashed at a particular offset function(esptool_py_flash_project_args entry offset image) set(options FLASH_IN_PROJECT) # flash the image when flashing the project set(single_value FLASH_FILE_TEMPLATE) # template file to use to be able to # flash the image individually using esptool cmake_parse_arguments(flash_entry "${options}" "${single_value}" "" "${ARGN}") get_property(flash_project_entries TARGET flash_project_args_target PROPERTY FLASH_PROJECT_ENTRIES) if(${entry} IN_LIST flash_project_entries) message(FATAL_ERROR "entry '${entry}' has already been added to flash project entries") endif() list(APPEND flash_project_entries "${entry}") set_property(TARGET flash_project_args_target PROPERTY FLASH_PROJECT_ENTRIES "${flash_project_entries}") file(RELATIVE_PATH image ${CMAKE_BINARY_DIR} ${image}) # Generate the standalone flash file to flash the image individually using esptool set(entry_flash_args ${IDF_BUILD_ARTIFACTS_DIR}/flash_${entry}_args) if(NOT flash_entry_FLASH_FILE_TEMPLATE) file(GENERATE OUTPUT ${entry_flash_args} CONTENT "${offset} ${image}") else() configure_file(${flash_entry_FLASH_FILE_TEMPLATE} ${entry_flash_args}) endif() set_directory_properties(PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES ${entry_flash_args}) # Generate standalone entries in the flasher args json file get_property(flash_project_args_entry_json TARGET flash_project_args_target PROPERTY FLASH_PROJECT_ARGS_ENTRY_JSON) list(APPEND flash_project_args_entry_json "\"${entry}\" : { \"offset\" : \"${offset}\", \"file\" : \"${image}\" }") set_property(TARGET flash_project_args_target PROPERTY FLASH_PROJECT_ARGS_ENTRY_JSON "${flash_project_args_entry_json}") # Generate entries in the flasher args json file if(flash_entry_FLASH_IN_PROJECT) get_property(flash_project_args TARGET flash_project_args_target PROPERTY FLASH_PROJECT_ARGS) list(APPEND flash_project_args "${offset} ${image}") set_property(TARGET flash_project_args_target PROPERTY FLASH_PROJECT_ARGS "${flash_project_args}") get_property(flash_project_args_json TARGET flash_project_args_target PROPERTY FLASH_PROJECT_ARGS_JSON) list(APPEND flash_project_args_json "\"${offset}\" : \"${image}\"") set_property(TARGET flash_project_args_target PROPERTY FLASH_PROJECT_ARGS_JSON "${flash_project_args_json}") endif() endfunction()