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 -std=c99 -c -Os \ 171 ${DEFINES} ${INCLUDES} 172CFLAGS += -ffunction-sections -fdata-sections 173 174LDFLAGS += --fatal-warnings -O1 175LDFLAGS += --gc-sections 176 177 178################################################################################ 179# Common sources and include directories 180################################################################################ 181 182BL_COMMON_SOURCES += common/bl_common.c \ 183 common/tf_printf.c \ 184 common/aarch64/debug.S \ 185 lib/aarch64/cache_helpers.S \ 186 lib/aarch64/misc_helpers.S \ 187 lib/aarch64/xlat_helpers.c \ 188 lib/stdlib/std.c \ 189 plat/common/aarch64/platform_helpers.S 190 191INCLUDES += -Iinclude/bl31 \ 192 -Iinclude/bl31/services \ 193 -Iinclude/common \ 194 -Iinclude/drivers \ 195 -Iinclude/drivers/arm \ 196 -Iinclude/drivers/auth \ 197 -Iinclude/drivers/io \ 198 -Iinclude/drivers/ti/uart \ 199 -Iinclude/lib \ 200 -Iinclude/lib/aarch64 \ 201 -Iinclude/lib/cpus/aarch64 \ 202 -Iinclude/plat/common \ 203 -Iinclude/stdlib \ 204 -Iinclude/stdlib/sys \ 205 ${PLAT_INCLUDES} \ 206 ${SPD_INCLUDES} 207 208 209################################################################################ 210# Generic definitions 211################################################################################ 212 213BUILD_BASE := ./build 214BUILD_PLAT := ${BUILD_BASE}/${PLAT}/${BUILD_TYPE} 215 216PLAT_MAKEFILE := platform.mk 217# Generate the platforms list by recursively searching for all directories 218# under /plat containing a PLAT_MAKEFILE. Append each platform with a `|` 219# char and strip out the final '|'. 220PLATFORMS := $(shell find plat/ -name '${PLAT_MAKEFILE}' -print0 | \ 221 sed -r 's%[^\x00]*\/([^/]*)\/${PLAT_MAKEFILE}\x00%\1|%g' | \ 222 sed -r 's/\|$$//') 223SPDS := $(shell ls -I none services/spd) 224 225# Platforms providing their own TBB makefile may override this value 226INCLUDE_TBBR_MK := 1 227 228 229################################################################################ 230# Include SPD Makefile if one has been specified 231################################################################################ 232 233ifneq (${SPD},none) 234 # We expect to locate an spd.mk under the specified SPD directory 235 SPD_MAKE := $(shell m="services/spd/${SPD}/${SPD}.mk"; [ -f "$$m" ] && echo "$$m") 236 237 ifeq (${SPD_MAKE},) 238 $(error Error: No services/spd/${SPD}/${SPD}.mk located) 239 endif 240 $(info Including ${SPD_MAKE}) 241 include ${SPD_MAKE} 242 243 # If there's BL3-2 companion for the chosen SPD, and the SPD wants to build the 244 # BL3-2 from source, we expect that the SPD's Makefile would set NEED_BL32 245 # variable to "yes". In case the BL3-2 is a binary which needs to be included in 246 # fip, then the NEED_BL32 needs to be set and BL3-2 would need to point to the bin. 247endif 248 249 250################################################################################ 251# Include the platform specific Makefile after the SPD Makefile (the platform 252# makefile may use all previous definitions in this file) 253################################################################################ 254 255ifeq (${PLAT},) 256 $(error "Error: Unknown platform. Please use PLAT=<platform name> to specify the platform") 257endif 258PLAT_MAKEFILE_FULL := $(shell find plat/ -wholename '*/${PLAT}/${PLAT_MAKEFILE}') 259ifeq ($(PLAT_MAKEFILE_FULL),) 260 $(error "Error: Invalid platform. The following platforms are available: ${PLATFORMS}") 261endif 262 263include ${PLAT_MAKEFILE_FULL} 264 265# If the platform has not defined ENABLE_PLAT_COMPAT, then enable it by default 266ifndef ENABLE_PLAT_COMPAT 267ENABLE_PLAT_COMPAT := 1 268endif 269 270# Include the platform compatibility helpers for PSCI 271ifneq (${ENABLE_PLAT_COMPAT}, 0) 272include plat/compat/plat_compat.mk 273endif 274 275# Include the CPU specific operations makefile. By default all CPU errata 276# workarounds and CPU specifc optimisations are disabled. This can be 277# overridden by the platform. 278include lib/cpus/cpu-ops.mk 279 280 281################################################################################ 282# Process platform overrideable behaviour 283################################################################################ 284 285# Check if -pedantic option should be used 286ifeq (${DISABLE_PEDANTIC},0) 287 CFLAGS += -pedantic 288endif 289 290# Using the ARM Trusted Firmware BL2 implies that a BL3-3 image also need to be 291# supplied for the FIP and Certificate generation tools. This flag can be 292# overridden by the platform. 293ifdef BL2_SOURCES 294NEED_BL33 ?= yes 295endif 296 297# Process TBB related flags 298ifneq (${GENERATE_COT},0) 299 # Common cert_create options 300 ifneq (${CREATE_KEYS},0) 301 $(eval CRT_ARGS += -n) 302 ifneq (${SAVE_KEYS},0) 303 $(eval CRT_ARGS += -k) 304 endif 305 endif 306 # Include TBBR makefile (unless the platform indicates otherwise) 307 ifeq (${INCLUDE_TBBR_MK},1) 308 include make_helpers/tbbr/tbbr_tools.mk 309 endif 310endif 311 312 313################################################################################ 314# Auxiliary tools (fip_create, cert_create, etc) 315################################################################################ 316 317# Variables for use with Certificate Generation Tool 318CRTTOOLPATH ?= tools/cert_create 319CRTTOOL ?= ${CRTTOOLPATH}/cert_create 320 321# Variables for use with Firmware Image Package 322FIPTOOLPATH ?= tools/fip_create 323FIPTOOL ?= ${FIPTOOLPATH}/fip_create 324 325 326################################################################################ 327# Build options checks 328################################################################################ 329 330$(eval $(call assert_boolean,DEBUG)) 331$(eval $(call assert_boolean,NS_TIMER_SWITCH)) 332$(eval $(call assert_boolean,RESET_TO_BL31)) 333$(eval $(call assert_boolean,CTX_INCLUDE_FPREGS)) 334$(eval $(call assert_boolean,ASM_ASSERTION)) 335$(eval $(call assert_boolean,USE_COHERENT_MEM)) 336$(eval $(call assert_boolean,DISABLE_PEDANTIC)) 337$(eval $(call assert_boolean,GENERATE_COT)) 338$(eval $(call assert_boolean,CREATE_KEYS)) 339$(eval $(call assert_boolean,SAVE_KEYS)) 340$(eval $(call assert_boolean,TRUSTED_BOARD_BOOT)) 341$(eval $(call assert_boolean,PROGRAMMABLE_RESET_ADDRESS)) 342$(eval $(call assert_boolean,PSCI_EXTENDED_STATE_ID)) 343$(eval $(call assert_boolean,WARN_DEPRECATED)) 344$(eval $(call assert_boolean,ENABLE_PLAT_COMPAT)) 345 346 347################################################################################ 348# Add definitions to the cpp preprocessor based on the current build options. 349# This is done after including the platform specific makefile to allow the 350# platform to overwrite the default options 351################################################################################ 352 353$(eval $(call add_define,PLAT_${PLAT})) 354$(eval $(call add_define,NS_TIMER_SWITCH)) 355$(eval $(call add_define,RESET_TO_BL31)) 356$(eval $(call add_define,CTX_INCLUDE_FPREGS)) 357$(eval $(call add_define,ARM_GIC_ARCH)) 358$(eval $(call add_define,ARM_CCI_PRODUCT_ID)) 359$(eval $(call add_define,ASM_ASSERTION)) 360$(eval $(call add_define,LOG_LEVEL)) 361$(eval $(call add_define,USE_COHERENT_MEM)) 362$(eval $(call add_define,TRUSTED_BOARD_BOOT)) 363$(eval $(call add_define,PROGRAMMABLE_RESET_ADDRESS)) 364$(eval $(call add_define,PSCI_EXTENDED_STATE_ID)) 365$(eval $(call add_define,WARN_DEPRECATED)) 366$(eval $(call add_define,ENABLE_PLAT_COMPAT)) 367 368 369################################################################################ 370# Include BL specific makefiles 371################################################################################ 372 373ifdef BL1_SOURCES 374NEED_BL1 := yes 375include bl1/bl1.mk 376endif 377 378ifdef BL2_SOURCES 379NEED_BL2 := yes 380include bl2/bl2.mk 381endif 382 383ifdef BL31_SOURCES 384NEED_BL31 := yes 385include bl31/bl31.mk 386endif 387 388 389################################################################################ 390# Build targets 391################################################################################ 392 393.PHONY: all msg_start clean realclean distclean cscope locate-checkpatch checkcodebase checkpatch fiptool fip certtool 394.SUFFIXES: 395 396all: msg_start 397 398msg_start: 399 @echo "Building ${PLAT}" 400 401# Expand build macros for the different images 402ifeq (${NEED_BL1},yes) 403$(eval $(call MAKE_BL,1)) 404endif 405 406ifeq (${NEED_BL2},yes) 407$(if ${BL2}, $(eval $(call MAKE_TOOL_ARGS,2,${BL2},in_fip)),\ 408 $(eval $(call MAKE_BL,2,in_fip))) 409endif 410 411ifeq (${NEED_BL31},yes) 412BL31_SOURCES += ${SPD_SOURCES} 413$(if ${BL31}, $(eval $(call MAKE_TOOL_ARGS,31,${BL31},in_fip)),\ 414 $(eval $(call MAKE_BL,31,in_fip))) 415endif 416 417ifeq (${NEED_BL32},yes) 418$(if ${BL32}, $(eval $(call MAKE_TOOL_ARGS,32,${BL32},in_fip)),\ 419 $(eval $(call MAKE_BL,32,in_fip))) 420endif 421 422# Add the BL33 image if required by the platform 423ifeq (${NEED_BL33},yes) 424$(eval $(call FIP_ADD_IMG,BL33,--bl33)) 425endif 426 427locate-checkpatch: 428ifndef CHECKPATCH 429 $(error "Please set CHECKPATCH to point to the Linux checkpatch.pl file, eg: CHECKPATCH=../linux/script/checkpatch.pl") 430else 431ifeq (,$(wildcard ${CHECKPATCH})) 432 $(error "The file CHECKPATCH points to cannot be found, use eg: CHECKPATCH=../linux/script/checkpatch.pl") 433endif 434endif 435 436clean: 437 @echo " CLEAN" 438 ${Q}rm -rf ${BUILD_PLAT} 439 ${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH} clean 440 ${Q}${MAKE} PLAT=${PLAT} --no-print-directory -C ${CRTTOOLPATH} clean 441 442realclean distclean: 443 @echo " REALCLEAN" 444 ${Q}rm -rf ${BUILD_BASE} 445 ${Q}rm -f ${CURDIR}/cscope.* 446 ${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH} clean 447 ${Q}${MAKE} PLAT=${PLAT} --no-print-directory -C ${CRTTOOLPATH} clean 448 449checkcodebase: locate-checkpatch 450 @echo " CHECKING STYLE" 451 @if test -d .git ; then \ 452 git ls-files | grep -v stdlib | while read GIT_FILE ; do ${CHECKPATCH} ${CHECKCODE_ARGS} -f $$GIT_FILE ; done ; \ 453 else \ 454 find . -type f -not -iwholename "*.git*" -not -iwholename "*build*" -not -iwholename "*stdlib*" -exec ${CHECKPATCH} ${CHECKCODE_ARGS} -f {} \; ; \ 455 fi 456 457checkpatch: locate-checkpatch 458 @echo " CHECKING STYLE" 459 ${Q}git log -p ${BASE_COMMIT}..HEAD -- ${CHECK_PATHS} | ${CHECKPATCH} ${CHECKPATCH_ARGS} - || true 460 461certtool: ${CRTTOOL} 462 463.PHONY: ${CRTTOOL} 464${CRTTOOL}: 465 ${Q}${MAKE} PLAT=${PLAT} --no-print-directory -C ${CRTTOOLPATH} 466 @echo 467 @echo "Built $@ successfully" 468 @echo 469 470ifneq (${GENERATE_COT},0) 471certificates: ${CRT_DEPS} ${CRTTOOL} 472 ${Q}${CRTTOOL} ${CRT_ARGS} 473 @echo 474 @echo "Built $@ successfully" 475 @echo "Certificates can be found in ${BUILD_PLAT}" 476 @echo 477endif 478 479${BUILD_PLAT}/${FIP_NAME}: ${FIP_DEPS} ${FIPTOOL} 480 ${Q}${FIPTOOL} --dump ${FIP_ARGS} $@ 481 @echo 482 @echo "Built $@ successfully" 483 @echo 484 485fiptool: ${FIPTOOL} 486fip: ${BUILD_PLAT}/${FIP_NAME} 487 488.PHONY: ${FIPTOOL} 489${FIPTOOL}: 490 ${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH} 491 492cscope: 493 @echo " CSCOPE" 494 ${Q}find ${CURDIR} -name "*.[chsS]" > cscope.files 495 ${Q}cscope -b -q -k 496 497help: 498 @echo "usage: ${MAKE} PLAT=<${PLATFORMS}> [OPTIONS] [TARGET]" 499 @echo "" 500 @echo "PLAT is used to specify which platform you wish to build." 501 @echo "If no platform is specified, PLAT defaults to: ${DEFAULT_PLAT}" 502 @echo "" 503 @echo "Please refer to the User Guide for a list of all supported options." 504 @echo "Note that the build system doesn't track dependencies for build " 505 @echo "options. Therefore, if any of the build options are changed " 506 @echo "from a previous build, a clean build must be performed." 507 @echo "" 508 @echo "Supported Targets:" 509 @echo " all Build all individual bootloader binaries" 510 @echo " bl1 Build the BL1 binary" 511 @echo " bl2 Build the BL2 binary" 512 @echo " bl31 Build the BL3-1 binary" 513 @echo " bl32 Build the BL3-2 binary" 514 @echo " certificates Build the certificates (requires 'GENERATE_COT=1')" 515 @echo " fip Build the Firmware Image Package (FIP)" 516 @echo " checkcodebase Check the coding style of the entire source tree" 517 @echo " checkpatch Check the coding style on changes in the current" 518 @echo " branch against BASE_COMMIT (default origin/master)" 519 @echo " clean Clean the build for the selected platform" 520 @echo " cscope Generate cscope index" 521 @echo " distclean Remove all build artifacts for all platforms" 522 @echo " certtool Build the Certificate generation tool" 523 @echo " fiptool Build the Firmware Image Package(FIP) creation tool" 524 @echo "" 525 @echo "Note: most build targets require PLAT to be set to a specific platform." 526 @echo "" 527 @echo "example: build all targets for the FVP platform:" 528 @echo " CROSS_COMPILE=aarch64-none-elf- make PLAT=fvp all" 529