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