blob: c963b7afdeee9c3a8bac2a07d45e1d2585c50867 [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
71# Convenience function for verifying option has a boolean value
72# $(eval $(call assert_boolean,FOO)) will assert FOO is 0 or 1
73define assert_boolean
74 $(and $(patsubst 0,,$(value $(1))),$(patsubst 1,,$(value $(1))),$(error $(1) must be boolean))
75endef
76
77# IMG_LINKERFILE defines the linker script corresponding to a BL stage
78# $(1) = BL stage (2, 30, 31, 32, 33)
79define IMG_LINKERFILE
80 ${BUILD_DIR}/bl$(1).ld
81endef
82
83# IMG_MAPFILE defines the output file describing the memory map corresponding
84# to a BL stage
85# $(1) = BL stage (2, 30, 31, 32, 33)
86define IMG_MAPFILE
87 ${BUILD_DIR}/bl$(1).map
88endef
89
90# IMG_ELF defines the elf file corresponding to a BL stage
91# $(1) = BL stage (2, 30, 31, 32, 33)
92define IMG_ELF
93 ${BUILD_DIR}/bl$(1).elf
94endef
95
96# IMG_DUMP defines the symbols dump file corresponding to a BL stage
97# $(1) = BL stage (2, 30, 31, 32, 33)
98define IMG_DUMP
99 ${BUILD_DIR}/bl$(1).dump
100endef
101
102# IMG_BIN defines the default image file corresponding to a BL stage
103# $(1) = BL stage (2, 30, 31, 32, 33)
104define IMG_BIN
105 ${BUILD_PLAT}/bl$(1).bin
106endef
107
108# FIP_ADD_PAYLOAD appends the command line arguments required by the FIP tool
109# to package a new payload. Optionally, it adds the dependency on this payload
110# $(1) = payload filename (i.e. bl31.bin)
111# $(2) = command line option for the specified payload (i.e. --bl31)
112# $(3) = fip target dependency (optional) (i.e. bl31)
113define FIP_ADD_PAYLOAD
114 $(eval FIP_ARGS += $(2) $(1))
115 $(eval $(if $(3),FIP_DEPS += $(3)))
116endef
117
Yatharth Kochard1a93432015-10-12 12:33:47 +0100118# CERT_ADD_CMD_OPT adds a new command line option to the cert_create invocation
Juan Castilloa3487d12015-08-18 14:23:04 +0100119# $(1) = parameter filename
120# $(2) = cert_create command line option for the specified parameter
121# $(3) = input parameter (false if empty)
122define CERT_ADD_CMD_OPT
123 $(eval $(if $(3),CRT_DEPS += $(1)))
124 $(eval CRT_ARGS += $(2) $(1))
125endef
126
127# FIP_ADD_IMG allows the platform to specify an image to be packed in the FIP
128# using a build option. It also adds a dependency on the image file, aborting
129# the build if the file does not exist.
Juan Castilloa72b6472015-12-10 15:49:17 +0000130# $(1) = build option to specify the image filename (SCP_BL2, BL33, etc)
131# $(2) = command line option for the fip_create tool (scp_bl2, bl33, etc)
Juan Castilloa3487d12015-08-18 14:23:04 +0100132# Example:
133# $(eval $(call FIP_ADD_IMG,BL33,--bl33))
134define FIP_ADD_IMG
135 CRT_DEPS += check_$(1)
136 FIP_DEPS += check_$(1)
137 $(call FIP_ADD_PAYLOAD,$(value $(1)),$(2))
138
139check_$(1):
140 $$(if $(value $(1)),,$$(error "Platform '${PLAT}' requires $(1). Please set $(1) to point to the right file"))
141endef
142
Yatharth Kochard1a93432015-10-12 12:33:47 +0100143# FWU_FIP_ADD_PAYLOAD appends the command line arguments required by the FIP tool
144# to package a new FWU payload. Optionally, it adds the dependency on this payload
145# $(1) = payload filename (e.g. ns_bl2u.bin)
Juan Castillo8e04dec2016-01-05 11:55:36 +0000146# $(2) = command line option for the specified payload (e.g. --fwu)
Yatharth Kochard1a93432015-10-12 12:33:47 +0100147# $(3) = fip target dependency (optional) (e.g. ns_bl2u)
148define FWU_FIP_ADD_PAYLOAD
149 $(eval $(if $(3),FWU_FIP_DEPS += $(3)))
150 $(eval FWU_FIP_ARGS += $(2) $(1))
151endef
152
153# FWU_CERT_ADD_CMD_OPT adds a new command line option to the cert_create invocation
154# $(1) = parameter filename
155# $(2) = cert_create command line option for the specified parameter
156# $(3) = input parameter (false if empty)
157define FWU_CERT_ADD_CMD_OPT
158 $(eval $(if $(3),FWU_CRT_DEPS += $(1)))
159 $(eval FWU_CRT_ARGS += $(2) $(1))
160endef
161
162# FWU_FIP_ADD_IMG allows the platform to pack a binary image in the FWU FIP
163# $(1) build option to specify the image filename (BL2U, NS_BL2U, etc)
164# $(2) command line option for the fip_create tool (bl2u, ns_bl2u, etc)
165# Example:
166# $(eval $(call FWU_FIP_ADD_IMG,BL2U,--bl2u))
167define FWU_FIP_ADD_IMG
168 FWU_CRT_DEPS += check_$(1)
169 FWU_FIP_DEPS += check_$(1)
170 $(call FWU_FIP_ADD_PAYLOAD,$(value $(1)),$(2))
171
172check_$(1):
173 $$(if $(value $(1)),,$$(error "Platform '${PLAT}' requires $(1). Please set $(1) to point to the right file"))
174endef
Juan Castilloa3487d12015-08-18 14:23:04 +0100175
176################################################################################
177# Auxiliary macros to build TF images from sources
178################################################################################
179
Juan Castillo396644b2015-10-22 11:34:44 +0100180# If no goal is specified in the command line, .DEFAULT_GOAL is used.
181# .DEFAULT_GOAL is defined in the main Makefile before including this file.
182ifeq ($(MAKECMDGOALS),)
183MAKECMDGOALS := $(.DEFAULT_GOAL)
184endif
185
Juan Castilloa3487d12015-08-18 14:23:04 +0100186define match_goals
187$(strip $(foreach goal,$(1),$(filter $(goal),$(MAKECMDGOALS))))
188endef
189
190# List of rules that involve building things
Yatharth Kocharb1c2fe02015-10-14 15:27:24 +0100191BUILD_TARGETS := all bl1 bl2 bl2u bl31 bl32 certificates fip
Juan Castilloa3487d12015-08-18 14:23:04 +0100192
193# Does the list of goals specified on the command line include a build target?
194ifneq ($(call match_goals,${BUILD_TARGETS}),)
195IS_ANYTHING_TO_BUILD := 1
196endif
197
198
199# MAKE_C builds a C source file and generates the dependency file
200# $(1) = output directory
201# $(2) = source file (%.c)
Yatharth Kochar115352c2015-10-02 13:58:52 +0100202# $(3) = BL stage (2, 2u, 30, 31, 32, 33)
Juan Castilloa3487d12015-08-18 14:23:04 +0100203define MAKE_C
204
205$(eval OBJ := $(1)/$(patsubst %.c,%.o,$(notdir $(2))))
206$(eval PREREQUISITES := $(patsubst %.o,%.d,$(OBJ)))
Yatharth Kochar115352c2015-10-02 13:58:52 +0100207$(eval IMAGE := IMAGE_BL$(call uppercase,$(3)))
Juan Castilloa3487d12015-08-18 14:23:04 +0100208
209$(OBJ): $(2)
210 @echo " CC $$<"
Sandrine Bailleuxf5fdbcc2016-04-11 13:01:17 +0100211 $$(Q)$$(CC) $$(TF_CFLAGS) $$(CFLAGS) -D$(IMAGE) -c $$< -o $$@
Juan Castilloa3487d12015-08-18 14:23:04 +0100212
Evan Lloyd93d3b702015-12-03 12:19:30 +0000213$(PREREQUISITES): $(2) | bl$(3)_dirs
Juan Castilloa3487d12015-08-18 14:23:04 +0100214 @echo " DEPS $$@"
Sandrine Bailleuxf5fdbcc2016-04-11 13:01:17 +0100215 $$(Q)$$(CC) $$(TF_CFLAGS) $$(CFLAGS) -M -MT $(OBJ) -MF $$@ $$<
Juan Castilloa3487d12015-08-18 14:23:04 +0100216
217ifdef IS_ANYTHING_TO_BUILD
218-include $(PREREQUISITES)
219endif
220
221endef
222
223
224# MAKE_S builds an assembly source file and generates the dependency file
225# $(1) = output directory
226# $(2) = assembly file (%.S)
Yatharth Kochar115352c2015-10-02 13:58:52 +0100227# $(3) = BL stage (2, 2u, 30, 31, 32, 33)
Juan Castilloa3487d12015-08-18 14:23:04 +0100228define MAKE_S
229
230$(eval OBJ := $(1)/$(patsubst %.S,%.o,$(notdir $(2))))
231$(eval PREREQUISITES := $(patsubst %.o,%.d,$(OBJ)))
Yatharth Kochar115352c2015-10-02 13:58:52 +0100232$(eval IMAGE := IMAGE_BL$(call uppercase,$(3)))
Juan Castilloa3487d12015-08-18 14:23:04 +0100233
234$(OBJ): $(2)
235 @echo " AS $$<"
Yatharth Kochar115352c2015-10-02 13:58:52 +0100236 $$(Q)$$(AS) $$(ASFLAGS) -D$(IMAGE) -c $$< -o $$@
Juan Castilloa3487d12015-08-18 14:23:04 +0100237
Evan Lloyd93d3b702015-12-03 12:19:30 +0000238$(PREREQUISITES): $(2) | bl$(3)_dirs
Juan Castilloa3487d12015-08-18 14:23:04 +0100239 @echo " DEPS $$@"
Juan Castilloa3487d12015-08-18 14:23:04 +0100240 $$(Q)$$(AS) $$(ASFLAGS) -M -MT $(OBJ) -MF $$@ $$<
241
242ifdef IS_ANYTHING_TO_BUILD
243-include $(PREREQUISITES)
244endif
245
246endef
247
248
249# MAKE_LD generate the linker script using the C preprocessor
250# $(1) = output linker script
251# $(2) = input template
252define MAKE_LD
253
254$(eval PREREQUISITES := $(1).d)
255
256$(1): $(2)
257 @echo " PP $$<"
258 $$(Q)$$(AS) $$(ASFLAGS) -P -E -D__LINKER__ -o $$@ $$<
259
Evan Lloyd93d3b702015-12-03 12:19:30 +0000260$(PREREQUISITES): $(2) | $(dir ${1})
Juan Castilloa3487d12015-08-18 14:23:04 +0100261 @echo " DEPS $$@"
Juan Castilloa3487d12015-08-18 14:23:04 +0100262 $$(Q)$$(AS) $$(ASFLAGS) -M -MT $(1) -MF $$@ $$<
263
264ifdef IS_ANYTHING_TO_BUILD
265-include $(PREREQUISITES)
266endif
267
268endef
269
270
271# MAKE_OBJS builds both C and assembly source files
272# $(1) = output directory
273# $(2) = list of source files (both C and assembly)
274# $(3) = BL stage (2, 30, 31, 32, 33)
275define MAKE_OBJS
276 $(eval C_OBJS := $(filter %.c,$(2)))
277 $(eval REMAIN := $(filter-out %.c,$(2)))
278 $(eval $(foreach obj,$(C_OBJS),$(call MAKE_C,$(1),$(obj),$(3))))
279
280 $(eval S_OBJS := $(filter %.S,$(REMAIN)))
281 $(eval REMAIN := $(filter-out %.S,$(REMAIN)))
282 $(eval $(foreach obj,$(S_OBJS),$(call MAKE_S,$(1),$(obj),$(3))))
283
284 $(and $(REMAIN),$(error Unexpected source files present: $(REMAIN)))
285endef
286
287
288# NOTE: The line continuation '\' is required in the next define otherwise we
289# end up with a line-feed characer at the end of the last c filename.
Evan Lloyda71d2592015-12-02 18:56:06 +0000290# Also bear this issue in mind if extending the list of supported filetypes.
Juan Castilloa3487d12015-08-18 14:23:04 +0100291define SOURCES_TO_OBJS
292 $(notdir $(patsubst %.c,%.o,$(filter %.c,$(1)))) \
293 $(notdir $(patsubst %.S,%.o,$(filter %.S,$(1))))
294endef
295
296
297# MAKE_TOOL_ARGS macro defines the command line arguments for the FIP tool for
298# each BL image. Arguments:
299# $(1) = BL stage (2, 30, 31, 32, 33)
300# $(2) = Binary file
Juan Castillo8e04dec2016-01-05 11:55:36 +0000301# $(3) = FIP command line option (if empty, image will not be included in the FIP)
Juan Castilloa3487d12015-08-18 14:23:04 +0100302define MAKE_TOOL_ARGS
Juan Castillo8e04dec2016-01-05 11:55:36 +0000303 $(if $(3),$(eval $(call FIP_ADD_PAYLOAD,$(2),--$(3),bl$(1))))
Juan Castilloa3487d12015-08-18 14:23:04 +0100304endef
305
Patrick Georgi8a10e342016-01-28 14:46:18 +0100306# Allow overriding the timestamp, for example for reproducible builds, or to
307# synchronize timestamps across multiple projects.
308# This must be set to a C string (including quotes where applicable).
309BUILD_MESSAGE_TIMESTAMP ?= __TIME__", "__DATE__
Juan Castilloa3487d12015-08-18 14:23:04 +0100310
311# MAKE_BL macro defines the targets and options to build each BL image.
312# Arguments:
Yatharth Kochar115352c2015-10-02 13:58:52 +0100313# $(1) = BL stage (2, 2u, 30, 31, 32, 33)
Juan Castillo8e04dec2016-01-05 11:55:36 +0000314# $(2) = FIP command line option (if empty, image will not be included in the FIP)
Juan Castilloa3487d12015-08-18 14:23:04 +0100315define MAKE_BL
316 $(eval BUILD_DIR := ${BUILD_PLAT}/bl$(1))
Yatharth Kochar115352c2015-10-02 13:58:52 +0100317 $(eval BL_SOURCES := $(BL$(call uppercase,$(1))_SOURCES))
318 $(eval SOURCES := $(BL_SOURCES) $(BL_COMMON_SOURCES) $(PLAT_BL_COMMON_SOURCES))
Juan Castilloa3487d12015-08-18 14:23:04 +0100319 $(eval OBJS := $(addprefix $(BUILD_DIR)/,$(call SOURCES_TO_OBJS,$(SOURCES))))
320 $(eval LINKERFILE := $(call IMG_LINKERFILE,$(1)))
321 $(eval MAPFILE := $(call IMG_MAPFILE,$(1)))
322 $(eval ELF := $(call IMG_ELF,$(1)))
323 $(eval DUMP := $(call IMG_DUMP,$(1)))
324 $(eval BIN := $(call IMG_BIN,$(1)))
Yatharth Kochar115352c2015-10-02 13:58:52 +0100325 $(eval BL_LINKERFILE := $(BL$(call uppercase,$(1))_LINKERFILE))
Evan Lloyd93d3b702015-12-03 12:19:30 +0000326 # We use sort only to get a list of unique object directory names.
327 # ordering is not relevant but sort removes duplicates.
328 $(eval TEMP_OBJ_DIRS := $(sort $(BUILD_DIR)/ $(dir ${OBJS})))
329 # The $(dir ) function leaves a trailing / on the directory names
330 # We append a . then strip /. from each, to remove the trailing / characters
331 # This gives names suitable for use as make rule targets.
332 $(eval OBJ_DIRS := $(subst /.,,$(addsuffix .,$(TEMP_OBJ_DIRS))))
333
334# Create generators for object directory structure
Juan Castilloa3487d12015-08-18 14:23:04 +0100335
Evan Lloyd93d3b702015-12-03 12:19:30 +0000336$(eval $(foreach objd,${OBJ_DIRS},$(call MAKE_PREREQ_DIR,${objd},)))
Juan Castilloa3487d12015-08-18 14:23:04 +0100337
Evan Lloyd93d3b702015-12-03 12:19:30 +0000338.PHONY : bl${1}_dirs
Juan Castilloa3487d12015-08-18 14:23:04 +0100339
Evan Lloyd93d3b702015-12-03 12:19:30 +0000340# We use order-only prerequisites to ensure that directories are created,
341# but do not cause re-builds every time a file is written.
342bl${1}_dirs: | ${OBJ_DIRS}
343
344$(eval $(call MAKE_OBJS,$(BUILD_DIR),$(SOURCES),$(1)))
345$(eval $(call MAKE_LD,$(LINKERFILE),$(BL_LINKERFILE)))
346
347$(ELF): $(OBJS) $(LINKERFILE) | bl$(1)_dirs
Juan Castilloa3487d12015-08-18 14:23:04 +0100348 @echo " LD $$@"
Evan Lloydcf6e9d42015-12-03 12:58:52 +0000349ifdef MAKE_BUILD_STRINGS
350 $(call MAKE_BUILD_STRINGS, $(BUILD_DIR)/build_message.o)
351else
Patrick Georgi8a10e342016-01-28 14:46:18 +0100352 @echo 'const char build_message[] = "Built : "$(BUILD_MESSAGE_TIMESTAMP); \
Juan Castilloa3487d12015-08-18 14:23:04 +0100353 const char version_string[] = "${VERSION_STRING}";' | \
Sandrine Bailleuxf5fdbcc2016-04-11 13:01:17 +0100354 $$(CC) $$(TF_CFLAGS) $$(CFLAGS) -xc - -o $(BUILD_DIR)/build_message.o
Evan Lloydcf6e9d42015-12-03 12:58:52 +0000355endif
Juan Castilloa3487d12015-08-18 14:23:04 +0100356 $$(Q)$$(LD) -o $$@ $$(LDFLAGS) -Map=$(MAPFILE) --script $(LINKERFILE) \
357 $(BUILD_DIR)/build_message.o $(OBJS)
358
359$(DUMP): $(ELF)
360 @echo " OD $$@"
361 $${Q}$${OD} -dx $$< > $$@
362
363$(BIN): $(ELF)
364 @echo " BIN $$@"
365 $$(Q)$$(OC) -O binary $$< $$@
366 @echo
367 @echo "Built $$@ successfully"
368 @echo
369
370.PHONY: bl$(1)
Evan Lloyd93d3b702015-12-03 12:19:30 +0000371bl$(1): $(BIN) $(DUMP)
Juan Castilloa3487d12015-08-18 14:23:04 +0100372
373all: bl$(1)
374
375$(eval $(call MAKE_TOOL_ARGS,$(1),$(BIN),$(2)))
376
377endef
378