ULX3S_WSL_Toolchain.sh

#!/bin/bash
# this is the old gist from gojimmypi https://gist.github.com/gojimmypi/f96cd86b2b8595b4cf3be4baf493c5a7
# before being converted to separate files in this repo
WORKSPACE=~/workspace       # put your workspace parent directory here. avoid spaces in path
export ULX3S_COM=/dev/ttyS8  # put your device name here

# This WSL Ubuntu bash script will update the system, fetch all dependencies, and git clone
# all of the libraries for running the @DoctorWkt Blinky for the ecp5 ULX3S Board
# including icestorm, nextpnr (or arachne-pnr), yosys
#
#
# A WSL-specific Makefile will also be fetched. (TODO)
#
# wget (TODO)/raw/Makefile -O Makefile
#
# or if you prefer the older arachne-pnr:
#
# wget (TODO)/raw/Makefile -O Makefile
#
# Works bext with Ubuntu 18.04 or later
#
# if weird errors are detected after editing from something like Visual Studio in Windows, try running
#  dos2unix ./ULX3S_WSL_Toolchain.sh
#
#"***************************************************************************************************"
# To fetch and use this file (ignore the version warning):
#
#   wget https://gist.githubusercontent.com/gojimmypi/f96cd86b2b8595b4cf3be4baf493c5a7/raw/ULX3S_WSL_Toolchain.sh -O ULX3S_WSL_Toolchain.sh
#   chmod +x ./ULX3S_WSL_Toolchain.sh
#   ./ULX3S_WSL_Toolchain.sh
#
# To clone this gist (honors version checking)
#
#   cd $WORKSPACE
#   git clone https://gist.github.com/f96cd86b2b8595b4cf3be4baf493c5a7.git ULX3S_WSL_Toolchain
#   cd ULX3S_WSL_Toolchain
#
#"***************************************************************************************************"
STARTING_PATH=$(pwd)

# see https://unix.stackexchange.com/questions/14270/get-exit-status-of-process-thats-piped-to-another/73180#73180
# we don't want tee to capture exit codes
set -o pipefail

# convert entire list of params to single lower case string
params="$(tr [A-Z] [a-z] <<< "$@")"
# echo $params

LOG_SUFFIX=$(date +"%Y%m%d_%H%M%S")

# strip any path from $0 to get just the file name of this script, stripping any CR, LF, Tabs
THIS_FILE_NAME=$(basename $0 .sh | tr --delete '\t\r\n' )

mkdir -p "$WORKSPACE"
mkdir -p "$WORKSPACE/install_logs"
LOG_DIRECTORY="$WORKSPACE/install_logs"


# This section is probably not needed anymore
#   #"***************************************************************************************************"
#   #  PYTHONPATH
#   #"***************************************************************************************************"
#   THIS_PYTHON_PATH="$WORKSPACE/prjtrellis/database"
#   
#   # set PYTHONPATH for later use in ~/.bashrc
#   if [ "$(cat ~/.bashrc | grep  $THIS_PYTHON_PATH)" == "" ]; then
#     if [ "$(echo $PYTHONPATH)" == "" ]; then
#       # there's apparently no PYTHONPATH already, so no need to append
#       echo PYTHONPATH=$THIS_PYTHON_PATH >> ~/.bashrc
#       echo "~/.bashrc updated with this line:"
#       echo PYTHONPATH=$THIS_PYTHON_PATH
#     else
#       # there's a PYTHONPATH, so we append this one 
#       echo PYTHONPATH=$PYTHONPATH:$THIS_PYTHON_PATH >> ~/.bashrc
#       echo "~/.bashrc updated with this line:"
#       echo PYTHONPATH=$PYTHONPATH:$THIS_PYTHON_PATH
#     fi
#   else
#     echo "Found $THIS_PYTHON_PATH in ~/.bashrc - path not changed."
#   fi
#   
#   # set PYTHONPATH for immediate use (call this script with ". ./name.sh" to retain)
#   if [ "$(echo $PYTHONPATH | grep  $THIS_PYTHON_PATH)" == "" ]; then
#     if [ "$(echo $PYTHONPATH)" == "" ]; then
#       # there's apparently no PYTHONPATH already, so no need to append
#       export PYTHONPATH=$THIS_PYTHON_PATH
#       echo "Set PYTHONPATH to $PYTHONPATH"
#     else
#       export PYTHONPATH=$PYTHONPATH:$THIS_PYTHON_PATH
#       echo "Updated current PYTHONPATH to $PYTHONPATH"
#     fi
#   else
#     echo "PYTHONPATH not updated. PYTHONPATH=$PYTHONPATH"
#   fi

