summaryrefslogtreecommitdiff
path: root/resources/scripts/download/u-boot
blob: 2e0863373e8846e4df113160014d17aab7926ea6 (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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
#!/usr/bin/env bash

#  helper script: download u-boot
#
#	Copyright (C) 2014, 2015, 2016, 2020, 2021 Leah Rowe <info@minifree.org>
#	Copyright (C) 2021 Denis 'GNUtoo' Carikli  <GNUtoo@cyberdimension.org>
#	Copyright (C) 2022 Alper Nebi Yasak <alpernebiyasak@gmail.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

# set this when you want to modify each u-boot tree
# for example, you want to test custom patches
# NODELETE= ./download u-boot
deletegit="true"
deleteblobs="true"
if [ "x${NODELETE+set}" = 'xset' ]; then
	[ "x${NODELETE:-all}" = "xgit" ] && deletegit="false"
	[ "x${NODELETE:-all}" = "xall" ] && deleteblobs="false" && deletegit="false"
fi

# Error handling is extreme in this script.
# This script handles the internet, and Git. Both are inherently unreliable.
[[ -f build_error ]] && rm -f build_error

list_supported_boards() {
	for board in resources/u-boot/*; do
		if [ -d ${board} ]; then
			echo "${board#resources/u-boot/}"
		fi
	done
}

downloadfor() {
	board="${1}"

	# 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
		ubrevision="undefined"
		ubtree="undefined"

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

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

		# This is to override $ubrevision and $ubtree
		source "resources/u-boot/${board}/board.cfg" || touch build_error
		if [ -f build_error ]; then
			printf "ERROR: %s: problem sourcing %s/board.cfg\n" \
				"download/u-boot" "${board}"
			return 1
		fi
		touch "resources/u-boot/${board}/seen"

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

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

	rm -f resources/u-boot/*/seen

	ubtree="u-boot/${ubtree}"
	if [ -d "${ubtree}" ]; then
	    printf \
		"REMARK: '%s' directory already exists. Skipping setup.\n" \
		"${ubtree}"
		if [ "${ubtree}" != "u-boot/${board}" ]; then
			printf "(for board: '${board}')\n"
		fi
		return 0
	fi

	if [ ! -d "u-boot" ]; then
		mkdir -p "u-boot"
	fi

	if [ ! -d "u-boot" ]; then
		printf \
			"ERROR: '%s' directory not created. Check file system permissions\n" \
			"u-boot"
		return 1
	fi

	uboot_dir="u-boot/u-boot"
	if [ ! -d "${uboot_dir}/.git" ] && [ -d "${uboot_dir}" ]; then
		rm -Rf "${uboot_dir}"
	fi

	if [ ! -d "${uboot_dir}" ]; then
		printf "Download u-boot from upstream:\n"
		git clone https://source.denx.de/u-boot/u-boot.git \
		    "${uboot_dir}" || \
		    rm -Rf "${uboot_dir}"
		if [ ! -d "${uboot_dir}" ]; then
			printf "WARNING: Upstream failed. Trying backup github repository:\n"
			git clone https://github.com/u-boot/u-boot.git \
				"${uboot_dir}" || \
				rm -Rf coreboot
		fi
		if [ ! -d "${uboot_dir}" ]; then
		    printf \
			"ERROR: %s: Problem with git-clone. Network issue?\n" \
			"download/u-boot"
			return 1
		fi
	else
		git -C "${uboot_dir}" pull || touch build_error
		if [ -f build_error ]; then
		    printf \
			"ERROR: %s: Problem with git-pull. Network issue?\n" \
			"download/u-boot"
			return 1
		fi
	fi

	cp -R "${uboot_dir}" "${ubtree}" || touch build_error
	if [ -f build_error ]; then
		printf "ERROR: %s: Unable to copy directory. Check file system permissions or free space.\n" \
			"download/u-boot"
		rm -Rf "${ubtree}/"
		return 1
	fi

	git -C "${ubtree}" reset --hard ${ubrevision} || \
	    touch build_error
	if [ -f build_error ]; then
	    printf \
		"ERROR: %s: Unable to reset to commit ID/tag '%s' for board '%s' on tree '%s'\n" \
		"download/u-boot" "${ubrevision}" "${board}" "${ubtree}"
		return 1
	fi

	git -C "${ubtree}" submodule update --init || touch build_error
	if [ -f build_error ]; then
		printf "ERROR: %s: Unable to update submodules for tree '%s'\n" \
			"${ubtree}"
		return 1
	fi

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

		git -C "${ubtree}" am "$(pwd)/${patch}" || touch build_error
		if [ -f build_error ]; then
			printf "ERROR: %s: Unable to apply patch '%s' for board '%s' on tree '%s'" \
				"download/u-boot" "${patch}" "${board}" "${ubtree}"
			git -C "${ubtree}" am --abort
			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/u-boot/${board}/extra.sh" ]; then
		"resources/u-boot/${board}/extra.sh" || touch build_error
		if [ -f build_error ]; then
			return 1
		fi
		return 0
	else
		return 0
	fi
}

strip_comments()
{
	file="$1"
	# Remove comments
	sed 's/#.*//' "${file}" | \
	    # Remove lines composed of whitespaces only
	    sed '/^\W\+$/d' | \
		# Remove empty lines
		sed '/^$/d'
}

generate_deblob_script()
{
	blob_list_file="$1"
	output="$2"

	# Add sheebang and copyright headers from this file
	awk '{
		if ($0 !~ /^#/ && NF > 0) {
			stop=1;
		}
		if (stop !=1) {
			printf("%s\n", $0);
		}
	}' $0 >> ${output}

	# Add rm -rf before directories and rm -f before files
	awk \
	'{
	}{
		if (NF == 0) {
			printf("\n");
		} else {
			if ($0 !~ /#/ && $NF ~ /\/$/) {
				printf("rm -rf %s\n", $0);
			} else if ($0 !~ /#/) {
				printf("rm -f %s\n", $0);
			} else {
				# We have comments, try to see if they are
				# still valid paths before the comments
				comments_found=0
				last_field=0
				for(i=1; i<=NF; i++) {
					if($i ~ /#/) {
						comments_found=1;
					} else if(comments_found != 1) {
						last_field=i;
					}
				}
				if (last_field == 0) {
					printf("%s\n", $0);
				} else if ($last_field ~ /\/$/) {
					printf("rm -rf %s\n", $0);
				} else {
					printf("rm -f %s\n", $0);
				}
			}
		}
	}' "${blob_list_file}" >> "${output}"
}

