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