Makefile

###############################################################################
#
# flipflip's ESP8266 Tschenggins Lämpli
#
# Copyright (c) 2018 Philippe Kehl <flipflip at oinkzwurgl dot org>
#
###############################################################################

# the normal SDK and the RTOS SDK
SDKBASE  ?= esp-open-sdk
RTOSBASE ?= esp-open-rtos

ifeq (,$(wildcard $(SDKBASE)))
$(error Missing or wrong SDKBASE! Symlink /path/to/esp-open-sdk here)
endif
ifeq (,$(wildcard $(RTOSBASE)))
$(error Missing or wrong RTOSBASE! Symlink /path/to/esp-open-rtos here)
endif

# we want all intermediate and output files here
OUTPUT_DIR   ?= output/
BUILD_DIR    = $(OUTPUT_DIR)build/
FIRMWARE_DIR = $(OUTPUT_DIR)firmware/

# we need the xtensa compiler and the esptool in the path
PATH := $(SDKBASE)/xtensa-lx106-elf/bin:$(SDKBASE)/esptool:$(PATH)

# build config
PROGRAM         = tschenggins-laempli
PROGRAM_SRC_DIR = ./src ./3rdparty
PROGRAM_INC_DIR = ./src ./3rdparty $(PROGRAM_OBJ_DIR)

EXTRA_COMPONENTS = extras/jsmn extras/bearssl
EXTRA_CFLAGS    += -DJSMN_PARENT_LINKS -Wenum-compare

EXTRA_CFLAGS    += -DSYSPARAM_DEBUG=3

EXTRA_CFLAGS    += -DWIFI_PARAM_SAVE=0

# TODO: add program_CFLAGS !!

#WARNINGS_AS_ERRORS = 1

# ESP8266 config (see esp-open-rtos/parameters.mk)
ESPPORT         = /dev/ttyUSB0
ESPBAUD         = 1500000
FLASH_MODE      = dout
#FLASH_MODE      = dio
FLASH_SIZE      = 32
FLASH_SPEED     = 40

include $(RTOSBASE)/common.mk


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

CONFIG            ?= config
CONFIG_STASSID    ?=
CONFIG_STAPASS    ?=
CONFIG_BACKENDURL ?=
CONFIG_CRTFILE    ?=

ifneq ($(MAKECMDGOALS),info)
ifneq ($(MAKECMDGOALS),clean)
ifneq ($(MAKECMDGOALS),help)
ifneq ($(MAKECMDGOALS),debug)
ifneq ($(MAKECMDGOALS),doc)
  #$(info CONFIG_STASSID=$(CONFIG_STASSID))
  #$(info CONFIG_STAPASS=$(CONFIG_STAPASS))
  #$(info CONFIG_BACKENDURL=$(CONFIG_BACKENDURL))
  #$(info CONFIG_CRTFILE=$(CONFIG_CRTFILE))
  ifneq ($(CONFIG),)
    ifeq (,$(wildcard $(CONFIG).mk))
      $(error Illegal CONFIG. There is no $(CONFIG).mk file)
    endif
    -include $(CONFIG).mk
  endif
  ifeq ($(CONFIG_STASSID),)
    $(error Missing CONFIG_STASSID! Check your $(CONFIG).mk file. Say 'make info' for details)
  endif
  ifeq ($(CONFIG_STASSID),"")
    $(error Missing CONFIG_STASSID! Check your $(CONFIG).mk file. Say 'make info' for details)
  endif
  ifeq ($(CONFIG_STAPASS),)
    $(error Missing CONFIG_STAPASS! Check your $(CONFIG).mk file. Say 'make info' for details)
  endif
  ifeq ($(CONFIG_STAPASS),"")
    $(error Missing CONFIG_STAPASS! Check your $(CONFIG).mk file. Say 'make info' for details)
  endif
  ifeq ($(CONFIG_BACKENDURL),)
    $(error Missing CONFIG_BACKENDURL! Check your $(CONFIG).mk file. Say 'make info' for details)
  endif
  ifeq ($(CONFIG_BACKENDURL),"")
    $(error Missing CONFIG_BACKENDURL! Check your $(CONFIG).mk file. Say 'make info' for details)
  endif
  ifeq ($(findstring https,$(CONFIG_BACKENDURL)),https)
    ifeq ($(CONFIG_CRTFILE),)
      $(error Missing CONFIG_CRTFILE! Check your $(CONFIG).mk file. Say 'make info' for details)
    endif
    ifeq ($(CONFIG_CRTFILE),"")
      $(error Missing CONFIG_CRTFILE! Check your $(CONFIG).mk file. Say 'make info' for details)
    endif
  endif
