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# Generic image processing filters 175################################################################################ 176 177# GZIP 178define GZIP_RULE 179$(1): $(2) 180 @echo " GZIP $$@" 181 $(Q)gzip -n -f -9 $$< --stdout > $$@ 182endef 183 184GZIP_SUFFIX := .gz 185 186################################################################################ 187# Auxiliary macros to build TF images from sources 188################################################################################ 189 190MAKE_DEP = -Wp,-MD,$(DEP) -MT $$@ -MP 191 192# MAKE_C builds a C source file and generates the dependency file 193# $(1) = output directory 194# $(2) = source file (%.c) 195# $(3) = BL stage (2, 2u, 30, 31, 32, 33) 196define MAKE_C 197 198$(eval OBJ := $(1)/$(patsubst %.c,%.o,$(notdir $(2)))) 199$(eval DEP := $(patsubst %.o,%.d,$(OBJ))) 200$(eval IMAGE := IMAGE_BL$(call uppercase,$(3))) 201 202$(OBJ): $(2) $(filter-out %.d,$(MAKEFILE_LIST)) | bl$(3)_dirs 203 @echo " CC $$<" 204 $$(Q)$$(CC) $$(TF_CFLAGS) $$(CFLAGS) -D$(IMAGE) $(MAKE_DEP) -c $$< -o $$@ 205 206-include $(DEP) 207 208endef 209 210 211# MAKE_S builds an assembly source file and generates the dependency file 212# $(1) = output directory 213# $(2) = assembly file (%.S) 214# $(3) = BL stage (2, 2u, 30, 31, 32, 33) 215define MAKE_S 216 217$(eval OBJ := $(1)/$(patsubst %.S,%.o,$(notdir $(2)))) 218$(eval DEP := $(patsubst %.o,%.d,$(OBJ))) 219$(eval IMAGE := IMAGE_BL$(call uppercase,$(3))) 220 221$(OBJ): $(2) $(filter-out %.d,$(MAKEFILE_LIST)) | bl$(3)_dirs 222 @echo " AS $$<" 223 $$(Q)$$(AS) $$(ASFLAGS) -D$(IMAGE) $(MAKE_DEP) -c $$< -o $$@ 224 225-include $(DEP) 226 227endef 228 229 230# MAKE_LD generate the linker script using the C preprocessor 231# $(1) = output linker script 232# $(2) = input template 233# $(3) = BL stage (2, 2u, 30, 31, 32, 33) 234define MAKE_LD 235 236$(eval DEP := $(1).d) 237 238$(1): $(2) $(filter-out %.d,$(MAKEFILE_LIST)) | bl$(3)_dirs 239 @echo " PP $$<" 240 $$(Q)$$(CPP) $$(CPPFLAGS) -P -D__ASSEMBLY__ -D__LINKER__ $(MAKE_DEP) -o $$@ $$< 241 242-include $(DEP) 243 244endef 245 246 247# MAKE_OBJS builds both C and assembly source files 248# $(1) = output directory 249# $(2) = list of source files (both C and assembly) 250# $(3) = BL stage (2, 30, 31, 32, 33) 251define MAKE_OBJS 252 $(eval C_OBJS := $(filter %.c,$(2))) 253 $(eval REMAIN := $(filter-out %.c,$(2))) 254 $(eval $(foreach obj,$(C_OBJS),$(call MAKE_C,$(1),$(obj),$(3)))) 255 256 $(eval S_OBJS := $(filter %.S,$(REMAIN))) 257 $(eval REMAIN := $(filter-out %.S,$(REMAIN))) 258 $(eval $(foreach obj,$(S_OBJS),$(call MAKE_S,$(1),$(obj),$(3)))) 259 260 $(and $(REMAIN),$(error Unexpected source files present: $(REMAIN))) 261endef 262 263 264# NOTE: The line continuation '\' is required in the next define otherwise we 265# end up with a line-feed characer at the end of the last c filename. 266# Also bear this issue in mind if extending the list of supported filetypes. 267define SOURCES_TO_OBJS 268 $(notdir $(patsubst %.c,%.o,$(filter %.c,$(1)))) \ 269 $(notdir $(patsubst %.S,%.o,$(filter %.S,$(1)))) 270endef 271 272# Allow overriding the timestamp, for example for reproducible builds, or to 273# synchronize timestamps across multiple projects. 274# This must be set to a C string (including quotes where applicable). 275BUILD_MESSAGE_TIMESTAMP ?= __TIME__", "__DATE__ 276 277# MAKE_BL macro defines the targets and options to build each BL image. 278# Arguments: 279# $(1) = BL stage (2, 2u, 30, 31, 32, 33) 280# $(2) = FIP command line option (if empty, image will not be included in the FIP) 281# $(3) = FIP prefix (optional) (if FWU_, target is fwu_fip instead of fip) 282define MAKE_BL 283 $(eval BUILD_DIR := ${BUILD_PLAT}/bl$(1)) 284 $(eval BL_SOURCES := $(BL$(call uppercase,$(1))_SOURCES)) 285 $(eval SOURCES := $(BL_SOURCES) $(BL_COMMON_SOURCES) $(PLAT_BL_COMMON_SOURCES)) 286 $(eval OBJS := $(addprefix $(BUILD_DIR)/,$(call SOURCES_TO_OBJS,$(SOURCES)))) 287 $(eval LINKERFILE := $(call IMG_LINKERFILE,$(1))) 288 $(eval MAPFILE := $(call IMG_MAPFILE,$(1))) 289 $(eval ELF := $(call IMG_ELF,$(1))) 290 $(eval DUMP := $(call IMG_DUMP,$(1))) 291 $(eval BIN := $(call IMG_BIN,$(1))) 292 $(eval BL_LINKERFILE := $(BL$(call uppercase,$(1))_LINKERFILE)) 293 # We use sort only to get a list of unique object directory names. 294 # ordering is not relevant but sort removes duplicates. 295 $(eval TEMP_OBJ_DIRS := $(sort $(dir ${OBJS} ${LINKERFILE}))) 296 # The $(dir ) function leaves a trailing / on the directory names 297 # Rip off the / to match directory names with make rule targets. 298 $(eval OBJ_DIRS := $(patsubst %/,%,$(TEMP_OBJ_DIRS))) 299 300# Create generators for object directory structure 301 302$(eval $(call MAKE_PREREQ_DIR,${BUILD_DIR},${BUILD_PLAT})) 303 304$(eval $(foreach objd,${OBJ_DIRS},$(call MAKE_PREREQ_DIR,${objd},${BUILD_DIR}))) 305 306.PHONY : bl${1}_dirs 307 308# We use order-only prerequisites to ensure that directories are created, 309# but do not cause re-builds every time a file is written. 310bl${1}_dirs: | ${OBJ_DIRS} 311 312$(eval $(call MAKE_OBJS,$(BUILD_DIR),$(SOURCES),$(1))) 313$(eval $(call MAKE_LD,$(LINKERFILE),$(BL_LINKERFILE),$(1))) 314 315$(ELF): $(OBJS) $(LINKERFILE) | bl$(1)_dirs 316 @echo " LD $$@" 317ifdef MAKE_BUILD_STRINGS 318 $(call MAKE_BUILD_STRINGS, $(BUILD_DIR)/build_message.o) 319else 320 @echo 'const char build_message[] = "Built : "$(BUILD_MESSAGE_TIMESTAMP); \ 321 const char version_string[] = "${VERSION_STRING}";' | \ 322 $$(CC) $$(TF_CFLAGS) $$(CFLAGS) -xc -c - -o $(BUILD_DIR)/build_message.o 323endif 324 $$(Q)$$(LD) -o $$@ $$(TF_LDFLAGS) $$(LDFLAGS) -Map=$(MAPFILE) \ 325 --script $(LINKERFILE) $(BUILD_DIR)/build_message.o $(OBJS) $(LDLIBS) 326 327$(DUMP): $(ELF) 328 @echo " OD $$@" 329 $${Q}$${OD} -dx $$< > $$@ 330 331$(BIN): $(ELF) 332 @echo " BIN $$@" 333 $$(Q)$$(OC) -O binary $$< $$@ 334 @${ECHO_BLANK_LINE} 335 @echo "Built $$@ successfully" 336 @${ECHO_BLANK_LINE} 337 338.PHONY: bl$(1) 339bl$(1): $(BIN) $(DUMP) 340 341all: bl$(1) 342 343$(if $(2),$(call TOOL_ADD_IMG_PAYLOAD,bl$(1),$(BIN),--$(2),$(BIN),$(3))) 344 345endef 346 347# Convert device tree source file names to matching blobs 348# $(1) = input dts 349define SOURCES_TO_DTBS 350 $(notdir $(patsubst %.dts,%.dtb,$(filter %.dts,$(1)))) 351endef 352 353# MAKE_FDT_DIRS macro creates the prerequisite directories that host the 354# FDT binaries 355# $(1) = output directory 356# $(2) = input dts 357define MAKE_FDT_DIRS 358 $(eval DTBS := $(addprefix $(1)/,$(call SOURCES_TO_DTBS,$(2)))) 359 $(eval TEMP_DTB_DIRS := $(sort $(dir ${DTBS}))) 360 # The $(dir ) function leaves a trailing / on the directory names 361 # Rip off the / to match directory names with make rule targets. 362 $(eval DTB_DIRS := $(patsubst %/,%,$(TEMP_DTB_DIRS))) 363 364$(eval $(foreach objd,${DTB_DIRS},$(call MAKE_PREREQ_DIR,${objd},${BUILD_DIR}))) 365 366fdt_dirs: ${DTB_DIRS} 367endef 368 369# MAKE_DTB generate the Flattened device tree binary 370# $(1) = output directory 371# $(2) = input dts 372define MAKE_DTB 373 374$(eval DOBJ := $(addprefix $(1)/,$(call SOURCES_TO_DTBS,$(2)))) 375$(eval DEP := $(patsubst %.dtb,%.d,$(DOBJ))) 376 377$(DOBJ): $(2) $(filter-out %.d,$(MAKEFILE_LIST)) | fdt_dirs 378 @echo " DTC $$<" 379 $$(Q)$$(DTC) $$(DTC_FLAGS) -d $(DEP) -o $$@ $$< 380 381-include $(DEP) 382 383endef 384 385# MAKE_DTBS builds flattened device tree sources 386# $(1) = output directory 387# $(2) = list of flattened device tree source files 388define MAKE_DTBS 389 $(eval DOBJS := $(filter %.dts,$(2))) 390 $(eval REMAIN := $(filter-out %.dts,$(2))) 391 $(and $(REMAIN),$(error FDT_SOURCES contain non-DTS files: $(REMAIN))) 392 $(eval $(foreach obj,$(DOBJS),$(call MAKE_DTB,$(1),$(obj)))) 393 394 $(eval $(call MAKE_FDT_DIRS,$(1),$(2))) 395 396dtbs: $(DTBS) 397all: dtbs 398endef 399