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