path: root/resources/scripts/download/coreboot

#!/usr/bin/env sh

#  helper script: download coreboot
#
#	Copyright (C) 2014,2015,2016,2020,2021,2023 Leah Rowe
#							<info@minifree.org>
#	Copyright (C) 2022 Alper Nebi Yasak <alpernebiyasak@gmail.com>
#	Copyright (C) 2022 Ferass El Hafidi <vitali64pmemail@protonmail.com>
#
#	This program 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.
#
#	This program 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/>.
#

# TODO: purge this entire file. it's terrible. re-write it more cleanly.

[ "x${DEBUG+set}" = 'xset' ] && set -v
set -u -e

main()
{
	# In this script, set -u is used to check for undefined variables, and
	# the test command doesn't do any lazy evaluation, so we can't use
	# a syntax like that: [ $# -eq 1 -a "$1" = "--help" ].

	if [ $# -eq 1 ] && [ "$1" = "--help" ] ; then
		usage
		exit 0
	elif [ $# -eq 1 ] && [ "$1" = "--list-boards" ] ; then
		list_supported_boards
		exit 0
	fi

	[ -f build_error ] && rm -f build_error

	rm -f resources/coreboot/*/seen

	printf "Downloading coreboot and (if available) applying patches\n"

	if [ $# -gt 0 ]; then
		for board in "${@}"; do
			rm -f resources/coreboot/*/seen
			downloadfor "${board}"
			if [ -f build_error ]; then
				break
			fi
		done
	else
		for board in resources/coreboot/*; do
			rm -f resources/coreboot/*/seen
			if [ ! -d "${board}/" ]; then
				continue
			fi
			downloadfor "${board##*/}"
			if [ -f build_error ]; then
				break
			fi
		done
	fi

	rm -f resources/coreboot/*/seen

	rm -f "build_error"
	printf "\n\n"
	exit 0
}

list_supported_boards()
{
	for board in resources/coreboot/*; do
		echo $board | sed 's#resources/coreboot/##'
	done
}

usage()
{
	progname="./download coreboot"
	printf "Usage:\n"
	printf "\t%s\t\t\t# Clone coreboot for all boards\n" "${progname}"
	printf "\t%s [board [board] ...] # Clone coreboot for given boards\n" \
			${progname}
	printf "\t%s --list-boards\t# Prints this help\n" ${progname}
	printf "\t%s --help\t\t# List supported boards\n" ${progname}
	printf "\t%s --help\t\t# Prints this help\n" ${progname}
}

downloadfor() {

	board="${1}"
	cbtree="undefined"
	cbrevision="undefined"

	# The loop will always exit, but this while loop is crafted
	# such that a tree referencing a tree that references another
	# tree is possible (and so on and so forth)

	while true; do
		cbrevision="undefined"
		cbtree="undefined"

		if [ ! -f "resources/coreboot/${board}/board.cfg" ]; then
			printf "ERROR: download/coreboot: board.cfg does not"
			printf " exist for '%s'\n" ${board}
			return 1
		fi

		if [ -f "resources/coreboot/${board}/seen" ]; then
			printf "ERROR: download/coreboot: logical loop:"
			printf " '%s' board.cfg refers to another tree," \
					${board}
			printf " which ultimately refers back to '%s'." \
					${board}
			return 1
		fi

		# This is to override $cbrevision and $cbtree
		. "resources/coreboot/${board}/board.cfg" \
				|| touch ../build_error

		if [ -f build_error ]; then
			printf "ERROR: download/coreboot:"
			printf " problem sourcing %s/board.cfg\n" "${board}"
			return 1
		fi
		touch "resources/coreboot/${board}/seen"

		if [ "${board}" != "${cbtree}" ]; then
			board="${cbtree}"
		else
			if [ "${cbtree}" = "undefined" ]; then
				printf "ERROR: download/coreboot:"
				printf " tree name undefined for '%s\n'" \
						${board}
				return 1
			fi

			if [ "${cbrevision}" = "undefined" ]; then
				printf "ERROR: download/coreboot:"
				printf " commit ID undefined for '%s'\n" \
						${board}
				return 1
			fi
			break
		fi
	done

	rm -f resources/coreboot/*/seen

	if [ -d "coreboot/${cbtree}" ]; then
		printf "REMARK: download/coreboot %s: exists. Skipping.\n" \
				${cbtree}
		if [ "${cbtree}" != "${1}" ]; then
			printf "(for board: '${1}')\n"
		fi
		return 0
	fi

	if [ ! -d coreboot ]; then
		mkdir "coreboot/"
	fi
	if [ ! -d coreboot ]; then
		printf "ERROR: download/coreboot: directory not created."
		printf " Check file system permissions\n"
		return 1
	fi

	cd "coreboot/"

	if [ ! -d coreboot/.git ] && [ -d coreboot ]; then
		rm -Rf coreboot/
	fi

	if [ ! -d coreboot ]; then
		printf "Download coreboot from upstream:\n"
		git clone https://review.coreboot.org/coreboot \
				|| rm -Rf coreboot
		if [ ! -d coreboot ]; then
			printf "WARNING: Upstream failed. Trying backup:\n"
			git clone https://github.com/coreboot/coreboot.git \
					|| rm -Rf coreboot
		fi
		if [ ! -d coreboot ]; then 
			printf "ERROR: download/coreboot:"
			printf " Problem with git-clone. Network issue?\n"
			cd ../
			return 1
		fi
	else
		( cd coreboot/; git pull || touch ../build_error )
		if [ -f ../build_error ]; then
			printf "ERROR: download/coreboot:"
			printf " Problem with git-pull. Network issue?\n"
			cd ../
			return 1
		fi
	fi

	cp -R coreboot "${cbtree}" || touch ../build_error
	if [ -d ../build_error ]; then
		printf "ERROR: download/coreboot: Unable to copy directory."
		printf " Check file system permissions or free space.\n"
		rm -Rf "${cbtree}/"
		cd ../
		return 1
	fi

	cd ${cbtree}/

	git reset --hard ${cbrevision} || touch ../../build_error
	if [ -f ../../build_error ]; then
		printf "ERROR: download/coreboot: Unable to reset to commit"
		printf " ID/tag '%s' for board '%s' on tree '%s'\n" \
				${cbrevision} ${1} ${cbtree}
		cd ../../
		return 1
	fi

	git submodule update --init --checkout || touch ../../build_error
	if [ -f ../../build_error ]; then
		printf "ERROR: download/coreboot:"
		printf " Unable to update submodules for tree '%s'\n" \
				${cbtree}
		cd ../../
		return 1
	fi

	for patch in ../../resources/coreboot/${cbtree}/patches/*.patch; do
		if [ ! -f "${patch}" ]; then
			continue
		fi

		git am "${patch}" || touch ../../build_error
		if [ -f ../../build_error ]; then
			printf "ERROR: download/coreboot: Unable to apply"
			printf " patch '%s' for board '%s' on tree '%s'" \
					${patch} ${1} ${cbtree}
			git am --abort
			cd ../../
			return 1
		fi
	done

	# extra.sh could be used to patch submodules, if you wanted to
	# It's impossible to predict what submodules will be available, and
	# it's rare that you'd want to patch them, so this is handled by
	# extra.sh on a per-board basis
	# In fact, extra.sh can be used for anything you want.
	if [ -f "../../resources/coreboot/${board}/extra.sh" ]; then
		"../../resources/coreboot/${board}/extra.sh" \
				|| touch ../../build_error
		if [ -f ../../build_error ]; then
			cd ../../; return 1
		fi
		return 0
	else
		cd ../../
		return 0
	fi
}

main $@