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