project_include.cmake 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138
  1. if(NOT IDF_BUILD_ARTIFACTS)
  2. return()
  3. endif()
  4. # Set some global esptool.py variables
  5. #
  6. # Many of these are read when generating flash_app_args & flash_project_args
  7. set(ESPTOOLPY ${PYTHON} "${CMAKE_CURRENT_LIST_DIR}/esptool/esptool.py" --chip esp32)
  8. set(ESPSECUREPY ${PYTHON} "${CMAKE_CURRENT_LIST_DIR}/esptool/espsecure.py")
  9. set(ESPEFUSEPY ${PYTHON} "${CMAKE_CURRENT_LIST_DIR}/esptool/espefuse.py")
  10. set(ESPFLASHMODE ${CONFIG_ESPTOOLPY_FLASHMODE})
  11. set(ESPFLASHFREQ ${CONFIG_ESPTOOLPY_FLASHFREQ})
  12. set(ESPFLASHSIZE ${CONFIG_ESPTOOLPY_FLASHSIZE})
  13. set(ESPTOOLPY_BEFORE "${CONFIG_ESPTOOLPY_BEFORE}")
  14. set(ESPTOOLPY_AFTER "${CONFIG_ESPTOOLPY_AFTER}")
  15. if(CONFIG_SECURE_BOOT_ENABLED OR CONFIG_FLASH_ENCRYPTION_ENABLED)
  16. # If security enabled then override post flash option
  17. set(ESPTOOLPY_AFTER "no_reset")
  18. endif()
  19. set(ESPTOOLPY_SERIAL "${ESPTOOLPY}"
  20. --port "${ESPPORT}"
  21. --baud ${ESPBAUD}
  22. --before "${ESPTOOLPY_BEFORE}"
  23. --after "${ESPTOOLPY_AFTER}"
  24. )
  25. if(CONFIG_ESPTOOLPY_COMPRESSED)
  26. set(ESPTOOLPY_COMPRESSED_OPT -z)
  27. else()
  28. set(ESPTOOLPY_COMPRESSED_OPT -u)
  29. endif()
  30. set(ESPTOOLPY_ELF2IMAGE_FLASH_OPTIONS
  31. --flash_mode ${ESPFLASHMODE}
  32. --flash_freq ${ESPFLASHFREQ}
  33. --flash_size ${ESPFLASHSIZE}
  34. )
  35. # String for printing flash command
  36. string(REPLACE ";" " " ESPTOOLPY_WRITE_FLASH_STR
  37. "${ESPTOOLPY} --port (PORT) --baud (BAUD) --before ${ESPTOOLPY_BEFORE} --after ${ESPTOOLPY_AFTER} "
  38. "write_flash ${ESPTOOLPY_ELF2IMAGE_FLASH_OPTIONS} ${ESPTOOLPY_EXTRA_FLASH_OPTIONS} ${ESPTOOLPY_COMPRESSED_OPT}")
  39. if(CONFIG_SECURE_BOOT_ENABLED AND
  40. NOT CONFIG_SECURE_BOOT_ALLOW_SHORT_APP_PARTITION AND
  41. NOT BOOTLOADER_BUILD)
  42. set(ESPTOOLPY_ELF2IMAGE_FLASH_OPTIONS
  43. ${ESPTOOLPY_ELF2IMAGE_FLASH_OPTIONS} --secure-pad)
  44. endif()
  45. if(NOT BOOTLOADER_BUILD)
  46. set(ESPTOOLPY_ELF2IMAGE_OPTIONS --elf-sha256-offset 0xb0)
  47. endif()
  48. if(CONFIG_ESP32_REV_MIN)
  49. set(ESPTOOLPY_ELF2IMAGE_OPTIONS ${ESPTOOLPY_ELF2IMAGE_OPTIONS} --min-rev ${CONFIG_ESP32_REV_MIN})
  50. endif()
  51. if(CONFIG_ESPTOOLPY_FLASHSIZE_DETECT)
  52. # Set ESPFLASHSIZE to 'detect' *after* elf2image options are generated,
  53. # as elf2image can't have 'detect' as an option...
  54. set(ESPFLASHSIZE detect)
  55. endif()
  56. get_filename_component(IDF_PROJECT_NAME ${IDF_PROJECT_EXECUTABLE} NAME_WE)
  57. if(CONFIG_SECURE_BOOT_BUILD_SIGNED_BINARIES AND NOT BOOTLOADER_BUILD)
  58. set(unsigned_project_binary "${IDF_PROJECT_NAME}-unsigned.bin")
  59. else()
  60. set(unsigned_project_binary "${IDF_PROJECT_NAME}.bin")
  61. endif()
  62. #
  63. # Add 'app.bin' target - generates with elf2image
  64. #
  65. add_custom_command(OUTPUT "${IDF_BUILD_ARTIFACTS_DIR}/${unsigned_project_binary}"
  66. COMMAND ${ESPTOOLPY} elf2image ${ESPTOOLPY_ELF2IMAGE_FLASH_OPTIONS} ${ESPTOOLPY_ELF2IMAGE_OPTIONS}
  67. -o "${IDF_BUILD_ARTIFACTS_DIR}/${unsigned_project_binary}" "${IDF_PROJECT_EXECUTABLE}"
  68. DEPENDS ${IDF_PROJECT_EXECUTABLE}
  69. VERBATIM
  70. WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
  71. )
  72. get_filename_component(IDF_PROJECT_BIN ${IDF_PROJECT_EXECUTABLE} NAME_WE)
  73. set(IDF_PROJECT_BIN ${IDF_PROJECT_BIN}.bin)
  74. if(NOT BOOTLOADER_BUILD AND
  75. CONFIG_SECURE_BOOT_BUILD_SIGNED_BINARIES)
  76. # for locally signed secure boot image, add a signing step to get from unsigned app to signed app
  77. add_custom_target(gen_unsigned_project_binary ALL DEPENDS "${IDF_BUILD_ARTIFACTS_DIR}/${unsigned_project_binary}")
  78. add_custom_command(OUTPUT "${IDF_BUILD_ARTIFACTS_DIR}/${IDF_PROJECT_BIN}"
  79. COMMAND ${ESPSECUREPY} sign_data --keyfile ${secure_boot_signing_key}
  80. -o "${IDF_BUILD_ARTIFACTS_DIR}/${IDF_PROJECT_BIN}" "${IDF_BUILD_ARTIFACTS_DIR}/${unsigned_project_binary}"
  81. DEPENDS gen_unsigned_project_binary
  82. VERBATIM
  83. )
  84. endif()
  85. if(NOT BOOTLOADER_BUILD)
  86. add_custom_target(app ALL DEPENDS "${IDF_BUILD_ARTIFACTS_DIR}/${IDF_PROJECT_BIN}")
  87. else()
  88. add_custom_target(bootloader ALL DEPENDS "${IDF_BUILD_ARTIFACTS_DIR}/${IDF_PROJECT_BIN}")
  89. endif()
  90. if(NOT BOOTLOADER_BUILD AND
  91. CONFIG_SECURE_BOOT_ENABLED AND
  92. NOT CONFIG_SECURE_BOOT_BUILD_SIGNED_BINARIES)
  93. add_custom_command(TARGET app POST_BUILD
  94. COMMAND ${CMAKE_COMMAND} -E echo
  95. "App built but not signed. Sign app before flashing"
  96. COMMAND ${CMAKE_COMMAND} -E echo
  97. "\t${ESPSECUREPY} sign_data --keyfile KEYFILE ${IDF_BUILD_ARTIFACTS_DIR}/${IDF_PROJECT_BIN}"
  98. VERBATIM)
  99. endif()
  100. #
  101. # Add 'flash' target - not all build systems can run this directly
  102. #
  103. function(esptool_py_custom_target target_name flasher_filename dependencies)
  104. add_custom_target(${target_name} DEPENDS ${dependencies}
  105. COMMAND ${CMAKE_COMMAND}
  106. -D IDF_PATH="${IDF_PATH}"
  107. -D ESPTOOLPY="${ESPTOOLPY}"
  108. -D ESPTOOL_ARGS="write_flash;@flash_${flasher_filename}_args"
  109. -D ESPTOOL_WORKING_DIR="${IDF_BUILD_ARTIFACTS_DIR}"
  110. -P ${IDF_PATH}/components/esptool_py/run_esptool.cmake
  111. WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR}
  112. USES_TERMINAL
  113. )
  114. endfunction()
  115. esptool_py_custom_target(flash project "app;partition_table;bootloader")
  116. esptool_py_custom_target(app-flash app "app")
  117. esptool_py_custom_target(bootloader-flash bootloader "bootloader")