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