Makefile

#
# @section License
#
# The MIT License (MIT)
#
# Copyright (c) 2014-2018, Erik Moqvist
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation
# files (the "Software"), to deal in the Software without
# restriction, including without limitation the rights to use, copy,
# modify, merge, publish, distribute, sublicense, and/or sell copies
# of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
#
# This file is part of the Simba project.
#

.PHONY: tags doc

SIMBA_VERSION ?= $(shell cat VERSION.txt)

BOARD ?= linux

ifeq ($(BOARD), linux)
    TESTS = $(addprefix tst/kernel/, \
	sys \
	thrd \
	time \
	timer)
    TESTS += $(addprefix tst/sync/, \
	bus \
	cond \
	chan \
	event \
	mutex \
	queue \
	rwlock \
	sem)
    TESTS += $(addprefix tst/collections/, \
	binary_tree \
	bits \
	circular_buffer \
	fifo \
	hash_map \
	list)
    TESTS += $(addprefix tst/alloc/, \
	circular_heap \
	heap)
    TESTS += $(addprefix tst/text/, \
	configfile \
	emacs \
	std \
	re)
    TESTS += $(addprefix tst/debug/, \
	log \
	harness)
    TESTS += $(addprefix tst/oam/, \
	nvm \
	service \
	settings \
	shell \
	soam)
#	upgrade \
#	upgrade/http \
#	upgrade/kermit \
#	upgrade/uds)
    TESTS += $(addprefix tst/filesystems/, \
	fat16 \
	fs)
#	spiffs)
    TESTS += $(addprefix tst/encode/, \
	base64 \
	json \
	nmea)
    TESTS += $(addprefix tst/hash/, \
	crc \
	sha1)
    TESTS += $(addprefix tst/inet/, \
	http_server \
	http_websocket_client \
	http_websocket_server \
	inet \
	isotp \
	mqtt_client \
	ping \
	slip \
	ssl \
	tftp_server)
    TESTS += $(addprefix tst/multimedia/, \
	midi)
    TESTS += $(addprefix tst/drivers/software/, \
	network/jtag_soft \
	network/xbee \
	network/xbee_client \
	sensors/dht \
	sensors/bmp280 \
	sensors/hx711 \
	storage/eeprom_soft \
	various/gnss)
    TESTS += $(addprefix tst/science/, \
	math \
	science)
endif

ifeq ($(BOARD), arduino_due)
    TESTS = $(addprefix tst/kernel/, \
	sys \
	thrd \
	time \
	timer)
    TESTS += $(addprefix tst/sync/, \
	bus \
	event \
	queue \
	rwlock \
	sem)
    TESTS += $(addprefix tst/collections/, \
	binary_tree \
	bits \
	fifo \
	hash_map)
    TESTS += $(addprefix tst/alloc/, \
	circular_heap \
	heap)
    TESTS += $(addprefix tst/text/, \
	configfile \
	std \
	re)
    TESTS += $(addprefix tst/debug/, \
	log)
    TESTS += $(addprefix tst/oam/, \
	settings \
	shell)
    TESTS += $(addprefix tst/filesystems/, \
	fs \
	spiffs)
    TESTS += $(addprefix tst/encode/, \
	base64 \
	json)
    TESTS += $(addprefix tst/hash/, \
	crc \
	sha1)
    TESTS += $(addprefix tst/drivers/hardware/, \
	basic/chipid \
	network/can \
	storage/flash)
endif

ifeq ($(BOARD), arduino_mega)
    TESTS = $(addprefix tst/kernel/, \
	sys \
	thrd \
	time \
	timer)
    TESTS += $(addprefix tst/sync/, \
	bus \
	event \
	queue \
	rwlock \
	sem)
    TESTS += $(addprefix tst/collections/, \
	binary_tree \
	bits \
	fifo \
	hash_map)
    TESTS += $(addprefix tst/alloc/, \
	circular_heap \
	heap)
    TESTS += $(addprefix tst/text/, \
	configfile \
	std \
	re)
    TESTS += $(addprefix tst/debug/, \
	log)
    TESTS += $(addprefix tst/oam/, \
	settings \
	shell)
    TESTS += $(addprefix tst/filesystems/, \
	fat16 \
	fs)
    TESTS += $(addprefix tst/encode/, \
	base64)
    TESTS += $(addprefix tst/hash/, \
	crc \
	sha1)
    TESTS += $(addprefix tst/inet/, \
	http_websocket_client \
	http_websocket_server \
	inet \
	mqtt_client \
	ping)
    TESTS += $(addprefix tst/drivers/hardware/, \
	basic/adc \
	basic/analog_input_pin \
	various/ds3231 \
	storage/sd \
	basic/pin)
