Makefile

# mangOH Makefile
#
# Requirements:
#  * Use leaf, or...
#  * Set LEGATO_ROOT environment variable to the path to a Legato working copy.
#  * Set XXXX_SYSROOT environment variables to the appropriate sysroot for the module. For example:
#    "export WP76XX_SYSROOT=/opt/swi/y22-ext-wp76xx/sysroots/armv7a-neon-poky-linux-gnueabi"
#  * If the Legato version in LEGATO_ROOT is < 18.02.0, then it will be necessary to do "export
#    LEGATO_SYSROOT=$XXXX_SYSROOT" where XXXX is the module the build is for.
#
# By default, the Legato framework will not be built before building the mangOH software.
# Set LEGATO=1 to trigger a build of the Legato framework first.
# WARNING: Do not use LEGATO=1 when using a Legato provided by leaf. This will result in the
# modification of files within ~/leaf-data which may be shared between many leaf workspaces
# and leaf profiles.
#
# To build with optional Octave(tm) support, set OCTAVE_ROOT to contain the path to directory
# containing the .app files for the Octave applications (such as cloudInterface.wp77xx.app).
# You also have the option of setting OCTAVE=0 to disable inclusion of Octave support even
# when OCTAVE_ROOT is set.
#
# Copyright (C) Sierra Wireless Inc.

UPDATE_FILE_DIR = build/update_files
LEAF_DATA ?= $(LEAF_WORKSPACE)/leaf-data/current

# Arguments passed to mksys whenever it is invoked.
MKSYS_ARGS_COMMON = --cflags=-O2 --object-dir=build/$@ --output-dir=$(UPDATE_FILE_DIR)

MAKEFILE_DIR := $(dir $(realpath $(firstword $(MAKEFILE_LIST))))

# Export a default location for the BSEC library if one isn't already defined by the environment.
# This variable is only relevant during yellow builds.
export BSEC_DIR ?= $(MAKEFILE_DIR)components/boschBsec/BSEC_1.4.7.2_GCC_CortexA7_20190225/algo/bin/Normal_version/Cortex_A7

# The comments below are for Developer Studio integration. Do not remove them.
# WARNING: Developer Studio has reached end-of-life and will not be supported in future.
# DS_CLONE_ROOT(CURDIR)
# DS_CUSTOM_OPTIONS(MKSYS_ARGS_COMMON)

# NOTE: This isn't needed when using leaf.
export PATH := $(LEGATO_ROOT)/bin:$(PATH)

# List of all supported mangOH boards.
BOARDS = green red yellow

# List of all supported Sierra Wireless WP-series modules.
MODULES = wp85 wp750x wp76xx wp77xx

# Toolchain-related variables that are needed when not using leaf.
TOOLCHAIN_DIR=$(shell $(LEGATO_ROOT)/bin/findtoolchain $* dir)
TOOLCHAIN_PREFIX=$(shell $(LEGATO_ROOT)/bin/findtoolchain $* prefix)

# List of goals for each board, in the form $(board)_$(module), like green_wp85.
GREEN_GOALS = $(foreach module,$(MODULES),green_$(module))
RED_GOALS = $(foreach module,$(MODULES),red_$(module))
YELLOW_GOALS = $(foreach module,$(MODULES),yellow_$(module))

# By default (if no goal is specified on the command line), we try to build for all combinations
# of boards and targets.  This will probably not work for most people, though, because they won't
# have all the necessary toolchains installed.
ALL_COMBINATIONS = $(GREEN_GOALS) $(RED_GOALS) $(YELLOW_GOALS)
.PHONY: all $(ALL_COMBINATIONS)
all: $(ALL_COMBINATIONS)

# Rule to build the Legato framework, if $(LEGATO) is not 0.
# WARNING: Do not use LEGATO=1 when using a Legato provided by leaf. This will result in the
# modification of files within ~/leaf-data which may be shared between many leaf workspaces and leaf
# profiles.
LEGATO ?= 0
.PHONY: legato_%
legato_%:
	$(eval export LEGATO_TARGET := $(subst legato_,,$@))
ifeq ($(LEGATO),0)
	@echo "Not building LEGATO due to \$$LEGATO == 0"
else
	$(MAKE) -C $(LEGATO_ROOT) framework_$(LEGATO_TARGET)
endif

# If OCTAVE_ROOT is defined, include Octave in mangOH Yellow builds by default.
# ...but we don't care about this if we are cleaning.
ifneq ($(MAKECMDGOALS),clean)
  ifdef OCTAVE_ROOT
    yellow_%: OCTAVE ?= 1
  else
    $(warning ==== OCTAVE_ROOT not defined ====)
    yellow_%: OCTAVE ?= 0
  endif
endif

# Build goals that get the target WP module type from the LEGATO_TARGET environment variable.
# If LEGATO_TARGET is defined (e.g., when using leaf), then you can run 'make yellow', for example.
.PHONY: $(BOARDS)
$(BOARDS): %: %_$(LEGATO_TARGET)

