Makefile

# http://stackoverflow.com/questions/7004702/how-can-i-create-a-makefile-for-c-projects-with-src-obj-and-bin-subdirectories

# output name
TARGET ?= speki

TOOLCHAIN_PATH ?= /gcc-arm-none-eabi/bin/

# type of build "debug", "release-debug" or "release"
BUILD_TYPE = release-debug

# toolchain
CC = $(TOOLCHAIN_PATH)arm-none-eabi-gcc
OC = $(TOOLCHAIN_PATH)arm-none-eabi-objcopy
OD = $(TOOLCHAIN_PATH)arm-none-eabi-objdump
SZ = $(TOOLCHAIN_PATH)arm-none-eabi-size

# static check tools
CPPCHECK = cppcheck
CPPCHECKFLAGS = -i./lib -i./src/system
CPPCHECKFLAGS += --enable=all --inconclusive --std=c11 --template=gcc
CPPCHECKFLAGS += --suppress=unusedFunction --suppress=missingInclude --suppress=unmatchedSuppression
DOXYGEN = doxygen
DOXYFILE = doc/Doxyfile

# output structure
OBJDIR ?= obj
DEPDIR ?= dep
BINDIR ?= bin
DOCDIR ?= doc/doxygen

# processor type
PTYPE = STM32F40_41xxx

# don't change anything under this line if you don't know what you're doing!
# ==========================================================================

# preparation for cross platform compatibility
RM := rm -rf
MKDIR := mkdir -p

# populate variables for includes
CFLAGS_INC :=
CFLAGS_DEF :=
CFLAGS_PROC :=
CFLAGS_BASE :=
LDFLAGS :=
SRCS :=
SRCS_ASM :=

# where are the libraries located?
LIBDIR := lib
SYSDIR ?= sys
BSPDIR ?= BSP
SGUIDIR ?= sGUI
PERIPHDIR ?= STM32F4xx_StdPeriph_Driver
CMSISDIR ?= CMSIS

# include libraries
include $(LIBDIR)/$(SYSDIR)/build.mk
include $(LIBDIR)/$(BSPDIR)/build.mk
include $(LIBDIR)/$(SGUIDIR)/build.mk
include $(LIBDIR)/$(PERIPHDIR)/build.mk
include $(LIBDIR)/$(CMSISDIR)/build.mk

# compiler flags
ifeq ($(BUILD_TYPE), debug)
	CFLAGS_BASE += -ggdb -O0 -DUSE_FULL_ASSERT
else ifeq ($(BUILD_TYPE), release-debug)
	CFLAGS_BASE += -O4 -g3
else ifeq ($(BUILD_TYPE), release)
	CFLAGS_BASE += -O4
else
$(error BUILD_TYPE needs to be set to either debug, release-debug or release)
endif
CFLAGS_BASE += -Wall -std=gnu11 -fdata-sections -ffunction-sections
CFLAGS_BASE += -specs=nano.specs
CFLAGS_BASE += -Wno-format-truncation -Wdouble-promotion -Wstrict-prototypes
CFLAGS_PROC += -mthumb -mcpu=cortex-m4 -mfloat-abi=hard -mfpu=fpv4-sp-d16
CFLAGS_DEF += -D$(PTYPE) -DUSE_STDPERIPH_DRIVER
CFLAGS_DEF += -DHSE_VALUE=25000000 -DSYSCALL_USART=USART1
CFLAGS_DEF += -D_VOLATILE=volatile
CFLAGS_INC += -Iinc
CFLAGS += $(CFLAGS_BASE) $(CFLAGS_PROC) $(CFLAGS_DEF) $(CFLAGS_INC)

# linker flags
LDFLAGS += -Tstm32f4_flash.ld
LDFLAGS += -Wl,-Map,"$(BINDIR)/$(TARGET).map"
LDFLAGS += -Wl,--start-group -lc -lm -Wl,--end-group
LDFLAGS += --specs=nosys.specs
LDFLAGS += -Wl,-cref -Wl,-static
LDFLAGS += -Wl,--gc-sections -Wl,--defsym=malloc_getpagesize_P=0x80

