#
# Copyright (c) 2013-2014, ARM Limited and Contributors. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# Redistributions of source code must retain the above copyright notice, this
# list of conditions and the following disclaimer.
#
# Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# Neither the name of ARM nor the names of its contributors may be used
# to endorse or promote products derived from this software without specific
# prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#

#
# Default values for build configurations
#

# Build verbosity
V			:= 0
# Debug build
DEBUG			?= 0
BUILD_TYPE		:= release
# Build architecture
ARCH 			:= aarch64
# Build platform
#DEFAULT_PLAT		:= gx
PLAT			:= ${SOC}
export PLAT
# Exception LEVEL
EL_LEVEL		:=el2
export EL_LEVEL
# SPD choice
SPD			= none
# Base commit to perform code check on
BASE_COMMIT		:= origin/master
# NS timer register save and restore
NS_TIMER_SWITCH		:= 0
# By default, Bl1 acts as the reset handler, not BL31
RESET_TO_BL31		:= 0

CONFIG_AML_SECURE_BOOT_V3 ?= 0
export CONFIG_AML_SECURE_BOOT_V3

CONFIG_AML_SPI		?= 1
export CONFIG_AML_SPI

# Checkpatch ignores
CHECK_IGNORE		=	--ignore COMPLEX_MACRO

CHECKPATCH_ARGS		=	--no-tree --no-signoff ${CHECK_IGNORE}
CHECKCODE_ARGS		=	--no-patch --no-tree --no-signoff ${CHECK_IGNORE}

ifeq (${V},0)
	Q=@
	CHECKCODE_ARGS	+=	--no-summary --terse
else
	Q=
endif
export Q

# Default build string (git branch and commit)
ifeq (${GIT_BRANCH},)
	GIT_BRANCH := $(shell git describe --all --contains)
endif
ifeq (${GIT_VERSION},)
	GIT_VERSION := $(shell git describe --always --contains)
    ifdef CONFIG_ODROIDC2
		GIT_VERSION := $(GIT_VERSION)-c2
    endif
endif
ifeq (${GIT_DIRTY},)
	GIT_DIRTY = $(findstring -dirty, $(shell git describe --always --dirty --all))
endif
ifeq (${BUILDER},)
	BUILDER := ${USER}@$(shell hostname)
endif

BL_COMMON_SOURCES	:=	\
				lib/${ARCH}/cache_v8.c				\
				lib/${ARCH}/cache_${EL_LEVEL}.S		\
				lib/stdlib/mem.c					\
				lib/ram_compress/lz4_compress.c		\
				lib/ram_compress/ram_compress.c		\
				lib/md5/md5.c			\
				drivers/serial.c		\
				drivers/timer.c			\
				drivers/watchdog.c

BL33Z_SOURCES		+=	\
				bl33z/bl33z_main.c		\
				bl33z/${ARCH}/bl33z_entrypoint.S

BL33Z_LINKERFILE	:=	bl33z/bl33z.ld.S

BUILD_BASE		:=	build
BUILD_PLAT		:=	${BUILD_BASE}/${PLAT}/${BUILD_TYPE}

# Convenience function for adding build definitions
# $(eval $(call add_define,FOO)) will have:
# -DFOO if $(FOO) is empty; -DFOO=$(FOO) otherwise
define add_define
DEFINES			+=	-D$(1)$(if $(value $(1)),=$(value $(1)),)
endef

# Convenience function for verifying option has a boolean value
# $(eval $(call assert_boolean,FOO)) will assert FOO is 0 or 1
define assert_boolean
$(if $(value $1),,$(error $1 must be boolean))
$(and $(patsubst 0,,$(value $(1))),$(patsubst 1,,$(value $(1))),$(error $(1) must be boolean))
endef

ifeq (${PLAT},)
  $(error "Error: Unknown platform. Please use PLAT=<platform name> to specify the platform.")
endif

all: msg_start

msg_start:
	@echo "Building ${PLAT}"

ifeq ($(MINCRYPT),y)
CFLAGS	+= 	-DCONFIG_AML_MINCRYPT_RSA
endif

ifeq ($(DEBUG_ROM),y)
CFLAGS	+= 	-DCONFIG_AML_DEBUG_ROM
endif

