make/project.mk

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