blob: 165e3aad813c9204476a6bfb4aff7ea1ab43b16e [file] [log] [blame]
Juan Castilloa3487d12015-08-18 14:23:04 +01001#
Evan Lloydf2697142015-12-02 18:17:37 +00002# Copyright (c) 2015-2016, ARM Limited and Contributors. All rights reserved.
Juan Castilloa3487d12015-08-18 14:23:04 +01003#
4# Redistribution and use in source and binary forms, with or without
5# modification, are permitted provided that the following conditions are met:
6#
7# Redistributions of source code must retain the above copyright notice, this
8# list of conditions and the following disclaimer.
9#
10# Redistributions in binary form must reproduce the above copyright notice,
11# this list of conditions and the following disclaimer in the documentation
12# and/or other materials provided with the distribution.
13#
14# Neither the name of ARM nor the names of its contributors may be used
15# to endorse or promote products derived from this software without specific
16# prior written permission.
17#
18# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28# POSSIBILITY OF SUCH DAMAGE.
29#
30
Evan Lloyd870a18c2015-12-02 18:41:22 +000031# Report an error if the eval make function is not available.
32$(eval eval_available := T)
33ifneq (${eval_available},T)
34 $(error This makefile only works with a Make program that supports $$(eval))
35endif
36
Evan Lloydf2697142015-12-02 18:17:37 +000037# Some utility macros for manipulating awkward (whitespace) characters.
38blank :=
39space :=${blank} ${blank}
40
41# A user defined function to recursively search for a filename below a directory
42# $1 is the directory root of the recursive search (blank for current directory).
43# $2 is the file name to search for.
44define rwildcard
45$(strip $(foreach d,$(wildcard ${1}*),$(call rwildcard,${d}/,${2}) $(filter $(subst *,%,%${2}),${d})))
46endef
47
Yatharth Kochar115352c2015-10-02 13:58:52 +010048# This table is used in converting lower case to upper case.
49uppercase_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
50
51# Internal macro used for converting lower case to upper case.
52# $(1) = upper case table
53# $(2) = String to convert
54define uppercase_internal
55$(if $(1),$$(subst $(firstword $(1)),$(call uppercase_internal,$(wordlist 2,$(words $(1)),$(1)),$(2))),$(2))
56endef
57
58# A macro for converting a string to upper case
59# $(1) = String to convert
60define uppercase
61$(eval uppercase_result:=$(call uppercase_internal,$(uppercase_table),$(1)))$(uppercase_result)
62endef
63
Juan Castilloa3487d12015-08-18 14:23:04 +010064# Convenience function for adding build definitions
65# $(eval $(call add_define,FOO)) will have:
66# -DFOO if $(FOO) is empty; -DFOO=$(FOO) otherwise
67define add_define
68 DEFINES += -D$(1)$(if $(value $(1)),=$(value $(1)),)
69endef
70
Soren Brinkmann9efe6572016-06-09 13:36:27 -070071# Convenience function for adding build definitions
72# $(eval $(call add_define_val,FOO,BAR)) will have:
73# -DFOO=BAR
74define add_define_val
75 DEFINES += -D$(1)=$(2)
76endef
77
Juan Castilloa3487d12015-08-18 14:23:04 +010078# Convenience function for verifying option has a boolean value
79# $(eval $(call assert_boolean,FOO)) will assert FOO is 0 or 1
80define assert_boolean
81 $(and $(patsubst 0,,$(value $(1))),$(patsubst 1,,$(value $(1))),$(error $(1) must be boolean))
82endef
83
84# IMG_LINKERFILE defines the linker script corresponding to a BL stage
85# $(1) = BL stage (2, 30, 31, 32, 33)
86define IMG_LINKERFILE
87 ${BUILD_DIR}/bl$(1).ld
88endef
89
90# IMG_MAPFILE defines the output file describing the memory map corresponding
91# to a BL stage
92# $(1) = BL stage (2, 30, 31, 32, 33)
93define IMG_MAPFILE
94 ${BUILD_DIR}/bl$(1).map
95endef
96
97# IMG_ELF defines the elf file corresponding to a BL stage
98# $(1) = BL stage (2, 30, 31, 32, 33)
99define IMG_ELF
100 ${BUILD_DIR}/bl$(1).elf
101endef
102
103# IMG_DUMP defines the symbols dump file corresponding to a BL stage
104# $(1) = BL stage (2, 30, 31, 32, 33)
105define IMG_DUMP
106 ${BUILD_DIR}/bl$(1).dump
107endef
108
109# IMG_BIN defines the default image file corresponding to a BL stage
110# $(1) = BL stage (2, 30, 31, 32, 33)
111define IMG_BIN
112 ${BUILD_PLAT}/bl$(1).bin
113endef
114
115# FIP_ADD_PAYLOAD appends the command line arguments required by the FIP tool
116# to package a new payload. Optionally, it adds the dependency on this payload
117# $(1) = payload filename (i.e. bl31.bin)
118# $(2) = command line option for the specified payload (i.e. --bl31)
119# $(3) = fip target dependency (optional) (i.e. bl31)
120define FIP_ADD_PAYLOAD
121 $(eval FIP_ARGS += $(2) $(1))
122 $(eval $(if $(3),FIP_DEPS += $(3)))
123endef
124
Yatharth Kochard1a93432015-10-12 12:33:47 +0100125# CERT_ADD_CMD_OPT adds a new command line option to the cert_create invocation
Juan Castilloa3487d12015-08-18 14:23:04 +0100126# $(1) = parameter filename
127# $(2) = cert_create command line option for the specified parameter
128# $(3) = input parameter (false if empty)
129define CERT_ADD_CMD_OPT
130 $(eval $(if $(3),CRT_DEPS += $(1)))
131 $(eval CRT_ARGS += $(2) $(1))
132endef
133
134# FIP_ADD_IMG allows the platform to specify an image to be packed in the FIP
135# using a build option. It also adds a dependency on the image file, aborting
136# the build if the file does not exist.
Juan Castilloa72b6472015-12-10 15:49:17 +0000137# $(1) = build option to specify the image filename (SCP_BL2, BL33, etc)
138# $(2) = command line option for the fip_create tool (scp_bl2, bl33, etc)
Juan Castilloa3487d12015-08-18 14:23:04 +0100139# Example:
140# $(eval $(call FIP_ADD_IMG,BL33,--bl33))
141define FIP_ADD_IMG
142 CRT_DEPS += check_$(1)
143 FIP_DEPS += check_$(1)
144 $(call FIP_ADD_PAYLOAD,$(value $(1)),$(2))
145
146check_$(1):
147 $$(if $(value $(1)),,$$(error "Platform '${PLAT}' requires $(1). Please set $(1) to point to the right file"))
148endef
149
Yatharth Kochard1a93432015-10-12 12:33:47 +0100150# FWU_FIP_ADD_PAYLOAD appends the command line arguments required by the FIP tool
151# to package a new FWU payload. Optionally, it adds the dependency on this payload
152# $(1) = payload filename (e.g. ns_bl2u.bin)
Juan Castillo8e04dec2016-01-05 11:55:36 +0000153# $(2) = command line option for the specified payload (e.g. --fwu)
Yatharth Kochard1a93432015-10-12 12:33:47 +0100154# $(3) = fip target dependency (optional) (e.g. ns_bl2u)
155define FWU_FIP_ADD_PAYLOAD
156 $(eval $(if $(3),FWU_FIP_DEPS += $(3)))
157 $(eval FWU_FIP_ARGS += $(2) $(1))
158endef
159
160# FWU_CERT_ADD_CMD_OPT adds a new command line option to the cert_create invocation
161# $(1) = parameter filename
162# $(2) = cert_create command line option for the specified parameter
163# $(3) = input parameter (false if empty)
164define FWU_CERT_ADD_CMD_OPT
165 $(eval $(if $(3),FWU_CRT_DEPS += $(1)))
166 $(eval FWU_CRT_ARGS += $(2) $(1))
167endef
168
169# FWU_FIP_ADD_IMG allows the platform to pack a binary image in the FWU FIP
170# $(1) build option to specify the image filename (BL2U, NS_BL2U, etc)
171# $(2) command line option for the fip_create tool (bl2u, ns_bl2u, etc)
172# Example:
173# $(eval $(call FWU_FIP_ADD_IMG,BL2U,--bl2u))
174define FWU_FIP_ADD_IMG
175 FWU_CRT_DEPS += check_$(1)
176 FWU_FIP_DEPS += check_$(1)
177 $(call FWU_FIP_ADD_PAYLOAD,$(value $(1)),$(2))
178
179check_$(1):
180 $$(if $(value $(1)),,$$(error "Platform '${PLAT}' requires $(1). Please set $(1) to point to the right file"))
181endef
Juan Castilloa3487d12015-08-18 14:23:04 +0100182
183################################################################################
184# Auxiliary macros to build TF images from sources
185################################################################################
186
Juan Castillo396644b2015-10-22 11:34:44 +0100187# If no goal is specified in the command line, .DEFAULT_GOAL is used.
188# .DEFAULT_GOAL is defined in the main Makefile before including this file.
189ifeq ($(MAKECMDGOALS),)
190MAKECMDGOALS := $(.DEFAULT_GOAL)
191endif
192
Juan Castilloa3487d12015-08-18 14:23:04 +0100193define match_goals
194$(strip $(foreach goal,$(1),$(filter $(goal),$(MAKECMDGOALS))))
195endef
196
197# List of rules that involve building things
Yatharth Kocharb1c2fe02015-10-14 15:27:24 +0100198BUILD_TARGETS := all bl1 bl2 bl2u bl31 bl32 certificates fip
Juan Castilloa3487d12015-08-18 14:23:04 +0100199
200# Does the list of goals specified on the command line include a build target?
201ifneq ($(call match_goals,${BUILD_TARGETS}),)
202IS_ANYTHING_TO_BUILD := 1
203endif
204
205
206# MAKE_C builds a C source file and generates the dependency file
207# $(1) = output directory
208# $(2) = source file (%.c)
Yatharth Kochar115352c2015-10-02 13:58:52 +0100209# $(3) = BL stage (2, 2u, 30, 31, 32, 33)
Juan Castilloa3487d12015-08-18 14:23:04 +0100210define MAKE_C
211
212$(eval OBJ := $(1)/$(patsubst %.c,%.o,$(notdir $(2))))
213$(eval PREREQUISITES := $(patsubst %.o,%.d,$(OBJ)))
Yatharth Kochar115352c2015-10-02 13:58:52 +0100214$(eval IMAGE := IMAGE_BL$(call uppercase,$(3)))
Juan Castilloa3487d12015-08-18 14:23:04 +0100215
216$(OBJ): $(2)
217 @echo " CC $$<"
Sandrine Bailleuxf5fdbcc2016-04-11 13:01:17 +0100218 $$(Q)$$(CC) $$(TF_CFLAGS) $$(CFLAGS) -D$(IMAGE) -c $$< -o $$@
Juan Castilloa3487d12015-08-18 14:23:04 +0100219
Evan Lloyd93d3b702015-12-03 12:19:30 +0000220$(PREREQUISITES): $(2) | bl$(3)_dirs
Juan Castilloa3487d12015-08-18 14:23:04 +0100221 @echo " DEPS $$@"
Sandrine Bailleuxf5fdbcc2016-04-11 13:01:17 +0100222 $$(Q)$$(CC) $$(TF_CFLAGS) $$(CFLAGS) -M -MT $(OBJ) -MF $$@ $$<
Juan Castilloa3487d12015-08-18 14:23:04 +0100223
224ifdef IS_ANYTHING_TO_BUILD
225-include $(PREREQUISITES)
226endif
227
228endef
229
230
231# MAKE_S builds an assembly source file and generates the dependency file
232# $(1) = output directory
233# $(2) = assembly file (%.S)
Yatharth Kochar115352c2015-10-02 13:58:52 +0100234# $(3) = BL stage (2, 2u, 30, 31, 32, 33)
Juan Castilloa3487d12015-08-18 14:23:04 +0100235define MAKE_S
236
237$(eval OBJ := $(1)/$(patsubst %.S,%.o,$(notdir $(2))))
238$(eval PREREQUISITES := $(patsubst %.o,%.d,$(OBJ)))
Yatharth Kochar115352c2015-10-02 13:58:52 +0100239$(eval IMAGE := IMAGE_BL$(call uppercase,$(3)))
Juan Castilloa3487d12015-08-18 14:23:04 +0100240
241$(OBJ): $(2)
242 @echo " AS $$<"
Yatharth Kochar115352c2015-10-02 13:58:52 +0100243 $$(Q)$$(AS) $$(ASFLAGS) -D$(IMAGE) -c $$< -o $$@
Juan Castilloa3487d12015-08-18 14:23:04 +0100244
Evan Lloyd93d3b702015-12-03 12:19:30 +0000245$(PREREQUISITES): $(2) | bl$(3)_dirs
Juan Castilloa3487d12015-08-18 14:23:04 +0100246 @echo " DEPS $$@"
Juan Castilloa3487d12015-08-18 14:23:04 +0100247 $$(Q)$$(AS) $$(ASFLAGS) -M -MT $(OBJ) -MF $$@ $$<
248
249ifdef IS_ANYTHING_TO_BUILD
250-include $(PREREQUISITES)
251endif
252
253endef
254
255
256# MAKE_LD generate the linker script using the C preprocessor
257# $(1) = output linker script
258# $(2) = input template
259define MAKE_LD
260
261$(eval PREREQUISITES := $(1).d)
262
263$(1): $(2)
264 @echo " PP $$<"
265 $$(Q)$$(AS) $$(ASFLAGS) -P -E -D__LINKER__ -o $$@ $$<
266
Evan Lloyd93d3b702015-12-03 12:19:30 +0000267$(PREREQUISITES): $(2) | $(dir ${1})
Juan Castilloa3487d12015-08-18 14:23:04 +0100268 @echo " DEPS $$@"
Juan Castilloa3487d12015-08-18 14:23:04 +0100269 $$(Q)$$(AS) $$(ASFLAGS) -M -MT $(1) -MF $$@ $$<
270
271ifdef IS_ANYTHING_TO_BUILD
272-include $(PREREQUISITES)
273endif
274
275endef
276
277
278# MAKE_OBJS builds both C and assembly source files
279# $(1) = output directory
280# $(2) = list of source files (both C and assembly)
281# $(3) = BL stage (2, 30, 31, 32, 33)
282define MAKE_OBJS
283 $(eval C_OBJS := $(filter %.c,$(2)))
284 $(eval REMAIN := $(filter-out %.c,$(2)))
285 $(eval $(foreach obj,$(C_OBJS),$(call MAKE_C,$(1),$(obj),$(3))))
286
287 $(eval S_OBJS := $(filter %.S,$(REMAIN)))
288 $(eval REMAIN := $(filter-out %.S,$(REMAIN)))
289 $(eval $(foreach obj,$(S_OBJS),$(call MAKE_S,$(1),$(obj),$(3))))
290
291 $(and $(REMAIN),$(error Unexpected source files present: $(REMAIN)))
292endef
293
294
295# NOTE: The line continuation '\' is required in the next define otherwise we
296# end up with a line-feed characer at the end of the last c filename.
Evan Lloyda71d2592015-12-02 18:56:06 +0000297# Also bear this issue in mind if extending the list of supported filetypes.
Juan Castilloa3487d12015-08-18 14:23:04 +0100298define SOURCES_TO_OBJS
299 $(notdir $(patsubst %.c,%.o,$(filter %.c,$(1)))) \
300 $(notdir $(patsubst %.S,%.o,$(filter %.S,$(1))))
301endef
302
303
304# MAKE_TOOL_ARGS macro defines the command line arguments for the FIP tool for
305# each BL image. Arguments:
306# $(1) = BL stage (2, 30, 31, 32, 33)
307# $(2) = Binary file
Juan Castillo8e04dec2016-01-05 11:55:36 +0000308# $(3) = FIP command line option (if empty, image will not be included in the FIP)
Juan Castilloa3487d12015-08-18 14:23:04 +0100309define MAKE_TOOL_ARGS
Juan Castillo8e04dec2016-01-05 11:55:36 +0000310 $(if $(3),$(eval $(call FIP_ADD_PAYLOAD,$(2),--$(3),bl$(1))))
Juan Castilloa3487d12015-08-18 14:23:04 +0100311endef
312
Patrick Georgi8a10e342016-01-28 14:46:18 +0100313# Allow overriding the timestamp, for example for reproducible builds, or to
314# synchronize timestamps across multiple projects.
315# This must be set to a C string (including quotes where applicable).
316BUILD_MESSAGE_TIMESTAMP ?= __TIME__", "__DATE__
Juan Castilloa3487d12015-08-18 14:23:04 +0100317
318# MAKE_BL macro defines the targets and options to build each BL image.
319# Arguments:
Yatharth Kochar115352c2015-10-02 13:58:52 +0100320# $(1) = BL stage (2, 2u, 30, 31, 32, 33)
Juan Castillo8e04dec2016-01-05 11:55:36 +0000321# $(2) = FIP command line option (if empty, image will not be included in the FIP)
Juan Castilloa3487d12015-08-18 14:23:04 +0100322define MAKE_BL
323 $(eval BUILD_DIR := ${BUILD_PLAT}/bl$(1))
Yatharth Kochar115352c2015-10-02 13:58:52 +0100324 $(eval BL_SOURCES := $(BL$(call uppercase,$(1))_SOURCES))
325 $(eval SOURCES := $(BL_SOURCES) $(BL_COMMON_SOURCES) $(PLAT_BL_COMMON_SOURCES))
Juan Castilloa3487d12015-08-18 14:23:04 +0100326 $(eval OBJS := $(addprefix $(BUILD_DIR)/,$(call SOURCES_TO_OBJS,$(SOURCES))))
327 $(eval LINKERFILE := $(call IMG_LINKERFILE,$(1)))
328 $(eval MAPFILE := $(call IMG_MAPFILE,$(1)))
329 $(eval ELF := $(call IMG_ELF,$(1)))
330 $(eval DUMP := $(call IMG_DUMP,$(1)))
331 $(eval BIN := $(call IMG_BIN,$(1)))
Yatharth Kochar115352c2015-10-02 13:58:52 +0100332 $(eval BL_LINKERFILE := $(BL$(call uppercase,$(1))_LINKERFILE))
Evan Lloyd93d3b702015-12-03 12:19:30 +0000333 # We use sort only to get a list of unique object directory names.
334 # ordering is not relevant but sort removes duplicates.
335 $(eval TEMP_OBJ_DIRS := $(sort $(BUILD_DIR)/ $(dir ${OBJS})))
336 # The $(dir ) function leaves a trailing / on the directory names
337 # We append a . then strip /. from each, to remove the trailing / characters
338 # This gives names suitable for use as make rule targets.
339 $(eval OBJ_DIRS := $(subst /.,,$(addsuffix .,$(TEMP_OBJ_DIRS))))
340
341# Create generators for object directory structure
Juan Castilloa3487d12015-08-18 14:23:04 +0100342
Evan Lloyd93d3b702015-12-03 12:19:30 +0000343$(eval $(foreach objd,${OBJ_DIRS},$(call MAKE_PREREQ_DIR,${objd},)))
Juan Castilloa3487d12015-08-18 14:23:04 +0100344
Evan Lloyd93d3b702015-12-03 12:19:30 +0000345.PHONY : bl${1}_dirs
Juan Castilloa3487d12015-08-18 14:23:04 +0100346
Evan Lloyd93d3b702015-12-03 12:19:30 +0000347# We use order-only prerequisites to ensure that directories are created,
348# but do not cause re-builds every time a file is written.
349bl${1}_dirs: | ${OBJ_DIRS}
350
351$(eval $(call MAKE_OBJS,$(BUILD_DIR),$(SOURCES),$(1)))
352$(eval $(call MAKE_LD,$(LINKERFILE),$(BL_LINKERFILE)))
353
354$(ELF): $(OBJS) $(LINKERFILE) | bl$(1)_dirs
Juan Castilloa3487d12015-08-18 14:23:04 +0100355 @echo " LD $$@"
Evan Lloydcf6e9d42015-12-03 12:58:52 +0000356ifdef MAKE_BUILD_STRINGS
357 $(call MAKE_BUILD_STRINGS, $(BUILD_DIR)/build_message.o)
358else
Patrick Georgi8a10e342016-01-28 14:46:18 +0100359 @echo 'const char build_message[] = "Built : "$(BUILD_MESSAGE_TIMESTAMP); \
Juan Castilloa3487d12015-08-18 14:23:04 +0100360 const char version_string[] = "${VERSION_STRING}";' | \
Sandrine Bailleuxf5fdbcc2016-04-11 13:01:17 +0100361 $$(CC) $$(TF_CFLAGS) $$(CFLAGS) -xc - -o $(BUILD_DIR)/build_message.o
Evan Lloydcf6e9d42015-12-03 12:58:52 +0000362endif
Juan Castilloa3487d12015-08-18 14:23:04 +0100363 $$(Q)$$(LD) -o $$@ $$(LDFLAGS) -Map=$(MAPFILE) --script $(LINKERFILE) \
364 $(BUILD_DIR)/build_message.o $(OBJS)
365
366$(DUMP): $(ELF)
367 @echo " OD $$@"
368 $${Q}$${OD} -dx $$< > $$@
369
370$(BIN): $(ELF)
371 @echo " BIN $$@"
372 $$(Q)$$(OC) -O binary $$< $$@
373 @echo
374 @echo "Built $$@ successfully"
375 @echo
376
377.PHONY: bl$(1)
Evan Lloyd93d3b702015-12-03 12:19:30 +0000378bl$(1): $(BIN) $(DUMP)
Juan Castilloa3487d12015-08-18 14:23:04 +0100379
380all: bl$(1)
381
382$(eval $(call MAKE_TOOL_ARGS,$(1),$(BIN),$(2)))
383
384endef
385