endif
endif
endif
endif
endif

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

GREP    := grep
PERL    := perl
TEE     := tee
SED     := sed
DATE    := date
HEAD    := head
TOUCH   := touch
MKDIR   := mkdir
RM      := rm
MV      := mv
CP      := cp
AWK     := awk
FIND    := find
SORT    := sort
CSCOPE  := cscope
DOXYGEN := doxygen
CHMOD   := chmod
CAT     := cat
MD5SUM  := md5sum

# verbosity helpers
ifeq ($(V),1)
V =
V1 =
V2 =
V12 =
OBJCOPY += -v
RM += -v
MV += -v
else
V = @
V1 = > /dev/null
V2 = 2> /dev/null
V12 = 2>&1 > /dev/null
VQ = -q
endif

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

CSCOPEDIRS := $(PROGRAM_SRC_DIR) $(PROGRAM_INC_DIR) \
	$(RTOSBASE)/libc/xtensa-lx106-elf/include/ $(RTOSBASE)/include $(RTOSBASE)/open_esplibs \
	$(RTOSBASE)/FreeRTOS/Source $(RTOSBASE)/core $(RTOSBASE)/extras $(RTOSBASE)/lwip

cscope.files: Makefile
	$(vecho) "GEN $@"
	$(Q)$(FIND) $(CSCOPEDIRS) \
        \( -type d \( -name .git -o -name .svn -o -false \) -prune \) \
        -o \( -iname '*.[ch]' -o -false \) -and \( -type f -o -type l \) -print \
		| $(SORT) -u > $@

cscope.out: cscope.files
	$(vecho) "GEN $@"
	$(Q)$(RM) -f cscope.out*
	$(Q)$(CSCOPE) -f $@ -b -k

cscope: cscope.out
clean: cscope-clean
cscope-clean:
	$(Q)$(RM) -f cscope.*

all: cscope

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

# show debug output
.PHONY: debug
debug:
	$(Q)$(PERL) tools/debug.pl $(ESPPORT):115200

# symbol table
$(BUILD_DIR)$(PROGRAM).sym: $(PROGRAM_OUT)
	$(vecho) "GEN $@"
	$(Q)$(OBJDUMP) -t $< > $@

# full listing
$(BUILD_DIR)$(PROGRAM).lst: $(PROGRAM_OUT)
	$(vecho) "GEN $@"
	$(Q)$(OBJDUMP) -h -S $< > $@

# print list of IRAM symbols
$(BUILD_DIR)$(PROGRAM).sym_iram: $(PROGRAM_OUT) tools/symbols.pl
	$(vecho) "GEN $@"
	$(Q)$(OBJDUMP) -t $< | $(PERL) tools/symbols.pl iRAM 0x40100000 0x8000 > $@

# print list of IROM symbols
$(BUILD_DIR)$(PROGRAM).sym_irom: $(PROGRAM_OUT) tools/symbols.pl
	$(vecho) "GEN $@"
	$(Q)$(OBJDUMP) -t $< | $(PERL) tools/symbols.pl iROM 0x40200000 0x5c000 > $@

# print list of DRAM symbols
$(BUILD_DIR)$(PROGRAM).sym_dram: $(PROGRAM_OUT) tools/symbols.pl
	$(vecho) "GEN $@"
	$(Q)$(OBJDUMP) -t $< | $(PERL) tools/symbols.pl dRAM 0x3ffe8000 0x14000 > $@

# print object size info
$(BUILD_DIR)$(PROGRAM).size: $(PROGRAM_OUT) $(BUILD_DIR)$(PROGRAM).sym_iram $(BUILD_DIR)$(PROGRAM).sym_irom  $(BUILD_DIR)$(PROGRAM).sym_dram
	$(vecho) "GEN $@"
	$(Q)$(SIZE) -Ax $< > $@
	$(Q)$(SIZE) -Bd $< >> $@
	$(Q)$(SIZE) -Bx $< >> $@
