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