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