project.mk 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529
  1. #
  2. # Main Project Makefile
  3. # This Makefile is included directly from the user project Makefile in order to call the component.mk
  4. # makefiles of all components (in a separate make process) to build all the libraries, then links them
  5. # together into the final file. If so, PWD is the project dir (we assume).
  6. #
  7. #
  8. # This makefile requires the environment variable IDF_PATH to be set to the top-level esp-idf directory
  9. # where this file is located.
  10. #
  11. .PHONY: build-components menuconfig defconfig all build clean all_binaries check-submodules size size-components size-files list-components
  12. all: all_binaries
  13. # see below for recipe of 'all' target
  14. #
  15. # # other components will add dependencies to 'all_binaries'. The
  16. # reason all_binaries is used instead of 'all' is so that the flash
  17. # target can build everything without triggering the per-component "to
  18. # flash..." output targets.)
  19. help:
  20. @echo "Welcome to Espressif IDF build system. Some useful make targets:"
  21. @echo ""
  22. @echo "make menuconfig - Configure IDF project"
  23. @echo "make defconfig - Set defaults for all new configuration options"
  24. @echo ""
  25. @echo "make all - Build app, bootloader, partition table"
  26. @echo "make flash - Flash app, bootloader, partition table to a chip"
  27. @echo "make clean - Remove all build output"
  28. @echo "make size - Display the static memory footprint of the app"
  29. @echo "make size-components, size-files - Finer-grained memory footprints"
  30. @echo "make erase_flash - Erase entire flash contents"
  31. @echo "make monitor - Run idf_monitor tool to monitor serial output from app"
  32. @echo "make simple_monitor - Monitor serial output on terminal console"
  33. @echo "make list-components - List all components in the project"
  34. @echo ""
  35. @echo "make app - Build just the app"
  36. @echo "make app-flash - Flash just the app"
  37. @echo "make app-clean - Clean just the app"
  38. @echo ""
  39. @echo "See also 'make bootloader', 'make bootloader-flash', 'make bootloader-clean', "
  40. @echo "'make partition_table', etc, etc."
  41. # dependency checks
  42. ifndef MAKE_RESTARTS
  43. ifeq ("$(filter 4.% 3.81 3.82,$(MAKE_VERSION))","")
  44. $(warning esp-idf build system only supports GNU Make versions 3.81 or newer. You may see unexpected results with other Makes.)
  45. endif
  46. ifdef MSYSTEM
  47. ifneq ("$(MSYSTEM)","MINGW32")
  48. $(warning esp-idf build system only supports MSYS2 in "MINGW32" mode. Consult the ESP-IDF documentation for details.)
  49. endif
  50. endif # MSYSTEM
  51. endif # MAKE_RESTARTS
  52. # can't run 'clean' along with any non-clean targets
  53. ifneq ("$(filter clean% %clean,$(MAKECMDGOALS))" ,"")
  54. ifneq ("$(filter-out clean% %clean,$(MAKECMDGOALS))", "")
  55. $(error esp-idf build system doesn't support running 'clean' targets along with any others. Run 'make clean' and then run other targets separately.)
  56. endif
  57. endif
  58. OS ?=
  59. # make IDF_PATH a "real" absolute path
  60. # * works around the case where a shell character is embedded in the environment variable value.
  61. # * changes Windows-style C:/blah/ paths to MSYS style /c/blah
  62. ifeq ("$(OS)","Windows_NT")
  63. # On Windows MSYS2, make wildcard function returns empty string for paths of form /xyz
  64. # where /xyz is a directory inside the MSYS root - so we don't use it.
  65. SANITISED_IDF_PATH:=$(realpath $(IDF_PATH))
  66. else
  67. SANITISED_IDF_PATH:=$(realpath $(wildcard $(IDF_PATH)))
  68. endif
  69. export IDF_PATH := $(SANITISED_IDF_PATH)
  70. ifndef IDF_PATH
  71. $(error IDF_PATH variable is not set to a valid directory.)
  72. endif
  73. ifneq ("$(IDF_PATH)","$(SANITISED_IDF_PATH)")
  74. # implies IDF_PATH was overriden on make command line.
  75. # Due to the way make manages variables, this is hard to account for
  76. #
  77. # if you see this error, do the shell expansion in the shell ie
  78. # make IDF_PATH=~/blah not make IDF_PATH="~/blah"
  79. $(error If IDF_PATH is overriden on command line, it must be an absolute path with no embedded shell special characters)
  80. endif
  81. ifneq ("$(IDF_PATH)","$(subst :,,$(IDF_PATH))")
  82. $(error IDF_PATH cannot contain colons. If overriding IDF_PATH on Windows, use MSYS Unix-style /c/dir instead of C:/dir)
  83. endif
  84. # disable built-in make rules, makes debugging saner
  85. MAKEFLAGS_OLD := $(MAKEFLAGS)
  86. MAKEFLAGS +=-rR
  87. # Default path to the project: we assume the Makefile including this file
  88. # is in the project directory
  89. ifndef PROJECT_PATH
  90. PROJECT_PATH := $(abspath $(dir $(firstword $(MAKEFILE_LIST))))
  91. export PROJECT_PATH
  92. endif
  93. # A list of the "common" makefiles, to use as a target dependency
  94. COMMON_MAKEFILES := $(abspath $(IDF_PATH)/make/project.mk $(IDF_PATH)/make/common.mk $(IDF_PATH)/make/component_wrapper.mk $(firstword $(MAKEFILE_LIST)))
  95. export COMMON_MAKEFILES
  96. # The directory where we put all objects/libraries/binaries. The project Makefile can
  97. # configure this if needed.
  98. ifndef BUILD_DIR_BASE
  99. BUILD_DIR_BASE := $(PROJECT_PATH)/build
  100. endif
  101. export BUILD_DIR_BASE
  102. # Component directories. These directories are searched for components (either the directory is a component,
  103. # or the directory contains subdirectories which are components.)
  104. # The project Makefile can override these component dirs, or add extras via EXTRA_COMPONENT_DIRS
  105. ifndef COMPONENT_DIRS
  106. EXTRA_COMPONENT_DIRS ?=
  107. COMPONENT_DIRS := $(PROJECT_PATH)/components $(EXTRA_COMPONENT_DIRS) $(IDF_PATH)/components $(PROJECT_PATH)/main
  108. endif
  109. export COMPONENT_DIRS
  110. ifdef SRCDIRS
  111. $(warning SRCDIRS variable is deprecated. These paths can be added to EXTRA_COMPONENT_DIRS or COMPONENT_DIRS instead.)
  112. COMPONENT_DIRS += $(abspath $(SRCDIRS))
  113. endif
  114. # The project Makefile can define a list of components, but if it does not do this we just take all available components
  115. # in the component dirs. A component is COMPONENT_DIRS directory, or immediate subdirectory,
  116. # which contains a component.mk file.
  117. #
  118. # Use the "make list-components" target to debug this step.
  119. ifndef COMPONENTS
  120. # Find all component names. The component names are the same as the
  121. # directories they're in, so /bla/components/mycomponent/component.mk -> mycomponent.
  122. COMPONENTS := $(dir $(foreach cd,$(COMPONENT_DIRS), \
  123. $(wildcard $(cd)/*/component.mk) $(wildcard $(cd)/component.mk) \
  124. ))
  125. COMPONENTS := $(sort $(foreach comp,$(COMPONENTS),$(lastword $(subst /, ,$(comp)))))
  126. endif
  127. export COMPONENTS
  128. # Resolve all of COMPONENTS into absolute paths in COMPONENT_PATHS.
  129. #
  130. # If a component name exists in multiple COMPONENT_DIRS, we take the first match.
  131. #
  132. # NOTE: These paths must be generated WITHOUT a trailing / so we
  133. # can use $(notdir x) to get the component name.
  134. COMPONENT_PATHS := $(foreach comp,$(COMPONENTS),$(firstword $(foreach cd,$(COMPONENT_DIRS),$(wildcard $(dir $(cd))$(comp) $(cd)/$(comp)))))
  135. TEST_COMPONENTS ?=
  136. TESTS_ALL ?=
  137. # If TESTS_ALL set to 1, set TEST_COMPONENTS_LIST to all components.
  138. # Otherwise, use the list supplied in TEST_COMPONENTS.
  139. ifeq ($(TESTS_ALL),1)
  140. TEST_COMPONENTS_LIST := $(COMPONENTS)
  141. else
  142. TEST_COMPONENTS_LIST := $(TEST_COMPONENTS)
  143. endif
  144. TEST_COMPONENT_PATHS := $(foreach comp,$(TEST_COMPONENTS_LIST),$(firstword $(foreach dir,$(COMPONENT_DIRS),$(wildcard $(dir)/$(comp)/test))))
  145. TEST_COMPONENT_NAMES := $(foreach comp,$(TEST_COMPONENT_PATHS),$(lastword $(subst /, ,$(dir $(comp))))_test)
  146. # Initialise project-wide variables which can be added to by
  147. # each component.
  148. #
  149. # These variables are built up via the component_project_vars.mk
  150. # generated makefiles (one per component).
  151. #
  152. # See docs/build-system.rst for more details.
  153. COMPONENT_INCLUDES :=
  154. COMPONENT_LDFLAGS :=
  155. COMPONENT_SUBMODULES :=
  156. COMPONENT_LIBRARIES :=
  157. # COMPONENT_PROJECT_VARS is the list of component_project_vars.mk generated makefiles
  158. # for each component.
  159. #
  160. # Including $(COMPONENT_PROJECT_VARS) builds the COMPONENT_INCLUDES,
  161. # COMPONENT_LDFLAGS variables and also targets for any inter-component
  162. # dependencies.
  163. #
  164. # See the component_project_vars.mk target in component_wrapper.mk
  165. COMPONENT_PROJECT_VARS := $(addsuffix /component_project_vars.mk,$(notdir $(COMPONENT_PATHS) ) $(TEST_COMPONENT_NAMES))
  166. COMPONENT_PROJECT_VARS := $(addprefix $(BUILD_DIR_BASE)/,$(COMPONENT_PROJECT_VARS))
  167. # this line is -include instead of include to prevent a spurious error message on make 3.81
  168. -include $(COMPONENT_PROJECT_VARS)
  169. # Also add top-level project include path, for top-level includes
  170. COMPONENT_INCLUDES += $(abspath $(BUILD_DIR_BASE)/include/)
  171. export COMPONENT_INCLUDES
  172. # Set variables common to both project & component
  173. include $(IDF_PATH)/make/common.mk
  174. all:
  175. ifdef CONFIG_SECURE_BOOT_ENABLED
  176. @echo "(Secure boot enabled, so bootloader not flashed automatically. See 'make bootloader' output)"
  177. ifndef CONFIG_SECURE_BOOT_BUILD_SIGNED_BINARIES
  178. @echo "App built but not signed. Sign app & partition data before flashing, via espsecure.py:"
  179. @echo "espsecure.py sign_data --keyfile KEYFILE $(APP_BIN)"
  180. @echo "espsecure.py sign_data --keyfile KEYFILE $(PARTITION_TABLE_BIN)"
  181. endif
  182. @echo "To flash app & partition table, run 'make flash' or:"
  183. else
  184. @echo "To flash all build output, run 'make flash' or:"
  185. endif
  186. @echo $(ESPTOOLPY_WRITE_FLASH) $(ESPTOOL_ALL_FLASH_ARGS)
  187. IDF_VER := $(shell cd ${IDF_PATH} && git describe --always --tags --dirty)
  188. # Set default LDFLAGS
  189. EXTRA_LDFLAGS ?=
  190. LDFLAGS ?= -nostdlib \
  191. -u call_user_start_cpu0 \
  192. $(EXTRA_LDFLAGS) \
  193. -Wl,--gc-sections \
  194. -Wl,-static \
  195. -Wl,--start-group \
  196. $(COMPONENT_LDFLAGS) \
  197. -lgcc \
  198. -lstdc++ \
  199. -lgcov \
  200. -Wl,--end-group \
  201. -Wl,-EL
  202. # Set default CPPFLAGS, CFLAGS, CXXFLAGS
  203. # These are exported so that components can use them when compiling.
  204. # If you need your component to add CFLAGS/etc for it's own source compilation only, set CFLAGS += in your component's Makefile.
  205. # If you need your component to add CFLAGS/etc globally for all source
  206. # files, set CFLAGS += in your component's Makefile.projbuild
  207. # If you need to set CFLAGS/CPPFLAGS/CXXFLAGS at project level, set them in application Makefile
  208. # before including project.mk. Default flags will be added before the ones provided in application Makefile.
  209. # CPPFLAGS used by C preprocessor
  210. # If any flags are defined in application Makefile, add them at the end.
  211. CPPFLAGS ?=
  212. EXTRA_CPPFLAGS ?=
  213. CPPFLAGS := -DESP_PLATFORM -D IDF_VER=\"$(IDF_VER)\" -MMD -MP $(CPPFLAGS) $(EXTRA_CPPFLAGS)
  214. # Warnings-related flags relevant both for C and C++
  215. COMMON_WARNING_FLAGS = -Wall -Werror=all \
  216. -Wno-error=unused-function \
  217. -Wno-error=unused-but-set-variable \
  218. -Wno-error=unused-variable \
  219. -Wno-error=deprecated-declarations \
  220. -Wextra \
  221. -Wno-unused-parameter -Wno-sign-compare
  222. # Flags which control code generation and dependency generation, both for C and C++
  223. COMMON_FLAGS = \
  224. -ffunction-sections -fdata-sections \
  225. -fstrict-volatile-bitfields \
  226. -mlongcalls \
  227. -nostdlib
  228. # Optimization flags are set based on menuconfig choice
  229. ifdef CONFIG_OPTIMIZATION_LEVEL_RELEASE
  230. OPTIMIZATION_FLAGS = -Os
  231. else
  232. OPTIMIZATION_FLAGS = -Og
  233. endif
  234. ifdef CONFIG_OPTIMIZATION_ASSERTIONS_DISABLED
  235. CPPFLAGS += -DNDEBUG
  236. endif
  237. # Enable generation of debugging symbols
  238. # (we generate even in Release mode, as this has no impact on final binary size.)
  239. DEBUG_FLAGS ?= -ggdb
  240. # List of flags to pass to C compiler
  241. # If any flags are defined in application Makefile, add them at the end.
  242. CFLAGS ?=
  243. EXTRA_CFLAGS ?=
  244. CFLAGS := $(strip \
  245. -std=gnu99 \
  246. $(OPTIMIZATION_FLAGS) $(DEBUG_FLAGS) \
  247. $(COMMON_FLAGS) \
  248. $(COMMON_WARNING_FLAGS) -Wno-old-style-declaration \
  249. $(CFLAGS) \
  250. $(EXTRA_CFLAGS))
  251. # List of flags to pass to C++ compiler
  252. # If any flags are defined in application Makefile, add them at the end.
  253. CXXFLAGS ?=
  254. EXTRA_CXXFLAGS ?=
  255. CXXFLAGS := $(strip \
  256. -std=gnu++11 \
  257. -fno-rtti \
  258. $(OPTIMIZATION_FLAGS) $(DEBUG_FLAGS) \
  259. $(COMMON_FLAGS) \
  260. $(COMMON_WARNING_FLAGS) \
  261. $(CXXFLAGS) \
  262. $(EXTRA_CXXFLAGS))
  263. ifdef CONFIG_CXX_EXCEPTIONS
  264. CXXFLAGS += -fexceptions
  265. else
  266. CXXFLAGS += -fno-exceptions
  267. endif
  268. export CFLAGS CPPFLAGS CXXFLAGS
  269. # Set host compiler and binutils
  270. HOSTCC := $(CC)
  271. HOSTLD := $(LD)
  272. HOSTAR := $(AR)
  273. ifdef OBJCOPY
  274. HOSTOBJCOPY := $(OBJCOPY)
  275. else
  276. HOSTOBJCOPY := objcopy
  277. endif
  278. ifdef SIZE
  279. HOSTSIZE := $(SIZE)
  280. else
  281. HOSTSIZE := size
  282. endif
  283. export HOSTCC HOSTLD HOSTAR HOSTOBJCOPY SIZE
  284. # Set target compiler. Defaults to whatever the user has
  285. # configured as prefix + ye olde gcc commands
  286. CC := $(call dequote,$(CONFIG_TOOLPREFIX))gcc
  287. CXX := $(call dequote,$(CONFIG_TOOLPREFIX))c++
  288. LD := $(call dequote,$(CONFIG_TOOLPREFIX))ld
  289. AR := $(call dequote,$(CONFIG_TOOLPREFIX))ar
  290. OBJCOPY := $(call dequote,$(CONFIG_TOOLPREFIX))objcopy
  291. SIZE := $(call dequote,$(CONFIG_TOOLPREFIX))size
  292. export CC CXX LD AR OBJCOPY SIZE
  293. PYTHON=$(call dequote,$(CONFIG_PYTHON))
  294. # the app is the main executable built by the project
  295. APP_ELF:=$(BUILD_DIR_BASE)/$(PROJECT_NAME).elf
  296. APP_MAP:=$(APP_ELF:.elf=.map)
  297. APP_BIN:=$(APP_ELF:.elf=.bin)
  298. # Include any Makefile.projbuild file letting components add
  299. # configuration at the project level
  300. define includeProjBuildMakefile
  301. $(if $(V),$(info including $(1)/Makefile.projbuild...))
  302. COMPONENT_PATH := $(1)
  303. include $(1)/Makefile.projbuild
  304. endef
  305. $(foreach componentpath,$(COMPONENT_PATHS), \
  306. $(if $(wildcard $(componentpath)/Makefile.projbuild), \
  307. $(eval $(call includeProjBuildMakefile,$(componentpath)))))
  308. # once we know component paths, we can include the config generation targets
  309. #
  310. # (bootloader build doesn't need this, config is exported from top-level)
  311. ifndef IS_BOOTLOADER_BUILD
  312. include $(IDF_PATH)/make/project_config.mk
  313. endif
  314. # ELF depends on the library archive files for COMPONENT_LIBRARIES
  315. # the rules to build these are emitted as part of GenerateComponentTarget below
  316. #
  317. # also depends on additional dependencies (linker scripts & binary libraries)
  318. # stored in COMPONENT_LINKER_DEPS, built via component.mk files' COMPONENT_ADD_LINKER_DEPS variable
  319. COMPONENT_LINKER_DEPS ?=
  320. $(APP_ELF): $(foreach libcomp,$(COMPONENT_LIBRARIES),$(BUILD_DIR_BASE)/$(libcomp)/lib$(libcomp).a) $(COMPONENT_LINKER_DEPS) $(COMPONENT_PROJECT_VARS)
  321. $(summary) LD $(patsubst $(PWD)/%,%,$@)
  322. $(CC) $(LDFLAGS) -o $@ -Wl,-Map=$(APP_MAP)
  323. app: $(APP_BIN)
  324. ifeq ("$(CONFIG_SECURE_BOOT_ENABLED)$(CONFIG_SECURE_BOOT_BUILD_SIGNED_BINARIES)","y") # secure boot enabled, but remote sign app image
  325. @echo "App built but not signed. Signing step via espsecure.py:"
  326. @echo "espsecure.py sign_data --keyfile KEYFILE $(APP_BIN)"
  327. @echo "Then flash app command is:"
  328. @echo $(ESPTOOLPY_WRITE_FLASH) $(CONFIG_APP_OFFSET) $(APP_BIN)
  329. else
  330. @echo "App built. Default flash app command is:"
  331. @echo $(ESPTOOLPY_WRITE_FLASH) $(CONFIG_APP_OFFSET) $(APP_BIN)
  332. endif
  333. all_binaries: $(APP_BIN)
  334. $(BUILD_DIR_BASE):
  335. mkdir -p $(BUILD_DIR_BASE)
  336. # Macro for the recursive sub-make for each component
  337. # $(1) - component directory
  338. # $(2) - component name only
  339. #
  340. # Is recursively expanded by the GenerateComponentTargets macro
  341. define ComponentMake
  342. +$(MAKE) -C $(BUILD_DIR_BASE)/$(2) -f $(IDF_PATH)/make/component_wrapper.mk COMPONENT_MAKEFILE=$(1)/component.mk COMPONENT_NAME=$(2)
  343. endef
  344. # Generate top-level component-specific targets for each component
  345. # $(1) - path to component dir
  346. # $(2) - name of component
  347. #
  348. define GenerateComponentTargets
  349. .PHONY: component-$(2)-build component-$(2)-clean
  350. component-$(2)-build: check-submodules $(call prereq_if_explicit, component-$(2)-clean) | $(BUILD_DIR_BASE)/$(2)
  351. $(call ComponentMake,$(1),$(2)) build
  352. component-$(2)-clean: | $(BUILD_DIR_BASE)/$(2) $(BUILD_DIR_BASE)/$(2)/component_project_vars.mk
  353. $(call ComponentMake,$(1),$(2)) clean
  354. $(BUILD_DIR_BASE)/$(2):
  355. @mkdir -p $(BUILD_DIR_BASE)/$(2)
  356. # tell make it can build any component's library by invoking the -build target
  357. # (this target exists for all components even ones which don't build libraries, but it's
  358. # only invoked for the targets whose libraries appear in COMPONENT_LIBRARIES and hence the
  359. # APP_ELF dependencies.)
  360. $(BUILD_DIR_BASE)/$(2)/lib$(2).a: component-$(2)-build
  361. $(details) "Target '$$^' responsible for '$$@'" # echo which build target built this file
  362. # add a target to generate the component_project_vars.mk files that
  363. # are used to inject variables into project make pass (see matching
  364. # component_project_vars.mk target in component_wrapper.mk).
  365. #
  366. # If any component_project_vars.mk file is out of date, the make
  367. # process will call this target to rebuild it and then restart.
  368. #
  369. $(BUILD_DIR_BASE)/$(2)/component_project_vars.mk: $(1)/component.mk $(COMMON_MAKEFILES) $(SDKCONFIG_MAKEFILE) | $(BUILD_DIR_BASE)/$(2)
  370. $(call ComponentMake,$(1),$(2)) component_project_vars.mk
  371. endef
  372. $(foreach component,$(COMPONENT_PATHS),$(eval $(call GenerateComponentTargets,$(component),$(notdir $(component)))))
  373. $(foreach component,$(TEST_COMPONENT_PATHS),$(eval $(call GenerateComponentTargets,$(component),$(lastword $(subst /, ,$(dir $(component))))_test)))
  374. app-clean: $(addprefix component-,$(addsuffix -clean,$(notdir $(COMPONENT_PATHS))))
  375. $(summary) RM $(APP_ELF)
  376. rm -f $(APP_ELF) $(APP_BIN) $(APP_MAP)
  377. size: $(APP_ELF)
  378. $(PYTHON) $(IDF_PATH)/tools/idf_size.py $(APP_MAP)
  379. size-files: $(APP_ELF)
  380. $(PYTHON) $(IDF_PATH)/tools/idf_size.py --files $(APP_MAP)
  381. size-components: $(APP_ELF)
  382. $(PYTHON) $(IDF_PATH)/tools/idf_size.py --archives $(APP_MAP)
  383. # NB: this ordering is deliberate (app-clean & bootloader-clean before
  384. # _config-clean), so config remains valid during all component clean
  385. # targets
  386. config-clean: app-clean bootloader-clean
  387. clean: app-clean bootloader-clean config-clean
  388. # phony target to check if any git submodule listed in COMPONENT_SUBMODULES are missing
  389. # or out of date, and exit if so. Components can add paths to this variable.
  390. #
  391. # This only works for components inside IDF_PATH
  392. check-submodules:
  393. # Dump the git status for the whole working copy once, then grep it for each submodule. This saves a lot of time on Windows.
  394. GIT_STATUS := $(shell cd ${IDF_PATH} && git status --porcelain --ignore-submodules=dirty)
  395. # Generate a target to check this submodule
  396. # $(1) - submodule directory, relative to IDF_PATH
  397. define GenerateSubmoduleCheckTarget
  398. check-submodules: $(IDF_PATH)/$(1)/.git
  399. $(IDF_PATH)/$(1)/.git:
  400. @echo "WARNING: Missing submodule $(1)..."
  401. [ -e ${IDF_PATH}/.git ] || ( echo "ERROR: esp-idf must be cloned from git to work."; exit 1)
  402. [ -x $$(which git) ] || ( echo "ERROR: Need to run 'git submodule init $(1)' in esp-idf root directory."; exit 1)
  403. @echo "Attempting 'git submodule update --init $(1)' in esp-idf root directory..."
  404. cd ${IDF_PATH} && git submodule update --init $(1)
  405. # Parse 'git status' output to check if the submodule commit is different to expected
  406. ifneq ("$(filter $(1),$(GIT_STATUS))","")
  407. $$(info WARNING: esp-idf git submodule $(1) may be out of date. Run 'git submodule update' in IDF_PATH dir to update.)
  408. endif
  409. endef
  410. # filter/subst in expression ensures all submodule paths begin with $(IDF_PATH), and then strips that prefix
  411. # so the argument is suitable for use with 'git submodule' commands
  412. $(foreach submodule,$(subst $(IDF_PATH)/,,$(filter $(IDF_PATH)/%,$(COMPONENT_SUBMODULES))),$(eval $(call GenerateSubmoduleCheckTarget,$(submodule))))
  413. # PHONY target to list components in the build and their paths
  414. list-components:
  415. $(info $(call dequote,$(SEPARATOR)))
  416. $(info COMPONENT_DIRS (components searched for here))
  417. $(foreach cd,$(COMPONENT_DIRS),$(info $(cd)))
  418. $(info $(call dequote,$(SEPARATOR)))
  419. $(info COMPONENTS (list of component names))
  420. $(info $(COMPONENTS))
  421. $(info $(call dequote,$(SEPARATOR)))
  422. $(info COMPONENT_PATHS (paths to all components):)
  423. $(foreach cp,$(COMPONENT_PATHS),$(info $(cp)))
  424. # Check toolchain version using the output of xtensa-esp32-elf-gcc --version command.
  425. # The output normally looks as follows
  426. # xtensa-esp32-elf-gcc (crosstool-NG crosstool-ng-1.22.0-59-ga194053) 4.8.5
  427. # The part in brackets is extracted into TOOLCHAIN_COMMIT_DESC variable,
  428. # the part after the brackets is extracted into TOOLCHAIN_GCC_VER.
  429. ifdef CONFIG_TOOLPREFIX
  430. ifndef MAKE_RESTARTS
  431. TOOLCHAIN_COMMIT_DESC := $(shell $(CC) --version | sed -E -n 's|.*crosstool-ng-([0-9]+).([0-9]+).([0-9]+)-([0-9]+)-g([0-9a-f]{7}).*|\1.\2.\3-\4-g\5|gp')
  432. TOOLCHAIN_GCC_VER := $(shell $(CC) --version | sed -E -n 's|xtensa-esp32-elf-gcc.*\ \(.*\)\ (.*)|\1|gp')
  433. # Officially supported version(s)
  434. SUPPORTED_TOOLCHAIN_COMMIT_DESC := 1.22.0-73-ge28a011
  435. SUPPORTED_TOOLCHAIN_GCC_VERSIONS := 5.2.0
  436. ifdef TOOLCHAIN_COMMIT_DESC
  437. ifneq ($(TOOLCHAIN_COMMIT_DESC), $(SUPPORTED_TOOLCHAIN_COMMIT_DESC))
  438. $(info WARNING: Toolchain version is not supported: $(TOOLCHAIN_COMMIT_DESC))
  439. $(info Expected to see version: $(SUPPORTED_TOOLCHAIN_COMMIT_DESC))
  440. $(info Please check ESP-IDF setup instructions and update the toolchain, or proceed at your own risk.)
  441. endif
  442. ifeq (,$(findstring $(TOOLCHAIN_GCC_VER), $(SUPPORTED_TOOLCHAIN_GCC_VERSIONS)))
  443. $(info WARNING: Compiler version is not supported: $(TOOLCHAIN_GCC_VER))
  444. $(info Expected to see version(s): $(SUPPORTED_TOOLCHAIN_GCC_VERSIONS))
  445. $(info Please check ESP-IDF setup instructions and update the toolchain, or proceed at your own risk.)
  446. endif
  447. else
  448. $(info WARNING: Failed to find Xtensa toolchain, may need to alter PATH or set one in the configuration menu)
  449. endif # TOOLCHAIN_COMMIT_DESC
  450. endif #MAKE_RESTARTS
  451. endif #CONFIG_TOOLPREFIX