1#
2# Copyright (c) 2013-2021, ARM Limited and Contributors. All rights reserved.
3#
4# SPDX-License-Identifier: BSD-3-Clause
5#
6
7#
8# Trusted Firmware Version
9#
10VERSION_MAJOR			:= 2
11VERSION_MINOR			:= 5
12
13# Default goal is build all images
14.DEFAULT_GOAL			:= all
15
16# Avoid any implicit propagation of command line variable definitions to
17# sub-Makefiles, like CFLAGS that we reserved for the firmware images'
18# usage. Other command line options like "-s" are still propagated as usual.
19MAKEOVERRIDES =
20
21MAKE_HELPERS_DIRECTORY := make_helpers/
22include ${MAKE_HELPERS_DIRECTORY}build_macros.mk
23include ${MAKE_HELPERS_DIRECTORY}build_env.mk
24
25################################################################################
26# Default values for build configurations, and their dependencies
27################################################################################
28
29include ${MAKE_HELPERS_DIRECTORY}defaults.mk
30
31# Assertions enabled for DEBUG builds by default
32ENABLE_ASSERTIONS		:= ${DEBUG}
33ENABLE_PMF			:= ${ENABLE_RUNTIME_INSTRUMENTATION}
34PLAT				:= ${DEFAULT_PLAT}
35
36################################################################################
37# Checkpatch script options
38################################################################################
39
40CHECKCODE_ARGS		:=	--no-patch
41# Do not check the coding style on imported library files or documentation files
42INC_ARM_DIRS_TO_CHECK	:=	$(sort $(filter-out                     \
43					include/drivers/arm/cryptocell,	\
44					$(wildcard include/drivers/arm/*)))
45INC_ARM_DIRS_TO_CHECK	+=	include/drivers/arm/cryptocell/*.h
46INC_DRV_DIRS_TO_CHECK	:=	$(sort $(filter-out			\
47					include/drivers/arm,		\
48					$(wildcard include/drivers/*)))
49INC_LIB_DIRS_TO_CHECK	:=	$(sort $(filter-out			\
50					include/lib/libfdt		\
51					include/lib/libc,		\
52					$(wildcard include/lib/*)))
53INC_DIRS_TO_CHECK	:=	$(sort $(filter-out			\
54					include/lib			\
55					include/drivers,		\
56					$(wildcard include/*)))
57LIB_DIRS_TO_CHECK	:=	$(sort $(filter-out			\
58					lib/compiler-rt			\
59					lib/libfdt%			\
60					lib/libc,			\
61					$(wildcard lib/*)))
62ROOT_DIRS_TO_CHECK	:=	$(sort $(filter-out			\
63					lib				\
64					include				\
65					docs				\
66					%.rst,				\
67					$(wildcard *)))
68CHECK_PATHS		:=	${ROOT_DIRS_TO_CHECK}			\
69				${INC_DIRS_TO_CHECK}			\
70				${INC_LIB_DIRS_TO_CHECK}		\
71				${LIB_DIRS_TO_CHECK}			\
72				${INC_DRV_DIRS_TO_CHECK}		\
73				${INC_ARM_DIRS_TO_CHECK}
74
75
76################################################################################
77# Process build options
78################################################################################
79
80# Verbose flag
81ifeq (${V},0)
82        Q:=@
83        ECHO:=@echo
84        CHECKCODE_ARGS	+=	--no-summary --terse
85else
86        Q:=
87        ECHO:=$(ECHO_QUIET)
88endif
89
90ifneq ($(findstring s,$(filter-out --%,$(MAKEFLAGS))),)
91        Q:=@
92        ECHO:=$(ECHO_QUIET)
93endif
94
95export Q ECHO
96
97# The cert_create tool cannot generate certificates individually, so we use the
98# target 'certificates' to create them all
99ifneq (${GENERATE_COT},0)
100        FIP_DEPS += certificates
101        FWU_FIP_DEPS += fwu_certificates
102endif
103
104# Process BRANCH_PROTECTION value and set
105# Pointer Authentication and Branch Target Identification flags
106ifeq (${BRANCH_PROTECTION},0)
107	# Default value turns off all types of branch protection
108	BP_OPTION := none
109else ifneq (${ARCH},aarch64)
110        $(error BRANCH_PROTECTION requires AArch64)
111else ifeq (${BRANCH_PROTECTION},1)
112	# Enables all types of branch protection features
113	BP_OPTION := standard
114	ENABLE_BTI := 1
115	ENABLE_PAUTH := 1
116else ifeq (${BRANCH_PROTECTION},2)
117	# Return address signing to its standard level
118	BP_OPTION := pac-ret
119	ENABLE_PAUTH := 1
120else ifeq (${BRANCH_PROTECTION},3)
121	# Extend the signing to include leaf functions
122	BP_OPTION := pac-ret+leaf
123	ENABLE_PAUTH := 1
124else ifeq (${BRANCH_PROTECTION},4)
125	# Turn on branch target identification mechanism
126	BP_OPTION := bti
127	ENABLE_BTI := 1
128else
129        $(error Unknown BRANCH_PROTECTION value ${BRANCH_PROTECTION})
130endif
131
132# USE_SPINLOCK_CAS requires AArch64 build
133ifeq (${USE_SPINLOCK_CAS},1)
134ifneq (${ARCH},aarch64)
135        $(error USE_SPINLOCK_CAS requires AArch64)
136else
137        $(info USE_SPINLOCK_CAS is an experimental feature)
138endif
139endif
140
141# USE_DEBUGFS experimental feature recommended only in debug builds
142ifeq (${USE_DEBUGFS},1)
143ifeq (${DEBUG},1)
144        $(warning DEBUGFS experimental feature is enabled.)
145else
146        $(warning DEBUGFS experimental, recommended in DEBUG builds ONLY)
147endif
148endif
149
150ifneq (${DECRYPTION_SUPPORT},none)
151ENC_ARGS += -f ${FW_ENC_STATUS}
152ENC_ARGS += -k ${ENC_KEY}
153ENC_ARGS += -n ${ENC_NONCE}
154FIP_DEPS += enctool
155FWU_FIP_DEPS += enctool
156endif
157
158################################################################################
159# Toolchain
160################################################################################
161
162HOSTCC			:=	gcc
163export HOSTCC
164
165CC			:=	${CROSS_COMPILE}gcc
166CPP			:=	${CROSS_COMPILE}cpp
167AS			:=	${CROSS_COMPILE}gcc
168AR			:=	${CROSS_COMPILE}ar
169LINKER			:=	${CROSS_COMPILE}ld
170OC			:=	${CROSS_COMPILE}objcopy
171OD			:=	${CROSS_COMPILE}objdump
172NM			:=	${CROSS_COMPILE}nm
173PP			:=	${CROSS_COMPILE}gcc -E
174DTC			:=	dtc
175
176# Use ${LD}.bfd instead if it exists (as absolute path or together with $PATH).
177ifneq ($(strip $(wildcard ${LD}.bfd) \
178	$(foreach dir,$(subst :, ,${PATH}),$(wildcard ${dir}/${LINKER}.bfd))),)
179LINKER			:=	${LINKER}.bfd
180endif
181
182ifeq (${ARM_ARCH_MAJOR},7)
183target32-directive	= 	-target arm-none-eabi
184# Will set march32-directive from platform configuration
185else
186target32-directive	= 	-target armv8a-none-eabi
187
188# Set the compiler's target architecture profile based on
189# ARM_ARCH_MAJOR ARM_ARCH_MINOR options
190ifeq (${ARM_ARCH_MINOR},0)
191march32-directive	= 	-march=armv${ARM_ARCH_MAJOR}-a
192march64-directive	= 	-march=armv${ARM_ARCH_MAJOR}-a
193else
194march32-directive	= 	-march=armv${ARM_ARCH_MAJOR}.${ARM_ARCH_MINOR}-a
195march64-directive	= 	-march=armv${ARM_ARCH_MAJOR}.${ARM_ARCH_MINOR}-a
196endif
197endif
198
199# Memory tagging is supported in architecture Armv8.5-A AArch64 and onwards
200ifeq ($(ARCH), aarch64)
201# Check if revision is greater than or equal to 8.5
202ifeq "8.5" "$(word 1, $(sort 8.5 $(ARM_ARCH_MAJOR).$(ARM_ARCH_MINOR)))"
203mem_tag_arch_support	= 	yes
204endif
205endif
206
207# Get architecture feature modifiers
208arch-features		=	${ARM_ARCH_FEATURE}
209
210# Enable required options for memory stack tagging.
211# Currently, these options are enabled only for clang and armclang compiler.
212ifeq (${SUPPORT_STACK_MEMTAG},yes)
213ifdef mem_tag_arch_support
214# Check for armclang and clang compilers
215ifneq ( ,$(filter $(notdir $(CC)),armclang clang))
216# Add "memtag" architecture feature modifier if not specified
217ifeq ( ,$(findstring memtag,$(arch-features)))
218arch-features       	:=       $(arch-features)+memtag
219endif	# memtag
220ifeq ($(notdir $(CC)),armclang)
221TF_CFLAGS		+=	-mmemtag-stack
222else ifeq ($(notdir $(CC)),clang)
223TF_CFLAGS		+=	-fsanitize=memtag
224endif	# armclang
225endif	# armclang clang
226else
227$(error "Error: stack memory tagging is not supported for architecture \
228	${ARCH},armv${ARM_ARCH_MAJOR}.${ARM_ARCH_MINOR}-a")
229endif	# mem_tag_arch_support
230endif	# SUPPORT_STACK_MEMTAG
231
232# Set the compiler's architecture feature modifiers
233ifneq ($(arch-features), none)
234# Strip "none+" from arch-features
235arch-features		:=	$(subst none+,,$(arch-features))
236ifeq ($(ARCH), aarch32)
237march32-directive	:=	$(march32-directive)+$(arch-features)
238else
239march64-directive	:=	$(march64-directive)+$(arch-features)
240endif
241# Print features
242$(info Arm Architecture Features specified: $(subst +, ,$(arch-features)))
243endif	# arch-features
244
245# Determine if FEAT_RNG is supported
246ENABLE_FEAT_RNG		=	$(if $(findstring rng,${arch-features}),1,0)
247
248# Determine if FEAT_SB is supported
249ENABLE_FEAT_SB		=	$(if $(findstring sb,${arch-features}),1,0)
250
251ifeq "8.5" "$(word 1, $(sort 8.5 $(ARM_ARCH_MAJOR).$(ARM_ARCH_MINOR)))"
252ENABLE_FEAT_SB		= 	1
253endif
254
255ifneq ($(findstring armclang,$(notdir $(CC))),)
256TF_CFLAGS_aarch32	=	-target arm-arm-none-eabi $(march32-directive)
257TF_CFLAGS_aarch64	=	-target aarch64-arm-none-eabi $(march64-directive)
258LD			=	$(LINKER)
259AS			=	$(CC) -c -x assembler-with-cpp $(TF_CFLAGS_$(ARCH))
260CPP			=	$(CC) -E $(TF_CFLAGS_$(ARCH))
261PP			=	$(CC) -E $(TF_CFLAGS_$(ARCH))
262else ifneq ($(findstring clang,$(notdir $(CC))),)
263CLANG_CCDIR		=	$(if $(filter-out ./,$(dir $(CC))),$(dir $(CC)),)
264TF_CFLAGS_aarch32	=	$(target32-directive) $(march32-directive)
265TF_CFLAGS_aarch64	=	-target aarch64-elf $(march64-directive)
266LD			=	$(CLANG_CCDIR)ld.lld
267ifeq (, $(shell which $(LD)))
268$(error "No $(LD) in PATH, make sure it is installed or set LD to a different linker")
269endif
270AS			=	$(CC) -c -x assembler-with-cpp $(TF_CFLAGS_$(ARCH))
271CPP			=	$(CC) -E
272PP			=	$(CC) -E
273else ifneq ($(findstring gcc,$(notdir $(CC))),)
274TF_CFLAGS_aarch32	=	$(march32-directive)
275TF_CFLAGS_aarch64	=	$(march64-directive)
276ifeq ($(ENABLE_LTO),1)
277	# Enable LTO only for aarch64
278	ifeq (${ARCH},aarch64)
279		LTO_CFLAGS	=	-flto
280		# Use gcc as a wrapper for the ld, recommended for LTO
281		LINKER		:=	${CROSS_COMPILE}gcc
282	endif
283endif
284LD			=	$(LINKER)
285else
286TF_CFLAGS_aarch32	=	$(march32-directive)
287TF_CFLAGS_aarch64	=	$(march64-directive)
288LD			=	$(LINKER)
289endif
290
291# Process Debug flag
292$(eval $(call add_define,DEBUG))
293ifneq (${DEBUG}, 0)
294        BUILD_TYPE	:=	debug
295        TF_CFLAGS	+= 	-g
296
297        ifneq ($(findstring clang,$(notdir $(CC))),)
298             ASFLAGS		+= 	-g
299        else
300             ASFLAGS		+= 	-g -Wa,--gdwarf-2
301        endif
302
303        # Use LOG_LEVEL_INFO by default for debug builds
304        LOG_LEVEL	:=	40
305else
306        BUILD_TYPE	:=	release
307        # Use LOG_LEVEL_NOTICE by default for release builds
308        LOG_LEVEL	:=	20
309endif
310
311# Default build string (git branch and commit)
312ifeq (${BUILD_STRING},)
313        BUILD_STRING  :=  $(shell git describe --always --dirty --tags 2> /dev/null)
314endif
315VERSION_STRING    :=  v${VERSION_MAJOR}.${VERSION_MINOR}(${BUILD_TYPE}):${BUILD_STRING}
316
317ifeq (${AARCH32_INSTRUCTION_SET},A32)
318TF_CFLAGS_aarch32	+=	-marm
319else ifeq (${AARCH32_INSTRUCTION_SET},T32)
320TF_CFLAGS_aarch32	+=	-mthumb
321else
322$(error Error: Unknown AArch32 instruction set ${AARCH32_INSTRUCTION_SET})
323endif
324
325TF_CFLAGS_aarch32	+=	-mno-unaligned-access
326TF_CFLAGS_aarch64	+=	-mgeneral-regs-only -mstrict-align
327
328ifneq (${BP_OPTION},none)
329TF_CFLAGS_aarch64	+=	-mbranch-protection=${BP_OPTION}
330endif
331
332ASFLAGS_aarch32		=	$(march32-directive)
333ASFLAGS_aarch64		=	$(march64-directive)
334
335# General warnings
336WARNINGS		:=	-Wall -Wmissing-include-dirs -Wunused	\
337				-Wdisabled-optimization -Wvla -Wshadow	\
338				-Wno-unused-parameter -Wredundant-decls
339
340# Additional warnings
341# Level 1
342WARNING1 := -Wextra
343WARNING1 += -Wmissing-format-attribute
344WARNING1 += -Wmissing-prototypes
345WARNING1 += -Wold-style-definition
346
347# Level 2
348WARNING2 := -Waggregate-return
349WARNING2 += -Wcast-align
350WARNING2 += -Wnested-externs
351
352WARNING3 := -Wbad-function-cast
353WARNING3 += -Wcast-qual
354WARNING3 += -Wconversion
355WARNING3 += -Wpacked
356WARNING3 += -Wpointer-arith
357WARNING3 += -Wswitch-default
358
359ifeq (${W},1)
360WARNINGS += $(WARNING1)
361else ifeq (${W},2)
362WARNINGS += $(WARNING1) $(WARNING2)
363else ifeq (${W},3)
364WARNINGS += $(WARNING1) $(WARNING2) $(WARNING3)
365endif
366
367# Compiler specific warnings
368ifeq ($(findstring clang,$(notdir $(CC))),)
369# not using clang
370WARNINGS	+=		-Wunused-but-set-variable -Wmaybe-uninitialized	\
371				-Wpacked-bitfield-compat -Wshift-overflow=2 \
372				-Wlogical-op
373else
374# using clang
375WARNINGS	+=		-Wshift-overflow -Wshift-sign-overflow \
376				-Wlogical-op-parentheses
377endif
378
379ifneq (${E},0)
380ERRORS := -Werror
381endif
382
383CPPFLAGS		=	${DEFINES} ${INCLUDES} ${MBEDTLS_INC} -nostdinc	\
384				$(ERRORS) $(WARNINGS)
385ASFLAGS			+=	$(CPPFLAGS) $(ASFLAGS_$(ARCH))			\
386				-ffreestanding -Wa,--fatal-warnings
387TF_CFLAGS		+=	$(CPPFLAGS) $(TF_CFLAGS_$(ARCH))		\
388				-ffunction-sections -fdata-sections		\
389				-ffreestanding -fno-builtin -fno-common		\
390				-Os -std=gnu99
391
392ifeq (${SANITIZE_UB},on)
393TF_CFLAGS		+=	-fsanitize=undefined -fno-sanitize-recover
394endif
395ifeq (${SANITIZE_UB},trap)
396TF_CFLAGS		+=	-fsanitize=undefined -fno-sanitize-recover	\
397				-fsanitize-undefined-trap-on-error
398endif
399
400GCC_V_OUTPUT		:=	$(shell $(CC) -v 2>&1)
401
402# LD = armlink
403ifneq ($(findstring armlink,$(notdir $(LD))),)
404TF_LDFLAGS		+=	--diag_error=warning --lto_level=O1
405TF_LDFLAGS		+=	--remove --info=unused,unusedsymbols
406TF_LDFLAGS		+=	$(TF_LDFLAGS_$(ARCH))
407
408# LD = gcc (used when GCC LTO is enabled)
409else ifneq ($(findstring gcc,$(notdir $(LD))),)
410# Pass ld options with Wl or Xlinker switches
411TF_LDFLAGS		+=	-Wl,--fatal-warnings -O1
412TF_LDFLAGS		+=	-Wl,--gc-sections
413ifeq ($(ENABLE_LTO),1)
414	ifeq (${ARCH},aarch64)
415		TF_LDFLAGS	+=	-flto -fuse-linker-plugin
416	endif
417endif
418# GCC automatically adds fix-cortex-a53-843419 flag when used to link
419# which breaks some builds, so disable if errata fix is not explicitly enabled
420ifneq (${ERRATA_A53_843419},1)
421	TF_LDFLAGS	+= 	-mno-fix-cortex-a53-843419
422endif
423TF_LDFLAGS		+= 	-nostdlib
424TF_LDFLAGS		+=	$(subst --,-Xlinker --,$(TF_LDFLAGS_$(ARCH)))
425
426# LD = gcc-ld (ld) or llvm-ld (ld.lld) or other
427else
428TF_LDFLAGS		+=	--fatal-warnings -O1
429TF_LDFLAGS		+=	--gc-sections
430# ld.lld doesn't recognize the errata flags,
431# therefore don't add those in that case
432ifeq ($(findstring ld.lld,$(notdir $(LD))),)
433TF_LDFLAGS		+=	$(TF_LDFLAGS_$(ARCH))
434endif
435endif
436
437DTC_FLAGS		+=	-I dts -O dtb
438DTC_CPPFLAGS		+=	-P -nostdinc -Iinclude -Ifdts -undef \
439				-x assembler-with-cpp $(DEFINES)
440
441ifeq ($(MEASURED_BOOT),1)
442DTC_CPPFLAGS		+=	-DMEASURED_BOOT -DBL2_HASH_SIZE=${TCG_DIGEST_SIZE}
443endif
444
445################################################################################
446# Common sources and include directories
447################################################################################
448include lib/compiler-rt/compiler-rt.mk
449
450BL_COMMON_SOURCES	+=	common/bl_common.c			\
451				common/tf_log.c				\
452				common/${ARCH}/debug.S			\
453				drivers/console/multi_console.c		\
454				lib/${ARCH}/cache_helpers.S		\
455				lib/${ARCH}/misc_helpers.S		\
456				plat/common/plat_bl_common.c		\
457				plat/common/plat_log_common.c		\
458				plat/common/${ARCH}/plat_common.c	\
459				plat/common/${ARCH}/platform_helpers.S	\
460				${COMPILER_RT_SRCS}
461
462ifeq ($(notdir $(CC)),armclang)
463BL_COMMON_SOURCES	+=	lib/${ARCH}/armclang_printf.S
464endif
465
466ifeq (${SANITIZE_UB},on)
467BL_COMMON_SOURCES	+=	plat/common/ubsan.c
468endif
469
470INCLUDES		+=	-Iinclude				\
471				-Iinclude/arch/${ARCH}			\
472				-Iinclude/lib/cpus/${ARCH}		\
473				-Iinclude/lib/el3_runtime/${ARCH}	\
474				${PLAT_INCLUDES}			\
475				${SPD_INCLUDES}
476
477include common/backtrace/backtrace.mk
478
479################################################################################
480# Generic definitions
481################################################################################
482
483include ${MAKE_HELPERS_DIRECTORY}plat_helpers.mk
484
485ifeq (${BUILD_BASE},)
486     BUILD_BASE		:=	./build
487endif
488BUILD_PLAT		:=	$(abspath ${BUILD_BASE})/${PLAT}/${BUILD_TYPE}
489
490SPDS			:=	$(sort $(filter-out none, $(patsubst services/spd/%,%,$(wildcard services/spd/*))))
491
492# Platforms providing their own TBB makefile may override this value
493INCLUDE_TBBR_MK		:=	1
494
495
496################################################################################
497# Include SPD Makefile if one has been specified
498################################################################################
499
500ifneq (${SPD},none)
501    ifeq (${ARCH},aarch32)
502        $(error "Error: SPD is incompatible with AArch32.")
503    endif
504
505    ifdef EL3_PAYLOAD_BASE
506        $(warning "SPD and EL3_PAYLOAD_BASE are incompatible build options.")
507        $(warning "The SPD and its BL32 companion will be present but ignored.")
508    endif
509
510    ifeq (${SPD},spmd)
511        $(warning "SPMD is an experimental feature")
512        # SPMD is located in std_svc directory
513        SPD_DIR := std_svc
514
515        ifeq ($(SPMD_SPM_AT_SEL2),1)
516            ifeq ($(CTX_INCLUDE_EL2_REGS),0)
517                $(error SPMD with SPM at S-EL2 requires CTX_INCLUDE_EL2_REGS option)
518            endif
519        endif
520
521        ifeq ($(findstring optee_sp,$(ARM_SPMC_MANIFEST_DTS)),optee_sp)
522            DTC_CPPFLAGS	+=	-DOPTEE_SP_FW_CONFIG
523        endif
524
525        ifeq ($(TS_SP_FW_CONFIG),1)
526            DTC_CPPFLAGS	+=	-DTS_SP_FW_CONFIG
527        endif
528    else
529        # All other SPDs in spd directory
530        SPD_DIR := spd
531    endif
532
533    # We expect to locate an spd.mk under the specified SPD directory
534    SPD_MAKE	:=	$(wildcard services/${SPD_DIR}/${SPD}/${SPD}.mk)
535
536    ifeq (${SPD_MAKE},)
537        $(error Error: No services/${SPD_DIR}/${SPD}/${SPD}.mk located)
538    endif
539    $(info Including ${SPD_MAKE})
540    include ${SPD_MAKE}
541
542    # If there's BL32 companion for the chosen SPD, we expect that the SPD's
543    # Makefile would set NEED_BL32 to "yes". In this case, the build system
544    # supports two mutually exclusive options:
545    # * BL32 is built from source: then BL32_SOURCES must contain the list
546    #   of source files to build BL32
547    # * BL32 is a prebuilt binary: then BL32 must point to the image file
548    #   that will be included in the FIP
549    # If both BL32_SOURCES and BL32 are defined, the binary takes precedence
550    # over the sources.
551endif
552
553################################################################################
554# Include the platform specific Makefile after the SPD Makefile (the platform
555# makefile may use all previous definitions in this file)
556################################################################################
557
558include ${PLAT_MAKEFILE_FULL}
559
560$(eval $(call MAKE_PREREQ_DIR,${BUILD_PLAT}))
561
562ifeq (${ARM_ARCH_MAJOR},7)
563include make_helpers/armv7-a-cpus.mk
564endif
565
566PIE_FOUND		:=	$(findstring --enable-default-pie,${GCC_V_OUTPUT})
567ifneq ($(PIE_FOUND),)
568	TF_CFLAGS	+=	-fno-PIE
569endif
570
571ifneq ($(findstring gcc,$(notdir $(LD))),)
572	PIE_LDFLAGS	+=	-Wl,-pie -Wl,--no-dynamic-linker
573else
574	PIE_LDFLAGS	+=	-pie --no-dynamic-linker
575endif
576
577ifeq ($(ENABLE_PIE),1)
578ifeq ($(BL2_AT_EL3),1)
579ifneq ($(BL2_IN_XIP_MEM),1)
580	BL2_CFLAGS	+=	-fpie
581	BL2_LDFLAGS	+=	$(PIE_LDFLAGS)
582endif
583endif
584	BL31_CFLAGS	+=	-fpie
585	BL31_LDFLAGS	+=	$(PIE_LDFLAGS)
586	BL32_CFLAGS	+=	-fpie
587	BL32_LDFLAGS	+=	$(PIE_LDFLAGS)
588endif
589
590ifeq (${ARCH},aarch64)
591BL1_CPPFLAGS += -DIMAGE_AT_EL3
592ifeq ($(BL2_AT_EL3),1)
593BL2_CPPFLAGS += -DIMAGE_AT_EL3
594else
595BL2_CPPFLAGS += -DIMAGE_AT_EL1
596endif
597BL2U_CPPFLAGS += -DIMAGE_AT_EL1
598BL31_CPPFLAGS += -DIMAGE_AT_EL3
599BL32_CPPFLAGS += -DIMAGE_AT_EL1
600endif
601
602# Include the CPU specific operations makefile, which provides default
603# values for all CPU errata workarounds and CPU specific optimisations.
604# This can be overridden by the platform.
605include lib/cpus/cpu-ops.mk
606
607ifeq (${ARCH},aarch32)
608NEED_BL32 := yes
609
610################################################################################
611# Build `AARCH32_SP` as BL32 image for AArch32
612################################################################################
613ifneq (${AARCH32_SP},none)
614# We expect to locate an sp.mk under the specified AARCH32_SP directory
615AARCH32_SP_MAKE	:=	$(wildcard bl32/${AARCH32_SP}/${AARCH32_SP}.mk)
616
617ifeq (${AARCH32_SP_MAKE},)
618  $(error Error: No bl32/${AARCH32_SP}/${AARCH32_SP}.mk located)
619endif
620
621$(info Including ${AARCH32_SP_MAKE})
622include ${AARCH32_SP_MAKE}
623endif
624
625endif
626
627################################################################################
628# Include libc if not overridden
629################################################################################
630ifeq (${OVERRIDE_LIBC},0)
631include lib/libc/libc.mk
632endif
633
634################################################################################
635# Check incompatible options
636################################################################################
637
638ifdef EL3_PAYLOAD_BASE
639        ifdef PRELOADED_BL33_BASE
640                $(warning "PRELOADED_BL33_BASE and EL3_PAYLOAD_BASE are \
641                incompatible build options. EL3_PAYLOAD_BASE has priority.")
642        endif
643        ifneq (${GENERATE_COT},0)
644                $(error "GENERATE_COT and EL3_PAYLOAD_BASE are incompatible build options.")
645        endif
646        ifneq (${TRUSTED_BOARD_BOOT},0)
647                $(error "TRUSTED_BOARD_BOOT and EL3_PAYLOAD_BASE are incompatible build options.")
648        endif
649endif
650
651ifeq (${NEED_BL33},yes)
652        ifdef EL3_PAYLOAD_BASE
653                $(warning "BL33 image is not needed when option \
654                BL33_PAYLOAD_BASE is used and won't be added to the FIP file.")
655        endif
656        ifdef PRELOADED_BL33_BASE
657                $(warning "BL33 image is not needed when option \
658                PRELOADED_BL33_BASE is used and won't be added to the FIP \
659                file.")
660        endif
661endif
662
663# When building for systems with hardware-assisted coherency, there's no need to
664# use USE_COHERENT_MEM. Require that USE_COHERENT_MEM must be set to 0 too.
665ifeq ($(HW_ASSISTED_COHERENCY)-$(USE_COHERENT_MEM),1-1)
666$(error USE_COHERENT_MEM cannot be enabled with HW_ASSISTED_COHERENCY)
667endif
668
669#For now, BL2_IN_XIP_MEM is only supported when BL2_AT_EL3 is 1.
670ifeq ($(BL2_AT_EL3)-$(BL2_IN_XIP_MEM),0-1)
671$(error "BL2_IN_XIP_MEM is only supported when BL2_AT_EL3 is enabled")
672endif
673
674# For RAS_EXTENSION, require that EAs are handled in EL3 first
675ifeq ($(RAS_EXTENSION),1)
676    ifneq ($(HANDLE_EA_EL3_FIRST),1)
677        $(error For RAS_EXTENSION, HANDLE_EA_EL3_FIRST must also be 1)
678    endif
679endif
680
681# When FAULT_INJECTION_SUPPORT is used, require that RAS_EXTENSION is enabled
682ifeq ($(FAULT_INJECTION_SUPPORT),1)
683    ifneq ($(RAS_EXTENSION),1)
684        $(error For FAULT_INJECTION_SUPPORT, RAS_EXTENSION must also be 1)
685    endif
686endif
687
688# DYN_DISABLE_AUTH can be set only when TRUSTED_BOARD_BOOT=1
689ifeq ($(DYN_DISABLE_AUTH), 1)
690    ifeq (${TRUSTED_BOARD_BOOT}, 0)
691        $(error "TRUSTED_BOARD_BOOT must be enabled for DYN_DISABLE_AUTH to be set.")
692    endif
693endif
694
695# SDEI_IN_FCONF is only supported when SDEI_SUPPORT is enabled.
696ifeq ($(SDEI_SUPPORT)-$(SDEI_IN_FCONF),0-1)
697$(error "SDEI_IN_FCONF is an experimental feature and is only supported when \
698	SDEI_SUPPORT is enabled")
699endif
700
701ifeq ($(COT_DESC_IN_DTB),1)
702    $(info CoT in device tree is an experimental feature)
703endif
704
705# If pointer authentication is used in the firmware, make sure that all the
706# registers associated to it are also saved and restored.
707# Not doing it would leak the value of the keys used by EL3 to EL1 and S-EL1.
708ifeq ($(ENABLE_PAUTH),1)
709    ifeq ($(CTX_INCLUDE_PAUTH_REGS),0)
710        $(error Pointer Authentication requires CTX_INCLUDE_PAUTH_REGS=1)
711    endif
712endif
713
714ifeq ($(CTX_INCLUDE_PAUTH_REGS),1)
715    ifneq (${ARCH},aarch64)
716        $(error CTX_INCLUDE_PAUTH_REGS requires AArch64)
717    else
718        $(info CTX_INCLUDE_PAUTH_REGS is an experimental feature)
719    endif
720endif
721
722ifeq ($(ENABLE_PAUTH),1)
723    $(info Pointer Authentication is an experimental feature)
724endif
725
726ifeq ($(ENABLE_BTI),1)
727    $(info Branch Protection is an experimental feature)
728endif
729
730ifeq ($(CTX_INCLUDE_MTE_REGS),1)
731    ifneq (${ARCH},aarch64)
732        $(error CTX_INCLUDE_MTE_REGS requires AArch64)
733    else
734        $(info CTX_INCLUDE_MTE_REGS is an experimental feature)
735    endif
736endif
737
738# Trusted Boot is a prerequisite for Measured Boot. It provides trust that the
739# code taking the measurements and recording them has not been tampered
740# with. This is referred to as the Root of Trust for Measurement.
741ifeq ($(MEASURED_BOOT),1)
742    ifneq (${TRUSTED_BOARD_BOOT},1)
743        $(error MEASURED_BOOT requires TRUSTED_BOARD_BOOT=1)
744    else
745        $(info MEASURED_BOOT is an experimental feature)
746    endif
747endif
748
749ifeq ($(PSA_FWU_SUPPORT),1)
750    $(info PSA_FWU_SUPPORT is an experimental feature)
751endif
752
753ifeq (${ARM_XLAT_TABLES_LIB_V1}, 1)
754    ifeq (${ALLOW_RO_XLAT_TABLES}, 1)
755        $(error "ALLOW_RO_XLAT_TABLES requires translation tables library v2")
756    endif
757endif
758
759ifneq (${DECRYPTION_SUPPORT},none)
760    ifeq (${TRUSTED_BOARD_BOOT}, 0)
761        $(error TRUSTED_BOARD_BOOT must be enabled for DECRYPTION_SUPPORT to be set)
762    else
763        $(info DECRYPTION_SUPPORT is an experimental feature)
764    endif
765endif
766
767################################################################################
768# Process platform overrideable behaviour
769################################################################################
770
771# Using BL2 implies that a BL33 image also needs to be supplied for the FIP and
772# Certificate generation tools. This flag can be overridden by the platform.
773ifdef BL2_SOURCES
774        ifdef EL3_PAYLOAD_BASE
775                # If booting an EL3 payload there is no need for a BL33 image
776                # in the FIP file.
777                NEED_BL33		:=	no
778        else
779                ifdef PRELOADED_BL33_BASE
780                        # If booting a BL33 preloaded image there is no need of
781                        # another one in the FIP file.
782                        NEED_BL33		:=	no
783                else
784                        NEED_BL33		?=	yes
785                endif
786        endif
787endif
788
789# If SCP_BL2 is given, we always want FIP to include it.
790ifdef SCP_BL2
791        NEED_SCP_BL2		:=	yes
792endif
793
794# For AArch32, BL31 is not currently supported.
795ifneq (${ARCH},aarch32)
796    ifdef BL31_SOURCES
797        # When booting an EL3 payload, there is no need to compile the BL31 image nor
798        # put it in the FIP.
799        ifndef EL3_PAYLOAD_BASE
800            NEED_BL31 := yes
801        endif
802    endif
803endif
804
805# Process TBB related flags
806ifneq (${GENERATE_COT},0)
807        # Common cert_create options
808        ifneq (${CREATE_KEYS},0)
809                $(eval CRT_ARGS += -n)
810                $(eval FWU_CRT_ARGS += -n)
811                ifneq (${SAVE_KEYS},0)
812                        $(eval CRT_ARGS += -k)
813                        $(eval FWU_CRT_ARGS += -k)
814                endif
815        endif
816        # Include TBBR makefile (unless the platform indicates otherwise)
817        ifeq (${INCLUDE_TBBR_MK},1)
818                include make_helpers/tbbr/tbbr_tools.mk
819        endif
820endif
821
822ifneq (${FIP_ALIGN},0)
823FIP_ARGS += --align ${FIP_ALIGN}
824endif
825
826################################################################################
827# Include libraries' Makefile that are used in all BL
828################################################################################
829
830include lib/stack_protector/stack_protector.mk
831
832################################################################################
833# Auxiliary tools (fiptool, cert_create, etc)
834################################################################################
835
836# Variables for use with Certificate Generation Tool
837CRTTOOLPATH		?=	tools/cert_create
838CRTTOOL			?=	${CRTTOOLPATH}/cert_create${BIN_EXT}
839
840# Variables for use with Firmware Encryption Tool
841ENCTOOLPATH		?=	tools/encrypt_fw
842ENCTOOL			?=	${ENCTOOLPATH}/encrypt_fw${BIN_EXT}
843
844# Variables for use with Firmware Image Package
845FIPTOOLPATH		?=	tools/fiptool
846FIPTOOL			?=	${FIPTOOLPATH}/fiptool${BIN_EXT}
847
848# Variables for use with sptool
849SPTOOLPATH		?=	tools/sptool
850SPTOOL			?=	${SPTOOLPATH}/sptool${BIN_EXT}
851SP_MK_GEN		?=	${SPTOOLPATH}/sp_mk_generator.py
852
853# Variables for use with ROMLIB
854ROMLIBPATH		?=	lib/romlib
855
856# Variable for use with Python
857PYTHON			?=	python3
858
859# Variables for use with PRINT_MEMORY_MAP
860PRINT_MEMORY_MAP_PATH		?=	tools/memory
861PRINT_MEMORY_MAP		?=	${PRINT_MEMORY_MAP_PATH}/print_memory_map.py
862
863# Variables for use with documentation build using Sphinx tool
864DOCS_PATH		?=	docs
865
866################################################################################
867# Include BL specific makefiles
868################################################################################
869ifdef BL1_SOURCES
870NEED_BL1 := yes
871include bl1/bl1.mk
872endif
873
874ifdef BL2_SOURCES
875NEED_BL2 := yes
876include bl2/bl2.mk
877endif
878
879ifdef BL2U_SOURCES
880NEED_BL2U := yes
881include bl2u/bl2u.mk
882endif
883
884ifeq (${NEED_BL31},yes)
885ifdef BL31_SOURCES
886include bl31/bl31.mk
887endif
888endif
889
890ifdef FDT_SOURCES
891NEED_FDT := yes
892endif
893
894################################################################################
895# Build options checks
896################################################################################
897
898$(eval $(call assert_booleans,\
899    $(sort \
900        ALLOW_RO_XLAT_TABLES \
901        COLD_BOOT_SINGLE_CPU \
902        CREATE_KEYS \
903        CTX_INCLUDE_AARCH32_REGS \
904        CTX_INCLUDE_FPREGS \
905        CTX_INCLUDE_PAUTH_REGS \
906        CTX_INCLUDE_MTE_REGS \
907        CTX_INCLUDE_EL2_REGS \
908        CTX_INCLUDE_NEVE_REGS \
909        DEBUG \
910        DISABLE_MTPMU \
911        DYN_DISABLE_AUTH \
912        EL3_EXCEPTION_HANDLING \
913        ENABLE_AMU \
914        AMU_RESTRICT_COUNTERS \
915        ENABLE_ASSERTIONS \
916        ENABLE_MPAM_FOR_LOWER_ELS \
917        ENABLE_PIE \
918        ENABLE_PMF \
919        ENABLE_PSCI_STAT \
920        ENABLE_RUNTIME_INSTRUMENTATION \
921        ENABLE_SPE_FOR_LOWER_ELS \
922        ENABLE_SVE_FOR_NS \
923        ENABLE_SVE_FOR_SWD \
924        ERROR_DEPRECATED \
925        FAULT_INJECTION_SUPPORT \
926        GENERATE_COT \
927        GICV2_G0_FOR_EL3 \
928        HANDLE_EA_EL3_FIRST \
929        HW_ASSISTED_COHERENCY \
930        INVERTED_MEMMAP \
931        MEASURED_BOOT \
932        NS_TIMER_SWITCH \
933        OVERRIDE_LIBC \
934        PL011_GENERIC_UART \
935        PROGRAMMABLE_RESET_ADDRESS \
936        PSCI_EXTENDED_STATE_ID \
937        RAS_EXTENSION \
938        RESET_TO_BL31 \
939        SAVE_KEYS \
940        SEPARATE_CODE_AND_RODATA \
941        SEPARATE_NOBITS_REGION \
942        SPIN_ON_BL1_EXIT \
943        SPM_MM \
944        SPMC_AT_EL3 \
945        SPMD_SPM_AT_SEL2 \
946        TRUSTED_BOARD_BOOT \
947        USE_COHERENT_MEM \
948        USE_DEBUGFS \
949        ARM_IO_IN_DTB \
950        SDEI_IN_FCONF \
951        SEC_INT_DESC_IN_FCONF \
952        USE_ROMLIB \
953        USE_TBBR_DEFS \
954        WARMBOOT_ENABLE_DCACHE_EARLY \
955        BL2_AT_EL3 \
956        BL2_IN_XIP_MEM \
957        BL2_INV_DCACHE \
958        USE_SPINLOCK_CAS \
959        ENCRYPT_BL31 \
960        ENCRYPT_BL32 \
961        ERRATA_SPECULATIVE_AT \
962        RAS_TRAP_LOWER_EL_ERR_ACCESS \
963        COT_DESC_IN_DTB \
964        USE_SP804_TIMER \
965        ENABLE_FEAT_RNG \
966        ENABLE_FEAT_SB \
967        PSA_FWU_SUPPORT \
968)))
969
970$(eval $(call assert_numerics,\
971    $(sort \
972        ARM_ARCH_MAJOR \
973        ARM_ARCH_MINOR \
974        BRANCH_PROTECTION \
975        FW_ENC_STATUS \
976        NR_OF_FW_BANKS \
977        NR_OF_IMAGES_IN_FW_BANK \
978)))
979
980ifdef KEY_SIZE
981        $(eval $(call assert_numeric,KEY_SIZE))
982endif
983
984ifeq ($(filter $(SANITIZE_UB), on off trap),)
985        $(error "Invalid value for SANITIZE_UB: can be one of on, off, trap")
986endif
987
988################################################################################
989# Add definitions to the cpp preprocessor based on the current build options.
990# This is done after including the platform specific makefile to allow the
991# platform to overwrite the default options
992################################################################################
993
994$(eval $(call add_defines,\
995    $(sort \
996        ALLOW_RO_XLAT_TABLES \
997        ARM_ARCH_MAJOR \
998        ARM_ARCH_MINOR \
999        COLD_BOOT_SINGLE_CPU \
1000        CTX_INCLUDE_AARCH32_REGS \
1001        CTX_INCLUDE_FPREGS \
1002        CTX_INCLUDE_PAUTH_REGS \
1003        EL3_EXCEPTION_HANDLING \
1004        CTX_INCLUDE_MTE_REGS \
1005        CTX_INCLUDE_EL2_REGS \
1006        CTX_INCLUDE_NEVE_REGS \
1007        DECRYPTION_SUPPORT_${DECRYPTION_SUPPORT} \
1008        DISABLE_MTPMU \
1009        ENABLE_AMU \
1010        AMU_RESTRICT_COUNTERS \
1011        ENABLE_ASSERTIONS \
1012        ENABLE_BTI \
1013        ENABLE_MPAM_FOR_LOWER_ELS \
1014        ENABLE_PAUTH \
1015        ENABLE_PIE \
1016        ENABLE_PMF \
1017        ENABLE_PSCI_STAT \
1018        ENABLE_RUNTIME_INSTRUMENTATION \
1019        ENABLE_SPE_FOR_LOWER_ELS \
1020        ENABLE_SVE_FOR_NS \
1021        ENABLE_SVE_FOR_SWD \
1022        ENCRYPT_BL31 \
1023        ENCRYPT_BL32 \
1024        ERROR_DEPRECATED \
1025        FAULT_INJECTION_SUPPORT \
1026        GICV2_G0_FOR_EL3 \
1027        HANDLE_EA_EL3_FIRST \
1028        HW_ASSISTED_COHERENCY \
1029        LOG_LEVEL \
1030        MEASURED_BOOT \
1031        NS_TIMER_SWITCH \
1032        PL011_GENERIC_UART \
1033        PLAT_${PLAT} \
1034        PROGRAMMABLE_RESET_ADDRESS \
1035        PSCI_EXTENDED_STATE_ID \
1036        RAS_EXTENSION \
1037        RESET_TO_BL31 \
1038        SEPARATE_CODE_AND_RODATA \
1039        SEPARATE_NOBITS_REGION \
1040        RECLAIM_INIT_CODE \
1041        SPD_${SPD} \
1042        SPIN_ON_BL1_EXIT \
1043        SPM_MM \
1044        SPMC_AT_EL3 \
1045        SPMD_SPM_AT_SEL2 \
1046        TRUSTED_BOARD_BOOT \
1047        TRNG_SUPPORT \
1048        USE_COHERENT_MEM \
1049        USE_DEBUGFS \
1050        ARM_IO_IN_DTB \
1051        SDEI_IN_FCONF \
1052        SEC_INT_DESC_IN_FCONF \
1053        USE_ROMLIB \
1054        USE_TBBR_DEFS \
1055        WARMBOOT_ENABLE_DCACHE_EARLY \
1056        BL2_AT_EL3 \
1057        BL2_IN_XIP_MEM \
1058        BL2_INV_DCACHE \
1059        USE_SPINLOCK_CAS \
1060        ERRATA_SPECULATIVE_AT \
1061        RAS_TRAP_LOWER_EL_ERR_ACCESS \
1062        COT_DESC_IN_DTB \
1063        USE_SP804_TIMER \
1064        ENABLE_FEAT_RNG \
1065        ENABLE_FEAT_SB \
1066        NR_OF_FW_BANKS \
1067        NR_OF_IMAGES_IN_FW_BANK \
1068        PSA_FWU_SUPPORT \
1069)))
1070
1071ifeq (${SANITIZE_UB},trap)
1072        $(eval $(call add_define,MONITOR_TRAPS))
1073endif
1074
1075# Define the EL3_PAYLOAD_BASE flag only if it is provided.
1076ifdef EL3_PAYLOAD_BASE
1077        $(eval $(call add_define,EL3_PAYLOAD_BASE))
1078else
1079        # Define the PRELOADED_BL33_BASE flag only if it is provided and
1080        # EL3_PAYLOAD_BASE is not defined, as it has priority.
1081        ifdef PRELOADED_BL33_BASE
1082                $(eval $(call add_define,PRELOADED_BL33_BASE))
1083        endif
1084endif
1085
1086# Define the DYN_DISABLE_AUTH flag only if set.
1087ifeq (${DYN_DISABLE_AUTH},1)
1088$(eval $(call add_define,DYN_DISABLE_AUTH))
1089endif
1090
1091ifneq ($(findstring armlink,$(notdir $(LD))),)
1092$(eval $(call add_define,USE_ARM_LINK))
1093endif
1094
1095# Generate and include sp_gen.mk if SPD is spmd and SP_LAYOUT_FILE is defined
1096ifeq (${SPD},spmd)
1097ifdef SP_LAYOUT_FILE
1098        ifeq (${SPMD_SPM_AT_SEL2},0)
1099            $(error "SPMD with SPM at S-EL1 does not require SP_LAYOUT_FILE")
1100        endif
1101        -include $(BUILD_PLAT)/sp_gen.mk
1102        FIP_DEPS += sp
1103        CRT_DEPS += sp
1104        NEED_SP_PKG := yes
1105else
1106        ifeq (${SPMD_SPM_AT_SEL2},1)
1107            $(error "SPMD with SPM at S-EL2 require SP_LAYOUT_FILE")
1108        endif
1109endif
1110endif
1111
1112################################################################################
1113# Build targets
1114################################################################################
1115
1116.PHONY:	all msg_start clean realclean distclean cscope locate-checkpatch checkcodebase checkpatch fiptool sptool fip sp fwu_fip certtool dtbs memmap doc enctool
1117.SUFFIXES:
1118
1119all: msg_start
1120
1121msg_start:
1122	@echo "Building ${PLAT}"
1123
1124ifeq (${ERROR_DEPRECATED},0)
1125# Check if deprecated declarations and cpp warnings should be treated as error or not.
1126ifneq ($(findstring clang,$(notdir $(CC))),)
1127    CPPFLAGS		+= 	-Wno-error=deprecated-declarations
1128else
1129    CPPFLAGS		+= 	-Wno-error=deprecated-declarations -Wno-error=cpp
1130endif
1131endif # !ERROR_DEPRECATED
1132
1133$(eval $(call MAKE_LIB_DIRS))
1134$(eval $(call MAKE_LIB,c))
1135
1136# Expand build macros for the different images
1137ifeq (${NEED_BL1},yes)
1138$(eval $(call MAKE_BL,1))
1139endif
1140
1141ifeq (${NEED_BL2},yes)
1142ifeq (${BL2_AT_EL3}, 0)
1143FIP_BL2_ARGS := tb-fw
1144endif
1145
1146$(if ${BL2}, $(eval $(call TOOL_ADD_IMG,bl2,--${FIP_BL2_ARGS})),\
1147	$(eval $(call MAKE_BL,2,${FIP_BL2_ARGS})))
1148endif
1149
1150ifeq (${NEED_SCP_BL2},yes)
1151$(eval $(call TOOL_ADD_IMG,scp_bl2,--scp-fw))
1152endif
1153
1154ifeq (${NEED_BL31},yes)
1155BL31_SOURCES += ${SPD_SOURCES}
1156# Sort BL31 source files to remove duplicates
1157BL31_SOURCES := $(sort ${BL31_SOURCES})
1158ifneq (${DECRYPTION_SUPPORT},none)
1159$(if ${BL31}, $(eval $(call TOOL_ADD_IMG,bl31,--soc-fw,,$(ENCRYPT_BL31))),\
1160	$(eval $(call MAKE_BL,31,soc-fw,,$(ENCRYPT_BL31))))
1161else
1162$(if ${BL31}, $(eval $(call TOOL_ADD_IMG,bl31,--soc-fw)),\
1163	$(eval $(call MAKE_BL,31,soc-fw)))
1164endif
1165endif
1166
1167# If a BL32 image is needed but neither BL32 nor BL32_SOURCES is defined, the
1168# build system will call TOOL_ADD_IMG to print a warning message and abort the
1169# process. Note that the dependency on BL32 applies to the FIP only.
1170ifeq (${NEED_BL32},yes)
1171# Sort BL32 source files to remove duplicates
1172BL32_SOURCES := $(sort ${BL32_SOURCES})
1173BUILD_BL32 := $(if $(BL32),,$(if $(BL32_SOURCES),1))
1174
1175ifneq (${DECRYPTION_SUPPORT},none)
1176$(if ${BUILD_BL32}, $(eval $(call MAKE_BL,32,tos-fw,,$(ENCRYPT_BL32))),\
1177	$(eval $(call TOOL_ADD_IMG,bl32,--tos-fw,,$(ENCRYPT_BL32))))
1178else
1179$(if ${BUILD_BL32}, $(eval $(call MAKE_BL,32,tos-fw)),\
1180	$(eval $(call TOOL_ADD_IMG,bl32,--tos-fw)))
1181endif
1182endif
1183
1184# Add the BL33 image if required by the platform
1185ifeq (${NEED_BL33},yes)
1186$(eval $(call TOOL_ADD_IMG,bl33,--nt-fw))
1187endif
1188
1189ifeq (${NEED_BL2U},yes)
1190$(if ${BL2U}, $(eval $(call TOOL_ADD_IMG,bl2u,--ap-fwu-cfg,FWU_)),\
1191	$(eval $(call MAKE_BL,2u,ap-fwu-cfg,FWU_)))
1192endif
1193
1194# Expand build macros for the different images
1195ifeq (${NEED_FDT},yes)
1196    $(eval $(call MAKE_DTBS,$(BUILD_PLAT)/fdts,$(FDT_SOURCES)))
1197endif
1198
1199# Add Secure Partition packages
1200ifeq (${NEED_SP_PKG},yes)
1201$(BUILD_PLAT)/sp_gen.mk: ${SP_MK_GEN} ${SP_LAYOUT_FILE} | ${BUILD_PLAT}
1202	${Q}${PYTHON} "$<" "$@" $(filter-out $<,$^) $(BUILD_PLAT) ${COT}
1203sp: $(SPTOOL) $(DTBS) $(BUILD_PLAT)/sp_gen.mk
1204	${Q}$(SPTOOL) $(SPTOOL_ARGS)
1205	@${ECHO_BLANK_LINE}
1206	@echo "Built SP Images successfully"
1207	@${ECHO_BLANK_LINE}
1208endif
1209
1210locate-checkpatch:
1211ifndef CHECKPATCH
1212	$(error "Please set CHECKPATCH to point to the Linux checkpatch.pl file, eg: CHECKPATCH=../linux/scripts/checkpatch.pl")
1213else
1214ifeq (,$(wildcard ${CHECKPATCH}))
1215	$(error "The file CHECKPATCH points to cannot be found, use eg: CHECKPATCH=../linux/scripts/checkpatch.pl")
1216endif
1217endif
1218
1219clean:
1220	@echo "  CLEAN"
1221	$(call SHELL_REMOVE_DIR,${BUILD_PLAT})
1222ifdef UNIX_MK
1223	${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH} clean
1224else
1225# Clear the MAKEFLAGS as we do not want
1226# to pass the gnumake flags to nmake.
1227	${Q}set MAKEFLAGS= && ${MSVC_NMAKE} /nologo /f ${FIPTOOLPATH}/Makefile.msvc FIPTOOLPATH=$(subst /,\,$(FIPTOOLPATH)) FIPTOOL=$(subst /,\,$(FIPTOOL)) clean
1228endif
1229	${Q}${MAKE} PLAT=${PLAT} --no-print-directory -C ${CRTTOOLPATH} clean
1230	${Q}${MAKE} PLAT=${PLAT} --no-print-directory -C ${ENCTOOLPATH} clean
1231	${Q}${MAKE} --no-print-directory -C ${ROMLIBPATH} clean
1232
1233realclean distclean:
1234	@echo "  REALCLEAN"
1235	$(call SHELL_REMOVE_DIR,${BUILD_BASE})
1236	$(call SHELL_DELETE_ALL, ${CURDIR}/cscope.*)
1237ifdef UNIX_MK
1238	${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH} clean
1239else
1240# Clear the MAKEFLAGS as we do not want
1241# to pass the gnumake flags to nmake.
1242	${Q}set MAKEFLAGS= && ${MSVC_NMAKE} /nologo /f ${FIPTOOLPATH}/Makefile.msvc FIPTOOLPATH=$(subst /,\,$(FIPTOOLPATH)) FIPTOOL=$(subst /,\,$(FIPTOOL)) realclean
1243endif
1244	${Q}${MAKE} --no-print-directory -C ${SPTOOLPATH} clean
1245	${Q}${MAKE} PLAT=${PLAT} --no-print-directory -C ${CRTTOOLPATH} clean
1246	${Q}${MAKE} PLAT=${PLAT} --no-print-directory -C ${ENCTOOLPATH} realclean
1247	${Q}${MAKE} --no-print-directory -C ${ROMLIBPATH} clean
1248
1249checkcodebase:		locate-checkpatch
1250	@echo "  CHECKING STYLE"
1251	@if test -d .git ; then						\
1252		git ls-files | grep -E -v 'libfdt|libc|docs|\.rst' |	\
1253		while read GIT_FILE ;					\
1254		do ${CHECKPATCH} ${CHECKCODE_ARGS} -f $$GIT_FILE ;	\
1255		done ;							\
1256	else								\
1257		 find . -type f -not -iwholename "*.git*"		\
1258		 -not -iwholename "*build*"				\
1259		 -not -iwholename "*libfdt*"				\
1260		 -not -iwholename "*libc*"				\
1261		 -not -iwholename "*docs*"				\
1262		 -not -iwholename "*.rst"				\
1263		 -exec ${CHECKPATCH} ${CHECKCODE_ARGS} -f {} \; ;	\
1264	fi
1265
1266checkpatch:		locate-checkpatch
1267	@echo "  CHECKING STYLE"
1268	@if test -n "${CHECKPATCH_OPTS}"; then				\
1269		echo "    with ${CHECKPATCH_OPTS} option(s)";		\
1270	fi
1271	${Q}COMMON_COMMIT=$$(git merge-base HEAD ${BASE_COMMIT});	\
1272	for commit in `git rev-list $$COMMON_COMMIT..HEAD`; do		\
1273		printf "\n[*] Checking style of '$$commit'\n\n";	\
1274		git log --format=email "$$commit~..$$commit"		\
1275			-- ${CHECK_PATHS} |				\
1276			${CHECKPATCH} ${CHECKPATCH_OPTS} - || true;	\
1277		git diff --format=email "$$commit~..$$commit"		\
1278			-- ${CHECK_PATHS} |				\
1279			${CHECKPATCH}  ${CHECKPATCH_OPTS} - || true;	\
1280	done
1281
1282certtool: ${CRTTOOL}
1283
1284${CRTTOOL}: FORCE
1285	${Q}${MAKE} PLAT=${PLAT} USE_TBBR_DEFS=${USE_TBBR_DEFS} COT=${COT} OPENSSL_DIR=${OPENSSL_DIR} CRTTOOL=${CRTTOOL} --no-print-directory -C ${CRTTOOLPATH}
1286	@${ECHO_BLANK_LINE}
1287	@echo "Built $@ successfully"
1288	@${ECHO_BLANK_LINE}
1289
1290ifneq (${GENERATE_COT},0)
1291certificates: ${CRT_DEPS} ${CRTTOOL}
1292	${Q}${CRTTOOL} ${CRT_ARGS}
1293	@${ECHO_BLANK_LINE}
1294	@echo "Built $@ successfully"
1295	@echo "Certificates can be found in ${BUILD_PLAT}"
1296	@${ECHO_BLANK_LINE}
1297endif
1298
1299${BUILD_PLAT}/${FIP_NAME}: ${FIP_DEPS} ${FIPTOOL}
1300	$(eval ${CHECK_FIP_CMD})
1301	${Q}${FIPTOOL} create ${FIP_ARGS} $@
1302	${Q}${FIPTOOL} info $@
1303	@${ECHO_BLANK_LINE}
1304	@echo "Built $@ successfully"
1305	@${ECHO_BLANK_LINE}
1306
1307ifneq (${GENERATE_COT},0)
1308fwu_certificates: ${FWU_CRT_DEPS} ${CRTTOOL}
1309	${Q}${CRTTOOL} ${FWU_CRT_ARGS}
1310	@${ECHO_BLANK_LINE}
1311	@echo "Built $@ successfully"
1312	@echo "FWU certificates can be found in ${BUILD_PLAT}"
1313	@${ECHO_BLANK_LINE}
1314endif
1315
1316${BUILD_PLAT}/${FWU_FIP_NAME}: ${FWU_FIP_DEPS} ${FIPTOOL}
1317	$(eval ${CHECK_FWU_FIP_CMD})
1318	${Q}${FIPTOOL} create ${FWU_FIP_ARGS} $@
1319	${Q}${FIPTOOL} info $@
1320	@${ECHO_BLANK_LINE}
1321	@echo "Built $@ successfully"
1322	@${ECHO_BLANK_LINE}
1323
1324fiptool: ${FIPTOOL}
1325fip: ${BUILD_PLAT}/${FIP_NAME}
1326fwu_fip: ${BUILD_PLAT}/${FWU_FIP_NAME}
1327
1328${FIPTOOL}: FORCE
1329ifdef UNIX_MK
1330	${Q}${MAKE} CPPFLAGS="-DVERSION='\"${VERSION_STRING}\"'" FIPTOOL=${FIPTOOL} --no-print-directory -C ${FIPTOOLPATH}
1331else
1332# Clear the MAKEFLAGS as we do not want
1333# to pass the gnumake flags to nmake.
1334	${Q}set MAKEFLAGS= && ${MSVC_NMAKE} /nologo /f ${FIPTOOLPATH}/Makefile.msvc FIPTOOLPATH=$(subst /,\,$(FIPTOOLPATH)) FIPTOOL=$(subst /,\,$(FIPTOOL))
1335endif
1336
1337sptool: ${SPTOOL}
1338${SPTOOL}: FORCE
1339	${Q}${MAKE} CPPFLAGS="-DVERSION='\"${VERSION_STRING}\"'" SPTOOL=${SPTOOL} --no-print-directory -C ${SPTOOLPATH}
1340
1341romlib.bin: libraries FORCE
1342	${Q}${MAKE} PLAT_DIR=${PLAT_DIR} BUILD_PLAT=${BUILD_PLAT} ENABLE_BTI=${ENABLE_BTI} ARM_ARCH_MINOR=${ARM_ARCH_MINOR} INCLUDES='${INCLUDES}' DEFINES='${DEFINES}' --no-print-directory -C ${ROMLIBPATH} all
1343
1344# Call print_memory_map tool
1345memmap: all
1346	${Q}${PYTHON} ${PRINT_MEMORY_MAP} ${BUILD_PLAT} ${INVERTED_MEMMAP}
1347
1348doc:
1349	@echo "  BUILD DOCUMENTATION"
1350	${Q}${MAKE} --no-print-directory -C ${DOCS_PATH} html
1351
1352enctool: ${ENCTOOL}
1353
1354${ENCTOOL}: FORCE
1355	${Q}${MAKE} PLAT=${PLAT} BUILD_INFO=0 OPENSSL_DIR=${OPENSSL_DIR} ENCTOOL=${ENCTOOL} --no-print-directory -C ${ENCTOOLPATH}
1356	@${ECHO_BLANK_LINE}
1357	@echo "Built $@ successfully"
1358	@${ECHO_BLANK_LINE}
1359
1360cscope:
1361	@echo "  CSCOPE"
1362	${Q}find ${CURDIR} -name "*.[chsS]" > cscope.files
1363	${Q}cscope -b -q -k
1364
1365help:
1366	@echo "usage: ${MAKE} [PLAT=<platform>] [OPTIONS] [TARGET]"
1367	@echo ""
1368	@echo "PLAT is used to specify which platform you wish to build."
1369	@echo "If no platform is specified, PLAT defaults to: ${DEFAULT_PLAT}"
1370	@echo ""
1371	@echo "platform = ${PLATFORM_LIST}"
1372	@echo ""
1373	@echo "Please refer to the User Guide for a list of all supported options."
1374	@echo "Note that the build system doesn't track dependencies for build "
1375	@echo "options. Therefore, if any of the build options are changed "
1376	@echo "from a previous build, a clean build must be performed."
1377	@echo ""
1378	@echo "Supported Targets:"
1379	@echo "  all            Build all individual bootloader binaries"
1380	@echo "  bl1            Build the BL1 binary"
1381	@echo "  bl2            Build the BL2 binary"
1382	@echo "  bl2u           Build the BL2U binary"
1383	@echo "  bl31           Build the BL31 binary"
1384	@echo "  bl32           Build the BL32 binary. If ARCH=aarch32, then "
1385	@echo "                 this builds secure payload specified by AARCH32_SP"
1386	@echo "  certificates   Build the certificates (requires 'GENERATE_COT=1')"
1387	@echo "  fip            Build the Firmware Image Package (FIP)"
1388	@echo "  fwu_fip        Build the FWU Firmware Image Package (FIP)"
1389	@echo "  checkcodebase  Check the coding style of the entire source tree"
1390	@echo "  checkpatch     Check the coding style on changes in the current"
1391	@echo "                 branch against BASE_COMMIT (default origin/master)"
1392	@echo "  clean          Clean the build for the selected platform"
1393	@echo "  cscope         Generate cscope index"
1394	@echo "  distclean      Remove all build artifacts for all platforms"
1395	@echo "  certtool       Build the Certificate generation tool"
1396	@echo "  enctool        Build the Firmware encryption tool"
1397	@echo "  fiptool        Build the Firmware Image Package (FIP) creation tool"
1398	@echo "  sp             Build the Secure Partition Packages"
1399	@echo "  sptool         Build the Secure Partition Package creation tool"
1400	@echo "  dtbs           Build the Device Tree Blobs (if required for the platform)"
1401	@echo "  memmap         Print the memory map of the built binaries"
1402	@echo "  doc            Build html based documentation using Sphinx tool"
1403	@echo ""
1404	@echo "Note: most build targets require PLAT to be set to a specific platform."
1405	@echo ""
1406	@echo "example: build all targets for the FVP platform:"
1407	@echo "  CROSS_COMPILE=aarch64-none-elf- make PLAT=fvp all"
1408
1409.PHONY: FORCE
1410FORCE:;
1411