xref: /rk3399_ARM-atf/Makefile (revision 7e26fe1f05bb05ce6e0f95b9a44ada2a21d53dd3)
1#
2# Copyright (c) 2013-2015, ARM Limited and Contributors. All rights reserved.
3#
4# Redistribution and use in source and binary forms, with or without
5# modification, are permitted provided that the following conditions are met:
6#
7# Redistributions of source code must retain the above copyright notice, this
8# list of conditions and the following disclaimer.
9#
10# Redistributions in binary form must reproduce the above copyright notice,
11# this list of conditions and the following disclaimer in the documentation
12# and/or other materials provided with the distribution.
13#
14# Neither the name of ARM nor the names of its contributors may be used
15# to endorse or promote products derived from this software without specific
16# prior written permission.
17#
18# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28# POSSIBILITY OF SUCH DAMAGE.
29#
30
31#
32# Trusted Firmware Version
33#
34VERSION_MAJOR		:= 1
35VERSION_MINOR		:= 1
36
37#
38# Default values for build configurations
39#
40
41# Build verbosity
42V			:= 0
43# Debug build
44DEBUG			:= 0
45# Build platform
46DEFAULT_PLAT		:= fvp
47PLAT			:= ${DEFAULT_PLAT}
48# SPD choice
49SPD			:= none
50# Base commit to perform code check on
51BASE_COMMIT		:= origin/master
52# NS timer register save and restore
53NS_TIMER_SWITCH		:= 0
54# By default, Bl1 acts as the reset handler, not BL31
55RESET_TO_BL31		:= 0
56# Include FP registers in cpu context
57CTX_INCLUDE_FPREGS		:= 0
58# Determine the version of ARM GIC architecture to use for interrupt management
59# in EL3. The platform port can change this value if needed.
60ARM_GIC_ARCH		:=	2
61# Determine the version of ARM CCI product used in the platform. The platform
62# port can change this value if needed.
63ARM_CCI_PRODUCT_ID	:=	400
64# Flag used to indicate if ASM_ASSERTION should be enabled for the build.
65# This defaults to being present in DEBUG builds only.
66ASM_ASSERTION		:=	${DEBUG}
67# Build option to choose whether Trusted firmware uses Coherent memory or not.
68USE_COHERENT_MEM	:=	1
69# Flag used to choose the power state format viz Extended State-ID or the Original
70# format.
71PSCI_EXTENDED_STATE_ID	:=	0
72# Default FIP file name
73FIP_NAME		:= fip.bin
74# By default, use the -pedantic option in the gcc command line
75DISABLE_PEDANTIC	:= 0
76# Flags to generate the Chain of Trust
77GENERATE_COT		:= 0
78CREATE_KEYS		:= 1
79SAVE_KEYS		:= 0
80# Flags to build TF with Trusted Boot support
81TRUSTED_BOARD_BOOT	:= 0
82# By default, consider that the platform's reset address is not programmable.
83# The platform Makefile is free to override this value.
84PROGRAMMABLE_RESET_ADDRESS	:= 0
85# Build flag to warn about usage of deprecated platform and framework APIs
86WARN_DEPRECATED	:= 0
87
88# Checkpatch ignores
89CHECK_IGNORE		=	--ignore COMPLEX_MACRO \
90				--ignore GERRIT_CHANGE_ID \
91				--ignore GIT_COMMIT_ID
92
93CHECKPATCH_ARGS		=	--no-tree --no-signoff ${CHECK_IGNORE}
94CHECKCODE_ARGS		=	--no-patch --no-tree --no-signoff ${CHECK_IGNORE}
95# Do not check the coding style on C library files
96CHECK_PATHS		=	$(shell ls -I include -I lib) \
97				$(addprefix include/,$(shell ls -I stdlib include)) \
98				$(addprefix lib/,$(shell ls -I stdlib lib))
99
100ifeq (${V},0)
101	Q=@
102	CHECKCODE_ARGS	+=	--no-summary --terse
103else
104	Q=
105endif
106export Q
107
108ifneq (${DEBUG}, 0)
109	BUILD_TYPE	:=	debug
110	# Use LOG_LEVEL_INFO by default for debug builds
111	LOG_LEVEL	:=	40
112else
113	BUILD_TYPE	:=	release
114	# Use LOG_LEVEL_NOTICE by default for release builds
115	LOG_LEVEL	:=	20
116endif
117
118# Default build string (git branch and commit)
119ifeq (${BUILD_STRING},)
120	BUILD_STRING	:=	$(shell git log -n 1 --pretty=format:"%h")
121endif
122
123VERSION_STRING		:=	v${VERSION_MAJOR}.${VERSION_MINOR}(${BUILD_TYPE}):${BUILD_STRING}
124
125BL_COMMON_SOURCES	:=	common/bl_common.c			\
126				common/tf_printf.c			\
127				common/aarch64/debug.S			\
128				lib/aarch64/cache_helpers.S		\
129				lib/aarch64/misc_helpers.S		\
130				lib/aarch64/xlat_helpers.c		\
131				lib/stdlib/std.c			\
132				plat/common/aarch64/platform_helpers.S
133
134BUILD_BASE		:=	./build
135BUILD_PLAT		:=	${BUILD_BASE}/${PLAT}/${BUILD_TYPE}
136
137PLAT_MAKEFILE		:=	platform.mk
138# Generate the platforms list by recursively searching for all directories
139# under /plat containing a PLAT_MAKEFILE. Append each platform with a `|`
140# char and strip out the final '|'.
141PLATFORMS		:=	$(shell find plat/ -name '${PLAT_MAKEFILE}' -print0 |			\
142					sed -r 's%[^\x00]*\/([^/]*)\/${PLAT_MAKEFILE}\x00%\1|%g' |	\
143					sed -r 's/\|$$//')
144SPDS			:=	$(shell ls -I none services/spd)
145
146# Convenience function for adding build definitions
147# $(eval $(call add_define,FOO)) will have:
148# -DFOO if $(FOO) is empty; -DFOO=$(FOO) otherwise
149define add_define
150DEFINES			+=	-D$(1)$(if $(value $(1)),=$(value $(1)),)
151endef
152
153# Convenience function for verifying option has a boolean value
154# $(eval $(call assert_boolean,FOO)) will assert FOO is 0 or 1
155define assert_boolean
156$(and $(patsubst 0,,$(value $(1))),$(patsubst 1,,$(value $(1))),$(error $(1) must be boolean))
157endef
158
159ifeq (${PLAT},)
160  $(error "Error: Unknown platform. Please use PLAT=<platform name> to specify the platform")
161endif
162PLAT_MAKEFILE_FULL	:=	$(shell find plat/ -wholename '*/${PLAT}/${PLAT_MAKEFILE}')
163ifeq ($(PLAT_MAKEFILE_FULL),)
164  $(error "Error: Invalid platform. The following platforms are available: ${PLATFORMS}")
165endif
166
167all: msg_start
168
169msg_start:
170	@echo "Building ${PLAT}"
171
172include ${PLAT_MAKEFILE_FULL}
173
174# If the platform has not defined ENABLE_PLAT_COMPAT, then enable it by default
175ifndef ENABLE_PLAT_COMPAT
176ENABLE_PLAT_COMPAT := 1
177endif
178
179# Include the platform compatibility helpers for PSCI
180ifneq (${ENABLE_PLAT_COMPAT}, 0)
181include plat/compat/plat_compat.mk
182endif
183
184# Include the CPU specific operations makefile. By default all CPU errata
185# workarounds and CPU specifc optimisations are disabled. This can be
186# overridden by the platform.
187include lib/cpus/cpu-ops.mk
188
189ifdef BL1_SOURCES
190NEED_BL1 := yes
191include bl1/bl1.mk
192endif
193
194ifdef BL2_SOURCES
195NEED_BL2 := yes
196include bl2/bl2.mk
197# Using the ARM Trusted Firmware BL2 implies that a BL3-3 image also need to be supplied for the FIP.
198# This flag can be overridden by the platform.
199NEED_BL33 ?= yes
200endif
201
202ifdef BL31_SOURCES
203NEED_BL31 := yes
204include bl31/bl31.mk
205endif
206
207# Include SPD Makefile if one has been specified
208ifneq (${SPD},none)
209  # We expect to locate an spd.mk under the specified SPD directory
210  SPD_MAKE		:=	$(shell m="services/spd/${SPD}/${SPD}.mk"; [ -f "$$m" ] && echo "$$m")
211
212  ifeq (${SPD_MAKE},)
213    $(error Error: No services/spd/${SPD}/${SPD}.mk located)
214  endif
215  $(info Including ${SPD_MAKE})
216  include ${SPD_MAKE}
217
218  # If there's BL3-2 companion for the chosen SPD, and the SPD wants to build the
219  # BL3-2 from source, we expect that the SPD's Makefile would set NEED_BL32
220  # variable to "yes". In case the BL3-2 is a binary which needs to be included in
221  # fip, then the NEED_BL32 needs to be set and BL3-2 would need to point to the bin.
222endif
223
224.PHONY:			all msg_start clean realclean distclean cscope locate-checkpatch checkcodebase checkpatch fiptool fip certtool
225.SUFFIXES:
226
227INCLUDES		+=	-Iinclude/bl31			\
228				-Iinclude/bl31/services		\
229				-Iinclude/common		\
230				-Iinclude/drivers		\
231				-Iinclude/drivers/arm		\
232				-Iinclude/drivers/auth		\
233				-Iinclude/drivers/io		\
234				-Iinclude/drivers/ti/uart	\
235				-Iinclude/lib			\
236				-Iinclude/lib/aarch64		\
237				-Iinclude/lib/cpus/aarch64	\
238				-Iinclude/plat/common		\
239				-Iinclude/stdlib		\
240				-Iinclude/stdlib/sys		\
241				${PLAT_INCLUDES}		\
242				${SPD_INCLUDES}
243
244# Process DEBUG flag
245$(eval $(call assert_boolean,DEBUG))
246$(eval $(call add_define,DEBUG))
247ifeq (${DEBUG},0)
248  $(eval $(call add_define,NDEBUG))
249else
250CFLAGS			+= 	-g
251ASFLAGS			+= 	-g -Wa,--gdwarf-2
252endif
253
254# Process PLAT flag
255$(eval $(call add_define,PLAT_${PLAT}))
256
257# Process NS_TIMER_SWITCH flag
258$(eval $(call assert_boolean,NS_TIMER_SWITCH))
259$(eval $(call add_define,NS_TIMER_SWITCH))
260
261# Process RESET_TO_BL31 flag
262$(eval $(call assert_boolean,RESET_TO_BL31))
263$(eval $(call add_define,RESET_TO_BL31))
264
265# Process CTX_INCLUDE_FPREGS flag
266$(eval $(call assert_boolean,CTX_INCLUDE_FPREGS))
267$(eval $(call add_define,CTX_INCLUDE_FPREGS))
268
269# Process ARM_GIC_ARCH flag
270$(eval $(call add_define,ARM_GIC_ARCH))
271
272# Process ARM_CCI_PRODUCT_ID flag
273$(eval $(call add_define,ARM_CCI_PRODUCT_ID))
274
275# Process ASM_ASSERTION flag
276$(eval $(call assert_boolean,ASM_ASSERTION))
277$(eval $(call add_define,ASM_ASSERTION))
278
279# Process LOG_LEVEL flag
280$(eval $(call add_define,LOG_LEVEL))
281
282# Process USE_COHERENT_MEM flag
283$(eval $(call assert_boolean,USE_COHERENT_MEM))
284$(eval $(call add_define,USE_COHERENT_MEM))
285
286# Process PSCI_EXTENDED_STATE_ID flag
287$(eval $(call assert_boolean,PSCI_EXTENDED_STATE_ID))
288$(eval $(call add_define,PSCI_EXTENDED_STATE_ID))
289
290# Process Generate CoT flags
291$(eval $(call assert_boolean,GENERATE_COT))
292$(eval $(call assert_boolean,CREATE_KEYS))
293$(eval $(call assert_boolean,SAVE_KEYS))
294
295# Process TRUSTED_BOARD_BOOT flag
296$(eval $(call assert_boolean,TRUSTED_BOARD_BOOT))
297$(eval $(call add_define,TRUSTED_BOARD_BOOT))
298
299# Process PROGRAMMABLE_RESET_ADDRESS flag
300$(eval $(call assert_boolean,PROGRAMMABLE_RESET_ADDRESS))
301$(eval $(call add_define,PROGRAMMABLE_RESET_ADDRESS))
302
303# Process ENABLE_PLAT_COMPAT flag
304$(eval $(call assert_boolean,ENABLE_PLAT_COMPAT))
305$(eval $(call add_define,ENABLE_PLAT_COMPAT))
306
307# Process WARN_DEPRECATED flag
308$(eval $(call assert_boolean,WARN_DEPRECATED))
309$(eval $(call add_define,WARN_DEPRECATED))
310
311ASFLAGS			+= 	-nostdinc -ffreestanding -Wa,--fatal-warnings	\
312				-Werror -Wmissing-include-dirs			\
313				-mgeneral-regs-only -D__ASSEMBLY__		\
314				${DEFINES} ${INCLUDES}
315CFLAGS			+= 	-nostdinc -ffreestanding -Wall			\
316				-Werror -Wmissing-include-dirs			\
317				-mgeneral-regs-only -std=c99 -c -Os		\
318				${DEFINES} ${INCLUDES}
319CFLAGS			+=	-ffunction-sections -fdata-sections
320
321LDFLAGS			+=	--fatal-warnings -O1
322LDFLAGS			+=	--gc-sections
323
324
325CC			:=	${CROSS_COMPILE}gcc
326CPP			:=	${CROSS_COMPILE}cpp
327AS			:=	${CROSS_COMPILE}gcc
328AR			:=	${CROSS_COMPILE}ar
329LD			:=	${CROSS_COMPILE}ld
330OC			:=	${CROSS_COMPILE}objcopy
331OD			:=	${CROSS_COMPILE}objdump
332NM			:=	${CROSS_COMPILE}nm
333PP			:=	${CROSS_COMPILE}gcc -E ${CFLAGS}
334
335# Variables for use with Firmware Image Package
336FIPTOOLPATH		?=	tools/fip_create
337FIPTOOL			?=	${FIPTOOLPATH}/fip_create
338fiptool:		${FIPTOOL}
339fip:			${BUILD_PLAT}/${FIP_NAME}
340
341# Variables for use with Certificate Generation Tool
342CRTTOOLPATH		?=	tools/cert_create
343CRTTOOL			?=	${CRTTOOLPATH}/cert_create
344certtool:		${CRTTOOL}
345
346# CoT generation tool default parameters
347TRUSTED_KEY_CERT	:=	${BUILD_PLAT}/trusted_key.crt
348
349# Pass the private keys to the CoT generation tool in the command line
350# If CREATE_KEYS is set, the '-n' option will be added, indicating the tool to create new keys
351ifneq (${GENERATE_COT},0)
352    $(eval CERTS := yes)
353
354    $(eval FIP_DEPS += certificates)
355    $(eval FIP_ARGS += --trusted-key-cert ${TRUSTED_KEY_CERT})
356
357    ifneq (${CREATE_KEYS},0)
358        $(eval CRT_ARGS += -n)
359        ifneq (${SAVE_KEYS},0)
360            $(eval CRT_ARGS += -k)
361        endif
362    endif
363    $(eval CRT_ARGS += $(if ${ROT_KEY}, --rot-key ${ROT_KEY}))
364    $(eval CRT_ARGS += $(if ${TRUSTED_WORLD_KEY}, --trusted-world-key ${TRUSTED_WORLD_KEY}))
365    $(eval CRT_ARGS += $(if ${NON_TRUSTED_WORLD_KEY}, --non-trusted-world-key ${NON_TRUSTED_WORLD_KEY}))
366    $(eval CRT_ARGS += --trusted-key-cert ${TRUSTED_KEY_CERT})
367    $(eval CRT_ARGS += $(if ${KEY_ALG}, --key-alg ${KEY_ALG}))
368endif
369
370# Check if -pedantic option should be used
371ifeq (${DISABLE_PEDANTIC},0)
372    CFLAGS		+= 	-pedantic
373endif
374
375locate-checkpatch:
376ifndef CHECKPATCH
377	$(error "Please set CHECKPATCH to point to the Linux checkpatch.pl file, eg: CHECKPATCH=../linux/script/checkpatch.pl")
378else
379ifeq (,$(wildcard ${CHECKPATCH}))
380	$(error "The file CHECKPATCH points to cannot be found, use eg: CHECKPATCH=../linux/script/checkpatch.pl")
381endif
382endif
383
384clean:
385			@echo "  CLEAN"
386			${Q}rm -rf ${BUILD_PLAT}
387			${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH} clean
388			${Q}${MAKE} PLAT=${PLAT} --no-print-directory -C ${CRTTOOLPATH} clean
389
390realclean distclean:
391			@echo "  REALCLEAN"
392			${Q}rm -rf ${BUILD_BASE}
393			${Q}rm -f ${CURDIR}/cscope.*
394			${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH} clean
395			${Q}${MAKE} PLAT=${PLAT} --no-print-directory -C ${CRTTOOLPATH} clean
396
397checkcodebase:		locate-checkpatch
398			@echo "  CHECKING STYLE"
399			@if test -d .git ; then	\
400				git ls-files | grep -v stdlib | while read GIT_FILE ; do ${CHECKPATCH} ${CHECKCODE_ARGS} -f $$GIT_FILE ; done ;	\
401			 else			\
402				 find . -type f -not -iwholename "*.git*" -not -iwholename "*build*" -not -iwholename "*stdlib*" -exec ${CHECKPATCH} ${CHECKCODE_ARGS} -f {} \; ;	\
403			 fi
404
405checkpatch:		locate-checkpatch
406			@echo "  CHECKING STYLE"
407			${Q}git log -p ${BASE_COMMIT}..HEAD -- ${CHECK_PATHS} | ${CHECKPATCH} ${CHECKPATCH_ARGS} - || true
408
409.PHONY: ${CRTTOOL}
410${CRTTOOL}:
411			${Q}${MAKE} PLAT=${PLAT} --no-print-directory -C ${CRTTOOLPATH}
412			@echo
413			@echo "Built $@ successfully"
414			@echo
415
416.PHONY: ${FIPTOOL}
417${FIPTOOL}:
418			${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH}
419
420define match_goals
421$(strip $(foreach goal,$(1),$(filter $(goal),$(MAKECMDGOALS))))
422endef
423
424# List of rules that involve building things
425BUILD_TARGETS := all bl1 bl2 bl31 bl32 fip
426
427# Does the list of goals specified on the command line include a build target?
428ifneq ($(call match_goals,${BUILD_TARGETS}),)
429IS_ANYTHING_TO_BUILD := 1
430endif
431
432define MAKE_C
433
434$(eval OBJ := $(1)/$(patsubst %.c,%.o,$(notdir $(2))))
435$(eval PREREQUISITES := $(patsubst %.o,%.d,$(OBJ)))
436
437$(OBJ) : $(2)
438	@echo "  CC      $$<"
439	$$(Q)$$(CC) $$(CFLAGS) -DIMAGE_BL$(3) -c $$< -o $$@
440
441
442$(PREREQUISITES) : $(2)
443	@echo "  DEPS    $$@"
444	@mkdir -p $(1)
445	$$(Q)$$(CC) $$(CFLAGS) -M -MT $(OBJ) -MF $$@ $$<
446
447ifdef IS_ANYTHING_TO_BUILD
448-include $(PREREQUISITES)
449endif
450
451endef
452
453
454define MAKE_S
455
456$(eval OBJ := $(1)/$(patsubst %.S,%.o,$(notdir $(2))))
457$(eval PREREQUISITES := $(patsubst %.o,%.d,$(OBJ)))
458
459$(OBJ) : $(2)
460	@echo "  AS      $$<"
461	$$(Q)$$(AS) $$(ASFLAGS) -DIMAGE_BL$(3) -c $$< -o $$@
462
463$(PREREQUISITES) : $(2)
464	@echo "  DEPS    $$@"
465	@mkdir -p $(1)
466	$$(Q)$$(AS) $$(ASFLAGS) -M -MT $(OBJ) -MF $$@ $$<
467
468ifdef IS_ANYTHING_TO_BUILD
469-include $(PREREQUISITES)
470endif
471
472endef
473
474
475define MAKE_LD
476
477$(eval PREREQUISITES := $(1).d)
478
479$(1) : $(2)
480	@echo "  PP      $$<"
481	$$(Q)$$(AS) $$(ASFLAGS) -P -E -D__LINKER__ -o $$@ $$<
482
483$(PREREQUISITES) : $(2)
484	@echo "  DEPS    $$@"
485	@mkdir -p $$(dir $$@)
486	$$(Q)$$(AS) $$(ASFLAGS) -M -MT $(1) -MF $$@ $$<
487
488ifdef IS_ANYTHING_TO_BUILD
489-include $(PREREQUISITES)
490endif
491
492endef
493
494
495define MAKE_OBJS
496	$(eval C_OBJS := $(filter %.c,$(2)))
497	$(eval REMAIN := $(filter-out %.c,$(2)))
498	$(eval $(foreach obj,$(C_OBJS),$(call MAKE_C,$(1),$(obj),$(3))))
499
500	$(eval S_OBJS := $(filter %.S,$(REMAIN)))
501	$(eval REMAIN := $(filter-out %.S,$(REMAIN)))
502	$(eval $(foreach obj,$(S_OBJS),$(call MAKE_S,$(1),$(obj),$(3))))
503
504	$(and $(REMAIN),$(error Unexpected source files present: $(REMAIN)))
505endef
506
507
508# NOTE: The line continuation '\' is required in the next define otherwise we
509# end up with a line-feed characer at the end of the last c filename.
510# Also bare this issue in mind if extending the list of supported filetypes.
511define SOURCES_TO_OBJS
512	$(notdir $(patsubst %.c,%.o,$(filter %.c,$(1)))) \
513	$(notdir $(patsubst %.S,%.o,$(filter %.S,$(1))))
514endef
515
516
517# MAKE_TOOL_ARGS macro defines the command line arguments for the FIP and CRT
518# tools at each BL stage. Arguments:
519#   $(1) = BL stage (2, 30, 31, 32, 33)
520#   $(2) = Binary file
521#   $(3) = In FIP (false if empty)
522#   $(4) = Create certificates (false if empty)
523#   $(5) = Create key certificate (false if empty)
524#   $(6) = Private key (optional)
525define MAKE_TOOL_ARGS
526
527$(eval FIP_DEPS += $(if $3,$(2),))
528$(eval FIP_ARGS += $(if $3,--bl$(1) $(2),))
529$(eval FIP_ARGS += $(if $4,--bl$(1)-cert $(BUILD_PLAT)/bl$(1).crt))
530$(eval FIP_ARGS += $(if $4,$(if $5,--bl$(1)-key-cert $(BUILD_PLAT)/bl$(1)_key.crt)))
531
532$(eval CRT_DEPS += $(if $4,$(2),))
533$(eval CRT_ARGS += $(if $4,--bl$(1) $(2)))
534$(eval CRT_ARGS += $(if $4,$(if $6,--bl$(1)-key $(6))))
535$(eval CRT_ARGS += $(if $4,--bl$(1)-cert $(BUILD_PLAT)/bl$(1).crt))
536$(eval CRT_ARGS += $(if $4,$(if $5,--bl$(1)-key-cert $(BUILD_PLAT)/bl$(1)_key.crt)))
537
538endef
539
540
541# MAKE_BL macro defines the targets and options to build each BL image.
542# Arguments:
543#   $(1) = BL stage (2, 30, 31, 32, 33)
544#   $(2) = In FIP (false if empty)
545#   $(3) = Create certificates (false if empty)
546#   $(4) = Create key certificate (false if empty)
547#   $(5) = Private key (optional)
548define MAKE_BL
549	$(eval BUILD_DIR  := ${BUILD_PLAT}/bl$(1))
550	$(eval SOURCES    := $(BL$(1)_SOURCES) $(BL_COMMON_SOURCES) $(PLAT_BL_COMMON_SOURCES))
551	$(eval OBJS       := $(addprefix $(BUILD_DIR)/,$(call SOURCES_TO_OBJS,$(SOURCES))))
552	$(eval LINKERFILE := $(BUILD_DIR)/bl$(1).ld)
553	$(eval MAPFILE    := $(BUILD_DIR)/bl$(1).map)
554	$(eval ELF        := $(BUILD_DIR)/bl$(1).elf)
555	$(eval DUMP       := $(BUILD_DIR)/bl$(1).dump)
556	$(eval BIN        := $(BUILD_PLAT)/bl$(1).bin)
557
558	$(eval $(call MAKE_OBJS,$(BUILD_DIR),$(SOURCES),$(1)))
559	$(eval $(call MAKE_LD,$(LINKERFILE),$(BL$(1)_LINKERFILE)))
560
561$(BUILD_DIR) :
562	$$(Q)mkdir -p "$$@"
563
564$(ELF) : $(OBJS) $(LINKERFILE)
565	@echo "  LD      $$@"
566	@echo 'const char build_message[] = "Built : "__TIME__", "__DATE__; \
567	       const char version_string[] = "${VERSION_STRING}";' | \
568		$$(CC) $$(CFLAGS) -xc - -o $(BUILD_DIR)/build_message.o
569	$$(Q)$$(LD) -o $$@ $$(LDFLAGS) -Map=$(MAPFILE) --script $(LINKERFILE) \
570					$(BUILD_DIR)/build_message.o $(OBJS)
571
572$(DUMP) : $(ELF)
573	@echo "  OD      $$@"
574	$${Q}$${OD} -dx $$< > $$@
575
576$(BIN) : $(ELF)
577	@echo "  BIN     $$@"
578	$$(Q)$$(OC) -O binary $$< $$@
579	@echo
580	@echo "Built $$@ successfully"
581	@echo
582
583.PHONY : bl$(1)
584bl$(1) : $(BUILD_DIR) $(BIN) $(DUMP)
585
586all : bl$(1)
587
588$(eval $(call MAKE_TOOL_ARGS,$(1),$(BIN),$(2),$(3),$(4),$(5)))
589
590endef
591
592
593ifeq (${NEED_BL1},yes)
594$(eval $(call MAKE_BL,1))
595endif
596
597ifeq (${NEED_BL2},yes)
598$(if ${BL2}, $(eval $(call MAKE_TOOL_ARGS,2,${BL2},in_fip,${CERTS})),\
599	$(eval $(call MAKE_BL,2,in_fip,${CERTS})))
600endif
601
602ifeq (${NEED_BL31},yes)
603BL31_SOURCES += ${SPD_SOURCES}
604$(if ${BL31}, $(eval $(call MAKE_TOOL_ARGS,31,${BL31},in_fip,${CERTS},${CERTS},${BL31_KEY})),\
605	$(eval $(call MAKE_BL,31,in_fip,${CERTS},${CERTS},${BL31_KEY})))
606endif
607
608ifeq (${NEED_BL32},yes)
609$(if ${BL32}, $(eval $(call MAKE_TOOL_ARGS,32,${BL32},in_fip,${CERTS},${CERTS},${BL32_KEY})),\
610	$(eval $(call MAKE_BL,32,in_fip,${CERTS},${CERTS},${BL32_KEY})))
611endif
612
613ifeq (${NEED_BL30},yes)
614$(if ${BL30}, $(eval $(call MAKE_TOOL_ARGS,30,${BL30},in_fip,${CERTS},${CERTS},${BL30_KEY})))
615
616# If BL3-0 is needed by the platform then 'BL30' variable must be defined.
617check_bl30:
618	$(if ${BL30},,$(error "To build a FIP for platform ${PLAT}, please set BL30 to point to the SCP firmware"))
619else
620
621# If BL3-0 is not needed by the platform but the user still specified the path
622# to a BL3-0 image then warn him that it will be ignored.
623check_bl30:
624	$(if ${BL30},$(warning "BL3-0 is not supported on platform ${PLAT}, it will just be ignored"),)
625endif
626
627ifeq (${NEED_BL33},yes)
628$(if ${BL33}, $(eval $(call MAKE_TOOL_ARGS,33,${BL33},in_fip,${CERTS},${CERTS},${BL33_KEY})))
629
630# If BL3-3 is needed by the platform then 'BL33' variable must be defined.
631check_bl33:
632	$(if ${BL33},,$(error "To build a FIP, please set BL33 to point to the Normal World binary, eg: BL33=../uefi/FVP_AARCH64_EFI.fd"))
633else
634
635# If BL3-3 is not needed by the platform but the user still specified the path
636# to a BL3-3 image then warn him that it will be ignored.
637check_bl33:
638	$(if ${BL33},$(warning "BL3-3 is not supported on platform ${PLAT}, it will just be ignored"),)
639endif
640
641# Add the dependency on the certificates
642ifneq (${GENERATE_COT},0)
643    fip: certificates
644endif
645
646certificates: ${CRT_DEPS} ${CRTTOOL} check_bl30 check_bl33
647			${Q}${CRTTOOL} ${CRT_ARGS}
648			@echo
649			@echo "Built $@ successfully"
650			@echo "Certificates can be found in ${BUILD_PLAT}"
651			@echo
652
653${BUILD_PLAT}/${FIP_NAME}: ${FIP_DEPS} ${FIPTOOL} check_bl30 check_bl33
654			${Q}${FIPTOOL} --dump \
655				${FIP_ARGS} \
656				$@
657			@echo
658			@echo "Built $@ successfully"
659			@echo
660
661
662cscope:
663	@echo "  CSCOPE"
664	${Q}find ${CURDIR} -name "*.[chsS]" > cscope.files
665	${Q}cscope -b -q -k
666
667help:
668	@echo "usage: ${MAKE} PLAT=<${PLATFORMS}> [OPTIONS] [TARGET]"
669	@echo ""
670	@echo "PLAT is used to specify which platform you wish to build."
671	@echo "If no platform is specified, PLAT defaults to: ${DEFAULT_PLAT}"
672	@echo ""
673	@echo "Please refer to the User Guide for a list of all supported options."
674	@echo "Note that the build system doesn't track dependencies for build "
675	@echo "options. Therefore, if any of the build options are changed "
676	@echo "from a previous build, a clean build must be performed."
677	@echo ""
678	@echo "Supported Targets:"
679	@echo "  all            Build all individual bootloader binaries"
680	@echo "  bl1            Build the BL1 binary"
681	@echo "  bl2            Build the BL2 binary"
682	@echo "  bl31           Build the BL3-1 binary"
683	@echo "  bl32           Build the BL3-2 binary"
684	@echo "  fip            Build the Firmware Image Package (FIP)"
685	@echo "  checkcodebase  Check the coding style of the entire source tree"
686	@echo "  checkpatch     Check the coding style on changes in the current"
687	@echo "                 branch against BASE_COMMIT (default origin/master)"
688	@echo "  clean          Clean the build for the selected platform"
689	@echo "  cscope         Generate cscope index"
690	@echo "  distclean      Remove all build artifacts for all platforms"
691	@echo "  certtool       Build the Certificate generation tool"
692	@echo "  fiptool        Build the Firmware Image Package(FIP) creation tool"
693	@echo ""
694	@echo "Note: most build targets require PLAT to be set to a specific platform."
695	@echo ""
696	@echo "example: build all targets for the FVP platform:"
697	@echo "  CROSS_COMPILE=aarch64-none-elf- make PLAT=fvp all"
698