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