install.sh

#!/bin/bash

# Install script for BeagleLogic from git repository
#
# This script is meant to be executed in either a chroot environment (used while
# building the BeagleLogic system image) or after doing a git clone of the
# BeagleLogic repository.
#
# This script only supports the BeagleBone Debian image which have all the
# required dependencies

DIR=$(cd `dirname $0` && pwd -P)
log="beaglelogic:"

# The kernel looks for beaglelogic-pru0-fw and beaglelogic-pru1-fw in /lib/firmware
# The firmware is installed as 'beaglelogic-pru0-fw' and 'beaglelogic-pru1-logic'
# beaglelogic-pru1-fw is further symlinked to beaglelogic-pru1-logic
# This arrangement enables running PRUDAQ by simply updating the symlink and
# reloading the beaglelogic kernel module
install_pru_firmware () {
	# Required for compiling the firmware, see firmware/Makefile
	if [ ! -d /usr/share/ti/cgt-pru/bin ] ; then
		ln -s /usr/bin/ /usr/share/ti/cgt-pru/bin
	fi

	echo "${log} Building and installing PRU firmware"
	export PRU_CGT=/usr/share/ti/cgt-pru
	cd "${DIR}/firmware"
	make
	make install

	cd "${DIR}/firmware/custom/prudaq"
	make
	make install

	if [ ! "x${RUNNING_AS_CHROOT}" = "xyes" ] ; then
		update-initramfs -u -k `uname -r`
	fi
}

create_beaglelogic_group() {
	echo "${log} Creating beaglelogic group and adding $DEFAULT_USER to it"

	groupadd -f beaglelogic
	usermod -aG beaglelogic ${DEFAULT_USER}
}


# Udev rules required to allow the default user to modify BeagleLogic
# sysfs attributes without requiring root permissions
install_udev_rules() {
	echo "${log} Installing udev rules"
	cp -v "${DIR}/scripts/90-beaglelogic.rules" "/etc/udev/rules.d/"
}

install_systemd_service() {
	echo "${log} Installing systemd startup service"
	cp -v "${DIR}/scripts/beaglelogic" "/etc/default/beaglelogic"
	cp -v "${DIR}/scripts/beaglelogic-tcp" "/etc/default/beaglelogic-tcp"
	cp -v "${DIR}/scripts/beaglelogic.service" "/lib/systemd/system/beaglelogic.service"
	cp -v "${DIR}/scripts/beaglelogic-startup.service" "/lib/systemd/system/beaglelogic-startup.service"
	cp -v "${DIR}/scripts/beaglelogic-tcp.service" "/lib/systemd/system/beaglelogic-tcp.service"
	chown root:root "/lib/systemd/system/beaglelogic.service"
	chown root:root "/lib/systemd/system/beaglelogic-startup.service"
	chown root:root "/lib/systemd/system/beaglelogic-tcp.service"
	sed -i -e "s:DIR:${DIR}:" "/lib/systemd/system/beaglelogic.service"
	sed -i -e "s:DIR:${DIR}:" "/lib/systemd/system/beaglelogic-startup.service"
	sed -i -e "s:DIR:${DIR}:" "/lib/systemd/system/beaglelogic-tcp.service"
	systemctl enable beaglelogic.service || true
	systemctl enable beaglelogic-startup.service || true
	systemctl enable beaglelogic-tcp.service || true
}

install_sigrok() {
	echo "${log} Installing sigrok and its dependencies"
	# Installing just sigrok-cli pulls all dependencies
	apt install -y sigrok-cli
}

install_node_modules() {
	echo "${log} Installing npm components for beaglelogic-server"
	cd ${DIR}/server
	if [ ! -d node_modules ] ; then
		/bin/su ${DEFAULT_USER} -c "npm install"
	fi
}

install_go_and_compile_server() {
	echo "${log} Installing Go"
	apt install -y golang

	echo "${log} Compiling TCP Server"
	cd ${DIR}/tcp-server-go
	/bin/su ${DEFAULT_USER} -c "go build server.go"
}

update_uboot_uenv_txt() {
	if [ ! "x${RUNNING_AS_CHROOT}" = "xyes" ] ; then
		echo "${log} Updating uEnv.txt"
		sed -i -e "s:#disable_uboot_overlay_video:disable_uboot_overlay_video:" "/boot/uEnv.txt"
		sed -i -e "s:uboot_overlay_pru:#uboot_overlay_pru:" "/boot/uEnv.txt"
		echo '#Load BeagleLogic Cape' >> "/boot/uEnv.txt"
		echo 'dtb_overlay=/lib/firmware/beaglelogic-00A0.dtbo' >> "/boot/uEnv.txt"
	fi
}

display_success_message() {
	if [ ! "x${RUNNING_AS_CHROOT}" = "xyes" ] ; then
		echo "${log} Successfully Installed. Please reboot"
	else
		echo "${log} Installation Completed, uEnv.txt must be updated"
	fi
}


if [ "x$1" = "x--upgrade" ] ; then
	UPGRADING="yes"
else
	UPGRADING="no"
fi

if [ "x$1" = "x--update-uenv-txt" ] ; then
	update_uboot_uenv_txt
	exit 0
fi

if [ "x$1" = "x--chroot" ] ; then
	DEFAULT_USER=$2
	RUNNING_AS_CHROOT="yes"
else
	RUNNING_AS_CHROOT="no"
	if [ ! "x$SUDO_USER" = "x" ] ; then
		DEFAULT_USER=$SUDO_USER
	else
		DEFAULT_USER="debian"
	fi
fi

install_pru_firmware
if [ "x${UPGRADING}" = "xno" ] ; then
	create_beaglelogic_group
fi
install_udev_rules
install_systemd_service
install_node_modules
install_go_and_compile_server
install_sigrok
if [ "x${UPGRADING}" = "xno" ] ; then
	update_uboot_uenv_txt
fi
display_success_message