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