blob: 4321ed0c435f040cc45d68876a16984aae946628 [file] [log] [blame]
Sandrine Bailleux3cd87d72018-10-09 11:12:55 +02001#
2# Copyright (c) 2018, Arm Limited. All rights reserved.
3#
4# SPDX-License-Identifier: BSD-3-Clause
5#
6
7# TFTF Version
8VERSION_MAJOR := 2
9VERSION_MINOR := 0
10
11################################################################################
12# Default values for build configurations, and their dependencies
13################################################################################
14
15include defaults.mk
16
17PLAT := ${DEFAULT_PLAT}
18
19# Assertions enabled for DEBUG builds by default
20ENABLE_ASSERTIONS := ${DEBUG}
21
22################################################################################
23# Checkpatch script options
24################################################################################
25
26CHECKCODE_ARGS := --no-patch
27# Do not check the coding style on imported library files or documentation files
28INC_LIB_DIRS_TO_CHECK := $(sort $(filter-out \
29 include/lib/stdlib, \
30 $(wildcard include/lib/*)))
31LIB_DIRS_TO_CHECK := $(sort $(filter-out \
32 lib/compiler-rt \
33 lib/stdlib, \
34 $(wildcard lib/*)))
35ROOT_DIRS_TO_CHECK := $(sort $(filter-out \
36 lib \
37 include \
38 docs \
39 %.md \
40 %.rst, \
41 $(wildcard *)))
42CHECK_PATHS := ${ROOT_DIRS_TO_CHECK} \
43 ${INC_LIB_DIRS_TO_CHECK} \
44 ${LIB_DIRS_TO_CHECK}
45
46ifeq (${V},0)
47 Q=@
48else
49 Q=
50endif
51export Q
52
53ifneq (${DEBUG}, 0)
54 BUILD_TYPE := debug
55 # Use LOG_LEVEL_INFO by default for debug builds
56 LOG_LEVEL := 40
57else
58 BUILD_TYPE := release
59 # Use LOG_LEVEL_ERROR by default for release builds
60 LOG_LEVEL := 20
61endif
62
63# Default build string (git branch and commit)
64ifeq (${BUILD_STRING},)
65 BUILD_STRING := $(shell git log -n 1 --pretty=format:"%h")
66endif
67
68VERSION_STRING := v${VERSION_MAJOR}.${VERSION_MINOR}(${PLAT},${BUILD_TYPE}):${BUILD_STRING}
69
70BUILD_BASE := ./build
71BUILD_PLAT := ${BUILD_BASE}/${PLAT}/${BUILD_TYPE}
72
73PLAT_MAKEFILE := platform.mk
74# Generate the platforms list by recursively searching for all directories
75# under /plat containing a PLAT_MAKEFILE. Append each platform with a `|`
76# char and strip out the final '|'.
77PLATFORMS := $(shell find plat/ -name '${PLAT_MAKEFILE}' -print0 | \
78 sed -r 's%[^\x00]*\/([^/]*)\/${PLAT_MAKEFILE}\x00%\1|%g' | \
79 sed -r 's/\|$$//')
80
81# Convenience function for adding build definitions
82# $(eval $(call add_define,BAR_DEFINES,FOO)) will have:
83# -DFOO if $(FOO) is empty; -DFOO=$(FOO) otherwise
84# inside the BAR_DEFINES variable.
85define add_define
86$(1) += -D$(2)$(if $(value $(2)),=$(value $(2)),)
87endef
88
89# Convenience function for verifying option has a boolean value
90# $(eval $(call assert_boolean,FOO)) will assert FOO is 0 or 1
91define assert_boolean
92$(and $(patsubst 0,,$(value $(1))),$(patsubst 1,,$(value $(1))),$(error $(1) must be boolean))
93endef
94
95ifeq (${PLAT},)
96 $(error "Error: Unknown platform. Please use PLAT=<platform name> to specify the platform")
97endif
98PLAT_PATH := $(shell find plat/ -wholename '*/${PLAT}')
99PLAT_MAKEFILE_FULL := ${PLAT_PATH}/${PLAT_MAKEFILE}
100ifeq ($(wildcard ${PLAT_MAKEFILE_FULL}),)
101 $(error "Error: Invalid platform. The following platforms are available: ${PLATFORMS}")
102endif
103
104.PHONY: all
105all: msg_start
106
107.PHONY: msg_start
108msg_start:
109 @echo "Building ${PLAT}"
Sandrine Bailleux043d5362018-10-03 17:05:59 +0200110 @echo "Selected set of tests: ${TESTS}"
Sandrine Bailleux3cd87d72018-10-09 11:12:55 +0200111
112# Include test images makefiles.
113include tftf/framework/framework.mk
114include tftf/tests/tests.mk
115include fwu/ns_bl1u/ns_bl1u.mk
116include fwu/ns_bl2u/ns_bl2u.mk
117include spm/cactus/cactus.mk
118
119# Include platform specific makefile last because:
120# - the platform makefile may use all previous definitions in this file.
121# - the platform makefile may wish overwriting some of them.
122include ${PLAT_MAKEFILE_FULL}
123
124
125.SUFFIXES:
126
127################################################################################
128# Build options checks
129################################################################################
130$(eval $(call assert_boolean,DEBUG))
131$(eval $(call assert_boolean,ENABLE_ASSERTIONS))
132$(eval $(call assert_boolean,FIRMWARE_UPDATE))
133$(eval $(call assert_boolean,FWU_BL_TEST))
134$(eval $(call assert_boolean,NEW_TEST_SESSION))
135$(eval $(call assert_boolean,SHELL_COLOR))
136$(eval $(call assert_boolean,USE_NVM))
137
138################################################################################
139# Add definitions to the cpp preprocessor based on the current build options.
140# This is done after including the platform specific makefile to allow the
141# platform to overwrite the default options
142################################################################################
143$(eval $(call add_define,TFTF_DEFINES,ARM_ARCH_MAJOR))
144$(eval $(call add_define,TFTF_DEFINES,ARM_ARCH_MINOR))
145$(eval $(call add_define,TFTF_DEFINES,DEBUG))
146$(eval $(call add_define,TFTF_DEFINES,ENABLE_ASSERTIONS))
147$(eval $(call add_define,TFTF_DEFINES,LOG_LEVEL))
148$(eval $(call add_define,TFTF_DEFINES,NEW_TEST_SESSION))
149$(eval $(call add_define,TFTF_DEFINES,PLAT_${PLAT}))
150$(eval $(call add_define,TFTF_DEFINES,SHELL_COLOR))
151$(eval $(call add_define,TFTF_DEFINES,USE_NVM))
152
153ifeq (${ARCH},aarch32)
154 $(eval $(call add_define,TFTF_DEFINES,AARCH32))
155else
156 $(eval $(call add_define,TFTF_DEFINES,AARCH64))
157endif
158
159################################################################################
160
161# Assembler, compiler and linker flags shared across all test images.
162COMMON_ASFLAGS :=
163COMMON_CFLAGS :=
164COMMON_LDFLAGS :=
165
166ifeq (${DEBUG},1)
167COMMON_CFLAGS += -g
168COMMON_ASFLAGS += -g -Wa,--gdwarf-2
169endif
170
171COMMON_ASFLAGS_aarch64 := -mgeneral-regs-only
172COMMON_CFLAGS_aarch64 := -mgeneral-regs-only
173
174COMMON_ASFLAGS_aarch32 := -march=armv8-a
175COMMON_CFLAGS_aarch32 := -march=armv8-a
176
177COMMON_ASFLAGS += -nostdinc -ffreestanding -Wa,--fatal-warnings \
178 -Werror -Wmissing-include-dirs \
179 -D__ASSEMBLY__ $(COMMON_ASFLAGS_$(ARCH))
180COMMON_CFLAGS += -nostdinc -ffreestanding -Wall -Werror \
181 -Wmissing-include-dirs $(COMMON_CFLAGS_$(ARCH)) \
182 -std=gnu99 -Os
183COMMON_CFLAGS += -ffunction-sections -fdata-sections
184
185# Get the content of CFLAGS user defined value last so they are appended after
186# the options defined in the Makefile
187COMMON_CFLAGS += ${CFLAGS}
188
189COMMON_LDFLAGS += --fatal-warnings -O1 --gc-sections --build-id=none
190
191CC := ${CROSS_COMPILE}gcc
192CPP := ${CROSS_COMPILE}cpp
193AS := ${CROSS_COMPILE}gcc
194AR := ${CROSS_COMPILE}ar
195LD := ${CROSS_COMPILE}ld
196OC := ${CROSS_COMPILE}objcopy
197OD := ${CROSS_COMPILE}objdump
198NM := ${CROSS_COMPILE}nm
199PP := ${CROSS_COMPILE}gcc
200
201################################################################################
202
203TFTF_SOURCES := ${FRAMEWORK_SOURCES} ${TESTS_SOURCES} ${PLAT_SOURCES}
204TFTF_INCLUDES += ${PLAT_INCLUDES}
205TFTF_CFLAGS += ${COMMON_CFLAGS}
206TFTF_ASFLAGS += ${COMMON_ASFLAGS}
207TFTF_LDFLAGS += ${COMMON_LDFLAGS}
208
209NS_BL1U_SOURCES += ${PLAT_SOURCES}
210NS_BL1U_INCLUDES += ${PLAT_INCLUDES}
211NS_BL1U_CFLAGS += ${COMMON_CFLAGS}
212NS_BL1U_ASFLAGS += ${COMMON_ASFLAGS}
213NS_BL1U_LDFLAGS += ${COMMON_LDFLAGS}
214
215NS_BL2U_SOURCES += ${PLAT_SOURCES}
216NS_BL2U_INCLUDES += ${PLAT_INCLUDES}
217NS_BL2U_CFLAGS += ${COMMON_CFLAGS}
218NS_BL2U_ASFLAGS += ${COMMON_ASFLAGS}
219NS_BL2U_LDFLAGS += ${COMMON_LDFLAGS}
220
221CACTUS_INCLUDES += ${PLAT_INCLUDES}
222CACTUS_CFLAGS += ${COMMON_CFLAGS}
223CACTUS_ASFLAGS += ${COMMON_ASFLAGS}
224CACTUS_LDFLAGS += ${COMMON_LDFLAGS}
225
226.PHONY: locate-checkpatch
227locate-checkpatch:
228ifndef CHECKPATCH
229 $(error "Please set CHECKPATCH to point to the Linux checkpatch.pl file, eg: CHECKPATCH=../linux/script/checkpatch.pl")
230else
231ifeq (,$(wildcard ${CHECKPATCH}))
232 $(error "The file CHECKPATCH points to cannot be found, use eg: CHECKPATCH=../linux/script/checkpatch.pl")
233endif
234endif
235
236.PHONY: clean
237clean:
238 @echo " CLEAN"
239 ${Q}rm -rf ${BUILD_PLAT}
240 ${MAKE} -C el3_payload clean
241
242.PHONY: realclean distclean
243realclean distclean:
244 @echo " REALCLEAN"
245 ${Q}rm -rf ${BUILD_BASE}
246 ${Q}rm -f ${CURDIR}/cscope.*
247 ${MAKE} -C el3_payload distclean
248
249.PHONY: checkcodebase
250checkcodebase: locate-checkpatch
251 @echo " CHECKING STYLE"
252 @if test -d .git ; then \
253 git ls-files | grep -E -v 'stdlib|docs|\.md|\.rst' | \
254 while read GIT_FILE ; \
255 do ${CHECKPATCH} ${CHECKCODE_ARGS} -f $$GIT_FILE ; \
256 done ; \
257 else \
258 find . -type f -not -iwholename "*.git*" \
259 -not -iwholename "*build*" \
260 -not -iwholename "*stdlib*" \
261 -not -iwholename "*docs*" \
262 -not -iwholename "*.md" \
263 -not -iwholename "*.rst" \
264 -exec ${CHECKPATCH} ${CHECKCODE_ARGS} -f {} \; ; \
265 fi
266
267.PHONY: checkpatch
268checkpatch: locate-checkpatch
269 @echo " CHECKING STYLE"
270 ${Q}COMMON_COMMIT=$$(git merge-base HEAD ${BASE_COMMIT}); \
271 for commit in `git rev-list $$COMMON_COMMIT..HEAD`; do \
272 printf "\n[*] Checking style of '$$commit'\n\n"; \
273 git log --format=email "$$commit~..$$commit" \
274 -- ${CHECK_PATHS} | ${CHECKPATCH} - || true; \
275 git diff --format=email "$$commit~..$$commit" \
276 -- ${CHECK_PATHS} | ${CHECKPATCH} - || true; \
277 done
278
279ifneq (${FIRMWARE_UPDATE},1)
280.PHONY: ns_bl1u ns_bl2u
281ns_bl1u ns_bl2u:
282 @echo "ERROR: Can't build $@ because Firmware Update is not supported \
283 on this platform."
284 @exit 1
285endif
286
287ifneq (${ARCH}-${PLAT},aarch64-fvp)
288.PHONY: cactus
289cactus:
290 @echo "ERROR: $@ is supported only on AArch64 FVP."
291 @exit 1
292endif
293
294MAKE_DEP = -Wp,-MD,$(DEP) -MT $$@
295
296define MAKE_C
297
298$(eval OBJ := $(1)/$(patsubst %.c,%.o,$(notdir $(2))))
299$(eval DEP := $(patsubst %.o,%.d,$(OBJ)))
300
301$(OBJ) : $(2)
302 @echo " CC $$<"
303 $$(Q)$$(CC) $$($(3)_CFLAGS) ${$(3)_INCLUDES} ${$(3)_DEFINES} -DIMAGE_$(3) $(MAKE_DEP) -c $$< -o $$@
304
305-include $(DEP)
306endef
307
308
309define MAKE_S
310
311$(eval OBJ := $(1)/$(patsubst %.S,%.o,$(notdir $(2))))
312$(eval DEP := $(patsubst %.o,%.d,$(OBJ)))
313
314$(OBJ) : $(2)
315 @echo " AS $$<"
316 $$(Q)$$(AS) $$($(3)_ASFLAGS) ${$(3)_INCLUDES} ${$(3)_DEFINES} -DIMAGE_$(3) $(MAKE_DEP) -c $$< -o $$@
317
318-include $(DEP)
319endef
320
321
322define MAKE_LD
323
324$(eval DEP := $(1).d)
325
326$(1) : $(2)
327 @echo " PP $$<"
328 $$(Q)$$(AS) $$($(3)_ASFLAGS) ${$(3)_INCLUDES} ${$(3)_DEFINES} -P -E $(MAKE_DEP) -o $$@ $$<
329
330-include $(DEP)
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),$(3))))
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),$(3))))
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 uppercase
356$(shell echo $(1) | tr '[:lower:]' '[:upper:]')
357endef
358
359define MAKE_IMG
360 $(eval IMG_PREFIX := $(call uppercase, $(1)))
361 $(eval BUILD_DIR := ${BUILD_PLAT}/$(1))
362 $(eval SOURCES := $(${IMG_PREFIX}_SOURCES))
363 $(eval OBJS := $(addprefix $(BUILD_DIR)/,$(call SOURCES_TO_OBJS,$(SOURCES))))
364 $(eval LINKERFILE := $(BUILD_DIR)/$(1).ld)
365 $(eval MAPFILE := $(BUILD_DIR)/$(1).map)
366 $(eval ELF := $(BUILD_DIR)/$(1).elf)
367 $(eval DUMP := $(BUILD_DIR)/$(1).dump)
368 $(eval BIN := $(BUILD_PLAT)/$(1).bin)
369
370 $(eval $(call MAKE_OBJS,$(BUILD_DIR),$(SOURCES),${IMG_PREFIX}))
371 $(eval $(call MAKE_LD,$(LINKERFILE),$(${IMG_PREFIX}_LINKERFILE),${IMG_PREFIX}))
372
373$(BUILD_DIR) :
374 $$(Q)mkdir -p "$$@"
375
376$(ELF) : $(OBJS) $(LINKERFILE)
377 @echo " LD $$@"
378 @echo 'const char build_message[] = "Built : "__TIME__", "__DATE__; \
379 const char version_string[] = "${VERSION_STRING}";' | \
380 $$(CC) $$(${IMG_PREFIX}_CFLAGS) ${${IMG_PREFIX}_INCLUDES} ${${IMG_PREFIX}_DEFINES} -c -xc - -o $(BUILD_DIR)/build_message.o
381 $$(Q)$$(LD) -o $$@ $$(${IMG_PREFIX}_LDFLAGS) -Map=$(MAPFILE) \
382 -T $(LINKERFILE) $(BUILD_DIR)/build_message.o $(OBJS)
383
384$(DUMP) : $(ELF)
385 @echo " OD $$@"
386 $${Q}$${OD} -dx $$< > $$@
387
388$(BIN) : $(ELF)
389 @echo " BIN $$@"
390 $$(Q)$$(OC) -O binary $$< $$@
391 @echo
392 @echo "Built $$@ successfully"
393 @echo
394
395.PHONY : $(1)
396$(1) : $(BUILD_DIR) $(BIN) $(DUMP)
397
398all : $(1)
399
400endef
401
402$(AUTOGEN_DIR):
403 $(Q)mkdir -p "$@"
404
405$(AUTOGEN_DIR)/tests_list.c $(AUTOGEN_DIR)/tests_list.h: $(AUTOGEN_DIR) ${TESTS_FILE} ${PLAT_TESTS_SKIP_LIST}
406 @echo " AUTOGEN $@"
407 tools/generate_test_list/generate_test_list.pl $(AUTOGEN_DIR)/tests_list.c $(AUTOGEN_DIR)/tests_list.h ${TESTS_FILE} $(PLAT_TESTS_SKIP_LIST)
408
409$(eval $(call MAKE_IMG,tftf))
410
411ifeq ($(FIRMWARE_UPDATE), 1)
412 $(eval $(call MAKE_IMG,ns_bl1u))
413 $(eval $(call MAKE_IMG,ns_bl2u))
414endif
415
416ifeq (${ARCH}-${PLAT},aarch64-fvp)
417 $(eval $(call MAKE_IMG,cactus))
418endif
419
420# The EL3 test payload is only supported in AArch64. It has an independent build
421# system.
422.PHONY: el3_payload
423ifneq (${ARCH},aarch32)
424el3_payload: $(BUILD_DIR)
425 ${Q}${MAKE} -C el3_payload PLAT=${PLAT}
426 ${Q}find "el3_payload/build/${PLAT}" -name '*.bin' -exec cp {} "${BUILD_PLAT}" \;
427
428all: el3_payload
429endif
430
431.PHONY: cscope
432cscope:
433 @echo " CSCOPE"
434 ${Q}find ${CURDIR} -name "*.[chsS]" > cscope.files
435 ${Q}cscope -b -q -k
436
437.PHONY: help
438help:
439 @echo "usage: ${MAKE} PLAT=<${PLATFORMS}> <all|tftf|ns_bl1u|ns_bl2u|cactus|el3_payload|distclean|clean|checkcodebase|checkpatch>"
440 @echo ""
441 @echo "PLAT is used to specify which platform you wish to build."
442 @echo "If no platform is specified, PLAT defaults to: ${DEFAULT_PLAT}"
443 @echo ""
444 @echo "Supported Targets:"
445 @echo " all Build all supported binaries for this platform"
446 @echo " (i.e. TFTF and FWU images)"
447 @echo " tftf Build the TFTF image"
448 @echo " ns_bl1u Build the NS_BL1U image"
449 @echo " ns_bl2u Build the NS_BL2U image"
450 @echo " cactus Build the Cactus image (Test S-EL0 payload)."
451 @echo " el3_payload Build the EL3 test payload"
452 @echo " checkcodebase Check the coding style of the entire source tree"
453 @echo " checkpatch Check the coding style on changes in the current"
454 @echo " branch against BASE_COMMIT (default origin/master)"
455 @echo " clean Clean the build for the selected platform"
456 @echo " cscope Generate cscope index"
457 @echo " distclean Remove all build artifacts for all platforms"
458 @echo ""
459 @echo "note: most build targets require PLAT to be set to a specific platform."
460 @echo ""
461 @echo "example: build all targets for the FVP platform:"
462 @echo " CROSS_COMPILE=aarch64-none-elf- make PLAT=fvp all"