feat(make): add make script and README

make/README

@@ -0,0 +1,6 @@
+README
+
+The SDK uses 'make' of esp-idf and information of esp-idf is following:
+
+URL: https://github.com/espressif/esp-idf
+tag: v3.1-dev

make/common.mk

@@ -0,0 +1,88 @@
+# Functionality common to both top-level project makefile (project.mk)
+# and component makefiles (component_wrapper.mk)
+#
+
+# Include project config makefile, if it exists.
+#
+# (Note that we only rebuild this makefile automatically for some
+# targets, see project_config.mk for details.)
+SDKCONFIG_MAKEFILE ?= $(abspath $(BUILD_DIR_BASE)/include/config/auto.conf)
+-include $(SDKCONFIG_MAKEFILE)
+export SDKCONFIG_MAKEFILE  # sub-makes (like bootloader) will reuse this path
+
+# BATCH_BUILD flag disables interactive terminal features, defaults to verbose build
+ifdef BATCH_BUILD
+V ?= 1
+endif
+
+#Handling of V=1/VERBOSE=1 flag
+#
+# if V=1, $(summary) does nothing and $(details) will echo extra details
+# if V is unset or not 1, $(summary) echoes a summary and $(details) does nothing
+VERBOSE ?=
+V ?= $(VERBOSE)
+ifeq ("$(V)","1")
+summary := @true
+details := @echo
+else
+summary := @echo
+details := @true
+
+# disable echoing of commands, directory names
+MAKEFLAGS += --silent
+endif  # $(V)==1
+
+ifdef CONFIG_MAKE_WARN_UNDEFINED_VARIABLES
+MAKEFLAGS += --warn-undefined-variables
+endif
+
+# General make utilities
+
+# convenience variable for printing an 80 asterisk wide separator line
+SEPARATOR:="*******************************************************************************"
+
+# macro to remove quotes from an argument, ie $(call dequote,$(CONFIG_BLAH))
+define dequote
+$(subst ",,$(1))
+endef
+# " comment kept here to keep syntax highlighting happy
+
+
+# macro to keep an absolute path as-is, but resolve a relative path
+# against a particular parent directory
+#
+# $(1) path to resolve
+# $(2) directory to resolve non-absolute path against
+#
+# Path and directory don't have to exist (definition of a "relative
+# path" is one that doesn't start with /)
+#
+# $(2) can contain a trailing forward slash or not, result will not
+# double any path slashes.
+#
+# example $(call resolvepath,$(CONFIG_PATH),$(CONFIG_DIR))
+define resolvepath
+$(foreach dir,$(1),$(if $(filter /%,$(dir)),$(dir),$(subst //,/,$(2)/$(dir))))
+endef
+
+
+# macro to include a target only if it's on the list of targets that make
+# was invoked with
+#
+# This allows you to have something like an "order-only phony prerequisite",
+# ie a prerequisite that determines an order phony targets have to run in.
+#
+# Because normal order-only prerequisites don't work with phony targets.
+#
+# example $(call prereq_if_explicit,erase_flash)
+define prereq_if_explicit
+$(filter $(1),$(MAKECMDGOALS))
+endef
+
+# macro to kill duplicate items in a list without messing up the sort order of the list.
+# Will only keep the unique items; if there are non-unique items in the list, it will remove
+# the later recurring ones so only the first one remains.
+# Copied from http://stackoverflow.com/questions/16144115/makefile-remove-duplicate-words-without-sorting
+define uniq
+$(if $1,$(firstword $1) $(call uniq,$(filter-out $(firstword $1),$1)))
+endef

make/component_common.mk

@@ -0,0 +1 @@
+$(warning Deprecated feature: No longer necessary to include component_common.mk from $(COMPONENT_PATH)/component.mk)

make/component_wrapper.mk

@@ -0,0 +1,296 @@
+# Component wrapper makefile
+#
+# This makefile gets called recursively from the project make, once for each component.
+# COMPONENT_MAKEFILE is set to point at the component.mk file for the component itself,
+# which is included as part of this process (after default variables are defined).
+#
+# This makefile comprises multiple stages, marked in blocked comments below.
+#
+# CWD is the build directory of the component.
+
+ifndef PROJECT_PATH
+$(error Make was invoked from $(CURDIR). However please do not run make from the sdk or a component directory; invoke make from the project directory. See the ESP-IDF README for details.)
+endif
+
+
+################################################################################
+# 1) Set default variables for the component build (including configuration
+#	loaded from sdkconfig.)
+################################################################################
+
+# Find the path to the component
+COMPONENT_PATH := $(abspath $(dir $(COMPONENT_MAKEFILE)))
+export COMPONENT_PATH
+
+# COMPONENT_BUILD_DIR is otherwise known as CWD for the build
+COMPONENT_BUILD_DIR := $(abspath .)
+
+# include elements common to both project & component makefiles
+# (includes project configuration set via menuconfig)
+include $(IDF_PATH)/make/common.mk
+
+# Some of the following defaults may be overriden by the component's component.mk makefile,
+# during the next step:
+
+# Absolute path of the .a file
+COMPONENT_LIBRARY = lib$(COMPONENT_NAME).a
+
+# Source dirs a component has. Default to root directory of component.
+COMPONENT_SRCDIRS = .
+
+#Names of binary & text files to embed as raw content in the component library
+COMPONENT_EMBED_FILES ?=
+COMPONENT_EMBED_TXTFILES ?=
+
+# By default, include only the include/ dir.
+COMPONENT_ADD_INCLUDEDIRS = include
+COMPONENT_ADD_LDFLAGS = -l$(COMPONENT_NAME)
+
+# Define optional compiling macros
+define compile_exclude 
+COMPONENT_OBJEXCLUDE += $(1)
+endef
+
+define compile_include
+COMPONENT_OBJINCLUDE += $(1)
+endef
+
+define compile_only_if
+$(eval $(if $(1), $(call compile_include, $(2)), $(call compile_exclude, $(2))))
+endef
+
+define compile_only_if_not 
+$(eval $(if $(1), $(call compile_exclude, $(2)), $(call compile_include, $(2))))
+endef
+
+COMPONENT_ADD_LINKER_DEPS ?=
+COMPONENT_DEPENDS ?=
+COMPONENT_EXTRA_CLEAN ?=
+COMPONENT_EXTRA_INCLUDES ?=
+COMPONENT_OBJEXCLUDE ?=
+COMPONENT_OBJINCLUDE ?=
+COMPONENT_SUBMODULES ?=
+
+################################################################################
+# 2) Include the component.mk for the specific component (COMPONENT_MAKEFILE) to
+#     override variables & optionally define custom targets.
+################################################################################
+
+include $(COMPONENT_MAKEFILE)
+
+################################################################################
+# 3) Set variables that depend on values that may changed by component.mk
+################################################################################
+
+ifndef COMPONENT_CONFIG_ONLY  # Skip steps 3-5 if COMPONENT_CONFIG_ONLY is set
+
+# Object files which need to be linked into the library
+# By default we take all .c, .cpp & .S files in COMPONENT_SRCDIRS.
+ifndef COMPONENT_OBJS
+# Find all source files in all COMPONENT_SRCDIRS
+COMPONENT_OBJS := $(foreach compsrcdir,$(COMPONENT_SRCDIRS),$(patsubst %.c,%.o,$(wildcard $(COMPONENT_PATH)/$(compsrcdir)/*.c)))
+COMPONENT_OBJS += $(foreach compsrcdir,$(COMPONENT_SRCDIRS),$(patsubst %.cpp,%.o,$(wildcard $(COMPONENT_PATH)/$(compsrcdir)/*.cpp)))
+COMPONENT_OBJS += $(foreach compsrcdir,$(COMPONENT_SRCDIRS),$(patsubst %.S,%.o,$(wildcard $(COMPONENT_PATH)/$(compsrcdir)/*.S)))
+# Make relative by removing COMPONENT_PATH from all found object paths
+COMPONENT_OBJS := $(patsubst $(COMPONENT_PATH)/%,%,$(COMPONENT_OBJS))
+else
+# Add in components defined by conditional compiling macros
+COMPONENT_OBJS += $(COMPONENT_OBJINCLUDE)
+endif
+# Remove items disabled by optional compilation
+COMPONENT_OBJS := $(foreach obj,$(COMPONENT_OBJS),$(if $(filter $(realpath $(obj)),$(realpath $(COMPONENT_OBJEXCLUDE))), ,$(obj)))
+
+# Remove duplicates
+COMPONENT_OBJS := $(call uniq,$(COMPONENT_OBJS))
+
+
+# Object files with embedded binaries to add to the component library
+# Correspond to the files named in COMPONENT_EMBED_FILES & COMPONENT_EMBED_TXTFILES
+COMPONENT_EMBED_OBJS ?= $(addsuffix .bin.o,$(notdir $(COMPONENT_EMBED_FILES))) $(addsuffix .txt.o,$(notdir $(COMPONENT_EMBED_TXTFILES)))
+
+# If we're called to compile something, we'll get passed the COMPONENT_INCLUDES
+# variable with all the include dirs from all the components in random order. This
+# means we can accidentally grab a header from another component before grabbing our own.
+# To make sure that does not happen, re-order the includes so ours come first.
+COMPONENT_PRIV_INCLUDEDIRS ?=
+OWN_INCLUDES:=$(abspath $(addprefix $(COMPONENT_PATH)/,$(COMPONENT_PRIV_INCLUDEDIRS) $(COMPONENT_ADD_INCLUDEDIRS)))
+COMPONENT_INCLUDES := $(OWN_INCLUDES) $(filter-out $(OWN_INCLUDES),$(COMPONENT_INCLUDES))
+
+
+################################################################################
+# 4) Define a target to generate component_project_vars.mk Makefile which
+# contains common per-component settings which are included directly in the
+# top-level project make
+#
+# (Skipped if COMPONENT_CONFIG_ONLY is set.)
+################################################################################
+
+# macro to generate variable-relative paths inside component_project_vars.mk, whenever possible
+# ie put literal $(IDF_PATH), $(PROJECT_PATH) and $(BUILD_DIR_BASE) into the generated
+# makefiles where possible.
+#
+# This means if directories move (breaking absolute paths), don't need to 'make clean'
+define MakeVariablePath
+$(subst $(IDF_PATH),$$(IDF_PATH),$(subst $(PROJECT_PATH),$$(PROJECT_PATH),$(subst $(BUILD_DIR_BASE),$$(BUILD_DIR_BASE),$(1))))
+endef
+
+# component_project_vars.mk target for the component. This is used to
+# take component.mk variables COMPONENT_ADD_INCLUDEDIRS,
+# COMPONENT_ADD_LDFLAGS, COMPONENT_DEPENDS and COMPONENT_SUBMODULES
+# and inject those into the project make pass.
+#
+# The target here has no dependencies, as the parent target in
+# project.mk evaluates dependencies before calling down to here. See
+# GenerateComponentTargets macro in project.mk.
+#
+# If you are thinking of editing the output of this target for a
+# component-specific feature, please don't! What you want is a
+# Makefile.projbuild for your component (see docs/build-system.rst for
+# more.)
+#
+# Note: The :: target here is not a mistake. This target should always be
+# executed, as dependencies are checked by the parent project-level make target.
+# See https://www.gnu.org/software/make/manual/make.html#index-_003a_003a-rules-_0028double_002dcolon_0029
+component_project_vars.mk::
+	$(details) "Building component project variables list $(abspath $@)"
+	@echo '# Automatically generated build file. Do not edit.' > $@
+	@echo 'COMPONENT_INCLUDES += $(call MakeVariablePath,$(addprefix $(COMPONENT_PATH)/,$(COMPONENT_ADD_INCLUDEDIRS)))' >> $@
+	@echo 'COMPONENT_LDFLAGS += $(call MakeVariablePath,-L$(COMPONENT_BUILD_DIR) $(COMPONENT_ADD_LDFLAGS))' >> $@
+	@echo 'COMPONENT_LINKER_DEPS += $(call MakeVariablePath,$(call resolvepath,$(COMPONENT_ADD_LINKER_DEPS),$(COMPONENT_PATH)))' >> $@
+	@echo 'COMPONENT_SUBMODULES += $(call MakeVariablePath,$(addprefix $(COMPONENT_PATH)/,$(COMPONENT_SUBMODULES)))' >> $@
+	@echo 'COMPONENT_LIBRARIES += $(COMPONENT_NAME)' >> $@
+	@echo 'component-$(COMPONENT_NAME)-build: $(addprefix component-,$(addsuffix -build,$(COMPONENT_DEPENDS)))' >> $@
+
+################################################################################
+# 5) Where COMPONENT_OWNBUILDTARGET / COMPONENT_OWNCLEANTARGET
+# is not set by component.mk, define default build, clean, etc. targets
+#
+# (Skipped if COMPONENT_CONFIG_ONLY is set.)
+################################################################################
+
+# Default build behaviour: define a phony build target and a COMPONENT_LIBRARY link target.
+ifndef COMPONENT_OWNBUILDTARGET
+.PHONY: build
+build: $(COMPONENT_LIBRARY)
+
+# Build the archive. We remove the archive first, otherwise ar will get confused if we update
+# an archive when multiple filenames have the same name (src1/test.o and src2/test.o)
+$(COMPONENT_LIBRARY): $(COMPONENT_OBJS) $(COMPONENT_EMBED_OBJS)
+	$(summary) AR $(patsubst $(PWD)/%,%,$(CURDIR))/$@
+	rm -f $@
+	$(AR) cru $@ $^
+endif
+
+# If COMPONENT_OWNCLEANTARGET is not set, define a phony clean target
+ifndef COMPONENT_OWNCLEANTARGET
+CLEAN_FILES := $(COMPONENT_LIBRARY) $(COMPONENT_OBJS) $(COMPONENT_OBJS:.o=.d) $(COMPONENT_OBJEXCLUDE) $(COMPONENT_OBJEXCLUDE:.o=.d) $(COMPONENT_EMBED_OBJS) $(COMPONENT_EXTRA_CLEAN) component_project_vars.mk
+.PHONY: clean
+clean:
+	$(summary) RM $(CLEAN_FILES)
+	rm -f $(CLEAN_FILES)
+endif
+
+DEBUG_FLAGS ?= -ggdb
+
+# Include all dependency files already generated
+-include $(COMPONENT_OBJS:.o=.d)
+
+# This is a fix for situation where the project or IDF dir moves, and instead
+# of rebuilding the target the build fails until make clean is run
+#
+# It adds an empty dependency rule for the (possibly non-existent) source file itself,
+# which prevents it not being found from failing the build
+#
+# $1 == Source File, $2 == .o file used for .d file name
+define AppendSourceToDependencies
+echo "$1:" >> $$(patsubst %.o,%.d,$2)
+endef
+
+
+# This pattern is generated for each COMPONENT_SRCDIR to compile the files in it.
+define GenerateCompileTargets
+# $(1) - directory containing source files, relative to $(COMPONENT_PATH) - one of $(COMPONENT_SRCDIRS)
+#
+$(1)/%.o: $$(COMPONENT_PATH)/$(1)/%.c $(COMMON_MAKEFILES) $(COMPONENT_MAKEFILE) | $(COMPONENT_SRCDIRS)
+	$$(summary) CC $$(patsubst $$(PWD)/%,%,$$(CURDIR))/$$@
+	$$(CC) $$(CFLAGS) $$(CPPFLAGS) $$(addprefix -I ,$$(COMPONENT_INCLUDES)) $$(addprefix -I ,$$(COMPONENT_EXTRA_INCLUDES)) -I$(1) -c $$< -o $$@
+	$(call AppendSourceToDependencies,$$<,$$@)
+
+$(1)/%.o: $$(COMPONENT_PATH)/$(1)/%.cpp $(COMMON_MAKEFILES) $(COMPONENT_MAKEFILE) | $(COMPONENT_SRCDIRS)
+	$$(summary) CXX $$(patsubst $$(PWD)/%,%,$$(CURDIR))/$$@
+	$$(CXX) $$(CXXFLAGS) $$(CPPFLAGS) $$(addprefix -I,$$(COMPONENT_INCLUDES)) $$(addprefix -I,$$(COMPONENT_EXTRA_INCLUDES)) -I$(1) -c $$< -o $$@
+	$(call AppendSourceToDependencies,$$<,$$@)
+
+$(1)/%.o: $$(COMPONENT_PATH)/$(1)/%.S $(COMMON_MAKEFILES) $(COMPONENT_MAKEFILE) | $(COMPONENT_SRCDIRS)
+	$$(summary) AS $$(patsubst $$(PWD)/%,%,$$(CURDIR))/$$@
+	$$(CC) $$(CPPFLAGS) $$(DEBUG_FLAGS) $$(addprefix -I ,$$(COMPONENT_INCLUDES)) $$(addprefix -I ,$$(COMPONENT_EXTRA_INCLUDES)) -I$(1) -c $$< -o $$@
+	$(call AppendSourceToDependencies,$$<,$$@)
+
+# CWD is build dir, create the build subdirectory if it doesn't exist
+#
+# (NB: Each .o file depends on all relative component build dirs $(COMPONENT_SRCDIRS), rather than just $(1), to work
+# around a behaviour make 3.81 where the first pattern (randomly) seems to be matched rather than the best fit. ie if
+# you have objects a/y.o and a/b/c.o then c.o can be matched with $(1)=a & %=b/c, meaning that subdir 'a/b' needs to be
+# created but wouldn't be created if $(1)=a. Make 4.x doesn't have this problem, it seems to preferentially
+# choose the better match ie $(1)=a/b and %=c )
+#
+$(1):
+	mkdir -p $(1)
+endef
+
+# Generate all the compile target patterns
+$(foreach srcdir,$(COMPONENT_SRCDIRS), $(eval $(call GenerateCompileTargets,$(srcdir))))
+
+## Support for embedding binary files into the ELF as symbols
+
+OBJCOPY_EMBED_ARGS := --input-target binary --output-target elf32-xtensa-le --binary-architecture xtensa --rename-section .data=.rodata.embedded
+
+# Generate pattern for embedding text or binary files into the app
+# $(1) is name of file (as relative path inside component)
+# $(2) is txt or bin depending on file contents
+#
+# txt files are null-terminated before being embedded (otherwise
+# identical behaviour.)
+#
+define GenerateEmbedTarget
+
+# copy the input file into the build dir (using a subdirectory
+# in case the file already exists elsewhere in the build dir)
+embed_bin/$$(notdir $(1)): $(call resolvepath,$(1),$(COMPONENT_PATH)) | embed_bin
+	cp $$< $$@
+
+embed_txt/$$(notdir $(1)): $(call resolvepath,$(1),$(COMPONENT_PATH)) | embed_txt
+	cp $$< $$@
+	printf '\0' >> $$@  # null-terminate text files
+
+# messing about with the embed_X subdirectory then using 'cd' for objcopy is because the
+# full path passed to OBJCOPY makes it into the name of the symbols in the .o file
+$$(notdir $(1)).$(2).o: embed_$(2)/$$(notdir $(1))
+	$(summary) EMBED $$(patsubst $$(PWD)/%,%,$$(CURDIR))/$$@
+	cd embed_$(2); $(OBJCOPY) $(OBJCOPY_EMBED_ARGS) $$(notdir $$<) ../$$@
+
+CLEAN_FILES += embed_$(2)/$$(notdir $(1))
+endef
+
+embed_txt embed_bin:
+	mkdir -p $@
+
+# generate targets to embed binary & text files
+$(foreach binfile,$(COMPONENT_EMBED_FILES), $(eval $(call GenerateEmbedTarget,$(binfile),bin)))
+
+$(foreach txtfile,$(COMPONENT_EMBED_TXTFILES), $(eval $(call GenerateEmbedTarget,$(txtfile),txt)))
+
+else   # COMPONENT_CONFIG_ONLY is set
+
+build:
+	$(details) "No build needed for $(COMPONENT_NAME) (COMPONENT_CONFIG_ONLY)"
+
+clean:
+	$(summary) RM component_project_vars.mk
+	rm -f component_project_vars.mk
+
+component_project_vars.mk::  # no need to add variables via component.mk
+	@echo '# COMPONENT_CONFIG_ONLY target sets no variables here' > $@
+
+endif  # COMPONENT_CONFIG_ONLY
+