1# 2# Copyright (c) 2013-2014, 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# 32# Trusted Firmware Version 33# 34VERSION_MAJOR := 0 35VERSION_MINOR := 4 36 37# 38# Default values for build configurations 39# 40 41# Build verbosity 42V := 0 43# Debug build 44DEBUG := 0 45# Build architecture 46ARCH := aarch64 47# Build platform 48DEFAULT_PLAT := fvp 49PLAT := ${DEFAULT_PLAT} 50# SPD choice 51SPD := none 52# Base commit to perform code check on 53BASE_COMMIT := origin/master 54# NS timer register save and restore 55NS_TIMER_SWITCH := 0 56# By default, Bl1 acts as the reset handler, not BL31 57RESET_TO_BL31 := 0 58# Include FP registers in cpu context 59CTX_INCLUDE_FPREGS := 0 60# Determine the version of ARM GIC architecture to use for interrupt management 61# in EL3. The platform port can change this value if needed. 62ARM_GIC_ARCH := 2 63# Flag used to indicate if ASM_ASSERTION should be enabled for the build. 64# This defaults to being present in DEBUG builds only. 65ASM_ASSERTION := ${DEBUG} 66 67# Checkpatch ignores 68CHECK_IGNORE = --ignore COMPLEX_MACRO 69 70CHECKPATCH_ARGS = --no-tree --no-signoff ${CHECK_IGNORE} 71CHECKCODE_ARGS = --no-patch --no-tree --no-signoff ${CHECK_IGNORE} 72 73ifeq (${V},0) 74 Q=@ 75 CHECKCODE_ARGS += --no-summary --terse 76else 77 Q= 78endif 79export Q 80 81ifneq (${DEBUG}, 0) 82 BUILD_TYPE := debug 83else 84 BUILD_TYPE := release 85endif 86 87# Default build string (git branch and commit) 88ifeq (${BUILD_STRING},) 89 BUILD_STRING := $(shell git log -n 1 --pretty=format:"%h") 90endif 91 92VERSION_STRING := v${VERSION_MAJOR}.${VERSION_MINOR}(${BUILD_TYPE}):${BUILD_STRING} 93 94BL_COMMON_SOURCES := common/bl_common.c \ 95 common/tf_printf.c \ 96 common/aarch64/debug.S \ 97 lib/aarch64/cache_helpers.S \ 98 lib/aarch64/misc_helpers.S \ 99 lib/aarch64/xlat_helpers.c \ 100 lib/stdlib/std.c \ 101 lib/io_storage.c \ 102 plat/common/aarch64/platform_helpers.S 103 104BUILD_BASE := ./build 105BUILD_PLAT := ${BUILD_BASE}/${PLAT}/${BUILD_TYPE} 106 107PLATFORMS := $(shell ls -I common plat/) 108SPDS := $(shell ls -I none services/spd) 109HELP_PLATFORMS := $(shell echo ${PLATFORMS} | sed 's/ /|/g') 110 111# Convenience function for adding build definitions 112# $(eval $(call add_define,FOO)) will have: 113# -DFOO if $(FOO) is empty; -DFOO=$(FOO) otherwise 114define add_define 115DEFINES += -D$(1)$(if $(value $(1)),=$(value $(1)),) 116endef 117 118# Convenience function for verifying option has a boolean value 119# $(eval $(call assert_boolean,FOO)) will assert FOO is 0 or 1 120define assert_boolean 121$(and $(patsubst 0,,$(value $(1))),$(patsubst 1,,$(value $(1))),$(error $(1) must be boolean)) 122endef 123 124ifeq (${PLAT},) 125 $(error "Error: Unknown platform. Please use PLAT=<platform name> to specify the platform.") 126endif 127ifeq ($(findstring ${PLAT},${PLATFORMS}),) 128 $(error "Error: Invalid platform. The following platforms are available: ${PLATFORMS}") 129endif 130 131all: msg_start 132 133msg_start: 134 @echo "Building ${PLAT}" 135 136include plat/${PLAT}/platform.mk 137 138ifdef BL1_SOURCES 139NEED_BL1 := yes 140include bl1/bl1.mk 141endif 142 143ifdef BL2_SOURCES 144NEED_BL2 := yes 145include bl2/bl2.mk 146endif 147 148ifdef BL31_SOURCES 149NEED_BL31 := yes 150include bl31/bl31.mk 151endif 152 153# Include SPD Makefile if one has been specified 154ifneq (${SPD},none) 155 # We expect to locate an spd.mk under the specified SPD directory 156 SPD_MAKE := $(shell m="services/spd/${SPD}/${SPD}.mk"; [ -f "$$m" ] && echo "$$m") 157 158 ifeq (${SPD_MAKE},) 159 $(error Error: No services/spd/${SPD}/${SPD}.mk located) 160 endif 161 $(info Including ${SPD_MAKE}) 162 include ${SPD_MAKE} 163 164 # If there's BL32 companion for the chosen SPD, and the SPD wants to build the 165 # BL2 from source, we expect that the SPD's Makefile would set NEED_BL32 166 # variable to "yes" 167endif 168 169.PHONY: all msg_start clean realclean distclean cscope locate-checkpatch checkcodebase checkpatch fiptool fip 170.SUFFIXES: 171 172INCLUDES += -Iinclude/bl31 \ 173 -Iinclude/bl31/services \ 174 -Iinclude/bl32 \ 175 -Iinclude/bl32/payloads \ 176 -Iinclude/common \ 177 -Iinclude/drivers \ 178 -Iinclude/drivers/arm \ 179 -Iinclude/lib \ 180 -Iinclude/lib/aarch64 \ 181 -Iinclude/plat/common \ 182 -Iinclude/stdlib \ 183 -Iinclude/stdlib/sys \ 184 ${PLAT_INCLUDES} \ 185 ${SPD_INCLUDES} 186 187# Process DEBUG flag 188$(eval $(call assert_boolean,DEBUG)) 189$(eval $(call add_define,DEBUG)) 190ifeq (${DEBUG},0) 191 $(eval $(call add_define,NDEBUG)) 192else 193CFLAGS += -g 194ASFLAGS += -g -Wa,--gdwarf-2 195endif 196 197# Process NS_TIMER_SWITCH flag 198$(eval $(call assert_boolean,NS_TIMER_SWITCH)) 199$(eval $(call add_define,NS_TIMER_SWITCH)) 200 201# Process RESET_TO_BL31 flag 202$(eval $(call assert_boolean,RESET_TO_BL31)) 203$(eval $(call add_define,RESET_TO_BL31)) 204 205# Process CTX_INCLUDE_FPREGS flag 206$(eval $(call assert_boolean,CTX_INCLUDE_FPREGS)) 207$(eval $(call add_define,CTX_INCLUDE_FPREGS)) 208 209# Process ARM_GIC_ARCH flag 210$(eval $(call add_define,ARM_GIC_ARCH)) 211 212# Process ASM_ASSERTION flag 213$(eval $(call assert_boolean,ASM_ASSERTION)) 214$(eval $(call add_define,ASM_ASSERTION)) 215 216ASFLAGS += -nostdinc -ffreestanding -Wa,--fatal-warnings \ 217 -Werror -Wmissing-include-dirs \ 218 -mgeneral-regs-only -D__ASSEMBLY__ \ 219 ${DEFINES} ${INCLUDES} 220CFLAGS += -nostdinc -pedantic -ffreestanding -Wall \ 221 -Werror -Wmissing-include-dirs \ 222 -mgeneral-regs-only -std=c99 -c -Os \ 223 ${DEFINES} ${INCLUDES} 224CFLAGS += -ffunction-sections -fdata-sections 225 226LDFLAGS += --fatal-warnings -O1 227LDFLAGS += --gc-sections 228 229 230CC := ${CROSS_COMPILE}gcc 231CPP := ${CROSS_COMPILE}cpp 232AS := ${CROSS_COMPILE}gcc 233AR := ${CROSS_COMPILE}ar 234LD := ${CROSS_COMPILE}ld 235OC := ${CROSS_COMPILE}objcopy 236OD := ${CROSS_COMPILE}objdump 237NM := ${CROSS_COMPILE}nm 238PP := ${CROSS_COMPILE}gcc -E ${CFLAGS} 239 240# Variables for use with Firmware Image Package 241FIPTOOLPATH ?= tools/fip_create 242FIPTOOL ?= ${FIPTOOLPATH}/fip_create 243fiptool: ${FIPTOOL} 244fip: ${BUILD_PLAT}/fip.bin 245 246locate-checkpatch: 247ifndef CHECKPATCH 248 $(error "Please set CHECKPATCH to point to the Linux checkpatch.pl file, eg: CHECKPATCH=../linux/script/checkpatch.pl") 249else 250ifeq (,$(wildcard ${CHECKPATCH})) 251 $(error "The file CHECKPATCH points to cannot be found, use eg: CHECKPATCH=../linux/script/checkpatch.pl") 252endif 253endif 254 255clean: 256 @echo " CLEAN" 257 ${Q}rm -rf ${BUILD_PLAT} 258 ${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH} clean 259 260realclean distclean: 261 @echo " REALCLEAN" 262 ${Q}rm -rf ${BUILD_BASE} 263 ${Q}rm -f ${CURDIR}/cscope.* 264 ${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH} clean 265 266checkcodebase: locate-checkpatch 267 @echo " CHECKING STYLE" 268 @if test -d .git ; then \ 269 git ls-files | grep -v stdlib | while read GIT_FILE ; do ${CHECKPATCH} ${CHECKCODE_ARGS} -f $$GIT_FILE ; done ; \ 270 else \ 271 find . -type f -not -iwholename "*.git*" -not -iwholename "*build*" -not -iwholename "*stdlib*" -exec ${CHECKPATCH} ${CHECKCODE_ARGS} -f {} \; ; \ 272 fi 273 274checkpatch: locate-checkpatch 275 @echo " CHECKING STYLE" 276 @git format-patch --stdout ${BASE_COMMIT} | ${CHECKPATCH} ${CHECKPATCH_ARGS} - || true 277 278${FIPTOOL}: 279 ${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH} 280 @echo 281 @echo "Built $@ successfully" 282 @echo 283 284define match_goals 285$(strip $(foreach goal,$(1),$(filter $(goal),$(MAKECMDGOALS)))) 286endef 287 288# List of rules that involve building things 289BUILD_TARGETS := all bl1 bl2 bl31 bl32 fip 290 291# Does the list of goals specified on the command line include a build target? 292ifneq ($(call match_goals,${BUILD_TARGETS}),) 293IS_ANYTHING_TO_BUILD := 1 294endif 295 296define MAKE_C 297 298$(eval OBJ := $(1)/$(patsubst %.c,%.o,$(notdir $(2)))) 299$(eval PREREQUISITES := $(patsubst %.o,%.d,$(OBJ))) 300 301$(OBJ) : $(2) 302 @echo " CC $$<" 303 $$(Q)$$(CC) $$(CFLAGS) -DIMAGE_BL$(3) -c $$< -o $$@ 304 305 306$(PREREQUISITES) : $(2) 307 @echo " DEPS $$@" 308 @mkdir -p $(1) 309 $$(Q)$$(CC) $$(CFLAGS) -M -MT $(OBJ) -MF $$@ $$< 310 311ifdef IS_ANYTHING_TO_BUILD 312-include $(PREREQUISITES) 313endif 314 315endef 316 317 318define MAKE_S 319 320$(eval OBJ := $(1)/$(patsubst %.S,%.o,$(notdir $(2)))) 321$(eval PREREQUISITES := $(patsubst %.o,%.d,$(OBJ))) 322 323$(OBJ) : $(2) 324 @echo " AS $$<" 325 $$(Q)$$(AS) $$(ASFLAGS) -DIMAGE_BL$(3) -c $$< -o $$@ 326 327$(PREREQUISITES) : $(2) 328 @echo " DEPS $$@" 329 @mkdir -p $(1) 330 $$(Q)$$(AS) $$(ASFLAGS) -M -MT $(OBJ) -MF $$@ $$< 331 332ifdef IS_ANYTHING_TO_BUILD 333-include $(PREREQUISITES) 334endif 335 336endef 337 338 339define MAKE_LD 340 341$(eval PREREQUISITES := $(1).d) 342 343$(1) : $(2) 344 @echo " PP $$<" 345 $$(Q)$$(AS) $$(ASFLAGS) -P -E -o $$@ $$< 346 347$(PREREQUISITES) : $(2) 348 @echo " DEPS $$@" 349 @mkdir -p $$(dir $$@) 350 $$(Q)$$(AS) $$(ASFLAGS) -M -MT $(1) -MF $$@ $$< 351 352ifdef IS_ANYTHING_TO_BUILD 353-include $(PREREQUISITES) 354endif 355 356endef 357 358 359define MAKE_OBJS 360 $(eval C_OBJS := $(filter %.c,$(2))) 361 $(eval REMAIN := $(filter-out %.c,$(2))) 362 $(eval $(foreach obj,$(C_OBJS),$(call MAKE_C,$(1),$(obj),$(3)))) 363 364 $(eval S_OBJS := $(filter %.S,$(REMAIN))) 365 $(eval REMAIN := $(filter-out %.S,$(REMAIN))) 366 $(eval $(foreach obj,$(S_OBJS),$(call MAKE_S,$(1),$(obj),$(3)))) 367 368 $(and $(REMAIN),$(error Unexpected source files present: $(REMAIN))) 369endef 370 371 372# NOTE: The line continuation '\' is required in the next define otherwise we 373# end up with a line-feed characer at the end of the last c filename. 374# Also bare this issue in mind if extending the list of supported filetypes. 375define SOURCES_TO_OBJS 376 $(notdir $(patsubst %.c,%.o,$(filter %.c,$(1)))) \ 377 $(notdir $(patsubst %.S,%.o,$(filter %.S,$(1)))) 378endef 379 380define MAKE_BL 381 $(eval BUILD_DIR := ${BUILD_PLAT}/bl$(1)) 382 $(eval SOURCES := $(BL$(1)_SOURCES) $(BL_COMMON_SOURCES) $(PLAT_BL_COMMON_SOURCES)) 383 $(eval OBJS := $(addprefix $(BUILD_DIR)/,$(call SOURCES_TO_OBJS,$(SOURCES)))) 384 $(eval LINKERFILE := $(BUILD_DIR)/bl$(1).ld) 385 $(eval MAPFILE := $(BUILD_DIR)/bl$(1).map) 386 $(eval ELF := $(BUILD_DIR)/bl$(1).elf) 387 $(eval DUMP := $(BUILD_DIR)/bl$(1).dump) 388 $(eval BIN := $(BUILD_PLAT)/bl$(1).bin) 389 390 $(eval $(call MAKE_OBJS,$(BUILD_DIR),$(SOURCES),$(1))) 391 $(eval $(call MAKE_LD,$(LINKERFILE),$(BL$(1)_LINKERFILE))) 392 393$(BUILD_DIR) : 394 $$(Q)mkdir -p "$$@" 395 396$(ELF) : $(OBJS) $(LINKERFILE) 397 @echo " LD $$@" 398 @echo 'const char build_message[] = "Built : "__TIME__", "__DATE__; \ 399 const char version_string[] = "${VERSION_STRING}";' | \ 400 $$(CC) $$(CFLAGS) -xc - -o $(BUILD_DIR)/build_message.o 401 $$(Q)$$(LD) -o $$@ $$(LDFLAGS) -Map=$(MAPFILE) --script $(LINKERFILE) \ 402 $(BUILD_DIR)/build_message.o $(OBJS) 403 404$(DUMP) : $(ELF) 405 @echo " OD $$@" 406 $${Q}$${OD} -dx $$< > $$@ 407 408$(BIN) : $(ELF) 409 @echo " BIN $$@" 410 $$(Q)$$(OC) -O binary $$< $$@ 411 @echo 412 @echo "Built $$@ successfully" 413 @echo 414 415.PHONY : bl$(1) 416bl$(1) : $(BUILD_DIR) $(BIN) $(DUMP) 417 418all : bl$(1) 419 420$(eval FIP_DEPS += $(if $2,$(BIN),)) 421$(eval FIP_ARGS += $(if $2,--bl$(1) $(BIN),)) 422 423endef 424 425 426ifeq (${NEED_BL1},yes) 427$(eval $(call MAKE_BL,1)) 428endif 429 430ifeq (${NEED_BL2},yes) 431$(eval $(call MAKE_BL,2,in_fip)) 432endif 433 434ifeq (${NEED_BL31},yes) 435BL31_SOURCES += ${SPD_SOURCES} 436$(eval $(call MAKE_BL,31,in_fip)) 437endif 438 439ifeq (${NEED_BL32},yes) 440$(eval $(call MAKE_BL,32,in_fip)) 441endif 442 443ifeq (${NEED_BL30},yes) 444FIP_DEPS += ${BL30} 445FIP_ARGS += --bl30 ${BL30} 446endif 447 448ifeq (${NEED_BL30},yes) 449# If BL3-0 is needed by the platform then 'BL30' variable must be defined. 450check_bl30: 451 $(if ${BL30},,$(error "To build a FIP for platform ${PLAT}, please set BL30 to point to the SCP firmware")) 452else 453# If BL3-0 is not needed by the platform but the user still specified the path 454# to a BL3-0 image then warn him that it will be ignored. 455check_bl30: 456 $(if ${BL30},$(warning "BL3-0 is not supported on platform ${PLAT}, it will just be ignored"),) 457endif 458 459${BUILD_PLAT}/fip.bin: ${FIP_DEPS} ${BL33} ${FIPTOOL} check_bl30 460 $(if ${BL33},,$(error "To build a FIP, please set BL33 to point to the Normal World binary, eg: BL33=../uefi/FVP_AARCH64_EFI.fd")) 461 ${Q}${FIPTOOL} --dump \ 462 ${FIP_ARGS} \ 463 --bl33 ${BL33} \ 464 $@ 465 @echo 466 @echo "Built $@ successfully" 467 @echo 468 469 470cscope: 471 @echo " CSCOPE" 472 ${Q}find ${CURDIR} -name "*.[chsS]" > cscope.files 473 ${Q}cscope -b -q -k 474 475help: 476 @echo "usage: ${MAKE} PLAT=<${HELP_PLATFORMS}> <all|bl1|bl2|bl31|distclean|clean|checkcodebase|checkpatch>" 477 @echo "" 478 @echo "PLAT is used to specify which platform you wish to build." 479 @echo "If no platform is specified, PLAT defaults to: ${DEFAULT_PLAT}" 480 @echo "" 481 @echo "Supported Targets:" 482 @echo " all Build the BL1, BL2 and BL31 binaries" 483 @echo " bl1 Build the BL1 binary" 484 @echo " bl2 Build the BL2 binary" 485 @echo " bl31 Build the BL31 binary" 486 @echo " checkcodebase Check the coding style of the entire source tree" 487 @echo " checkpatch Check the coding style on changes in the current" 488 @echo " branch against BASE_COMMIT (default origin/master)" 489 @echo " clean Clean the build for the selected platform" 490 @echo " cscope Generate cscope index" 491 @echo " distclean Remove all build artifacts for all platforms" 492 @echo " fiptool Build the Firmware Image Package(FIP) creation tool" 493 @echo "" 494 @echo "note: most build targets require PLAT to be set to a specific platform." 495 @echo "" 496 @echo "example: build all targets for the FVP platform:" 497 @echo " CROSS_COMPILE=aarch64-none-elf- make PLAT=fvp all" 498