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 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 BL32 companion for the chosen SPD, we expect that the SPD's 245 # Makefile would set NEED_BL32 to "yes". In this case, the build system 246 # supports two mutually exclusive options: 247 # * BL32 is built from source: then BL32_SOURCES must contain the list 248 # of source files to build BL32 249 # * BL32 is a prebuilt binary: then BL32 must point to the image file 250 # that will be included in the FIP 251 # If both BL32_SOURCES and BL32 are defined, the binary takes precedence 252 # over the sources. 253endif 254 255 256################################################################################ 257# Include the platform specific Makefile after the SPD Makefile (the platform 258# makefile may use all previous definitions in this file) 259################################################################################ 260 261ifeq (${PLAT},) 262 $(error "Error: Unknown platform. Please use PLAT=<platform name> to specify the platform") 263endif 264PLAT_MAKEFILE_FULL := $(shell find plat/ -wholename '*/${PLAT}/${PLAT_MAKEFILE}') 265ifeq ($(PLAT_MAKEFILE_FULL),) 266 $(error "Error: Invalid platform. The following platforms are available: ${PLATFORMS}") 267endif 268 269include ${PLAT_MAKEFILE_FULL} 270 271# If the platform has not defined ENABLE_PLAT_COMPAT, then enable it by default 272ifndef ENABLE_PLAT_COMPAT 273ENABLE_PLAT_COMPAT := 1 274endif 275 276# Include the platform compatibility helpers for PSCI 277ifneq (${ENABLE_PLAT_COMPAT}, 0) 278include plat/compat/plat_compat.mk 279endif 280 281# Include the CPU specific operations makefile. By default all CPU errata 282# workarounds and CPU specifc optimisations are disabled. This can be 283# overridden by the platform. 284include lib/cpus/cpu-ops.mk 285 286 287################################################################################ 288# Process platform overrideable behaviour 289################################################################################ 290 291# Check if -pedantic option should be used 292ifeq (${DISABLE_PEDANTIC},0) 293 CFLAGS += -pedantic 294endif 295 296# Using the ARM Trusted Firmware BL2 implies that a BL3-3 image also need to be 297# supplied for the FIP and Certificate generation tools. This flag can be 298# overridden by the platform. 299ifdef BL2_SOURCES 300NEED_BL33 ?= yes 301endif 302 303# Process TBB related flags 304ifneq (${GENERATE_COT},0) 305 # Common cert_create options 306 ifneq (${CREATE_KEYS},0) 307 $(eval CRT_ARGS += -n) 308 ifneq (${SAVE_KEYS},0) 309 $(eval CRT_ARGS += -k) 310 endif 311 endif 312 # Include TBBR makefile (unless the platform indicates otherwise) 313 ifeq (${INCLUDE_TBBR_MK},1) 314 include make_helpers/tbbr/tbbr_tools.mk 315 endif 316endif 317 318 319################################################################################ 320# Auxiliary tools (fip_create, cert_create, etc) 321################################################################################ 322 323# Variables for use with Certificate Generation Tool 324CRTTOOLPATH ?= tools/cert_create 325CRTTOOL ?= ${CRTTOOLPATH}/cert_create 326 327# Variables for use with Firmware Image Package 328FIPTOOLPATH ?= tools/fip_create 329FIPTOOL ?= ${FIPTOOLPATH}/fip_create 330 331 332################################################################################ 333# Build options checks 334################################################################################ 335 336$(eval $(call assert_boolean,DEBUG)) 337$(eval $(call assert_boolean,NS_TIMER_SWITCH)) 338$(eval $(call assert_boolean,RESET_TO_BL31)) 339$(eval $(call assert_boolean,CTX_INCLUDE_FPREGS)) 340$(eval $(call assert_boolean,ASM_ASSERTION)) 341$(eval $(call assert_boolean,USE_COHERENT_MEM)) 342$(eval $(call assert_boolean,DISABLE_PEDANTIC)) 343$(eval $(call assert_boolean,GENERATE_COT)) 344$(eval $(call assert_boolean,CREATE_KEYS)) 345$(eval $(call assert_boolean,SAVE_KEYS)) 346$(eval $(call assert_boolean,TRUSTED_BOARD_BOOT)) 347$(eval $(call assert_boolean,PROGRAMMABLE_RESET_ADDRESS)) 348$(eval $(call assert_boolean,PSCI_EXTENDED_STATE_ID)) 349$(eval $(call assert_boolean,ERROR_DEPRECATED)) 350$(eval $(call assert_boolean,ENABLE_PLAT_COMPAT)) 351 352 353################################################################################ 354# Add definitions to the cpp preprocessor based on the current build options. 355# This is done after including the platform specific makefile to allow the 356# platform to overwrite the default options 357################################################################################ 358 359$(eval $(call add_define,PLAT_${PLAT})) 360$(eval $(call add_define,NS_TIMER_SWITCH)) 361$(eval $(call add_define,RESET_TO_BL31)) 362$(eval $(call add_define,CTX_INCLUDE_FPREGS)) 363$(eval $(call add_define,ARM_GIC_ARCH)) 364$(eval $(call add_define,ARM_CCI_PRODUCT_ID)) 365$(eval $(call add_define,ASM_ASSERTION)) 366$(eval $(call add_define,LOG_LEVEL)) 367$(eval $(call add_define,USE_COHERENT_MEM)) 368$(eval $(call add_define,TRUSTED_BOARD_BOOT)) 369$(eval $(call add_define,PROGRAMMABLE_RESET_ADDRESS)) 370$(eval $(call add_define,PSCI_EXTENDED_STATE_ID)) 371$(eval $(call add_define,ERROR_DEPRECATED)) 372$(eval $(call add_define,ENABLE_PLAT_COMPAT)) 373 374 375################################################################################ 376# Include BL specific makefiles 377################################################################################ 378 379ifdef BL1_SOURCES 380NEED_BL1 := yes 381include bl1/bl1.mk 382endif 383 384ifdef BL2_SOURCES 385NEED_BL2 := yes 386include bl2/bl2.mk 387endif 388 389ifdef BL31_SOURCES 390NEED_BL31 := yes 391include bl31/bl31.mk 392endif 393 394 395################################################################################ 396# Build targets 397################################################################################ 398 399.PHONY: all msg_start clean realclean distclean cscope locate-checkpatch checkcodebase checkpatch fiptool fip certtool 400.SUFFIXES: 401 402all: msg_start 403 404msg_start: 405 @echo "Building ${PLAT}" 406 407# Check if deprecated declarations should be treated as error or not. 408ifeq (${ERROR_DEPRECATED},0) 409 CFLAGS += -Wno-error=deprecated-declarations 410endif 411 412# Expand build macros for the different images 413ifeq (${NEED_BL1},yes) 414$(eval $(call MAKE_BL,1)) 415endif 416 417ifeq (${NEED_BL2},yes) 418$(if ${BL2}, $(eval $(call MAKE_TOOL_ARGS,2,${BL2},in_fip)),\ 419 $(eval $(call MAKE_BL,2,in_fip))) 420endif 421 422ifeq (${NEED_BL31},yes) 423BL31_SOURCES += ${SPD_SOURCES} 424$(if ${BL31}, $(eval $(call MAKE_TOOL_ARGS,31,${BL31},in_fip)),\ 425 $(eval $(call MAKE_BL,31,in_fip))) 426endif 427 428# If a BL32 image is needed but neither BL32 nor BL32_SOURCES is defined, the 429# build system will call FIP_ADD_IMG to print a warning message and abort the 430# process. Note that the dependency on BL32 applies to the FIP only. 431ifeq (${NEED_BL32},yes) 432$(if ${BL32}, $(eval $(call MAKE_TOOL_ARGS,32,${BL32},in_fip)),\ 433 $(if ${BL32_SOURCES}, $(eval $(call MAKE_BL,32,in_fip)),\ 434 $(eval $(call FIP_ADD_IMG,BL32,--bl32)))) 435endif 436 437# Add the BL33 image if required by the platform 438ifeq (${NEED_BL33},yes) 439$(eval $(call FIP_ADD_IMG,BL33,--bl33)) 440endif 441 442locate-checkpatch: 443ifndef CHECKPATCH 444 $(error "Please set CHECKPATCH to point to the Linux checkpatch.pl file, eg: CHECKPATCH=../linux/script/checkpatch.pl") 445else 446ifeq (,$(wildcard ${CHECKPATCH})) 447 $(error "The file CHECKPATCH points to cannot be found, use eg: CHECKPATCH=../linux/script/checkpatch.pl") 448endif 449endif 450 451clean: 452 @echo " CLEAN" 453 ${Q}rm -rf ${BUILD_PLAT} 454 ${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH} clean 455 ${Q}${MAKE} PLAT=${PLAT} --no-print-directory -C ${CRTTOOLPATH} clean 456 457realclean distclean: 458 @echo " REALCLEAN" 459 ${Q}rm -rf ${BUILD_BASE} 460 ${Q}rm -f ${CURDIR}/cscope.* 461 ${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH} clean 462 ${Q}${MAKE} PLAT=${PLAT} --no-print-directory -C ${CRTTOOLPATH} clean 463 464checkcodebase: locate-checkpatch 465 @echo " CHECKING STYLE" 466 @if test -d .git ; then \ 467 git ls-files | grep -v stdlib | while read GIT_FILE ; do ${CHECKPATCH} ${CHECKCODE_ARGS} -f $$GIT_FILE ; done ; \ 468 else \ 469 find . -type f -not -iwholename "*.git*" -not -iwholename "*build*" -not -iwholename "*stdlib*" -exec ${CHECKPATCH} ${CHECKCODE_ARGS} -f {} \; ; \ 470 fi 471 472checkpatch: locate-checkpatch 473 @echo " CHECKING STYLE" 474 ${Q}git log -p ${BASE_COMMIT}..HEAD -- ${CHECK_PATHS} | ${CHECKPATCH} ${CHECKPATCH_ARGS} - || true 475 476certtool: ${CRTTOOL} 477 478.PHONY: ${CRTTOOL} 479${CRTTOOL}: 480 ${Q}${MAKE} PLAT=${PLAT} --no-print-directory -C ${CRTTOOLPATH} 481 @echo 482 @echo "Built $@ successfully" 483 @echo 484 485ifneq (${GENERATE_COT},0) 486certificates: ${CRT_DEPS} ${CRTTOOL} 487 ${Q}${CRTTOOL} ${CRT_ARGS} 488 @echo 489 @echo "Built $@ successfully" 490 @echo "Certificates can be found in ${BUILD_PLAT}" 491 @echo 492endif 493 494${BUILD_PLAT}/${FIP_NAME}: ${FIP_DEPS} ${FIPTOOL} 495 ${Q}${FIPTOOL} --dump ${FIP_ARGS} $@ 496 @echo 497 @echo "Built $@ successfully" 498 @echo 499 500fiptool: ${FIPTOOL} 501fip: ${BUILD_PLAT}/${FIP_NAME} 502 503.PHONY: ${FIPTOOL} 504${FIPTOOL}: 505 ${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH} 506 507cscope: 508 @echo " CSCOPE" 509 ${Q}find ${CURDIR} -name "*.[chsS]" > cscope.files 510 ${Q}cscope -b -q -k 511 512help: 513 @echo "usage: ${MAKE} PLAT=<${PLATFORMS}> [OPTIONS] [TARGET]" 514 @echo "" 515 @echo "PLAT is used to specify which platform you wish to build." 516 @echo "If no platform is specified, PLAT defaults to: ${DEFAULT_PLAT}" 517 @echo "" 518 @echo "Please refer to the User Guide for a list of all supported options." 519 @echo "Note that the build system doesn't track dependencies for build " 520 @echo "options. Therefore, if any of the build options are changed " 521 @echo "from a previous build, a clean build must be performed." 522 @echo "" 523 @echo "Supported Targets:" 524 @echo " all Build all individual bootloader binaries" 525 @echo " bl1 Build the BL1 binary" 526 @echo " bl2 Build the BL2 binary" 527 @echo " bl31 Build the BL3-1 binary" 528 @echo " bl32 Build the BL3-2 binary" 529 @echo " certificates Build the certificates (requires 'GENERATE_COT=1')" 530 @echo " fip Build the Firmware Image Package (FIP)" 531 @echo " checkcodebase Check the coding style of the entire source tree" 532 @echo " checkpatch Check the coding style on changes in the current" 533 @echo " branch against BASE_COMMIT (default origin/master)" 534 @echo " clean Clean the build for the selected platform" 535 @echo " cscope Generate cscope index" 536 @echo " distclean Remove all build artifacts for all platforms" 537 @echo " certtool Build the Certificate generation tool" 538 @echo " fiptool Build the Firmware Image Package(FIP) creation tool" 539 @echo "" 540 @echo "Note: most build targets require PLAT to be set to a specific platform." 541 @echo "" 542 @echo "example: build all targets for the FVP platform:" 543 @echo " CROSS_COMPILE=aarch64-none-elf- make PLAT=fvp all" 544