1# 2# Copyright (c) 2015-2016, ARM Limited and Contributors. All rights reserved. 3# 4# Redistribution and use in source and binary forms, with or without 5# modification, are permitted provided that the following conditions are met: 6# 7# Redistributions of source code must retain the above copyright notice, this 8# list of conditions and the following disclaimer. 9# 10# Redistributions in binary form must reproduce the above copyright notice, 11# this list of conditions and the following disclaimer in the documentation 12# and/or other materials provided with the distribution. 13# 14# Neither the name of ARM nor the names of its contributors may be used 15# to endorse or promote products derived from this software without specific 16# prior written permission. 17# 18# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 19# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 22# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28# POSSIBILITY OF SUCH DAMAGE. 29# 30 31# Report an error if the eval make function is not available. 32$(eval eval_available := T) 33ifneq (${eval_available},T) 34 $(error This makefile only works with a Make program that supports $$(eval)) 35endif 36 37# Some utility macros for manipulating awkward (whitespace) characters. 38blank := 39space :=${blank} ${blank} 40 41# A user defined function to recursively search for a filename below a directory 42# $1 is the directory root of the recursive search (blank for current directory). 43# $2 is the file name to search for. 44define rwildcard 45$(strip $(foreach d,$(wildcard ${1}*),$(call rwildcard,${d}/,${2}) $(filter $(subst *,%,%${2}),${d}))) 46endef 47 48# This table is used in converting lower case to upper case. 49uppercase_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 50 51# Internal macro used for converting lower case to upper case. 52# $(1) = upper case table 53# $(2) = String to convert 54define uppercase_internal 55$(if $(1),$$(subst $(firstword $(1)),$(call uppercase_internal,$(wordlist 2,$(words $(1)),$(1)),$(2))),$(2)) 56endef 57 58# A macro for converting a string to upper case 59# $(1) = String to convert 60define uppercase 61$(eval uppercase_result:=$(call uppercase_internal,$(uppercase_table),$(1)))$(uppercase_result) 62endef 63 64# Convenience function for adding build definitions 65# $(eval $(call add_define,FOO)) will have: 66# -DFOO if $(FOO) is empty; -DFOO=$(FOO) otherwise 67define add_define 68 DEFINES += -D$(1)$(if $(value $(1)),=$(value $(1)),) 69endef 70 71# Convenience function for verifying option has a boolean value 72# $(eval $(call assert_boolean,FOO)) will assert FOO is 0 or 1 73define assert_boolean 74 $(and $(patsubst 0,,$(value $(1))),$(patsubst 1,,$(value $(1))),$(error $(1) must be boolean)) 75endef 76 77# IMG_LINKERFILE defines the linker script corresponding to a BL stage 78# $(1) = BL stage (2, 30, 31, 32, 33) 79define IMG_LINKERFILE 80 ${BUILD_DIR}/bl$(1).ld 81endef 82 83# IMG_MAPFILE defines the output file describing the memory map corresponding 84# to a BL stage 85# $(1) = BL stage (2, 30, 31, 32, 33) 86define IMG_MAPFILE 87 ${BUILD_DIR}/bl$(1).map 88endef 89 90# IMG_ELF defines the elf file corresponding to a BL stage 91# $(1) = BL stage (2, 30, 31, 32, 33) 92define IMG_ELF 93 ${BUILD_DIR}/bl$(1).elf 94endef 95 96# IMG_DUMP defines the symbols dump file corresponding to a BL stage 97# $(1) = BL stage (2, 30, 31, 32, 33) 98define IMG_DUMP 99 ${BUILD_DIR}/bl$(1).dump 100endef 101 102# IMG_BIN defines the default image file corresponding to a BL stage 103# $(1) = BL stage (2, 30, 31, 32, 33) 104define IMG_BIN 105 ${BUILD_PLAT}/bl$(1).bin 106endef 107 108# FIP_ADD_PAYLOAD appends the command line arguments required by the FIP tool 109# to package a new payload. Optionally, it adds the dependency on this payload 110# $(1) = payload filename (i.e. bl31.bin) 111# $(2) = command line option for the specified payload (i.e. --bl31) 112# $(3) = fip target dependency (optional) (i.e. bl31) 113define FIP_ADD_PAYLOAD 114 $(eval FIP_ARGS += $(2) $(1)) 115 $(eval $(if $(3),FIP_DEPS += $(3))) 116endef 117 118# CERT_ADD_CMD_OPT adds a new command line option to the cert_create invocation 119# $(1) = parameter filename 120# $(2) = cert_create command line option for the specified parameter 121# $(3) = input parameter (false if empty) 122define CERT_ADD_CMD_OPT 123 $(eval $(if $(3),CRT_DEPS += $(1))) 124 $(eval CRT_ARGS += $(2) $(1)) 125endef 126 127# FIP_ADD_IMG allows the platform to specify an image to be packed in the FIP 128# using a build option. It also adds a dependency on the image file, aborting 129# the build if the file does not exist. 130# $(1) = build option to specify the image filename (SCP_BL2, BL33, etc) 131# $(2) = command line option for the fip_create tool (scp_bl2, bl33, etc) 132# Example: 133# $(eval $(call FIP_ADD_IMG,BL33,--bl33)) 134define FIP_ADD_IMG 135 CRT_DEPS += check_$(1) 136 FIP_DEPS += check_$(1) 137 $(call FIP_ADD_PAYLOAD,$(value $(1)),$(2)) 138 139check_$(1): 140 $$(if $(value $(1)),,$$(error "Platform '${PLAT}' requires $(1). Please set $(1) to point to the right file")) 141endef 142 143# FWU_FIP_ADD_PAYLOAD appends the command line arguments required by the FIP tool 144# to package a new FWU payload. Optionally, it adds the dependency on this payload 145# $(1) = payload filename (e.g. ns_bl2u.bin) 146# $(2) = command line option for the specified payload (e.g. --fwu) 147# $(3) = fip target dependency (optional) (e.g. ns_bl2u) 148define FWU_FIP_ADD_PAYLOAD 149 $(eval $(if $(3),FWU_FIP_DEPS += $(3))) 150 $(eval FWU_FIP_ARGS += $(2) $(1)) 151endef 152 153# FWU_CERT_ADD_CMD_OPT adds a new command line option to the cert_create invocation 154# $(1) = parameter filename 155# $(2) = cert_create command line option for the specified parameter 156# $(3) = input parameter (false if empty) 157define FWU_CERT_ADD_CMD_OPT 158 $(eval $(if $(3),FWU_CRT_DEPS += $(1))) 159 $(eval FWU_CRT_ARGS += $(2) $(1)) 160endef 161 162# FWU_FIP_ADD_IMG allows the platform to pack a binary image in the FWU FIP 163# $(1) build option to specify the image filename (BL2U, NS_BL2U, etc) 164# $(2) command line option for the fip_create tool (bl2u, ns_bl2u, etc) 165# Example: 166# $(eval $(call FWU_FIP_ADD_IMG,BL2U,--bl2u)) 167define FWU_FIP_ADD_IMG 168 FWU_CRT_DEPS += check_$(1) 169 FWU_FIP_DEPS += check_$(1) 170 $(call FWU_FIP_ADD_PAYLOAD,$(value $(1)),$(2)) 171 172check_$(1): 173 $$(if $(value $(1)),,$$(error "Platform '${PLAT}' requires $(1). Please set $(1) to point to the right file")) 174endef 175 176################################################################################ 177# Auxiliary macros to build TF images from sources 178################################################################################ 179 180# If no goal is specified in the command line, .DEFAULT_GOAL is used. 181# .DEFAULT_GOAL is defined in the main Makefile before including this file. 182ifeq ($(MAKECMDGOALS),) 183MAKECMDGOALS := $(.DEFAULT_GOAL) 184endif 185 186define match_goals 187$(strip $(foreach goal,$(1),$(filter $(goal),$(MAKECMDGOALS)))) 188endef 189 190# List of rules that involve building things 191BUILD_TARGETS := all bl1 bl2 bl2u bl31 bl32 certificates fip 192 193# Does the list of goals specified on the command line include a build target? 194ifneq ($(call match_goals,${BUILD_TARGETS}),) 195IS_ANYTHING_TO_BUILD := 1 196endif 197 198 199# MAKE_C builds a C source file and generates the dependency file 200# $(1) = output directory 201# $(2) = source file (%.c) 202# $(3) = BL stage (2, 2u, 30, 31, 32, 33) 203define MAKE_C 204 205$(eval OBJ := $(1)/$(patsubst %.c,%.o,$(notdir $(2)))) 206$(eval PREREQUISITES := $(patsubst %.o,%.d,$(OBJ))) 207$(eval IMAGE := IMAGE_BL$(call uppercase,$(3))) 208 209$(OBJ): $(2) 210 @echo " CC $$<" 211 $$(Q)$$(CC) $$(CFLAGS) -D$(IMAGE) -c $$< -o $$@ 212 213 214$(PREREQUISITES): $(2) 215 @echo " DEPS $$@" 216 @mkdir -p $(1) 217 $$(Q)$$(CC) $$(CFLAGS) -M -MT $(OBJ) -MF $$@ $$< 218 219ifdef IS_ANYTHING_TO_BUILD 220-include $(PREREQUISITES) 221endif 222 223endef 224 225 226# MAKE_S builds an assembly source file and generates the dependency file 227# $(1) = output directory 228# $(2) = assembly file (%.S) 229# $(3) = BL stage (2, 2u, 30, 31, 32, 33) 230define MAKE_S 231 232$(eval OBJ := $(1)/$(patsubst %.S,%.o,$(notdir $(2)))) 233$(eval PREREQUISITES := $(patsubst %.o,%.d,$(OBJ))) 234$(eval IMAGE := IMAGE_BL$(call uppercase,$(3))) 235 236$(OBJ): $(2) 237 @echo " AS $$<" 238 $$(Q)$$(AS) $$(ASFLAGS) -D$(IMAGE) -c $$< -o $$@ 239 240$(PREREQUISITES): $(2) 241 @echo " DEPS $$@" 242 @mkdir -p $(1) 243 $$(Q)$$(AS) $$(ASFLAGS) -M -MT $(OBJ) -MF $$@ $$< 244 245ifdef IS_ANYTHING_TO_BUILD 246-include $(PREREQUISITES) 247endif 248 249endef 250 251 252# MAKE_LD generate the linker script using the C preprocessor 253# $(1) = output linker script 254# $(2) = input template 255define MAKE_LD 256 257$(eval PREREQUISITES := $(1).d) 258 259$(1): $(2) 260 @echo " PP $$<" 261 $$(Q)$$(AS) $$(ASFLAGS) -P -E -D__LINKER__ -o $$@ $$< 262 263$(PREREQUISITES): $(2) 264 @echo " DEPS $$@" 265 @mkdir -p $$(dir $$@) 266 $$(Q)$$(AS) $$(ASFLAGS) -M -MT $(1) -MF $$@ $$< 267 268ifdef IS_ANYTHING_TO_BUILD 269-include $(PREREQUISITES) 270endif 271 272endef 273 274 275# MAKE_OBJS builds both C and assembly source files 276# $(1) = output directory 277# $(2) = list of source files (both C and assembly) 278# $(3) = BL stage (2, 30, 31, 32, 33) 279define MAKE_OBJS 280 $(eval C_OBJS := $(filter %.c,$(2))) 281 $(eval REMAIN := $(filter-out %.c,$(2))) 282 $(eval $(foreach obj,$(C_OBJS),$(call MAKE_C,$(1),$(obj),$(3)))) 283 284 $(eval S_OBJS := $(filter %.S,$(REMAIN))) 285 $(eval REMAIN := $(filter-out %.S,$(REMAIN))) 286 $(eval $(foreach obj,$(S_OBJS),$(call MAKE_S,$(1),$(obj),$(3)))) 287 288 $(and $(REMAIN),$(error Unexpected source files present: $(REMAIN))) 289endef 290 291 292# NOTE: The line continuation '\' is required in the next define otherwise we 293# end up with a line-feed characer at the end of the last c filename. 294# Also bare this issue in mind if extending the list of supported filetypes. 295define SOURCES_TO_OBJS 296 $(notdir $(patsubst %.c,%.o,$(filter %.c,$(1)))) \ 297 $(notdir $(patsubst %.S,%.o,$(filter %.S,$(1)))) 298endef 299 300 301# MAKE_TOOL_ARGS macro defines the command line arguments for the FIP tool for 302# each BL image. Arguments: 303# $(1) = BL stage (2, 30, 31, 32, 33) 304# $(2) = Binary file 305# $(3) = FIP command line option (if empty, image will not be included in the FIP) 306define MAKE_TOOL_ARGS 307 $(if $(3),$(eval $(call FIP_ADD_PAYLOAD,$(2),--$(3),bl$(1)))) 308endef 309 310# Allow overriding the timestamp, for example for reproducible builds, or to 311# synchronize timestamps across multiple projects. 312# This must be set to a C string (including quotes where applicable). 313BUILD_MESSAGE_TIMESTAMP ?= __TIME__", "__DATE__ 314 315# MAKE_BL macro defines the targets and options to build each BL image. 316# Arguments: 317# $(1) = BL stage (2, 2u, 30, 31, 32, 33) 318# $(2) = FIP command line option (if empty, image will not be included in the FIP) 319define MAKE_BL 320 $(eval BUILD_DIR := ${BUILD_PLAT}/bl$(1)) 321 $(eval BL_SOURCES := $(BL$(call uppercase,$(1))_SOURCES)) 322 $(eval SOURCES := $(BL_SOURCES) $(BL_COMMON_SOURCES) $(PLAT_BL_COMMON_SOURCES)) 323 $(eval OBJS := $(addprefix $(BUILD_DIR)/,$(call SOURCES_TO_OBJS,$(SOURCES)))) 324 $(eval LINKERFILE := $(call IMG_LINKERFILE,$(1))) 325 $(eval MAPFILE := $(call IMG_MAPFILE,$(1))) 326 $(eval ELF := $(call IMG_ELF,$(1))) 327 $(eval DUMP := $(call IMG_DUMP,$(1))) 328 $(eval BIN := $(call IMG_BIN,$(1))) 329 $(eval BL_LINKERFILE := $(BL$(call uppercase,$(1))_LINKERFILE)) 330 331 $(eval $(call MAKE_OBJS,$(BUILD_DIR),$(SOURCES),$(1))) 332 $(eval $(call MAKE_LD,$(LINKERFILE),$(BL_LINKERFILE))) 333 334$(BUILD_DIR): 335 $$(Q)mkdir -p "$$@" 336 337$(ELF): $(OBJS) $(LINKERFILE) 338 @echo " LD $$@" 339 @echo 'const char build_message[] = "Built : "$(BUILD_MESSAGE_TIMESTAMP); \ 340 const char version_string[] = "${VERSION_STRING}";' | \ 341 $$(CC) $$(CFLAGS) -xc - -o $(BUILD_DIR)/build_message.o 342 $$(Q)$$(LD) -o $$@ $$(LDFLAGS) -Map=$(MAPFILE) --script $(LINKERFILE) \ 343 $(BUILD_DIR)/build_message.o $(OBJS) 344 345$(DUMP): $(ELF) 346 @echo " OD $$@" 347 $${Q}$${OD} -dx $$< > $$@ 348 349$(BIN): $(ELF) 350 @echo " BIN $$@" 351 $$(Q)$$(OC) -O binary $$< $$@ 352 @echo 353 @echo "Built $$@ successfully" 354 @echo 355 356.PHONY: bl$(1) 357bl$(1): $(BUILD_DIR) $(BIN) $(DUMP) 358 359all: bl$(1) 360 361$(eval $(call MAKE_TOOL_ARGS,$(1),$(BIN),$(2))) 362 363endef 364 365