1 # Copyright 2015-2018 Espressif Systems (Shanghai) PTE LTD
2 # Copyright 2018 apeos contributors
4 # Component wrapper makefile
6 # This makefile gets called recursively from the project make, once for each component.
7 # COMPONENT_MAKEFILE is set to point at the component.mk file for the component itself,
8 # which is included as part of this process (after default variables are defined).
10 # This makefile comprises multiple stages, marked in blocked comments below.
12 # CWD is the build directory of the component.
14 # Licensed under the Apache License, Version 2.0 (the "License");
15 # you may not use this file except in compliance with the License.
16 # You may obtain a copy of the License at
18 # http://www.apache.org/licenses/LICENSE-2.0
20 # Unless required by applicable law or agreed to in writing, software
21 # distributed under the License is distributed on an "AS IS" BASIS,
22 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
23 # See the License for the specific language governing permissions and
24 # limitations under the License.
27 $(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.
)
31 ################################################################################
32 # 1) Set default variables for the component build (including configuration
33 # loaded from sdkconfig.)
34 ################################################################################
36 # Find the path to the component
37 COMPONENT_PATH
:= $(abspath
$(dir $(COMPONENT_MAKEFILE
)))
40 # COMPONENT_BUILD_DIR is otherwise known as CWD for the build
41 COMPONENT_BUILD_DIR
:= $(abspath .
)
43 # include elements common to both project & component makefiles
44 # (includes project configuration set via menuconfig)
45 include $(IDF_PATH
)/make
/common.mk
47 # Some of the following defaults may be overriden by the component's component.mk makefile,
48 # during the next step:
50 # Absolute path of the .a file
51 COMPONENT_LIBRARY
= lib
$(COMPONENT_NAME
).a
53 # Source dirs a component has. Default to root directory of component.
56 #Names of binary & text files to embed as raw content in the component library
57 COMPONENT_EMBED_FILES ?
=
58 COMPONENT_EMBED_TXTFILES ?
=
60 # By default, include only the include/ dir.
61 COMPONENT_ADD_INCLUDEDIRS
= include
62 COMPONENT_ADD_LDFLAGS
= -l
$(COMPONENT_NAME
)
64 # Define optional compiling macros
65 define compile_exclude
66 COMPONENT_OBJEXCLUDE
+= $(1)
69 define compile_include
70 COMPONENT_OBJINCLUDE
+= $(1)
73 define compile_only_if
74 $(eval
$(if
$(1), $(call compile_include
, $(2)), $(call compile_exclude
, $(2))))
77 define compile_only_if_not
78 $(eval
$(if
$(1), $(call compile_exclude
, $(2)), $(call compile_include
, $(2))))
81 COMPONENT_ADD_LINKER_DEPS ?
=
83 COMPONENT_EXTRA_CLEAN ?
=
84 COMPONENT_EXTRA_INCLUDES ?
=
85 COMPONENT_OBJEXCLUDE ?
=
86 COMPONENT_OBJINCLUDE ?
=
87 COMPONENT_SUBMODULES ?
=
89 ################################################################################
90 # 2) Include the component.mk for the specific component (COMPONENT_MAKEFILE) to
91 # override variables & optionally define custom targets. Also include global
92 # component makefiles.
93 ################################################################################
96 # Include any Makefile.componentbuild file letting components add
97 # configuration at the global component level
99 # Save component_path; we pass it to the called Makefile.componentbuild
100 # as COMPILING_COMPONENT_PATH, and we use it to restore the current
101 # COMPONENT_PATH later.
102 COMPILING_COMPONENT_PATH
:= $(COMPONENT_PATH
)
104 define includeCompBuildMakefile
105 $(if
$(V
),$(info including
$(1)/Makefile.componentbuild...
))
106 COMPONENT_PATH
:= $(1)
107 include $(1)/Makefile.componentbuild
109 $(foreach componentpath
,$(COMPONENT_PATHS
), \
110 $(if
$(wildcard $(componentpath
)/Makefile.componentbuild
), \
111 $(eval
$(call includeCompBuildMakefile
,$(componentpath
)))))
113 #Restore COMPONENT_PATH to what it was
114 COMPONENT_PATH
:= $(COMPILING_COMPONENT_PATH
)
117 # Include component.mk for this component.
118 include $(COMPONENT_MAKEFILE
)
121 ################################################################################
122 # 3) Set variables that depend on values that may changed by component.mk
123 ################################################################################
125 ifndef COMPONENT_CONFIG_ONLY
# Skip steps 3-5 if COMPONENT_CONFIG_ONLY is set
127 # Object files which need to be linked into the library
128 # By default we take all .c, .cpp, .cc & .S files in COMPONENT_SRCDIRS.
129 ifndef COMPONENT_OBJS
130 # Find all source files in all COMPONENT_SRCDIRS
131 COMPONENT_OBJS
:= $(foreach compsrcdir
,$(COMPONENT_SRCDIRS
),$(patsubst %.c
,%.o
,$(wildcard $(COMPONENT_PATH
)/$(compsrcdir
)/*.c
)))
132 COMPONENT_OBJS
+= $(foreach compsrcdir
,$(COMPONENT_SRCDIRS
),$(patsubst %.
cpp,%.o
,$(wildcard $(COMPONENT_PATH
)/$(compsrcdir
)/*.
cpp)))
133 COMPONENT_OBJS
+= $(foreach compsrcdir
,$(COMPONENT_SRCDIRS
),$(patsubst %.
cc,%.o
,$(wildcard $(COMPONENT_PATH
)/$(compsrcdir
)/*.
cc)))
134 COMPONENT_OBJS
+= $(foreach compsrcdir
,$(COMPONENT_SRCDIRS
),$(patsubst %.S
,%.o
,$(wildcard $(COMPONENT_PATH
)/$(compsrcdir
)/*.S
)))
135 # Make relative by removing COMPONENT_PATH from all found object paths
136 COMPONENT_OBJS
:= $(patsubst $(COMPONENT_PATH
)/%,%,$(COMPONENT_OBJS
))
138 # Add in components defined by conditional compiling macros
139 COMPONENT_OBJS
+= $(COMPONENT_OBJINCLUDE
)
141 # Remove items disabled by optional compilation
142 COMPONENT_OBJS
:= $(foreach obj
,$(COMPONENT_OBJS
),$(if
$(filter $(realpath
$(obj
)),$(realpath
$(COMPONENT_OBJEXCLUDE
))), ,$(obj
)))
145 COMPONENT_OBJS
:= $(call uniq
,$(COMPONENT_OBJS
))
148 # Object files with embedded binaries to add to the component library
149 # Correspond to the files named in COMPONENT_EMBED_FILES & COMPONENT_EMBED_TXTFILES
150 COMPONENT_EMBED_OBJS ?
= $(addsuffix .bin.o
,$(notdir $(COMPONENT_EMBED_FILES
))) $(addsuffix .txt.o
,$(notdir $(COMPONENT_EMBED_TXTFILES
)))
152 # If we're called to compile something, we'll get passed the COMPONENT_INCLUDES
153 # variable with all the include dirs from all the components in random order. This
154 # means we can accidentally grab a header from another component before grabbing our own.
155 # To make sure that does not happen, re-order the includes so ours come first.
156 COMPONENT_PRIV_INCLUDEDIRS ?
=
157 OWN_INCLUDES
:=$(abspath
$(addprefix $(COMPONENT_PATH
)/,$(COMPONENT_PRIV_INCLUDEDIRS
) $(COMPONENT_ADD_INCLUDEDIRS
)))
158 COMPONENT_INCLUDES
:= $(OWN_INCLUDES
) $(filter-out $(OWN_INCLUDES
),$(COMPONENT_INCLUDES
))
161 ################################################################################
162 # 4) Define a target to generate component_project_vars.mk Makefile which
163 # contains common per-component settings which are included directly in the
164 # top-level project make
166 # (Skipped if COMPONENT_CONFIG_ONLY is set.)
167 ################################################################################
169 # macro to generate variable-relative paths inside component_project_vars.mk, whenever possible
170 # ie put literal $(IDF_PATH), $(PROJECT_PATH) and $(BUILD_DIR_BASE) into the generated
171 # makefiles where possible.
173 # This means if directories move (breaking absolute paths), don't need to 'make clean'
174 define MakeVariablePath
175 $(subst $(IDF_PATH
),$$(IDF_PATH
),$(subst $(PROJECT_PATH
),$$(PROJECT_PATH
),$(subst $(BUILD_DIR_BASE
),$$(BUILD_DIR_BASE
),$(1))))
178 # component_project_vars.mk target for the component. This is used to
179 # take component.mk variables COMPONENT_ADD_INCLUDEDIRS,
180 # COMPONENT_ADD_LDFLAGS, COMPONENT_DEPENDS and COMPONENT_SUBMODULES
181 # and inject those into the project make pass.
183 # The target here has no dependencies, as the parent target in
184 # project.mk evaluates dependencies before calling down to here. See
185 # GenerateComponentTargets macro in project.mk.
187 # If you are thinking of editing the output of this target for a
188 # component-specific feature, please don't! What you want is a
189 # Makefile.projbuild for your component (see docs/build-system.rst for
192 # Note: The :: target here is not a mistake. This target should always be
193 # executed, as dependencies are checked by the parent project-level make target.
194 # See https://www.gnu.org/software/make/manual/make.html#index-_003a_003a-rules-_0028double_002dcolon_0029
195 component_project_vars.mk
::
196 $(details
) "Building component project variables list $(abspath $@)"
197 @echo
'# Automatically generated build file. Do not edit.' > $@
198 @echo
'COMPONENT_INCLUDES += $(call MakeVariablePath,$(addprefix $(COMPONENT_PATH)/,$(COMPONENT_ADD_INCLUDEDIRS)))' >> $@
199 @echo
'COMPONENT_LDFLAGS += $(call MakeVariablePath,-L$(COMPONENT_BUILD_DIR) $(COMPONENT_ADD_LDFLAGS))' >> $@
200 @echo
'COMPONENT_LINKER_DEPS += $(call MakeVariablePath,$(call resolvepath,$(COMPONENT_ADD_LINKER_DEPS),$(COMPONENT_PATH)))' >> $@
201 @echo
'COMPONENT_SUBMODULES += $(call MakeVariablePath,$(addprefix $(COMPONENT_PATH)/,$(COMPONENT_SUBMODULES)))' >> $@
202 @echo
'COMPONENT_LIBRARIES += $(COMPONENT_NAME)' >> $@
203 @echo
'component-$(COMPONENT_NAME)-build: $(addprefix component-,$(addsuffix -build,$(COMPONENT_DEPENDS)))' >> $@
205 ################################################################################
206 # 5) Where COMPONENT_OWNBUILDTARGET / COMPONENT_OWNCLEANTARGET
207 # is not set by component.mk, define default build, clean, etc. targets
209 # (Skipped if COMPONENT_CONFIG_ONLY is set.)
210 ################################################################################
212 # Default build behaviour: define a phony build target and a COMPONENT_LIBRARY link target.
213 ifndef COMPONENT_OWNBUILDTARGET
215 build
: $(COMPONENT_LIBRARY
)
217 # Build the archive. We remove the archive first, otherwise ar will get confused if we update
218 # an archive when multiple filenames have the same name (src1/test.o and src2/test.o)
219 $(COMPONENT_LIBRARY
): $(COMPONENT_OBJS
) $(COMPONENT_EMBED_OBJS
)
220 $(summary
) AR
$(patsubst $(PWD
)/%,%,$(CURDIR
))/$@
225 # If COMPONENT_OWNCLEANTARGET is not set, define a phony clean target
226 ifndef COMPONENT_OWNCLEANTARGET
227 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
230 $(summary
) RM
$(CLEAN_FILES
)
236 # Include all dependency files already generated
237 -include $(COMPONENT_OBJS
:.o
=.d
)
239 # This is a fix for situation where the project or IDF dir moves, and instead
240 # of rebuilding the target the build fails until make clean is run
242 # It adds an empty dependency rule for the (possibly non-existent) source file itself,
243 # which prevents it not being found from failing the build
245 # $1 == Source File, $2 == .o file used for .d file name
246 define AppendSourceToDependencies
247 echo
"$1:" >> $$(patsubst %.o
,%.d
,$2)
251 # This pattern is generated for each COMPONENT_SRCDIR to compile the files in it.
252 define GenerateCompileTargets
253 # $(1) - directory containing source files, relative to $(COMPONENT_PATH) - one of $(COMPONENT_SRCDIRS)
255 $(1)/%.o
: $$(COMPONENT_PATH
)/$(1)/%.c
$(COMMON_MAKEFILES
) $(COMPONENT_MAKEFILE
) |
$(COMPONENT_SRCDIRS
)
256 $$(summary
) CC
$$(patsubst $$(PWD
)/%,%,$$(CURDIR
))/$$@
257 $$(CC
) $$(CFLAGS
) $$(CPPFLAGS
) $$(addprefix -I
,$$(COMPONENT_INCLUDES
)) $$(addprefix -I
,$$(COMPONENT_EXTRA_INCLUDES
)) -I
$(1) -c
$$< -o
$$@
258 $(call AppendSourceToDependencies
,$$<,$$@
)
260 $(1)/%.o
: $$(COMPONENT_PATH
)/$(1)/%.
cpp $(COMMON_MAKEFILES
) $(COMPONENT_MAKEFILE
) |
$(COMPONENT_SRCDIRS
)
261 $$(summary
) CXX
$$(patsubst $$(PWD
)/%,%,$$(CURDIR
))/$$@
262 $$(CXX
) $$(CXXFLAGS
) $$(CPPFLAGS
) $$(addprefix -I
,$$(COMPONENT_INCLUDES
)) $$(addprefix -I
,$$(COMPONENT_EXTRA_INCLUDES
)) -I
$(1) -c
$$< -o
$$@
263 $(call AppendSourceToDependencies
,$$<,$$@
)
265 $(1)/%.o
: $$(COMPONENT_PATH
)/$(1)/%.
cc $(COMMON_MAKEFILES
) $(COMPONENT_MAKEFILE
) |
$(COMPONENT_SRCDIRS
)
266 $$(summary
) CXX
$$(patsubst $$(PWD
)/%,%,$$(CURDIR
))/$$@
267 $$(CXX
) $$(CXXFLAGS
) $$(CPPFLAGS
) $$(addprefix -I
,$$(COMPONENT_INCLUDES
)) $$(addprefix -I
,$$(COMPONENT_EXTRA_INCLUDES
)) -I
$(1) -c
$$< -o
$$@
268 $(call AppendSourceToDependencies
,$$<,$$@
)
270 $(1)/%.o
: $$(COMPONENT_PATH
)/$(1)/%.S
$(COMMON_MAKEFILES
) $(COMPONENT_MAKEFILE
) |
$(COMPONENT_SRCDIRS
)
271 $$(summary
) AS
$$(patsubst $$(PWD
)/%,%,$$(CURDIR
))/$$@
272 $$(CC
) $$(CPPFLAGS
) $$(DEBUG_FLAGS
) $$(addprefix -I
,$$(COMPONENT_INCLUDES
)) $$(addprefix -I
,$$(COMPONENT_EXTRA_INCLUDES
)) -I
$(1) -c
$$< -o
$$@
273 $(call AppendSourceToDependencies
,$$<,$$@
)
275 # CWD is build dir, create the build subdirectory if it doesn't exist
277 # (NB: Each .o file depends on all relative component build dirs $(COMPONENT_SRCDIRS), rather than just $(1), to work
278 # around a behaviour make 3.81 where the first pattern (randomly) seems to be matched rather than the best fit. ie if
279 # 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
280 # created but wouldn't be created if $(1)=a. Make 4.x doesn't have this problem, it seems to preferentially
281 # choose the better match ie $(1)=a/b and %=c )
287 # Generate all the compile target patterns
288 $(foreach srcdir,$(COMPONENT_SRCDIRS
), $(eval
$(call GenerateCompileTargets
,$(srcdir))))
290 ## Support for embedding binary files into the ELF as symbols
292 OBJCOPY_EMBED_ARGS
:= --input-target binary
--output-target elf32-xtensa-le
--binary-architecture xtensa
--rename-section .data
=.rodata.embedded
294 # Generate pattern for embedding text or binary files into the app
295 # $(1) is name of file (as relative path inside component)
296 # $(2) is txt or bin depending on file contents
298 # txt files are null-terminated before being embedded (otherwise
299 # identical behaviour.)
301 define GenerateEmbedTarget
303 # copy the input file into the build dir (using a subdirectory
304 # in case the file already exists elsewhere in the build dir)
305 embed_bin
/$$(notdir $(1)): $(call resolvepath
,$(1),$(COMPONENT_PATH
)) | embed_bin
308 embed_txt
/$$(notdir $(1)): $(call resolvepath
,$(1),$(COMPONENT_PATH
)) | embed_txt
310 printf
'\0' >> $$@
# null-terminate text files
312 # messing about with the embed_X subdirectory then using 'cd' for objcopy is because the
313 # full path passed to OBJCOPY makes it into the name of the symbols in the .o file
314 $$(notdir $(1)).
$(2).o
: embed_
$(2)/$$(notdir $(1))
315 $(summary
) EMBED
$$(patsubst $$(PWD
)/%,%,$$(CURDIR
))/$$@
316 cd embed_
$(2); $(OBJCOPY
) $(OBJCOPY_EMBED_ARGS
) $$(notdir $$<) ..
/$$@
318 CLEAN_FILES
+= embed_
$(2)/$$(notdir $(1))
324 # generate targets to embed binary & text files
325 $(foreach binfile
,$(COMPONENT_EMBED_FILES
), $(eval
$(call GenerateEmbedTarget
,$(binfile
),bin
)))
327 $(foreach txtfile
,$(COMPONENT_EMBED_TXTFILES
), $(eval
$(call GenerateEmbedTarget
,$(txtfile
),txt
)))
329 else # COMPONENT_CONFIG_ONLY is set
332 $(details
) "No build needed for $(COMPONENT_NAME) (COMPONENT_CONFIG_ONLY)"
335 $(summary
) RM component_project_vars.mk
336 rm -f component_project_vars.mk
338 component_project_vars.mk
:: # no need to add variables via component.mk
339 @echo
'# COMPONENT_CONFIG_ONLY target sets no variables here' > $@
341 endif # COMPONENT_CONFIG_ONLY