1# 2# Copyright (c) 2013-2015, 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 := 1 36 37# Default goal is build all images 38.DEFAULT_GOAL := all 39 40include make_helpers/build_macros.mk 41 42################################################################################ 43# Default values for build configurations 44################################################################################ 45 46# Build verbosity 47V := 0 48# Debug build 49DEBUG := 0 50# Build platform 51DEFAULT_PLAT := fvp 52PLAT := ${DEFAULT_PLAT} 53# SPD choice 54SPD := none 55# Base commit to perform code check on 56BASE_COMMIT := origin/master 57# NS timer register save and restore 58NS_TIMER_SWITCH := 0 59# By default, Bl1 acts as the reset handler, not BL31 60RESET_TO_BL31 := 0 61# Include FP registers in cpu context 62CTX_INCLUDE_FPREGS := 0 63# Determine the version of ARM GIC architecture to use for interrupt management 64# in EL3. The platform port can change this value if needed. 65ARM_GIC_ARCH := 2 66# Determine the version of ARM CCI product used in the platform. The platform 67# port can change this value if needed. 68ARM_CCI_PRODUCT_ID := 400 69# Flag used to indicate if ASM_ASSERTION should be enabled for the build. 70# This defaults to being present in DEBUG builds only. 71ASM_ASSERTION := ${DEBUG} 72# Build option to choose whether Trusted firmware uses Coherent memory or not. 73USE_COHERENT_MEM := 1 74# Flag used to choose the power state format viz Extended State-ID or the Original 75# format. 76PSCI_EXTENDED_STATE_ID := 0 77# Default FIP file name 78FIP_NAME := fip.bin 79# By default, use the -pedantic option in the gcc command line 80DISABLE_PEDANTIC := 0 81# Flags to generate the Chain of Trust 82GENERATE_COT := 0 83CREATE_KEYS := 1 84SAVE_KEYS := 0 85# Flags to build TF with Trusted Boot support 86TRUSTED_BOARD_BOOT := 0 87# By default, consider that the platform's reset address is not programmable. 88# The platform Makefile is free to override this value. 89PROGRAMMABLE_RESET_ADDRESS := 0 90# Build flag to warn about usage of deprecated platform and framework APIs 91WARN_DEPRECATED := 0 92 93 94################################################################################ 95# Checkpatch script options 96################################################################################ 97 98CHECK_IGNORE := --ignore COMPLEX_MACRO \ 99 --ignore GERRIT_CHANGE_ID \ 100 --ignore GIT_COMMIT_ID 101CHECKPATCH_ARGS := --no-tree --no-signoff ${CHECK_IGNORE} 102CHECKCODE_ARGS := --no-patch --no-tree --no-signoff ${CHECK_IGNORE} 103# Do not check the coding style on C library files 104CHECK_PATHS := $(shell ls -I include -I lib) \ 105 $(addprefix include/,$(shell ls -I stdlib include)) \ 106 $(addprefix lib/,$(shell ls -I stdlib lib)) 107 108 109################################################################################ 110# Process build options 111################################################################################ 112 113# Verbose flag 114ifeq (${V},0) 115 Q=@ 116 CHECKCODE_ARGS += --no-summary --terse 117else 118 Q= 119endif 120export Q 121 122# Process Debug flag 123$(eval $(call add_define,DEBUG)) 124ifneq (${DEBUG}, 0) 125 BUILD_TYPE := debug 126 CFLAGS += -g 127 ASFLAGS += -g -Wa,--gdwarf-2 128 # Use LOG_LEVEL_INFO by default for debug builds 129 LOG_LEVEL := 40 130else 131 BUILD_TYPE := release 132 $(eval $(call add_define,NDEBUG)) 133 # Use LOG_LEVEL_NOTICE by default for release builds 134 LOG_LEVEL := 20 135endif 136 137# Default build string (git branch and commit) 138ifeq (${BUILD_STRING},) 139 BUILD_STRING := $(shell git log -n 1 --pretty=format:"%h") 140endif 141VERSION_STRING := v${VERSION_MAJOR}.${VERSION_MINOR}(${BUILD_TYPE}):${BUILD_STRING} 142 143# The cert_create tool cannot generate certificates individually, so we use the 144# target 'certificates' to create them all 145ifneq (${GENERATE_COT},0) 146 FIP_DEPS += certificates 147endif 148 149 150################################################################################ 151# Toolchain 152################################################################################ 153 154CC := ${CROSS_COMPILE}gcc 155CPP := ${CROSS_COMPILE}cpp 156AS := ${CROSS_COMPILE}gcc 157AR := ${CROSS_COMPILE}ar 158LD := ${CROSS_COMPILE}ld 159OC := ${CROSS_COMPILE}objcopy 160OD := ${CROSS_COMPILE}objdump 161NM := ${CROSS_COMPILE}nm 162PP := ${CROSS_COMPILE}gcc -E 163 164ASFLAGS += -nostdinc -ffreestanding -Wa,--fatal-warnings \ 165 -Werror -Wmissing-include-dirs \ 166 -mgeneral-regs-only -D__ASSEMBLY__ \ 167 ${DEFINES} ${INCLUDES} 168CFLAGS += -nostdinc -ffreestanding -Wall \ 169 -Werror -Wmissing-include-dirs \ 170 -mgeneral-regs-only -mstrict-align \ 171 -std=c99 -c -Os \ 172 ${DEFINES} ${INCLUDES} 173CFLAGS += -ffunction-sections -fdata-sections 174 175LDFLAGS += --fatal-warnings -O1 176LDFLAGS += --gc-sections 177 178 179################################################################################ 180# Common sources and include directories 181################################################################################ 182 183BL_COMMON_SOURCES += common/bl_common.c \ 184 common/tf_printf.c \ 185 common/aarch64/debug.S \ 186 lib/aarch64/cache_helpers.S \ 187 lib/aarch64/misc_helpers.S \ 188 lib/aarch64/xlat_helpers.c \ 189 lib/stdlib/std.c \ 190 plat/common/aarch64/platform_helpers.S 191 192INCLUDES += -Iinclude/bl31 \ 193 -Iinclude/bl31/services \ 194 -Iinclude/common \ 195 -Iinclude/drivers \ 196 -Iinclude/drivers/arm \ 197 -Iinclude/drivers/auth \ 198 -Iinclude/drivers/io \ 199 -Iinclude/drivers/ti/uart \ 200 -Iinclude/lib \ 201 -Iinclude/lib/aarch64 \ 202 -Iinclude/lib/cpus/aarch64 \ 203 -Iinclude/plat/common \ 204 -Iinclude/stdlib \ 205 -Iinclude/stdlib/sys \ 206 ${PLAT_INCLUDES} \ 207 ${SPD_INCLUDES} 208 209 210################################################################################ 211# Generic definitions 212################################################################################ 213 214BUILD_BASE := ./build 215BUILD_PLAT := ${BUILD_BASE}/${PLAT}/${BUILD_TYPE} 216 217PLAT_MAKEFILE := platform.mk 218# Generate the platforms list by recursively searching for all directories 219# under /plat containing a PLAT_MAKEFILE. Append each platform with a `|` 220# char and strip out the final '|'. 221PLATFORMS := $(shell find plat/ -name '${PLAT_MAKEFILE}' -print0 | \ 222 sed -r 's%[^\x00]*\/([^/]*)\/${PLAT_MAKEFILE}\x00%\1|%g' | \ 223 sed -r 's/\|$$//') 224SPDS := $(shell ls -I none services/spd) 225 226# Platforms providing their own TBB makefile may override this value 227INCLUDE_TBBR_MK := 1 228 229 230################################################################################ 231# Include SPD Makefile if one has been specified 232################################################################################ 233 234ifneq (${SPD},none) 235 # We expect to locate an spd.mk under the specified SPD directory 236 SPD_MAKE := $(shell m="services/spd/${SPD}/${SPD}.mk"; [ -f "$$m" ] && echo "$$m") 237 238 ifeq (${SPD_MAKE},) 239 $(error Error: No services/spd/${SPD}/${SPD}.mk located) 240 endif 241 $(info Including ${SPD_MAKE}) 242 include ${SPD_MAKE} 243 244 # If there's BL3-2 companion for the chosen SPD, and the SPD wants to build the 245 # BL3-2 from source, we expect that the SPD's Makefile would set NEED_BL32 246 # variable to "yes". In case the BL3-2 is a binary which needs to be included in 247 # fip, then the NEED_BL32 needs to be set and BL3-2 would need to point to the bin. 248endif 249 250 251################################################################################ 252# Include the platform specific Makefile after the SPD Makefile (the platform 253# makefile may use all previous definitions in this file) 254################################################################################ 255 256ifeq (${PLAT},) 257 $(error "Error: Unknown platform. Please use PLAT=<platform name> to specify the platform") 258endif 259PLAT_MAKEFILE_FULL := $(shell find plat/ -wholename '*/${PLAT}/${PLAT_MAKEFILE}') 260ifeq ($(PLAT_MAKEFILE_FULL),) 261 $(error "Error: Invalid platform. The following platforms are available: ${PLATFORMS}") 262endif 263 264include ${PLAT_MAKEFILE_FULL} 265 266# If the platform has not defined ENABLE_PLAT_COMPAT, then enable it by default 267ifndef ENABLE_PLAT_COMPAT 268ENABLE_PLAT_COMPAT := 1 269endif 270 271# Include the platform compatibility helpers for PSCI 272ifneq (${ENABLE_PLAT_COMPAT}, 0) 273include plat/compat/plat_compat.mk 274endif 275 276# Include the CPU specific operations makefile. By default all CPU errata 277# workarounds and CPU specifc optimisations are disabled. This can be 278# overridden by the platform. 279include lib/cpus/cpu-ops.mk 280 281 282################################################################################ 283# Process platform overrideable behaviour 284################################################################################ 285 286# Check if -pedantic option should be used 287ifeq (${DISABLE_PEDANTIC},0) 288 CFLAGS += -pedantic 289endif 290 291# Using the ARM Trusted Firmware BL2 implies that a BL3-3 image also need to be 292# supplied for the FIP and Certificate generation tools. This flag can be 293# overridden by the platform. 294ifdef BL2_SOURCES 295NEED_BL33 ?= yes 296endif 297 298# Process TBB related flags 299ifneq (${GENERATE_COT},0) 300 # Common cert_create options 301 ifneq (${CREATE_KEYS},0) 302 $(eval CRT_ARGS += -n) 303 ifneq (${SAVE_KEYS},0) 304 $(eval CRT_ARGS += -k) 305 endif 306 endif 307 # Include TBBR makefile (unless the platform indicates otherwise) 308 ifeq (${INCLUDE_TBBR_MK},1) 309 include make_helpers/tbbr/tbbr_tools.mk 310 endif 311endif 312 313 314################################################################################ 315# Auxiliary tools (fip_create, cert_create, etc) 316################################################################################ 317 318# Variables for use with Certificate Generation Tool 319CRTTOOLPATH ?= tools/cert_create 320CRTTOOL ?= ${CRTTOOLPATH}/cert_create 321 322# Variables for use with Firmware Image Package 323FIPTOOLPATH ?= tools/fip_create 324FIPTOOL ?= ${FIPTOOLPATH}/fip_create 325 326 327################################################################################ 328# Build options checks 329################################################################################ 330 331$(eval $(call assert_boolean,DEBUG)) 332$(eval $(call assert_boolean,NS_TIMER_SWITCH)) 333$(eval $(call assert_boolean,RESET_TO_BL31)) 334$(eval $(call assert_boolean,CTX_INCLUDE_FPREGS)) 335$(eval $(call assert_boolean,ASM_ASSERTION)) 336$(eval $(call assert_boolean,USE_COHERENT_MEM)) 337$(eval $(call assert_boolean,DISABLE_PEDANTIC)) 338$(eval $(call assert_boolean,GENERATE_COT)) 339$(eval $(call assert_boolean,CREATE_KEYS)) 340$(eval $(call assert_boolean,SAVE_KEYS)) 341$(eval $(call assert_boolean,TRUSTED_BOARD_BOOT)) 342$(eval $(call assert_boolean,PROGRAMMABLE_RESET_ADDRESS)) 343$(eval $(call assert_boolean,PSCI_EXTENDED_STATE_ID)) 344$(eval $(call assert_boolean,WARN_DEPRECATED)) 345$(eval $(call assert_boolean,ENABLE_PLAT_COMPAT)) 346 347 348################################################################################ 349# Add definitions to the cpp preprocessor based on the current build options. 350# This is done after including the platform specific makefile to allow the 351# platform to overwrite the default options 352################################################################################ 353 354$(eval $(call add_define,PLAT_${PLAT})) 355$(eval $(call add_define,NS_TIMER_SWITCH)) 356$(eval $(call add_define,RESET_TO_BL31)) 357$(eval $(call add_define,CTX_INCLUDE_FPREGS)) 358$(eval $(call add_define,ARM_GIC_ARCH)) 359$(eval $(call add_define,ARM_CCI_PRODUCT_ID)) 360$(eval $(call add_define,ASM_ASSERTION)) 361$(eval $(call add_define,LOG_LEVEL)) 362$(eval $(call add_define,USE_COHERENT_MEM)) 363$(eval $(call add_define,TRUSTED_BOARD_BOOT)) 364$(eval $(call add_define,PROGRAMMABLE_RESET_ADDRESS)) 365$(eval $(call add_define,PSCI_EXTENDED_STATE_ID)) 366$(eval $(call add_define,WARN_DEPRECATED)) 367$(eval $(call add_define,ENABLE_PLAT_COMPAT)) 368 369 370################################################################################ 371# Include BL specific makefiles 372################################################################################ 373 374ifdef BL1_SOURCES 375NEED_BL1 := yes 376include bl1/bl1.mk 377endif 378 379ifdef BL2_SOURCES 380NEED_BL2 := yes 381include bl2/bl2.mk 382endif 383 384ifdef BL31_SOURCES 385NEED_BL31 := yes 386include bl31/bl31.mk 387endif 388 389 390################################################################################ 391# Build targets 392################################################################################ 393 394.PHONY: all msg_start clean realclean distclean cscope locate-checkpatch checkcodebase checkpatch fiptool fip certtool 395.SUFFIXES: 396 397all: msg_start 398 399msg_start: 400 @echo "Building ${PLAT}" 401 402# Expand build macros for the different images 403ifeq (${NEED_BL1},yes) 404$(eval $(call MAKE_BL,1)) 405endif 406 407ifeq (${NEED_BL2},yes) 408$(if ${BL2}, $(eval $(call MAKE_TOOL_ARGS,2,${BL2},in_fip)),\ 409 $(eval $(call MAKE_BL,2,in_fip))) 410endif 411 412ifeq (${NEED_BL31},yes) 413BL31_SOURCES += ${SPD_SOURCES} 414$(if ${BL31}, $(eval $(call MAKE_TOOL_ARGS,31,${BL31},in_fip)),\ 415 $(eval $(call MAKE_BL,31,in_fip))) 416endif 417 418ifeq (${NEED_BL32},yes) 419$(if ${BL32}, $(eval $(call MAKE_TOOL_ARGS,32,${BL32},in_fip)),\ 420 $(eval $(call MAKE_BL,32,in_fip))) 421endif 422 423# Add the BL33 image if required by the platform 424ifeq (${NEED_BL33},yes) 425$(eval $(call FIP_ADD_IMG,BL33,--bl33)) 426endif 427 428locate-checkpatch: 429ifndef CHECKPATCH 430 $(error "Please set CHECKPATCH to point to the Linux checkpatch.pl file, eg: CHECKPATCH=../linux/script/checkpatch.pl") 431else 432ifeq (,$(wildcard ${CHECKPATCH})) 433 $(error "The file CHECKPATCH points to cannot be found, use eg: CHECKPATCH=../linux/script/checkpatch.pl") 434endif 435endif 436 437clean: 438 @echo " CLEAN" 439 ${Q}rm -rf ${BUILD_PLAT} 440 ${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH} clean 441 ${Q}${MAKE} PLAT=${PLAT} --no-print-directory -C ${CRTTOOLPATH} clean 442 443realclean distclean: 444 @echo " REALCLEAN" 445 ${Q}rm -rf ${BUILD_BASE} 446 ${Q}rm -f ${CURDIR}/cscope.* 447 ${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH} clean 448 ${Q}${MAKE} PLAT=${PLAT} --no-print-directory -C ${CRTTOOLPATH} clean 449 450checkcodebase: locate-checkpatch 451 @echo " CHECKING STYLE" 452 @if test -d .git ; then \ 453 git ls-files | grep -v stdlib | while read GIT_FILE ; do ${CHECKPATCH} ${CHECKCODE_ARGS} -f $$GIT_FILE ; done ; \ 454 else \ 455 find . -type f -not -iwholename "*.git*" -not -iwholename "*build*" -not -iwholename "*stdlib*" -exec ${CHECKPATCH} ${CHECKCODE_ARGS} -f {} \; ; \ 456 fi 457 458checkpatch: locate-checkpatch 459 @echo " CHECKING STYLE" 460 ${Q}git log -p ${BASE_COMMIT}..HEAD -- ${CHECK_PATHS} | ${CHECKPATCH} ${CHECKPATCH_ARGS} - || true 461 462certtool: ${CRTTOOL} 463 464.PHONY: ${CRTTOOL} 465${CRTTOOL}: 466 ${Q}${MAKE} PLAT=${PLAT} --no-print-directory -C ${CRTTOOLPATH} 467 @echo 468 @echo "Built $@ successfully" 469 @echo 470 471ifneq (${GENERATE_COT},0) 472certificates: ${CRT_DEPS} ${CRTTOOL} 473 ${Q}${CRTTOOL} ${CRT_ARGS} 474 @echo 475 @echo "Built $@ successfully" 476 @echo "Certificates can be found in ${BUILD_PLAT}" 477 @echo 478endif 479 480${BUILD_PLAT}/${FIP_NAME}: ${FIP_DEPS} ${FIPTOOL} 481 ${Q}${FIPTOOL} --dump ${FIP_ARGS} $@ 482 @echo 483 @echo "Built $@ successfully" 484 @echo 485 486fiptool: ${FIPTOOL} 487fip: ${BUILD_PLAT}/${FIP_NAME} 488 489.PHONY: ${FIPTOOL} 490${FIPTOOL}: 491 ${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH} 492 493cscope: 494 @echo " CSCOPE" 495 ${Q}find ${CURDIR} -name "*.[chsS]" > cscope.files 496 ${Q}cscope -b -q -k 497 498help: 499 @echo "usage: ${MAKE} PLAT=<${PLATFORMS}> [OPTIONS] [TARGET]" 500 @echo "" 501 @echo "PLAT is used to specify which platform you wish to build." 502 @echo "If no platform is specified, PLAT defaults to: ${DEFAULT_PLAT}" 503 @echo "" 504 @echo "Please refer to the User Guide for a list of all supported options." 505 @echo "Note that the build system doesn't track dependencies for build " 506 @echo "options. Therefore, if any of the build options are changed " 507 @echo "from a previous build, a clean build must be performed." 508 @echo "" 509 @echo "Supported Targets:" 510 @echo " all Build all individual bootloader binaries" 511 @echo " bl1 Build the BL1 binary" 512 @echo " bl2 Build the BL2 binary" 513 @echo " bl31 Build the BL3-1 binary" 514 @echo " bl32 Build the BL3-2 binary" 515 @echo " certificates Build the certificates (requires 'GENERATE_COT=1')" 516 @echo " fip Build the Firmware Image Package (FIP)" 517 @echo " checkcodebase Check the coding style of the entire source tree" 518 @echo " checkpatch Check the coding style on changes in the current" 519 @echo " branch against BASE_COMMIT (default origin/master)" 520 @echo " clean Clean the build for the selected platform" 521 @echo " cscope Generate cscope index" 522 @echo " distclean Remove all build artifacts for all platforms" 523 @echo " certtool Build the Certificate generation tool" 524 @echo " fiptool Build the Firmware Image Package(FIP) creation tool" 525 @echo "" 526 @echo "Note: most build targets require PLAT to be set to a specific platform." 527 @echo "" 528 @echo "example: build all targets for the FVP platform:" 529 @echo " CROSS_COMPILE=aarch64-none-elf- make PLAT=fvp all" 530