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