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