#	$(Q)$(SIZE) -Bd $(OFILES) >> $@
	@echo >> $@
	@echo >> $@
	@echo >> $@
	$(Q)$(GREP) -h ^total $(subst .size,.sym_iram,$@) $(subst .size,.sym_irom,$@) $(subst .size,.sym_dram,$@) | $(TEE) -a $@

# add sizes and symbol lists to the main build target
all: $(BUILD_DIR)$(PROGRAM).size $(BUILD_DIR)$(PROGRAM).lst $(BUILD_DIR)$(PROGRAM).sym

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

# build version
BUILDVER    := $(shell $(PERL) tools/version.pl)
BUILDDATE   := $(shell $(DATE) +"%Y-%m-%d %H:%M")
GCCVERSION  := $(shell PATH=$(PATH) $(CC) --version | $(HEAD) -n1)
EORVERSION  := $(shell $(PERL) tools/version.pl $(RTOSBASE))
SDKVERSION  := $(shell $(PERL) tools/version.pl $(SDKBASE))

VERFP = $(BUILDVER)-$(EORVERSION)-$(SDKVERSION)
VERFP_OLD := $(shell $(SED) -n '/fingerprint /s/.*fingerprint //p' $(PROGRAM_OBJ_DIR)ver_gen.h 2>/dev/null || echo nover)

# trigger generation of ver_gen.h if necessary
ifneq ($(VERFP),$(VERFP_OLD))
$(shell $(MKDIR) -p $(PROGRAM_OBJ_DIR); $(TOUCH) $(PROGRAM_OBJ_DIR).ver_gen.h)
endif

# generate version include file
$(PROGRAM_OBJ_DIR)ver_gen.h: $(PROGRAM_OBJ_DIR).ver_gen.h Makefile | $(PROGRAM_OBJ_DIR)
	$(vecho) "GEN $@"
	$(Q)$(RM) -f $@
	$(Q)echo "#ifndef __VER_GEN_H__"                   >> $@.tmp
	$(Q)echo "#define __VER_GEN_H__"                   >> $@.tmp
	$(Q)echo "// fingerprint $(VERFP)"                 >> $@.tmp
	$(Q)echo "#define FF_GCCVERSION \"$(GCCVERSION)\"" >> $@.tmp
	$(Q)echo "#define FF_BUILDVER   \"$(BUILDVER)\""   >> $@.tmp
	$(Q)echo "#define FF_BUILDDATE  \"$(BUILDDATE)\""  >> $@.tmp
	$(Q)echo "#define FF_PROGRAM    \"$(PROGRAM)\""    >> $@.tmp
	$(Q)echo "#define FF_EORVERSION \"$(EORVERSION)\"" >> $@.tmp
	$(Q)echo "#define FF_SDKVERSION \"$(SDKVERSION)\"" >> $@.tmp
	$(Q)echo "#endif"                                  >> $@.tmp
	$(Q)$(MV) $@.tmp $@

# all source file may need this
$(PROGRAM_OBJ_FILES): $(PROGRAM_OBJ_DIR)ver_gen.h

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

CFGMD5     := $(shell $(MD5SUM) $(CONFIG).mk 2>/dev/null)
CFGMD5_OLD := $(shell $(SED) -n '/fingerprint /s/.*fingerprint //p' $(PROGRAM_OBJ_DIR)cfg_gen.h 2>/dev/null || echo nocfg)

# trigger generation of cfg_gen.h if necessary
ifneq ($(CFGMD5),$(CFGMD5_OLD))
$(shell $(MKDIR) -p $(PROGRAM_OBJ_DIR); $(TOUCH) $(PROGRAM_OBJ_DIR).cfg_gen.h)
endif

