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