endif

ifeq ($(BOARD), arduino_nano)
    TESTS = $(addprefix tst/drivers/hardware/, \
	sensors/ds18b20 \
	basic/analog_output_pin \
	basic/exti \
	network/owi)
endif

ifeq ($(BOARD), arduino_pro_micro)
    TESTS = $(addprefix tst/kernel/, \
	sys \
	thrd \
	timer)
endif

ifeq ($(BOARD), esp12e)
    TESTS = $(addprefix tst/kernel/, \
	sys \
	thrd \
	timer)
endif

ifeq ($(BOARD), nodemcu)
    TESTS = $(addprefix tst/kernel/, \
	sys \
	thrd \
	timer)
    TESTS += $(addprefix tst/sync/, \
	bus \
	event \
	queue \
	rwlock \
	sem)
    TESTS += $(addprefix tst/collections/, \
	binary_tree \
	bits \
	fifo \
	hash_map)
    TESTS += $(addprefix tst/alloc/, \
	circular_heap)
    TESTS += $(addprefix tst/text/, \
	std \
	re)
    TESTS += $(addprefix tst/debug/, \
	log)
    TESTS += $(addprefix tst/oam/, \
	shell)
    TESTS += $(addprefix tst/encode/, \
	base64 \
	json)
    TESTS += $(addprefix tst/hash/, \
	crc \
	sha1)
    TESTS += $(addprefix tst/inet/, \
	http_websocket_client \
	http_websocket_server \
	inet \
	mqtt_client \
	network_interface/wifi_esp \
	ping)
    TESTS += $(addprefix tst/drivers/hardware/, \
	basic/pin \
	basic/random \
	basic/power)
    TESTS += $(addprefix tst/filesystems/, \
	fs \
	spiffs)
endif

ifeq ($(BOARD), nano32)
    TESTS = $(addprefix tst/kernel/, \
	sys \
	thrd \
	timer)
    TESTS += $(addprefix tst/sync/, \
	bus \
	event \
	queue \
	rwlock \
	sem)
    TESTS += $(addprefix tst/collections/, \
	binary_tree \
	bits \
	fifo \
	hash_map)
    TESTS += $(addprefix tst/alloc/, \
	circular_heap)
    TESTS += $(addprefix tst/text/, \
	std \
	re)
    TESTS += $(addprefix tst/debug/, \
	log)
    TESTS += $(addprefix tst/oam/, \
	shell)
    TESTS += $(addprefix tst/encode/, \
	base64 \
	json)
    TESTS += $(addprefix tst/hash/, \
	crc \
	sha1)
    TESTS += $(addprefix tst/inet/, \
	http_websocket_client \
	http_websocket_server \
	inet \
	mqtt_client_network \
	network_interface/wifi_esp \
	ping)
    TESTS += $(addprefix tst/filesystems/, \
	fs \
	spiffs)
endif

ifeq ($(BOARD), stm32vldiscovery)
    TESTS = $(addprefix tst/kernel/, \
	sys \
	thrd \
	timer)
    TESTS += $(addprefix tst/sync/, \
	bus \
	event \
	queue \
	rwlock \
	sem)
    TESTS += $(addprefix tst/collections/, \
	binary_tree \
	bits \
	fifo \
	hash_map)
    TESTS += $(addprefix tst/alloc/, \
	circular_heap)
    TESTS += $(addprefix tst/text/, \
	std \
	re)
    TESTS += $(addprefix tst/debug/, \
	log)
    TESTS += $(addprefix tst/oam/, \
	shell)
    TESTS += $(addprefix tst/encode/, \
	base64 \
	json)
    TESTS += $(addprefix tst/hash/, \
	crc \
	sha1)
    TESTS += $(addprefix tst/inet/, \
	http_websocket_client \
	http_websocket_server \
	inet \
	mqtt_client \
	ping)
    TESTS += $(addprefix tst/drivers/hardware/, \
	basic/pin \
	basic/random)
endif

ifeq ($(BOARD), photon)
    TESTS = $(addprefix tst/kernel/, \
	sys \
	thrd \
	time \
	timer)
    TESTS += $(addprefix tst/sync/, \
	bus \
	event \
	queue \
	rwlock \
	sem)
    TESTS += $(addprefix tst/collections/, \
	binary_tree \
	bits \
	fifo \
	hash_map)
    TESTS += $(addprefix tst/alloc/, \
	circular_heap)
    TESTS += $(addprefix tst/text/, \
	std \
	re)
    TESTS += $(addprefix tst/debug/, \
	log)
    TESTS += $(addprefix tst/oam/, \
	shell)
    TESTS += $(addprefix tst/encode/, \
	base64 \
	json)
    TESTS += $(addprefix tst/hash/, \
	crc \
	sha1)
    TESTS += $(addprefix tst/inet/, \
	http_websocket_client \
	http_websocket_server \
	inet \
	mqtt_client \
	ping)