#"***************************************************************************************************"
# CheckForError() function
#
# example: CheckForError $? mylog.1.txt mylog2.txt
#
# functions are a common place to get weird script errors. typically carriage returns. use dos2unix
#
# for cmake internal recipe errors, see: https://cmake.org/cmake/help/v3.9/command/execute_process.html
#
# note tee captures error code: https://stackoverflow.com/questions/1221833/pipe-output-and-capture-exit-status-in-bash
#"***************************************************************************************************"
CheckForError() { # $1 expected to be error code via $?
	if [ "$1" != "0" ]; then
		if [ "$2" != "" ]; then
			echo "---------------------------"
			echo "Looking in $2 for errors..."
			echo "---------------------------"
			grep -v " --disable-werror " "$2" | grep -B2 -i error
		fi
		if [ "$3" != "" ]; then
			echo "---------------------------"
			echo "Looking in $3 for errors..."
			echo "---------------------------"
			grep -v " --disable-werror " "$3" | grep -B2 -i error
		fi
		if [ "$4" != "" ]; then
			echo "---------------------------"
			echo "Looking in $4 for errors..."
			echo "---------------------------"
			grep -v " --disable-werror " "$4" | grep -B2 -i error
		fi
		if [ "$5" != "" ]; then
			echo "---------------------------"
			echo "Looking in $5 for errors..."
			echo "---------------------------"
			grep -v " --disable-werror " "$5" | grep -B2 -i error
		fi
		read -p "Error detected. Try updating dependencies. Press enter to continue, or Ctrl-C to abort."
	else
		echo "Ok! Exit code = [$1] using params=$params" 
	fi
}

#"***************************************************************************************************"
# CheckForGitFileChange() bash function. Compare hash of local file to one on GitHub
# 
# example: check specific file:
#   CheckForGitFileChange ~/workspace/nextpnr/README.md
#
# example: check this bash file:
#   CheckForGitFileChange $0    
#
# see https://gist.github.com/gojimmypi/22b7d43ce69e9c828e97534ff0a1d27f
#
#"***************************************************************************************************"
CheckForGitFileChange() {
	SAVED_CURRENT_PATH=$(pwd)
	if [ ! -f "$1" ]; then
		echo "File not found: "$1
		return 1
	fi

	## in case we get called from some other directory, we need to know the entire path of this file
	## as git commands need to be run in the repository directory.
	GIT_REL_PATH=$(dirname $1 | tr --delete '\t\r\n') 
	GIT_FULL_PATH="$(cd "${GIT_REL_PATH}"; pwd)"
	GIT_FILE_NAME=$(basename $1 | tr --delete '\t\r\n' )
	GIT_THIS_BRANCH=$(git rev-parse --abbrev-ref HEAD)
	cd $GIT_FULL_PATH

	echo "Checking $GIT_FULL_PATH/$GIT_FILE_NAME on branch origin/$GIT_THIS_BRANCH"

	# compares occur to local files only, so quietly fetch
	git fetch > /dev/null

	# we first need to get the latest commit hash (non-blank if remote is newer)
    COMMIT_HASH=$(git show --format=%H --no-patch --no-abbrev-commit HEAD..origin/$GIT_THIS_BRANCH)

	# view the file in the commit hash found and pipe to `git hash-object` to compute hash
	GIT_HASH=$(git show $COMMIT_HASH:$1 | git hash-object --stdin )

	# simple `git hash-object` to compute hash of the local file
	THIS_HASH=$(git hash-object $1)

	# some visual entertainment
	echo "COMMIT_HASH = $COMMIT_HASH"
	echo "GIT_HASH    = $GIT_HASH"
	echo "THIS_HASH   = $THIS_HASH"

	if [ "$THIS_HASH" == "$GIT_HASH" ]; then
		echo "Confirmed $1 is the most recent version found in GitHub."
	else 
		echo "Warning! This version of $1 does not match the most recent version in GitHub!"
		git status | tr -s ' ' | grep "modified: README.md"
		read -p "Press enter to continue, or Ctrl-C to abort. (manually push/pull recent file)"
	fi
	cd $SAVED_CURRENT_PATH
}