ifeq ($(UBOOT_AUTO_TEST),y)
CFLAGS	+= 	-DCONFIG_AML_UBOOT_AUTO_TEST
endif

#ifdef BL33Z_SOURCES
NEED_BL33Z := yes
#include bl33z/bl33z.mk
#endif

# Include SPD Makefile if one has been specified
ifneq (${SPD},none)
  # We expect to locate an spd.mk under the specified SPD directory
  SPD_MAKE		:=	$(shell m="services/spd/${SPD}/${SPD}.mk"; [ -f "$$m" ] && echo "$$m")

  ifeq (${SPD_MAKE},)
    $(error Error: No services/spd/${SPD}/${SPD}.mk located)
  endif
  $(info Including ${SPD_MAKE})
  include ${SPD_MAKE}

  # If there's BL32 companion for the chosen SPD, and the SPD wants to build the
  # BL33Z from source, we expect that the SPD's Makefile would set NEED_BL32
  # variable to "yes"
endif

.PHONY:			all msg_start clean realclean distclean cscope locate-checkpatch checkcodebase checkpatch fiptool fip
.SUFFIXES:

INCLUDES		+=	-Iinclude/bl33z			\
				-Iinclude/drivers			\
				-Iinclude/lib				\
				-Iinclude/lib/${ARCH}		\
				-Iinclude/stdlib			\
				-Iinclude/stdlib/sys		\
				-Iinclude/asm/arch-${PLAT}

# Process DEBUG flag
$(eval $(call assert_boolean,DEBUG))
$(eval $(call add_define,DEBUG))
ifeq (${DEBUG},0)
  $(eval $(call add_define,NDEBUG))
else
CFLAGS			+= 	-g
ASFLAGS			+= 	-g -Wa,--gdwarf-2
endif

# Process NS_TIMER_SWITCH flag
$(eval $(call assert_boolean,NS_TIMER_SWITCH))
$(eval $(call add_define,NS_TIMER_SWITCH))

# Process RESET_TO_BL31 flag
$(eval $(call assert_boolean,RESET_TO_BL31))
$(eval $(call add_define,RESET_TO_BL31))

# Process CONFIG_AML_SECURE_BOOT_V3 flag
$(eval $(call assert_boolean,CONFIG_AML_SECURE_BOOT_V3))
$(eval $(call add_define,CONFIG_AML_SECURE_BOOT_V3))

# Process CONFIG_AML_SPI flag
$(eval $(call assert_boolean,CONFIG_AML_SPI))
$(eval $(call add_define,CONFIG_AML_SPI))

# Define the AARCH32/AARCH64 flag based on the ARCH flag
$(info ARCH=${ARCH})
ifeq (${ARCH},aarch32)
        $(eval $(call add_define,AARCH32))
else
        $(eval $(call add_define,AARCH64))
endif

###########################################
# aarch64 compiler
###########################################
ASFLAGS_aarch64			+= 	-nostdinc -ffreestanding -Wa,--fatal-warnings	\
				-mgeneral-regs-only -D__ASSEMBLY__		\
				${DEFINES} ${INCLUDES}

CFLAGS_aarch64			+= 	-nostdinc -pedantic -ffreestanding -Wall	\
				-Werror -mgeneral-regs-only -std=gnu99 -Wno-pedantic -c -Os	\
				${DEFINES} ${INCLUDES}
CFLAGS_aarch64			+=	-ffunction-sections -fdata-sections
CFLAGS_aarch64			+=	${FIRMWARE_CPPFLAGS}
CFLAGS_aarch64			+=	-DCONFIG_64BIT

LDFLAGS_aarch64			+=	--fatal-warnings -O1
LDFLAGS_aarch64			+=	--gc-sections

###########################################
# aarch32 compiler
###########################################
ASFLAGS_aarch32			+= 	-nostdinc -ffreestanding -Wa,--fatal-warnings	-mcpu=cortex-a9 -mfpu=neon \
				-D__ASSEMBLY__		\
				${DEFINES} ${INCLUDES}
