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