summaryrefslogtreecommitdiff
path: root/resources/scripts/update/blobs/download
blob: 49f3fa4c52be74b87a14d44233ada2de764f00ed (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
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
#!/usr/bin/env sh

# SPDX-FileCopyrightText: 2022 Caleb La Grange <thonkpeasant@protonmail.com>
# SPDX-FileCopyrightText: 2022 Ferass El Hafidi <vitali64pmemail@protonmail.com>
# SPDX-FileCopyrightText: 2023 Leah Rowe <info@minifree.org>
# SPDX-License-Identifier: GPL-3.0-only

agent="Mozilla/5.0 (Windows NT 10.0; rv:91.0) Gecko/20100101 Firefox/91.0"

ec_url=""
ec_url_bkup=""
ec_hash=""
dl_hash=""
dl_url=""
dl_url_bkup=""
dl_path=""
e6400_vga_dl_hash=""
e6400_vga_dl_url=""
e6400_vga_dl_url_bkup=""
e6400_vga_offset=""
e6400_vga_romname=""
sch5545ec_dl_url=""
sch5545ec_dl_url_bkup=""
sch5545ec_dl_hash=""

cbdir="coreboot/default"
cbcfgsdir="resources/coreboot"
boarddir=""
blobdir="blobs"
appdir="${blobdir}/app"
_7ztest="a"
mecleaner="$(pwd)/me_cleaner/me_cleaner.py"
e6400_unpack="$(pwd)/bios_extract/dell_inspiron_1100_unpacker.py"
me7updateparser="$(pwd)/resources/blobs/me7_update_parser.py"
kbc1126_ec_dump="$(pwd)/${cbdir}/util/kbc1126/kbc1126_ec_dump"
board=""
pfs_extract="$(pwd)/biosutilities/Dell_PFS_Extract.py"
uefiextract="$(pwd)/uefitool/uefiextract"
_b="" # board shorthand without e.g. _4mb (avoid duplication per flash size)

CONFIG_HAVE_MRC=""
CONFIG_HAVE_IFD_BIN=""
CONFIG_HAVE_ME_BIN=""
CONFIG_HAVE_GBE_BIN=""
CONFIG_KBC1126_FIRMWARE=""
CONFIG_BOARD_DELL_E6400=""
CONFIG_VGA_BIOS_FILE=""
CONFIG_INCLUDE_SMSC_SCH5545_EC_FW=""
CONFIG_SMSC_SCH5545_EC_FW_FILE=""

main()
{
	board="${1}"
	boarddir="${cbcfgsdir}/${board}"

	[ ! -d "${boarddir}" ] && \
	    fail "Board target, ${board}, not defined"
	[ ! -f "${boarddir}/target.cfg" ] && \
	    fail "Target missing target.cfg"

	no_config="printf \"No config for target, %s\\n\" ${board} 1>&2; exit 0"
	for x in "${boarddir}"/config/*; do
		if [ -f "${x}" ]; then
			no_config=""
		fi
	done
	eval "${no_config}"
	
	detect_firmware || exit 0
	scan_sources_config

	build_dependencies
	download_blobs
}

detect_firmware()
{
	set -- "${boarddir}/config/"*
	. ${1} 2>/dev/null
	. "${boarddir}/target.cfg"

	if [ "${CONFIG_HAVE_MRC}" = "y" ]; then
		needs="${needs} MRC"
	fi
	if [ "${CONFIG_HAVE_IFD_BIN}" = "y" ]; then
		needs="${needs} IFD"
	fi
	if [ "${CONFIG_HAVE_ME_BIN}" = "y" ]; then
		needs="${needs} ME"
	fi
	if [ "${CONFIG_HAVE_GBE_BIN}" = "y" ]; then
		needs="${needs} GBE"
	fi
	if [ "${CONFIG_KBC1126_FIRMWARE}" = "y" ]; then
		needs="${needs} EC"
	fi
	if [ "${CONFIG_BOARD_DELL_E6400}" = "y" ] \
			&& [ "${CONFIG_VGA_BIOS_FILE}" != "" ]; then
		needs="${needs} E6400VGA"
	fi
	if [ "${CONFIG_INCLUDE_SMSC_SCH5545_EC_FW}" = "y" ]; then
		needs="${needs} SCH5545EC"
	fi
	if [ -z ${needs+x} ]; then
		printf 'No binary blobs needed for this board\n'
		return 1
	fi
	printf "Firmware needed for board '%s':\n" ${board}
	printf "%s\n" ${needs}
}

scan_sources_config()
{
	# Shorthand (avoid duplicating configs per flash size)
	_b=${board%%_*mb}

	awkstr=" /\{.*${_b}.*}{/ {flag=1;next} /\}/{flag=0} flag { print }"

	while read -r line ; do
		case ${line} in
		EC_url_bkup*)
			set ${line}
			ec_url_bkup=${2}
			;;
		EC_url*)
			set ${line}
			ec_url=${2}
			;;
		EC_hash*)
			set ${line}
			ec_hash=${2}
			;;
		DL_hash*)
			set ${line}
			dl_hash=${2}
			;;
		DL_url_bkup*)
			set ${line}
			dl_url_bkup=${2}
			;;
		DL_url*)
			set ${line}
			dl_url=${2}
			;;
		E6400_VGA_DL_hash*)
			set ${line}
			e6400_vga_dl_hash=${2}
			;;
		E6400_VGA_DL_url_bkup*)
			set ${line}
			e6400_vga_dl_url_bkup=${2}
			;;
		E6400_VGA_DL_url*)
			set ${line}
			e6400_vga_dl_url=${2}
			;;
		E6400_VGA_offset*)
			set ${line}
			e6400_vga_offset=${2}
			;;
		E6400_VGA_romname*)
			set ${line}
			e6400_vga_romname=${2}
			;;
		SCH5545EC_DL_hash*)
			set ${line}
			sch5545ec_dl_hash=${2}
			;;
		SCH5545EC_DL_url_bkup*)
			set ${line}
			sch5545ec_dl_url_bkup=${2}
			;;
		SCH5545EC_DL_url*)
			set ${line}
			sch5545ec_dl_url=${2}
			;;
		esac
	done << EOF
	$(eval "awk '${awkstr}' resources/blobs/sources")
EOF
}

build_dependencies()
{
	if [ ! -d me_cleaner ]; then
		printf "downloading me_cleaner\n"
		./fetch me_cleaner || fail "could not download me_cleaner"
	fi
	if [ ! -d ${cbdir} ]; then
		printf "downloading coreboot\n"
		./fetch_trees coreboot default \
				|| fail "could not download coreboot"
	fi
	if [ ! -d bios_extract ]; then
		printf "downloading bios_extract\n"
		./fetch bios_extract \
				|| fail "could not download bios_extract"
	fi
	if [ ! -d biosutilities ]; then
		printf "downloading biosutilities\n"
		./fetch biosutilities \
				|| fail "could not download biosutilities"
	fi
	if [ ! -d uefitool ]; then
		printf "download uefitool (for UEFIExtract)\n"
		./fetch uefitool \
				|| fail "could not download uefitool"
	fi
	if [ ! -f uefitool/uefiextract ]; then
		./build src for uefitool \
				|| fail "could not build uefitool"
	fi
	if [ ! -f ${cbdir}/util/kbc1126/kbc1126_ec_dump ]; then
		printf "Building kbc1126_ec_dump from coreboot\n"
		make -BC ${cbdir}/util/kbc1126 \
				|| fail "could not build kbc1126_ec_dump"
	fi
	if [ ! -f "${cbdir}/util/ifdtool/ifdtool" ]; then
		printf "building ifdtool from coreboot\n"
		make -C ${cbdir}/util/ifdtool \
				|| fail 'could not build ifdtool'
	fi
}

download_blobs()
{
	for need in ${needs}; do
		case ${need} in
		*ME*)
			download_blob_intel_me || _failed="${_failed} me"
			;;
		*SCH5545EC*)
			download_sch5545ec || failed="${_failed} sch5545ec"
			;;
		*EC*)
			download_ec || _failed="${_failed} ec"
			;;
		*E6400VGA*)
			download_e6400vga || _failed="${_failed} e6400vga"
			;;
		*MRC*)
			./update blobs mrc || _failed="${_failed} mrc"
			;;
		esac
	done
	
	if [ ! -z ${_failed+x} ]; then
		fail "failed to obtain ${_failed}\nTry manual extraction?"
	fi
}

download_blob_intel_me()
{
	printf "Downloading neutered ME for board: %s\n" ${board}

	fetch_update me || return 1
	extract_blob_intel_me || return 1
}

extract_blob_intel_me()
{
	printf "Extracting neutered ME for ${board}\n"

	_me_destination=${CONFIG_ME_BIN_PATH#../../}

	if [ ! -d "${_me_destination%/*}" ]; then
		mkdir -p ${_me_destination%/*}
	fi
	if [ -d "${appdir}" ]; then
		rm -r ${appdir}
	fi
	if [ -f "${_me_destination}" ]; then
		printf 'me already downloaded\n'
		return 0
	fi

	printf "Extracting and stripping Intel ME firmware\n"

	innoextract ${dl_path} -d ${appdir} \
	|| 7z x ${dl_path} -o${appdir} \
	|| unar "${dl_path}" -o "${appdir}" \
		|| fail 'Could not extract vendor update' 

	bruteforce_extract_blob_intel_me "$(pwd)/${_me_destination}" \
			"$(pwd)/${appdir}" \
		|| fail "Could not extract Intel ME firmware"

	printf "Truncated and cleaned me output to ${_me_destination}\n"
}

# cursed, carcinogenic code. TODO rewrite it better
bruteforce_extract_blob_intel_me()
{
	_me_destination="${1}"
	cdir="${2}" # must be an absolute path, not relative

	if [ -f "${_me_destination}" ]; then
		return 0
	fi

	sdir="$(mktemp -d)"
	mkdir -p "${sdir}" || return 1

	(
	printf "Entering %s\n" "${cdir}"
	cd "${cdir}" || exit 1
	for i in *; do
		if [ -f "${_me_destination}" ]; then
			# me.bin found, so avoid needless further traversal
			break
		elif [ -L "${i}" ]; then
			# symlinks are a security risk, in this context
			continue
		elif [ -f "${i}" ]; then
			"${mecleaner}" -r -t -O "${sdir}/vendorfile" \
					-M "${_me_destination}" "${i}" \
				&& break # (we found me.bin)	
			"${mecleaner}" -r -t -O "${_me_destination}" "${i}" \
				&& break # (we found me.bin)
			"${me7updateparser}" -O ${_me_destination} "${i}" \
				&& break # (we found me.bin)
			_7ztest="${_7ztest}a"
			7z x "${i}" -o${_7ztest} \
				|| innoextract "${i}" -d  "${_7ztest}" \
				|| unar "${i}" -o "${_7ztest}" \
				|| continue
			bruteforce_extract_blob_intel_me "${_me_destination}" \
					"${cdir}/${_7ztest}"
		elif [ -d "$i" ]; then
			bruteforce_extract_blob_intel_me "${_me_destination}" \
					"${cdir}/${i}"
		else
			printf "SKIPPING: %s\n" "${i}"
			continue
		fi
		cdir="${1}"
		cd "${cdir}"
	done
	)

	rm -Rf "${sdir}"

	if [ ! -f "${_me_destination}" ]; then
		printf "me.bin not found in vendor update for: %s\n" ${board}
		return 1
	fi
}

download_ec()
{
	printf "Downloading KBC1126 EC firmware for HP laptop\n"

	fetch_update ec || return 1
	extract_ec || return 1
}

extract_ec()
{
	printf "Extracting KBC1126 EC firmware for board: %s\n" ${board}

	_ec_destination=${CONFIG_KBC1126_FW1#../../}

	if [ ! -d "${_ec_destination%/*}" ]; then
		mkdir -p "${_ec_destination%/*}"
	fi
	if [ -d "${appdir}" ]; then
		rm -Rf "${appdir}"
	fi
	if [ -f "${_ec_destination}" ]; then
		printf "ec already downloaded\n"
		return 0
	fi

	unar "${dl_path}" -o "${appdir}"

	(
	cd "${appdir}/${dl_path##*/}"

	mv Rompaq/68*.BIN ec.bin
	if [ ! -f ec.bin ]; then
		unar -D ROM.CAB Rom.bin || \
		    unar -D Rom.CAB Rom.bin || \
		    unar -D 68*.CAB Rom.bin
		mv Rom.bin ec.bin
	fi
	if [ ! -f ec.bin ]; then
		printf "could not extract ec.bin for board '%s'" ${board} \
			1>&2
		fail "aborting the build. please audit lbmk carefully."
	fi

	"${kbc1126_ec_dump}" ec.bin
	)

	for i in 1 2; do
		if [ -f "${appdir}/${dl_path##*/}/ec.bin.fw${i}" ]; then
			continue
		fi
		printf "Not found: %s/%s/ec.bin.fw%s\n" \
				${appdir} ${dl_path##*/} ${i}
		printf "Could not extract EC firmware for: %s\n" \
				${board}
		return 1
	done

	cp "${appdir}/${dl_path##*/}"/ec.bin.fw* "${_ec_destination%/*}/"
}