CFLAGS_aarch32 		+= -g -Os -fno-builtin -ffreestanding -nostdinc
CFLAGS_aarch32 		+= -pipe -DCONFIG_ARM -D__ARM__ -mthumb -mabi=aapcs-linux -mthumb-interwork -mcpu=cortex-a9
CFLAGS_aarch32 		+= -mfpu=neon  -mno-long-calls -fno-stack-protector -MD -Wno-unused-function -mno-long-calls
CFLAGS_aarch32 		+= -Wall -Werror -std=gnu99 -Wno-pedantic -c -Os
CFLAGS_aarch32			+= 	${DEFINES} ${INCLUDES}
CFLAGS_aarch32			+= 	${FIRMWARE_CPPFLAGS}

LDFLAGS_aarch32			+=	--fatal-warnings -O1
LDFLAGS_aarch32			+=	--gc-sections

###########################################
# final compiler
###########################################
ASFLAGS += $(ASFLAGS_${ARCH})
CFLAGS += $(CFLAGS_${ARCH})
LDFLAGS += $(LDFLAGS_${ARCH})

CC			:=	${CROSS_COMPILE}gcc
CPP			:=	${CROSS_COMPILE}cpp
AS			:=	${CROSS_COMPILE}gcc
AR			:=	${CROSS_COMPILE}ar
LD			:=	${CROSS_COMPILE}ld
OC			:=	${CROSS_COMPILE}objcopy
OD			:=	${CROSS_COMPILE}objdump
NM			:=	${CROSS_COMPILE}nm
PP			:=	${CROSS_COMPILE}gcc -E ${CFLAGS}

# Variables for use with Firmware Image Package
FIPTOOLPATH		?=	tools/fip_create
FIPTOOL			?=	${FIPTOOLPATH}/fip_create
fiptool:		${FIPTOOL}
fip:			${BUILD_PLAT}/fip.bin

ifdef CONFIG_ODROIDC2
CFLAGS			+= 	-DCONFIG_ODROIDC2
endif # CONFIG_ODROIDC2

# Check T32 Cross Compiler Version
ifeq (${ARCH},aarch32)
CC_VER=$(shell $(CC) -v 2>&1 | grep 'gcc version' | cut -d ' ' -f 3)
T32_CROSS_COMPILE_VERSION=6.3.1
VER=$(sort ${CC_VER} ${T32_CROSS_COMPILE_VERSION})
VER_MIN=$(shell echo ${VER} | cut -d ' ' -f 1)
ifneq ($(VER_MIN), $(T32_CROSS_COMPILE_VERSION))
$(error You should use GCC version is greater than or equal to $(T32_CROSS_COMPILE_VERSION))
endif
endif

locate-checkpatch:
ifndef CHECKPATCH
	$(error "Please set CHECKPATCH to point to the Linux checkpatch.pl file, eg: CHECKPATCH=../linux/script/checkpatch.pl")
else
ifeq (,$(wildcard ${CHECKPATCH}))
	$(error "The file CHECKPATCH points to cannot be found, use eg: CHECKPATCH=../linux/script/checkpatch.pl")
endif
endif

clean:
			@echo "  CLEAN"
			${Q}rm -rf ${BUILD_PLAT}

realclean distclean:
			@echo "  REALCLEAN"
			${Q}rm -rf ${BUILD_BASE}
			${Q}rm -f ${CURDIR}/cscope.*

checkcodebase:		locate-checkpatch
			@echo "  CHECKING STYLE"
			@if test -d .git ; then	\
				git ls-files | while read GIT_FILE ; do ${CHECKPATCH} ${CHECKCODE_ARGS} -f $$GIT_FILE ; done ;	\
			 else			\
				 find . -type f -not -iwholename "*.git*" -not -iwholename "*build*" -exec ${CHECKPATCH} ${CHECKCODE_ARGS} -f {} \; ;	\
			 fi

checkpatch:		locate-checkpatch
			@echo "  CHECKING STYLE"
			@git format-patch --stdout ${BASE_COMMIT} | ${CHECKPATCH} ${CHECKPATCH_ARGS} - || true

${FIPTOOL}:
			${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH}
			@echo
			@echo "Built $@ successfully"
			@echo

define match_goals
$(strip $(foreach goal,$(1),$(filter $(goal),$(MAKECMDGOALS))))
endef

