blob: abdd4d069e7b9dc8adba4aac09789df1123cea1b [file] [log] [blame]
Juan Castilloa3487d12015-08-18 14:23:04 +01001#
developer09f3e982022-03-23 18:51:48 +08002# Copyright (c) 2015-2022, ARM Limited and Contributors. All rights reserved.
Juan Castilloa3487d12015-08-18 14:23:04 +01003#
dp-armfa3cf0b2017-05-03 09:38:09 +01004# SPDX-License-Identifier: BSD-3-Clause
Juan Castilloa3487d12015-08-18 14:23:04 +01005#
6
Evan Lloyd870a18c2015-12-02 18:41:22 +00007# 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
Evan Lloydf2697142015-12-02 18:17:37 +000013# Some utility macros for manipulating awkward (whitespace) characters.
14blank :=
15space :=${blank} ${blank}
16
17# A user defined function to recursively search for a filename below a directory
18# $1 is the directory root of the recursive search (blank for current directory).
19# $2 is the file name to search for.
20define rwildcard
21$(strip $(foreach d,$(wildcard ${1}*),$(call rwildcard,${d}/,${2}) $(filter $(subst *,%,%${2}),${d})))
22endef
23
Yatharth Kochar115352c2015-10-02 13:58:52 +010024# This table is used in converting lower case to upper case.
25uppercase_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
26
27# Internal macro used for converting lower case to upper case.
28# $(1) = upper case table
29# $(2) = String to convert
30define uppercase_internal
31$(if $(1),$$(subst $(firstword $(1)),$(call uppercase_internal,$(wordlist 2,$(words $(1)),$(1)),$(2))),$(2))
32endef
33
34# A macro for converting a string to upper case
35# $(1) = String to convert
36define uppercase
37$(eval uppercase_result:=$(call uppercase_internal,$(uppercase_table),$(1)))$(uppercase_result)
38endef
39
Juan Castilloa3487d12015-08-18 14:23:04 +010040# Convenience function for adding build definitions
41# $(eval $(call add_define,FOO)) will have:
42# -DFOO if $(FOO) is empty; -DFOO=$(FOO) otherwise
43define add_define
44 DEFINES += -D$(1)$(if $(value $(1)),=$(value $(1)),)
45endef
46
Leonardo Sandoval65fca7c2020-09-10 12:18:27 -050047
48# Convenience function for addding multiple build definitions
49# $(eval $(call add_defines,FOO BOO))
50define add_defines
51 $(foreach def,$1,$(eval $(call add_define,$(def))))
52endef
53
Soren Brinkmann9efe6572016-06-09 13:36:27 -070054# Convenience function for adding build definitions
55# $(eval $(call add_define_val,FOO,BAR)) will have:
56# -DFOO=BAR
57define add_define_val
58 DEFINES += -D$(1)=$(2)
59endef
60
Juan Castilloa3487d12015-08-18 14:23:04 +010061# Convenience function for verifying option has a boolean value
62# $(eval $(call assert_boolean,FOO)) will assert FOO is 0 or 1
63define assert_boolean
Masahiro Yamada1ab9e922017-05-23 23:45:01 +090064 $(if $(filter-out 0 1,$($1)),$(error $1 must be boolean))
Juan Castilloa3487d12015-08-18 14:23:04 +010065endef
66
Leonardo Sandoval65fca7c2020-09-10 12:18:27 -050067# Convenience function for verifying options have boolean values
68# $(eval $(call assert_booleans,FOO BOO)) will assert FOO and BOO for 0 or 1 values
69define assert_booleans
70 $(foreach bool,$1,$(eval $(call assert_boolean,$(bool))))
71endef
72
Jeenu Viswambharanfca76802017-01-16 16:52:35 +0000730-9 := 0 1 2 3 4 5 6 7 8 9
74
75# Function to verify that a given option $(1) contains a numeric value
76define assert_numeric
77$(if $($(1)),,$(error $(1) must not be empty))
78$(eval __numeric := $($(1)))
79$(foreach d,$(0-9),$(eval __numeric := $(subst $(d),,$(__numeric))))
80$(if $(__numeric),$(error $(1) must be numeric))
81endef
82
Leonardo Sandoval65fca7c2020-09-10 12:18:27 -050083# Convenience function for verifying options have numeric values
84# $(eval $(call assert_numerics,FOO BOO)) will assert FOO and BOO contain numeric values
85define assert_numerics
86 $(foreach num,$1,$(eval $(call assert_numeric,$(num))))
87endef
88
Vijayenthiran Subramaniam3414e3a2020-02-08 21:27:30 +053089# CREATE_SEQ is a recursive function to create sequence of numbers from 1 to
90# $(2) and assign the sequence to $(1)
91define CREATE_SEQ
92$(if $(word $(2), $($(1))),\
93 $(eval $(1) += $(words $($(1))))\
94 $(eval $(1) := $(filter-out 0,$($(1)))),\
95 $(eval $(1) += $(words $($(1))))\
96 $(call CREATE_SEQ,$(1),$(2))\
97)
98endef
99
Juan Castilloa3487d12015-08-18 14:23:04 +0100100# IMG_LINKERFILE defines the linker script corresponding to a BL stage
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500101# $(1) = BL stage
Juan Castilloa3487d12015-08-18 14:23:04 +0100102define IMG_LINKERFILE
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500103 ${BUILD_DIR}/$(1).ld
Juan Castilloa3487d12015-08-18 14:23:04 +0100104endef
105
106# IMG_MAPFILE defines the output file describing the memory map corresponding
107# to a BL stage
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500108# $(1) = BL stage
Juan Castilloa3487d12015-08-18 14:23:04 +0100109define IMG_MAPFILE
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500110 ${BUILD_DIR}/$(1).map
Juan Castilloa3487d12015-08-18 14:23:04 +0100111endef
112
113# IMG_ELF defines the elf file corresponding to a BL stage
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500114# $(1) = BL stage
Juan Castilloa3487d12015-08-18 14:23:04 +0100115define IMG_ELF
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500116 ${BUILD_DIR}/$(1).elf
Juan Castilloa3487d12015-08-18 14:23:04 +0100117endef
118
119# IMG_DUMP defines the symbols dump file corresponding to a BL stage
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500120# $(1) = BL stage
Juan Castilloa3487d12015-08-18 14:23:04 +0100121define IMG_DUMP
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500122 ${BUILD_DIR}/$(1).dump
Juan Castilloa3487d12015-08-18 14:23:04 +0100123endef
124
125# IMG_BIN defines the default image file corresponding to a BL stage
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500126# $(1) = BL stage
Juan Castilloa3487d12015-08-18 14:23:04 +0100127define IMG_BIN
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500128 ${BUILD_PLAT}/$(1).bin
Juan Castilloa3487d12015-08-18 14:23:04 +0100129endef
130
Sumit Gargeec52442019-11-14 16:33:45 +0530131# IMG_ENC_BIN defines the default encrypted image file corresponding to a
132# BL stage
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500133# $(1) = BL stage
Sumit Gargeec52442019-11-14 16:33:45 +0530134define IMG_ENC_BIN
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500135 ${BUILD_PLAT}/$(1)_enc.bin
Sumit Gargeec52442019-11-14 16:33:45 +0530136endef
137
138# ENCRYPT_FW invokes enctool to encrypt firmware binary
139# $(1) = input firmware binary
140# $(2) = output encrypted firmware binary
141define ENCRYPT_FW
142$(2): $(1) enctool
143 $$(ECHO) " ENC $$<"
144 $$(Q)$$(ENCTOOL) $$(ENC_ARGS) -i $$< -o $$@
145endef
146
Masahiro Yamada6c2b4592018-01-26 11:42:01 +0900147# TOOL_ADD_PAYLOAD appends the command line arguments required by fiptool to
148# package a new payload and/or by cert_create to generate certificate.
149# Optionally, it adds the dependency on this payload
Juan Castilloa3487d12015-08-18 14:23:04 +0100150# $(1) = payload filename (i.e. bl31.bin)
Masahiro Yamadac85deee2017-12-23 23:56:18 +0900151# $(2) = command line option for the specified payload (i.e. --soc-fw)
Masahiro Yamada5c3ae332018-01-26 11:42:01 +0900152# $(3) = tool target dependency (optional) (ex. build/fvp/release/bl31.bin)
Masahiro Yamadacd7711d2018-01-26 11:42:01 +0900153# $(4) = FIP prefix (optional) (if FWU_, target is fwu_fip instead of fip)
Sumit Gargeec52442019-11-14 16:33:45 +0530154# $(5) = encrypted payload (optional) (ex. build/fvp/release/bl31_enc.bin)
Masahiro Yamada6c2b4592018-01-26 11:42:01 +0900155define TOOL_ADD_PAYLOAD
Sumit Gargeec52442019-11-14 16:33:45 +0530156ifneq ($(5),)
157 $(4)FIP_ARGS += $(2) $(5)
158 $(if $(3),$(4)CRT_DEPS += $(1))
159else
Masahiro Yamada714a6922018-01-26 11:42:01 +0900160 $(4)FIP_ARGS += $(2) $(1)
Sumit Gargeec52442019-11-14 16:33:45 +0530161 $(if $(3),$(4)CRT_DEPS += $(3))
162endif
Masahiro Yamada714a6922018-01-26 11:42:01 +0900163 $(if $(3),$(4)FIP_DEPS += $(3))
Masahiro Yamadaec154ad2018-01-26 11:42:01 +0900164 $(4)CRT_ARGS += $(2) $(1)
Juan Castilloa3487d12015-08-18 14:23:04 +0100165endef
166
Masahiro Yamadabfb64ac2018-02-01 16:31:09 +0900167# TOOL_ADD_IMG_PAYLOAD works like TOOL_ADD_PAYLOAD, but applies image filters
168# before passing them to host tools if BL*_PRE_TOOL_FILTER is defined.
169# $(1) = image_type (scp_bl2, bl33, etc.)
170# $(2) = payload filepath (ex. build/fvp/release/bl31.bin)
171# $(3) = command line option for the specified payload (ex. --soc-fw)
172# $(4) = tool target dependency (optional) (ex. build/fvp/release/bl31.bin)
173# $(5) = FIP prefix (optional) (if FWU_, target is fwu_fip instead of fip)
Sumit Gargeec52442019-11-14 16:33:45 +0530174# $(6) = encrypted payload (optional) (ex. build/fvp/release/bl31_enc.bin)
Masahiro Yamadabfb64ac2018-02-01 16:31:09 +0900175
176define TOOL_ADD_IMG_PAYLOAD
177
178$(eval PRE_TOOL_FILTER := $($(call uppercase,$(1))_PRE_TOOL_FILTER))
179
180ifneq ($(PRE_TOOL_FILTER),)
181
182$(eval PROCESSED_PATH := $(BUILD_PLAT)/$(1).bin$($(PRE_TOOL_FILTER)_SUFFIX))
183
184$(call $(PRE_TOOL_FILTER)_RULE,$(PROCESSED_PATH),$(2))
185
186$(PROCESSED_PATH): $(4)
187
Sumit Gargeec52442019-11-14 16:33:45 +0530188$(call TOOL_ADD_PAYLOAD,$(PROCESSED_PATH),$(3),$(PROCESSED_PATH),$(5),$(6))
Masahiro Yamadabfb64ac2018-02-01 16:31:09 +0900189
190else
Sumit Gargeec52442019-11-14 16:33:45 +0530191$(call TOOL_ADD_PAYLOAD,$(2),$(3),$(4),$(5),$(6))
Masahiro Yamadabfb64ac2018-02-01 16:31:09 +0900192endif
193endef
194
Yatharth Kochard1a93432015-10-12 12:33:47 +0100195# CERT_ADD_CMD_OPT adds a new command line option to the cert_create invocation
Juan Castilloa3487d12015-08-18 14:23:04 +0100196# $(1) = parameter filename
197# $(2) = cert_create command line option for the specified parameter
Masahiro Yamada5ebfda32018-01-26 11:42:01 +0900198# $(3) = FIP prefix (optional) (if FWU_, target is fwu_fip instead of fip)
Juan Castilloa3487d12015-08-18 14:23:04 +0100199define CERT_ADD_CMD_OPT
Masahiro Yamada5ebfda32018-01-26 11:42:01 +0900200 $(3)CRT_ARGS += $(2) $(1)
Juan Castilloa3487d12015-08-18 14:23:04 +0100201endef
202
Masahiro Yamada4d156802018-01-26 11:42:01 +0900203# TOOL_ADD_IMG allows the platform to specify an external image to be packed
204# in the FIP and/or for which certificate is generated. It also adds a
205# dependency on the image file, aborting the build if the file does not exist.
Masahiro Yamada9c5ca522018-01-26 11:42:01 +0900206# $(1) = image_type (scp_bl2, bl33, etc.)
Masahiro Yamadac85deee2017-12-23 23:56:18 +0900207# $(2) = command line option for fiptool (--scp-fw, --nt-fw, etc)
Masahiro Yamadacd7711d2018-01-26 11:42:01 +0900208# $(3) = FIP prefix (optional) (if FWU_, target is fwu_fip instead of fip)
Sumit Gargeec52442019-11-14 16:33:45 +0530209# $(4) = Image encryption flag (optional) (0, 1)
Juan Castilloa3487d12015-08-18 14:23:04 +0100210# Example:
Masahiro Yamada9c5ca522018-01-26 11:42:01 +0900211# $(eval $(call TOOL_ADD_IMG,bl33,--nt-fw))
Masahiro Yamada4d156802018-01-26 11:42:01 +0900212define TOOL_ADD_IMG
Masahiro Yamada9c5ca522018-01-26 11:42:01 +0900213 # Build option to specify the image filename (SCP_BL2, BL33, etc)
214 # This is the uppercase form of the first parameter
215 $(eval _V := $(call uppercase,$(1)))
216
Pali Rohára5416ab2020-11-24 16:53:04 +0100217 # $(check_$(1)_cmd) variable is executed in the check_$(1) target and also
218 # is put into the ${CHECK_$(3)FIP_CMD} variable which is executed by the
219 # target ${BUILD_PLAT}/${$(3)FIP_NAME}.
220 $(eval check_$(1)_cmd := \
221 $(if $(value $(_V)),,$$$$(error "Platform '${PLAT}' requires $(_V). Please set $(_V) to point to the right file")) \
222 $(if $(wildcard $(value $(_V))),,$$$$(error '$(_V)=$(value $(_V))' was specified, but '$(value $(_V))' does not exist)) \
223 )
224
Masahiro Yamada714a6922018-01-26 11:42:01 +0900225 $(3)CRT_DEPS += check_$(1)
Pali Rohára5416ab2020-11-24 16:53:04 +0100226 CHECK_$(3)FIP_CMD += $$(check_$(1)_cmd)
Sumit Gargeec52442019-11-14 16:33:45 +0530227ifeq ($(4),1)
228 $(eval ENC_BIN := ${BUILD_PLAT}/$(1)_enc.bin)
229 $(call ENCRYPT_FW,$(value $(_V)),$(ENC_BIN))
230 $(call TOOL_ADD_IMG_PAYLOAD,$(1),$(value $(_V)),$(2),$(ENC_BIN),$(3), \
231 $(ENC_BIN))
232else
Pali Rohára5416ab2020-11-24 16:53:04 +0100233 $(call TOOL_ADD_IMG_PAYLOAD,$(1),$(value $(_V)),$(2),$(if $(wildcard $(value $(_V))),$(value $(_V)),FORCE),$(3))
Sumit Gargeec52442019-11-14 16:33:45 +0530234endif
Juan Castilloa3487d12015-08-18 14:23:04 +0100235
Masahiro Yamada9dff1562017-12-24 13:08:00 +0900236.PHONY: check_$(1)
Juan Castilloa3487d12015-08-18 14:23:04 +0100237check_$(1):
Pali Rohára5416ab2020-11-24 16:53:04 +0100238 $(check_$(1)_cmd)
Juan Castilloa3487d12015-08-18 14:23:04 +0100239endef
240
Juan Castilloa3487d12015-08-18 14:23:04 +0100241################################################################################
Masahiro Yamadaeff36a92018-01-26 11:42:01 +0900242# Generic image processing filters
243################################################################################
244
245# GZIP
246define GZIP_RULE
247$(1): $(2)
Andre Przywaracf2bb082018-09-27 10:56:05 +0100248 $(ECHO) " GZIP $$@"
Masahiro Yamadaeff36a92018-01-26 11:42:01 +0900249 $(Q)gzip -n -f -9 $$< --stdout > $$@
250endef
251
252GZIP_SUFFIX := .gz
253
254################################################################################
Juan Castilloa3487d12015-08-18 14:23:04 +0100255# Auxiliary macros to build TF images from sources
256################################################################################
257
Masahiro Yamadae487bb62016-12-22 15:23:05 +0900258MAKE_DEP = -Wp,-MD,$(DEP) -MT $$@ -MP
Juan Castilloa3487d12015-08-18 14:23:04 +0100259
Roberto Vargas21360f32018-05-08 10:27:10 +0100260
261# MAKE_C_LIB builds a C source file and generates the dependency file
262# $(1) = output directory
263# $(2) = source file (%.c)
264# $(3) = library name
265define MAKE_C_LIB
266$(eval OBJ := $(1)/$(patsubst %.c,%.o,$(notdir $(2))))
267$(eval DEP := $(patsubst %.o,%.d,$(OBJ)))
268
269$(OBJ): $(2) $(filter-out %.d,$(MAKEFILE_LIST)) | lib$(3)_dirs
Andre Przywaracf2bb082018-09-27 10:56:05 +0100270 $$(ECHO) " CC $$<"
Roberto Vargas21360f32018-05-08 10:27:10 +0100271 $$(Q)$$(CC) $$(TF_CFLAGS) $$(CFLAGS) $(MAKE_DEP) -c $$< -o $$@
272
273-include $(DEP)
274
275endef
276
Antonio Nino Diaza884dfb2019-02-08 13:20:37 +0000277# MAKE_S_LIB builds an assembly source file and generates the dependency file
278# $(1) = output directory
279# $(2) = source file (%.S)
280# $(3) = library name
281define MAKE_S_LIB
282$(eval OBJ := $(1)/$(patsubst %.S,%.o,$(notdir $(2))))
283$(eval DEP := $(patsubst %.o,%.d,$(OBJ)))
284
285$(OBJ): $(2) $(filter-out %.d,$(MAKEFILE_LIST)) | lib$(3)_dirs
286 $$(ECHO) " AS $$<"
287 $$(Q)$$(AS) $$(ASFLAGS) $(MAKE_DEP) -c $$< -o $$@
288
289-include $(DEP)
290
291endef
292
Roberto Vargas21360f32018-05-08 10:27:10 +0100293
Juan Castilloa3487d12015-08-18 14:23:04 +0100294# MAKE_C builds a C source file and generates the dependency file
295# $(1) = output directory
296# $(2) = source file (%.c)
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500297# $(3) = BL stage
Juan Castilloa3487d12015-08-18 14:23:04 +0100298define MAKE_C
299
300$(eval OBJ := $(1)/$(patsubst %.c,%.o,$(notdir $(2))))
Masahiro Yamada56c53f62016-12-22 14:02:27 +0900301$(eval DEP := $(patsubst %.o,%.d,$(OBJ)))
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500302$(eval BL_CPPFLAGS := $($(call uppercase,$(3))_CPPFLAGS) -DIMAGE_$(call uppercase,$(3)))
303$(eval BL_CFLAGS := $($(call uppercase,$(3))_CFLAGS))
Juan Castilloa3487d12015-08-18 14:23:04 +0100304
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500305$(OBJ): $(2) $(filter-out %.d,$(MAKEFILE_LIST)) | $(3)_dirs
Andre Przywaracf2bb082018-09-27 10:56:05 +0100306 $$(ECHO) " CC $$<"
Masahiro Yamadaefcbfa82020-03-25 16:55:28 +0900307 $$(Q)$$(CC) $$(LTO_CFLAGS) $$(TF_CFLAGS) $$(CFLAGS) $(BL_CPPFLAGS) $(BL_CFLAGS) $(MAKE_DEP) -c $$< -o $$@
Juan Castilloa3487d12015-08-18 14:23:04 +0100308
Masahiro Yamada56c53f62016-12-22 14:02:27 +0900309-include $(DEP)
Juan Castilloa3487d12015-08-18 14:23:04 +0100310
311endef
312
313
314# MAKE_S builds an assembly source file and generates the dependency file
315# $(1) = output directory
316# $(2) = assembly file (%.S)
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500317# $(3) = BL stage
Juan Castilloa3487d12015-08-18 14:23:04 +0100318define MAKE_S
319
320$(eval OBJ := $(1)/$(patsubst %.S,%.o,$(notdir $(2))))
Masahiro Yamada56c53f62016-12-22 14:02:27 +0900321$(eval DEP := $(patsubst %.o,%.d,$(OBJ)))
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500322$(eval BL_CPPFLAGS := $($(call uppercase,$(3))_CPPFLAGS) -DIMAGE_$(call uppercase,$(3)))
323$(eval BL_ASFLAGS := $($(call uppercase,$(3))_ASFLAGS))
Juan Castilloa3487d12015-08-18 14:23:04 +0100324
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500325$(OBJ): $(2) $(filter-out %.d,$(MAKEFILE_LIST)) | $(3)_dirs
Andre Przywaracf2bb082018-09-27 10:56:05 +0100326 $$(ECHO) " AS $$<"
Masahiro Yamadaefcbfa82020-03-25 16:55:28 +0900327 $$(Q)$$(AS) $$(ASFLAGS) $(BL_CPPFLAGS) $(BL_ASFLAGS) $(MAKE_DEP) -c $$< -o $$@
Juan Castilloa3487d12015-08-18 14:23:04 +0100328
Masahiro Yamada56c53f62016-12-22 14:02:27 +0900329-include $(DEP)
Juan Castilloa3487d12015-08-18 14:23:04 +0100330
331endef
332
333
334# MAKE_LD generate the linker script using the C preprocessor
335# $(1) = output linker script
336# $(2) = input template
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500337# $(3) = BL stage
Juan Castilloa3487d12015-08-18 14:23:04 +0100338define MAKE_LD
339
Masahiro Yamada56c53f62016-12-22 14:02:27 +0900340$(eval DEP := $(1).d)
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500341$(eval BL_CPPFLAGS := $($(call uppercase,$(3))_CPPFLAGS) -DIMAGE_$(call uppercase,$(3)))
Juan Castilloa3487d12015-08-18 14:23:04 +0100342
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500343$(1): $(2) $(filter-out %.d,$(MAKEFILE_LIST)) | $(3)_dirs
Andre Przywaracf2bb082018-09-27 10:56:05 +0100344 $$(ECHO) " PP $$<"
Masahiro Yamadaefcbfa82020-03-25 16:55:28 +0900345 $$(Q)$$(CPP) $$(CPPFLAGS) $(BL_CPPFLAGS) $(TF_CFLAGS_$(ARCH)) -P -x assembler-with-cpp -D__LINKER__ $(MAKE_DEP) -o $$@ $$<
Juan Castilloa3487d12015-08-18 14:23:04 +0100346
Masahiro Yamada56c53f62016-12-22 14:02:27 +0900347-include $(DEP)
Juan Castilloa3487d12015-08-18 14:23:04 +0100348
349endef
350
Antonio Nino Diaza884dfb2019-02-08 13:20:37 +0000351# MAKE_LIB_OBJS builds both C and assembly source files
Roberto Vargas21360f32018-05-08 10:27:10 +0100352# $(1) = output directory
353# $(2) = list of source files
354# $(3) = name of the library
355define MAKE_LIB_OBJS
356 $(eval C_OBJS := $(filter %.c,$(2)))
357 $(eval REMAIN := $(filter-out %.c,$(2)))
358 $(eval $(foreach obj,$(C_OBJS),$(call MAKE_C_LIB,$(1),$(obj),$(3))))
359
Antonio Nino Diaza884dfb2019-02-08 13:20:37 +0000360 $(eval S_OBJS := $(filter %.S,$(REMAIN)))
361 $(eval REMAIN := $(filter-out %.S,$(REMAIN)))
362 $(eval $(foreach obj,$(S_OBJS),$(call MAKE_S_LIB,$(1),$(obj),$(3))))
363
Roberto Vargas21360f32018-05-08 10:27:10 +0100364 $(and $(REMAIN),$(error Unexpected source files present: $(REMAIN)))
365endef
366
Juan Castilloa3487d12015-08-18 14:23:04 +0100367
368# MAKE_OBJS builds both C and assembly source files
369# $(1) = output directory
370# $(2) = list of source files (both C and assembly)
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500371# $(3) = BL stage
Juan Castilloa3487d12015-08-18 14:23:04 +0100372define MAKE_OBJS
373 $(eval C_OBJS := $(filter %.c,$(2)))
374 $(eval REMAIN := $(filter-out %.c,$(2)))
375 $(eval $(foreach obj,$(C_OBJS),$(call MAKE_C,$(1),$(obj),$(3))))
376
377 $(eval S_OBJS := $(filter %.S,$(REMAIN)))
378 $(eval REMAIN := $(filter-out %.S,$(REMAIN)))
379 $(eval $(foreach obj,$(S_OBJS),$(call MAKE_S,$(1),$(obj),$(3))))
380
381 $(and $(REMAIN),$(error Unexpected source files present: $(REMAIN)))
382endef
383
384
385# NOTE: The line continuation '\' is required in the next define otherwise we
386# end up with a line-feed characer at the end of the last c filename.
Evan Lloyda71d2592015-12-02 18:56:06 +0000387# Also bear this issue in mind if extending the list of supported filetypes.
Juan Castilloa3487d12015-08-18 14:23:04 +0100388define SOURCES_TO_OBJS
389 $(notdir $(patsubst %.c,%.o,$(filter %.c,$(1)))) \
390 $(notdir $(patsubst %.S,%.o,$(filter %.S,$(1))))
391endef
392
Patrick Georgi8a10e342016-01-28 14:46:18 +0100393# Allow overriding the timestamp, for example for reproducible builds, or to
394# synchronize timestamps across multiple projects.
395# This must be set to a C string (including quotes where applicable).
396BUILD_MESSAGE_TIMESTAMP ?= __TIME__", "__DATE__
Juan Castilloa3487d12015-08-18 14:23:04 +0100397
Roberto Vargas21360f32018-05-08 10:27:10 +0100398.PHONY: libraries
399
Roberto Vargase92111a2018-05-22 16:05:42 +0100400# MAKE_LIB_DIRS macro defines the target for the directory where
Roberto Vargas21360f32018-05-08 10:27:10 +0100401# libraries are created
Roberto Vargase92111a2018-05-22 16:05:42 +0100402define MAKE_LIB_DIRS
Roberto Vargas21360f32018-05-08 10:27:10 +0100403 $(eval LIB_DIR := ${BUILD_PLAT}/lib)
Roberto Vargase92111a2018-05-22 16:05:42 +0100404 $(eval ROMLIB_DIR := ${BUILD_PLAT}/romlib)
405 $(eval LIBWRAPPER_DIR := ${BUILD_PLAT}/libwrapper)
406 $(eval $(call MAKE_PREREQ_DIR,${LIB_DIR},${BUILD_PLAT}))
407 $(eval $(call MAKE_PREREQ_DIR,${ROMLIB_DIR},${BUILD_PLAT}))
408 $(eval $(call MAKE_PREREQ_DIR,${LIBWRAPPER_DIR},${BUILD_PLAT}))
Roberto Vargas21360f32018-05-08 10:27:10 +0100409endef
410
411# MAKE_LIB macro defines the targets and options to build each BL image.
412# Arguments:
413# $(1) = Library name
414define MAKE_LIB
415 $(eval BUILD_DIR := ${BUILD_PLAT}/lib$(1))
416 $(eval LIB_DIR := ${BUILD_PLAT}/lib)
Roberto Vargase92111a2018-05-22 16:05:42 +0100417 $(eval ROMLIB_DIR := ${BUILD_PLAT}/romlib)
Roberto Vargas21360f32018-05-08 10:27:10 +0100418 $(eval SOURCES := $(LIB$(call uppercase,$(1))_SRCS))
419 $(eval OBJS := $(addprefix $(BUILD_DIR)/,$(call SOURCES_TO_OBJS,$(SOURCES))))
420
421$(eval $(call MAKE_PREREQ_DIR,${BUILD_DIR},${BUILD_PLAT}))
422$(eval $(call MAKE_LIB_OBJS,$(BUILD_DIR),$(SOURCES),$(1)))
423
424.PHONY : lib${1}_dirs
Roberto Vargase92111a2018-05-22 16:05:42 +0100425lib${1}_dirs: | ${BUILD_DIR} ${LIB_DIR} ${ROMLIB_DIR} ${LIBWRAPPER_DIR}
Roberto Vargas21360f32018-05-08 10:27:10 +0100426libraries: ${LIB_DIR}/lib$(1).a
Varun Wadekar4d034c52019-01-11 14:47:48 -0800427ifneq ($(findstring armlink,$(notdir $(LD))),)
428LDPATHS = --userlibpath=${LIB_DIR}
429LDLIBS += --library=$(1)
430else
Roberto Vargas21360f32018-05-08 10:27:10 +0100431LDPATHS = -L${LIB_DIR}
432LDLIBS += -l$(1)
Varun Wadekar4d034c52019-01-11 14:47:48 -0800433endif
Roberto Vargas21360f32018-05-08 10:27:10 +0100434
Roberto Vargase92111a2018-05-22 16:05:42 +0100435ifeq ($(USE_ROMLIB),1)
Sathees Balyaf5ec5002018-10-18 19:14:21 +0100436LIBWRAPPER = -lwrappers
Roberto Vargase92111a2018-05-22 16:05:42 +0100437endif
438
Roberto Vargas21360f32018-05-08 10:27:10 +0100439all: ${LIB_DIR}/lib$(1).a
440
441${LIB_DIR}/lib$(1).a: $(OBJS)
Andre Przywaracf2bb082018-09-27 10:56:05 +0100442 $$(ECHO) " AR $$@"
Roberto Vargas21360f32018-05-08 10:27:10 +0100443 $$(Q)$$(AR) cr $$@ $$?
444endef
445
Juan Castilloa3487d12015-08-18 14:23:04 +0100446# MAKE_BL macro defines the targets and options to build each BL image.
447# Arguments:
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500448# $(1) = BL stage
Juan Castillo8e04dec2016-01-05 11:55:36 +0000449# $(2) = FIP command line option (if empty, image will not be included in the FIP)
Masahiro Yamadacd7711d2018-01-26 11:42:01 +0900450# $(3) = FIP prefix (optional) (if FWU_, target is fwu_fip instead of fip)
Sumit Gargeec52442019-11-14 16:33:45 +0530451# $(4) = BL encryption flag (optional) (0, 1)
Juan Castilloa3487d12015-08-18 14:23:04 +0100452define MAKE_BL
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500453 $(eval BUILD_DIR := ${BUILD_PLAT}/$(1))
454 $(eval BL_SOURCES := $($(call uppercase,$(1))_SOURCES))
Yatharth Kochar115352c2015-10-02 13:58:52 +0100455 $(eval SOURCES := $(BL_SOURCES) $(BL_COMMON_SOURCES) $(PLAT_BL_COMMON_SOURCES))
Juan Castilloa3487d12015-08-18 14:23:04 +0100456 $(eval OBJS := $(addprefix $(BUILD_DIR)/,$(call SOURCES_TO_OBJS,$(SOURCES))))
457 $(eval LINKERFILE := $(call IMG_LINKERFILE,$(1)))
458 $(eval MAPFILE := $(call IMG_MAPFILE,$(1)))
459 $(eval ELF := $(call IMG_ELF,$(1)))
460 $(eval DUMP := $(call IMG_DUMP,$(1)))
461 $(eval BIN := $(call IMG_BIN,$(1)))
Sumit Gargeec52442019-11-14 16:33:45 +0530462 $(eval ENC_BIN := $(call IMG_ENC_BIN,$(1)))
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500463 $(eval BL_LINKERFILE := $($(call uppercase,$(1))_LINKERFILE))
464 $(eval BL_LIBS := $($(call uppercase,$(1))_LIBS))
Evan Lloyd93d3b702015-12-03 12:19:30 +0000465 # We use sort only to get a list of unique object directory names.
466 # ordering is not relevant but sort removes duplicates.
Evan Lloyd4c3055f2017-04-07 16:58:57 +0100467 $(eval TEMP_OBJ_DIRS := $(sort $(dir ${OBJS} ${LINKERFILE})))
Evan Lloyd93d3b702015-12-03 12:19:30 +0000468 # The $(dir ) function leaves a trailing / on the directory names
Masahiro Yamada823482b2017-01-19 19:31:00 +0900469 # Rip off the / to match directory names with make rule targets.
470 $(eval OBJ_DIRS := $(patsubst %/,%,$(TEMP_OBJ_DIRS)))
Evan Lloyd93d3b702015-12-03 12:19:30 +0000471
472# Create generators for object directory structure
Juan Castilloa3487d12015-08-18 14:23:04 +0100473
Masahiro Yamadae2395b42017-11-04 03:12:28 +0900474$(eval $(call MAKE_PREREQ_DIR,${BUILD_DIR},${BUILD_PLAT}))
Evan Lloyd4c3055f2017-04-07 16:58:57 +0100475
476$(eval $(foreach objd,${OBJ_DIRS},$(call MAKE_PREREQ_DIR,${objd},${BUILD_DIR})))
Juan Castilloa3487d12015-08-18 14:23:04 +0100477
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500478.PHONY : ${1}_dirs
Juan Castilloa3487d12015-08-18 14:23:04 +0100479
Evan Lloyd93d3b702015-12-03 12:19:30 +0000480# We use order-only prerequisites to ensure that directories are created,
481# but do not cause re-builds every time a file is written.
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500482${1}_dirs: | ${OBJ_DIRS}
Evan Lloyd93d3b702015-12-03 12:19:30 +0000483
484$(eval $(call MAKE_OBJS,$(BUILD_DIR),$(SOURCES),$(1)))
Masahiro Yamada4abe9232017-01-12 10:48:22 +0900485$(eval $(call MAKE_LD,$(LINKERFILE),$(BL_LINKERFILE),$(1)))
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500486$(eval BL_LDFLAGS := $($(call uppercase,$(1))_LDFLAGS))
Evan Lloyd93d3b702015-12-03 12:19:30 +0000487
Roberto Vargase92111a2018-05-22 16:05:42 +0100488ifeq ($(USE_ROMLIB),1)
489$(ELF): romlib.bin
490endif
491
developer09f3e982022-03-23 18:51:48 +0800492# MODULE_OBJS can be assigned by vendors with different compiled
493# object file path, and prebuilt object file path.
494$(eval OBJS += $(MODULE_OBJS))
495
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500496$(ELF): $(OBJS) $(LINKERFILE) | $(1)_dirs libraries $(BL_LIBS)
Andre Przywaracf2bb082018-09-27 10:56:05 +0100497 $$(ECHO) " LD $$@"
Evan Lloydcf6e9d42015-12-03 12:58:52 +0000498ifdef MAKE_BUILD_STRINGS
499 $(call MAKE_BUILD_STRINGS, $(BUILD_DIR)/build_message.o)
500else
Patrick Georgi8a10e342016-01-28 14:46:18 +0100501 @echo 'const char build_message[] = "Built : "$(BUILD_MESSAGE_TIMESTAMP); \
laurenw-arme954f652022-07-12 10:12:05 -0500502 const char version_string[] = "${VERSION_STRING}"; \
503 const char version[] = "${VERSION}";' | \
Masahiro Yamada49071ae2016-12-22 12:39:55 +0900504 $$(CC) $$(TF_CFLAGS) $$(CFLAGS) -xc -c - -o $(BUILD_DIR)/build_message.o
Evan Lloydcf6e9d42015-12-03 12:58:52 +0000505endif
Varun Wadekar4d034c52019-01-11 14:47:48 -0800506ifneq ($(findstring armlink,$(notdir $(LD))),)
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500507 $$(Q)$$(LD) -o $$@ $$(TF_LDFLAGS) $$(LDFLAGS) $(BL_LDFLAGS) --entry=${1}_entrypoint \
Varun Wadekar4d034c52019-01-11 14:47:48 -0800508 --predefine="-D__LINKER__=$(__LINKER__)" \
509 --predefine="-DTF_CFLAGS=$(TF_CFLAGS)" \
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500510 --map --list="$(MAPFILE)" --scatter=${PLAT_DIR}/scat/${1}.scat \
Varun Wadekar4d034c52019-01-11 14:47:48 -0800511 $(LDPATHS) $(LIBWRAPPER) $(LDLIBS) $(BL_LIBS) \
512 $(BUILD_DIR)/build_message.o $(OBJS)
zelalem-aweked5f45272019-11-12 16:20:17 -0600513else ifneq ($(findstring gcc,$(notdir $(LD))),)
514 $$(Q)$$(LD) -o $$@ $$(TF_LDFLAGS) $$(LDFLAGS) -Wl,-Map=$(MAPFILE) \
developer09f3e982022-03-23 18:51:48 +0800515 -Wl,-dT $(LINKERFILE) $(EXTRA_LINKERFILE) $(BUILD_DIR)/build_message.o \
zelalem-aweked5f45272019-11-12 16:20:17 -0600516 $(OBJS) $(LDPATHS) $(LIBWRAPPER) $(LDLIBS) $(BL_LIBS)
Varun Wadekar4d034c52019-01-11 14:47:48 -0800517else
Masahiro Yamadae2e8e102020-01-17 13:44:20 +0900518 $$(Q)$$(LD) -o $$@ $$(TF_LDFLAGS) $$(LDFLAGS) $(BL_LDFLAGS) -Map=$(MAPFILE) \
Roberto Vargas21360f32018-05-08 10:27:10 +0100519 --script $(LINKERFILE) $(BUILD_DIR)/build_message.o \
Sathees Balyaf5ec5002018-10-18 19:14:21 +0100520 $(OBJS) $(LDPATHS) $(LIBWRAPPER) $(LDLIBS) $(BL_LIBS)
Varun Wadekar4d034c52019-01-11 14:47:48 -0800521endif
Christoph Müllner4f088e42019-04-24 09:45:30 +0200522ifeq ($(DISABLE_BIN_GENERATION),1)
523 @${ECHO_BLANK_LINE}
524 @echo "Built $$@ successfully"
525 @${ECHO_BLANK_LINE}
526endif
Juan Castilloa3487d12015-08-18 14:23:04 +0100527
528$(DUMP): $(ELF)
Andre Przywaracf2bb082018-09-27 10:56:05 +0100529 $${ECHO} " OD $$@"
Juan Castilloa3487d12015-08-18 14:23:04 +0100530 $${Q}$${OD} -dx $$< > $$@
531
532$(BIN): $(ELF)
Andre Przywaracf2bb082018-09-27 10:56:05 +0100533 $${ECHO} " BIN $$@"
Juan Castilloa3487d12015-08-18 14:23:04 +0100534 $$(Q)$$(OC) -O binary $$< $$@
Evan Lloyd1c5f3602017-04-11 16:52:00 +0100535 @${ECHO_BLANK_LINE}
Juan Castilloa3487d12015-08-18 14:23:04 +0100536 @echo "Built $$@ successfully"
Evan Lloyd1c5f3602017-04-11 16:52:00 +0100537 @${ECHO_BLANK_LINE}
Juan Castilloa3487d12015-08-18 14:23:04 +0100538
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500539.PHONY: $(1)
Christoph Müllner4f088e42019-04-24 09:45:30 +0200540ifeq ($(DISABLE_BIN_GENERATION),1)
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500541$(1): $(ELF) $(DUMP)
Christoph Müllner4f088e42019-04-24 09:45:30 +0200542else
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500543$(1): $(BIN) $(DUMP)
Christoph Müllner4f088e42019-04-24 09:45:30 +0200544endif
Juan Castilloa3487d12015-08-18 14:23:04 +0100545
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500546all: $(1)
Juan Castilloa3487d12015-08-18 14:23:04 +0100547
Sumit Gargeec52442019-11-14 16:33:45 +0530548ifeq ($(4),1)
549$(call ENCRYPT_FW,$(BIN),$(ENC_BIN))
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500550$(if $(2),$(call TOOL_ADD_IMG_PAYLOAD,$(1),$(BIN),--$(2),$(ENC_BIN),$(3), \
Sumit Gargeec52442019-11-14 16:33:45 +0530551 $(ENC_BIN)))
552else
Zelalem Awekeb44dec12021-07-11 17:25:48 -0500553$(if $(2),$(call TOOL_ADD_IMG_PAYLOAD,$(1),$(BIN),--$(2),$(BIN),$(3)))
Sumit Gargeec52442019-11-14 16:33:45 +0530554endif
Juan Castilloa3487d12015-08-18 14:23:04 +0100555
556endef
557
Soby Mathewab4181d2017-12-14 17:44:56 +0000558# Convert device tree source file names to matching blobs
559# $(1) = input dts
Nishanth Menon4ac02ba2016-10-14 01:13:57 +0000560define SOURCES_TO_DTBS
561 $(notdir $(patsubst %.dts,%.dtb,$(filter %.dts,$(1))))
562endef
563
Soby Mathewab4181d2017-12-14 17:44:56 +0000564# MAKE_FDT_DIRS macro creates the prerequisite directories that host the
565# FDT binaries
566# $(1) = output directory
567# $(2) = input dts
568define MAKE_FDT_DIRS
569 $(eval DTBS := $(addprefix $(1)/,$(call SOURCES_TO_DTBS,$(2))))
Nishanth Menon4ac02ba2016-10-14 01:13:57 +0000570 $(eval TEMP_DTB_DIRS := $(sort $(dir ${DTBS})))
571 # The $(dir ) function leaves a trailing / on the directory names
572 # Rip off the / to match directory names with make rule targets.
573 $(eval DTB_DIRS := $(patsubst %/,%,$(TEMP_DTB_DIRS)))
574
575$(eval $(foreach objd,${DTB_DIRS},$(call MAKE_PREREQ_DIR,${objd},${BUILD_DIR})))
576
577fdt_dirs: ${DTB_DIRS}
Nishanth Menon4ac02ba2016-10-14 01:13:57 +0000578endef
579
Soby Mathewab4181d2017-12-14 17:44:56 +0000580# MAKE_DTB generate the Flattened device tree binary
Nishanth Menon4ac02ba2016-10-14 01:13:57 +0000581# $(1) = output directory
582# $(2) = input dts
583define MAKE_DTB
584
Yann Gautierf3831802018-09-04 10:44:00 +0200585# List of DTB file(s) to generate, based on DTS file basename list
Soby Mathewab4181d2017-12-14 17:44:56 +0000586$(eval DOBJ := $(addprefix $(1)/,$(call SOURCES_TO_DTBS,$(2))))
Yann Gautierf3831802018-09-04 10:44:00 +0200587# List of the pre-compiled DTS file(s)
Yann Gautier2cf1dbc2018-06-18 16:00:23 +0200588$(eval DPRE := $(addprefix $(1)/,$(patsubst %.dts,%.pre.dts,$(notdir $(2)))))
Yann Gautierf3831802018-09-04 10:44:00 +0200589# Dependencies of the pre-compiled DTS file(s) on its source and included files
590$(eval DTSDEP := $(patsubst %.dtb,%.o.d,$(DOBJ)))
591# Dependencies of the DT compilation on its pre-compiled DTS
592$(eval DTBDEP := $(patsubst %.dtb,%.d,$(DOBJ)))
Nishanth Menon4ac02ba2016-10-14 01:13:57 +0000593
Stephen Warrenc4d562a2018-02-21 17:13:50 -0700594$(DOBJ): $(2) $(filter-out %.d,$(MAKEFILE_LIST)) | fdt_dirs
Andre Przywaracf2bb082018-09-27 10:56:05 +0100595 $${ECHO} " CPP $$<"
Yann Gautierf3831802018-09-04 10:44:00 +0200596 $(eval DTBS := $(addprefix $(1)/,$(call SOURCES_TO_DTBS,$(2))))
Manish Pandeye6c5a232019-01-21 14:50:10 +0000597 $$(Q)$$(PP) $$(DTC_CPPFLAGS) -MT $(DTBS) -MMD -MF $(DTSDEP) -o $(DPRE) $$<
Andre Przywaracf2bb082018-09-27 10:56:05 +0100598 $${ECHO} " DTC $$<"
Balint Dobszay5ce2c322020-01-10 17:16:27 +0100599 $$(Q)$$(DTC) $$(DTC_FLAGS) -d $(DTBDEP) -o $$@ $(DPRE)
Nishanth Menon4ac02ba2016-10-14 01:13:57 +0000600
Yann Gautierf3831802018-09-04 10:44:00 +0200601-include $(DTBDEP)
602-include $(DTSDEP)
Nishanth Menon4ac02ba2016-10-14 01:13:57 +0000603
604endef
605
606# MAKE_DTBS builds flattened device tree sources
607# $(1) = output directory
608# $(2) = list of flattened device tree source files
609define MAKE_DTBS
610 $(eval DOBJS := $(filter %.dts,$(2)))
611 $(eval REMAIN := $(filter-out %.dts,$(2)))
Soby Mathewab4181d2017-12-14 17:44:56 +0000612 $(and $(REMAIN),$(error FDT_SOURCES contain non-DTS files: $(REMAIN)))
Nishanth Menon4ac02ba2016-10-14 01:13:57 +0000613 $(eval $(foreach obj,$(DOBJS),$(call MAKE_DTB,$(1),$(obj))))
614
Soby Mathewab4181d2017-12-14 17:44:56 +0000615 $(eval $(call MAKE_FDT_DIRS,$(1),$(2)))
616
617dtbs: $(DTBS)
618all: dtbs
Nishanth Menon4ac02ba2016-10-14 01:13:57 +0000619endef