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