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