project.mk 23 KB

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