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