usage()
{
	progname="./download u-boot"

	printf "Usage:\n"
	printf "\t%s                                # %s\n" \
	       "${progname}" \
	       "Download and deblob u-boot for all boards"
	printf "\t%s [board]                        # %s\n" \
	       "${progname}" \
	       "Download and deblob u-boot for the given board"
	printf "\t%s --blobs-list                   # %s\n" \
	       "${progname}" \
	       "Print the path of the generic blobs.list file"
	printf "\t%s --blobs-list [board]           # %s\n" \
	       "${progname}" \
	       "Print the path of the blobs.list file for the given board"
	printf "\t%s --gen-deblob-script            # %s\n" \
	       "${progname}" \
	       "Print the path of a generated generic deblob script"
	printf "\t%s --gen-deblob-script [board]    # %s\n" \
	       "${progname}" \
	       "Print the path of a generated deblob script for the given board"
	printf "\t%s --list-boards                  # %s\n" \
	       "${progname}" \
	       "List supported boards"
	printf "\t%s --help                         # %s\n" \
	       "${progname}" \
	       "Prints this help"
}

download_uboot_board()
{
	board="${1}"
	ubtree="u-boot/${board}"

	printf "Downloading u-boot "
	printf "and (if exist in build system) applying patches\n"
	downloadfor "${board}"

	rm -f "build_error"
	printf "\n\n"

	if [ "${deleteblobs}" = "true" ]; then
		if [ "${deletegit}" = "true" ]; then
			rm -rf "${ubtree}"/.git* "${ubtree}"/*/.git*
		fi
		blobslist="$(print_blobs_list_path "${board}")"
		for blob_path in $(strip_comments "${blobslist}"); do
		    if echo "${blob_path}" | \
			    grep '/$' 2>&1 >/dev/null ; then
				printf "Deleting blob directory: '%s/%s'\n" \
				       "${ubtree}" "${blob_path}"
				rm -rf "${ubtree}/${blob_path}"
			else
				printf "Deleting blob file: '%s/%s'\n" \
				       "${ubtree}" "${blob_path}"
				rm -f "${ubtree}/${blob_path}"
			fi
		done
	fi
}

print_blobs_list_path()
{
	board="$1"

	if [ -f "resources/u-boot/${board}/blobs.list" ]; then
		printf "resources/u-boot/${board}/blobs.list\n"
	else
		printf "resources/u-boot/default/blobs.list\n"
	fi
}

print_deblob_script_path()
{
	board="$1"
	path="$(mktemp)"

	generate_deblob_script "$(print_blobs_list_path ${board})" "${path}"
	printf "%s\n" ${path}
}

if [ $# -eq 0 ] ; then
	for board in $(list_supported_boards); do
		download_uboot_board "${board}"
	done

	if [ "${deletegit}" = "true" ]; then
		rm -rf u-boot/u-boot/ u-boot/.git*
	fi

	exit 0
elif [ $# -eq 1 -a "$1" == "--help" ] ; then
	usage
	exit 0
elif [ $# -eq 1 -a "$1" == "--list-boards" ] ; then
	list_supported_boards
	exit 0
elif [ $# -eq 1 -a "$1" == "--blobs-list" ] ; then
	print_blobs_list_path "default"
	exit 0
elif [ $# -eq 2 -a "$1" == "--blobs-list" ] ; then
	found=0
	for board in $(list_supported_boards) ; do
		if [ "${board}" = "$2" ] ; then
			print_blobs_list_path "$2"
			exit 0
		fi
	done

	printf "Error: Board '${2}' is not supported\n"

	exit 1
elif [ $# -eq 1 -a "$1" == "--gen-deblob-script" ] ; then
	print_deblob_script_path "default"
	exit 0
elif [ $# -eq 2 -a "$1" == "--gen-deblob-script" ] ; then
	found=0
	for board in $(list_supported_boards) ; do
		if [ "$board" = "$2" ] ; then
			print_deblob_script_path "$2"
			exit 0
		fi
	done

	printf "Error: Board '${2}' is not supported\n"

	exit 1
elif [ $# -eq 1 ] ; then
	for board in $(list_supported_boards) ; do
		if [ "$board" = "$1" ] ; then
			download_uboot_board "$1"
			exit 0
		fi
	done

	if [ "${deletegit}" = "true" ]; then
		rm -rf u-boot/u-boot/ u-boot/.git*
	fi

	printf "Error: Board '${1}' is not supported\n"

	exit 1
fi

exit 0