# check that we are not running as root
ls /root > /dev/null 2>&1
EXIT_STAT=$?
if [ $EXIT_STAT -ne 0 ];then
  echo "Startup ulx3s toolchain. Security Context:" $(whoami) 2>&1 | tee -a  "$THIS_SETUP_LOG"
else
  echo "Setup aborted. Do not run as root. Causes undesired install permissions. Enter sudo password as required during setup."
  exit 2
fi

CheckForGitFileChange $0


if [ "$1" == "" ]; then
  echo ""
  echo "$0 --help for additional options."
  echo ""
  read -p "Press [Enter] to update all system dependencies, fetch latest github code, and rebuild everything..."
fi

if [[ "$params" == *"help"* ]] || [[ "$params" == *"--help"* ]] || [[ "$params" == *"-h"* ]];  then
  echo ""
  echo "$THIS_FILE_NAME help. Version 0.1"
  echo ""
  echo "If no parametes are selected, install and update everything."
  echo ""
  echo "If selection option is already installed, git fetch latest version and install."
  echo ""
  echo "Logs are saved to "$LOG_DIRECTORY"/"$THIS_FILE_NAME"_[step]_"$LOG_SUFFIX".log"
  echo "Edit WORKSPACE setting to fit your needs."
  echo ""
  echo "  --arachne-pnr  : install/update arachne-pnr"
  echo "  --blinky       : install/update ULX3S-Blinky"
  echo "  --help         : show this help screen"
  echo "  --icestorm     : install/update icestorm"
  echo "  --make         : make and upload the ULX3S-Blinky project"
  echo "  --nextpnr      : install/update nextpnr"
  echo "  --nosystem     : do not install requirements; do not perform apt-get update and apt-get upgrade"
  echo "  --prjtrellis   : install/update prjtrellis"
  echo "  --system       : install requirements; perform apt-get update and apt-get upgrade"
  echo "  --ujprog       : install/update ujprog"
  echo "  --ulx3s-bin    : install/update ulx3s-bin quixk start binaries"
  echo "  --version      : show versions of installed tools"
  echo "  --yosys        : install/update yosys"
  echo ""
fi

echo "params="$params
# for anything other than --help we will likely need to be sudo to install, so run once with the date to get started
if [ "$params" != "--help" ]; then
	echo "date"
	sudo date # pause if copy/paste password prompt (otherwise text ends up in password prompt)
fi


