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 := 0 35VERSION_MINOR := 4 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 141ifdef BL1_SOURCES 142NEED_BL1 := yes 143include bl1/bl1.mk 144endif 145 146ifdef BL2_SOURCES 147NEED_BL2 := yes 148include bl2/bl2.mk 149endif 150 151ifdef BL31_SOURCES 152NEED_BL31 := yes 153include bl31/bl31.mk 154endif 155 156# Include SPD Makefile if one has been specified 157ifneq (${SPD},none) 158 # We expect to locate an spd.mk under the specified SPD directory 159 SPD_MAKE := $(shell m="services/spd/${SPD}/${SPD}.mk"; [ -f "$$m" ] && echo "$$m") 160 161 ifeq (${SPD_MAKE},) 162 $(error Error: No services/spd/${SPD}/${SPD}.mk located) 163 endif 164 $(info Including ${SPD_MAKE}) 165 include ${SPD_MAKE} 166 167 # If there's BL32 companion for the chosen SPD, and the SPD wants to build the 168 # BL2 from source, we expect that the SPD's Makefile would set NEED_BL32 169 # variable to "yes" 170endif 171 172.PHONY: all msg_start clean realclean distclean cscope locate-checkpatch checkcodebase checkpatch fiptool fip 173.SUFFIXES: 174 175INCLUDES += -Iinclude/bl31 \ 176 -Iinclude/bl31/services \ 177 -Iinclude/common \ 178 -Iinclude/drivers \ 179 -Iinclude/drivers/arm \ 180 -Iinclude/drivers/io \ 181 -Iinclude/lib \ 182 -Iinclude/lib/aarch64 \ 183 -Iinclude/plat/common \ 184 -Iinclude/stdlib \ 185 -Iinclude/stdlib/sys \ 186 ${PLAT_INCLUDES} \ 187 ${SPD_INCLUDES} 188 189# Process DEBUG flag 190$(eval $(call assert_boolean,DEBUG)) 191$(eval $(call add_define,DEBUG)) 192ifeq (${DEBUG},0) 193 $(eval $(call add_define,NDEBUG)) 194else 195CFLAGS += -g 196ASFLAGS += -g -Wa,--gdwarf-2 197endif 198 199# Process NS_TIMER_SWITCH flag 200$(eval $(call assert_boolean,NS_TIMER_SWITCH)) 201$(eval $(call add_define,NS_TIMER_SWITCH)) 202 203# Process RESET_TO_BL31 flag 204$(eval $(call assert_boolean,RESET_TO_BL31)) 205$(eval $(call add_define,RESET_TO_BL31)) 206 207# Process CTX_INCLUDE_FPREGS flag 208$(eval $(call assert_boolean,CTX_INCLUDE_FPREGS)) 209$(eval $(call add_define,CTX_INCLUDE_FPREGS)) 210 211# Process ARM_GIC_ARCH flag 212$(eval $(call add_define,ARM_GIC_ARCH)) 213 214# Process ASM_ASSERTION flag 215$(eval $(call assert_boolean,ASM_ASSERTION)) 216$(eval $(call add_define,ASM_ASSERTION)) 217 218# Process LOG_LEVEL flag 219$(eval $(call add_define,LOG_LEVEL)) 220 221ASFLAGS += -nostdinc -ffreestanding -Wa,--fatal-warnings \ 222 -Werror -Wmissing-include-dirs \ 223 -mgeneral-regs-only -D__ASSEMBLY__ \ 224 ${DEFINES} ${INCLUDES} 225CFLAGS += -nostdinc -pedantic -ffreestanding -Wall \ 226 -Werror -Wmissing-include-dirs \ 227 -mgeneral-regs-only -std=c99 -c -Os \ 228 ${DEFINES} ${INCLUDES} 229CFLAGS += -ffunction-sections -fdata-sections 230 231LDFLAGS += --fatal-warnings -O1 232LDFLAGS += --gc-sections 233 234 235CC := ${CROSS_COMPILE}gcc 236CPP := ${CROSS_COMPILE}cpp 237AS := ${CROSS_COMPILE}gcc 238AR := ${CROSS_COMPILE}ar 239LD := ${CROSS_COMPILE}ld 240OC := ${CROSS_COMPILE}objcopy 241OD := ${CROSS_COMPILE}objdump 242NM := ${CROSS_COMPILE}nm 243PP := ${CROSS_COMPILE}gcc -E ${CFLAGS} 244 245# Variables for use with Firmware Image Package 246FIPTOOLPATH ?= tools/fip_create 247FIPTOOL ?= ${FIPTOOLPATH}/fip_create 248fiptool: ${FIPTOOL} 249fip: ${BUILD_PLAT}/fip.bin 250 251locate-checkpatch: 252ifndef CHECKPATCH 253 $(error "Please set CHECKPATCH to point to the Linux checkpatch.pl file, eg: CHECKPATCH=../linux/script/checkpatch.pl") 254else 255ifeq (,$(wildcard ${CHECKPATCH})) 256 $(error "The file CHECKPATCH points to cannot be found, use eg: CHECKPATCH=../linux/script/checkpatch.pl") 257endif 258endif 259 260clean: 261 @echo " CLEAN" 262 ${Q}rm -rf ${BUILD_PLAT} 263 ${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH} clean 264 265realclean distclean: 266 @echo " REALCLEAN" 267 ${Q}rm -rf ${BUILD_BASE} 268 ${Q}rm -f ${CURDIR}/cscope.* 269 ${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH} clean 270 271checkcodebase: locate-checkpatch 272 @echo " CHECKING STYLE" 273 @if test -d .git ; then \ 274 git ls-files | grep -v stdlib | while read GIT_FILE ; do ${CHECKPATCH} ${CHECKCODE_ARGS} -f $$GIT_FILE ; done ; \ 275 else \ 276 find . -type f -not -iwholename "*.git*" -not -iwholename "*build*" -not -iwholename "*stdlib*" -exec ${CHECKPATCH} ${CHECKCODE_ARGS} -f {} \; ; \ 277 fi 278 279checkpatch: locate-checkpatch 280 @echo " CHECKING STYLE" 281 @git format-patch --stdout ${BASE_COMMIT} | ${CHECKPATCH} ${CHECKPATCH_ARGS} - || true 282 283${FIPTOOL}: 284 ${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH} 285 @echo 286 @echo "Built $@ successfully" 287 @echo 288 289define match_goals 290$(strip $(foreach goal,$(1),$(filter $(goal),$(MAKECMDGOALS)))) 291endef 292 293# List of rules that involve building things 294BUILD_TARGETS := all bl1 bl2 bl31 bl32 fip 295 296# Does the list of goals specified on the command line include a build target? 297ifneq ($(call match_goals,${BUILD_TARGETS}),) 298IS_ANYTHING_TO_BUILD := 1 299endif 300 301define MAKE_C 302 303$(eval OBJ := $(1)/$(patsubst %.c,%.o,$(notdir $(2)))) 304$(eval PREREQUISITES := $(patsubst %.o,%.d,$(OBJ))) 305 306$(OBJ) : $(2) 307 @echo " CC $$<" 308 $$(Q)$$(CC) $$(CFLAGS) -DIMAGE_BL$(3) -c $$< -o $$@ 309 310 311$(PREREQUISITES) : $(2) 312 @echo " DEPS $$@" 313 @mkdir -p $(1) 314 $$(Q)$$(CC) $$(CFLAGS) -M -MT $(OBJ) -MF $$@ $$< 315 316ifdef IS_ANYTHING_TO_BUILD 317-include $(PREREQUISITES) 318endif 319 320endef 321 322 323define MAKE_S 324 325$(eval OBJ := $(1)/$(patsubst %.S,%.o,$(notdir $(2)))) 326$(eval PREREQUISITES := $(patsubst %.o,%.d,$(OBJ))) 327 328$(OBJ) : $(2) 329 @echo " AS $$<" 330 $$(Q)$$(AS) $$(ASFLAGS) -DIMAGE_BL$(3) -c $$< -o $$@ 331 332$(PREREQUISITES) : $(2) 333 @echo " DEPS $$@" 334 @mkdir -p $(1) 335 $$(Q)$$(AS) $$(ASFLAGS) -M -MT $(OBJ) -MF $$@ $$< 336 337ifdef IS_ANYTHING_TO_BUILD 338-include $(PREREQUISITES) 339endif 340 341endef 342 343 344define MAKE_LD 345 346$(eval PREREQUISITES := $(1).d) 347 348$(1) : $(2) 349 @echo " PP $$<" 350 $$(Q)$$(AS) $$(ASFLAGS) -P -E -o $$@ $$< 351 352$(PREREQUISITES) : $(2) 353 @echo " DEPS $$@" 354 @mkdir -p $$(dir $$@) 355 $$(Q)$$(AS) $$(ASFLAGS) -M -MT $(1) -MF $$@ $$< 356 357ifdef IS_ANYTHING_TO_BUILD 358-include $(PREREQUISITES) 359endif 360 361endef 362 363 364define MAKE_OBJS 365 $(eval C_OBJS := $(filter %.c,$(2))) 366 $(eval REMAIN := $(filter-out %.c,$(2))) 367 $(eval $(foreach obj,$(C_OBJS),$(call MAKE_C,$(1),$(obj),$(3)))) 368 369 $(eval S_OBJS := $(filter %.S,$(REMAIN))) 370 $(eval REMAIN := $(filter-out %.S,$(REMAIN))) 371 $(eval $(foreach obj,$(S_OBJS),$(call MAKE_S,$(1),$(obj),$(3)))) 372 373 $(and $(REMAIN),$(error Unexpected source files present: $(REMAIN))) 374endef 375 376 377# NOTE: The line continuation '\' is required in the next define otherwise we 378# end up with a line-feed characer at the end of the last c filename. 379# Also bare this issue in mind if extending the list of supported filetypes. 380define SOURCES_TO_OBJS 381 $(notdir $(patsubst %.c,%.o,$(filter %.c,$(1)))) \ 382 $(notdir $(patsubst %.S,%.o,$(filter %.S,$(1)))) 383endef 384 385define MAKE_BL 386 $(eval BUILD_DIR := ${BUILD_PLAT}/bl$(1)) 387 $(eval SOURCES := $(BL$(1)_SOURCES) $(BL_COMMON_SOURCES) $(PLAT_BL_COMMON_SOURCES)) 388 $(eval OBJS := $(addprefix $(BUILD_DIR)/,$(call SOURCES_TO_OBJS,$(SOURCES)))) 389 $(eval LINKERFILE := $(BUILD_DIR)/bl$(1).ld) 390 $(eval MAPFILE := $(BUILD_DIR)/bl$(1).map) 391 $(eval ELF := $(BUILD_DIR)/bl$(1).elf) 392 $(eval DUMP := $(BUILD_DIR)/bl$(1).dump) 393 $(eval BIN := $(BUILD_PLAT)/bl$(1).bin) 394 395 $(eval $(call MAKE_OBJS,$(BUILD_DIR),$(SOURCES),$(1))) 396 $(eval $(call MAKE_LD,$(LINKERFILE),$(BL$(1)_LINKERFILE))) 397 398$(BUILD_DIR) : 399 $$(Q)mkdir -p "$$@" 400 401$(ELF) : $(OBJS) $(LINKERFILE) 402 @echo " LD $$@" 403 @echo 'const char build_message[] = "Built : "__TIME__", "__DATE__; \ 404 const char version_string[] = "${VERSION_STRING}";' | \ 405 $$(CC) $$(CFLAGS) -xc - -o $(BUILD_DIR)/build_message.o 406 $$(Q)$$(LD) -o $$@ $$(LDFLAGS) -Map=$(MAPFILE) --script $(LINKERFILE) \ 407 $(BUILD_DIR)/build_message.o $(OBJS) 408 409$(DUMP) : $(ELF) 410 @echo " OD $$@" 411 $${Q}$${OD} -dx $$< > $$@ 412 413$(BIN) : $(ELF) 414 @echo " BIN $$@" 415 $$(Q)$$(OC) -O binary $$< $$@ 416 @echo 417 @echo "Built $$@ successfully" 418 @echo 419 420.PHONY : bl$(1) 421bl$(1) : $(BUILD_DIR) $(BIN) $(DUMP) 422 423all : bl$(1) 424 425$(eval FIP_DEPS += $(if $2,$(BIN),)) 426$(eval FIP_ARGS += $(if $2,--bl$(1) $(BIN),)) 427 428endef 429 430 431ifeq (${NEED_BL1},yes) 432$(eval $(call MAKE_BL,1)) 433endif 434 435ifeq (${NEED_BL2},yes) 436$(eval $(call MAKE_BL,2,in_fip)) 437endif 438 439ifeq (${NEED_BL31},yes) 440BL31_SOURCES += ${SPD_SOURCES} 441$(eval $(call MAKE_BL,31,in_fip)) 442endif 443 444ifeq (${NEED_BL32},yes) 445$(eval $(call MAKE_BL,32,in_fip)) 446endif 447 448ifeq (${NEED_BL30},yes) 449FIP_DEPS += ${BL30} 450FIP_ARGS += --bl30 ${BL30} 451endif 452 453ifeq (${NEED_BL30},yes) 454# If BL3-0 is needed by the platform then 'BL30' variable must be defined. 455check_bl30: 456 $(if ${BL30},,$(error "To build a FIP for platform ${PLAT}, please set BL30 to point to the SCP firmware")) 457else 458# If BL3-0 is not needed by the platform but the user still specified the path 459# to a BL3-0 image then warn him that it will be ignored. 460check_bl30: 461 $(if ${BL30},$(warning "BL3-0 is not supported on platform ${PLAT}, it will just be ignored"),) 462endif 463 464${BUILD_PLAT}/fip.bin: ${FIP_DEPS} ${BL33} ${FIPTOOL} check_bl30 465 $(if ${BL33},,$(error "To build a FIP, please set BL33 to point to the Normal World binary, eg: BL33=../uefi/FVP_AARCH64_EFI.fd")) 466 ${Q}${FIPTOOL} --dump \ 467 ${FIP_ARGS} \ 468 --bl33 ${BL33} \ 469 $@ 470 @echo 471 @echo "Built $@ successfully" 472 @echo 473 474 475cscope: 476 @echo " CSCOPE" 477 ${Q}find ${CURDIR} -name "*.[chsS]" > cscope.files 478 ${Q}cscope -b -q -k 479 480help: 481 @echo "usage: ${MAKE} PLAT=<${HELP_PLATFORMS}> <all|bl1|bl2|bl31|distclean|clean|checkcodebase|checkpatch>" 482 @echo "" 483 @echo "PLAT is used to specify which platform you wish to build." 484 @echo "If no platform is specified, PLAT defaults to: ${DEFAULT_PLAT}" 485 @echo "" 486 @echo "Supported Targets:" 487 @echo " all Build the BL1, BL2 and BL31 binaries" 488 @echo " bl1 Build the BL1 binary" 489 @echo " bl2 Build the BL2 binary" 490 @echo " bl31 Build the BL31 binary" 491 @echo " checkcodebase Check the coding style of the entire source tree" 492 @echo " checkpatch Check the coding style on changes in the current" 493 @echo " branch against BASE_COMMIT (default origin/master)" 494 @echo " clean Clean the build for the selected platform" 495 @echo " cscope Generate cscope index" 496 @echo " distclean Remove all build artifacts for all platforms" 497 @echo " fiptool Build the Firmware Image Package(FIP) creation tool" 498 @echo "" 499 @echo "note: most build targets require PLAT to be set to a specific platform." 500 @echo "" 501 @echo "example: build all targets for the FVP platform:" 502 @echo " CROSS_COMPILE=aarch64-none-elf- make PLAT=fvp all" 503