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