# either explicitly updating with keyword "system" or no parameter at all, will update system
# a "nosystem" parameter will avoid updating the system libraries
if [[ "$1" != *"--nosystem"* ]]  && { [[ "$1" == *"--system"* ]] || [ "$1" == "" ]; } then
	cd "$WORKSPACE"
	THIS_LOG=$LOG_DIRECTORY"/"$THIS_FILE_NAME"_system_update_"$LOG_SUFFIX".log"

	echo "***************************************************************************************************"
	echo "update/upgrade current system. Saving log to $THIS_LOG"
	echo "***************************************************************************************************"
	sudo apt-get update --assume-yes        2>&1 | tee -a "$THIS_LOG"
	sudo apt-get upgrade --assume-yes       2>&1 | tee -a "$THIS_LOG"

	echo "***************************************************************************************************"
	echo "git install and config. Saving log to $THIS_LOG"
	echo "***************************************************************************************************"
	# These git .insteadOf options may not be needed if your firewall does not blocks the git ports, 
	# but we set anyhow. 
	#
	# it is unlikely to cause harm for these repositories, unless for some reason your firewall is blocking HTTPS
	sudo apt-get install git --assume-yes   2>&1 | tee -a "$THIS_LOG"

	# git config --global url.https://git.qemu.org/git/.insteadOf git://git.qemu-project.org/
	# git config --global url.https://anongit.freedesktop.org/git/.insteadOf git://anongit.freedesktop.org/

	# git config --global url.https://github.com/riscv.insteadOf git://github.com/riscv

	# also consider somerthing like this for everything on GitHub:
	# git config --global url.https://github.com/.insteadOf git://github.com/
	#
	# and to clear:
	# git config --global --unset url.https://github.com/.insteadOf

	echo "***************************************************************************************************"
	echo " install x11 dependencies (only needed for WSL?)"
	echo "***************************************************************************************************"
	sudo apt install dbus-x11

	cd "$WORKSPACE"
	echo "***************************************************************************************************"
	echo "install icestorm dependencies. Saving log to $THIS_LOG"
	echo "***************************************************************************************************"
	# this next install needs a bit of disk space:
	#   0 upgraded, 205 newly installed, 0 to remove and 3 not upgraded.
	#   Need to get 130 MB of archives.
	#   After this operation, 652 MB of additional disk space will be used.
	#
	sudo apt-get install build-essential clang bison flex libreadline-dev \
						 gawk tcl-dev libffi-dev git mercurial graphviz   \
						 xdot pkg-config libftdi-dev --assume-yes 2>&1 | tee -a "$THIS_LOG"
	CheckForError $? "$THIS_LOG"


	echo "***************************************************************************************************"
	echo "install Python and dependencies. Saving log to $THIS_LOG"
	echo "***************************************************************************************************"
	sudo apt-get install python python3 --assume-yes  2>&1 | tee -a "$THIS_LOG"
	sudo apt-get install python3-pip --assume-yes     2>&1 | tee -a "$THIS_LOG"
	pip3 install database

	echo "***************************************************************************************************"
	echo "install apio. Saving log to $THIS_LOG"
	echo "***************************************************************************************************"
	pip3 install -U apio 2>&1 | tee -a "$THIS_LOG"
	CheckForError $? "$THIS_LOG"

	echo "***************************************************************************************************"
	echo "install nextpnr dependencies. Saving log to $THIS_LOG"
	echo "***************************************************************************************************"
	# this next line is about another half gig of files!
	#   0 upgraded, 249 newly installed, 0 to remove and 3 not upgraded.
	#   Need to get 132 MB of archives.
	#   After this operation, 623 MB of additional disk space will be used.
	#
	sudo apt-get install libboost-all-dev python3-dev qt5-default clang-format libeigen3-dev --assume-yes 2>&1 | tee -a "$THIS_LOG"
	sudo apt-get install cmake --assume-yes 2>&1 | tee -a "$THIS_LOG"
	CheckForError $? "$THIS_LOG"

	echo "***************************************************************************************************"
	echo "install verilator. Saving log to $THIS_LOG"
	echo "***************************************************************************************************"
	# The following NEW packages will be installed:
	#  verilator
	# 0 upgraded, 1 newly installed, 0 to remove and 1 not upgraded.
	# Need to get 2878 kB of archives.
	# After this operation, 13.1 MB of additional disk space will be used.
	sudo apt-get install verilator --assume-yes  2>&1 | tee -a "$THIS_LOG"
	CheckForError $? "$THIS_LOG"

	if grep -q Microsoft /proc/version; then
	  echo "***************************************************************************************************"
	  echo "WSL detected; Install x86_64-w64-mingw32-gcc; Saving log to $THIS_LOG"
	  echo "***************************************************************************************************"
	  sudo apt-get install mingw-w64 --assume-yes 2>&1 | tee -a "$THIS_LOG"
	  CheckForError $? "$THIS_LOG"
	fi

	echo "***************************************************************************************************"
	echo "update/upgrade current system again. Saving log to $THIS_LOG"
	echo "***************************************************************************************************"
	sudo apt-get update --assume-yes        2>&1 | tee -a "$THIS_LOG"
	CheckForError $? "$THIS_LOG"

	sudo apt-get upgrade --assume-yes       2>&1 | tee -a "$THIS_LOG"
	CheckForError $? "$THIS_LOG"
fi