endif

ifeq ($(BOARD), spc56ddiscovery)
    TESTS = $(addprefix tst/kernel/, \
	sys \
	thrd \
	time \
	timer)
    TESTS += $(addprefix tst/sync/, \
	bus \
	event \
	queue \
	rwlock \
	sem)
    TESTS += $(addprefix tst/collections/, \
	binary_tree \
	bits \
	fifo \
	hash_map)
    TESTS += $(addprefix tst/alloc/, \
	circular_heap)
    TESTS += $(addprefix tst/text/, \
	std \
	re)
    TESTS += $(addprefix tst/debug/, \
	log)
    TESTS += $(addprefix tst/oam/, \
	shell \
	soam)
    TESTS += $(addprefix tst/encode/, \
	base64 \
	 json)
    TESTS += $(addprefix tst/hash/, \
	crc \
	sha1)
    TESTS += $(addprefix tst/drivers/hardware/, \
	storage/eeprom_soft)
endif

ifeq ($(BOARD), xvisor_raspberry_pi_3)
    TESTS = $(addprefix tst/kernel/, \
	sys \
	thrd \
	time \
	timer)
    TESTS += $(addprefix tst/sync/, \
	cond \
	event \
	mutex \
	queue)
    TESTS += $(addprefix tst/alloc/, \
	heap \
	circular_heap)
    TESTS += $(addprefix tst/debug/, \
	log)
    TESTS += $(addprefix tst/encode/, \
	base64 \
	json)
    TESTS += $(addprefix tst/hash/, \
	crc \
	sha1)
    TESTS += $(addprefix tst/text/, \
	std \
	emacs)
endif

ifeq ($(BOARD), defcon26_badge)
    TESTS = $(addprefix tst/kernel/, \
	stress \
	sys \
	thrd \
	timer)
    TESTS += $(addprefix tst/sync/, \
	cond \
	event \
	mutex \
	queue)
    TESTS += $(addprefix tst/alloc/, \
	heap \
	circular_heap)
    TESTS += $(addprefix tst/debug/, \
	log)
    TESTS += $(addprefix tst/encode/, \
	base64 \
	json)
    TESTS += $(addprefix tst/hash/, \
	crc \
	sha1)
endif

# List of all application to build
APPS += $(TESTS)

all: $(APPS:%=%.all)

clean: $(APPS:%=%.clean)

rerun:
	for test in $(TESTS) ; do \
	    $(MAKE) -C $$test run || exit 1 ; \
	done

# Depend on 'all' to build all applications (optinally with -j) before
# uploading and running them one at a time.
run: all
	for test in $(TESTS) ; do \
	    if [ ! -e $$test/.$(BOARD).passed ] ; then \
		$(MAKE) -C $$test run || exit 1 ; \
		touch $$test/.$(BOARD).passed ; \
	    else \
		echo ; \
		echo "$$test already passed." ; \
		echo ; \
	    fi \
	done

size: $(TESTS:%=%.size)

report:
	for test in $(TESTS) ; do \
	    $(MAKE) -C $(basename $$test) report ; \
	    echo ; \
	done

test: run
	$(MAKE) report

coverage: $(TESTS:%=%.cov)
	lcov $(TESTS:%=-a %/coverage.info) -o coverage.info
	mkdir -p coverage && cd coverage && genhtml ../coverage.info
	genhtml coverage.info
	@echo
	@echo "Run 'firefox coverage/index.html' to open the coverage report in a web browser."
	@echo

codecov-coverage: $(TESTS:%=%.ccc)

jenkins-coverage: $(TESTS:%=%.jc)

travis:
	$(MAKE) cloc
	$(MAKE) pmccabe
	$(MAKE) test CDEFS_EXTRA="CONFIG_ASSERT=1"

release-test:
	+bin/release.py --test --version $(SIMBA_VERSION)

release:
	+bin/release.py --package --version $(SIMBA_VERSION)

clean-arduino-due:
	$(MAKE) BOARD=arduino_due clean

clean-arduino-mega:
	$(MAKE) BOARD=arduino_mega clean

clean-arduino-nano:
	$(MAKE) BOARD=arduino_nano clean

