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