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