# List of rules that involve building things
BUILD_TARGETS := all bl1 bl33z bl31 bl32 fip

# Does the list of goals specified on the command line include a build target?
ifneq ($(call match_goals,${BUILD_TARGETS}),)
IS_ANYTHING_TO_BUILD := 1
endif

define MAKE_C

$(eval OBJ := $(1)/$(patsubst %.c,%.o,$(notdir $(2))))
$(eval PREREQUISITES := $(patsubst %.o,%.d,$(OBJ)))

$(OBJ) : $(2)
	@echo "  CC      $$<"
	$$(Q)$$(CC) $$(CFLAGS) -c $$< -o $$@


$(PREREQUISITES) : $(2)
	@echo "  DEPS    $$@"
	@mkdir -p $(1)
	$$(Q)$$(CC) $$(CFLAGS) -M -MT $(OBJ) -MF $$@ $$<

ifdef IS_ANYTHING_TO_BUILD
-include $(PREREQUISITES)
endif

endef


define MAKE_S

$(eval OBJ := $(1)/$(patsubst %.S,%.o,$(notdir $(2))))
$(eval PREREQUISITES := $(patsubst %.o,%.d,$(OBJ)))

$(OBJ) : $(2)
	@echo "  AS      $$<"
	$$(Q)$$(AS) $$(ASFLAGS) -c $$< -o $$@

$(PREREQUISITES) : $(2)
	@echo "  DEPS    $$@"
	@mkdir -p $(1)
	$$(Q)$$(AS) $$(ASFLAGS) -M -MT $(OBJ) -MF $$@ $$<

ifdef IS_ANYTHING_TO_BUILD
-include $(PREREQUISITES)
endif

endef


define MAKE_LD

$(eval PREREQUISITES := $(1).d)

$(1) : $(2)
	@echo "  PP      $$<"
	$$(Q)$$(AS) $$(ASFLAGS) -P -E -o $$@ $$<

$(PREREQUISITES) : $(2)
	@echo "  DEPS    $$@"
	@mkdir -p $$(dir $$@)
	$$(Q)$$(AS) $$(ASFLAGS) -M -MT $(1) -MF $$@ $$<

ifdef IS_ANYTHING_TO_BUILD
-include $(PREREQUISITES)
endif

endef


define MAKE_OBJS
	$(eval C_OBJS := $(filter %.c,$(2)))
	$(eval REMAIN := $(filter-out %.c,$(2)))
	$(eval $(foreach obj,$(C_OBJS),$(call MAKE_C,$(1),$(obj))))

	$(eval S_OBJS := $(filter %.S,$(REMAIN)))
	$(eval REMAIN := $(filter-out %.S,$(REMAIN)))
	$(eval $(foreach obj,$(S_OBJS),$(call MAKE_S,$(1),$(obj))))

	$(and $(REMAIN),$(error Unexpected source files present: $(REMAIN)))
endef


# NOTE: The line continuation '\' is required in the next define otherwise we
# end up with a line-feed character at the end of the last c filename.
# Also bare this issue in mind if extending the list of supported filetypes.
define SOURCES_TO_OBJS
	$(notdir $(patsubst %.c,%.o,$(filter %.c,$(1)))) \
	$(notdir $(patsubst %.S,%.o,$(filter %.S,$(1))))
endef

# Allow overriding the timestamp, for example for reproducible builds, or to
# # synchronize timestamps across multiple projects.
# # This must be set to a C string (including quotes where applicable).
BUILD_MESSAGE_TIMESTAMP ?= __TIME__", "__DATE__

define MAKE_BL
	$(eval BUILD_DIR  := ${BUILD_PLAT}/bl$(1))
	$(eval SOURCES    := $(BL33Z_SOURCES) $(BL_COMMON_SOURCES) $(PLAT_BL_COMMON_SOURCES))
	$(eval OBJS       := $(addprefix $(BUILD_DIR)/,$(call SOURCES_TO_OBJS,$(SOURCES))))
	$(eval LINKERFILE := $(BUILD_DIR)/bl$(1).ld)
	$(eval MAPFILE    := $(BUILD_DIR)/bl$(1).map)
	$(eval ELF        := $(BUILD_DIR)/bl$(1).elf)
	$(eval DUMP       := $(BUILD_DIR)/bl$(1).dump)
	$(eval BIN        := $(BUILD_PLAT)/bl$(1).bin)

	$(shell mkdir -p $(sort $(dir $(OBJS) $(LINKERFILE) $(MAPFILE) $(DUMP))))

	$(eval $(call MAKE_OBJS,$(BUILD_DIR),$(SOURCES)))
	$(eval $(call MAKE_LD,$(LINKERFILE),$(BL33Z_LINKERFILE)))

