blob: 34d82c9a373c7b06ccd31d66f4ccbba205373642 [file] [log] [blame]
Juan Castilloa3487d12015-08-18 14:23:04 +01001#
Jeenu Viswambharanfca76802017-01-16 16:52:35 +00002# Copyright (c) 2015-2017, 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
Soren Brinkmann9efe6572016-06-09 13:36:27 -070047# Convenience function for adding build definitions
48# $(eval $(call add_define_val,FOO,BAR)) will have:
49# -DFOO=BAR
50define add_define_val
51 DEFINES += -D$(1)=$(2)
52endef
53
Juan Castilloa3487d12015-08-18 14:23:04 +010054# Convenience function for verifying option has a boolean value
55# $(eval $(call assert_boolean,FOO)) will assert FOO is 0 or 1
56define assert_boolean
Masahiro Yamada1ab9e922017-05-23 23:45:01 +090057 $(if $(filter-out 0 1,$($1)),$(error $1 must be boolean))
Juan Castilloa3487d12015-08-18 14:23:04 +010058endef
59
Jeenu Viswambharanfca76802017-01-16 16:52:35 +0000600-9 := 0 1 2 3 4 5 6 7 8 9
61
62# Function to verify that a given option $(1) contains a numeric value
63define assert_numeric
64$(if $($(1)),,$(error $(1) must not be empty))
65$(eval __numeric := $($(1)))
66$(foreach d,$(0-9),$(eval __numeric := $(subst $(d),,$(__numeric))))
67$(if $(__numeric),$(error $(1) must be numeric))
68endef
69
Juan Castilloa3487d12015-08-18 14:23:04 +010070# IMG_LINKERFILE defines the linker script corresponding to a BL stage
71# $(1) = BL stage (2, 30, 31, 32, 33)
72define IMG_LINKERFILE
73 ${BUILD_DIR}/bl$(1).ld
74endef
75
76# IMG_MAPFILE defines the output file describing the memory map corresponding
77# to a BL stage
78# $(1) = BL stage (2, 30, 31, 32, 33)
79define IMG_MAPFILE
80 ${BUILD_DIR}/bl$(1).map
81endef
82
83# IMG_ELF defines the elf file corresponding to a BL stage
84# $(1) = BL stage (2, 30, 31, 32, 33)
85define IMG_ELF
86 ${BUILD_DIR}/bl$(1).elf
87endef
88
89# IMG_DUMP defines the symbols dump file corresponding to a BL stage
90# $(1) = BL stage (2, 30, 31, 32, 33)
91define IMG_DUMP
92 ${BUILD_DIR}/bl$(1).dump
93endef
94
95# IMG_BIN defines the default image file corresponding to a BL stage
96# $(1) = BL stage (2, 30, 31, 32, 33)
97define IMG_BIN
98 ${BUILD_PLAT}/bl$(1).bin
99endef
100
dp-arm4972ec52016-05-25 16:20:20 +0100101# FIP_ADD_PAYLOAD appends the command line arguments required by fiptool
Juan Castilloa3487d12015-08-18 14:23:04 +0100102# to package a new payload. Optionally, it adds the dependency on this payload
103# $(1) = payload filename (i.e. bl31.bin)
104# $(2) = command line option for the specified payload (i.e. --bl31)
105# $(3) = fip target dependency (optional) (i.e. bl31)
106define FIP_ADD_PAYLOAD
107 $(eval FIP_ARGS += $(2) $(1))
108 $(eval $(if $(3),FIP_DEPS += $(3)))
109endef
110
Yatharth Kochard1a93432015-10-12 12:33:47 +0100111# CERT_ADD_CMD_OPT adds a new command line option to the cert_create invocation
Juan Castilloa3487d12015-08-18 14:23:04 +0100112# $(1) = parameter filename
113# $(2) = cert_create command line option for the specified parameter
114# $(3) = input parameter (false if empty)
115define CERT_ADD_CMD_OPT
116 $(eval $(if $(3),CRT_DEPS += $(1)))
117 $(eval CRT_ARGS += $(2) $(1))
118endef
119
120# FIP_ADD_IMG allows the platform to specify an image to be packed in the FIP
121# using a build option. It also adds a dependency on the image file, aborting
122# the build if the file does not exist.
Juan Castilloa72b6472015-12-10 15:49:17 +0000123# $(1) = build option to specify the image filename (SCP_BL2, BL33, etc)
dp-arm4972ec52016-05-25 16:20:20 +0100124# $(2) = command line option for fiptool (scp_bl2, bl33, etc)
Juan Castilloa3487d12015-08-18 14:23:04 +0100125# Example:
126# $(eval $(call FIP_ADD_IMG,BL33,--bl33))
127define FIP_ADD_IMG
128 CRT_DEPS += check_$(1)
129 FIP_DEPS += check_$(1)
130 $(call FIP_ADD_PAYLOAD,$(value $(1)),$(2))
131
132check_$(1):
133 $$(if $(value $(1)),,$$(error "Platform '${PLAT}' requires $(1). Please set $(1) to point to the right file"))
134endef
135
dp-arm4972ec52016-05-25 16:20:20 +0100136# FWU_FIP_ADD_PAYLOAD appends the command line arguments required by fiptool
Yatharth Kochard1a93432015-10-12 12:33:47 +0100137# to package a new FWU payload. Optionally, it adds the dependency on this payload
138# $(1) = payload filename (e.g. ns_bl2u.bin)
Juan Castillo8e04dec2016-01-05 11:55:36 +0000139# $(2) = command line option for the specified payload (e.g. --fwu)
Yatharth Kochard1a93432015-10-12 12:33:47 +0100140# $(3) = fip target dependency (optional) (e.g. ns_bl2u)
141define FWU_FIP_ADD_PAYLOAD
142 $(eval $(if $(3),FWU_FIP_DEPS += $(3)))
143 $(eval FWU_FIP_ARGS += $(2) $(1))
144endef
145
146# FWU_CERT_ADD_CMD_OPT adds a new command line option to the cert_create invocation
147# $(1) = parameter filename
148# $(2) = cert_create command line option for the specified parameter
149# $(3) = input parameter (false if empty)
150define FWU_CERT_ADD_CMD_OPT
151 $(eval $(if $(3),FWU_CRT_DEPS += $(1)))
152 $(eval FWU_CRT_ARGS += $(2) $(1))
153endef
154
155# FWU_FIP_ADD_IMG allows the platform to pack a binary image in the FWU FIP
156# $(1) build option to specify the image filename (BL2U, NS_BL2U, etc)
dp-arm4972ec52016-05-25 16:20:20 +0100157# $(2) command line option for fiptool (bl2u, ns_bl2u, etc)
Yatharth Kochard1a93432015-10-12 12:33:47 +0100158# Example:
159# $(eval $(call FWU_FIP_ADD_IMG,BL2U,--bl2u))
160define FWU_FIP_ADD_IMG
161 FWU_CRT_DEPS += check_$(1)
162 FWU_FIP_DEPS += check_$(1)
163 $(call FWU_FIP_ADD_PAYLOAD,$(value $(1)),$(2))
164
165check_$(1):
166 $$(if $(value $(1)),,$$(error "Platform '${PLAT}' requires $(1). Please set $(1) to point to the right file"))
167endef
Juan Castilloa3487d12015-08-18 14:23:04 +0100168
169################################################################################
170# Auxiliary macros to build TF images from sources
171################################################################################
172
Masahiro Yamadae487bb62016-12-22 15:23:05 +0900173MAKE_DEP = -Wp,-MD,$(DEP) -MT $$@ -MP
Juan Castilloa3487d12015-08-18 14:23:04 +0100174
175# MAKE_C builds a C source file and generates the dependency file
176# $(1) = output directory
177# $(2) = source file (%.c)
Yatharth Kochar115352c2015-10-02 13:58:52 +0100178# $(3) = BL stage (2, 2u, 30, 31, 32, 33)
Juan Castilloa3487d12015-08-18 14:23:04 +0100179define MAKE_C
180
181$(eval OBJ := $(1)/$(patsubst %.c,%.o,$(notdir $(2))))
Masahiro Yamada56c53f62016-12-22 14:02:27 +0900182$(eval DEP := $(patsubst %.o,%.d,$(OBJ)))
Yatharth Kochar115352c2015-10-02 13:58:52 +0100183$(eval IMAGE := IMAGE_BL$(call uppercase,$(3)))
Juan Castilloa3487d12015-08-18 14:23:04 +0100184
Masahiro Yamada56c53f62016-12-22 14:02:27 +0900185$(OBJ): $(2) | bl$(3)_dirs
Juan Castilloa3487d12015-08-18 14:23:04 +0100186 @echo " CC $$<"
Masahiro Yamada56c53f62016-12-22 14:02:27 +0900187 $$(Q)$$(CC) $$(TF_CFLAGS) $$(CFLAGS) -D$(IMAGE) $(MAKE_DEP) -c $$< -o $$@
Juan Castilloa3487d12015-08-18 14:23:04 +0100188
Masahiro Yamada56c53f62016-12-22 14:02:27 +0900189-include $(DEP)
Juan Castilloa3487d12015-08-18 14:23:04 +0100190
191endef
192
193
194# MAKE_S builds an assembly source file and generates the dependency file
195# $(1) = output directory
196# $(2) = assembly file (%.S)
Yatharth Kochar115352c2015-10-02 13:58:52 +0100197# $(3) = BL stage (2, 2u, 30, 31, 32, 33)
Juan Castilloa3487d12015-08-18 14:23:04 +0100198define MAKE_S
199
200$(eval OBJ := $(1)/$(patsubst %.S,%.o,$(notdir $(2))))
Masahiro Yamada56c53f62016-12-22 14:02:27 +0900201$(eval DEP := $(patsubst %.o,%.d,$(OBJ)))
Yatharth Kochar115352c2015-10-02 13:58:52 +0100202$(eval IMAGE := IMAGE_BL$(call uppercase,$(3)))
Juan Castilloa3487d12015-08-18 14:23:04 +0100203
Masahiro Yamada56c53f62016-12-22 14:02:27 +0900204$(OBJ): $(2) | bl$(3)_dirs
Juan Castilloa3487d12015-08-18 14:23:04 +0100205 @echo " AS $$<"
Masahiro Yamada56c53f62016-12-22 14:02:27 +0900206 $$(Q)$$(AS) $$(ASFLAGS) -D$(IMAGE) $(MAKE_DEP) -c $$< -o $$@
Juan Castilloa3487d12015-08-18 14:23:04 +0100207
Masahiro Yamada56c53f62016-12-22 14:02:27 +0900208-include $(DEP)
Juan Castilloa3487d12015-08-18 14:23:04 +0100209
210endef
211
212
213# MAKE_LD generate the linker script using the C preprocessor
214# $(1) = output linker script
215# $(2) = input template
Masahiro Yamada4abe9232017-01-12 10:48:22 +0900216# $(3) = BL stage (2, 2u, 30, 31, 32, 33)
Juan Castilloa3487d12015-08-18 14:23:04 +0100217define MAKE_LD
218
Masahiro Yamada56c53f62016-12-22 14:02:27 +0900219$(eval DEP := $(1).d)
Juan Castilloa3487d12015-08-18 14:23:04 +0100220
Masahiro Yamada4abe9232017-01-12 10:48:22 +0900221$(1): $(2) | bl$(3)_dirs
Juan Castilloa3487d12015-08-18 14:23:04 +0100222 @echo " PP $$<"
Masahiro Yamada56c53f62016-12-22 14:02:27 +0900223 $$(Q)$$(CPP) $$(CPPFLAGS) -P -D__ASSEMBLY__ -D__LINKER__ $(MAKE_DEP) -o $$@ $$<
Juan Castilloa3487d12015-08-18 14:23:04 +0100224
Masahiro Yamada56c53f62016-12-22 14:02:27 +0900225-include $(DEP)
Juan Castilloa3487d12015-08-18 14:23:04 +0100226
227endef
228
229
230# MAKE_OBJS builds both C and assembly source files
231# $(1) = output directory
232# $(2) = list of source files (both C and assembly)
233# $(3) = BL stage (2, 30, 31, 32, 33)
234define MAKE_OBJS
235 $(eval C_OBJS := $(filter %.c,$(2)))
236 $(eval REMAIN := $(filter-out %.c,$(2)))
237 $(eval $(foreach obj,$(C_OBJS),$(call MAKE_C,$(1),$(obj),$(3))))
238
239 $(eval S_OBJS := $(filter %.S,$(REMAIN)))
240 $(eval REMAIN := $(filter-out %.S,$(REMAIN)))
241 $(eval $(foreach obj,$(S_OBJS),$(call MAKE_S,$(1),$(obj),$(3))))
242
243 $(and $(REMAIN),$(error Unexpected source files present: $(REMAIN)))
244endef
245
246
247# NOTE: The line continuation '\' is required in the next define otherwise we
248# end up with a line-feed characer at the end of the last c filename.
Evan Lloyda71d2592015-12-02 18:56:06 +0000249# Also bear this issue in mind if extending the list of supported filetypes.
Juan Castilloa3487d12015-08-18 14:23:04 +0100250define SOURCES_TO_OBJS
251 $(notdir $(patsubst %.c,%.o,$(filter %.c,$(1)))) \
252 $(notdir $(patsubst %.S,%.o,$(filter %.S,$(1))))
253endef
254
255
dp-arm4972ec52016-05-25 16:20:20 +0100256# MAKE_TOOL_ARGS macro defines the command line arguments for fiptool for
Juan Castilloa3487d12015-08-18 14:23:04 +0100257# each BL image. Arguments:
258# $(1) = BL stage (2, 30, 31, 32, 33)
259# $(2) = Binary file
Juan Castillo8e04dec2016-01-05 11:55:36 +0000260# $(3) = FIP command line option (if empty, image will not be included in the FIP)
Juan Castilloa3487d12015-08-18 14:23:04 +0100261define MAKE_TOOL_ARGS
Juan Castillo8e04dec2016-01-05 11:55:36 +0000262 $(if $(3),$(eval $(call FIP_ADD_PAYLOAD,$(2),--$(3),bl$(1))))
Juan Castilloa3487d12015-08-18 14:23:04 +0100263endef
264
Patrick Georgi8a10e342016-01-28 14:46:18 +0100265# Allow overriding the timestamp, for example for reproducible builds, or to
266# synchronize timestamps across multiple projects.
267# This must be set to a C string (including quotes where applicable).
268BUILD_MESSAGE_TIMESTAMP ?= __TIME__", "__DATE__
Juan Castilloa3487d12015-08-18 14:23:04 +0100269
270# MAKE_BL macro defines the targets and options to build each BL image.
271# Arguments:
Yatharth Kochar115352c2015-10-02 13:58:52 +0100272# $(1) = BL stage (2, 2u, 30, 31, 32, 33)
Juan Castillo8e04dec2016-01-05 11:55:36 +0000273# $(2) = FIP command line option (if empty, image will not be included in the FIP)
Juan Castilloa3487d12015-08-18 14:23:04 +0100274define MAKE_BL
275 $(eval BUILD_DIR := ${BUILD_PLAT}/bl$(1))
Yatharth Kochar115352c2015-10-02 13:58:52 +0100276 $(eval BL_SOURCES := $(BL$(call uppercase,$(1))_SOURCES))
277 $(eval SOURCES := $(BL_SOURCES) $(BL_COMMON_SOURCES) $(PLAT_BL_COMMON_SOURCES))
Juan Castilloa3487d12015-08-18 14:23:04 +0100278 $(eval OBJS := $(addprefix $(BUILD_DIR)/,$(call SOURCES_TO_OBJS,$(SOURCES))))
279 $(eval LINKERFILE := $(call IMG_LINKERFILE,$(1)))
280 $(eval MAPFILE := $(call IMG_MAPFILE,$(1)))
281 $(eval ELF := $(call IMG_ELF,$(1)))
282 $(eval DUMP := $(call IMG_DUMP,$(1)))
283 $(eval BIN := $(call IMG_BIN,$(1)))
Yatharth Kochar115352c2015-10-02 13:58:52 +0100284 $(eval BL_LINKERFILE := $(BL$(call uppercase,$(1))_LINKERFILE))
Evan Lloyd93d3b702015-12-03 12:19:30 +0000285 # We use sort only to get a list of unique object directory names.
286 # ordering is not relevant but sort removes duplicates.
Evan Lloyd4c3055f2017-04-07 16:58:57 +0100287 $(eval TEMP_OBJ_DIRS := $(sort $(dir ${OBJS} ${LINKERFILE})))
Evan Lloyd93d3b702015-12-03 12:19:30 +0000288 # The $(dir ) function leaves a trailing / on the directory names
Masahiro Yamada823482b2017-01-19 19:31:00 +0900289 # Rip off the / to match directory names with make rule targets.
290 $(eval OBJ_DIRS := $(patsubst %/,%,$(TEMP_OBJ_DIRS)))
Evan Lloyd93d3b702015-12-03 12:19:30 +0000291
292# Create generators for object directory structure
Juan Castilloa3487d12015-08-18 14:23:04 +0100293
Evan Lloyd4c3055f2017-04-07 16:58:57 +0100294$(eval $(call MAKE_PREREQ_DIR,${BUILD_DIR},))
295
296$(eval $(foreach objd,${OBJ_DIRS},$(call MAKE_PREREQ_DIR,${objd},${BUILD_DIR})))
Juan Castilloa3487d12015-08-18 14:23:04 +0100297
Evan Lloyd93d3b702015-12-03 12:19:30 +0000298.PHONY : bl${1}_dirs
Juan Castilloa3487d12015-08-18 14:23:04 +0100299
Evan Lloyd93d3b702015-12-03 12:19:30 +0000300# We use order-only prerequisites to ensure that directories are created,
301# but do not cause re-builds every time a file is written.
302bl${1}_dirs: | ${OBJ_DIRS}
303
304$(eval $(call MAKE_OBJS,$(BUILD_DIR),$(SOURCES),$(1)))
Masahiro Yamada4abe9232017-01-12 10:48:22 +0900305$(eval $(call MAKE_LD,$(LINKERFILE),$(BL_LINKERFILE),$(1)))
Evan Lloyd93d3b702015-12-03 12:19:30 +0000306
307$(ELF): $(OBJS) $(LINKERFILE) | bl$(1)_dirs
Juan Castilloa3487d12015-08-18 14:23:04 +0100308 @echo " LD $$@"
Evan Lloydcf6e9d42015-12-03 12:58:52 +0000309ifdef MAKE_BUILD_STRINGS
310 $(call MAKE_BUILD_STRINGS, $(BUILD_DIR)/build_message.o)
311else
Patrick Georgi8a10e342016-01-28 14:46:18 +0100312 @echo 'const char build_message[] = "Built : "$(BUILD_MESSAGE_TIMESTAMP); \
Juan Castilloa3487d12015-08-18 14:23:04 +0100313 const char version_string[] = "${VERSION_STRING}";' | \
Masahiro Yamada49071ae2016-12-22 12:39:55 +0900314 $$(CC) $$(TF_CFLAGS) $$(CFLAGS) -xc -c - -o $(BUILD_DIR)/build_message.o
Evan Lloydcf6e9d42015-12-03 12:58:52 +0000315endif
Juan Castilloa3487d12015-08-18 14:23:04 +0100316 $$(Q)$$(LD) -o $$@ $$(LDFLAGS) -Map=$(MAPFILE) --script $(LINKERFILE) \
317 $(BUILD_DIR)/build_message.o $(OBJS)
318
319$(DUMP): $(ELF)
320 @echo " OD $$@"
321 $${Q}$${OD} -dx $$< > $$@
322
323$(BIN): $(ELF)
324 @echo " BIN $$@"
325 $$(Q)$$(OC) -O binary $$< $$@
Evan Lloyd1c5f3602017-04-11 16:52:00 +0100326 @${ECHO_BLANK_LINE}
Juan Castilloa3487d12015-08-18 14:23:04 +0100327 @echo "Built $$@ successfully"
Evan Lloyd1c5f3602017-04-11 16:52:00 +0100328 @${ECHO_BLANK_LINE}
Juan Castilloa3487d12015-08-18 14:23:04 +0100329
330.PHONY: bl$(1)
Evan Lloyd93d3b702015-12-03 12:19:30 +0000331bl$(1): $(BIN) $(DUMP)
Juan Castilloa3487d12015-08-18 14:23:04 +0100332
333all: bl$(1)
334
335$(eval $(call MAKE_TOOL_ARGS,$(1),$(BIN),$(2)))
336
337endef
338