if [[ "$1" == *"--blinky"* ]] || [ "$1" == "" ]; then
	cd "$WORKSPACE"
	THIS_LOG=$LOG_DIRECTORY"/"$THIS_FILE_NAME"_blinky_"$LOG_SUFFIX".log"

	echo "***************************************************************************************************"
	echo "@DoctorWkt ULX3S-Blinky. Saving log to $THIS_LOG"
	echo "***************************************************************************************************"
	if [ ! -d "$WORKSPACE"/ULX3S-Blinky ]; then
	  git clone --recursive https://github.com/DoctorWkt/ULX3S-Blinky 2>&1 | tee -a "$THIS_LOG"
	  cd ULX3S-Blinky
	else
	  cd ULX3S-Blinky
	  git fetch                                                       2>&1 | tee -a "$THIS_LOG"
	  git pull                                                        2>&1 | tee -a "$THIS_LOG"
	fi
fi

if [ "$params" != "--help" ]; then
	sudo apio drivers --serial-enable
	sudo usermod -a -G dialout $USER
fi


if [[ "$1" == *"--icestorm"* ]] || [ "$1" == "" ]; then
	cd "$WORKSPACE"
	THIS_LOG=$LOG_DIRECTORY"/"$THIS_FILE_NAME"_icestorm_"$LOG_SUFFIX".log"

	echo "***************************************************************************************************"
	echo " icestorm. Saving log to: "$THIS_LOG
	echo "***************************************************************************************************"

	# see http://www.clifford.at/icestorm/
	if [ ! -d "$WORKSPACE"/icestorm ]; then
	  git clone https://github.com/cliffordwolf/icestorm.git icestorm 2>&1 | tee -a "$THIS_LOG"
	  cd icestorm
	else
	  cd icestorm
	  git fetch                                                       2>&1 | tee -a "$THIS_LOG"
	  git pull                                                        2>&1 | tee -a "$THIS_LOG"
	  make clean                                                      2>&1 | tee -a "$THIS_LOG"
	  CheckForError $? "$THIS_LOG"
	fi

	make -j$(nproc)                                                   2>&1 | tee -a "$THIS_LOG"
	CheckForError $? "$THIS_LOG"

	sudo make install                                                 2>&1 | tee -a "$THIS_LOG"
	CheckForError $? "$THIS_LOG"
else
	# for non-help params, alwayss check versions even if not updating them
	cd "$WORKSPACE"
	cd icestorm
	if [ "$params" != "--help" ]; then
		CheckForGitFileChange README.md
	fi
fi


if [[ "$1" == *"--arachne-pnr"* ]] || [ "$1" == "" ]; then
	cd "$WORKSPACE"
	THIS_LOG=$LOG_DIRECTORY"/"$THIS_FILE_NAME"_arachne-pnr_"$LOG_SUFFIX".log"

	echo "***************************************************************************************************"
	echo " arachne-pnr. Saving log to $THIS_LOG"
	echo "***************************************************************************************************"
	if [ ! -d "$WORKSPACE"/arachne-pnr ]; then
	  git clone https://github.com/cseed/arachne-pnr.git arachne-pnr 2>&1 | tee -a "$THIS_LOG"
	  cd arachne-pnr
	else
	  cd arachne-pnr
	  git fetch                                                      2>&1 | tee -a "$THIS_LOG" 
	  git pull                                                       2>&1 | tee -a "$THIS_LOG"

	  make clean                                                     2>&1 | tee -a "$THIS_LOG" 
	  CheckForError $? "$THIS_LOG"
	fi

	make -j$(nproc)                                                  2>&1 | tee -a "$THIS_LOG"
	CheckForError $? "$THIS_LOG"

	sudo make install                                                2>&1 | tee -a "$THIS_LOG"
	CheckForError $? "$THIS_LOG"
else
	# for non-help params, alwayss check versions even if not updating them
	cd "$WORKSPACE"
	cd arachne-pnr
	if [ "$params" != "--help" ]; then
		CheckForGitFileChange README.md
	fi
fi