$(PROGRAM_OBJ_DIR)cfg_gen.h: Makefile $(PROGRAM_OBJ_DIR).cfg_gen.h $(CONFIG).mk | $(PROGRAM_OBJ_DIR)
	$(vecho) "GEN $@ ($(CONFIG))"
	$(Q)$(RM) -f $@
	$(Q)echo "#ifndef __CFG_GEN_H__" >> $@.tmp
	$(Q)echo "#define __CFG_GEN_H__" >> $@.tmp
	$(Q)echo "// fingerprint $(CFGMD5)" >> $@.tmp
	$(Q)echo "#define FF_CFG_STASSID    \"$(CONFIG_STASSID)\"" >> $@.tmp
	$(Q)echo "#define FF_CFG_STAPASS    \"$(CONFIG_STAPASS)\"" >> $@.tmp
	$(Q)echo "#define FF_CFG_BACKENDURL \"$(CONFIG_BACKENDURL)\"" >> $@.tmp
	$(Q)echo "#endif" >> $@.tmp
	$(Q)$(MV) $@.tmp $@

# all source file may need this
$(PROGRAM_OBJ_FILES): $(PROGRAM_OBJ_DIR)cfg_gen.h

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

ifeq ($(CONFIG_CRTFILE),)
_NO_CRT = 1
endif
ifeq ($(CONFIG_CRTFILE),"")
_NO_CRT = 1
endif

ifneq ($(_NO_CRT),1)
CRTMD5     := $(shell $(MD5SUM) $(CONFIG_CRTFILE) 2>/dev/null)
endif
CRTMD5_OLD := $(shell $(SED) -n '/fingerprint /s/.*fingerprint //p' $(PROGRAM_OBJ_DIR)crt_gen.h 2>/dev/null || echo nocrt)

# trigger generation of crt_gen.h if necessary
ifneq ($(CRTMD5),$(CRTMD5_OLD))
$(shell $(MKDIR) -p $(PROGRAM_OBJ_DIR); $(TOUCH) $(PROGRAM_OBJ_DIR).crt_gen.h)
endif

ifeq ($(_NO_CRT),1)

$(PROGRAM_OBJ_DIR)crt_gen.h: $(PROGRAM_OBJ_DIR).crt_gen.h | $(PROGRAM_OBJ_DIR)
	$(vecho) "GEN $@ (dummy)"
	$(Q)$(RM) -f $@
	$(Q)$(TOUCH) $@
else

# we need the brssl tool
BRSSL_REL := build/brssl
BRSSL     := $(BEARSSL_DIR)$(BRSSL_REL)

$(BRSSL): $(BEARSSL_DIR)
	$(Q)$(MAKE) -C $(BEARSSL_DIR) $(BRSSL_REL)

$(PROGRAM_OBJ_DIR)crt_gen.h: Makefile $(PROGRAM_OBJ_DIR).crt_gen.h $(CONFIG_CRTFILE) $(BRSSL) | $(PROGRAM_OBJ_DIR)
	$(vecho) "GEN $@ ($(CONFIG_CRTFILE))"
	$(Q)$(RM) -f $@
	$(Q)echo "#ifndef __CRT_GEN_H__" >> $@.tmp
	$(Q)echo "#define __CRT_GEN_H__" >> $@.tmp
	$(Q)echo "// fingerprint $(CRTMD5)" >> $@.tmp
	$(Q)echo "#define HAVE_CRT 1" >> $@.tmp
	$(Q)echo "#define CRT_TODAY $(shell $(DATE) --utc '+%s')" >> $@.tmp
	$(Q)$(BRSSL) ta -q $(CONFIG_CRTFILE) >> $@.tmp
	$(Q)echo "#endif" >> $@.tmp
	$(Q)$(MV) $@.tmp $@

endif

# wifi.c file will need this
$(PROGRAM_OBJ_FILES): $(PROGRAM_OBJ_DIR)crt_gen.h

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

FW_FILE_RBOOT_BIN  := $(OUTPUT_DIR)0x00000_rboot.bin
FW_FILE_RBOOT_CONF := $(OUTPUT_DIR)0x01000_blank.bin
FW_FILE_FIRMWARE   := $(OUTPUT_DIR)0x02000_$(PROGRAM)_$(BUILDVER)_$(CONFIG_STASSID).bin

all: $(FW_FILE_RBOOT_BIN) $(FW_FILE_RBOOT_CONF) $(FW_FILE_FIRMWARE)

$(FW_FILE_RBOOT_BIN): $(RBOOT_BIN)
	$(Q)$(CP) $^ $@

$(FW_FILE_RBOOT_CONF): $(RBOOT_CONF)
	$(Q)$(CP) $^ $@

$(FW_FILE_FIRMWARE): $(FW_FILE)
	$(Q)$(CP) $^ $@

