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