clean-arduino-pro-micro:
	$(MAKE) BOARD=arduino_pro_micro clean

clean-nodemcu:
	$(MAKE) BOARD=nodemcu clean

clean-esp12e:
	$(MAKE) BOARD=esp12e clean

clean-nano32:
	$(MAKE) BOARD=nano32 clean

clean-stm32vldiscovery:
	$(MAKE) BOARD=stm32vldiscovery clean

clean-photon:
	$(MAKE) BOARD=photon clean

clean-spc56ddiscovery:
	$(MAKE) BOARD=spc56ddiscovery clean

clean-xvisor-raspberry-pi-3:
	$(MAKE) BOARD=xvisor_raspberry_pi_3 clean

clean-xvisor-defcon26-badge:
	$(MAKE) BOARD=defcon26_badge clean

test-arduino-due:
	@echo "Arduino Due"
	$(MAKE) BOARD=arduino_due SERIAL_PORT=/dev/simba-arduino_due test

test-arduino-mega:
	@echo "Arduino Mega"
	$(MAKE) BOARD=arduino_mega SERIAL_PORT=/dev/simba-arduino_mega test

test-arduino-nano:
	@echo "Arduino Nano"
	$(MAKE) BOARD=arduino_nano SERIAL_PORT=/dev/simba-arduino_nano test

test-arduino-pro-micro:
	@echo "Arduino Pro Micro"
	$(MAKE) BOARD=arduino_pro_micro SERIAL_PORT=/dev/simba-arduino_pro_micro test

test-nodemcu:
	@echo "NodeMcu"
	$(MAKE) BOARD=nodemcu SERIAL_PORT=/dev/simba-nodemcuv3 test

test-esp12e:
	@echo "ESP12-E"
	$(MAKE) BOARD=esp12e SERIAL_PORT=/dev/simba-esp12e test

test-nano32:
	@echo "Nano32"
	$(MAKE) BOARD=nano32 SERIAL_PORT=/dev/simba-nano32 test

test-stm32vldiscovery:
	@echo "STM32VLDISCOVERY"
	$(MAKE) BOARD=stm32vldiscovery SERIAL_PORT=/dev/simba-stm32vldiscovery test

test-photon:
	@echo "Photon"
	$(MAKE) BOARD=photon SERIAL_PORT=/dev/simba-photon test

test-spc56ddiscovery:
	@echo "SPC56D Discovery"
	$(MAKE) BOARD=spc56ddiscovery SERIAL_PORT=/dev/simba-spc56ddiscovery CONTROL_PORT=/dev/simba-spc56ddiscovery-control test

test-xvisor-raspberry-pi-3:
	@echo "Xvisor Raspberry Pi 3"
	$(MAKE) -C tst/kernel/sys BOARD=xvisor_raspberry_pi_3 all
	$(MAKE) BOARD=xvisor_raspberry_pi_3 SERIAL_PORT=/dev/arduino test

test-xvisor-defon26-badge:
	@echo "DEF CON 26 Badge"
	$(MAKE) BOARD=defcon26_badge SERIAL_PORT=/dev/ttyUSB0 test

clean-arduino-due-platformio:
	@echo "Arduino Due"
	$(MAKE) -C examples/platformio BOARD=arduino_due SERIAL_PORT=/dev/simba-arduino_due clean

clean-arduino-mega-platformio:
	@echo "Arduino Mega"
	$(MAKE) -C examples/platformio BOARD=arduino_mega SERIAL_PORT=/dev/simba-arduino_mega clean

clean-nodemcu-platformio:
	@echo "NodeMCU"
	$(MAKE) -C examples/platformio BOARD=nodemcu SERIAL_PORT=/dev/simba-nodemcu clean

test-arduino-due-platformio:
	@echo "Arduino Due"
	$(MAKE) -C examples/platformio BOARD=arduino_due SERIAL_PORT=/dev/simba-arduino_due test

test-arduino-mega-platformio:
	@echo "Arduino Mega"
	$(MAKE) -C examples/platformio BOARD=arduino_mega SERIAL_PORT=/dev/simba-arduino_mega test

test-nodemcu-platformio:
	@echo "NodeMCU"
	$(MAKE) -C examples/platformio BOARD=nodemcu SERIAL_PORT=/dev/simba-nodemcuv3 test

test-i2c-nano-mega:
	@echo "I2C Nano Mega"
	$(MAKE) -C tst/drivers/hardware/network/i2c/slave BOARD=arduino_nano SERIAL_PORT=/dev/simba-arduino_nano upload
	$(MAKE) -C tst/drivers/hardware/network/i2c/master_soft BOARD=arduino_mega SERIAL_PORT=/dev/simba-arduino_mega run