download_e6400vga()
{
	printf "Downloading Nvidia VGA ROM for Dell Latitude E6400\n"

	fetch_update e6400vga || return 1
	extract_e6400vga || return 1
}

extract_e6400vga()
{
	printf "Extracting Nvidia VGA ROM for ${board}\n"

	_vga_destination=${CONFIG_VGA_BIOS_FILE#../../}

	if [ -f "${_vga_destination}" ]; then
		printf 'vga rom already downloaded\n'
		return 0
	fi
	if [ ! -d "${_vga_destination%/*}" ]; then
		mkdir -p ${_vga_destination%/*}
	fi	
	if [ -d "${appdir}" ]; then
		rm -r ${appdir}
	fi

	mkdir -p "${appdir}"
	mv "${dl_path}" "${appdir}"

	if [ "${e6400_vga_offset}" = "" ]; then
		printf "E6400 VGA offset not defined\n"
		return 1
	elif [ "${e6400_vga_romname}" = "" ]; then
		printf "E6400 VGA ROM name not defined\n"
		return 1
	fi

	(
	cd "${appdir}"
	tail -c +${e6400_vga_offset} "${dl_path##*/}" \
			| gunzip > bios.bin
	if [ ! -f "bios.bin" ]; then
		fail 'Could not extract bios.bin from Dell E6400 update'
	fi
	"${e6400_unpack}" bios.bin || printf "TODO: fix dell extract util\n"
	if [ ! -f "${e6400_vga_romname}" ]; then
		fail 'Could not extract VGA ROM from Dell E6400 BIOS update'
	fi
	)

	cp "${appdir}"/"${e6400_vga_romname}" "${_vga_destination}"

	printf "E6400 Nvidia ROM saved to: %s\n" "${_vga_destination}"
}

