summaryrefslogtreecommitdiff
path: root/resources/scripts/download/coreboot
blob: 821ee321421ad30510942692c30033f10901abec (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
#!/usr/bin/env sh

#  helper script: download coreboot
#
#	Copyright (C) 2014, 2015, 2016, 2020, 2021 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/>.
#

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

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                     # %s\n" \
	       "${progname}" \
	       "Download coreboot for all the boards"
	printf "\t%s [board [board] ...] # %s\n" \
	       "${progname}" \
	       "Download coreboot for the given boards"
	printf "\t%s --list-boards       # %s\n" \
	       "${progname}" \
	       "Prints this help"
	printf "\t%s --help              # %s\n" \
	       "${progname}" \
	       "List supported boards"
	printf "\t%s --help              # %s\n" \
	       "${progname}" \
	       "Prints this help"
}

# 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

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)
	while true; do
		cbrevision="undefined"
		cbtree="undefined"

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

		if [ -f "resources/coreboot/${board}/seen" ]; then
			printf "ERROR: download/coreboot: logical loop; '%s' board.cfg refers to another tree, which ultimately refers back to '%s'.\n" "${board}" "${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: 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: tree name undefined for '%s\n'" "${board}"
				return 1
			fi

			if [ "${cbrevision}" = "undefined" ]; then
				printf "ERROR: download/coreboot: 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: directory for '%s' already exists. Skipping setup.\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. 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 github repository:\n"
			git clone https://github.com/coreboot/coreboot.git || rm -Rf coreboot
		fi
		if [ ! -d coreboot ]; then 
			printf "ERROR: download/coreboot: 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: 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. 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 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: 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 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
}

printf "Downloading coreboot and (if exist in build system) 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