$(BUILD_DIR) :
	$$(Q)mkdir -p "$$@"

$(ELF) : $(OBJS) $(LINKERFILE)
	@echo "  LD      $$@"
	@mkdir -p $(dir $$@)
	@echo 'const char build_message[] = "Built : "${BUILD_MESSAGE_TIMESTAMP}". ${PLAT} ${GIT_BRANCH} g${GIT_VERSION}${GIT_DIRTY} - ${BUILDER}";' | \
		$$(CC) $$(CFLAGS) -xc - -o $(BUILD_DIR)/build_message.o
	$$(Q)$$(LD) -o $$@ $$(LDFLAGS) -Map=$(MAPFILE) --script $(LINKERFILE) \
					$(BUILD_DIR)/build_message.o $(OBJS)

$(DUMP) : $(ELF)
	@echo "  OD      $$@"
	@mkdir -p $(dir $$@)
	$${Q}$${OD} -dxS $$< > $$@

$(BIN) : $(ELF)
	@echo "  BIN     $$@"
	@mkdir -p $(dir $$@)
	$$(Q)$$(OC) -O binary $$< $$@
	@echo
	@echo "Built $$@ successfully."
	@cp -rf $(BIN) ${BUILD_BASE}/
	@echo

.PHONY : bl$(1)
bl$(1) : $(BUILD_DIR) $(ELF) $(DUMP) $(BIN)
# update __acs_set symbol value in bin
ifeq (${ARCH},aarch32)
	@python tools/t32_tool/t32_tool.py $(DUMP) __acs_set $(BIN) 4
endif

all : bl$(1)

$(eval FIP_DEPS += $(if $2,$(BIN),))
$(eval FIP_ARGS += $(if $2,--bl$(1) $(BIN),))

endef

ifeq (${NEED_BL33Z},yes)
$(eval $(call MAKE_BL,33z,in_fip))
endif

${BUILD_PLAT}/fip.bin:	${FIP_DEPS} ${BL33} ${FIPTOOL}
			$(if ${BL33},,$(error "To build a FIP, please set BL33 to point to the Normal World binary, eg: BL33=../uefi/FVP_AARCH64_EFI.fd"))
			${Q}${FIPTOOL} --dump \
				${FIP_ARGS} \
				--bl33 ${BL33} \
				$@
			@echo
			@echo "Built $@ successfully"
			@echo


cscope:
	@echo "  CSCOPE"
	${Q}find ${CURDIR} -name "*.[chsS]" > cscope.files
	${Q}cscope -b -q -k

help:
	@echo "usage: ${MAKE} PLAT=<${HELP_PLATFORMS}> <bl33z|distclean|clean|checkcodebase|checkpatch>"
	@echo ""
	@echo "PLAT is used to specify which platform you wish to build."
	@echo "If no platform is specified, PLAT defaults to: ${DEFAULT_PLAT}"
	@echo ""
	@echo "Supported Targets:"
	@echo "  bl33z           Build the BL33Z binary"
	@echo "  checkcodebase  Check the coding style of the entire source tree"
	@echo "  checkpatch     Check the coding style on changes in the current"
	@echo "                 branch against BASE_COMMIT (default origin/master)"
	@echo "  clean          Clean the build for the selected platform"
	@echo "  cscope         Generate cscope index"
	@echo "  distclean      Remove all build artifacts for all platforms"
	@echo "  fiptool        Build the Firmware Image Package(FIP) creation tool"
	@echo ""
	@echo "note: most build targets require PLAT to be set to a specific platform."
	@echo ""
	@echo "example: build all targets for the FVP platform:"
	@echo "  CROSS_COMPILE=aarch64-none-elf- make PLAT=fvp all"