clean-i2c-nano-mega:
	@echo "I2C Nano Mega"
	$(MAKE) -C tst/drivers/hardware/network/i2c/slave BOARD=arduino_nano clean
	$(MAKE) -C tst/drivers/hardware/network/i2c/master_soft BOARD=arduino_mega clean

test-all-boards:
	$(MAKE) test-arduino-due
	$(MAKE) test-arduino-mega
	$(MAKE) test-arduino-nano
	$(MAKE) test-esp12e
#	$(MAKE) test-photon
	$(MAKE) test-arduino-due-platformio
	$(MAKE) test-arduino-mega-platformio
	$(MAKE) test-i2c-nano-mega
	$(MAKE) test-nodemcu-platformio
	$(MAKE) test-arduino-pro-micro
	$(MAKE) test-nodemcu
	$(MAKE) test-nano32
	$(MAKE) test-spc56ddiscovery
	$(MAKE) test-xvisor-raspberry-pi-3

clean-all-boards:
	$(MAKE) clean-arduino-due
	$(MAKE) clean-arduino-mega
	$(MAKE) clean-arduino-nano
	$(MAKE) clean-esp12e
#	$(MAKE) clean-photon
	$(MAKE) clean-arduino-due-platformio
	$(MAKE) clean-arduino-mega-platformio
	$(MAKE) clean-i2c-nano-mega
	$(MAKE) clean-nodemcu-platformio
	$(MAKE) clean-arduino-pro-micro
	$(MAKE) clean-nodemcu
	$(MAKE) clean-nano32
	$(MAKE) clean-spc56ddiscovery
	$(MAKE) clean-xvisor-raspberry-pi-3

doc:
	+bin/dbgen.py database.json
	+bin/docgen.py database.json
	$(MAKE) -s -C doc

arduino:
	+make/arduino/arduino.py --remove-outdir --version $(SIMBA_VERSION)

platformio:
	+make/platformio/platformio.py --version $(SIMBA_VERSION)

$(APPS:%=%.all):
	$(MAKE) -C $(basename $@) all

$(APPS:%=%.clean):
	$(MAKE) -C $(basename $@) clean
	rm -f $(basename $@)/.$(BOARD).passed

$(APPS:%=%.size):
	$(MAKE) -C $(basename $@) size

$(TESTS:%=%.report):
	$(MAKE) -C $(basename $@) report

$(TESTS:%=%.cov):
	$(MAKE) -C $(basename $@) coverage

$(TESTS:%=%.ccc):
	$(MAKE) -C $(basename $@) codecov-coverage

$(TESTS:%=%.jc):
	$(MAKE) -C $(basename $@) jenkins-coverage

tags:
	echo "Creating tags file .TAGS"
	etags -o .TAGS --declarations $$(git ls-files *.[hci] | xargs) \
	$$(find 3pp/mbedtls -name "*.[hc]" -o -name "*.cpp" | xargs)

cloc:
	cloc $$(git ls-files | grep -v 3pp | xargs)

pmccabe:
	pmccabe $$(git ls-files "src/*.[hic]") | sort -n

print-%:
	@echo $($*)

generate-stubs:
	rm -rf tst/stubs
	(cd src && \
	 for f in $$(find . -name "*.h" \
		     | grep -v ports \
		     | grep -v boards \
		     | grep -v mcus \
		     | grep -v simba.h \
		     | grep -v simba_gen.h \
		     | grep -v config_default.h \
		     | grep -v config.h) ; do \
	 stub.py -d generate \
	  --ignore-function fs_split \
	  --ignore-function chipid_read \
	  --ignore-function pin_device_set_mode \
	  --ignore-function pin_device_read \
	  --ignore-function pin_device_write \
	  --ignore-function pin_device_write_high \
	  --ignore-function pin_device_write_low \
	  $$f ../tst/stubs/$$(dirname $$f) ; done)

help:
	@echo "--------------------------------------------------------------------------------"
	@echo "  target                      description"
	@echo "--------------------------------------------------------------------------------"
	@echo "  all                         compile and link the application"
	@echo "  clean                       remove all generated files and folders"
	@echo "  run                         run the application"
	@echo "  report                      print test report"
	@echo "  test                        run + report"
	@echo "  size                        print executable size information"
	@echo "  cloc                        print source code line statistics"
	@echo "  pmccabe                     print source code complexity statistics"
	@echo "  doc                         Generate the documentation."
	@echo "  help                        show this help"
	@echo