project.mk 22 KB

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