1# 2# Copyright (c) 2015-2018, ARM Limited and Contributors. All rights reserved. 3# 4# SPDX-License-Identifier: BSD-3-Clause 5# 6 7# 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 13# 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 24# 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 40# 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 47# 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 54# 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 57 $(if $(filter-out 0 1,$($1)),$(error $1 must be boolean)) 58endef 59 600-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 70# 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 101# TOOL_ADD_PAYLOAD appends the command line arguments required by fiptool to 102# package a new payload and/or by cert_create to generate certificate. 103# Optionally, it adds the dependency on this payload 104# $(1) = payload filename (i.e. bl31.bin) 105# $(2) = command line option for the specified payload (i.e. --soc-fw) 106# $(3) = tool target dependency (optional) (ex. build/fvp/release/bl31.bin) 107# $(4) = FIP prefix (optional) (if FWU_, target is fwu_fip instead of fip) 108define TOOL_ADD_PAYLOAD 109 $(4)FIP_ARGS += $(2) $(1) 110 $(if $(3),$(4)FIP_DEPS += $(3)) 111 $(4)CRT_ARGS += $(2) $(1) 112 $(if $(3),$(4)CRT_DEPS += $(3)) 113endef 114 115# TOOL_ADD_IMG_PAYLOAD works like TOOL_ADD_PAYLOAD, but applies image filters 116# before passing them to host tools if BL*_PRE_TOOL_FILTER is defined. 117# $(1) = image_type (scp_bl2, bl33, etc.) 118# $(2) = payload filepath (ex. build/fvp/release/bl31.bin) 119# $(3) = command line option for the specified payload (ex. --soc-fw) 120# $(4) = tool target dependency (optional) (ex. build/fvp/release/bl31.bin) 121# $(5) = FIP prefix (optional) (if FWU_, target is fwu_fip instead of fip) 122 123define TOOL_ADD_IMG_PAYLOAD 124 125$(eval PRE_TOOL_FILTER := $($(call uppercase,$(1))_PRE_TOOL_FILTER)) 126 127ifneq ($(PRE_TOOL_FILTER),) 128 129$(eval PROCESSED_PATH := $(BUILD_PLAT)/$(1).bin$($(PRE_TOOL_FILTER)_SUFFIX)) 130 131$(call $(PRE_TOOL_FILTER)_RULE,$(PROCESSED_PATH),$(2)) 132 133$(PROCESSED_PATH): $(4) 134 135$(call TOOL_ADD_PAYLOAD,$(PROCESSED_PATH),$(3),$(PROCESSED_PATH),$(5)) 136 137else 138$(call TOOL_ADD_PAYLOAD,$(2),$(3),$(4),$(5)) 139endif 140endef 141 142# CERT_ADD_CMD_OPT adds a new command line option to the cert_create invocation 143# $(1) = parameter filename 144# $(2) = cert_create command line option for the specified parameter 145# $(3) = FIP prefix (optional) (if FWU_, target is fwu_fip instead of fip) 146define CERT_ADD_CMD_OPT 147 $(3)CRT_ARGS += $(2) $(1) 148endef 149 150# TOOL_ADD_IMG allows the platform to specify an external image to be packed 151# in the FIP and/or for which certificate is generated. It also adds a 152# dependency on the image file, aborting the build if the file does not exist. 153# $(1) = image_type (scp_bl2, bl33, etc.) 154# $(2) = command line option for fiptool (--scp-fw, --nt-fw, etc) 155# $(3) = FIP prefix (optional) (if FWU_, target is fwu_fip instead of fip) 156# Example: 157# $(eval $(call TOOL_ADD_IMG,bl33,--nt-fw)) 158define TOOL_ADD_IMG 159 # Build option to specify the image filename (SCP_BL2, BL33, etc) 160 # This is the uppercase form of the first parameter 161 $(eval _V := $(call uppercase,$(1))) 162 163 $(3)CRT_DEPS += check_$(1) 164 $(3)FIP_DEPS += check_$(1) 165 $(call TOOL_ADD_IMG_PAYLOAD,$(1),$(value $(_V)),$(2),,$(3)) 166 167.PHONY: check_$(1) 168check_$(1): 169 $$(if $(value $(_V)),,$$(error "Platform '${PLAT}' requires $(_V). Please set $(_V) to point to the right file")) 170 $$(if $(wildcard $(value $(_V))),,$$(error '$(_V)=$(value $(_V))' was specified, but '$(value $(_V))' does not exist)) 171endef 172 173################################################################################ 174# Auxiliary macros to build TF images from sources 175################################################################################ 176 177MAKE_DEP = -Wp,-MD,$(DEP) -MT $$@ -MP 178 179# MAKE_C builds a C source file and generates the dependency file 180# $(1) = output directory 181# $(2) = source file (%.c) 182# $(3) = BL stage (2, 2u, 30, 31, 32, 33) 183define MAKE_C 184 185$(eval OBJ := $(1)/$(patsubst %.c,%.o,$(notdir $(2)))) 186$(eval DEP := $(patsubst %.o,%.d,$(OBJ))) 187$(eval IMAGE := IMAGE_BL$(call uppercase,$(3))) 188 189$(OBJ): $(2) | bl$(3)_dirs 190 @echo " CC $$<" 191 $$(Q)$$(CC) $$(TF_CFLAGS) $$(CFLAGS) -D$(IMAGE) $(MAKE_DEP) -c $$< -o $$@ 192 193-include $(DEP) 194 195endef 196 197 198# MAKE_S builds an assembly source file and generates the dependency file 199# $(1) = output directory 200# $(2) = assembly file (%.S) 201# $(3) = BL stage (2, 2u, 30, 31, 32, 33) 202define MAKE_S 203 204$(eval OBJ := $(1)/$(patsubst %.S,%.o,$(notdir $(2)))) 205$(eval DEP := $(patsubst %.o,%.d,$(OBJ))) 206$(eval IMAGE := IMAGE_BL$(call uppercase,$(3))) 207 208$(OBJ): $(2) | bl$(3)_dirs 209 @echo " AS $$<" 210 $$(Q)$$(AS) $$(ASFLAGS) -D$(IMAGE) $(MAKE_DEP) -c $$< -o $$@ 211 212-include $(DEP) 213 214endef 215 216 217# MAKE_LD generate the linker script using the C preprocessor 218# $(1) = output linker script 219# $(2) = input template 220# $(3) = BL stage (2, 2u, 30, 31, 32, 33) 221define MAKE_LD 222 223$(eval DEP := $(1).d) 224 225$(1): $(2) | bl$(3)_dirs 226 @echo " PP $$<" 227 $$(Q)$$(CPP) $$(CPPFLAGS) -P -D__ASSEMBLY__ -D__LINKER__ $(MAKE_DEP) -o $$@ $$< 228 229-include $(DEP) 230 231endef 232 233 234# MAKE_OBJS builds both C and assembly source files 235# $(1) = output directory 236# $(2) = list of source files (both C and assembly) 237# $(3) = BL stage (2, 30, 31, 32, 33) 238define MAKE_OBJS 239 $(eval C_OBJS := $(filter %.c,$(2))) 240 $(eval REMAIN := $(filter-out %.c,$(2))) 241 $(eval $(foreach obj,$(C_OBJS),$(call MAKE_C,$(1),$(obj),$(3)))) 242 243 $(eval S_OBJS := $(filter %.S,$(REMAIN))) 244 $(eval REMAIN := $(filter-out %.S,$(REMAIN))) 245 $(eval $(foreach obj,$(S_OBJS),$(call MAKE_S,$(1),$(obj),$(3)))) 246 247 $(and $(REMAIN),$(error Unexpected source files present: $(REMAIN))) 248endef 249 250 251# NOTE: The line continuation '\' is required in the next define otherwise we 252# end up with a line-feed characer at the end of the last c filename. 253# Also bear this issue in mind if extending the list of supported filetypes. 254define SOURCES_TO_OBJS 255 $(notdir $(patsubst %.c,%.o,$(filter %.c,$(1)))) \ 256 $(notdir $(patsubst %.S,%.o,$(filter %.S,$(1)))) 257endef 258 259# Allow overriding the timestamp, for example for reproducible builds, or to 260# synchronize timestamps across multiple projects. 261# This must be set to a C string (including quotes where applicable). 262BUILD_MESSAGE_TIMESTAMP ?= __TIME__", "__DATE__ 263 264# MAKE_BL macro defines the targets and options to build each BL image. 265# Arguments: 266# $(1) = BL stage (2, 2u, 30, 31, 32, 33) 267# $(2) = FIP command line option (if empty, image will not be included in the FIP) 268# $(3) = FIP prefix (optional) (if FWU_, target is fwu_fip instead of fip) 269define MAKE_BL 270 $(eval BUILD_DIR := ${BUILD_PLAT}/bl$(1)) 271 $(eval BL_SOURCES := $(BL$(call uppercase,$(1))_SOURCES)) 272 $(eval SOURCES := $(BL_SOURCES) $(BL_COMMON_SOURCES) $(PLAT_BL_COMMON_SOURCES)) 273 $(eval OBJS := $(addprefix $(BUILD_DIR)/,$(call SOURCES_TO_OBJS,$(SOURCES)))) 274 $(eval LINKERFILE := $(call IMG_LINKERFILE,$(1))) 275 $(eval MAPFILE := $(call IMG_MAPFILE,$(1))) 276 $(eval ELF := $(call IMG_ELF,$(1))) 277 $(eval DUMP := $(call IMG_DUMP,$(1))) 278 $(eval BIN := $(call IMG_BIN,$(1))) 279 $(eval BL_LINKERFILE := $(BL$(call uppercase,$(1))_LINKERFILE)) 280 # We use sort only to get a list of unique object directory names. 281 # ordering is not relevant but sort removes duplicates. 282 $(eval TEMP_OBJ_DIRS := $(sort $(dir ${OBJS} ${LINKERFILE}))) 283 # The $(dir ) function leaves a trailing / on the directory names 284 # Rip off the / to match directory names with make rule targets. 285 $(eval OBJ_DIRS := $(patsubst %/,%,$(TEMP_OBJ_DIRS))) 286 287# Create generators for object directory structure 288 289$(eval $(call MAKE_PREREQ_DIR,${BUILD_DIR},${BUILD_PLAT})) 290 291$(eval $(foreach objd,${OBJ_DIRS},$(call MAKE_PREREQ_DIR,${objd},${BUILD_DIR}))) 292 293.PHONY : bl${1}_dirs 294 295# We use order-only prerequisites to ensure that directories are created, 296# but do not cause re-builds every time a file is written. 297bl${1}_dirs: | ${OBJ_DIRS} 298 299$(eval $(call MAKE_OBJS,$(BUILD_DIR),$(SOURCES),$(1))) 300$(eval $(call MAKE_LD,$(LINKERFILE),$(BL_LINKERFILE),$(1))) 301 302$(ELF): $(OBJS) $(LINKERFILE) | bl$(1)_dirs 303 @echo " LD $$@" 304ifdef MAKE_BUILD_STRINGS 305 $(call MAKE_BUILD_STRINGS, $(BUILD_DIR)/build_message.o) 306else 307 @echo 'const char build_message[] = "Built : "$(BUILD_MESSAGE_TIMESTAMP); \ 308 const char version_string[] = "${VERSION_STRING}";' | \ 309 $$(CC) $$(TF_CFLAGS) $$(CFLAGS) -xc -c - -o $(BUILD_DIR)/build_message.o 310endif 311 $$(Q)$$(LD) -o $$@ $$(TF_LDFLAGS) $$(LDFLAGS) -Map=$(MAPFILE) \ 312 --script $(LINKERFILE) $(BUILD_DIR)/build_message.o $(OBJS) $(LDLIBS) 313 314$(DUMP): $(ELF) 315 @echo " OD $$@" 316 $${Q}$${OD} -dx $$< > $$@ 317 318$(BIN): $(ELF) 319 @echo " BIN $$@" 320 $$(Q)$$(OC) -O binary $$< $$@ 321 @${ECHO_BLANK_LINE} 322 @echo "Built $$@ successfully" 323 @${ECHO_BLANK_LINE} 324 325.PHONY: bl$(1) 326bl$(1): $(BIN) $(DUMP) 327 328all: bl$(1) 329 330$(if $(2),$(call TOOL_ADD_IMG_PAYLOAD,bl$(1),$(BIN),--$(2),$(BIN),$(3))) 331 332endef 333 334define SOURCES_TO_DTBS 335 $(notdir $(patsubst %.dts,%.dtb,$(filter %.dts,$(1)))) 336endef 337 338# MAKE_FDT macro defines the targets and options to build each FDT binary 339# Arguments: (none) 340define MAKE_FDT 341 $(eval DTB_BUILD_DIR := ${BUILD_PLAT}/fdts) 342 $(eval DTBS := $(addprefix $(DTB_BUILD_DIR)/,$(call SOURCES_TO_DTBS,$(FDT_SOURCES)))) 343 $(eval TEMP_DTB_DIRS := $(sort $(dir ${DTBS}))) 344 # The $(dir ) function leaves a trailing / on the directory names 345 # Rip off the / to match directory names with make rule targets. 346 $(eval DTB_DIRS := $(patsubst %/,%,$(TEMP_DTB_DIRS))) 347 348$(eval $(foreach objd,${DTB_DIRS},$(call MAKE_PREREQ_DIR,${objd},${BUILD_DIR}))) 349 350fdt_dirs: ${DTB_DIRS} 351 352endef 353 354# MAKE_DTB generate the Flattened device tree binary (device tree binary) 355# $(1) = output directory 356# $(2) = input dts 357define MAKE_DTB 358 359$(eval DOBJ := $(1)/$(patsubst %.dts,%.dtb,$(notdir $(2)))) 360$(eval DEP := $(patsubst %.dtb,%.d,$(DOBJ))) 361 362$(DOBJ): $(2) | fdt_dirs 363 @echo " DTC $$<" 364 $$(Q)$$(DTC) $$(DTC_FLAGS) -d $(DEP) -o $$@ $$< 365 366-include $(DEP) 367 368endef 369 370# MAKE_DTBS builds flattened device tree sources 371# $(1) = output directory 372# $(2) = list of flattened device tree source files 373define MAKE_DTBS 374 $(eval DOBJS := $(filter %.dts,$(2))) 375 $(eval REMAIN := $(filter-out %.dts,$(2))) 376 $(eval $(foreach obj,$(DOBJS),$(call MAKE_DTB,$(1),$(obj)))) 377 378 $(and $(REMAIN),$(error Unexpected s present: $(REMAIN))) 379endef 380