if [[ "$1" == *"--prjtrellis"* ]] || [ "$1" == "" ]; then
	cd "$WORKSPACE"
	THIS_LOG=$LOG_DIRECTORY"/"$THIS_FILE_NAME"_prjtrellis_"$LOG_SUFFIX".log"

	echo "***************************************************************************************************"
	echo " prjtrellis (required for nextpnr-ecp5). Saving log to $THIS_LOG"
	echo "***************************************************************************************************"
	if [ ! -d "$WORKSPACE"/prjtrellis ]; then
	  git clone --recursive https://github.com/SymbiFlow/prjtrellis
	  cd prjtrellis
	else
	  cd prjtrellis
	  git fetch                                                      2>&1 | tee -a "$THIS_LOG"
	  git pull                                                       2>&1 | tee -a "$THIS_LOG"

	fi

	# cmake must run from the libtrellis directory
	cd libtrellis

	# Makefile will not exist the very first time, so nothing to do
    if [ ! -f "Makefile" ]; then
      echo "$0: File 'Makefile' not found. Not cleaning..."
    else
      make clean                                                       2>&1 | tee -a "$THIS_LOG"
      CheckForError $? "$THIS_LOG"
    fi

	cmake -DCMAKE_INSTALL_PREFIX=/usr .                              2>&1 | tee -a "$THIS_LOG"
	CheckForError $? "$THIS_LOG"

	# see https://stackoverflow.com/questions/9383014/cant-import-my-own-modules-in-python
	# now set above
	# export PYTHONPATH="~/workspace/prjtrellis/database"

	make                                                             2>&1 | tee -a "$THIS_LOG"
	CheckForError $? "$THIS_LOG"

	sudo make install                                                2>&1 | tee -a "$THIS_LOG"
	CheckForError $? "$THIS_LOG"
else
	# for non-help params, alwayss check versions even if not updating them
	cd "$WORKSPACE"
	cd prjtrellis
	if [ "$params" != "--help" ]; then
		CheckForGitFileChange README.md
	fi
fi


if [[ "$1" == *"--nextpnr"* ]] || [ "$1" == "" ]; then
	cd "$WORKSPACE"
	THIS_LOG=$LOG_DIRECTORY"/"$THIS_FILE_NAME"_nextpnr_"$LOG_SUFFIX".log"

	echo "***************************************************************************************************"
	echo " nextpnr-ecp5. Saving log to $THIS_LOG"
	echo "***************************************************************************************************"
	# see https://github.com/YosysHQ/nextpnr#nextpnr-ecp5
	if [ ! -d "$WORKSPACE"/nextpnr ]; then
	  git clone https://github.com/YosysHQ/nextpnr.git               2>&1 | tee -a "$THIS_LOG"
	  cd nextpnr
	else
	  cd nextpnr
	  git fetch                                                      2>&1 | tee -a "$THIS_LOG"
	  git pull                                                       2>&1 | tee -a "$THIS_LOG"

	  make clean                                                     2>&1 | tee -a "$THIS_LOG"
	  CheckForError $? "$THIS_LOG" "./CMakeFiles/CMakeOutput.log" "./CMakeFiles/CMakeError.log"
	  # CheckForError $? "$THIS_LOG"
	fi

	# Note the "DTRELLIS_INSTALL_PREFIX=/usr" value is the install directory, not git workspace clone directory
	# If CMake fails, try rm CMakeCache.txt
	cmake -DARCH=ecp5 -DTRELLIS_INSTALL_PREFIX=/usr .           2>&1 | tee -a "$THIS_LOG"
	echo This error: $?
	CheckForError $? "./CMakeFiles/CMakeOutput.log" "./CMakeFiles/CMakeError.log"

	# this is currently failing with
	# [ 17%] Generating ecp5/chipdbs/chipdb-25k.bba
	# Traceback (most recent call last):
	#   File "/home/gojimmypi/workspace/nextpnr/ecp5/trellis_import.py", line 3, in <module>
	#     import database
	# ModuleNotFoundError: No module named 'database'
	# see https://stackoverflow.com/questions/9383014/cant-import-my-own-modules-in-python
	# to fix:
	# export PYTHONPATH="~/workspace/prjtrellis/database"
	make -j$(nproc)                                                  2>&1 | tee -a "$THIS_LOG"

	# CheckForError $?
	CheckForError $? "./CMakeFiles/CMakeOutput.log" "./CMakeFiles/CMakeError.log"

	sudo make install                                                2>&1 | tee -a "$THIS_LOG"
	CheckForError $?
else
	# for non-help params, alwayss check versions even if not updating them
	cd "$WORKSPACE"
	cd nextpnr
	if [ "$params" != "--help" ]; then
		CheckForGitFileChange README.md
	fi
