xref: /rk3399_ARM-atf/Makefile (revision 2b98e7890b4fc28d0be9ca5b073fcd3f9eccde0e)
1#
2# Copyright (c) 2013-2014, 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# Default values for build configurations
33#
34
35# Build verbosity
36V			:= 0
37# Debug build
38DEBUG			:= 0
39# Build architecture
40ARCH 			:= aarch64
41# Build platform
42DEFAULT_PLAT		:= fvp
43PLAT			:= ${DEFAULT_PLAT}
44# SPD choice
45SPD			:= none
46# Base commit to perform code check on
47BASE_COMMIT		:= origin/master
48# NS timer register save and restore
49NS_TIMER_SWITCH		:= 0
50# By default, Bl1 acts as the reset handler, not BL31
51RESET_TO_BL31		:= 0
52# Include FP registers in cpu context
53CTX_INCLUDE_FPREGS		:= 0
54# Determine the version of ARM GIC architecture to use for interrupt management
55# in EL3. The platform port can change this value if needed.
56ARM_GIC_ARCH		:=	2
57
58
59# Checkpatch ignores
60CHECK_IGNORE		=	--ignore COMPLEX_MACRO
61
62CHECKPATCH_ARGS		=	--no-tree --no-signoff ${CHECK_IGNORE}
63CHECKCODE_ARGS		=	--no-patch --no-tree --no-signoff ${CHECK_IGNORE}
64
65ifeq (${V},0)
66	Q=@
67	CHECKCODE_ARGS	+=	--no-summary --terse
68else
69	Q=
70endif
71export Q
72
73ifneq (${DEBUG}, 0)
74	BUILD_TYPE	:=	debug
75else
76	BUILD_TYPE	:=	release
77endif
78
79BL_COMMON_SOURCES	:=	common/bl_common.c			\
80				common/debug.c				\
81				lib/aarch64/cache_helpers.S		\
82				lib/aarch64/misc_helpers.S		\
83				lib/aarch64/xlat_helpers.c		\
84				lib/stdlib/std.c			\
85				lib/io_storage.c			\
86				plat/common/aarch64/platform_helpers.S
87
88BUILD_BASE		:=	./build
89BUILD_PLAT		:=	${BUILD_BASE}/${PLAT}/${BUILD_TYPE}
90
91PLATFORMS		:=	$(shell ls -I common plat/)
92SPDS			:=	$(shell ls -I none services/spd)
93HELP_PLATFORMS		:=	$(shell echo ${PLATFORMS} | sed 's/ /|/g')
94
95# Convenience function for adding build definitions
96# $(eval $(call add_define,FOO)) will have:
97# -DFOO if $(FOO) is empty; -DFOO=$(FOO) otherwise
98define add_define
99DEFINES			+=	-D$(1)$(if $(value $(1)),=$(value $(1)),)
100endef
101
102# Convenience function for verifying option has a boolean value
103# $(eval $(call assert_boolean,FOO)) will assert FOO is 0 or 1
104define assert_boolean
105$(and $(patsubst 0,,$(value $(1))),$(patsubst 1,,$(value $(1))),$(error $(1) must be boolean))
106endef
107
108ifeq (${PLAT},)
109  $(error "Error: Unknown platform. Please use PLAT=<platform name> to specify the platform.")
110endif
111ifeq ($(findstring ${PLAT},${PLATFORMS}),)
112  $(error "Error: Invalid platform. The following platforms are available: ${PLATFORMS}")
113endif
114
115all: msg_start
116
117msg_start:
118	@echo "Building ${PLAT}"
119
120include plat/${PLAT}/platform.mk
121
122ifdef BL1_SOURCES
123NEED_BL1 := yes
124include bl1/bl1.mk
125endif
126
127ifdef BL2_SOURCES
128NEED_BL2 := yes
129include bl2/bl2.mk
130endif
131
132ifdef BL31_SOURCES
133NEED_BL31 := yes
134include bl31/bl31.mk
135endif
136
137# Include SPD Makefile if one has been specified
138ifneq (${SPD},none)
139  # We expect to locate an spd.mk under the specified SPD directory
140  SPD_MAKE		:=	$(shell m="services/spd/${SPD}/${SPD}.mk"; [ -f "$$m" ] && echo "$$m")
141
142  ifeq (${SPD_MAKE},)
143    $(error Error: No services/spd/${SPD}/${SPD}.mk located)
144  endif
145  $(info Including ${SPD_MAKE})
146  include ${SPD_MAKE}
147
148  # If there's BL32 companion for the chosen SPD, and the SPD wants to build the
149  # BL2 from source, we expect that the SPD's Makefile would set NEED_BL32
150  # variable to "yes"
151endif
152
153.PHONY:			all msg_start clean realclean distclean cscope locate-checkpatch checkcodebase checkpatch fiptool fip
154.SUFFIXES:
155
156INCLUDES		+=	-Iinclude/bl31			\
157				-Iinclude/bl31/services		\
158				-Iinclude/bl32			\
159				-Iinclude/bl32/payloads		\
160				-Iinclude/common		\
161				-Iinclude/drivers		\
162				-Iinclude/drivers/arm		\
163				-Iinclude/lib			\
164				-Iinclude/lib/aarch64		\
165				-Iinclude/plat/common		\
166				-Iinclude/stdlib		\
167				-Iinclude/stdlib/sys		\
168				${PLAT_INCLUDES}		\
169				${SPD_INCLUDES}
170
171# Process DEBUG flag
172$(eval $(call assert_boolean,DEBUG))
173$(eval $(call add_define,DEBUG))
174ifeq (${DEBUG},0)
175  $(eval $(call add_define,NDEBUG))
176else
177CFLAGS			+= 	-g
178ASFLAGS			+= 	-g -Wa,--gdwarf-2
179endif
180
181# Process NS_TIMER_SWITCH flag
182$(eval $(call assert_boolean,NS_TIMER_SWITCH))
183$(eval $(call add_define,NS_TIMER_SWITCH))
184
185# Process RESET_TO_BL31 flag
186$(eval $(call assert_boolean,RESET_TO_BL31))
187$(eval $(call add_define,RESET_TO_BL31))
188
189# Process CTX_INCLUDE_FPREGS flag
190$(eval $(call assert_boolean,CTX_INCLUDE_FPREGS))
191$(eval $(call add_define,CTX_INCLUDE_FPREGS))
192
193# Process ARM_GIC_ARCH flag
194$(eval $(call add_define,ARM_GIC_ARCH))
195
196
197ASFLAGS			+= 	-nostdinc -ffreestanding -Wa,--fatal-warnings	\
198				-Werror -Wmissing-include-dirs			\
199				-mgeneral-regs-only -D__ASSEMBLY__		\
200				${DEFINES} ${INCLUDES}
201CFLAGS			+= 	-nostdinc -pedantic -ffreestanding -Wall	\
202				-Werror -Wmissing-include-dirs			\
203				-mgeneral-regs-only -std=c99 -c -Os		\
204				${DEFINES} ${INCLUDES}
205CFLAGS			+=	-ffunction-sections -fdata-sections
206
207LDFLAGS			+=	--fatal-warnings -O1
208LDFLAGS			+=	--gc-sections
209
210
211CC			:=	${CROSS_COMPILE}gcc
212CPP			:=	${CROSS_COMPILE}cpp
213AS			:=	${CROSS_COMPILE}gcc
214AR			:=	${CROSS_COMPILE}ar
215LD			:=	${CROSS_COMPILE}ld
216OC			:=	${CROSS_COMPILE}objcopy
217OD			:=	${CROSS_COMPILE}objdump
218NM			:=	${CROSS_COMPILE}nm
219PP			:=	${CROSS_COMPILE}gcc -E ${CFLAGS}
220
221# Variables for use with Firmware Image Package
222FIPTOOLPATH		?=	tools/fip_create
223FIPTOOL			?=	${FIPTOOLPATH}/fip_create
224fiptool:		${FIPTOOL}
225fip:			${BUILD_PLAT}/fip.bin
226
227locate-checkpatch:
228ifndef CHECKPATCH
229	$(error "Please set CHECKPATCH to point to the Linux checkpatch.pl file, eg: CHECKPATCH=../linux/script/checkpatch.pl")
230else
231ifeq (,$(wildcard ${CHECKPATCH}))
232	$(error "The file CHECKPATCH points to cannot be found, use eg: CHECKPATCH=../linux/script/checkpatch.pl")
233endif
234endif
235
236clean:
237			@echo "  CLEAN"
238			${Q}rm -rf ${BUILD_PLAT}
239			${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH} clean
240
241realclean distclean:
242			@echo "  REALCLEAN"
243			${Q}rm -rf ${BUILD_BASE}
244			${Q}rm -f ${CURDIR}/cscope.*
245			${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH} clean
246
247checkcodebase:		locate-checkpatch
248			@echo "  CHECKING STYLE"
249			@if test -d .git ; then	\
250				git ls-files | grep -v stdlib | while read GIT_FILE ; do ${CHECKPATCH} ${CHECKCODE_ARGS} -f $$GIT_FILE ; done ;	\
251			 else			\
252				 find . -type f -not -iwholename "*.git*" -not -iwholename "*build*" -not -iwholename "*stdlib*" -exec ${CHECKPATCH} ${CHECKCODE_ARGS} -f {} \; ;	\
253			 fi
254
255checkpatch:		locate-checkpatch
256			@echo "  CHECKING STYLE"
257			@git format-patch --stdout ${BASE_COMMIT} | ${CHECKPATCH} ${CHECKPATCH_ARGS} - || true
258
259${FIPTOOL}:
260			${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH}
261			@echo
262			@echo "Built $@ successfully"
263			@echo
264
265define match_goals
266$(strip $(foreach goal,$(1),$(filter $(goal),$(MAKECMDGOALS))))
267endef
268
269# List of rules that involve building things
270BUILD_TARGETS := all bl1 bl2 bl31 bl32 fip
271
272# Does the list of goals specified on the command line include a build target?
273ifneq ($(call match_goals,${BUILD_TARGETS}),)
274IS_ANYTHING_TO_BUILD := 1
275endif
276
277define MAKE_C
278
279$(eval OBJ := $(1)/$(patsubst %.c,%.o,$(notdir $(2))))
280$(eval PREREQUISITES := $(patsubst %.o,%.d,$(OBJ)))
281
282$(OBJ) : $(2)
283	@echo "  CC      $$<"
284	$$(Q)$$(CC) $$(CFLAGS) -c $$< -o $$@
285
286
287$(PREREQUISITES) : $(2)
288	@echo "  DEPS    $$@"
289	@mkdir -p $(1)
290	$$(Q)$$(CC) $$(CFLAGS) -M -MT $(OBJ) -MF $$@ $$<
291
292ifdef IS_ANYTHING_TO_BUILD
293-include $(PREREQUISITES)
294endif
295
296endef
297
298
299define MAKE_S
300
301$(eval OBJ := $(1)/$(patsubst %.S,%.o,$(notdir $(2))))
302$(eval PREREQUISITES := $(patsubst %.o,%.d,$(OBJ)))
303
304$(OBJ) : $(2)
305	@echo "  AS      $$<"
306	$$(Q)$$(AS) $$(ASFLAGS) -c $$< -o $$@
307
308$(PREREQUISITES) : $(2)
309	@echo "  DEPS    $$@"
310	@mkdir -p $(1)
311	$$(Q)$$(AS) $$(ASFLAGS) -M -MT $(OBJ) -MF $$@ $$<
312
313ifdef IS_ANYTHING_TO_BUILD
314-include $(PREREQUISITES)
315endif
316
317endef
318
319
320define MAKE_LD
321
322$(eval PREREQUISITES := $(1).d)
323
324$(1) : $(2)
325	@echo "  PP      $$<"
326	$$(Q)$$(AS) $$(ASFLAGS) -P -E -o $$@ $$<
327
328$(PREREQUISITES) : $(2)
329	@echo "  DEPS    $$@"
330	@mkdir -p $$(dir $$@)
331	$$(Q)$$(AS) $$(ASFLAGS) -M -MT $(1) -MF $$@ $$<
332
333ifdef IS_ANYTHING_TO_BUILD
334-include $(PREREQUISITES)
335endif
336
337endef
338
339
340define MAKE_OBJS
341	$(eval C_OBJS := $(filter %.c,$(2)))
342	$(eval REMAIN := $(filter-out %.c,$(2)))
343	$(eval $(foreach obj,$(C_OBJS),$(call MAKE_C,$(1),$(obj))))
344
345	$(eval S_OBJS := $(filter %.S,$(REMAIN)))
346	$(eval REMAIN := $(filter-out %.S,$(REMAIN)))
347	$(eval $(foreach obj,$(S_OBJS),$(call MAKE_S,$(1),$(obj))))
348
349	$(and $(REMAIN),$(error Unexpected source files present: $(REMAIN)))
350endef
351
352
353# NOTE: The line continuation '\' is required in the next define otherwise we
354# end up with a line-feed characer at the end of the last c filename.
355# Also bare this issue in mind if extending the list of supported filetypes.
356define SOURCES_TO_OBJS
357	$(notdir $(patsubst %.c,%.o,$(filter %.c,$(1)))) \
358	$(notdir $(patsubst %.S,%.o,$(filter %.S,$(1))))
359endef
360
361define MAKE_BL
362	$(eval BUILD_DIR  := ${BUILD_PLAT}/bl$(1))
363	$(eval SOURCES    := $(BL$(1)_SOURCES) $(BL_COMMON_SOURCES) $(PLAT_BL_COMMON_SOURCES))
364	$(eval OBJS       := $(addprefix $(BUILD_DIR)/,$(call SOURCES_TO_OBJS,$(SOURCES))))
365	$(eval LINKERFILE := $(BUILD_DIR)/bl$(1).ld)
366	$(eval MAPFILE    := $(BUILD_DIR)/bl$(1).map)
367	$(eval ELF        := $(BUILD_DIR)/bl$(1).elf)
368	$(eval DUMP       := $(BUILD_DIR)/bl$(1).dump)
369	$(eval BIN        := $(BUILD_PLAT)/bl$(1).bin)
370
371	$(eval $(call MAKE_OBJS,$(BUILD_DIR),$(SOURCES)))
372	$(eval $(call MAKE_LD,$(LINKERFILE),$(BL$(1)_LINKERFILE)))
373
374$(BUILD_DIR) :
375	$$(Q)mkdir -p "$$@"
376
377$(ELF) : $(OBJS) $(LINKERFILE)
378	@echo "  LD      $$@"
379	@echo 'const char build_message[] = "Built : "__TIME__", "__DATE__;' | \
380		$$(CC) $$(CFLAGS) -xc - -o $(BUILD_DIR)/build_message.o
381	$$(Q)$$(LD) -o $$@ $$(LDFLAGS) -Map=$(MAPFILE) --script $(LINKERFILE) \
382					$(BUILD_DIR)/build_message.o $(OBJS)
383
384$(DUMP) : $(ELF)
385	@echo "  OD      $$@"
386	$${Q}$${OD} -dx $$< > $$@
387
388$(BIN) : $(ELF)
389	@echo "  BIN     $$@"
390	$$(Q)$$(OC) -O binary $$< $$@
391	@echo
392	@echo "Built $$@ successfully"
393	@echo
394
395.PHONY : bl$(1)
396bl$(1) : $(BUILD_DIR) $(BIN) $(DUMP)
397
398all : bl$(1)
399
400$(eval FIP_DEPS += $(if $2,$(BIN),))
401$(eval FIP_ARGS += $(if $2,--bl$(1) $(BIN),))
402
403endef
404
405
406ifeq (${NEED_BL1},yes)
407$(eval $(call MAKE_BL,1))
408endif
409
410ifeq (${NEED_BL2},yes)
411$(eval $(call MAKE_BL,2,in_fip))
412endif
413
414ifeq (${NEED_BL31},yes)
415BL31_SOURCES += ${SPD_SOURCES}
416$(eval $(call MAKE_BL,31,in_fip))
417endif
418
419ifeq (${NEED_BL32},yes)
420$(eval $(call MAKE_BL,32,in_fip))
421endif
422
423ifeq (${NEED_BL30},yes)
424FIP_DEPS += ${BL30}
425FIP_ARGS += --bl30 ${BL30}
426endif
427
428ifeq (${NEED_BL30},yes)
429# If BL3-0 is needed by the platform then 'BL30' variable must be defined.
430check_bl30:
431	$(if ${BL30},,$(error "To build a FIP for platform ${PLAT}, please set BL30 to point to the SCP firmware"))
432else
433# If BL3-0 is not needed by the platform but the user still specified the path
434# to a BL3-0 image then warn him that it will be ignored.
435check_bl30:
436	$(if ${BL30},$(warning "BL3-0 is not supported on platform ${PLAT}, it will just be ignored"),)
437endif
438
439${BUILD_PLAT}/fip.bin: ${FIP_DEPS} ${BL33} ${FIPTOOL} check_bl30
440			$(if ${BL33},,$(error "To build a FIP, please set BL33 to point to the Normal World binary, eg: BL33=../uefi/FVP_AARCH64_EFI.fd"))
441			${Q}${FIPTOOL} --dump \
442				${FIP_ARGS} \
443				--bl33 ${BL33} \
444				$@
445			@echo
446			@echo "Built $@ successfully"
447			@echo
448
449
450cscope:
451	@echo "  CSCOPE"
452	${Q}find ${CURDIR} -name "*.[chsS]" > cscope.files
453	${Q}cscope -b -q -k
454
455help:
456	@echo "usage: ${MAKE} PLAT=<${HELP_PLATFORMS}> <all|bl1|bl2|bl31|distclean|clean|checkcodebase|checkpatch>"
457	@echo ""
458	@echo "PLAT is used to specify which platform you wish to build."
459	@echo "If no platform is specified, PLAT defaults to: ${DEFAULT_PLAT}"
460	@echo ""
461	@echo "Supported Targets:"
462	@echo "  all            Build the BL1, BL2 and BL31 binaries"
463	@echo "  bl1            Build the BL1 binary"
464	@echo "  bl2            Build the BL2 binary"
465	@echo "  bl31           Build the BL31 binary"
466	@echo "  checkcodebase  Check the coding style of the entire source tree"
467	@echo "  checkpatch     Check the coding style on changes in the current"
468	@echo "                 branch against BASE_COMMIT (default origin/master)"
469	@echo "  clean          Clean the build for the selected platform"
470	@echo "  cscope         Generate cscope index"
471	@echo "  distclean      Remove all build artifacts for all platforms"
472	@echo "  fiptool        Build the Firmware Image Package(FIP) creation tool"
473	@echo ""
474	@echo "note: most build targets require PLAT to be set to a specific platform."
475	@echo ""
476	@echo "example: build all targets for the FVP platform:"
477	@echo "  CROSS_COMPILE=aarch64-none-elf- make PLAT=fvp all"
478