project.mk 20 KB

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