Makefile-common

##############################################################################
#                                                                            #
# Teacup - Lean and efficient firmware for RepRap printers                   #
#                                                                            #
# by Triffid Hunter, Traumflug, jakepoz, many others.                        #
#                                                                            #
# This firmware is Copyright (c) ...                                         #
#   2009 - 2010 Michael Moon aka Triffid_Hunter                              #
#   2010 - 2013 Markus "Traumflug" Hitter <mah@jump-ing.de>                  #
#                                                                            #
# This program is free software; you can redistribute it and/or modify       #
# it under the terms of the GNU General Public License as published by       #
# the Free Software Foundation; either version 2 of the License, or          #
# (at your option) any later version.                                        #
#                                                                            #
# This program is distributed in the hope that it will be useful,            #
# but WITHOUT ANY WARRANTY; without even the implied warranty of             #
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              #
# GNU General Public License for more details.                               #
#                                                                            #
# You should have received a copy of the GNU General Public License          #
# along with this program; if not, write to the Free Software                #
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA #
#                                                                            #
##############################################################################

##############################################################################
#                                                                            #
# This file isn't sufficient on its own. Use the target-specific Makefile    #
# instead, which -includes this file.                                        #
#                                                                            #
##############################################################################

BUILDDIR = build
USER_CONFIG ?= config.h

ifdef BUILD_FLAVOR
BUILDDIR := $(BUILDDIR)/$(BUILD_FLAVOR)
endif

ifneq ($(USER_CONFIG),config.h)
BUILDDIR := $(BUILDDIR)/$(USER_CONFIG:.h=)
endif

CFLAGS += -save-temps=obj -DUSER_CONFIG='"$(USER_CONFIG)"'

CC = $(TOOLCHAIN)gcc
OBJDUMP = $(TOOLCHAIN)objdump
OBJCOPY = $(TOOLCHAIN)objcopy


OBJ = $(patsubst %.c,$(BUILDDIR)/%.o,$(SOURCES))

.PHONY: all clean doc functionsbysize
.PRECIOUS: %.o %.elf

all: $(BUILDDIR) $(TARGET)

clean:
	rm -rf $(BUILDDIR) $(TARGET) *~

doc: Doxyfile *.c *.h
	doxygen $<

functionsbysize: $(OBJ)
	@$(OBJDUMP) -h $^ | grep '\.text\.' | perl -ne '/\.text\.(\S+)\s+([0-9a-f]+)/ && printf "%u\t%s\n", eval("0x$$2"), $$1;' | sort -n

$(BUILDDIR):
	mkdir -p $(BUILDDIR)

# pull in dependency info
-include $(OBJ:%.o=%.P)

# Everything depends on makefiles, excluding auto-built makefiles
$(OBJ): $(filter-out %.P,$(MAKEFILE_LIST))

# Auto-depends extension
df = $(@:.o=)
define CCPOST
	cp $(df).d $(df).P; \
	sed -e 's/#.*//' -e 's/^[^:]*: *//' -e 's/ *\\$$//' \
	  -e '/^$$/ d' -e 's/$$/ :/' < $(df).d >> $(df).P; \
	rm -f $(df).d
endef

$(BUILDDIR)/%.o: %.c | $(BUILDDIR)
	@echo "  CC        $@"
	@$(CC) -c $(CFLAGS) -MMD -o $@ $<
	@$(call CCPOST)

$(BUILDDIR)/%.elf: $(OBJ)
	@echo "  LINK      $@"
	@$(CC) $(CFLAGS) $(LDFLAGS) -o $@ $^ $(LIBS)

$(BUILDDIR)/%.lst: $(BUILDDIR)/%.elf
	@echo "  OBJDUMP   $@"
	@$(OBJDUMP) -h -S $< > $@

%.hex: $(BUILDDIR)/%.elf
	@echo "  OBJCOPY   $@"
	@$(OBJCOPY) -j .text -j .data -O ihex -R .eeprom -R .fuse -R .lock $< $@

$(BUILDDIR)/%.bin: $(BUILDDIR)/%.elf
	@echo "  OBJCOPY   $@"
	@$(OBJCOPY) -j .text -j .data -O binary $< $@

$(BUILDDIR)/%.sym: $(BUILDDIR)/%.elf
	@echo "  SYM       $@"
	@$(OBJDUMP) -t $< | perl -ne 'BEGIN { printf "  ADDR  NAME                  SIZE\n"; } /([0-9a-f]+)\s+(\w+)\s+O\s+\.(bss|data)\s+([0-9a-f]+)\s+(\w+)/ && printf "0x%04x  %-20s +%d\n", eval("0x$$1") & 0xFFFF, $$5, eval("0x$$4")' | sort -k1 > $@


# Helpful tools.

.PHONY: regressiontests

# Try to catch regressions. Put here whatever test can help to detect these
# and can be automated enough to allow to run them with a simple
# "make regressiontests".
regressiontests:
	# Generic Gen7 configuration.
	$(MAKE) -f Makefile-AVR USER_CONFIG=testcases/config.regtest-gen7-avr.h \
	  MCU=atmega644 F_CPU=20000000UL EXTRA_CFLAGS=-Werror all
	# Generic RAMPS configuration.
	$(MAKE) -f Makefile-AVR USER_CONFIG=testcases/config.regtest-ramps.h \
	  MCU=atmega2560 F_CPU=16000000UL EXTRA_CFLAGS=-Werror all
	# Generic Teensy2 configuration, which uses USB_SERIAL and no SD card.
	$(MAKE) -f Makefile-AVR USER_CONFIG=testcases/config.regtest-teensy2.h \
	  MCU=atmega32u4 F_CPU=16000000UL EXTRA_CFLAGS=-Werror all
	# Generic Gen3 configuration for {TX,RX}_ENABLE_PIN.
	$(MAKE) -f Makefile-AVR USER_CONFIG=testcases/config.regtest-gen3.h \
	  MCU=atmega644p F_CPU=16000000UL EXTRA_CFLAGS=-Werror all
	# The configuration used for performance measurements.
	$(MAKE) -f Makefile-AVR USER_CONFIG=testcases/config.h.Profiling \
	  MCU=atmega644 F_CPU=20000000UL EXTRA_CFLAGS=-Werror all
	# Continue with ARM based boards, a Gen7-ARM.
	$(MAKE) -f Makefile-ARM USER_CONFIG=testcases/config.regtest-gen7-arm.h \
	  EXTRA_CFLAGS=-Werror all
	# Don't forget the hostside simulator.
	$(MAKE) -f Makefile-SIM USER_CONFIG=testcases/config.regtest-gen7-avr.h \
	  EXTRA_CFLAGS=-Werror all
	@# Nonstandard builds go into a subdirectory of build/, see definition of
	@# $(BUILDDIR) above. Let's clean that up on success.
	rm -rf $(BUILDDIR)/testcases/ $(BUILDDIR)/sim/
	@echo
	@echo "All regression tests ran successfully, you're fine to commit now."