clean: fw-files-clean
.PHONY: fw-files-clean
fw-files-clean:
	$(Q)$(RM) -f $(OUTPUT_DIR)0x*.bin

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

#DOC_GEN_FILES := $(PROGRAM_OBJ_DIR)version_gen.h
DOXY_WARNINGS_LOG := $(BUILD_DIR)doxygen_warnings.log
DOXY_LOG := $(BUILD_DIR)doxygen.log

$(DOXY_WARNINGS_LOG): | $(BUILD_DIR)
$(DOXY_LOG): | $(BUILD_DIR)

.PHONY: doc
doc: $(OUTPUT_DIR)html/.done
$(OUTPUT_DIR)html/.done: Makefile $(CFILES) $(HFILES) Doxyfile tools/doxylogfix.pl $(DOC_GEN_FILES) $(wildcard src/*.h) $(wildcard src/*.c)
# remove previous output and create new output directory
	$(Q)$(RM) -rf $(OUTPUT_DIR)html
	$(Q)$(MKDIR) -p $(OUTPUT_DIR)html
# generate documentation (run the doxygen tool)
	@echo "$(HLG)R Doxygen $(HLR)$(OUTPUT_DIR)html$(HLO)"
	$(Q)(\
		$(CAT) Doxyfile; \
		echo "PROJECT_NUMBER = $(BUILDVER)"; \
		echo "OUTPUT_DIRECTORY = $(OUTPUT_DIR)"; \
		echo "WARN_LOGFILE = $(DOXY_WARNINGS_LOG)"; \
		echo "INPUT += $(DOC_GEN_FILES)"; \
	) | $(DOXYGEN) - | $(TEE) $(DOXY_LOG) $(V1)
# make paths in the logfiles relative
	$(Q)$(SED) -i -r -e 's@$(CURDIR)/?@./@g' -e '/^$$/d' $(DOXY_WARNINGS_LOG) $(DOXY_LOG)
# remove some known won't-fix warnings in the logfile
	$(Q)$(PERL) tools/doxylogfix.pl < $(DOXY_WARNINGS_LOG) > $(DOXY_WARNINGS_LOG)-clean
	$(Q)if [ -s $(DOXY_WARNINGS_LOG)-clean ]; then \
		$(CAT) $(DOXY_WARNINGS_LOG)-clean; \
	else \
		echo "no warnings" > $(DOXY_WARNINGS_LOG)-clean; \
	fi
# inject the warnings and doxygen logfiles into the generated HTML
	$(Q)$(SED) -i \
		-e '/%DOXYGEN_LOG/r $(DOXY_LOG)' \
		-e '/%DOXYGEN_WARNINGS/r $(DOXY_WARNINGS_LOG)-clean' \
		-e '/%DOXYGEN_WARNINGS/s/%DOXYGEN_WARNINGS%//' \
		-e '/%DOXYGEN_LOG/s/%DOXYGEN_LOG%//' \
		$(OUTPUT_DIR)html/P_DOXYGEN.html
# make docu files world-readable
	$(Q)$(CHMOD) -R a+rX $(OUTPUT_DIR)html
# done
	$(Q)$(TOUCH) $@

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

help: ourhelp

.PHONY: ourhelp
ourhelp:
	@echo
	@echo "****** Say 'make info' for Tschenggins Lämpli help! *****"
	@echo


.PHONY: info
info:
	@echo "Tschenggins Lämpli Makefile Help"
	@echo
	@echo "This uses the esp-open-rtos make system. Say 'make help' for their help."
	@echo
	@echo "Say 'make' to build using the configuration from config.mk."
	@echo
	@echo "Say 'make CONFIG=myconfig' to build using the configuration from myconfig.mk."
	@echo
	@echo "Say 'make debug' to pretty-print debug output from the Lämpli".
	@echo
	@echo "Typical development command line:"
	@echo "make -j8 CONFIG=myconfig flash && make debug"
	@echo
	@echo "To get the server certificate from an existing server, do something like this:"
	@echo "openssl s_client -showcerts -servername google.com -connect google.com:443 < /dev/null | \\"
	@echo "  openssl x509 -outform pem > server.crt"
	@echo
	@echo "Happy hacking! :-)"


###############################################################################
# eof