fi


if [[ "$1" == *"--yosys"* ]] || [ "$1" == "" ]; then
	cd "$WORKSPACE"
	THIS_LOG=$LOG_DIRECTORY"/"$THIS_FILE_NAME"_yosys_"$LOG_SUFFIX".log"

	echo "***************************************************************************************************"
	echo " yosys. Saving log to $THIS_LOG"
	echo "***************************************************************************************************"
	# see http://www.clifford.at/yosys/
	if [ ! -d "$WORKSPACE"/yosys ]; then
	  git clone https://github.com/cliffordwolf/yosys.git yosys      2>&1 | tee -a "$THIS_LOG"
	  cd yosys
	else
	  cd yosys
	  git fetch                                                      2>&1 | tee -a "$THIS_LOG"
	  git pull                                                       2>&1 | tee -a "$THIS_LOG" 

	  make clean                                                     2>&1 | tee -a "$THIS_LOG"
	  CheckForError $? "$THIS_LOG"
	fi

	make -j$(nproc)                                                  2>&1 | tee -a "$THIS_LOG"
	CheckForError $? "$THIS_LOG"

	sudo make install                                                2>&1 | tee -a "$THIS_LOG"
	CheckForError $? "$THIS_LOG"
else
	# for non-help params, alwayss check versions even if not updating them
	cd "$WORKSPACE"
	cd yosys
	if [ "$params" != "--help" ]; then
		CheckForGitFileChange README.md
	fi
fi


if [[ "$1" == *"--ujprog"* ]] || [ "$1" == "" ]; then
	cd "$WORKSPACE"
	THIS_LOG=$LOG_DIRECTORY"/"$THIS_FILE_NAME"_ujprog_"$LOG_SUFFIX".log"

	echo "***************************************************************************************************"
	echo " ujprog. Saving log to $THIS_LOG"
	echo "***************************************************************************************************"
	# see https://github.com/f32c/tools/tree/master/ujprog
	# NOTE: Although this successfully compiles, it does not seem to work in WSL (not USB device support)
	if [ ! -d "$WORKSPACE"/f32c_tools ]; then
	  git clone https://github.com/f32c/tools.git f32c_tools         2>&1 | tee -a "$THIS_LOG"
	  cd f32c_tools/ujprog
	else
	  cd f32c_tools
	  git fetch                                                      2>&1 | tee -a "$THIS_LOG"
	  git pull                                                       2>&1 | tee -a "$THIS_LOG"
	  cd f32c_tools/ujprog

	  make clean                                                     2>&1 | tee -a "$THIS_LOG"
	  CheckForError $? "$THIS_LOG"
	fi

	# There's no point to making the linux version of ujprog in WSL, as native USB devices are not supported.
	# but we can compile the Windows version, amd actually call it from WSL (call from /mnt/c... not ~/...)
	if grep -q Microsoft /proc/version; then
	  THIS_LOG=$LOG_DIRECTORY"/"$THIS_FILE_NAME"_ming32_64_"$LOG_SUFFIX".log"
	  cd "$WORKSPACE"

	  echo "***************************************************************************************************"
	  echo " ming32_64. Saving log to $THIS_LOG"
	  echo "***************************************************************************************************"

	  make -f Makefile.ming32_64                                     2>&1 | tee -a "$THIS_LOG"
	  CheckForError $? "$THIS_LOG"

	  sudo make -f Makefile.ming32_64 install                        2>&1 | tee -a "$THIS_LOG"
	  CheckForError $? "$THIS_LOG"
	else
	  make -f Makefile.linux                                         2>&1 | tee -a "$THIS_LOG"
	  CheckForError $? "$THIS_LOG"

	  sudo make -f Makefile.linux install                            2>&1 | tee -a "$THIS_LOG"
	  CheckForError $? "$THIS_LOG"
      
	  # The default install directory for ujprog is /usr/local/bin/ujprog however the rxrbln Makefile 
	  # expects it to be /usr/src/f32c-ujprog/ujprog/ujprog so we'll just create a quick symlink
	  sudo mkdir -p /usr/src/f32c-ujprog/ujprog/
      sudo ln -s /usr/local/bin/ujprog /usr/src/f32c-ujprog/ujprog/ujprog
	fi