download_sch5545ec()
{
	printf "Downloading SMSC SCH5545 Environment Controller firmware\n"

	fetch_update sch5545ec || return 1
	extract_sch5545ec || return 1
}

# TODO: this code is cancer. hardcoded is bad, and stupid.
# TODO: make it *scan* (based on signature, in each file)
extract_sch5545ec()
{
	printf "Extracting SCH5545 Environment Controller firmware for '%s'\n" \
	    ${board}

	_sch5545ec_destination=${CONFIG_SMSC_SCH5545_EC_FW_FILE#../../}

	if [ -f "${_sch5545ec_destination}" ]; then
		printf 'sch5545 firmware already downloaded\n'
		return 0
	fi

	if [ -d "${appdir}" ]; then
		rm -Rf "${appdir}"
	fi
	mkdir -p "${appdir}/"

	cp "${dl_path}" "${appdir}/"
	python "${pfs_extract}" "${appdir}/${dlsum}" -e || exit 1

	# full system ROM (UEFI), to extract with UEFIExtract:
	_bios="${appdir}/${dlsum}_extracted/Firmware"
	_bios="${_bios}/1 ${dlsum} -- 1 System BIOS vA.28.bin"

	# this is the SCH5545 firmware, inside of the extracted UEFI ROM:
	_sch5545ec_fw="${_bios}.dump/4 7A9354D9-0468-444A-81CE-0BF617D890DF"
	_sch5545ec_fw="${_sch5545ec_fw}/54 D386BEB8-4B54-4E69-94F5-06091F67E0D3"
	_sch5545ec_fw="${_sch5545ec_fw}/0 Raw section/body.bin" # <-- this!

	# this makes the file defined by _sch5545ec_fw available to copy
	"${uefiextract}" "${_bios}" || exit 1

	cp "${_sch5545ec_fw}" "${_sch5545ec_destination}" || exit 1
}

fetch_update()
{
	printf "Fetching vendor update for board: %s\n" ${board}

	fw_type="${1}"
	dl=""
	dl_bkup=""
	dlsum=""
	if [ "${fw_type}" = "me" ]; then
		dl=${dl_url}
		dl_bkup=${dl_url_bkup}
		dlsum=${dl_hash}
	elif [ "${fw_type}" = "ec" ]; then
		dl=${ec_url}
		dl_bkup=${ec_url_bkup}
		dlsum=${ec_hash}
	elif [ "${fw_type}" = "e6400vga" ]; then
		dl=${e6400_vga_dl_url}
		dl_bkup=${e6400_vga_dl_url_bkup}
		dlsum=${e6400_vga_dl_hash}
	elif [ "${fw_type}" = "sch5545ec" ]; then
		dl="${sch5545ec_dl_url}"
		dl_bkup="${sch5545ec_dl_url_bkup}"
		dlsum="${sch5545ec_dl_hash}"
	else
		printf "Unsupported download type: %s\n" ${fw_type}
		return 1
	fi

	if [ -z "${dl_url+x}" ] && [ "${fw_type}" != "e6400vga" ]; then
		printf "No vendor update specified for board: %s\n" ${board}
		return 1
	fi

	dl_path=${blobdir}/cache/${dlsum}
	mkdir -p ${blobdir}/cache

	dl_fail="y"
	vendor_checksum ${dlsum} && dl_fail="n"
	for x in "${dl}" "${dl_bkup}"; do
		if [ "${dl_fail}" = "n" ]; then
			break
		fi
		rm -f "${dl_path}"
		wget -U "${agent}" ${x} -O ${dl_path}
		vendor_checksum ${dlsum} && dl_fail="n"
	done
	if [ "${dl_fail}" = "y" ]; then
		printf "Could not download blob file\n" 1>&2
		return 1
	fi
}

vendor_checksum()
{
	if [ ! -f "${dl_path}" ]; then
		printf "Vendor update not found on disk for: %s\n" ${board}
		return 1
	elif [ "$(sha1sum ${dl_path} | awk '{print $1}')" != "${1}" ]; then
		printf "Bad checksum on vendor update for: %s\n" ${board}
		return 1
	fi
}

fail()
{
	printf "\nERROR: $@\n"
	exit 1
}

main $@