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