# Generic Makefile for compiling ARM microcontroller firmware

# Copyright (C)2013-2020, Philip Munts, President, Munts AM Corp.
#
# 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.
#
# 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.

###############################################################################

# Define a default target placeholder

ARM_mk_default:
	@echo ERROR: You must explicitly specify a make target!
	@exit 1

###############################################################################

# Toolchain definitions

CROSS_COMPILE	?= /usr/local/gcc-arm-none-eabi/bin/arm-none-eabi-

CC		= $(CROSS_COMPILE)gcc
CXX		= $(CROSS_COMPILE)g++
LD		= $(CROSS_COMPILE)ld
AR		= $(CROSS_COMPILE)ar
STRIP		= $(CROSS_COMPILE)strip
OBJCOPY		= $(CROSS_COMPILE)objcopy
OBJDUMP		= $(CROSS_COMPILE)objdump
GDB		= $(CROSS_COMPILE)gdb

FIND		?= find

###############################################################################

# Framework general definitions

MCUDIR		?= $(ARMSRC)/gcc/$(MCUFAMILY)
MCUFAMILYNAME	:= $(shell echo $(MCUFAMILY) | tr '[a-z]' '[A-Z]')
MCULIBRARY	= $(MCUDIR)/lib$(MCU).a
MCULINKSCRIPT	= $(MCUDIR)/$(MCU).ld

###############################################################################

# Include MCU dependent makefile

include $(MCUDIR)/$(MCUFAMILY).mk

###############################################################################

# Support for common library functions

COMMON_DIR	= $(ARMSRC)/gcc/common
include $(COMMON_DIR)/common.mk

###############################################################################

# Support for the lightweight console I/O library

ifeq ($(WITH_CONIO), yes)
IOFLAGS += -DCONIO_STDIO
endif

###############################################################################

# Support for floating point I/O

ifeq ($(WITH_FLOATINPUT), yes)
IOFLAGS	+= -DFLOATIO -u _scanf_float
endif

ifeq ($(WITH_FLOATOUTPUT), yes)
IOFLAGS	+= -DFLOATIO -u _printf_float
endif

ifeq ($(WITH_FLOATIO), yes)
IOFLAGS	+= -DFLOATIO -u _printf_float -u _scanf_float
endif

###############################################################################

# Support for FreeRTOS

ifeq ($(WITH_FREERTOS), yes)
FREERTOS_DIR	= $(ARMSRC)/gcc/FreeRTOS
include $(FREERTOS_DIR)/FreeRTOS.mk
endif

###############################################################################

# Compiler and linker flags

CPUFLAGS	+= -D$(MCU) -D$(BOARDNAME) -DBOARDNAME='"$(BOARDNAME)"'
CPUFLAGS	+= -DMCUFAMILYNAME='"$(MCUFAMILYNAME)"'
DEBUGFLAGS	?= -g
OPTFLAGS	?= -O0
CFLAGS		+= $(EARLYFLAGS)
CFLAGS		+= -Wall -ffunction-sections
CFLAGS		+= -I$(ARMSRC)/gcc/include -I$(MCUDIR)
CFLAGS		+= $(CPUFLAGS) $(BOARDFLAGS) $(CONSOLEFLAGS) $(IOFLAGS)
CFLAGS		+= $(CONFIGFLAGS) $(OPTFLAGS) $(DEBUGFLAGS) $(EXTRAFLAGS)
CXXFLAGS	+= -fno-use-cxa-atexit -D_GLIBCXX_USE_C99=1 -std=c++1y
LDFLAGS		+= -nostartfiles -T$(MCULINKSCRIPT) -L$(MCUDIR) -l$(MCU) -lm -lstdc++
LDFLAGS		+= -Wl,-Map=$*.map,--cref,--gc-sections $(EXTRAOBJS)

###############################################################################

# Recursive make flags, to be passed to subordinate makes

RMAKEFLAGS	+= ARMSRC=$(ARMSRC)
RMAKEFLAGS	+= BOARDNAME=$(BOARDNAME)
RMAKEFLAGS	+= CFLAGS='$(CFLAGS)' CXXFLAGS='$(CXXFLAGS)' LDFLAGS='$(LDFLAGS)'
ifeq ($(WITH_FREERTOS), yes)
RMAKEFLAGS	+= FREERTOS_ARCH=$(FREERTOS_ARCH)
endif

###############################################################################

# GDB definitions

GDBSERVERPORT	= 3333
#GDBGUI		?= ddd --gdb --debugger
#GDBFLAGS	?= -tui

###############################################################################

# These targets are not files

.PHONY: ARM_mk_default ARM_mk_lib ARM_mk_clean

# Don't delete intermediate files

.SECONDARY:

###############################################################################

# Define some suffix rules

.SUFFIXES: .asm .c .cpp .bin .dmp .elf .hex .o .s .S

.c.o:
	$(CC) $(CFLAGS) -c -o $@ $<

.cpp.o:
	$(CXX) $(CFLAGS) $(CXXFLAGS) -c -o $@ $<

.o.elf:
	$(MAKE) -C $(MCUDIR) lib$(MCU).a $(RMAKEFLAGS)
	$(CC) $(CFLAGS) -o $@ $< $(LDFLAGS)

.elf.asm:
	$(OBJDUMP) -S -d $< >$@

.elf.bin:
	$(OBJCOPY) -S -O binary --gap-fill=0 $< $@

.elf.hex:
	$(OBJCOPY) -S -O ihex --change-addresses=$(FLASHWRITEADDR) --gap-fill=0 $< $@

.bin.dmp:
	hexdump -C $< > $@

.s.o:
	$(CC) $(CFLAGS) -c -o $@ -c $<

.S.o:
	$(CC) $(CFLAGS) -c -o $@ -c $<

###############################################################################

# Build the MCU dependent support library

ARM_mk_lib:
	$(MAKE) -C $(MCUDIR) lib$(MCU).a $(RMAKEFLAGS)

###############################################################################

# Clean out working files

ARM_mk_clean:
	rm -f *.a *.asm *.bin *.dmp *.elf *.hex *.log *.map *.stackdump *.tmp Default.ini
	$(FIND) * -name '*.o' -exec rm {} ";"
	cd $(MCUDIR) && rm -f *.a *.asm *.bin *.dmp *.elf *.hex *.log *.map *.stackdump *.tmp Default.ini
	cd $(MCUDIR) && $(FIND) * -name '*.o' -exec rm {} ";"
	cd $(MCUDIR) && $(MAKE) clean_$(MCU) $(CLEANTARGETS) $(RMAKEFLAGS)

###############################################################################

# Include programming and debugging makefiles

include $(ARMSRC)/gcc/include/dfu.mk
include $(ARMSRC)/gcc/include/jlink.mk
include $(ARMSRC)/gcc/include/lpc21isp.mk
include $(ARMSRC)/gcc/include/mbed.mk
include $(ARMSRC)/gcc/include/openocd.mk
include $(ARMSRC)/gcc/include/stlink.mk