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 193# MAKE_C_LIB builds a C source file and generates the dependency file 194# $(1) = output directory 195# $(2) = source file (%.c) 196# $(3) = library name 197define MAKE_C_LIB 198$(eval OBJ := $(1)/$(patsubst %.c,%.o,$(notdir $(2)))) 199$(eval DEP := $(patsubst %.o,%.d,$(OBJ))) 200 201$(OBJ): $(2) $(filter-out %.d,$(MAKEFILE_LIST)) | lib$(3)_dirs 202 @echo " CC $$<" 203 $$(Q)$$(CC) $$(TF_CFLAGS) $$(CFLAGS) $(MAKE_DEP) -c $$< -o $$@ 204 205-include $(DEP) 206 207endef 208 209 210# MAKE_C builds a C source file and generates the dependency file 211# $(1) = output directory 212# $(2) = source file (%.c) 213# $(3) = BL stage (2, 2u, 30, 31, 32, 33) 214define MAKE_C 215 216$(eval OBJ := $(1)/$(patsubst %.c,%.o,$(notdir $(2)))) 217$(eval DEP := $(patsubst %.o,%.d,$(OBJ))) 218$(eval IMAGE := IMAGE_BL$(call uppercase,$(3))) 219 220$(OBJ): $(2) $(filter-out %.d,$(MAKEFILE_LIST)) | bl$(3)_dirs 221 @echo " CC $$<" 222 $$(Q)$$(CC) $$(TF_CFLAGS) $$(CFLAGS) -D$(IMAGE) $(MAKE_DEP) -c $$< -o $$@ 223 224-include $(DEP) 225 226endef 227 228 229# MAKE_S builds an assembly source file and generates the dependency file 230# $(1) = output directory 231# $(2) = assembly file (%.S) 232# $(3) = BL stage (2, 2u, 30, 31, 32, 33) 233define MAKE_S 234 235$(eval OBJ := $(1)/$(patsubst %.S,%.o,$(notdir $(2)))) 236$(eval DEP := $(patsubst %.o,%.d,$(OBJ))) 237$(eval IMAGE := IMAGE_BL$(call uppercase,$(3))) 238 239$(OBJ): $(2) $(filter-out %.d,$(MAKEFILE_LIST)) | bl$(3)_dirs 240 @echo " AS $$<" 241 $$(Q)$$(AS) $$(ASFLAGS) -D$(IMAGE) $(MAKE_DEP) -c $$< -o $$@ 242 243-include $(DEP) 244 245endef 246 247 248# MAKE_LD generate the linker script using the C preprocessor 249# $(1) = output linker script 250# $(2) = input template 251# $(3) = BL stage (2, 2u, 30, 31, 32, 33) 252define MAKE_LD 253 254$(eval DEP := $(1).d) 255 256$(1): $(2) $(filter-out %.d,$(MAKEFILE_LIST)) | bl$(3)_dirs 257 @echo " PP $$<" 258 $$(Q)$$(CPP) $$(CPPFLAGS) -P -D__ASSEMBLY__ -D__LINKER__ $(MAKE_DEP) -o $$@ $$< 259 260-include $(DEP) 261 262endef 263 264# MAKE_LIB_OBJS builds both C source files 265# $(1) = output directory 266# $(2) = list of source files 267# $(3) = name of the library 268define MAKE_LIB_OBJS 269 $(eval C_OBJS := $(filter %.c,$(2))) 270 $(eval REMAIN := $(filter-out %.c,$(2))) 271 $(eval $(foreach obj,$(C_OBJS),$(call MAKE_C_LIB,$(1),$(obj),$(3)))) 272 273 $(and $(REMAIN),$(error Unexpected source files present: $(REMAIN))) 274endef 275 276 277# MAKE_OBJS builds both C and assembly source files 278# $(1) = output directory 279# $(2) = list of source files (both C and assembly) 280# $(3) = BL stage (2, 30, 31, 32, 33) 281define MAKE_OBJS 282 $(eval C_OBJS := $(filter %.c,$(2))) 283 $(eval REMAIN := $(filter-out %.c,$(2))) 284 $(eval $(foreach obj,$(C_OBJS),$(call MAKE_C,$(1),$(obj),$(3)))) 285 286 $(eval S_OBJS := $(filter %.S,$(REMAIN))) 287 $(eval REMAIN := $(filter-out %.S,$(REMAIN))) 288 $(eval $(foreach obj,$(S_OBJS),$(call MAKE_S,$(1),$(obj),$(3)))) 289 290 $(and $(REMAIN),$(error Unexpected source files present: $(REMAIN))) 291endef 292 293 294# NOTE: The line continuation '\' is required in the next define otherwise we 295# end up with a line-feed characer at the end of the last c filename. 296# Also bear this issue in mind if extending the list of supported filetypes. 297define SOURCES_TO_OBJS 298 $(notdir $(patsubst %.c,%.o,$(filter %.c,$(1)))) \ 299 $(notdir $(patsubst %.S,%.o,$(filter %.S,$(1)))) 300endef 301 302# Allow overriding the timestamp, for example for reproducible builds, or to 303# synchronize timestamps across multiple projects. 304# This must be set to a C string (including quotes where applicable). 305BUILD_MESSAGE_TIMESTAMP ?= __TIME__", "__DATE__ 306 307.PHONY: libraries 308 309# MAKE_LIB_DIRS macro defines the target for the directory where 310# libraries are created 311define MAKE_LIB_DIRS 312 $(eval LIB_DIR := ${BUILD_PLAT}/lib) 313 $(eval ROMLIB_DIR := ${BUILD_PLAT}/romlib) 314 $(eval LIBWRAPPER_DIR := ${BUILD_PLAT}/libwrapper) 315 $(eval $(call MAKE_PREREQ_DIR,${LIB_DIR},${BUILD_PLAT})) 316 $(eval $(call MAKE_PREREQ_DIR,${ROMLIB_DIR},${BUILD_PLAT})) 317 $(eval $(call MAKE_PREREQ_DIR,${LIBWRAPPER_DIR},${BUILD_PLAT})) 318endef 319 320# MAKE_LIB macro defines the targets and options to build each BL image. 321# Arguments: 322# $(1) = Library name 323define MAKE_LIB 324 $(eval BUILD_DIR := ${BUILD_PLAT}/lib$(1)) 325 $(eval LIB_DIR := ${BUILD_PLAT}/lib) 326 $(eval ROMLIB_DIR := ${BUILD_PLAT}/romlib) 327 $(eval SOURCES := $(LIB$(call uppercase,$(1))_SRCS)) 328 $(eval OBJS := $(addprefix $(BUILD_DIR)/,$(call SOURCES_TO_OBJS,$(SOURCES)))) 329 330$(eval $(call MAKE_PREREQ_DIR,${BUILD_DIR},${BUILD_PLAT})) 331$(eval $(call MAKE_LIB_OBJS,$(BUILD_DIR),$(SOURCES),$(1))) 332 333.PHONY : lib${1}_dirs 334lib${1}_dirs: | ${BUILD_DIR} ${LIB_DIR} ${ROMLIB_DIR} ${LIBWRAPPER_DIR} 335libraries: ${LIB_DIR}/lib$(1).a 336LDPATHS = -L${LIB_DIR} 337LDLIBS += -l$(1) 338 339ifeq ($(USE_ROMLIB),1) 340LDLIBS := -lwrappers -lc 341endif 342 343all: ${LIB_DIR}/lib$(1).a 344 345${LIB_DIR}/lib$(1).a: $(OBJS) 346 @echo " AR $$@" 347 $$(Q)$$(AR) cr $$@ $$? 348endef 349 350# MAKE_BL macro defines the targets and options to build each BL image. 351# Arguments: 352# $(1) = BL stage (2, 2u, 30, 31, 32, 33) 353# $(2) = FIP command line option (if empty, image will not be included in the FIP) 354# $(3) = FIP prefix (optional) (if FWU_, target is fwu_fip instead of fip) 355define MAKE_BL 356 $(eval BUILD_DIR := ${BUILD_PLAT}/bl$(1)) 357 $(eval BL_SOURCES := $(BL$(call uppercase,$(1))_SOURCES)) 358 $(eval SOURCES := $(BL_SOURCES) $(BL_COMMON_SOURCES) $(PLAT_BL_COMMON_SOURCES)) 359 $(eval OBJS := $(addprefix $(BUILD_DIR)/,$(call SOURCES_TO_OBJS,$(SOURCES)))) 360 $(eval LINKERFILE := $(call IMG_LINKERFILE,$(1))) 361 $(eval MAPFILE := $(call IMG_MAPFILE,$(1))) 362 $(eval ELF := $(call IMG_ELF,$(1))) 363 $(eval DUMP := $(call IMG_DUMP,$(1))) 364 $(eval BIN := $(call IMG_BIN,$(1))) 365 $(eval BL_LINKERFILE := $(BL$(call uppercase,$(1))_LINKERFILE)) 366 $(eval BL_LIBS := $(BL$(call uppercase,$(1))_LIBS)) 367 # We use sort only to get a list of unique object directory names. 368 # ordering is not relevant but sort removes duplicates. 369 $(eval TEMP_OBJ_DIRS := $(sort $(dir ${OBJS} ${LINKERFILE}))) 370 # The $(dir ) function leaves a trailing / on the directory names 371 # Rip off the / to match directory names with make rule targets. 372 $(eval OBJ_DIRS := $(patsubst %/,%,$(TEMP_OBJ_DIRS))) 373 374# Create generators for object directory structure 375 376$(eval $(call MAKE_PREREQ_DIR,${BUILD_DIR},${BUILD_PLAT})) 377 378$(eval $(foreach objd,${OBJ_DIRS},$(call MAKE_PREREQ_DIR,${objd},${BUILD_DIR}))) 379 380.PHONY : bl${1}_dirs 381 382# We use order-only prerequisites to ensure that directories are created, 383# but do not cause re-builds every time a file is written. 384bl${1}_dirs: | ${OBJ_DIRS} 385 386$(eval $(call MAKE_OBJS,$(BUILD_DIR),$(SOURCES),$(1))) 387$(eval $(call MAKE_LD,$(LINKERFILE),$(BL_LINKERFILE),$(1))) 388 389ifeq ($(USE_ROMLIB),1) 390$(ELF): romlib.bin 391endif 392 393$(ELF): $(OBJS) $(LINKERFILE) | bl$(1)_dirs libraries $(BL_LIBS) 394 @echo " LD $$@" 395ifdef MAKE_BUILD_STRINGS 396 $(call MAKE_BUILD_STRINGS, $(BUILD_DIR)/build_message.o) 397else 398 @echo 'const char build_message[] = "Built : "$(BUILD_MESSAGE_TIMESTAMP); \ 399 const char version_string[] = "${VERSION_STRING}";' | \ 400 $$(CC) $$(TF_CFLAGS) $$(CFLAGS) -xc -c - -o $(BUILD_DIR)/build_message.o 401endif 402 $$(Q)$$(LD) -o $$@ $$(TF_LDFLAGS) $$(LDFLAGS) -Map=$(MAPFILE) \ 403 --script $(LINKERFILE) $(BUILD_DIR)/build_message.o \ 404 $(OBJS) $(LDPATHS) $(LDLIBS) $(BL_LIBS) 405 406$(DUMP): $(ELF) 407 @echo " OD $$@" 408 $${Q}$${OD} -dx $$< > $$@ 409 410$(BIN): $(ELF) 411 @echo " BIN $$@" 412 $$(Q)$$(OC) -O binary $$< $$@ 413 @${ECHO_BLANK_LINE} 414 @echo "Built $$@ successfully" 415 @${ECHO_BLANK_LINE} 416 417.PHONY: bl$(1) 418bl$(1): $(BIN) $(DUMP) 419 420all: bl$(1) 421 422$(if $(2),$(call TOOL_ADD_IMG_PAYLOAD,bl$(1),$(BIN),--$(2),$(BIN),$(3))) 423 424endef 425 426# Convert device tree source file names to matching blobs 427# $(1) = input dts 428define SOURCES_TO_DTBS 429 $(notdir $(patsubst %.dts,%.dtb,$(filter %.dts,$(1)))) 430endef 431 432# MAKE_FDT_DIRS macro creates the prerequisite directories that host the 433# FDT binaries 434# $(1) = output directory 435# $(2) = input dts 436define MAKE_FDT_DIRS 437 $(eval DTBS := $(addprefix $(1)/,$(call SOURCES_TO_DTBS,$(2)))) 438 $(eval TEMP_DTB_DIRS := $(sort $(dir ${DTBS}))) 439 # The $(dir ) function leaves a trailing / on the directory names 440 # Rip off the / to match directory names with make rule targets. 441 $(eval DTB_DIRS := $(patsubst %/,%,$(TEMP_DTB_DIRS))) 442 443$(eval $(foreach objd,${DTB_DIRS},$(call MAKE_PREREQ_DIR,${objd},${BUILD_DIR}))) 444 445fdt_dirs: ${DTB_DIRS} 446endef 447 448# MAKE_DTB generate the Flattened device tree binary 449# $(1) = output directory 450# $(2) = input dts 451define MAKE_DTB 452 453$(eval DOBJ := $(addprefix $(1)/,$(call SOURCES_TO_DTBS,$(2)))) 454$(eval DPRE := $(addprefix $(1)/,$(patsubst %.dts,%.pre.dts,$(notdir $(2))))) 455$(eval DEP := $(patsubst %.dtb,%.d,$(DOBJ))) 456 457$(DOBJ): $(2) $(filter-out %.d,$(MAKEFILE_LIST)) | fdt_dirs 458 @echo " CPP $$<" 459 $$(Q)$$(CPP) $$(CPPFLAGS) -x assembler-with-cpp -o $(DPRE) $$< 460 @echo " DTC $$<" 461 $$(Q)$$(DTC) $$(DTC_FLAGS) -i fdts -d $(DEP) -o $$@ $(DPRE) 462 463-include $(DEP) 464 465endef 466 467# MAKE_DTBS builds flattened device tree sources 468# $(1) = output directory 469# $(2) = list of flattened device tree source files 470define MAKE_DTBS 471 $(eval DOBJS := $(filter %.dts,$(2))) 472 $(eval REMAIN := $(filter-out %.dts,$(2))) 473 $(and $(REMAIN),$(error FDT_SOURCES contain non-DTS files: $(REMAIN))) 474 $(eval $(foreach obj,$(DOBJS),$(call MAKE_DTB,$(1),$(obj)))) 475 476 $(eval $(call MAKE_FDT_DIRS,$(1),$(2))) 477 478dtbs: $(DTBS) 479all: dtbs 480endef 481