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