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