project.mk 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579
  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 $(EXCLUDE_COMPONENTS), $(COMPONENTS))
  135. endif
  136. export COMPONENTS
  137. # Resolve all of COMPONENTS into absolute paths in COMPONENT_PATHS.
  138. #
  139. # If a component name exists in multiple COMPONENT_DIRS, we take the first match.
  140. #
  141. # NOTE: These paths must be generated WITHOUT a trailing / so we
  142. # can use $(notdir x) to get the component name.
  143. COMPONENT_PATHS := $(foreach comp,$(COMPONENTS),$(firstword $(foreach cd,$(COMPONENT_DIRS),$(wildcard $(dir $(cd))$(comp) $(cd)/$(comp)))))
  144. export COMPONENT_PATHS
  145. TEST_COMPONENTS ?=
  146. TESTS_ALL ?=
  147. # If TESTS_ALL set to 1, set TEST_COMPONENTS_LIST to all components.
  148. # Otherwise, use the list supplied in TEST_COMPONENTS.
  149. ifeq ($(TESTS_ALL),1)
  150. TEST_COMPONENTS_LIST := $(COMPONENTS)
  151. else
  152. TEST_COMPONENTS_LIST := $(TEST_COMPONENTS)
  153. endif
  154. TEST_COMPONENT_PATHS := $(foreach comp,$(TEST_COMPONENTS_LIST),$(firstword $(foreach dir,$(COMPONENT_DIRS),$(wildcard $(dir)/$(comp)/test))))
  155. TEST_COMPONENT_NAMES := $(foreach comp,$(TEST_COMPONENT_PATHS),$(lastword $(subst /, ,$(dir $(comp))))_test)
  156. # Initialise project-wide variables which can be added to by
  157. # each component.
  158. #
  159. # These variables are built up via the component_project_vars.mk
  160. # generated makefiles (one per component).
  161. #
  162. # See docs/build-system.rst for more details.
  163. COMPONENT_INCLUDES :=
  164. COMPONENT_LDFLAGS :=
  165. COMPONENT_SUBMODULES :=
  166. COMPONENT_LIBRARIES :=
  167. # COMPONENT_PROJECT_VARS is the list of component_project_vars.mk generated makefiles
  168. # for each component.
  169. #
  170. # Including $(COMPONENT_PROJECT_VARS) builds the COMPONENT_INCLUDES,
  171. # COMPONENT_LDFLAGS variables and also targets for any inter-component
  172. # dependencies.
  173. #
  174. # See the component_project_vars.mk target in component_wrapper.mk
  175. COMPONENT_PROJECT_VARS := $(addsuffix /component_project_vars.mk,$(notdir $(COMPONENT_PATHS) ) $(TEST_COMPONENT_NAMES))
  176. COMPONENT_PROJECT_VARS := $(addprefix $(BUILD_DIR_BASE)/,$(COMPONENT_PROJECT_VARS))
  177. # this line is -include instead of include to prevent a spurious error message on make 3.81
  178. -include $(COMPONENT_PROJECT_VARS)
  179. # Also add top-level project include path, for top-level includes
  180. COMPONENT_INCLUDES += $(abspath $(BUILD_DIR_BASE)/include/)
  181. export COMPONENT_INCLUDES
  182. # Set variables common to both project & component
  183. include $(IDF_PATH)/make/common.mk
  184. all:
  185. ifdef CONFIG_SECURE_BOOT_ENABLED
  186. @echo "(Secure boot enabled, so bootloader not flashed automatically. See 'make bootloader' output)"
  187. ifndef CONFIG_SECURE_BOOT_BUILD_SIGNED_BINARIES
  188. @echo "App built but not signed. Sign app & partition data before flashing, via espsecure.py:"
  189. @echo "espsecure.py sign_data --keyfile KEYFILE $(APP_BIN)"
  190. @echo "espsecure.py sign_data --keyfile KEYFILE $(PARTITION_TABLE_BIN)"
  191. endif
  192. @echo "To flash app & partition table, run 'make flash' or:"
  193. else
  194. @echo "To flash all build output, run 'make flash' or:"
  195. endif
  196. @echo $(ESPTOOLPY_WRITE_FLASH) $(ESPTOOL_ALL_FLASH_ARGS)
  197. # If we have `version.txt` then prefer that for extracting IDF version
  198. ifeq ("$(wildcard ${IDF_PATH}/version.txt)","")
  199. IDF_VER := $(shell cd ${IDF_PATH} && git describe --always --tags --dirty)
  200. else
  201. IDF_VER := `cat ${IDF_PATH}/version.txt`
  202. endif
  203. # Set default LDFLAGS
  204. EXTRA_LDFLAGS ?=
  205. LDFLAGS ?= -nostdlib \
  206. -u call_user_start_cpu0 \
  207. $(EXTRA_LDFLAGS) \
  208. -Wl,--gc-sections \
  209. -Wl,-static \
  210. -Wl,--start-group \
  211. $(COMPONENT_LDFLAGS) \
  212. -lgcc \
  213. -lstdc++ \
  214. -lgcov \
  215. -Wl,--end-group \
  216. -Wl,-EL
  217. # Set default CPPFLAGS, CFLAGS, CXXFLAGS
  218. # These are exported so that components can use them when compiling.
  219. # If you need your component to add CFLAGS/etc for it's own source compilation only, set CFLAGS += in your component's Makefile.
  220. # If you need your component to add CFLAGS/etc globally for all source
  221. # files, set CFLAGS += in your component's Makefile.projbuild
  222. # If you need to set CFLAGS/CPPFLAGS/CXXFLAGS at project level, set them in application Makefile
  223. # before including project.mk. Default flags will be added before the ones provided in application Makefile.
  224. # CPPFLAGS used by C preprocessor
  225. # If any flags are defined in application Makefile, add them at the end.
  226. CPPFLAGS ?=
  227. EXTRA_CPPFLAGS ?=
  228. CPPFLAGS := -DESP_PLATFORM -D IDF_VER=\"$(IDF_VER)\" -MMD -MP $(CPPFLAGS) $(EXTRA_CPPFLAGS)
  229. # Warnings-related flags relevant both for C and C++
  230. COMMON_WARNING_FLAGS = -Wall -Werror=all \
  231. -Wno-error=unused-function \
  232. -Wno-error=unused-but-set-variable \
  233. -Wno-error=unused-variable \
  234. -Wno-error=deprecated-declarations \
  235. -Wextra \
  236. -Wno-unused-parameter -Wno-sign-compare
  237. ifdef CONFIG_WARN_WRITE_STRINGS
  238. COMMON_WARNING_FLAGS += -Wwrite-strings
  239. endif #CONFIG_WARN_WRITE_STRINGS
  240. # Flags which control code generation and dependency generation, both for C and C++
  241. COMMON_FLAGS = \
  242. -ffunction-sections -fdata-sections \
  243. -fstrict-volatile-bitfields \
  244. -mlongcalls \
  245. -nostdlib
  246. ifndef IS_BOOTLOADER_BUILD
  247. # stack protection (only one option can be selected in menuconfig)
  248. ifdef CONFIG_STACK_CHECK_NORM
  249. COMMON_FLAGS += -fstack-protector
  250. endif
  251. ifdef CONFIG_STACK_CHECK_STRONG
  252. COMMON_FLAGS += -fstack-protector-strong
  253. endif
  254. ifdef CONFIG_STACK_CHECK_ALL
  255. COMMON_FLAGS += -fstack-protector-all
  256. endif
  257. endif
  258. # Optimization flags are set based on menuconfig choice
  259. ifdef CONFIG_OPTIMIZATION_LEVEL_RELEASE
  260. OPTIMIZATION_FLAGS = -Os
  261. else
  262. OPTIMIZATION_FLAGS = -Og
  263. endif
  264. ifdef CONFIG_OPTIMIZATION_ASSERTIONS_DISABLED
  265. CPPFLAGS += -DNDEBUG
  266. endif
  267. # Enable generation of debugging symbols
  268. # (we generate even in Release mode, as this has no impact on final binary size.)
  269. DEBUG_FLAGS ?= -ggdb
  270. # List of flags to pass to C compiler
  271. # If any flags are defined in application Makefile, add them at the end.
  272. CFLAGS ?=
  273. EXTRA_CFLAGS ?=
  274. CFLAGS := $(strip \
  275. -std=gnu99 \
  276. $(OPTIMIZATION_FLAGS) $(DEBUG_FLAGS) \
  277. $(COMMON_FLAGS) \
  278. $(COMMON_WARNING_FLAGS) -Wno-old-style-declaration \
  279. $(CFLAGS) \
  280. $(EXTRA_CFLAGS))
  281. # List of flags to pass to C++ compiler
  282. # If any flags are defined in application Makefile, add them at the end.
  283. CXXFLAGS ?=
  284. EXTRA_CXXFLAGS ?=
  285. CXXFLAGS := $(strip \
  286. -std=gnu++11 \
  287. -fno-rtti \
  288. $(OPTIMIZATION_FLAGS) $(DEBUG_FLAGS) \
  289. $(COMMON_FLAGS) \
  290. $(COMMON_WARNING_FLAGS) \
  291. $(CXXFLAGS) \
  292. $(EXTRA_CXXFLAGS))
  293. ifdef CONFIG_CXX_EXCEPTIONS
  294. CXXFLAGS += -fexceptions
  295. else
  296. CXXFLAGS += -fno-exceptions
  297. endif
  298. export CFLAGS CPPFLAGS CXXFLAGS
  299. # Set default values that were not previously defined
  300. CC ?= gcc
  301. LD ?= ld
  302. AR ?= ar
  303. OBJCOPY ?= objcopy
  304. SIZE ?= size
  305. # Set host compiler and binutils
  306. HOSTCC := $(CC)
  307. HOSTLD := $(LD)
  308. HOSTAR := $(AR)
  309. HOSTOBJCOPY := $(OBJCOPY)
  310. HOSTSIZE := $(SIZE)
  311. export HOSTCC HOSTLD HOSTAR HOSTOBJCOPY SIZE
  312. # Set target compiler. Defaults to whatever the user has
  313. # configured as prefix + ye olde gcc commands
  314. CC := $(call dequote,$(CONFIG_TOOLPREFIX))gcc
  315. CXX := $(call dequote,$(CONFIG_TOOLPREFIX))c++
  316. LD := $(call dequote,$(CONFIG_TOOLPREFIX))ld
  317. AR := $(call dequote,$(CONFIG_TOOLPREFIX))ar
  318. OBJCOPY := $(call dequote,$(CONFIG_TOOLPREFIX))objcopy
  319. SIZE := $(call dequote,$(CONFIG_TOOLPREFIX))size
  320. export CC CXX LD AR OBJCOPY SIZE
  321. PYTHON=$(call dequote,$(CONFIG_PYTHON))
  322. # the app is the main executable built by the project
  323. APP_ELF:=$(BUILD_DIR_BASE)/$(PROJECT_NAME).elf
  324. APP_MAP:=$(APP_ELF:.elf=.map)
  325. APP_BIN:=$(APP_ELF:.elf=.bin)
  326. # Include any Makefile.projbuild file letting components add
  327. # configuration at the project level
  328. define includeProjBuildMakefile
  329. $(if $(V),$$(info including $(1)/Makefile.projbuild...))
  330. COMPONENT_PATH := $(1)
  331. include $(1)/Makefile.projbuild
  332. endef
  333. $(foreach componentpath,$(COMPONENT_PATHS), \
  334. $(if $(wildcard $(componentpath)/Makefile.projbuild), \
  335. $(eval $(call includeProjBuildMakefile,$(componentpath)))))
  336. # once we know component paths, we can include the config generation targets
  337. #
  338. # (bootloader build doesn't need this, config is exported from top-level)
  339. ifndef IS_BOOTLOADER_BUILD
  340. include $(IDF_PATH)/make/project_config.mk
  341. endif
  342. # ELF depends on the library archive files for COMPONENT_LIBRARIES
  343. # the rules to build these are emitted as part of GenerateComponentTarget below
  344. #
  345. # also depends on additional dependencies (linker scripts & binary libraries)
  346. # stored in COMPONENT_LINKER_DEPS, built via component.mk files' COMPONENT_ADD_LINKER_DEPS variable
  347. COMPONENT_LINKER_DEPS ?=
  348. $(APP_ELF): $(foreach libcomp,$(COMPONENT_LIBRARIES),$(BUILD_DIR_BASE)/$(libcomp)/lib$(libcomp).a) $(COMPONENT_LINKER_DEPS) $(COMPONENT_PROJECT_VARS)
  349. $(summary) LD $(patsubst $(PWD)/%,%,$@)
  350. $(CC) $(LDFLAGS) -o $@ -Wl,-Map=$(APP_MAP)
  351. app: $(APP_BIN)
  352. ifeq ("$(CONFIG_SECURE_BOOT_ENABLED)$(CONFIG_SECURE_BOOT_BUILD_SIGNED_BINARIES)","y") # secure boot enabled, but remote sign app image
  353. @echo "App built but not signed. Signing step via espsecure.py:"
  354. @echo "espsecure.py sign_data --keyfile KEYFILE $(APP_BIN)"
  355. @echo "Then flash app command is:"
  356. @echo $(ESPTOOLPY_WRITE_FLASH) $(CONFIG_APP_OFFSET) $(APP_BIN)
  357. else
  358. @echo "App built. Default flash app command is:"
  359. @echo $(ESPTOOLPY_WRITE_FLASH) $(CONFIG_APP_OFFSET) $(APP_BIN)
  360. endif
  361. all_binaries: $(APP_BIN)
  362. $(BUILD_DIR_BASE):
  363. mkdir -p $(BUILD_DIR_BASE)
  364. # Macro for the recursive sub-make for each component
  365. # $(1) - component directory
  366. # $(2) - component name only
  367. #
  368. # Is recursively expanded by the GenerateComponentTargets macro
  369. define ComponentMake
  370. +$(MAKE) -C $(BUILD_DIR_BASE)/$(2) -f $(IDF_PATH)/make/component_wrapper.mk COMPONENT_MAKEFILE=$(1)/component.mk COMPONENT_NAME=$(2)
  371. endef
  372. # Generate top-level component-specific targets for each component
  373. # $(1) - path to component dir
  374. # $(2) - name of component
  375. #
  376. define GenerateComponentTargets
  377. .PHONY: component-$(2)-build component-$(2)-clean
  378. component-$(2)-build: check-submodules $(call prereq_if_explicit, component-$(2)-clean) | $(BUILD_DIR_BASE)/$(2)
  379. $(call ComponentMake,$(1),$(2)) build
  380. component-$(2)-clean: | $(BUILD_DIR_BASE)/$(2) $(BUILD_DIR_BASE)/$(2)/component_project_vars.mk
  381. $(call ComponentMake,$(1),$(2)) clean
  382. $(BUILD_DIR_BASE)/$(2):
  383. @mkdir -p $(BUILD_DIR_BASE)/$(2)
  384. # tell make it can build any component's library by invoking the -build target
  385. # (this target exists for all components even ones which don't build libraries, but it's
  386. # only invoked for the targets whose libraries appear in COMPONENT_LIBRARIES and hence the
  387. # APP_ELF dependencies.)
  388. $(BUILD_DIR_BASE)/$(2)/lib$(2).a: component-$(2)-build
  389. $(details) "Target '$$^' responsible for '$$@'" # echo which build target built this file
  390. # add a target to generate the component_project_vars.mk files that
  391. # are used to inject variables into project make pass (see matching
  392. # component_project_vars.mk target in component_wrapper.mk).
  393. #
  394. # If any component_project_vars.mk file is out of date, the make
  395. # process will call this target to rebuild it and then restart.
  396. #
  397. $(BUILD_DIR_BASE)/$(2)/component_project_vars.mk: $(1)/component.mk $(COMMON_MAKEFILES) $(SDKCONFIG_MAKEFILE) | $(BUILD_DIR_BASE)/$(2)
  398. $(call ComponentMake,$(1),$(2)) component_project_vars.mk
  399. endef
  400. $(foreach component,$(COMPONENT_PATHS),$(eval $(call GenerateComponentTargets,$(component),$(notdir $(component)))))
  401. $(foreach component,$(TEST_COMPONENT_PATHS),$(eval $(call GenerateComponentTargets,$(component),$(lastword $(subst /, ,$(dir $(component))))_test)))
  402. app-clean: $(addprefix component-,$(addsuffix -clean,$(notdir $(COMPONENT_PATHS))))
  403. $(summary) RM $(APP_ELF)
  404. rm -f $(APP_ELF) $(APP_BIN) $(APP_MAP)
  405. size: $(APP_ELF)
  406. $(PYTHON) $(IDF_PATH)/tools/idf_size.py $(APP_MAP)
  407. size-files: $(APP_ELF)
  408. $(PYTHON) $(IDF_PATH)/tools/idf_size.py --files $(APP_MAP)
  409. size-components: $(APP_ELF)
  410. $(PYTHON) $(IDF_PATH)/tools/idf_size.py --archives $(APP_MAP)
  411. size-symbols: $(APP_ELF)
  412. ifndef COMPONENT
  413. $(error "ERROR: Please enter the component to look symbols for, e.g. COMPONENT=heap")
  414. else
  415. $(PYTHON) $(IDF_PATH)/tools/idf_size.py --archive_details lib$(COMPONENT).a $(APP_MAP)
  416. endif
  417. # NB: this ordering is deliberate (app-clean & bootloader-clean before
  418. # _config-clean), so config remains valid during all component clean
  419. # targets
  420. config-clean: app-clean bootloader-clean
  421. clean: app-clean bootloader-clean config-clean
  422. # phony target to check if any git submodule listed in COMPONENT_SUBMODULES are missing
  423. # or out of date, and exit if so. Components can add paths to this variable.
  424. #
  425. # This only works for components inside IDF_PATH
  426. check-submodules:
  427. # Check if .gitmodules exists, otherwise skip submodule check, assuming flattened structure
  428. ifneq ("$(wildcard ${IDF_PATH}/.gitmodules)","")
  429. # Dump the git status for the whole working copy once, then grep it for each submodule. This saves a lot of time on Windows.
  430. GIT_STATUS := $(shell cd ${IDF_PATH} && git status --porcelain --ignore-submodules=dirty)
  431. # Generate a target to check this submodule
  432. # $(1) - submodule directory, relative to IDF_PATH
  433. define GenerateSubmoduleCheckTarget
  434. check-submodules: $(IDF_PATH)/$(1)/.git
  435. $(IDF_PATH)/$(1)/.git:
  436. @echo "WARNING: Missing submodule $(1)..."
  437. [ -e ${IDF_PATH}/.git ] || ( echo "ERROR: esp-idf must be cloned from git to work."; exit 1)
  438. [ -x "$(shell which git)" ] || ( echo "ERROR: Need to run 'git submodule init $(1)' in esp-idf root directory."; exit 1)
  439. @echo "Attempting 'git submodule update --init $(1)' in esp-idf root directory..."
  440. cd ${IDF_PATH} && git submodule update --init $(1)
  441. # Parse 'git status' output to check if the submodule commit is different to expected
  442. ifneq ("$(filter $(1),$(GIT_STATUS))","")
  443. $$(info WARNING: esp-idf git submodule $(1) may be out of date. Run 'git submodule update' in IDF_PATH dir to update.)
  444. endif
  445. endef
  446. # filter/subst in expression ensures all submodule paths begin with $(IDF_PATH), and then strips that prefix
  447. # so the argument is suitable for use with 'git submodule' commands
  448. $(foreach submodule,$(subst $(IDF_PATH)/,,$(filter $(IDF_PATH)/%,$(COMPONENT_SUBMODULES))),$(eval $(call GenerateSubmoduleCheckTarget,$(submodule))))
  449. endif # End check for .gitmodules existence
  450. # PHONY target to list components in the build and their paths
  451. list-components:
  452. $(info $(call dequote,$(SEPARATOR)))
  453. $(info COMPONENT_DIRS (components searched for here))
  454. $(foreach cd,$(COMPONENT_DIRS),$(info $(cd)))
  455. $(info $(call dequote,$(SEPARATOR)))
  456. $(info COMPONENTS (list of component names))
  457. $(info $(COMPONENTS))
  458. $(info $(call dequote,$(SEPARATOR)))
  459. $(info EXCLUDE_COMPONENTS (list of excluded names))
  460. $(info $(if $(EXCLUDE_COMPONENTS),$(EXCLUDE_COMPONENTS),(none provided)))
  461. $(info $(call dequote,$(SEPARATOR)))
  462. $(info COMPONENT_PATHS (paths to all components):)
  463. $(foreach cp,$(COMPONENT_PATHS),$(info $(cp)))
  464. # print flash command, so users can dump this to config files and download somewhere without idf
  465. print_flash_cmd:
  466. echo $(ESPTOOL_WRITE_FLASH_OPTIONS) $(ESPTOOL_ALL_FLASH_ARGS) | sed -e 's:'$(PWD)/build/'::g'
  467. # Check toolchain version using the output of xtensa-esp32-elf-gcc --version command.
  468. # The output normally looks as follows
  469. # xtensa-esp32-elf-gcc (crosstool-NG crosstool-ng-1.22.0-59-ga194053) 4.8.5
  470. # The part in brackets is extracted into TOOLCHAIN_COMMIT_DESC variable,
  471. # the part after the brackets is extracted into TOOLCHAIN_GCC_VER.
  472. ifdef CONFIG_TOOLPREFIX
  473. ifndef MAKE_RESTARTS
  474. 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')
  475. TOOLCHAIN_GCC_VER := $(shell $(CC) --version | sed -E -n 's|xtensa-esp32-elf-gcc.*\ \(.*\)\ (.*)|\1|gp')
  476. # Officially supported version(s)
  477. SUPPORTED_TOOLCHAIN_COMMIT_DESC := 1.22.0-80-g6c4433a
  478. SUPPORTED_TOOLCHAIN_GCC_VERSIONS := 5.2.0
  479. ifdef TOOLCHAIN_COMMIT_DESC
  480. ifneq ($(TOOLCHAIN_COMMIT_DESC), $(SUPPORTED_TOOLCHAIN_COMMIT_DESC))
  481. $(info WARNING: Toolchain version is not supported: $(TOOLCHAIN_COMMIT_DESC))
  482. $(info Expected to see version: $(SUPPORTED_TOOLCHAIN_COMMIT_DESC))
  483. $(info Please check ESP-IDF setup instructions and update the toolchain, or proceed at your own risk.)
  484. endif
  485. ifeq (,$(findstring $(TOOLCHAIN_GCC_VER), $(SUPPORTED_TOOLCHAIN_GCC_VERSIONS)))
  486. $(info WARNING: Compiler version is not supported: $(TOOLCHAIN_GCC_VER))
  487. $(info Expected to see version(s): $(SUPPORTED_TOOLCHAIN_GCC_VERSIONS))
  488. $(info Please check ESP-IDF setup instructions and update the toolchain, or proceed at your own risk.)
  489. endif
  490. else
  491. $(info WARNING: Failed to find Xtensa toolchain, may need to alter PATH or set one in the configuration menu)
  492. endif # TOOLCHAIN_COMMIT_DESC
  493. endif #MAKE_RESTARTS
  494. endif #CONFIG_TOOLPREFIX