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) 106define FIP_ADD_PAYLOAD 107 $(eval FIP_ARGS += $(2) $(1)) 108 $(eval $(if $(3),FIP_DEPS += $(3))) 109endef 110 111# CERT_ADD_CMD_OPT adds a new command line option to the cert_create invocation 112# $(1) = parameter filename 113# $(2) = cert_create command line option for the specified parameter 114# $(3) = input parameter (false if empty) 115define CERT_ADD_CMD_OPT 116 $(eval $(if $(3),CRT_DEPS += $(1))) 117 $(eval CRT_ARGS += $(2) $(1)) 118endef 119 120# FIP_ADD_IMG allows the platform to specify an image to be packed in the FIP 121# using a build option. It also adds a dependency on the image file, aborting 122# the build if the file does not exist. 123# $(1) = build option to specify the image filename (SCP_BL2, BL33, etc) 124# $(2) = command line option for fiptool (--scp-fw, --nt-fw, etc) 125# Example: 126# $(eval $(call FIP_ADD_IMG,BL33,--nt-fw)) 127define FIP_ADD_IMG 128 CRT_DEPS += check_$(1) 129 FIP_DEPS += check_$(1) 130 $(call FIP_ADD_PAYLOAD,$(value $(1)),$(2)) 131 132.PHONY: check_$(1) 133check_$(1): 134 $$(if $(value $(1)),,$$(error "Platform '${PLAT}' requires $(1). Please set $(1) to point to the right file")) 135 $$(if $(wildcard $(value $(1))),,$$(error '$(1)=$(value $(1))' was specified, but '$(value $(1))' does not exist)) 136endef 137 138# FWU_FIP_ADD_PAYLOAD appends the command line arguments required by fiptool 139# to package a new FWU payload. Optionally, it adds the dependency on this payload 140# $(1) = payload filename (e.g. ns_bl2u.bin) 141# $(2) = command line option for the specified payload (e.g. --fwu) 142# $(3) = fip target dependency (optional) (e.g. ns_bl2u) 143define FWU_FIP_ADD_PAYLOAD 144 $(eval $(if $(3),FWU_FIP_DEPS += $(3))) 145 $(eval FWU_FIP_ARGS += $(2) $(1)) 146endef 147 148# FWU_CERT_ADD_CMD_OPT adds a new command line option to the cert_create invocation 149# $(1) = parameter filename 150# $(2) = cert_create command line option for the specified parameter 151# $(3) = input parameter (false if empty) 152define FWU_CERT_ADD_CMD_OPT 153 $(eval $(if $(3),FWU_CRT_DEPS += $(1))) 154 $(eval FWU_CRT_ARGS += $(2) $(1)) 155endef 156 157# FWU_FIP_ADD_IMG allows the platform to pack a binary image in the FWU FIP 158# $(1) build option to specify the image filename (BL2U, NS_BL2U, etc) 159# $(2) command line option for fiptool (--ap-fwu-cfg, --fwu, etc) 160# Example: 161# $(eval $(call FWU_FIP_ADD_IMG,BL2U,--ap-fwu-cfg)) 162define FWU_FIP_ADD_IMG 163 FWU_CRT_DEPS += check_$(1) 164 FWU_FIP_DEPS += check_$(1) 165 $(call FWU_FIP_ADD_PAYLOAD,$(value $(1)),$(2)) 166 167.PHONY: check_$(1) 168check_$(1): 169 $$(if $(value $(1)),,$$(error "Platform '${PLAT}' requires $(1). Please set $(1) to point to the right file")) 170 $$(if $(wildcard $(value $(1))),,$$(error '$(1)=$(value $(1))' was specified, but '$(value $(1))' 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) 268define MAKE_BL 269 $(eval BUILD_DIR := ${BUILD_PLAT}/bl$(1)) 270 $(eval BL_SOURCES := $(BL$(call uppercase,$(1))_SOURCES)) 271 $(eval SOURCES := $(BL_SOURCES) $(BL_COMMON_SOURCES) $(PLAT_BL_COMMON_SOURCES)) 272 $(eval OBJS := $(addprefix $(BUILD_DIR)/,$(call SOURCES_TO_OBJS,$(SOURCES)))) 273 $(eval LINKERFILE := $(call IMG_LINKERFILE,$(1))) 274 $(eval MAPFILE := $(call IMG_MAPFILE,$(1))) 275 $(eval ELF := $(call IMG_ELF,$(1))) 276 $(eval DUMP := $(call IMG_DUMP,$(1))) 277 $(eval BIN := $(call IMG_BIN,$(1))) 278 $(eval BL_LINKERFILE := $(BL$(call uppercase,$(1))_LINKERFILE)) 279 # We use sort only to get a list of unique object directory names. 280 # ordering is not relevant but sort removes duplicates. 281 $(eval TEMP_OBJ_DIRS := $(sort $(dir ${OBJS} ${LINKERFILE}))) 282 # The $(dir ) function leaves a trailing / on the directory names 283 # Rip off the / to match directory names with make rule targets. 284 $(eval OBJ_DIRS := $(patsubst %/,%,$(TEMP_OBJ_DIRS))) 285 286# Create generators for object directory structure 287 288$(eval $(call MAKE_PREREQ_DIR,${BUILD_DIR},${BUILD_PLAT})) 289 290$(eval $(foreach objd,${OBJ_DIRS},$(call MAKE_PREREQ_DIR,${objd},${BUILD_DIR}))) 291 292.PHONY : bl${1}_dirs 293 294# We use order-only prerequisites to ensure that directories are created, 295# but do not cause re-builds every time a file is written. 296bl${1}_dirs: | ${OBJ_DIRS} 297 298$(eval $(call MAKE_OBJS,$(BUILD_DIR),$(SOURCES),$(1))) 299$(eval $(call MAKE_LD,$(LINKERFILE),$(BL_LINKERFILE),$(1))) 300 301$(ELF): $(OBJS) $(LINKERFILE) | bl$(1)_dirs 302 @echo " LD $$@" 303ifdef MAKE_BUILD_STRINGS 304 $(call MAKE_BUILD_STRINGS, $(BUILD_DIR)/build_message.o) 305else 306 @echo 'const char build_message[] = "Built : "$(BUILD_MESSAGE_TIMESTAMP); \ 307 const char version_string[] = "${VERSION_STRING}";' | \ 308 $$(CC) $$(TF_CFLAGS) $$(CFLAGS) -xc -c - -o $(BUILD_DIR)/build_message.o 309endif 310 $$(Q)$$(LD) -o $$@ $$(TF_LDFLAGS) $$(LDFLAGS) -Map=$(MAPFILE) \ 311 --script $(LINKERFILE) $(BUILD_DIR)/build_message.o $(OBJS) $(LDLIBS) 312 313$(DUMP): $(ELF) 314 @echo " OD $$@" 315 $${Q}$${OD} -dx $$< > $$@ 316 317$(BIN): $(ELF) 318 @echo " BIN $$@" 319 $$(Q)$$(OC) -O binary $$< $$@ 320 @${ECHO_BLANK_LINE} 321 @echo "Built $$@ successfully" 322 @${ECHO_BLANK_LINE} 323 324.PHONY: bl$(1) 325bl$(1): $(BIN) $(DUMP) 326 327all: bl$(1) 328 329$(if $(2),$(call FIP_ADD_PAYLOAD,$(BIN),--$(2),bl$(1))) 330 331endef 332 333define SOURCES_TO_DTBS 334 $(notdir $(patsubst %.dts,%.dtb,$(filter %.dts,$(1)))) 335endef 336 337# MAKE_FDT macro defines the targets and options to build each FDT binary 338# Arguments: (none) 339define MAKE_FDT 340 $(eval DTB_BUILD_DIR := ${BUILD_PLAT}/fdts) 341 $(eval DTBS := $(addprefix $(DTB_BUILD_DIR)/,$(call SOURCES_TO_DTBS,$(FDT_SOURCES)))) 342 $(eval TEMP_DTB_DIRS := $(sort $(dir ${DTBS}))) 343 # The $(dir ) function leaves a trailing / on the directory names 344 # Rip off the / to match directory names with make rule targets. 345 $(eval DTB_DIRS := $(patsubst %/,%,$(TEMP_DTB_DIRS))) 346 347$(eval $(foreach objd,${DTB_DIRS},$(call MAKE_PREREQ_DIR,${objd},${BUILD_DIR}))) 348 349fdt_dirs: ${DTB_DIRS} 350 351endef 352 353# MAKE_DTB generate the Flattened device tree binary (device tree binary) 354# $(1) = output directory 355# $(2) = input dts 356define MAKE_DTB 357 358$(eval DOBJ := $(1)/$(patsubst %.dts,%.dtb,$(notdir $(2)))) 359$(eval DEP := $(patsubst %.dtb,%.d,$(DOBJ))) 360 361$(DOBJ): $(2) | fdt_dirs 362 @echo " DTC $$<" 363 $$(Q)$$(DTC) $$(DTC_FLAGS) -d $(DEP) -o $$@ $$< 364 365-include $(DEP) 366 367endef 368 369# MAKE_DTBS builds flattened device tree sources 370# $(1) = output directory 371# $(2) = list of flattened device tree source files 372define MAKE_DTBS 373 $(eval DOBJS := $(filter %.dts,$(2))) 374 $(eval REMAIN := $(filter-out %.dts,$(2))) 375 $(eval $(foreach obj,$(DOBJS),$(call MAKE_DTB,$(1),$(obj)))) 376 377 $(and $(REMAIN),$(error Unexpected s present: $(REMAIN))) 378endef 379