SRCS += $(wildcard src/*.c)
SRCS_ASM += $(wildcard src/*.s)
SRCS_ASM_S += $(wildcard src/*.S)

OBJS := $(SRCS:%.c=$(OBJDIR)/%.o) $(SRCS_ASM:%.s=$(OBJDIR)/%.o) $(SRCS_ASM_S:%.S=$(OBJDIR)/%.o)

# list of target files
TARGETFILES := $(BINDIR)/$(TARGET).elf $(BINDIR)/$(TARGET).bin $(BINDIR)/$(TARGET).lst $(BINDIR)/compile_commands.json

# TARGETS
# =======

# these are not real targets
.PHONY: all clean dirs size test cppcheck doccheck doc

# default target
all: $(TARGETFILES) | dirs

# link and create elf
$(BINDIR)/$(TARGET).elf: $(OBJS) | dirs
	@$(CC) $(CFLAGS) $(LDFLAGS) -o $@ $(OBJS)
	@echo "[LD] $@"

%.hex: %.elf
	@$(OC) -O ihex $< $@
	@echo "[OC] $@"

%.bin: %.elf
	@$(OC) -O binary $< $@
	@echo "[OC] $@"

%.lst: %.elf
	@$(OD) -x -S $< > $@
	@echo "[OD] $@"

# Include auto generated dependency files
-include $(wildcard $(DEPDIR)/*.d)

# compile and generate dependency files
$(OBJDIR)/%.o: %.s | dirs
	@$(CC) $(CFLAGS) -c -o $@ $< -MMD -MF $(DEPDIR)/$(*F).d
	@echo "[AS] $<"

# compile and generate dependency files
$(OBJDIR)/%.o: %.S | dirs
	@$(CC) $(CFLAGS) -c -o $@ $< -MMD -MF $(DEPDIR)/$(*F).d
	@echo "[AS] $<"

# compile and generate dependency files
$(OBJDIR)/%.o: %.c | dirs
	@$(CC) $(CFLAGS) -c -o $@ $< -MMD -MF $(DEPDIR)/$(*F).d
	@echo "[CC] $<"

# output size information
size: $(BINDIR)/$(TARGET).elf
	@$(SZ) $(BINDIR)/$(TARGET).elf

flash: $(BINDIR)/$(TARGET).elf
	openocd -f openocd.cfg

# create directories
dirs:
	@$(MKDIR) $(dir $(OBJS))
	@$(MKDIR) $(DEPDIR)
	@$(MKDIR) $(BINDIR)

# remove output files
clean:
	@echo "[RM] $(OBJDIR)"
	@$(RM) $(OBJDIR)
	@echo "[RM] $(DEPDIR)"
	@$(RM) $(DEPDIR)
	@echo "[RM] $(BINDIR)"
	@$(RM) $(BINDIR)
	@echo "[RM] $(DOCDIR)"
	@$(RM) $(DOCDIR)

# run all static checks
test: cppcheck -doccheck

# static check with cppcheck.
# in CI export errors in junit-xml format
cppcheck: $(BINDIR)/compile_commands.json
	@$(CPPCHECK) $(CPPCHECKFLAGS) .
ifdef CI
	@$(CPPCHECK) $(CPPCHECKFLAGS) . \
		--xml-version=2 2> cppcheck_result.xml 1>/dev/null
	@cppcheck_junit cppcheck_result.xml cppcheck_junit.xml
endif

# check for undocumented files
# in CI export errors in junit-xml format
doccheck: -doc
ifdef CI
	@doxygen_junit --input doxy_result.log --output doxy_junit.xml
	@test ! -s doxy_result.log
endif

# generate doxygen documentation
# in CI enable logging of errors
doc:
ifdef CI
	@echo "WARN_LOGFILE = doxy_result.log" >> $(DOXYFILE)
endif
	@$(DOXYGEN) $(DOXYFILE)

# update target but ignore errors
-%:
	-@$(MAKE) --no-print-directory $*

# rules to generate a compile_commands.json
%.compdb_entry: %.c
	@echo "    {" > $@
	@echo "        \"command\": \"$(CC) $(CFLAGS) -c $<\"," >> $@
	@echo "        \"directory\": \"$(CURDIR)\"," >> $@
	@echo "        \"file\": \"$<\"" >> $@
	@echo "    }," >> $@

COMPDB_ENTRIES = $(addsuffix .compdb_entry, $(basename $(SRCS)))

$(BINDIR)/compile_commands.json: $(COMPDB_ENTRIES)
	@echo "[" > $@.tmp
	@cat $^ >> $@.tmp
	@sed '$$d' < $@.tmp > $@
	@echo "    }" >> $@
	@echo "]" >> $@
	@rm $@.tmp
	@rm $^