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