xref: /rk3399_ARM-atf/Makefile (revision feb358b65151f7c4d6656a4ee52199f205798ce8)
1#
2# Copyright (c) 2013-2020, 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			:= 2
12
13# Default goal is build all images
14.DEFAULT_GOAL			:= all
15
16# Avoid any implicit propagation of command line variable definitions to
17# sub-Makefiles, like CFLAGS that we reserved for the firmware images'
18# usage. Other command line options like "-s" are still propagated as usual.
19MAKEOVERRIDES =
20
21MAKE_HELPERS_DIRECTORY := make_helpers/
22include ${MAKE_HELPERS_DIRECTORY}build_macros.mk
23include ${MAKE_HELPERS_DIRECTORY}build_env.mk
24
25################################################################################
26# Default values for build configurations, and their dependencies
27################################################################################
28
29include ${MAKE_HELPERS_DIRECTORY}defaults.mk
30
31# Assertions enabled for DEBUG builds by default
32ENABLE_ASSERTIONS		:= ${DEBUG}
33ENABLE_PMF			:= ${ENABLE_RUNTIME_INSTRUMENTATION}
34PLAT				:= ${DEFAULT_PLAT}
35
36################################################################################
37# Checkpatch script options
38################################################################################
39
40CHECKCODE_ARGS		:=	--no-patch
41# Do not check the coding style on imported library files or documentation files
42INC_LIB_DIRS_TO_CHECK	:=	$(sort $(filter-out			\
43					include/lib/libfdt		\
44					include/lib/libc,		\
45					$(wildcard include/lib/*)))
46INC_DIRS_TO_CHECK	:=	$(sort $(filter-out			\
47					include/lib,			\
48					$(wildcard include/*)))
49LIB_DIRS_TO_CHECK	:=	$(sort $(filter-out			\
50					lib/compiler-rt			\
51					lib/libfdt%			\
52					lib/libc,			\
53					$(wildcard lib/*)))
54ROOT_DIRS_TO_CHECK	:=	$(sort $(filter-out			\
55					lib				\
56					include				\
57					docs				\
58					%.rst,				\
59					$(wildcard *)))
60CHECK_PATHS		:=	${ROOT_DIRS_TO_CHECK}			\
61				${INC_DIRS_TO_CHECK}			\
62				${INC_LIB_DIRS_TO_CHECK}		\
63				${LIB_DIRS_TO_CHECK}
64
65
66################################################################################
67# Process build options
68################################################################################
69
70# Verbose flag
71ifeq (${V},0)
72        Q:=@
73        ECHO:=@echo
74        CHECKCODE_ARGS	+=	--no-summary --terse
75else
76        Q:=
77        ECHO:=$(ECHO_QUIET)
78endif
79
80ifneq ($(findstring s,$(filter-out --%,$(MAKEFLAGS))),)
81        Q:=@
82        ECHO:=$(ECHO_QUIET)
83endif
84
85export Q ECHO
86
87# Process Debug flag
88$(eval $(call add_define,DEBUG))
89ifneq (${DEBUG}, 0)
90        BUILD_TYPE	:=	debug
91        TF_CFLAGS	+= 	-g
92
93        ifneq ($(findstring clang,$(notdir $(CC))),)
94             ASFLAGS		+= 	-g
95        else
96             ASFLAGS		+= 	-g -Wa,--gdwarf-2
97        endif
98
99        # Use LOG_LEVEL_INFO by default for debug builds
100        LOG_LEVEL	:=	40
101else
102        BUILD_TYPE	:=	release
103        # Use LOG_LEVEL_NOTICE by default for release builds
104        LOG_LEVEL	:=	20
105endif
106
107# Default build string (git branch and commit)
108ifeq (${BUILD_STRING},)
109        BUILD_STRING	:=	$(shell git describe --always --dirty --tags 2> /dev/null)
110endif
111VERSION_STRING		:=	v${VERSION_MAJOR}.${VERSION_MINOR}(${BUILD_TYPE}):${BUILD_STRING}
112
113# The cert_create tool cannot generate certificates individually, so we use the
114# target 'certificates' to create them all
115ifneq (${GENERATE_COT},0)
116        FIP_DEPS += certificates
117        FWU_FIP_DEPS += fwu_certificates
118endif
119
120# Process BRANCH_PROTECTION value and set
121# Pointer Authentication and Branch Target Identification flags
122ifeq (${BRANCH_PROTECTION},0)
123	# Default value turns off all types of branch protection
124	BP_OPTION := none
125else ifneq (${ARCH},aarch64)
126        $(error BRANCH_PROTECTION requires AArch64)
127else ifeq (${BRANCH_PROTECTION},1)
128	# Enables all types of branch protection features
129	BP_OPTION := standard
130	ENABLE_BTI := 1
131	ENABLE_PAUTH := 1
132else ifeq (${BRANCH_PROTECTION},2)
133	# Return address signing to its standard level
134	BP_OPTION := pac-ret
135	ENABLE_PAUTH := 1
136else ifeq (${BRANCH_PROTECTION},3)
137	# Extend the signing to include leaf functions
138	BP_OPTION := pac-ret+leaf
139	ENABLE_PAUTH := 1
140else
141        $(error Unknown BRANCH_PROTECTION value ${BRANCH_PROTECTION})
142endif
143
144# USE_SPINLOCK_CAS requires AArch64 build
145ifeq (${USE_SPINLOCK_CAS},1)
146ifneq (${ARCH},aarch64)
147        $(error USE_SPINLOCK_CAS requires AArch64)
148else
149        $(info USE_SPINLOCK_CAS is an experimental feature)
150endif
151endif
152
153# USE_DEBUGFS experimental feature recommended only in debug builds
154ifeq (${USE_DEBUGFS},1)
155ifeq (${DEBUG},1)
156        $(warning DEBUGFS experimental feature is enabled.)
157else
158        $(warning DEBUGFS experimental, recommended in DEBUG builds ONLY)
159endif
160endif
161
162################################################################################
163# Toolchain
164################################################################################
165
166HOSTCC			:=	gcc
167export HOSTCC
168
169CC			:=	${CROSS_COMPILE}gcc
170CPP			:=	${CROSS_COMPILE}cpp
171AS			:=	${CROSS_COMPILE}gcc
172AR			:=	${CROSS_COMPILE}ar
173LINKER			:=	${CROSS_COMPILE}ld
174OC			:=	${CROSS_COMPILE}objcopy
175OD			:=	${CROSS_COMPILE}objdump
176NM			:=	${CROSS_COMPILE}nm
177PP			:=	${CROSS_COMPILE}gcc -E
178DTC			:=	dtc
179
180# Use ${LD}.bfd instead if it exists (as absolute path or together with $PATH).
181ifneq ($(strip $(wildcard ${LD}.bfd) \
182	$(foreach dir,$(subst :, ,${PATH}),$(wildcard ${dir}/${LINKER}.bfd))),)
183LINKER			:=	${LINKER}.bfd
184endif
185
186ifeq (${ARM_ARCH_MAJOR},7)
187target32-directive	= 	-target arm-none-eabi
188# Will set march32-directive from platform configuration
189else
190target32-directive	= 	-target armv8a-none-eabi
191
192# Set the compiler's target architecture profile based on ARM_ARCH_MINOR option
193ifeq (${ARM_ARCH_MINOR},0)
194march32-directive	= 	-march=armv8-a
195march64-directive	= 	-march=armv8-a
196else
197march32-directive	= 	-march=armv8.${ARM_ARCH_MINOR}-a
198march64-directive	= 	-march=armv8.${ARM_ARCH_MINOR}-a
199endif
200endif
201
202ifneq ($(findstring armclang,$(notdir $(CC))),)
203TF_CFLAGS_aarch32	=	-target arm-arm-none-eabi $(march32-directive)
204TF_CFLAGS_aarch64	=	-target aarch64-arm-none-eabi $(march64-directive)
205LD			=	$(LINKER)
206AS			=	$(CC) -c -x assembler-with-cpp $(TF_CFLAGS_$(ARCH))
207CPP			=	$(CC) -E $(TF_CFLAGS_$(ARCH))
208PP			=	$(CC) -E $(TF_CFLAGS_$(ARCH))
209else ifneq ($(findstring clang,$(notdir $(CC))),)
210TF_CFLAGS_aarch32	=	$(target32-directive) $(march32-directive)
211TF_CFLAGS_aarch64	=	-target aarch64-elf $(march64-directive)
212LD			=	$(LINKER)
213AS			=	$(CC) -c -x assembler-with-cpp $(TF_CFLAGS_$(ARCH))
214CPP			=	$(CC) -E
215PP			=	$(CC) -E
216else ifneq ($(findstring gcc,$(notdir $(CC))),)
217TF_CFLAGS_aarch32	=	$(march32-directive)
218TF_CFLAGS_aarch64	=	$(march64-directive)
219ifeq ($(ENABLE_LTO),1)
220	# Enable LTO only for aarch64
221	ifeq (${ARCH},aarch64)
222		LTO_CFLAGS	=	-flto
223		# Use gcc as a wrapper for the ld, recommended for LTO
224		LINKER		:=	${CROSS_COMPILE}gcc
225	endif
226endif
227LD			=	$(LINKER)
228else
229TF_CFLAGS_aarch32	=	$(march32-directive)
230TF_CFLAGS_aarch64	=	$(march64-directive)
231LD			=	$(LINKER)
232endif
233
234ifeq (${AARCH32_INSTRUCTION_SET},A32)
235TF_CFLAGS_aarch32	+=	-marm
236else ifeq (${AARCH32_INSTRUCTION_SET},T32)
237TF_CFLAGS_aarch32	+=	-mthumb
238else
239$(error Error: Unknown AArch32 instruction set ${AARCH32_INSTRUCTION_SET})
240endif
241
242TF_CFLAGS_aarch32	+=	-mno-unaligned-access
243TF_CFLAGS_aarch64	+=	-mgeneral-regs-only -mstrict-align
244
245ifneq (${BP_OPTION},none)
246TF_CFLAGS_aarch64	+=	-mbranch-protection=${BP_OPTION}
247endif
248
249ASFLAGS_aarch32		=	$(march32-directive)
250ASFLAGS_aarch64		=	$(march64-directive)
251
252# General warnings
253WARNINGS		:=	-Wall -Wmissing-include-dirs -Wunused	\
254				-Wdisabled-optimization	-Wvla -Wshadow	\
255				-Wno-unused-parameter
256
257# Additional warnings
258# Level 1
259WARNING1 := -Wextra
260WARNING1 += -Wmissing-format-attribute
261WARNING1 += -Wmissing-prototypes
262WARNING1 += -Wold-style-definition
263
264# Level 2
265WARNING2 := -Waggregate-return
266WARNING2 += -Wcast-align
267WARNING2 += -Wnested-externs
268
269WARNING3 := -Wbad-function-cast
270WARNING3 += -Wcast-qual
271WARNING3 += -Wconversion
272WARNING3 += -Wpacked
273WARNING3 += -Wpointer-arith
274WARNING3 += -Wredundant-decls
275WARNING3 += -Wswitch-default
276
277ifeq (${W},1)
278WARNINGS += $(WARNING1)
279else ifeq (${W},2)
280WARNINGS += $(WARNING1) $(WARNING2)
281else ifeq (${W},3)
282WARNINGS += $(WARNING1) $(WARNING2) $(WARNING3)
283endif
284
285# Compiler specific warnings
286ifeq ($(findstring clang,$(notdir $(CC))),)
287# not using clang
288WARNINGS	+=		-Wunused-but-set-variable -Wmaybe-uninitialized	\
289				-Wpacked-bitfield-compat -Wshift-overflow=2 \
290				-Wlogical-op
291else
292# using clang
293WARNINGS	+=		-Wshift-overflow -Wshift-sign-overflow \
294				-Wlogical-op-parentheses
295endif
296
297ifneq (${E},0)
298ERRORS := -Werror
299endif
300
301CPPFLAGS		=	${DEFINES} ${INCLUDES} ${MBEDTLS_INC} -nostdinc	\
302				$(ERRORS) $(WARNINGS)
303ASFLAGS			+=	$(CPPFLAGS) $(ASFLAGS_$(ARCH))			\
304				-ffreestanding -Wa,--fatal-warnings
305TF_CFLAGS		+=	$(CPPFLAGS) $(TF_CFLAGS_$(ARCH))		\
306				-ffunction-sections -fdata-sections		\
307				-ffreestanding -fno-builtin -fno-common		\
308				-Os -std=gnu99
309
310ifeq (${SANITIZE_UB},on)
311TF_CFLAGS		+=	-fsanitize=undefined -fno-sanitize-recover
312endif
313ifeq (${SANITIZE_UB},trap)
314TF_CFLAGS		+=	-fsanitize=undefined -fno-sanitize-recover	\
315				-fsanitize-undefined-trap-on-error
316endif
317
318GCC_V_OUTPUT		:=	$(shell $(CC) -v 2>&1)
319
320ifneq ($(findstring armlink,$(notdir $(LD))),)
321TF_LDFLAGS		+=	--diag_error=warning --lto_level=O1
322TF_LDFLAGS		+=	--remove --info=unused,unusedsymbols
323TF_LDFLAGS		+=	$(TF_LDFLAGS_$(ARCH))
324else ifneq ($(findstring gcc,$(notdir $(LD))),)
325# Pass ld options with Wl or Xlinker switches
326TF_LDFLAGS		+=	-Wl,--fatal-warnings -O1
327TF_LDFLAGS		+=	-Wl,--gc-sections
328ifeq ($(ENABLE_LTO),1)
329	ifeq (${ARCH},aarch64)
330		TF_LDFLAGS	+=	-flto -fuse-linker-plugin
331	endif
332endif
333# GCC automatically adds fix-cortex-a53-843419 flag when used to link
334# which breaks some builds, so disable if errata fix is not explicitly enabled
335ifneq (${ERRATA_A53_843419},1)
336	TF_LDFLAGS	+= 	-mno-fix-cortex-a53-843419
337endif
338TF_LDFLAGS		+= 	-nostdlib
339TF_LDFLAGS		+=	$(subst --,-Xlinker --,$(TF_LDFLAGS_$(ARCH)))
340else
341TF_LDFLAGS		+=	--fatal-warnings -O1
342TF_LDFLAGS		+=	--gc-sections
343TF_LDFLAGS		+=	$(TF_LDFLAGS_$(ARCH))
344endif
345
346DTC_FLAGS		+=	-I dts -O dtb
347DTC_CPPFLAGS		+=	-P -nostdinc -Iinclude -Ifdts -undef -x assembler-with-cpp
348
349################################################################################
350# Common sources and include directories
351################################################################################
352include lib/compiler-rt/compiler-rt.mk
353
354BL_COMMON_SOURCES	+=	common/bl_common.c			\
355				common/tf_log.c				\
356				common/${ARCH}/debug.S			\
357				drivers/console/multi_console.c		\
358				lib/${ARCH}/cache_helpers.S		\
359				lib/${ARCH}/misc_helpers.S		\
360				plat/common/plat_bl_common.c		\
361				plat/common/plat_log_common.c		\
362				plat/common/${ARCH}/plat_common.c	\
363				plat/common/${ARCH}/platform_helpers.S	\
364				${COMPILER_RT_SRCS}
365
366ifeq ($(notdir $(CC)),armclang)
367BL_COMMON_SOURCES	+=	lib/${ARCH}/armclang_printf.S
368endif
369
370ifeq (${SANITIZE_UB},on)
371BL_COMMON_SOURCES	+=	plat/common/ubsan.c
372endif
373
374INCLUDES		+=	-Iinclude				\
375				-Iinclude/arch/${ARCH}			\
376				-Iinclude/lib/cpus/${ARCH}		\
377				-Iinclude/lib/el3_runtime/${ARCH}	\
378				${PLAT_INCLUDES}			\
379				${SPD_INCLUDES}
380
381include common/backtrace/backtrace.mk
382
383################################################################################
384# Generic definitions
385################################################################################
386
387include ${MAKE_HELPERS_DIRECTORY}plat_helpers.mk
388
389BUILD_BASE		:=	./build
390BUILD_PLAT		:=	${BUILD_BASE}/${PLAT}/${BUILD_TYPE}
391
392SPDS			:=	$(sort $(filter-out none, $(patsubst services/spd/%,%,$(wildcard services/spd/*))))
393
394# Platforms providing their own TBB makefile may override this value
395INCLUDE_TBBR_MK		:=	1
396
397
398################################################################################
399# Include SPD Makefile if one has been specified
400################################################################################
401
402ifneq (${SPD},none)
403ifeq (${ARCH},aarch32)
404        $(error "Error: SPD is incompatible with AArch32.")
405endif
406ifdef EL3_PAYLOAD_BASE
407        $(warning "SPD and EL3_PAYLOAD_BASE are incompatible build options.")
408        $(warning "The SPD and its BL32 companion will be present but ignored.")
409endif
410        # We expect to locate an spd.mk under the specified SPD directory
411        SPD_MAKE	:=	$(wildcard services/spd/${SPD}/${SPD}.mk)
412
413        ifeq (${SPD_MAKE},)
414                $(error Error: No services/spd/${SPD}/${SPD}.mk located)
415        endif
416        $(info Including ${SPD_MAKE})
417        include ${SPD_MAKE}
418
419        # If there's BL32 companion for the chosen SPD, we expect that the SPD's
420        # Makefile would set NEED_BL32 to "yes". In this case, the build system
421        # supports two mutually exclusive options:
422        # * BL32 is built from source: then BL32_SOURCES must contain the list
423        #   of source files to build BL32
424        # * BL32 is a prebuilt binary: then BL32 must point to the image file
425        #   that will be included in the FIP
426        # If both BL32_SOURCES and BL32 are defined, the binary takes precedence
427        # over the sources.
428endif
429
430################################################################################
431# Include the platform specific Makefile after the SPD Makefile (the platform
432# makefile may use all previous definitions in this file)
433################################################################################
434
435include ${PLAT_MAKEFILE_FULL}
436
437$(eval $(call MAKE_PREREQ_DIR,${BUILD_PLAT}))
438
439ifeq (${ARM_ARCH_MAJOR},7)
440include make_helpers/armv7-a-cpus.mk
441endif
442
443ifeq ($(ENABLE_PIE),1)
444    TF_CFLAGS		+=	-fpie
445	ifneq ($(findstring gcc,$(notdir $(LD))),)
446		TF_LDFLAGS	+=	-Wl,-pie -Wl,--no-dynamic-linker
447	else
448		TF_LDFLAGS	+=	-pie --no-dynamic-linker
449	endif
450else
451    PIE_FOUND		:=	$(findstring --enable-default-pie,${GCC_V_OUTPUT})
452    ifneq ($(PIE_FOUND),)
453        TF_CFLAGS		+=	-fno-PIE
454    endif
455endif
456
457# Include the CPU specific operations makefile, which provides default
458# values for all CPU errata workarounds and CPU specific optimisations.
459# This can be overridden by the platform.
460include lib/cpus/cpu-ops.mk
461
462ifeq (${ARCH},aarch32)
463NEED_BL32 := yes
464
465################################################################################
466# Build `AARCH32_SP` as BL32 image for AArch32
467################################################################################
468ifneq (${AARCH32_SP},none)
469# We expect to locate an sp.mk under the specified AARCH32_SP directory
470AARCH32_SP_MAKE	:=	$(wildcard bl32/${AARCH32_SP}/${AARCH32_SP}.mk)
471
472ifeq (${AARCH32_SP_MAKE},)
473  $(error Error: No bl32/${AARCH32_SP}/${AARCH32_SP}.mk located)
474endif
475
476$(info Including ${AARCH32_SP_MAKE})
477include ${AARCH32_SP_MAKE}
478endif
479
480endif
481
482################################################################################
483# Include libc if not overridden
484################################################################################
485ifeq (${OVERRIDE_LIBC},0)
486include lib/libc/libc.mk
487endif
488
489################################################################################
490# Check incompatible options
491################################################################################
492
493ifdef EL3_PAYLOAD_BASE
494        ifdef PRELOADED_BL33_BASE
495                $(warning "PRELOADED_BL33_BASE and EL3_PAYLOAD_BASE are \
496                incompatible build options. EL3_PAYLOAD_BASE has priority.")
497        endif
498        ifneq (${GENERATE_COT},0)
499                $(error "GENERATE_COT and EL3_PAYLOAD_BASE are incompatible build options.")
500        endif
501        ifneq (${TRUSTED_BOARD_BOOT},0)
502                $(error "TRUSTED_BOARD_BOOT and EL3_PAYLOAD_BASE are incompatible build options.")
503        endif
504endif
505
506ifeq (${NEED_BL33},yes)
507        ifdef EL3_PAYLOAD_BASE
508                $(warning "BL33 image is not needed when option \
509                BL33_PAYLOAD_BASE is used and won't be added to the FIP file.")
510        endif
511        ifdef PRELOADED_BL33_BASE
512                $(warning "BL33 image is not needed when option \
513                PRELOADED_BL33_BASE is used and won't be added to the FIP \
514                file.")
515        endif
516endif
517
518# When building for systems with hardware-assisted coherency, there's no need to
519# use USE_COHERENT_MEM. Require that USE_COHERENT_MEM must be set to 0 too.
520ifeq ($(HW_ASSISTED_COHERENCY)-$(USE_COHERENT_MEM),1-1)
521$(error USE_COHERENT_MEM cannot be enabled with HW_ASSISTED_COHERENCY)
522endif
523
524#For now, BL2_IN_XIP_MEM is only supported when BL2_AT_EL3 is 1.
525ifeq ($(BL2_AT_EL3)-$(BL2_IN_XIP_MEM),0-1)
526$(error "BL2_IN_XIP_MEM is only supported when BL2_AT_EL3 is enabled")
527endif
528
529# For RAS_EXTENSION, require that EAs are handled in EL3 first
530ifeq ($(RAS_EXTENSION),1)
531    ifneq ($(HANDLE_EA_EL3_FIRST),1)
532        $(error For RAS_EXTENSION, HANDLE_EA_EL3_FIRST must also be 1)
533    endif
534endif
535
536# When FAULT_INJECTION_SUPPORT is used, require that RAS_EXTENSION is enabled
537ifeq ($(FAULT_INJECTION_SUPPORT),1)
538    ifneq ($(RAS_EXTENSION),1)
539        $(error For FAULT_INJECTION_SUPPORT, RAS_EXTENSION must also be 1)
540    endif
541endif
542
543# DYN_DISABLE_AUTH can be set only when TRUSTED_BOARD_BOOT=1
544ifeq ($(DYN_DISABLE_AUTH), 1)
545    ifeq (${TRUSTED_BOARD_BOOT}, 0)
546        $(error "TRUSTED_BOARD_BOOT must be enabled for DYN_DISABLE_AUTH to be set.")
547    endif
548endif
549
550# If pointer authentication is used in the firmware, make sure that all the
551# registers associated to it are also saved and restored.
552# Not doing it would leak the value of the keys used by EL3 to EL1 and S-EL1.
553ifeq ($(ENABLE_PAUTH),1)
554    ifeq ($(CTX_INCLUDE_PAUTH_REGS),0)
555        $(error Pointer Authentication requires CTX_INCLUDE_PAUTH_REGS=1)
556    endif
557endif
558
559ifeq ($(CTX_INCLUDE_PAUTH_REGS),1)
560    ifneq (${ARCH},aarch64)
561        $(error CTX_INCLUDE_PAUTH_REGS requires AArch64)
562    else
563        $(info CTX_INCLUDE_PAUTH_REGS is an experimental feature)
564    endif
565endif
566
567ifeq ($(ENABLE_PAUTH),1)
568    $(info Pointer Authentication is an experimental feature)
569endif
570
571ifeq ($(ENABLE_BTI),1)
572    $(info Branch Protection is an experimental feature)
573endif
574
575ifeq ($(CTX_INCLUDE_MTE_REGS),1)
576    ifneq (${ARCH},aarch64)
577        $(error CTX_INCLUDE_MTE_REGS requires AArch64)
578    else
579        $(info CTX_INCLUDE_MTE_REGS is an experimental feature)
580    endif
581endif
582
583################################################################################
584# Process platform overrideable behaviour
585################################################################################
586
587# Using BL2 implies that a BL33 image also needs to be supplied for the FIP and
588# Certificate generation tools. This flag can be overridden by the platform.
589ifdef BL2_SOURCES
590        ifdef EL3_PAYLOAD_BASE
591                # If booting an EL3 payload there is no need for a BL33 image
592                # in the FIP file.
593                NEED_BL33		:=	no
594        else
595                ifdef PRELOADED_BL33_BASE
596                        # If booting a BL33 preloaded image there is no need of
597                        # another one in the FIP file.
598                        NEED_BL33		:=	no
599                else
600                        NEED_BL33		?=	yes
601                endif
602        endif
603endif
604
605# If SCP_BL2 is given, we always want FIP to include it.
606ifdef SCP_BL2
607        NEED_SCP_BL2		:=	yes
608endif
609
610# For AArch32, BL31 is not currently supported.
611ifneq (${ARCH},aarch32)
612    ifdef BL31_SOURCES
613        # When booting an EL3 payload, there is no need to compile the BL31 image nor
614        # put it in the FIP.
615        ifndef EL3_PAYLOAD_BASE
616            NEED_BL31 := yes
617        endif
618    endif
619endif
620
621# Process TBB related flags
622ifneq (${GENERATE_COT},0)
623        # Common cert_create options
624        ifneq (${CREATE_KEYS},0)
625                $(eval CRT_ARGS += -n)
626                $(eval FWU_CRT_ARGS += -n)
627                ifneq (${SAVE_KEYS},0)
628                        $(eval CRT_ARGS += -k)
629                        $(eval FWU_CRT_ARGS += -k)
630                endif
631        endif
632        # Include TBBR makefile (unless the platform indicates otherwise)
633        ifeq (${INCLUDE_TBBR_MK},1)
634                include make_helpers/tbbr/tbbr_tools.mk
635        endif
636endif
637
638ifneq (${FIP_ALIGN},0)
639FIP_ARGS += --align ${FIP_ALIGN}
640endif
641
642################################################################################
643# Include libraries' Makefile that are used in all BL
644################################################################################
645
646include lib/stack_protector/stack_protector.mk
647
648################################################################################
649# Auxiliary tools (fiptool, cert_create, etc)
650################################################################################
651
652# Variables for use with Certificate Generation Tool
653CRTTOOLPATH		?=	tools/cert_create
654CRTTOOL			?=	${CRTTOOLPATH}/cert_create${BIN_EXT}
655
656# Variables for use with Firmware Image Package
657FIPTOOLPATH		?=	tools/fiptool
658FIPTOOL			?=	${FIPTOOLPATH}/fiptool${BIN_EXT}
659
660# Variables for use with sptool
661SPTOOLPATH		?=	tools/sptool
662SPTOOL			?=	${SPTOOLPATH}/sptool${BIN_EXT}
663
664# Variables for use with ROMLIB
665ROMLIBPATH		?=	lib/romlib
666
667# Variable for use with Python
668PYTHON			?=	python3
669
670# Variables for use with PRINT_MEMORY_MAP
671PRINT_MEMORY_MAP_PATH		?=	tools/memory
672PRINT_MEMORY_MAP		?=	${PRINT_MEMORY_MAP_PATH}/print_memory_map.py
673
674################################################################################
675# Include BL specific makefiles
676################################################################################
677ifdef BL1_SOURCES
678NEED_BL1 := yes
679include bl1/bl1.mk
680endif
681
682ifdef BL2_SOURCES
683NEED_BL2 := yes
684include bl2/bl2.mk
685endif
686
687ifdef BL2U_SOURCES
688NEED_BL2U := yes
689include bl2u/bl2u.mk
690endif
691
692ifeq (${NEED_BL31},yes)
693ifdef BL31_SOURCES
694include bl31/bl31.mk
695endif
696endif
697
698ifdef FDT_SOURCES
699NEED_FDT := yes
700endif
701
702################################################################################
703# Build options checks
704################################################################################
705
706$(eval $(call assert_boolean,COLD_BOOT_SINGLE_CPU))
707$(eval $(call assert_boolean,CREATE_KEYS))
708$(eval $(call assert_boolean,CTX_INCLUDE_AARCH32_REGS))
709$(eval $(call assert_boolean,CTX_INCLUDE_FPREGS))
710$(eval $(call assert_boolean,CTX_INCLUDE_PAUTH_REGS))
711$(eval $(call assert_boolean,CTX_INCLUDE_MTE_REGS))
712$(eval $(call assert_boolean,DEBUG))
713$(eval $(call assert_boolean,DYN_DISABLE_AUTH))
714$(eval $(call assert_boolean,EL3_EXCEPTION_HANDLING))
715$(eval $(call assert_boolean,ENABLE_AMU))
716$(eval $(call assert_boolean,ENABLE_ASSERTIONS))
717$(eval $(call assert_boolean,ENABLE_MPAM_FOR_LOWER_ELS))
718$(eval $(call assert_boolean,ENABLE_PIE))
719$(eval $(call assert_boolean,ENABLE_PMF))
720$(eval $(call assert_boolean,ENABLE_PSCI_STAT))
721$(eval $(call assert_boolean,ENABLE_RUNTIME_INSTRUMENTATION))
722$(eval $(call assert_boolean,ENABLE_SPE_FOR_LOWER_ELS))
723$(eval $(call assert_boolean,ENABLE_SVE_FOR_NS))
724$(eval $(call assert_boolean,ERROR_DEPRECATED))
725$(eval $(call assert_boolean,FAULT_INJECTION_SUPPORT))
726$(eval $(call assert_boolean,GENERATE_COT))
727$(eval $(call assert_boolean,GICV2_G0_FOR_EL3))
728$(eval $(call assert_boolean,HANDLE_EA_EL3_FIRST))
729$(eval $(call assert_boolean,HW_ASSISTED_COHERENCY))
730$(eval $(call assert_boolean,NS_TIMER_SWITCH))
731$(eval $(call assert_boolean,OVERRIDE_LIBC))
732$(eval $(call assert_boolean,PL011_GENERIC_UART))
733$(eval $(call assert_boolean,PROGRAMMABLE_RESET_ADDRESS))
734$(eval $(call assert_boolean,PSCI_EXTENDED_STATE_ID))
735$(eval $(call assert_boolean,RAS_EXTENSION))
736$(eval $(call assert_boolean,RESET_TO_BL31))
737$(eval $(call assert_boolean,SAVE_KEYS))
738$(eval $(call assert_boolean,SEPARATE_CODE_AND_RODATA))
739$(eval $(call assert_boolean,SEPARATE_NOBITS_REGION))
740$(eval $(call assert_boolean,SPIN_ON_BL1_EXIT))
741$(eval $(call assert_boolean,SPM_MM))
742$(eval $(call assert_boolean,TRUSTED_BOARD_BOOT))
743$(eval $(call assert_boolean,USE_COHERENT_MEM))
744$(eval $(call assert_boolean,USE_DEBUGFS))
745$(eval $(call assert_boolean,USE_ROMLIB))
746$(eval $(call assert_boolean,USE_TBBR_DEFS))
747$(eval $(call assert_boolean,WARMBOOT_ENABLE_DCACHE_EARLY))
748$(eval $(call assert_boolean,BL2_AT_EL3))
749$(eval $(call assert_boolean,BL2_IN_XIP_MEM))
750$(eval $(call assert_boolean,BL2_INV_DCACHE))
751$(eval $(call assert_boolean,USE_SPINLOCK_CAS))
752
753$(eval $(call assert_numeric,ARM_ARCH_MAJOR))
754$(eval $(call assert_numeric,ARM_ARCH_MINOR))
755$(eval $(call assert_numeric,BRANCH_PROTECTION))
756
757ifdef KEY_SIZE
758        $(eval $(call assert_numeric,KEY_SIZE))
759endif
760
761ifeq ($(filter $(SANITIZE_UB), on off trap),)
762        $(error "Invalid value for SANITIZE_UB: can be one of on, off, trap")
763endif
764
765################################################################################
766# Add definitions to the cpp preprocessor based on the current build options.
767# This is done after including the platform specific makefile to allow the
768# platform to overwrite the default options
769################################################################################
770
771$(eval $(call add_define,ARM_ARCH_MAJOR))
772$(eval $(call add_define,ARM_ARCH_MINOR))
773$(eval $(call add_define,COLD_BOOT_SINGLE_CPU))
774$(eval $(call add_define,CTX_INCLUDE_AARCH32_REGS))
775$(eval $(call add_define,CTX_INCLUDE_FPREGS))
776$(eval $(call add_define,CTX_INCLUDE_PAUTH_REGS))
777$(eval $(call add_define,EL3_EXCEPTION_HANDLING))
778$(eval $(call add_define,CTX_INCLUDE_MTE_REGS))
779$(eval $(call add_define,ENABLE_AMU))
780$(eval $(call add_define,ENABLE_ASSERTIONS))
781$(eval $(call add_define,ENABLE_BTI))
782$(eval $(call add_define,ENABLE_MPAM_FOR_LOWER_ELS))
783$(eval $(call add_define,ENABLE_PAUTH))
784$(eval $(call add_define,ENABLE_PIE))
785$(eval $(call add_define,ENABLE_PMF))
786$(eval $(call add_define,ENABLE_PSCI_STAT))
787$(eval $(call add_define,ENABLE_RUNTIME_INSTRUMENTATION))
788$(eval $(call add_define,ENABLE_SPE_FOR_LOWER_ELS))
789$(eval $(call add_define,ENABLE_SVE_FOR_NS))
790$(eval $(call add_define,ERROR_DEPRECATED))
791$(eval $(call add_define,FAULT_INJECTION_SUPPORT))
792$(eval $(call add_define,GICV2_G0_FOR_EL3))
793$(eval $(call add_define,HANDLE_EA_EL3_FIRST))
794$(eval $(call add_define,HW_ASSISTED_COHERENCY))
795$(eval $(call add_define,LOG_LEVEL))
796$(eval $(call add_define,NS_TIMER_SWITCH))
797$(eval $(call add_define,PL011_GENERIC_UART))
798$(eval $(call add_define,PLAT_${PLAT}))
799$(eval $(call add_define,PROGRAMMABLE_RESET_ADDRESS))
800$(eval $(call add_define,PSCI_EXTENDED_STATE_ID))
801$(eval $(call add_define,RAS_EXTENSION))
802$(eval $(call add_define,RESET_TO_BL31))
803$(eval $(call add_define,SEPARATE_CODE_AND_RODATA))
804$(eval $(call add_define,SEPARATE_NOBITS_REGION))
805$(eval $(call add_define,RECLAIM_INIT_CODE))
806$(eval $(call add_define,SPD_${SPD}))
807$(eval $(call add_define,SPIN_ON_BL1_EXIT))
808$(eval $(call add_define,SPM_MM))
809$(eval $(call add_define,TRUSTED_BOARD_BOOT))
810$(eval $(call add_define,USE_COHERENT_MEM))
811$(eval $(call add_define,USE_DEBUGFS))
812$(eval $(call add_define,USE_ROMLIB))
813$(eval $(call add_define,USE_TBBR_DEFS))
814$(eval $(call add_define,WARMBOOT_ENABLE_DCACHE_EARLY))
815$(eval $(call add_define,BL2_AT_EL3))
816$(eval $(call add_define,BL2_IN_XIP_MEM))
817$(eval $(call add_define,BL2_INV_DCACHE))
818$(eval $(call add_define,USE_SPINLOCK_CAS))
819
820ifeq (${SANITIZE_UB},trap)
821        $(eval $(call add_define,MONITOR_TRAPS))
822endif
823
824# Define the EL3_PAYLOAD_BASE flag only if it is provided.
825ifdef EL3_PAYLOAD_BASE
826        $(eval $(call add_define,EL3_PAYLOAD_BASE))
827else
828        # Define the PRELOADED_BL33_BASE flag only if it is provided and
829        # EL3_PAYLOAD_BASE is not defined, as it has priority.
830        ifdef PRELOADED_BL33_BASE
831                $(eval $(call add_define,PRELOADED_BL33_BASE))
832        endif
833endif
834
835# Define the DYN_DISABLE_AUTH flag only if set.
836ifeq (${DYN_DISABLE_AUTH},1)
837$(eval $(call add_define,DYN_DISABLE_AUTH))
838endif
839
840ifneq ($(findstring armlink,$(notdir $(LD))),)
841$(eval $(call add_define,USE_ARM_LINK))
842endif
843
844################################################################################
845# Build targets
846################################################################################
847
848.PHONY:	all msg_start clean realclean distclean cscope locate-checkpatch checkcodebase checkpatch fiptool sptool fip fwu_fip certtool dtbs memmap
849.SUFFIXES:
850
851all: msg_start
852
853msg_start:
854	@echo "Building ${PLAT}"
855
856ifeq (${ERROR_DEPRECATED},0)
857# Check if deprecated declarations and cpp warnings should be treated as error or not.
858ifneq ($(findstring clang,$(notdir $(CC))),)
859    CPPFLAGS		+= 	-Wno-error=deprecated-declarations
860else
861    CPPFLAGS		+= 	-Wno-error=deprecated-declarations -Wno-error=cpp
862endif
863# __ASSEMBLY__ is deprecated in favor of the compiler-builtin __ASSEMBLER__.
864ASFLAGS	+= -D__ASSEMBLY__
865# AARCH32/AARCH64 macros are deprecated in favor of the compiler-builtin __aarch64__.
866ifeq (${ARCH},aarch32)
867        $(eval $(call add_define,AARCH32))
868else
869        $(eval $(call add_define,AARCH64))
870endif
871endif # !ERROR_DEPRECATED
872
873$(eval $(call MAKE_LIB_DIRS))
874$(eval $(call MAKE_LIB,c))
875
876# Expand build macros for the different images
877ifeq (${NEED_BL1},yes)
878$(eval $(call MAKE_BL,1))
879endif
880
881ifeq (${NEED_BL2},yes)
882ifeq (${BL2_AT_EL3}, 0)
883FIP_BL2_ARGS := tb-fw
884endif
885
886$(if ${BL2}, $(eval $(call TOOL_ADD_IMG,bl2,--${FIP_BL2_ARGS})),\
887	$(eval $(call MAKE_BL,2,${FIP_BL2_ARGS})))
888endif
889
890ifeq (${NEED_SCP_BL2},yes)
891$(eval $(call TOOL_ADD_IMG,scp_bl2,--scp-fw))
892endif
893
894ifeq (${NEED_BL31},yes)
895BL31_SOURCES += ${SPD_SOURCES}
896$(if ${BL31}, $(eval $(call TOOL_ADD_IMG,bl31,--soc-fw)),\
897	$(eval $(call MAKE_BL,31,soc-fw)))
898endif
899
900# If a BL32 image is needed but neither BL32 nor BL32_SOURCES is defined, the
901# build system will call TOOL_ADD_IMG to print a warning message and abort the
902# process. Note that the dependency on BL32 applies to the FIP only.
903ifeq (${NEED_BL32},yes)
904
905BUILD_BL32 := $(if $(BL32),,$(if $(BL32_SOURCES),1))
906
907$(if ${BUILD_BL32}, $(eval $(call MAKE_BL,32,tos-fw)),\
908	$(eval $(call TOOL_ADD_IMG,bl32,--tos-fw)))
909endif
910
911# Add the BL33 image if required by the platform
912ifeq (${NEED_BL33},yes)
913$(eval $(call TOOL_ADD_IMG,bl33,--nt-fw))
914endif
915
916ifeq (${NEED_BL2U},yes)
917$(if ${BL2U}, $(eval $(call TOOL_ADD_IMG,bl2u,--ap-fwu-cfg,FWU_)),\
918	$(eval $(call MAKE_BL,2u,ap-fwu-cfg,FWU_)))
919endif
920
921# Expand build macros for the different images
922ifeq (${NEED_FDT},yes)
923    $(eval $(call MAKE_DTBS,$(BUILD_PLAT)/fdts,$(FDT_SOURCES)))
924endif
925
926locate-checkpatch:
927ifndef CHECKPATCH
928	$(error "Please set CHECKPATCH to point to the Linux checkpatch.pl file, eg: CHECKPATCH=../linux/scripts/checkpatch.pl")
929else
930ifeq (,$(wildcard ${CHECKPATCH}))
931	$(error "The file CHECKPATCH points to cannot be found, use eg: CHECKPATCH=../linux/scripts/checkpatch.pl")
932endif
933endif
934
935clean:
936	@echo "  CLEAN"
937	$(call SHELL_REMOVE_DIR,${BUILD_PLAT})
938	${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH} clean
939	${Q}${MAKE} PLAT=${PLAT} --no-print-directory -C ${CRTTOOLPATH} clean
940	${Q}${MAKE} --no-print-directory -C ${ROMLIBPATH} clean
941
942realclean distclean:
943	@echo "  REALCLEAN"
944	$(call SHELL_REMOVE_DIR,${BUILD_BASE})
945	$(call SHELL_DELETE_ALL, ${CURDIR}/cscope.*)
946	${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH} clean
947	${Q}${MAKE} --no-print-directory -C ${SPTOOLPATH} clean
948	${Q}${MAKE} PLAT=${PLAT} --no-print-directory -C ${CRTTOOLPATH} clean
949	${Q}${MAKE} --no-print-directory -C ${ROMLIBPATH} clean
950
951checkcodebase:		locate-checkpatch
952	@echo "  CHECKING STYLE"
953	@if test -d .git ; then						\
954		git ls-files | grep -E -v 'libfdt|libc|docs|\.rst' |	\
955		while read GIT_FILE ;					\
956		do ${CHECKPATCH} ${CHECKCODE_ARGS} -f $$GIT_FILE ;	\
957		done ;							\
958	else								\
959		 find . -type f -not -iwholename "*.git*"		\
960		 -not -iwholename "*build*"				\
961		 -not -iwholename "*libfdt*"				\
962		 -not -iwholename "*libc*"				\
963		 -not -iwholename "*docs*"				\
964		 -not -iwholename "*.rst"				\
965		 -exec ${CHECKPATCH} ${CHECKCODE_ARGS} -f {} \; ;	\
966	fi
967
968checkpatch:		locate-checkpatch
969	@echo "  CHECKING STYLE"
970	@if test -n "${CHECKPATCH_OPTS}"; then				\
971		echo "    with ${CHECKPATCH_OPTS} option(s)";		\
972	fi
973	${Q}COMMON_COMMIT=$$(git merge-base HEAD ${BASE_COMMIT});	\
974	for commit in `git rev-list $$COMMON_COMMIT..HEAD`; do		\
975		printf "\n[*] Checking style of '$$commit'\n\n";	\
976		git log --format=email "$$commit~..$$commit"		\
977			-- ${CHECK_PATHS} |				\
978			${CHECKPATCH} ${CHECKPATCH_OPTS} - || true;	\
979		git diff --format=email "$$commit~..$$commit"		\
980			-- ${CHECK_PATHS} |				\
981			${CHECKPATCH}  ${CHECKPATCH_OPTS} - || true;	\
982	done
983
984certtool: ${CRTTOOL}
985
986.PHONY: ${CRTTOOL}
987${CRTTOOL}:
988	${Q}${MAKE} PLAT=${PLAT} USE_TBBR_DEFS=${USE_TBBR_DEFS} --no-print-directory -C ${CRTTOOLPATH}
989	@${ECHO_BLANK_LINE}
990	@echo "Built $@ successfully"
991	@${ECHO_BLANK_LINE}
992
993ifneq (${GENERATE_COT},0)
994certificates: ${CRT_DEPS} ${CRTTOOL}
995	${Q}${CRTTOOL} ${CRT_ARGS}
996	@${ECHO_BLANK_LINE}
997	@echo "Built $@ successfully"
998	@echo "Certificates can be found in ${BUILD_PLAT}"
999	@${ECHO_BLANK_LINE}
1000endif
1001
1002${BUILD_PLAT}/${FIP_NAME}: ${FIP_DEPS} ${FIPTOOL}
1003	${Q}${FIPTOOL} create ${FIP_ARGS} $@
1004	${Q}${FIPTOOL} info $@
1005	@${ECHO_BLANK_LINE}
1006	@echo "Built $@ successfully"
1007	@${ECHO_BLANK_LINE}
1008
1009ifneq (${GENERATE_COT},0)
1010fwu_certificates: ${FWU_CRT_DEPS} ${CRTTOOL}
1011	${Q}${CRTTOOL} ${FWU_CRT_ARGS}
1012	@${ECHO_BLANK_LINE}
1013	@echo "Built $@ successfully"
1014	@echo "FWU certificates can be found in ${BUILD_PLAT}"
1015	@${ECHO_BLANK_LINE}
1016endif
1017
1018${BUILD_PLAT}/${FWU_FIP_NAME}: ${FWU_FIP_DEPS} ${FIPTOOL}
1019	${Q}${FIPTOOL} create ${FWU_FIP_ARGS} $@
1020	${Q}${FIPTOOL} info $@
1021	@${ECHO_BLANK_LINE}
1022	@echo "Built $@ successfully"
1023	@${ECHO_BLANK_LINE}
1024
1025fiptool: ${FIPTOOL}
1026fip: ${BUILD_PLAT}/${FIP_NAME}
1027fwu_fip: ${BUILD_PLAT}/${FWU_FIP_NAME}
1028
1029.PHONY: ${FIPTOOL}
1030${FIPTOOL}:
1031	${Q}${MAKE} CPPFLAGS="-DVERSION='\"${VERSION_STRING}\"'" --no-print-directory -C ${FIPTOOLPATH}
1032
1033sptool: ${SPTOOL}
1034.PHONY: ${SPTOOL}
1035${SPTOOL}:
1036	${Q}${MAKE} CPPFLAGS="-DVERSION='\"${VERSION_STRING}\"'" --no-print-directory -C ${SPTOOLPATH}
1037
1038.PHONY: libraries
1039romlib.bin: libraries
1040	${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
1041
1042# Call print_memory_map tool
1043memmap: all
1044	${Q}${PYTHON} $(PRINT_MEMORY_MAP) $(BUILD_PLAT)
1045
1046cscope:
1047	@echo "  CSCOPE"
1048	${Q}find ${CURDIR} -name "*.[chsS]" > cscope.files
1049	${Q}cscope -b -q -k
1050
1051help:
1052	@echo "usage: ${MAKE} [PLAT=<platform>] [OPTIONS] [TARGET]"
1053	@echo ""
1054	@echo "PLAT is used to specify which platform you wish to build."
1055	@echo "If no platform is specified, PLAT defaults to: ${DEFAULT_PLAT}"
1056	@echo ""
1057	@echo "platform = ${PLATFORM_LIST}"
1058	@echo ""
1059	@echo "Please refer to the User Guide for a list of all supported options."
1060	@echo "Note that the build system doesn't track dependencies for build "
1061	@echo "options. Therefore, if any of the build options are changed "
1062	@echo "from a previous build, a clean build must be performed."
1063	@echo ""
1064	@echo "Supported Targets:"
1065	@echo "  all            Build all individual bootloader binaries"
1066	@echo "  bl1            Build the BL1 binary"
1067	@echo "  bl2            Build the BL2 binary"
1068	@echo "  bl2u           Build the BL2U binary"
1069	@echo "  bl31           Build the BL31 binary"
1070	@echo "  bl32           Build the BL32 binary. If ARCH=aarch32, then "
1071	@echo "                 this builds secure payload specified by AARCH32_SP"
1072	@echo "  certificates   Build the certificates (requires 'GENERATE_COT=1')"
1073	@echo "  fip            Build the Firmware Image Package (FIP)"
1074	@echo "  fwu_fip        Build the FWU Firmware Image Package (FIP)"
1075	@echo "  checkcodebase  Check the coding style of the entire source tree"
1076	@echo "  checkpatch     Check the coding style on changes in the current"
1077	@echo "                 branch against BASE_COMMIT (default origin/master)"
1078	@echo "  clean          Clean the build for the selected platform"
1079	@echo "  cscope         Generate cscope index"
1080	@echo "  distclean      Remove all build artifacts for all platforms"
1081	@echo "  certtool       Build the Certificate generation tool"
1082	@echo "  fiptool        Build the Firmware Image Package (FIP) creation tool"
1083	@echo "  sptool         Build the Secure Partition Package creation tool"
1084	@echo "  dtbs           Build the Device Tree Blobs (if required for the platform)"
1085	@echo "  memmap         Print the memory map of the built binaries"
1086	@echo ""
1087	@echo "Note: most build targets require PLAT to be set to a specific platform."
1088	@echo ""
1089	@echo "example: build all targets for the FVP platform:"
1090	@echo "  CROSS_COMPILE=aarch64-none-elf- make PLAT=fvp all"
1091