1# 2# Copyright (c) 2015-2017, 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 840-9 := 0 1 2 3 4 5 6 7 8 9 85 86# Function to verify that a given option $(1) contains a numeric value 87define assert_numeric 88$(if $($(1)),,$(error $(1) must not be empty)) 89$(eval __numeric := $($(1))) 90$(foreach d,$(0-9),$(eval __numeric := $(subst $(d),,$(__numeric)))) 91$(if $(__numeric),$(error $(1) must be numeric)) 92endef 93 94# IMG_LINKERFILE defines the linker script corresponding to a BL stage 95# $(1) = BL stage (2, 30, 31, 32, 33) 96define IMG_LINKERFILE 97 ${BUILD_DIR}/bl$(1).ld 98endef 99 100# IMG_MAPFILE defines the output file describing the memory map corresponding 101# to a BL stage 102# $(1) = BL stage (2, 30, 31, 32, 33) 103define IMG_MAPFILE 104 ${BUILD_DIR}/bl$(1).map 105endef 106 107# IMG_ELF defines the elf file corresponding to a BL stage 108# $(1) = BL stage (2, 30, 31, 32, 33) 109define IMG_ELF 110 ${BUILD_DIR}/bl$(1).elf 111endef 112 113# IMG_DUMP defines the symbols dump file corresponding to a BL stage 114# $(1) = BL stage (2, 30, 31, 32, 33) 115define IMG_DUMP 116 ${BUILD_DIR}/bl$(1).dump 117endef 118 119# IMG_BIN defines the default image file corresponding to a BL stage 120# $(1) = BL stage (2, 30, 31, 32, 33) 121define IMG_BIN 122 ${BUILD_PLAT}/bl$(1).bin 123endef 124 125# FIP_ADD_PAYLOAD appends the command line arguments required by fiptool 126# to package a new payload. Optionally, it adds the dependency on this payload 127# $(1) = payload filename (i.e. bl31.bin) 128# $(2) = command line option for the specified payload (i.e. --bl31) 129# $(3) = fip target dependency (optional) (i.e. bl31) 130define FIP_ADD_PAYLOAD 131 $(eval FIP_ARGS += $(2) $(1)) 132 $(eval $(if $(3),FIP_DEPS += $(3))) 133endef 134 135# CERT_ADD_CMD_OPT adds a new command line option to the cert_create invocation 136# $(1) = parameter filename 137# $(2) = cert_create command line option for the specified parameter 138# $(3) = input parameter (false if empty) 139define CERT_ADD_CMD_OPT 140 $(eval $(if $(3),CRT_DEPS += $(1))) 141 $(eval CRT_ARGS += $(2) $(1)) 142endef 143 144# FIP_ADD_IMG allows the platform to specify an image to be packed in the FIP 145# using a build option. It also adds a dependency on the image file, aborting 146# the build if the file does not exist. 147# $(1) = build option to specify the image filename (SCP_BL2, BL33, etc) 148# $(2) = command line option for fiptool (scp_bl2, bl33, etc) 149# Example: 150# $(eval $(call FIP_ADD_IMG,BL33,--bl33)) 151define FIP_ADD_IMG 152 CRT_DEPS += check_$(1) 153 FIP_DEPS += check_$(1) 154 $(call FIP_ADD_PAYLOAD,$(value $(1)),$(2)) 155 156check_$(1): 157 $$(if $(value $(1)),,$$(error "Platform '${PLAT}' requires $(1). Please set $(1) to point to the right file")) 158endef 159 160# FWU_FIP_ADD_PAYLOAD appends the command line arguments required by fiptool 161# to package a new FWU payload. Optionally, it adds the dependency on this payload 162# $(1) = payload filename (e.g. ns_bl2u.bin) 163# $(2) = command line option for the specified payload (e.g. --fwu) 164# $(3) = fip target dependency (optional) (e.g. ns_bl2u) 165define FWU_FIP_ADD_PAYLOAD 166 $(eval $(if $(3),FWU_FIP_DEPS += $(3))) 167 $(eval FWU_FIP_ARGS += $(2) $(1)) 168endef 169 170# FWU_CERT_ADD_CMD_OPT adds a new command line option to the cert_create invocation 171# $(1) = parameter filename 172# $(2) = cert_create command line option for the specified parameter 173# $(3) = input parameter (false if empty) 174define FWU_CERT_ADD_CMD_OPT 175 $(eval $(if $(3),FWU_CRT_DEPS += $(1))) 176 $(eval FWU_CRT_ARGS += $(2) $(1)) 177endef 178 179# FWU_FIP_ADD_IMG allows the platform to pack a binary image in the FWU FIP 180# $(1) build option to specify the image filename (BL2U, NS_BL2U, etc) 181# $(2) command line option for fiptool (bl2u, ns_bl2u, etc) 182# Example: 183# $(eval $(call FWU_FIP_ADD_IMG,BL2U,--bl2u)) 184define FWU_FIP_ADD_IMG 185 FWU_CRT_DEPS += check_$(1) 186 FWU_FIP_DEPS += check_$(1) 187 $(call FWU_FIP_ADD_PAYLOAD,$(value $(1)),$(2)) 188 189check_$(1): 190 $$(if $(value $(1)),,$$(error "Platform '${PLAT}' requires $(1). Please set $(1) to point to the right file")) 191endef 192 193################################################################################ 194# Auxiliary macros to build TF images from sources 195################################################################################ 196 197MAKE_DEP = -Wp,-MD,$(DEP) -MT $$@ -MP 198 199# MAKE_C builds a C source file and generates the dependency file 200# $(1) = output directory 201# $(2) = source file (%.c) 202# $(3) = BL stage (2, 2u, 30, 31, 32, 33) 203define MAKE_C 204 205$(eval OBJ := $(1)/$(patsubst %.c,%.o,$(notdir $(2)))) 206$(eval DEP := $(patsubst %.o,%.d,$(OBJ))) 207$(eval IMAGE := IMAGE_BL$(call uppercase,$(3))) 208 209$(OBJ): $(2) | bl$(3)_dirs 210 @echo " CC $$<" 211 $$(Q)$$(CC) $$(TF_CFLAGS) $$(CFLAGS) -D$(IMAGE) $(MAKE_DEP) -c $$< -o $$@ 212 213-include $(DEP) 214 215endef 216 217 218# MAKE_S builds an assembly source file and generates the dependency file 219# $(1) = output directory 220# $(2) = assembly file (%.S) 221# $(3) = BL stage (2, 2u, 30, 31, 32, 33) 222define MAKE_S 223 224$(eval OBJ := $(1)/$(patsubst %.S,%.o,$(notdir $(2)))) 225$(eval DEP := $(patsubst %.o,%.d,$(OBJ))) 226$(eval IMAGE := IMAGE_BL$(call uppercase,$(3))) 227 228$(OBJ): $(2) | bl$(3)_dirs 229 @echo " AS $$<" 230 $$(Q)$$(AS) $$(ASFLAGS) -D$(IMAGE) $(MAKE_DEP) -c $$< -o $$@ 231 232-include $(DEP) 233 234endef 235 236 237# MAKE_LD generate the linker script using the C preprocessor 238# $(1) = output linker script 239# $(2) = input template 240# $(3) = BL stage (2, 2u, 30, 31, 32, 33) 241define MAKE_LD 242 243$(eval DEP := $(1).d) 244 245$(1): $(2) | bl$(3)_dirs 246 @echo " PP $$<" 247 $$(Q)$$(CPP) $$(CPPFLAGS) -P -D__ASSEMBLY__ -D__LINKER__ $(MAKE_DEP) -o $$@ $$< 248 249-include $(DEP) 250 251endef 252 253 254# MAKE_OBJS builds both C and assembly source files 255# $(1) = output directory 256# $(2) = list of source files (both C and assembly) 257# $(3) = BL stage (2, 30, 31, 32, 33) 258define MAKE_OBJS 259 $(eval C_OBJS := $(filter %.c,$(2))) 260 $(eval REMAIN := $(filter-out %.c,$(2))) 261 $(eval $(foreach obj,$(C_OBJS),$(call MAKE_C,$(1),$(obj),$(3)))) 262 263 $(eval S_OBJS := $(filter %.S,$(REMAIN))) 264 $(eval REMAIN := $(filter-out %.S,$(REMAIN))) 265 $(eval $(foreach obj,$(S_OBJS),$(call MAKE_S,$(1),$(obj),$(3)))) 266 267 $(and $(REMAIN),$(error Unexpected source files present: $(REMAIN))) 268endef 269 270 271# NOTE: The line continuation '\' is required in the next define otherwise we 272# end up with a line-feed characer at the end of the last c filename. 273# Also bear this issue in mind if extending the list of supported filetypes. 274define SOURCES_TO_OBJS 275 $(notdir $(patsubst %.c,%.o,$(filter %.c,$(1)))) \ 276 $(notdir $(patsubst %.S,%.o,$(filter %.S,$(1)))) 277endef 278 279 280# MAKE_TOOL_ARGS macro defines the command line arguments for fiptool for 281# each BL image. Arguments: 282# $(1) = BL stage (2, 30, 31, 32, 33) 283# $(2) = Binary file 284# $(3) = FIP command line option (if empty, image will not be included in the FIP) 285define MAKE_TOOL_ARGS 286 $(if $(3),$(eval $(call FIP_ADD_PAYLOAD,$(2),--$(3),bl$(1)))) 287endef 288 289# Allow overriding the timestamp, for example for reproducible builds, or to 290# synchronize timestamps across multiple projects. 291# This must be set to a C string (including quotes where applicable). 292BUILD_MESSAGE_TIMESTAMP ?= __TIME__", "__DATE__ 293 294# MAKE_BL macro defines the targets and options to build each BL image. 295# Arguments: 296# $(1) = BL stage (2, 2u, 30, 31, 32, 33) 297# $(2) = FIP command line option (if empty, image will not be included in the FIP) 298define MAKE_BL 299 $(eval BUILD_DIR := ${BUILD_PLAT}/bl$(1)) 300 $(eval BL_SOURCES := $(BL$(call uppercase,$(1))_SOURCES)) 301 $(eval SOURCES := $(BL_SOURCES) $(BL_COMMON_SOURCES) $(PLAT_BL_COMMON_SOURCES)) 302 $(eval OBJS := $(addprefix $(BUILD_DIR)/,$(call SOURCES_TO_OBJS,$(SOURCES)))) 303 $(eval LINKERFILE := $(call IMG_LINKERFILE,$(1))) 304 $(eval MAPFILE := $(call IMG_MAPFILE,$(1))) 305 $(eval ELF := $(call IMG_ELF,$(1))) 306 $(eval DUMP := $(call IMG_DUMP,$(1))) 307 $(eval BIN := $(call IMG_BIN,$(1))) 308 $(eval BL_LINKERFILE := $(BL$(call uppercase,$(1))_LINKERFILE)) 309 # We use sort only to get a list of unique object directory names. 310 # ordering is not relevant but sort removes duplicates. 311 $(eval TEMP_OBJ_DIRS := $(sort $(BUILD_DIR)/ $(dir ${OBJS} ${LINKERFILE}))) 312 # The $(dir ) function leaves a trailing / on the directory names 313 # Rip off the / to match directory names with make rule targets. 314 $(eval OBJ_DIRS := $(patsubst %/,%,$(TEMP_OBJ_DIRS))) 315 316# Create generators for object directory structure 317 318$(eval $(foreach objd,${OBJ_DIRS},$(call MAKE_PREREQ_DIR,${objd},))) 319 320.PHONY : bl${1}_dirs 321 322# We use order-only prerequisites to ensure that directories are created, 323# but do not cause re-builds every time a file is written. 324bl${1}_dirs: | ${OBJ_DIRS} 325 326$(eval $(call MAKE_OBJS,$(BUILD_DIR),$(SOURCES),$(1))) 327$(eval $(call MAKE_LD,$(LINKERFILE),$(BL_LINKERFILE),$(1))) 328 329$(ELF): $(OBJS) $(LINKERFILE) | bl$(1)_dirs 330 @echo " LD $$@" 331ifdef MAKE_BUILD_STRINGS 332 $(call MAKE_BUILD_STRINGS, $(BUILD_DIR)/build_message.o) 333else 334 @echo 'const char build_message[] = "Built : "$(BUILD_MESSAGE_TIMESTAMP); \ 335 const char version_string[] = "${VERSION_STRING}";' | \ 336 $$(CC) $$(TF_CFLAGS) $$(CFLAGS) -xc -c - -o $(BUILD_DIR)/build_message.o 337endif 338 $$(Q)$$(LD) -o $$@ $$(LDFLAGS) -Map=$(MAPFILE) --script $(LINKERFILE) \ 339 $(BUILD_DIR)/build_message.o $(OBJS) 340 341$(DUMP): $(ELF) 342 @echo " OD $$@" 343 $${Q}$${OD} -dx $$< > $$@ 344 345$(BIN): $(ELF) 346 @echo " BIN $$@" 347 $$(Q)$$(OC) -O binary $$< $$@ 348 @echo 349 @echo "Built $$@ successfully" 350 @echo 351 352.PHONY: bl$(1) 353bl$(1): $(BIN) $(DUMP) 354 355all: bl$(1) 356 357$(eval $(call MAKE_TOOL_ARGS,$(1),$(BIN),$(2))) 358 359endef 360 361