1# 2# Copyright (c) 2013-2014, 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 := 0 36 37# 38# Default values for build configurations 39# 40 41# Build verbosity 42V := 0 43# Debug build 44DEBUG := 0 45# Build architecture 46ARCH := aarch64 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# Flag used to indicate if ASM_ASSERTION should be enabled for the build. 64# This defaults to being present in DEBUG builds only. 65ASM_ASSERTION := ${DEBUG} 66 67# Checkpatch ignores 68CHECK_IGNORE = --ignore COMPLEX_MACRO 69 70CHECKPATCH_ARGS = --no-tree --no-signoff ${CHECK_IGNORE} 71CHECKCODE_ARGS = --no-patch --no-tree --no-signoff ${CHECK_IGNORE} 72 73ifeq (${V},0) 74 Q=@ 75 CHECKCODE_ARGS += --no-summary --terse 76else 77 Q= 78endif 79export Q 80 81ifneq (${DEBUG}, 0) 82 BUILD_TYPE := debug 83 # Use LOG_LEVEL_INFO by default for debug builds 84 LOG_LEVEL := 40 85else 86 BUILD_TYPE := release 87 # Use LOG_LEVEL_NOTICE by default for release builds 88 LOG_LEVEL := 20 89endif 90 91# Default build string (git branch and commit) 92ifeq (${BUILD_STRING},) 93 BUILD_STRING := $(shell git log -n 1 --pretty=format:"%h") 94endif 95 96VERSION_STRING := v${VERSION_MAJOR}.${VERSION_MINOR}(${BUILD_TYPE}):${BUILD_STRING} 97 98BL_COMMON_SOURCES := common/bl_common.c \ 99 common/tf_printf.c \ 100 common/aarch64/debug.S \ 101 lib/aarch64/cache_helpers.S \ 102 lib/aarch64/misc_helpers.S \ 103 lib/aarch64/xlat_helpers.c \ 104 lib/stdlib/std.c \ 105 plat/common/aarch64/platform_helpers.S 106 107BUILD_BASE := ./build 108BUILD_PLAT := ${BUILD_BASE}/${PLAT}/${BUILD_TYPE} 109 110PLATFORMS := $(shell ls -I common plat/) 111SPDS := $(shell ls -I none services/spd) 112HELP_PLATFORMS := $(shell echo ${PLATFORMS} | sed 's/ /|/g') 113 114# Convenience function for adding build definitions 115# $(eval $(call add_define,FOO)) will have: 116# -DFOO if $(FOO) is empty; -DFOO=$(FOO) otherwise 117define add_define 118DEFINES += -D$(1)$(if $(value $(1)),=$(value $(1)),) 119endef 120 121# Convenience function for verifying option has a boolean value 122# $(eval $(call assert_boolean,FOO)) will assert FOO is 0 or 1 123define assert_boolean 124$(and $(patsubst 0,,$(value $(1))),$(patsubst 1,,$(value $(1))),$(error $(1) must be boolean)) 125endef 126 127ifeq (${PLAT},) 128 $(error "Error: Unknown platform. Please use PLAT=<platform name> to specify the platform.") 129endif 130ifeq ($(findstring ${PLAT},${PLATFORMS}),) 131 $(error "Error: Invalid platform. The following platforms are available: ${PLATFORMS}") 132endif 133 134all: msg_start 135 136msg_start: 137 @echo "Building ${PLAT}" 138 139include plat/${PLAT}/platform.mk 140 141# By default all CPU errata workarounds are disabled. This can be 142# overridden by the platform. 143include lib/cpus/cpu-errata.mk 144 145ifdef BL1_SOURCES 146NEED_BL1 := yes 147include bl1/bl1.mk 148endif 149 150ifdef BL2_SOURCES 151NEED_BL2 := yes 152include bl2/bl2.mk 153# Using the ARM Trusted Firmware BL2 implies that a BL3-3 image also need to be supplied for the FIP. 154# This flag can be overridden by the platform. 155NEED_BL33 ?= yes 156endif 157 158ifdef BL31_SOURCES 159NEED_BL31 := yes 160include bl31/bl31.mk 161endif 162 163# Include SPD Makefile if one has been specified 164ifneq (${SPD},none) 165 # We expect to locate an spd.mk under the specified SPD directory 166 SPD_MAKE := $(shell m="services/spd/${SPD}/${SPD}.mk"; [ -f "$$m" ] && echo "$$m") 167 168 ifeq (${SPD_MAKE},) 169 $(error Error: No services/spd/${SPD}/${SPD}.mk located) 170 endif 171 $(info Including ${SPD_MAKE}) 172 include ${SPD_MAKE} 173 174 # If there's BL3-2 companion for the chosen SPD, and the SPD wants to build the 175 # BL3-2 from source, we expect that the SPD's Makefile would set NEED_BL32 176 # variable to "yes". In case the BL3-2 is a binary which needs to be included in 177 # fip, then the NEED_BL32 needs to be set and BL3-2 would need to point to the bin. 178endif 179 180.PHONY: all msg_start clean realclean distclean cscope locate-checkpatch checkcodebase checkpatch fiptool fip 181.SUFFIXES: 182 183INCLUDES += -Iinclude/bl31 \ 184 -Iinclude/bl31/services \ 185 -Iinclude/common \ 186 -Iinclude/drivers \ 187 -Iinclude/drivers/arm \ 188 -Iinclude/drivers/io \ 189 -Iinclude/lib \ 190 -Iinclude/lib/aarch64 \ 191 -Iinclude/lib/cpus/aarch64 \ 192 -Iinclude/plat/common \ 193 -Iinclude/stdlib \ 194 -Iinclude/stdlib/sys \ 195 ${PLAT_INCLUDES} \ 196 ${SPD_INCLUDES} 197 198# Process DEBUG flag 199$(eval $(call assert_boolean,DEBUG)) 200$(eval $(call add_define,DEBUG)) 201ifeq (${DEBUG},0) 202 $(eval $(call add_define,NDEBUG)) 203else 204CFLAGS += -g 205ASFLAGS += -g -Wa,--gdwarf-2 206endif 207 208# Process NS_TIMER_SWITCH flag 209$(eval $(call assert_boolean,NS_TIMER_SWITCH)) 210$(eval $(call add_define,NS_TIMER_SWITCH)) 211 212# Process RESET_TO_BL31 flag 213$(eval $(call assert_boolean,RESET_TO_BL31)) 214$(eval $(call add_define,RESET_TO_BL31)) 215 216# Process CTX_INCLUDE_FPREGS flag 217$(eval $(call assert_boolean,CTX_INCLUDE_FPREGS)) 218$(eval $(call add_define,CTX_INCLUDE_FPREGS)) 219 220# Process ARM_GIC_ARCH flag 221$(eval $(call add_define,ARM_GIC_ARCH)) 222 223# Process ASM_ASSERTION flag 224$(eval $(call assert_boolean,ASM_ASSERTION)) 225$(eval $(call add_define,ASM_ASSERTION)) 226 227# Process LOG_LEVEL flag 228$(eval $(call add_define,LOG_LEVEL)) 229 230ASFLAGS += -nostdinc -ffreestanding -Wa,--fatal-warnings \ 231 -Werror -Wmissing-include-dirs \ 232 -mgeneral-regs-only -D__ASSEMBLY__ \ 233 ${DEFINES} ${INCLUDES} 234CFLAGS += -nostdinc -pedantic -ffreestanding -Wall \ 235 -Werror -Wmissing-include-dirs \ 236 -mgeneral-regs-only -std=c99 -c -Os \ 237 ${DEFINES} ${INCLUDES} 238CFLAGS += -ffunction-sections -fdata-sections 239 240LDFLAGS += --fatal-warnings -O1 241LDFLAGS += --gc-sections 242 243 244CC := ${CROSS_COMPILE}gcc 245CPP := ${CROSS_COMPILE}cpp 246AS := ${CROSS_COMPILE}gcc 247AR := ${CROSS_COMPILE}ar 248LD := ${CROSS_COMPILE}ld 249OC := ${CROSS_COMPILE}objcopy 250OD := ${CROSS_COMPILE}objdump 251NM := ${CROSS_COMPILE}nm 252PP := ${CROSS_COMPILE}gcc -E ${CFLAGS} 253 254# Variables for use with Firmware Image Package 255FIPTOOLPATH ?= tools/fip_create 256FIPTOOL ?= ${FIPTOOLPATH}/fip_create 257fiptool: ${FIPTOOL} 258fip: ${BUILD_PLAT}/fip.bin 259 260locate-checkpatch: 261ifndef CHECKPATCH 262 $(error "Please set CHECKPATCH to point to the Linux checkpatch.pl file, eg: CHECKPATCH=../linux/script/checkpatch.pl") 263else 264ifeq (,$(wildcard ${CHECKPATCH})) 265 $(error "The file CHECKPATCH points to cannot be found, use eg: CHECKPATCH=../linux/script/checkpatch.pl") 266endif 267endif 268 269clean: 270 @echo " CLEAN" 271 ${Q}rm -rf ${BUILD_PLAT} 272 ${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH} clean 273 274realclean distclean: 275 @echo " REALCLEAN" 276 ${Q}rm -rf ${BUILD_BASE} 277 ${Q}rm -f ${CURDIR}/cscope.* 278 ${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH} clean 279 280checkcodebase: locate-checkpatch 281 @echo " CHECKING STYLE" 282 @if test -d .git ; then \ 283 git ls-files | grep -v stdlib | while read GIT_FILE ; do ${CHECKPATCH} ${CHECKCODE_ARGS} -f $$GIT_FILE ; done ; \ 284 else \ 285 find . -type f -not -iwholename "*.git*" -not -iwholename "*build*" -not -iwholename "*stdlib*" -exec ${CHECKPATCH} ${CHECKCODE_ARGS} -f {} \; ; \ 286 fi 287 288checkpatch: locate-checkpatch 289 @echo " CHECKING STYLE" 290 @git format-patch --stdout ${BASE_COMMIT} | ${CHECKPATCH} ${CHECKPATCH_ARGS} - || true 291 292${FIPTOOL}: 293 ${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH} 294 @echo 295 @echo "Built $@ successfully" 296 @echo 297 298define match_goals 299$(strip $(foreach goal,$(1),$(filter $(goal),$(MAKECMDGOALS)))) 300endef 301 302# List of rules that involve building things 303BUILD_TARGETS := all bl1 bl2 bl31 bl32 fip 304 305# Does the list of goals specified on the command line include a build target? 306ifneq ($(call match_goals,${BUILD_TARGETS}),) 307IS_ANYTHING_TO_BUILD := 1 308endif 309 310define MAKE_C 311 312$(eval OBJ := $(1)/$(patsubst %.c,%.o,$(notdir $(2)))) 313$(eval PREREQUISITES := $(patsubst %.o,%.d,$(OBJ))) 314 315$(OBJ) : $(2) 316 @echo " CC $$<" 317 $$(Q)$$(CC) $$(CFLAGS) -DIMAGE_BL$(3) -c $$< -o $$@ 318 319 320$(PREREQUISITES) : $(2) 321 @echo " DEPS $$@" 322 @mkdir -p $(1) 323 $$(Q)$$(CC) $$(CFLAGS) -M -MT $(OBJ) -MF $$@ $$< 324 325ifdef IS_ANYTHING_TO_BUILD 326-include $(PREREQUISITES) 327endif 328 329endef 330 331 332define MAKE_S 333 334$(eval OBJ := $(1)/$(patsubst %.S,%.o,$(notdir $(2)))) 335$(eval PREREQUISITES := $(patsubst %.o,%.d,$(OBJ))) 336 337$(OBJ) : $(2) 338 @echo " AS $$<" 339 $$(Q)$$(AS) $$(ASFLAGS) -DIMAGE_BL$(3) -c $$< -o $$@ 340 341$(PREREQUISITES) : $(2) 342 @echo " DEPS $$@" 343 @mkdir -p $(1) 344 $$(Q)$$(AS) $$(ASFLAGS) -M -MT $(OBJ) -MF $$@ $$< 345 346ifdef IS_ANYTHING_TO_BUILD 347-include $(PREREQUISITES) 348endif 349 350endef 351 352 353define MAKE_LD 354 355$(eval PREREQUISITES := $(1).d) 356 357$(1) : $(2) 358 @echo " PP $$<" 359 $$(Q)$$(AS) $$(ASFLAGS) -P -E -o $$@ $$< 360 361$(PREREQUISITES) : $(2) 362 @echo " DEPS $$@" 363 @mkdir -p $$(dir $$@) 364 $$(Q)$$(AS) $$(ASFLAGS) -M -MT $(1) -MF $$@ $$< 365 366ifdef IS_ANYTHING_TO_BUILD 367-include $(PREREQUISITES) 368endif 369 370endef 371 372 373define MAKE_OBJS 374 $(eval C_OBJS := $(filter %.c,$(2))) 375 $(eval REMAIN := $(filter-out %.c,$(2))) 376 $(eval $(foreach obj,$(C_OBJS),$(call MAKE_C,$(1),$(obj),$(3)))) 377 378 $(eval S_OBJS := $(filter %.S,$(REMAIN))) 379 $(eval REMAIN := $(filter-out %.S,$(REMAIN))) 380 $(eval $(foreach obj,$(S_OBJS),$(call MAKE_S,$(1),$(obj),$(3)))) 381 382 $(and $(REMAIN),$(error Unexpected source files present: $(REMAIN))) 383endef 384 385 386# NOTE: The line continuation '\' is required in the next define otherwise we 387# end up with a line-feed characer at the end of the last c filename. 388# Also bare this issue in mind if extending the list of supported filetypes. 389define SOURCES_TO_OBJS 390 $(notdir $(patsubst %.c,%.o,$(filter %.c,$(1)))) \ 391 $(notdir $(patsubst %.S,%.o,$(filter %.S,$(1)))) 392endef 393 394define MAKE_BL 395 $(eval BUILD_DIR := ${BUILD_PLAT}/bl$(1)) 396 $(eval SOURCES := $(BL$(1)_SOURCES) $(BL_COMMON_SOURCES) $(PLAT_BL_COMMON_SOURCES)) 397 $(eval OBJS := $(addprefix $(BUILD_DIR)/,$(call SOURCES_TO_OBJS,$(SOURCES)))) 398 $(eval LINKERFILE := $(BUILD_DIR)/bl$(1).ld) 399 $(eval MAPFILE := $(BUILD_DIR)/bl$(1).map) 400 $(eval ELF := $(BUILD_DIR)/bl$(1).elf) 401 $(eval DUMP := $(BUILD_DIR)/bl$(1).dump) 402 $(eval BIN := $(BUILD_PLAT)/bl$(1).bin) 403 404 $(eval $(call MAKE_OBJS,$(BUILD_DIR),$(SOURCES),$(1))) 405 $(eval $(call MAKE_LD,$(LINKERFILE),$(BL$(1)_LINKERFILE))) 406 407$(BUILD_DIR) : 408 $$(Q)mkdir -p "$$@" 409 410$(ELF) : $(OBJS) $(LINKERFILE) 411 @echo " LD $$@" 412 @echo 'const char build_message[] = "Built : "__TIME__", "__DATE__; \ 413 const char version_string[] = "${VERSION_STRING}";' | \ 414 $$(CC) $$(CFLAGS) -xc - -o $(BUILD_DIR)/build_message.o 415 $$(Q)$$(LD) -o $$@ $$(LDFLAGS) -Map=$(MAPFILE) --script $(LINKERFILE) \ 416 $(BUILD_DIR)/build_message.o $(OBJS) 417 418$(DUMP) : $(ELF) 419 @echo " OD $$@" 420 $${Q}$${OD} -dx $$< > $$@ 421 422$(BIN) : $(ELF) 423 @echo " BIN $$@" 424 $$(Q)$$(OC) -O binary $$< $$@ 425 @echo 426 @echo "Built $$@ successfully" 427 @echo 428 429.PHONY : bl$(1) 430bl$(1) : $(BUILD_DIR) $(BIN) $(DUMP) 431 432all : bl$(1) 433 434$(eval FIP_DEPS += $(if $2,$(BIN),)) 435$(eval FIP_ARGS += $(if $2,--bl$(1) $(BIN),)) 436 437endef 438 439 440ifeq (${NEED_BL1},yes) 441$(eval $(call MAKE_BL,1)) 442endif 443 444ifeq (${NEED_BL2},yes) 445$(if ${BL2}, $(eval FIP_DEPS += ${BL2}) $(eval FIP_ARGS += --bl2 ${BL2}),\ 446 $(eval $(call MAKE_BL,2,in_fip))) 447endif 448 449ifeq (${NEED_BL31},yes) 450BL31_SOURCES += ${SPD_SOURCES} 451$(if ${BL31}, $(eval FIP_DEPS += ${BL31}) $(eval FIP_ARGS += --bl31 ${BL31}),\ 452 $(eval $(call MAKE_BL,31,in_fip))) 453endif 454 455ifeq (${NEED_BL32},yes) 456$(if ${BL32}, $(eval FIP_DEPS += ${BL32}) $(eval FIP_ARGS += --bl32 ${BL32}),\ 457 $(eval $(call MAKE_BL,32,in_fip))) 458endif 459 460ifeq (${NEED_BL30},yes) 461$(if ${BL30}, $(eval FIP_DEPS += ${BL30}) $(eval FIP_ARGS += --bl30 ${BL30}), ) 462 463# If BL3-0 is needed by the platform then 'BL30' variable must be defined. 464check_bl30: 465 $(if ${BL30},,$(error "To build a FIP for platform ${PLAT}, please set BL30 to point to the SCP firmware")) 466else 467 468# If BL3-0 is not needed by the platform but the user still specified the path 469# to a BL3-0 image then warn him that it will be ignored. 470check_bl30: 471 $(if ${BL30},$(warning "BL3-0 is not supported on platform ${PLAT}, it will just be ignored"),) 472endif 473 474ifeq (${NEED_BL33},yes) 475$(if ${BL33}, $(eval FIP_DEPS += ${BL33}) $(eval FIP_ARGS += --bl33 ${BL33}), ) 476 477# If BL3-3 is needed by the platform then 'BL33' variable must be defined. 478check_bl33: 479 $(if ${BL33},,$(error "To build a FIP, please set BL33 to point to the Normal World binary, eg: BL33=../uefi/FVP_AARCH64_EFI.fd")) 480else 481 482# If BL3-3 is not needed by the platform but the user still specified the path 483# to a BL3-3 image then warn him that it will be ignored. 484check_bl33: 485 $(if ${BL33},$(warning "BL3-3 is not supported on platform ${PLAT}, it will just be ignored"),) 486endif 487 488 489${BUILD_PLAT}/fip.bin: ${FIP_DEPS} ${FIPTOOL} check_bl30 check_bl33 490 ${Q}${FIPTOOL} --dump \ 491 ${FIP_ARGS} \ 492 $@ 493 @echo 494 @echo "Built $@ successfully" 495 @echo 496 497 498cscope: 499 @echo " CSCOPE" 500 ${Q}find ${CURDIR} -name "*.[chsS]" > cscope.files 501 ${Q}cscope -b -q -k 502 503help: 504 @echo "usage: ${MAKE} PLAT=<${HELP_PLATFORMS}> <all|bl1|bl2|bl31|distclean|clean|checkcodebase|checkpatch>" 505 @echo "" 506 @echo "PLAT is used to specify which platform you wish to build." 507 @echo "If no platform is specified, PLAT defaults to: ${DEFAULT_PLAT}" 508 @echo "" 509 @echo "Supported Targets:" 510 @echo " all Build the BL1, BL2 and BL31 binaries" 511 @echo " bl1 Build the BL1 binary" 512 @echo " bl2 Build the BL2 binary" 513 @echo " bl31 Build the BL31 binary" 514 @echo " checkcodebase Check the coding style of the entire source tree" 515 @echo " checkpatch Check the coding style on changes in the current" 516 @echo " branch against BASE_COMMIT (default origin/master)" 517 @echo " clean Clean the build for the selected platform" 518 @echo " cscope Generate cscope index" 519 @echo " distclean Remove all build artifacts for all platforms" 520 @echo " fiptool Build the Firmware Image Package(FIP) creation tool" 521 @echo "" 522 @echo "note: most build targets require PLAT to be set to a specific platform." 523 @echo "" 524 @echo "example: build all targets for the FVP platform:" 525 @echo " CROSS_COMPILE=aarch64-none-elf- make PLAT=fvp all" 526