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