xref: /rk3399_ARM-atf/make_helpers/build_macros.mk (revision 093888caaf54cbfe38d4b68406d98fbcf5c7d81f)
1#
2# Copyright (c) 2015-2023, Arm Limited and Contributors. All rights reserved.
3#
4# SPDX-License-Identifier: BSD-3-Clause
5#
6
7# Report an error if the eval make function is not available.
8$(eval eval_available := T)
9ifneq (${eval_available},T)
10    $(error This makefile only works with a Make program that supports $$(eval))
11endif
12
13# Some utility macros for manipulating awkward (whitespace) characters.
14blank			:=
15space			:=${blank} ${blank}
16comma			:= ,
17
18# A user defined function to recursively search for a filename below a directory
19#    $1 is the directory root of the recursive search (blank for current directory).
20#    $2 is the file name to search for.
21define rwildcard
22$(strip $(foreach d,$(wildcard ${1}*),$(call rwildcard,${d}/,${2}) $(filter $(subst *,%,%${2}),${d})))
23endef
24
25# This table is used in converting lower case to upper case.
26uppercase_table:=a,A b,B c,C d,D e,E f,F g,G h,H i,I j,J k,K l,L m,M n,N o,O p,P q,Q r,R s,S t,T u,U v,V w,W x,X y,Y z,Z
27
28# Internal macro used for converting lower case to upper case.
29#   $(1) = upper case table
30#   $(2) = String to convert
31define uppercase_internal
32$(if $(1),$$(subst $(firstword $(1)),$(call uppercase_internal,$(wordlist 2,$(words $(1)),$(1)),$(2))),$(2))
33endef
34
35# A macro for converting a string to upper case
36#   $(1) = String to convert
37define uppercase
38$(eval uppercase_result:=$(call uppercase_internal,$(uppercase_table),$(1)))$(uppercase_result)
39endef
40
41# Convenience function for adding build definitions
42# $(eval $(call add_define,FOO)) will have:
43# -DFOO if $(FOO) is empty; -DFOO=$(FOO) otherwise
44define add_define
45    DEFINES			+=	-D$(1)$(if $(value $(1)),=$(value $(1)),)
46endef
47
48
49# Convenience function for addding multiple build definitions
50# $(eval $(call add_defines,FOO BOO))
51define add_defines
52    $(foreach def,$1,$(eval $(call add_define,$(def))))
53endef
54
55# Convenience function for adding build definitions
56# $(eval $(call add_define_val,FOO,BAR)) will have:
57# -DFOO=BAR
58define add_define_val
59    DEFINES			+=	-D$(1)=$(2)
60endef
61
62# Convenience function for verifying option has a boolean value
63# $(eval $(call assert_boolean,FOO)) will assert FOO is 0 or 1
64define assert_boolean
65    $(if $(filter-out 0 1,$($1)),$(error $1 must be boolean))
66endef
67
68# Convenience function for verifying options have boolean values
69# $(eval $(call assert_booleans,FOO BOO)) will assert FOO and BOO for 0 or 1 values
70define assert_booleans
71    $(foreach bool,$1,$(eval $(call assert_boolean,$(bool))))
72endef
73
740-9 := 0 1 2 3 4 5 6 7 8 9
75
76# Function to verify that a given option $(1) contains a numeric value
77define assert_numeric
78$(if $($(1)),,$(error $(1) must not be empty))
79$(eval __numeric := $($(1)))
80$(foreach d,$(0-9),$(eval __numeric := $(subst $(d),,$(__numeric))))
81$(if $(__numeric),$(error $(1) must be numeric))
82endef
83
84# Convenience function for verifying options have numeric values
85# $(eval $(call assert_numerics,FOO BOO)) will assert FOO and BOO contain numeric values
86define assert_numerics
87    $(foreach num,$1,$(eval $(call assert_numeric,$(num))))
88endef
89
90# CREATE_SEQ is a recursive function to create sequence of numbers from 1 to
91# $(2) and assign the sequence to $(1)
92define CREATE_SEQ
93$(if $(word $(2), $($(1))),\
94  $(eval $(1) += $(words $($(1))))\
95  $(eval $(1) := $(filter-out 0,$($(1)))),\
96  $(eval $(1) += $(words $($(1))))\
97  $(call CREATE_SEQ,$(1),$(2))\
98)
99endef
100
101# IMG_MAPFILE defines the output file describing the memory map corresponding
102# to a BL stage
103#   $(1) = BL stage
104define IMG_MAPFILE
105    ${BUILD_DIR}/$(1).map
106endef
107
108# IMG_ELF defines the elf file corresponding to a BL stage
109#   $(1) = BL stage
110define IMG_ELF
111    ${BUILD_DIR}/$(1).elf
112endef
113
114# IMG_DUMP defines the symbols dump file corresponding to a BL stage
115#   $(1) = BL stage
116define IMG_DUMP
117    ${BUILD_DIR}/$(1).dump
118endef
119
120# IMG_BIN defines the default image file corresponding to a BL stage
121#   $(1) = BL stage
122define IMG_BIN
123    ${BUILD_PLAT}/$(1).bin
124endef
125
126# IMG_ENC_BIN defines the default encrypted image file corresponding to a
127# BL stage
128#   $(1) = BL stage
129define IMG_ENC_BIN
130    ${BUILD_PLAT}/$(1)_enc.bin
131endef
132
133# ENCRYPT_FW invokes enctool to encrypt firmware binary
134#   $(1) = input firmware binary
135#   $(2) = output encrypted firmware binary
136define ENCRYPT_FW
137$(2): $(1) enctool
138	$$(ECHO) "  ENC     $$<"
139	$$(Q)$$(ENCTOOL) $$(ENC_ARGS) -i $$< -o $$@
140endef
141
142# TOOL_ADD_PAYLOAD appends the command line arguments required by fiptool to
143# package a new payload and/or by cert_create to generate certificate.
144# Optionally, it adds the dependency on this payload
145#   $(1) = payload filename (i.e. bl31.bin)
146#   $(2) = command line option for the specified payload (i.e. --soc-fw)
147#   $(3) = tool target dependency (optional) (ex. build/fvp/release/bl31.bin)
148#   $(4) = FIP prefix (optional) (if FWU_, target is fwu_fip instead of fip)
149#   $(5) = encrypted payload (optional) (ex. build/fvp/release/bl31_enc.bin)
150define TOOL_ADD_PAYLOAD
151ifneq ($(5),)
152    $(4)FIP_ARGS += $(2) $(5)
153    $(if $(3),$(4)CRT_DEPS += $(1))
154else
155    $(4)FIP_ARGS += $(2) $(1)
156    $(if $(3),$(4)CRT_DEPS += $(3))
157endif
158    $(if $(3),$(4)FIP_DEPS += $(3))
159    $(4)CRT_ARGS += $(2) $(1)
160endef
161
162# TOOL_ADD_IMG_PAYLOAD works like TOOL_ADD_PAYLOAD, but applies image filters
163# before passing them to host tools if BL*_PRE_TOOL_FILTER is defined.
164#   $(1) = image_type (scp_bl2, bl33, etc.)
165#   $(2) = payload filepath (ex. build/fvp/release/bl31.bin)
166#   $(3) = command line option for the specified payload (ex. --soc-fw)
167#   $(4) = tool target dependency (optional) (ex. build/fvp/release/bl31.bin)
168#   $(5) = FIP prefix (optional) (if FWU_, target is fwu_fip instead of fip)
169#   $(6) = encrypted payload (optional) (ex. build/fvp/release/bl31_enc.bin)
170
171define TOOL_ADD_IMG_PAYLOAD
172
173$(eval PRE_TOOL_FILTER := $($(call uppercase,$(1))_PRE_TOOL_FILTER))
174
175ifneq ($(PRE_TOOL_FILTER),)
176
177$(eval PROCESSED_PATH := $(BUILD_PLAT)/$(1).bin$($(PRE_TOOL_FILTER)_SUFFIX))
178
179$(call $(PRE_TOOL_FILTER)_RULE,$(PROCESSED_PATH),$(2))
180
181$(PROCESSED_PATH): $(4)
182
183$(call TOOL_ADD_PAYLOAD,$(PROCESSED_PATH),$(3),$(PROCESSED_PATH),$(5),$(6))
184
185else
186$(call TOOL_ADD_PAYLOAD,$(2),$(3),$(4),$(5),$(6))
187endif
188endef
189
190# CERT_ADD_CMD_OPT adds a new command line option to the cert_create invocation
191#   $(1) = parameter filename
192#   $(2) = cert_create command line option for the specified parameter
193#   $(3) = FIP prefix (optional) (if FWU_, target is fwu_fip instead of fip)
194define CERT_ADD_CMD_OPT
195    $(3)CRT_ARGS += $(2) $(1)
196endef
197
198# TOOL_ADD_IMG allows the platform to specify an external image to be packed
199# in the FIP and/or for which certificate is generated. It also adds a
200# dependency on the image file, aborting the build if the file does not exist.
201#   $(1) = image_type (scp_bl2, bl33, etc.)
202#   $(2) = command line option for fiptool (--scp-fw, --nt-fw, etc)
203#   $(3) = FIP prefix (optional) (if FWU_, target is fwu_fip instead of fip)
204#   $(4) = Image encryption flag (optional) (0, 1)
205# Example:
206#   $(eval $(call TOOL_ADD_IMG,bl33,--nt-fw))
207define TOOL_ADD_IMG
208    # Build option to specify the image filename (SCP_BL2, BL33, etc)
209    # This is the uppercase form of the first parameter
210    $(eval _V := $(call uppercase,$(1)))
211
212    # $(check_$(1)_cmd) variable is executed in the check_$(1) target and also
213    # is put into the ${CHECK_$(3)FIP_CMD} variable which is executed by the
214    # target ${BUILD_PLAT}/${$(3)FIP_NAME}.
215    $(eval check_$(1)_cmd := \
216        $(if $(value $(_V)),,$$$$(error "Platform '${PLAT}' requires $(_V). Please set $(_V) to point to the right file")) \
217        $(if $(wildcard $(value $(_V))),,$$$$(error '$(_V)=$(value $(_V))' was specified, but '$(value $(_V))' does not exist)) \
218    )
219
220    $(3)CRT_DEPS += check_$(1)
221    CHECK_$(3)FIP_CMD += $$(check_$(1)_cmd)
222ifeq ($(4),1)
223    $(eval ENC_BIN := ${BUILD_PLAT}/$(1)_enc.bin)
224    $(call ENCRYPT_FW,$(value $(_V)),$(ENC_BIN))
225    $(call TOOL_ADD_IMG_PAYLOAD,$(1),$(value $(_V)),$(2),$(ENC_BIN),$(3), \
226		$(ENC_BIN))
227else
228    $(call TOOL_ADD_IMG_PAYLOAD,$(1),$(value $(_V)),$(2),$(if $(wildcard $(value $(_V))),$(value $(_V)),FORCE),$(3))
229endif
230
231.PHONY: check_$(1)
232check_$(1):
233	$(check_$(1)_cmd)
234endef
235
236# SELECT_OPENSSL_API_VERSION selects the OpenSSL API version to be used to
237# build the host tools by checking the version of OpenSSL located under
238# the path defined by the OPENSSL_DIR variable. It receives no parameters.
239define SELECT_OPENSSL_API_VERSION
240    # Set default value for USING_OPENSSL3 macro to 0
241    $(eval USING_OPENSSL3 = 0)
242    # Obtain the OpenSSL version for the build located under OPENSSL_DIR
243    $(eval OPENSSL_INFO := $(shell LD_LIBRARY_PATH=${OPENSSL_DIR}:${OPENSSL_DIR}/lib ${OPENSSL_BIN_PATH}/openssl version))
244    $(eval OPENSSL_CURRENT_VER = $(word 2, ${OPENSSL_INFO}))
245    $(eval OPENSSL_CURRENT_VER_MAJOR = $(firstword $(subst ., ,$(OPENSSL_CURRENT_VER))))
246    # If OpenSSL version is 3.x, then set USING_OPENSSL3 flag to 1
247    $(if $(filter 3,$(OPENSSL_CURRENT_VER_MAJOR)), $(eval USING_OPENSSL3 = 1))
248endef
249
250################################################################################
251# Generic image processing filters
252################################################################################
253
254# GZIP
255define GZIP_RULE
256$(1): $(2)
257	$(ECHO) "  GZIP    $$@"
258	$(Q)gzip -n -f -9 $$< --stdout > $$@
259endef
260
261GZIP_SUFFIX := .gz
262
263################################################################################
264# Auxiliary macros to build TF images from sources
265################################################################################
266
267MAKE_DEP = -Wp,-MD,$(DEP) -MT $$@ -MP
268
269
270# MAKE_C_LIB builds a C source file and generates the dependency file
271#   $(1) = output directory
272#   $(2) = source file (%.c)
273#   $(3) = library name
274define MAKE_C_LIB
275$(eval OBJ := $(1)/$(patsubst %.c,%.o,$(notdir $(2))))
276$(eval DEP := $(patsubst %.o,%.d,$(OBJ)))
277
278$(OBJ): $(2) $(filter-out %.d,$(MAKEFILE_LIST)) | lib$(3)_dirs
279	$$(ECHO) "  CC      $$<"
280	$$(Q)$$(CC) $$(TF_CFLAGS) $$(CFLAGS) $(MAKE_DEP) -c $$< -o $$@
281
282-include $(DEP)
283
284endef
285
286# MAKE_S_LIB builds an assembly source file and generates the dependency file
287#   $(1) = output directory
288#   $(2) = source file (%.S)
289#   $(3) = library name
290define MAKE_S_LIB
291$(eval OBJ := $(1)/$(patsubst %.S,%.o,$(notdir $(2))))
292$(eval DEP := $(patsubst %.o,%.d,$(OBJ)))
293
294$(OBJ): $(2) $(filter-out %.d,$(MAKEFILE_LIST)) | lib$(3)_dirs
295	$$(ECHO) "  AS      $$<"
296	$$(Q)$$(AS) $$(ASFLAGS) $(MAKE_DEP) -c $$< -o $$@
297
298-include $(DEP)
299
300endef
301
302
303# MAKE_C builds a C source file and generates the dependency file
304#   $(1) = output directory
305#   $(2) = source file (%.c)
306#   $(3) = BL stage
307define MAKE_C
308
309$(eval OBJ := $(1)/$(patsubst %.c,%.o,$(notdir $(2))))
310$(eval DEP := $(patsubst %.o,%.d,$(OBJ)))
311$(eval BL_CPPFLAGS := $($(call uppercase,$(3))_CPPFLAGS) -DIMAGE_$(call uppercase,$(3)))
312$(eval BL_CFLAGS := $($(call uppercase,$(3))_CFLAGS))
313
314$(OBJ): $(2) $(filter-out %.d,$(MAKEFILE_LIST)) | $(3)_dirs
315	$$(ECHO) "  CC      $$<"
316	$$(Q)$$(CC) $$(LTO_CFLAGS) $$(TF_CFLAGS) $$(CFLAGS) $(BL_CPPFLAGS) $(BL_CFLAGS) $(MAKE_DEP) -c $$< -o $$@
317
318-include $(DEP)
319
320endef
321
322
323# MAKE_S builds an assembly source file and generates the dependency file
324#   $(1) = output directory
325#   $(2) = assembly file (%.S)
326#   $(3) = BL stage
327define MAKE_S
328
329$(eval OBJ := $(1)/$(patsubst %.S,%.o,$(notdir $(2))))
330$(eval DEP := $(patsubst %.o,%.d,$(OBJ)))
331$(eval BL_CPPFLAGS := $($(call uppercase,$(3))_CPPFLAGS) -DIMAGE_$(call uppercase,$(3)))
332$(eval BL_ASFLAGS := $($(call uppercase,$(3))_ASFLAGS))
333
334$(OBJ): $(2) $(filter-out %.d,$(MAKEFILE_LIST)) | $(3)_dirs
335	$$(ECHO) "  AS      $$<"
336	$$(Q)$$(AS) $$(ASFLAGS) $(BL_CPPFLAGS) $(BL_ASFLAGS) $(MAKE_DEP) -c $$< -o $$@
337
338-include $(DEP)
339
340endef
341
342
343# MAKE_LD generate the linker script using the C preprocessor
344#   $(1) = output linker script
345#   $(2) = input template
346#   $(3) = BL stage
347define MAKE_LD
348
349$(eval DEP := $(1).d)
350$(eval BL_CPPFLAGS := $($(call uppercase,$(3))_CPPFLAGS) -DIMAGE_$(call uppercase,$(3)))
351
352$(1): $(2) $(filter-out %.d,$(MAKEFILE_LIST)) | $(3)_dirs
353	$$(ECHO) "  PP      $$<"
354	$$(Q)$$(CPP) $$(CPPFLAGS) $(BL_CPPFLAGS) $(TF_CFLAGS_$(ARCH)) -P -x assembler-with-cpp -D__LINKER__ $(MAKE_DEP) -o $$@ $$<
355
356-include $(DEP)
357
358endef
359
360# MAKE_LIB_OBJS builds both C and assembly source files
361#   $(1) = output directory
362#   $(2) = list of source files
363#   $(3) = name of the library
364define MAKE_LIB_OBJS
365        $(eval C_OBJS := $(filter %.c,$(2)))
366        $(eval REMAIN := $(filter-out %.c,$(2)))
367        $(eval $(foreach obj,$(C_OBJS),$(call MAKE_C_LIB,$(1),$(obj),$(3))))
368
369        $(eval S_OBJS := $(filter %.S,$(REMAIN)))
370        $(eval REMAIN := $(filter-out %.S,$(REMAIN)))
371        $(eval $(foreach obj,$(S_OBJS),$(call MAKE_S_LIB,$(1),$(obj),$(3))))
372
373        $(and $(REMAIN),$(error Unexpected source files present: $(REMAIN)))
374endef
375
376
377# MAKE_OBJS builds both C and assembly source files
378#   $(1) = output directory
379#   $(2) = list of source files (both C and assembly)
380#   $(3) = BL stage
381define MAKE_OBJS
382        $(eval C_OBJS := $(filter %.c,$(2)))
383        $(eval REMAIN := $(filter-out %.c,$(2)))
384        $(eval $(foreach obj,$(C_OBJS),$(call MAKE_C,$(1),$(obj),$(3))))
385
386        $(eval S_OBJS := $(filter %.S,$(REMAIN)))
387        $(eval REMAIN := $(filter-out %.S,$(REMAIN)))
388        $(eval $(foreach obj,$(S_OBJS),$(call MAKE_S,$(1),$(obj),$(3))))
389
390        $(and $(REMAIN),$(error Unexpected source files present: $(REMAIN)))
391endef
392
393
394# NOTE: The line continuation '\' is required in the next define otherwise we
395# end up with a line-feed characer at the end of the last c filename.
396# Also bear this issue in mind if extending the list of supported filetypes.
397define SOURCES_TO_OBJS
398        $(notdir $(patsubst %.c,%.o,$(filter %.c,$(1)))) \
399        $(notdir $(patsubst %.S,%.o,$(filter %.S,$(1))))
400endef
401
402# Allow overriding the timestamp, for example for reproducible builds, or to
403# synchronize timestamps across multiple projects.
404# This must be set to a C string (including quotes where applicable).
405BUILD_MESSAGE_TIMESTAMP ?= __TIME__", "__DATE__
406
407.PHONY: libraries
408
409# MAKE_LIB_DIRS macro defines the target for the directory where
410# libraries are created
411define MAKE_LIB_DIRS
412        $(eval LIB_DIR    := ${BUILD_PLAT}/lib)
413        $(eval ROMLIB_DIR    := ${BUILD_PLAT}/romlib)
414        $(eval LIBWRAPPER_DIR := ${BUILD_PLAT}/libwrapper)
415        $(eval $(call MAKE_PREREQ_DIR,${LIB_DIR},${BUILD_PLAT}))
416        $(eval $(call MAKE_PREREQ_DIR,${ROMLIB_DIR},${BUILD_PLAT}))
417        $(eval $(call MAKE_PREREQ_DIR,${LIBWRAPPER_DIR},${BUILD_PLAT}))
418endef
419
420# MAKE_LIB macro defines the targets and options to build each BL image.
421# Arguments:
422#   $(1) = Library name
423define MAKE_LIB
424        $(eval BUILD_DIR  := ${BUILD_PLAT}/lib$(1))
425        $(eval LIB_DIR    := ${BUILD_PLAT}/lib)
426        $(eval ROMLIB_DIR    := ${BUILD_PLAT}/romlib)
427        $(eval SOURCES    := $(LIB$(call uppercase,$(1))_SRCS))
428        $(eval OBJS       := $(addprefix $(BUILD_DIR)/,$(call SOURCES_TO_OBJS,$(SOURCES))))
429
430$(eval $(call MAKE_PREREQ_DIR,${BUILD_DIR},${BUILD_PLAT}))
431$(eval $(call MAKE_LIB_OBJS,$(BUILD_DIR),$(SOURCES),$(1)))
432
433.PHONY : lib${1}_dirs
434lib${1}_dirs: | ${BUILD_DIR} ${LIB_DIR}  ${ROMLIB_DIR} ${LIBWRAPPER_DIR}
435libraries: ${LIB_DIR}/lib$(1).a
436ifneq ($(findstring armlink,$(notdir $(LD))),)
437LDPATHS = --userlibpath=${LIB_DIR}
438LDLIBS += --library=$(1)
439else
440LDPATHS = -L${LIB_DIR}
441LDLIBS += -l$(1)
442endif
443
444ifeq ($(USE_ROMLIB),1)
445LIBWRAPPER = -lwrappers
446endif
447
448all: ${LIB_DIR}/lib$(1).a
449
450${LIB_DIR}/lib$(1).a: $(OBJS)
451	$$(ECHO) "  AR      $$@"
452	$$(Q)$$(AR) cr $$@ $$?
453endef
454
455# Generate the path to one or more preprocessed linker scripts given the paths
456# of their sources.
457#
458# Arguments:
459#   $(1) = path to one or more linker script sources
460define linker_script_path
461        $(patsubst %.S,$(BUILD_DIR)/%,$(1))
462endef
463
464# MAKE_BL macro defines the targets and options to build each BL image.
465# Arguments:
466#   $(1) = BL stage
467#   $(2) = FIP command line option (if empty, image will not be included in the FIP)
468#   $(3) = FIP prefix (optional) (if FWU_, target is fwu_fip instead of fip)
469#   $(4) = BL encryption flag (optional) (0, 1)
470define MAKE_BL
471        $(eval BUILD_DIR  := ${BUILD_PLAT}/$(1))
472        $(eval BL_SOURCES := $($(call uppercase,$(1))_SOURCES))
473        $(eval SOURCES    := $(BL_SOURCES) $(BL_COMMON_SOURCES) $(PLAT_BL_COMMON_SOURCES))
474        $(eval OBJS       := $(addprefix $(BUILD_DIR)/,$(call SOURCES_TO_OBJS,$(SOURCES))))
475        $(eval MAPFILE    := $(call IMG_MAPFILE,$(1)))
476        $(eval ELF        := $(call IMG_ELF,$(1)))
477        $(eval DUMP       := $(call IMG_DUMP,$(1)))
478        $(eval BIN        := $(call IMG_BIN,$(1)))
479        $(eval ENC_BIN    := $(call IMG_ENC_BIN,$(1)))
480        $(eval BL_LIBS    := $($(call uppercase,$(1))_LIBS))
481
482        $(eval DEFAULT_LINKER_SCRIPT_SOURCE := $($(call uppercase,$(1))_DEFAULT_LINKER_SCRIPT_SOURCE))
483        $(eval DEFAULT_LINKER_SCRIPT := $(call linker_script_path,$(DEFAULT_LINKER_SCRIPT_SOURCE)))
484
485        $(eval LINKER_SCRIPT_SOURCES := $($(call uppercase,$(1))_LINKER_SCRIPT_SOURCES))
486        $(eval LINKER_SCRIPTS := $(call linker_script_path,$(LINKER_SCRIPT_SOURCES)))
487
488        # We use sort only to get a list of unique object directory names.
489        # ordering is not relevant but sort removes duplicates.
490        $(eval TEMP_OBJ_DIRS := $(sort $(dir ${OBJS} ${DEFAULT_LINKER_SCRIPT} ${LINKER_SCRIPTS})))
491        # The $(dir ) function leaves a trailing / on the directory names
492        # Rip off the / to match directory names with make rule targets.
493        $(eval OBJ_DIRS   := $(patsubst %/,%,$(TEMP_OBJ_DIRS)))
494
495# Create generators for object directory structure
496
497$(eval $(call MAKE_PREREQ_DIR,${BUILD_DIR},${BUILD_PLAT}))
498
499$(eval $(foreach objd,${OBJ_DIRS},
500        $(call MAKE_PREREQ_DIR,${objd},${BUILD_DIR})))
501
502.PHONY : ${1}_dirs
503
504# We use order-only prerequisites to ensure that directories are created,
505# but do not cause re-builds every time a file is written.
506${1}_dirs: | ${OBJ_DIRS}
507
508$(eval $(call MAKE_OBJS,$(BUILD_DIR),$(SOURCES),$(1)))
509
510# Generate targets to preprocess each required linker script
511$(eval $(foreach source,$(DEFAULT_LINKER_SCRIPT_SOURCE) $(LINKER_SCRIPT_SOURCES), \
512        $(call MAKE_LD,$(call linker_script_path,$(source)),$(source),$(1))))
513
514$(eval BL_LDFLAGS := $($(call uppercase,$(1))_LDFLAGS))
515
516ifeq ($(USE_ROMLIB),1)
517$(ELF): romlib.bin
518endif
519
520# MODULE_OBJS can be assigned by vendors with different compiled
521# object file path, and prebuilt object file path.
522$(eval OBJS += $(MODULE_OBJS))
523
524$(ELF): $(OBJS) $(DEFAULT_LINKER_SCRIPT) $(LINKER_SCRIPTS) | $(1)_dirs libraries $(BL_LIBS)
525	$$(ECHO) "  LD      $$@"
526ifdef MAKE_BUILD_STRINGS
527	$(call MAKE_BUILD_STRINGS, $(BUILD_DIR)/build_message.o)
528else
529	@echo 'const char build_message[] = "Built : "$(BUILD_MESSAGE_TIMESTAMP); \
530	       const char version_string[] = "${VERSION_STRING}"; \
531	       const char version[] = "${VERSION}";' | \
532		$$(CC) $$(TF_CFLAGS) $$(CFLAGS) -xc -c - -o $(BUILD_DIR)/build_message.o
533endif
534ifneq ($(findstring armlink,$(notdir $(LD))),)
535	$$(Q)$$(LD) -o $$@ $$(TF_LDFLAGS) $$(LDFLAGS) $(BL_LDFLAGS) --entry=${1}_entrypoint \
536		--predefine="-D__LINKER__=$(__LINKER__)" \
537		--predefine="-DTF_CFLAGS=$(TF_CFLAGS)" \
538		--map --list="$(MAPFILE)" --scatter=${PLAT_DIR}/scat/${1}.scat \
539		$(LDPATHS) $(LIBWRAPPER) $(LDLIBS) $(BL_LIBS) \
540		$(BUILD_DIR)/build_message.o $(OBJS)
541else ifneq ($(findstring gcc,$(notdir $(LD))),)
542	$$(Q)$$(LD) -o $$@ $$(TF_LDFLAGS) $$(LDFLAGS) -Wl,-Map=$(MAPFILE) \
543		$(addprefix -Wl$(comma)--script$(comma),$(LINKER_SCRIPTS)) -Wl,--script,$(DEFAULT_LINKER_SCRIPT) \
544		$(BUILD_DIR)/build_message.o \
545		$(OBJS) $(LDPATHS) $(LIBWRAPPER) $(LDLIBS) $(BL_LIBS)
546else
547	$$(Q)$$(LD) -o $$@ $$(TF_LDFLAGS) $$(LDFLAGS) $(BL_LDFLAGS) -Map=$(MAPFILE) \
548		$(addprefix -T ,$(LINKER_SCRIPTS)) --script $(DEFAULT_LINKER_SCRIPT) \
549		$(BUILD_DIR)/build_message.o \
550		$(OBJS) $(LDPATHS) $(LIBWRAPPER) $(LDLIBS) $(BL_LIBS)
551endif
552ifeq ($(DISABLE_BIN_GENERATION),1)
553	@${ECHO_BLANK_LINE}
554	@echo "Built $$@ successfully"
555	@${ECHO_BLANK_LINE}
556endif
557
558$(DUMP): $(ELF)
559	$${ECHO} "  OD      $$@"
560	$${Q}$${OD} -dx $$< > $$@
561
562$(BIN): $(ELF)
563	$${ECHO} "  BIN     $$@"
564	$$(Q)$$(OC) -O binary $$< $$@
565	@${ECHO_BLANK_LINE}
566	@echo "Built $$@ successfully"
567	@${ECHO_BLANK_LINE}
568
569.PHONY: $(1)
570ifeq ($(DISABLE_BIN_GENERATION),1)
571$(1): $(ELF) $(DUMP)
572else
573$(1): $(BIN) $(DUMP)
574endif
575
576all: $(1)
577
578ifeq ($(4),1)
579$(call ENCRYPT_FW,$(BIN),$(ENC_BIN))
580$(if $(2),$(call TOOL_ADD_IMG_PAYLOAD,$(1),$(BIN),--$(2),$(ENC_BIN),$(3), \
581		$(ENC_BIN)))
582else
583$(if $(2),$(call TOOL_ADD_IMG_PAYLOAD,$(1),$(BIN),--$(2),$(BIN),$(3)))
584endif
585
586endef
587
588# Convert device tree source file names to matching blobs
589#   $(1) = input dts
590define SOURCES_TO_DTBS
591        $(notdir $(patsubst %.dts,%.dtb,$(filter %.dts,$(1))))
592endef
593
594# MAKE_FDT_DIRS macro creates the prerequisite directories that host the
595# FDT binaries
596#   $(1) = output directory
597#   $(2) = input dts
598define MAKE_FDT_DIRS
599        $(eval DTBS       := $(addprefix $(1)/,$(call SOURCES_TO_DTBS,$(2))))
600        $(eval TEMP_DTB_DIRS := $(sort $(dir ${DTBS})))
601        # The $(dir ) function leaves a trailing / on the directory names
602        # Rip off the / to match directory names with make rule targets.
603        $(eval DTB_DIRS   := $(patsubst %/,%,$(TEMP_DTB_DIRS)))
604
605$(eval $(foreach objd,${DTB_DIRS},$(call MAKE_PREREQ_DIR,${objd},${BUILD_DIR})))
606
607fdt_dirs: ${DTB_DIRS}
608endef
609
610# MAKE_DTB generate the Flattened device tree binary
611#   $(1) = output directory
612#   $(2) = input dts
613define MAKE_DTB
614
615# List of DTB file(s) to generate, based on DTS file basename list
616$(eval DOBJ := $(addprefix $(1)/,$(call SOURCES_TO_DTBS,$(2))))
617# List of the pre-compiled DTS file(s)
618$(eval DPRE := $(addprefix $(1)/,$(patsubst %.dts,%.pre.dts,$(notdir $(2)))))
619# Dependencies of the pre-compiled DTS file(s) on its source and included files
620$(eval DTSDEP := $(patsubst %.dtb,%.o.d,$(DOBJ)))
621# Dependencies of the DT compilation on its pre-compiled DTS
622$(eval DTBDEP := $(patsubst %.dtb,%.d,$(DOBJ)))
623
624$(DOBJ): $(2) $(filter-out %.d,$(MAKEFILE_LIST)) | fdt_dirs
625	$${ECHO} "  CPP     $$<"
626	$(eval DTBS       := $(addprefix $(1)/,$(call SOURCES_TO_DTBS,$(2))))
627	$$(Q)$$(PP) $$(DTC_CPPFLAGS) -MT $(DTBS) -MMD -MF $(DTSDEP) -o $(DPRE) $$<
628	$${ECHO} "  DTC     $$<"
629	$$(Q)$$(DTC) $$(DTC_FLAGS) -d $(DTBDEP) -o $$@ $(DPRE)
630
631-include $(DTBDEP)
632-include $(DTSDEP)
633
634endef
635
636# MAKE_DTBS builds flattened device tree sources
637#   $(1) = output directory
638#   $(2) = list of flattened device tree source files
639define MAKE_DTBS
640        $(eval DOBJS := $(filter %.dts,$(2)))
641        $(eval REMAIN := $(filter-out %.dts,$(2)))
642        $(and $(REMAIN),$(error FDT_SOURCES contain non-DTS files: $(REMAIN)))
643        $(eval $(foreach obj,$(DOBJS),$(call MAKE_DTB,$(1),$(obj))))
644
645        $(eval $(call MAKE_FDT_DIRS,$(1),$(2)))
646
647dtbs: $(DTBS)
648all: dtbs
649endef
650