Makefile

Go to the documentation of this file.

##>!
##>! Zerocat Chipflasher --- Flash free firmware to BIOS chips,
##>!                         kick the Manageability Engine.
##>!
##>! Copyright (C) 2015 Tomás Zerolo <tomas@tuxteam.de> @n
##>! Copyright (C) 2015, 2016, 2017, 2018 Kai Mertens <kmx@posteo.net>
##>!
##>! The Zerocat Chipflasher 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 3 of
##>! the License, or (at your option) any later version.
##>!
##>! The Zerocat Chipflasher 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, see <http://www.gnu.org/licenses/>.
##>!
##>! This file is part of the Zerocat Chipflasher.
##>!
##>! @file firmware/src/Makefile
##>!
##>! @brief Build the chipflasher software, `kick` and `connect`.
##>!
##>! Usage:
##>!   `$ make all`
##>!
 
##>! @cond
#######################################################################
# Variable settings for sub-shells.
# FIXME refine this:
# Have to set shell explicitly for PATH setting to take effect (why?)
SHELL := /bin/sh
 
 
#######################################################################
# Buildchain Options
#
# Note it is assumed that you have installed the original
# Parallax "SimpleIDE 1.0 RC1" binary tool bundle as a fallback. Paths
# to these tools are using the postfix "_OLD".
#
# Updated tools shall be installed via the GNU Guix Package Manager,
# thus paths to updated tools are using the postfix "_GUIX".
#
# The updated "Simple Libraries" folder may be downloaded separately,
# we are using the postfix "_MASTER" for it.
#
# Please see zerocat-tools.md from the doc repository for details. It is
# available like: git clone git://zerocat.org/zerocat/projects/doc
#
PATH_PARALLAX = /opt/parallax/
PATH_GNUGUIX = $(shell echo "$$GUIX_ENVIRONMENT"/;)
PATH_SIMPLELIBS_PARALLAX = $(PATH_PARALLAX)Workspace/Learn/Simple\ Libraries/
PATH_SIMPLELIBS_MASTER = ../../firmware1/src/parallaxinc/Simple-Libraries/Learn/Simple\ Libraries/
PATH_HOST_SRC = ../../host/src/
PROPGCC_PARALLAX = $(PATH_PARALLAX)bin/propeller-elf-gcc
PROPGCC_GNUGUIX = $(PATH_GNUGUIX)bin/propeller-elf-gcc
 
# This is needed so gcc finds all its parts ("propeller-elf-gcc: error
# trying to exec 'cc1': execvp: No such file or directory"). Is a prefix,
# mind the trailing slash!
# Note that the environment variable GCC_EXEC_PREFIX doesn't work for
# us. But GCC's option -B works!
PATH_GCC_LIBEXEC_PARALLAX = $(PATH_PARALLAX)libexec/gcc/propeller-elf/4.6.1/
PATH_GCC_LIBEXEC_GNUGUIX = $(PATH_GNUGUIX)libexec/gcc/propeller-elf/4.6.1/
 
#######################################################################
# Buildchain settings
#  possibly to be overridden by those in buildchain.cfg
PATH_SIMPLELIBS = $(PATH_SIMPLELIBS_PARALLAX)
PROPGCC = $(PROPGCC_PARALLAX)
PATH_GCC_LIBEXEC := $(PATH_GCC_LIBEXEC_PARALLAX)
-include buildchain.cfg
 
#######################################################################
# Compiler flags
 
# Memory model
#  cmm: the program image is compiled into a size-optimized form
#  lmm: stores the program image and variable data in Main RAM, fastest execution
#  xmmc: stores program images in external flash memory, an SD card, or EEPROM.
MMODEL := lmm
 
# Base CFLAGS: apply those always:
BASE_CFLAGS = -Os -m$(MMODEL) -Wall -m32bit-doubles -fno-exceptions -std=c99
 
# CFLAGS: let user specify:
override CFLAGS += $(BASE_CFLAGS)
 
# Paths for compilation
INCLUDES = -I . \
           -I $(PATH_SIMPLELIBS)TextDevices/libsimpletext \
           -I $(PATH_SIMPLELIBS)Utility/libsimpletools \
           -I $(PATH_SIMPLELIBS)Protocol/libsimplei2c
 
LIBDIRS = -L . \
          -L $(PATH_SIMPLELIBS)TextDevices/libsimpletext/$(MMODEL) \
          -L $(PATH_SIMPLELIBS)Utility/libsimpletools/$(MMODEL) \
          -L $(PATH_SIMPLELIBS)Protocol/libsimplei2c/$(MMODEL)
##>! @endcond
 
 
##>! @cond
# Libraries for kick, the chipflasher's firmware
LIBS = -lsimpletext -lsimpletools -lsimplei2c
LIBPROP = \
    libprop/putChar.h \
    libprop/putChar.c
LIBCOMMON = \
    libcommon/common.h \
    libcommon/serial-codes.h \
    libcommon/filespec.h \
    libcommon/hexdigit2bin.c \
    libcommon/bin2hexdigit.c \
    libcommon/line_info.c \
    libcommon/filespec.c
LIBSPI = \
    libSPI/SPI-command-set.h \
    libSPI/SPI-flash-bits.h
LIBKICK = \
    libkick/chipspec.h  \
    libkick/proppins.h \
    libkick/key-enable-bits.h \
    libkick/fast-SPI.h \
    libkick/chipspec.c
 
#######################################################################
# Explicit dependencies
.PHONY: kick connect all clean cleanall
 
# build kick
kick:   kick.elf
 
# build connect
connect:
    $(MAKE) -C $(PATH_HOST_SRC);
 
# build kick and connect
all:    kick connect
 
# clean kick
clean:
    rm -f *.elf;
 
# clean kick and connect
cleanall: clean
    $(MAKE) -C $(PATH_HOST_SRC) clean;
 
# FIXME a patern rule would be nice. But where to stick the -lm -lfdserial and so on?
# NOTE lib order matters (-lfoo -lbar). And $^ must go before libs.
# NOTE Propeller code allows some non ANSI standard format specifiers,
# i.e. "%b" for binary representation of an integer.
# That will produce warnings according to -Wformat and -Wformat-extra-args.
#
# You can temporarily disable these warnings in your source code:
#
#   [...]
#   #pragma GCC diagnostic push
#   #pragma GCC diagnostic ignored "-Wall"
#   #pragma GCC diagnostic ignored "-Wformat-extra-args"
#   //your code goes here, i.e.:
#   //printi("binary number: %08b", x);
#   #pragma GCC diagnostic pop
#   [...]
#
# Please compare to:
# https://gcc.gnu.org/onlinedocs/gcc/Diagnostic-Pragmas.html#Diagnostic-Pragmas)
#
 
kick.elf: kick.c $(LIBPROP) $(LIBCOMMON) $(LIBSPI) $(LIBKICK) kick.h
    $(PROPGCC) $(INCLUDES) $(LIBDIRS) $(CFLAGS) \
    $< $(LIBS) \
    -o $@;
##>! @endcond