# If LEGATO_TARGET is not set, and someone tries to make one of the board goals (like 'make yellow')
# then it will attempt to build something like 'yellow_'.  In that case, we want to report a
# helpful error message, and we use these "missing LEGATO_TARGET" goals to do that.
MISSING_LEGATO_TARGET = $(foreach board,$(BOARDS),$(board)_)
.PHONY: $(MISSING_LEGATO_TARGET)
$(MISSING_LEGATO_TARGET):
	$(error LEGATO_TARGET not specified and no goal like $@wp76xx provided)

# Build goals that don't rely on LEGATO_TARGET, instead allowing the module to be specified
# on the command line as part of the goal. E.g., 'make green_wp85'.  If using these, Legato's
# findtoolchain script will be used to try to find the approriate build toolchain.

$(GREEN_GOALS): green_%: legato_%
	# NOTE: When using leaf, these TOOLCHAIN_X variables don't need to be passed to mksys.
	TOOLCHAIN_DIR=$(TOOLCHAIN_DIR) \
	TOOLCHAIN_PREFIX=$(TOOLCHAIN_PREFIX) \
	mksys -t $* $(MKSYS_ARGS_COMMON) green.sdef

$(RED_GOALS): red_%: legato_%
	# NOTE: When using leaf, these TOOLCHAIN_X variables don't need to be passed to mksys.
	TOOLCHAIN_DIR=$(TOOLCHAIN_DIR) \
	TOOLCHAIN_PREFIX=$(TOOLCHAIN_PREFIX) \
	OCTAVE=$(OCTAVE) \
	mksys -t $* $(MKSYS_ARGS_COMMON) red.sdef

$(YELLOW_GOALS): yellow_%: legato_%
	@if ! [ -e "$(BSEC_DIR)" ] ; then \
		echo "*" ; \
		echo "* ERROR: Bosch bsec library not found at BSEC_DIR ($(BSEC_DIR))." ; \
		echo "*        See components/boschBsec/README.md ." >&2 ; \
		echo "*" ; \
		false ; \
	fi
	@if [ "$(OCTAVE)" = "1" -a "$(OCTAVE_ROOT)" = "" ]; then \
		echo "* ERROR: OCTAVE_ROOT not defined. Cannot build Octave support." >&2 ; \
		echo "*        Set OCTAVE_ROOT to the directory in which the Octave .app" >&2 ; \
		echo "*        files can be found, or set OCTAVE=0 (or unset OCTAVE) to" >&2 ; \
		echo "*        build without Octave." >&2 ; \
		false ; \
	fi
	# NOTE: When using leaf, these TOOLCHAIN_X variables don't need to be passed to mksys.
	TOOLCHAIN_DIR=$(TOOLCHAIN_DIR) \
	TOOLCHAIN_PREFIX=$(TOOLCHAIN_PREFIX) \
	OCTAVE=$(OCTAVE) \
	mksys -t $* $(MKSYS_ARGS_COMMON) yellow.sdef

# The cleaning goal.
.PHONY: clean
clean:
	rm -rf build

# Goals for building the software to be used when testing inside the environmental test chamber.
TEST_BUILD_ID = $@_$(LEGATO_TARGET)
.PHONY: env_test_yellow
env_test_yellow: env_test_%:
ifndef LEGATO_TARGET
	$(error LEGATO_TARGET not specified)
endif
	mksys -t $(LEGATO_TARGET) \
		  --object-dir=build/$(TEST_BUILD_ID) \
		  --output-dir=build/update_files \
	      $@.sdef

# Rule for generating legato.cwe files from .update files.
CWE_FILES = $(foreach board,$(BOARDS),build/$(board)_$(LEGATO_TARGET)/legato.cwe)
$(CWE_FILES): build/%_$(LEGATO_TARGET)/legato.cwe: $(UPDATE_FILE_DIR)/%.$(LEGATO_TARGET).update
	systoimg -s $(LEGATO_TARGET) $< build/$*_$(LEGATO_TARGET)

# Goals, like "yellow_spk", for building complete .spk files for factory programming.
# The names of the resulting .spk files are of the form build/yellow_wp76xx.spk.
FACTORY_SPK_GOALS = $(foreach board,$(BOARDS),$(board)_spk)
.PHONY: $(FACTORY_SPK_GOALS)
$(FACTORY_SPK_GOALS): %_spk: % build/%_$(LEGATO_TARGET).spk

# Select the modem firmware image as follows:
# - Prefer the one specific to Sierra Wireless SIMs
# - Fall back to the first "Generic" version found, if no Sierra version available.
# NOTE: This can be overridden on the command line or in the environment.
MODEM_FIRMWARE ?= $(firstword $(wildcard $(LEAF_DATA)/*-modem-image/*_SIERRA_*.spk) \
                              $(wildcard $(LEAF_DATA)/*-modem-image/*_GENERIC_*.spk) )

LINUX_IMAGE ?= $(wildcard $(LEAF_DATA)/*-linux-image/linux.cwe)

build/%_$(LEGATO_TARGET).spk: build/%_$(LEGATO_TARGET)/legato.cwe
	swicwe -c $(LINUX_IMAGE) \
	          $(MODEM_FIRMWARE) \
	          $< \
	       -o $@
	@echo "Factory .spk generated using:"
	@echo "  modem firmware = $(MODEM_FIRMWARE)"
	@echo "  Linux kernel and root file system = $(LINUX_IMAGE)"
	@echo "  Legato framework and apps = $<"
	@echo "Output written to $@"