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