1# 2# Copyright (c) 2015-2016, ARM Limited and Contributors. All rights reserved. 3# 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 31# 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 37# 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 48# 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 64# 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 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 78# 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 125# CERT_ADD_CMD_OPT adds a new command line option to the cert_create invocation 126# $(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. 137# $(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) 139# 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 150# 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) 153# $(2) = command line option for the specified payload (e.g. --fwu) 154# $(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 182 183################################################################################ 184# Auxiliary macros to build TF images from sources 185################################################################################ 186 187# 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 193define match_goals 194$(strip $(foreach goal,$(1),$(filter $(goal),$(MAKECMDGOALS)))) 195endef 196 197# List of rules that involve building things 198BUILD_TARGETS := all bl1 bl2 bl2u bl31 bl32 certificates fip 199 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) 209# $(3) = BL stage (2, 2u, 30, 31, 32, 33) 210define MAKE_C 211 212$(eval OBJ := $(1)/$(patsubst %.c,%.o,$(notdir $(2)))) 213$(eval PREREQUISITES := $(patsubst %.o,%.d,$(OBJ))) 214$(eval IMAGE := IMAGE_BL$(call uppercase,$(3))) 215 216$(OBJ): $(2) 217 @echo " CC $$<" 218 $$(Q)$$(CC) $$(TF_CFLAGS) $$(CFLAGS) -D$(IMAGE) -c $$< -o $$@ 219 220$(PREREQUISITES): $(2) | bl$(3)_dirs 221 @echo " DEPS $$@" 222 $$(Q)$$(CC) $$(TF_CFLAGS) $$(CFLAGS) -M -MT $(OBJ) -MF $$@ $$< 223 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) 234# $(3) = BL stage (2, 2u, 30, 31, 32, 33) 235define MAKE_S 236 237$(eval OBJ := $(1)/$(patsubst %.S,%.o,$(notdir $(2)))) 238$(eval PREREQUISITES := $(patsubst %.o,%.d,$(OBJ))) 239$(eval IMAGE := IMAGE_BL$(call uppercase,$(3))) 240 241$(OBJ): $(2) 242 @echo " AS $$<" 243 $$(Q)$$(AS) $$(ASFLAGS) -D$(IMAGE) -c $$< -o $$@ 244 245$(PREREQUISITES): $(2) | bl$(3)_dirs 246 @echo " DEPS $$@" 247 $$(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 267$(PREREQUISITES): $(2) | $(dir ${1}) 268 @echo " DEPS $$@" 269 $$(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. 297# Also bear this issue in mind if extending the list of supported filetypes. 298define 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 308# $(3) = FIP command line option (if empty, image will not be included in the FIP) 309define MAKE_TOOL_ARGS 310 $(if $(3),$(eval $(call FIP_ADD_PAYLOAD,$(2),--$(3),bl$(1)))) 311endef 312 313# 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__ 317 318# MAKE_BL macro defines the targets and options to build each BL image. 319# Arguments: 320# $(1) = BL stage (2, 2u, 30, 31, 32, 33) 321# $(2) = FIP command line option (if empty, image will not be included in the FIP) 322define MAKE_BL 323 $(eval BUILD_DIR := ${BUILD_PLAT}/bl$(1)) 324 $(eval BL_SOURCES := $(BL$(call uppercase,$(1))_SOURCES)) 325 $(eval SOURCES := $(BL_SOURCES) $(BL_COMMON_SOURCES) $(PLAT_BL_COMMON_SOURCES)) 326 $(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))) 332 $(eval BL_LINKERFILE := $(BL$(call uppercase,$(1))_LINKERFILE)) 333 # 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 342 343$(eval $(foreach objd,${OBJ_DIRS},$(call MAKE_PREREQ_DIR,${objd},))) 344 345.PHONY : bl${1}_dirs 346 347# 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 355 @echo " LD $$@" 356ifdef MAKE_BUILD_STRINGS 357 $(call MAKE_BUILD_STRINGS, $(BUILD_DIR)/build_message.o) 358else 359 @echo 'const char build_message[] = "Built : "$(BUILD_MESSAGE_TIMESTAMP); \ 360 const char version_string[] = "${VERSION_STRING}";' | \ 361 $$(CC) $$(TF_CFLAGS) $$(CFLAGS) -xc - -o $(BUILD_DIR)/build_message.o 362endif 363 $$(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) 378bl$(1): $(BIN) $(DUMP) 379 380all: bl$(1) 381 382$(eval $(call MAKE_TOOL_ARGS,$(1),$(BIN),$(2))) 383 384endef 385 386