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