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