else
	# for non-help params, alwayss check versions even if not updating them
	cd "$WORKSPACE"
	cd f32c_tools/ujprog
	if [ "$params" != "--help" ]; then
		CheckForGitFileChange README.md
	fi
fi


if [[ "$1" == *"--version"* ]] || [ "$1" == "" ]; then
	cd "$WORKSPACE"
	THIS_LOG=$LOG_DIRECTORY"/"$THIS_FILE_NAME"_version_"$LOG_SUFFIX".log"

	echo "***************************************************************************************************"
	echo " show versions installed. Saving log to $THIS_LOG"
	echo "***************************************************************************************************"
	lsb_release -a                                                              2>&1 | tee -a "$THIS_LOG"
	python  --version                                                           2>&1 | tee -a "$THIS_LOG"
	python3 --version                                                           2>&1 | tee -a "$THIS_LOG"
	cmake   --version                                                           2>&1 | tee -a "$THIS_LOG"
	clang   --version                                                           2>&1 | tee -a "$THIS_LOG"
	echo qtf_default $(apt-cache show qt5-default | grep -m1 Version)           2>&1 | tee -a "$THIS_LOG"
	echo libboost-all-dev $(apt-cache show libboost-all-dev | grep -m1 Version) 2>&1 | tee -a "$THIS_LOG"

	for pk in build-essential clang bison flex libreadline-dev \
			  gawk tcl-dev libffi-dev git mercurial graphviz   \
			  xdot pkg-config python python3 libftdi-dev \
			  qt5-default python3-dev libboost-dev; \
	  do echo "$pk" $(apt-cache show "$pk" | grep -m1 Version 2>&1 | tee -a "$THIS_LOG");  done

	nextpnr-ecp5 --version                                                      2>&1 | tee -a "$THIS_LOG"
	yosys -V                                                                    2>&1 | tee -a "$THIS_LOG"
fi



if [[ "$1" == *"--ulx3s-bin"* ]] || [ "$1" == "" ]; then
	cd "$WORKSPACE"
	THIS_LOG=$LOG_DIRECTORY"/"$THIS_FILE_NAME"_ulx3s-bin_"$LOG_SUFFIX".log"

	echo "***************************************************************************************************"
	echo " ulx3s-bin. Saving log to $THIS_LOG"
	echo "***************************************************************************************************"
	if [ ! -d "$WORKSPACE"/ulx3s-bin ]; then
	  git clone --recursive https://github.com/ulx3s/ulx3s-bin.git    2>&1 | tee -a "$THIS_LOG"
	  cd ulx3s-bin
	else
	  cd ulx3s-bin
	  git fetch                                                       2>&1 | tee -a "$THIS_LOG"
	  git pull                                                        2>&1 | tee -a "$THIS_LOG"
	fi
fi

if [[ "$1" == *"--make"* ]] || [ "$1" == "" ]; then
	cd "$WORKSPACE"
	THIS_LOG=$LOG_DIRECTORY"/"$THIS_FILE_NAME"_make_"$LOG_SUFFIX".log"

	echo "***************************************************************************************************"
	echo "  build the ULX3S-Blinky. Saving log to $THIS_LOG"
	echo "***************************************************************************************************"
	# See https://github.com/DoctorWkt/ULX3S-Blinky

	cd ULX3S-Blinky


	# Get our WSL-specific Makefile
	# wget (todo)/raw/Makefile -O Makefile

	make clean

	# the make prog looks for ~wkt/.bin/ujprog, which we don't have.
	# so we'll make the bit file and upload explicitly.
	# see also ~/$WORKSPACE/ulx3s-bin/ quick start files for ujprog
	make ulx3s.bit

	read -p "Press [Enter] to upload blinky to ulx3s"
	echo ""
    $WORKSPACE/f32c_tools/ujprog/ujprog ulx3s.bit

	date
fi




echo ""
echo "Done!"
if [ "$params" != "--help" ]; then
	echo "See log files in:" $LOG_DIRECTORY
	ls $LOG_DIRECTORY | grep -x $THIS_FILE_NAME".*"$LOG_SUFFIX".log"
fi
cd $STARTING_PATH

exit