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