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