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