summaryrefslogtreecommitdiff
path: root/resources/scripts/update/blobs/inject
blob: 696cd74db41446cc2fa6d7a4092e2a6c7bfe6a67 (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
#!/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

sname=""
archive=""
_filetype=""
rom=""
board=""
modifygbe=""
new_mac=""
release=""
releasearchive=""

cbdir="coreboot/default"
cbcfgsdir="resources/coreboot"
ifdtool="cbutils/default/ifdtool"
cbfstool="cbutils/default/cbfstool"
nvmutil="util/nvmutil/nvm"
boarddir=""
pciromsdir="pciroms"

CONFIG_HAVE_MRC=""
CONFIG_HAVE_ME_BIN=""
CONFIG_ME_BIN_PATH=""
CONFIG_KBC1126_FIRMWARE=""
CONFIG_KBC1126_FW1=""
CONFIG_KBC1126_FW1_OFFSET=""
CONFIG_KBC1126_FW2=""
CONFIG_KBC1126_FW2_OFFSET=""
CONFIG_VGA_BIOS_FILE=""
CONFIG_VGA_BIOS_ID=""
CONFIG_GBE_BIN_PATH=""
CONFIG_INCLUDE_SMSC_SCH5545_EC_FW=""
CONFIG_SMSC_SCH5545_EC_FW_FILE=""

main()
{
	sname="${0}"

	[ $# -lt 1 ] && fail "No options specified."
	[ "${1}" = "listboards" ] && listboards && exit 0

	archive="${1}"

	while getopts r:b:m: option
	do
		case "${option}" in
		r)
			rom=${OPTARG} ;;
		b)
			board=${OPTARG} ;;
		m)
			modifygbe=true
			new_mac=${OPTARG} ;;
		esac
	done

	check_board
	build_dependencies
	inject_blobs

	printf "Friendly reminder (this is *not* an error message):\n"
	printf "Please always ensure that the files were inserted correctly.\n"
	printf "Read https://libreboot.org/docs/install/ivy_has_common.html\n"
}

check_board()
{
	if ! check_release ${archive} ; then
		[ -f "${rom}" ] || \
			fail "${rom} is not a valid path"
		[ -z ${rom+x} ] && \
			fail 'no rom specified'
		[ ! -z ${board+x} ] || \
			board=$(detect_board ${rom}) || \
			    fail 'no board specified'
	else
		release=true
		releasearchive="${archive}"
		board=$(detect_board ${archive}) || \
		    fail 'Could not detect board type'
	fi

	boarddir="${cbcfgsdir}/${board}"
	[ -d "${boarddir}" ] || fail "board ${board} not found"
}

check_release()
{
	[ -f "${archive}" ] || return 1
	[ "${archive##*.}" = "xz" ] || return 1
	printf "%s\n" "Release archive ${archive} detected"
}

# This function tries to determine the board from the filename of the rom.
# It will only succeed if the filename is not changed from the build/download
detect_board()
{
	path=${1}
	filename=$(basename ${path})
	case ${filename} in
	grub_*)
		board=$(echo "${filename}" | cut -d '_' -f2-3) ;;
	seabios_withgrub_*)
		board=$(echo "${filename}" | cut -d '_' -f3-4) ;;
	*.tar.xz)
		_stripped_prefix=${filename#*_}
		board="${_stripped_prefix%.tar.xz}" ;;
	*)
		return 1
	esac	
	[ -d "${boarddir}/" ] || return 1
	printf '%s\n' "${board}"
}

build_dependencies()
{
	[ -d "${cbdir}" ] || ./fetch_trees coreboot default
	./build coreboot utils default || fail "could not build cbutils"
	./update blobs download ${board} || \
	    fail "Could not download blobs for ${board}"
}

inject_blobs()
{
	if [ "${release}" = "true" ]; then
		echo 'patching release file'
		patch_release_roms
	else
		patch_rom ${rom}
	fi
}

patch_release_roms()
{
	_tmpdir=$(mktemp -d "/tmp/${board}_tmpXXXX")
	tar xf "${releasearchive}" -C "${_tmpdir}" || \
	fail 'could not extract release archive'

	for x in ${_tmpdir}/bin/*/*.rom ; do
		echo "patching rom $x"
		patch_rom ${x} || fail "could not patch ${x}"
	done

	(
	cd ${_tmpdir}/bin/*
	sha1sum --status -c blobhashes || \
	fail 'ROMs did not match expected hashes'
	)

	if [ "${modifygbe}" = "true" ]; then
		for x in ${_tmpdir}/bin/*/*.rom ; do
			modify_gbe ${x}
		done
	fi

	[ -d bin/release ] || mkdir -p bin/release
	mv ${_tmpdir}/bin/* bin/release/ && \
	    printf '%s\n' 'Success! Your ROMs are in bin/release'

	rm -r "${_tmpdir}"
}

patch_rom()
{
	rom="${1}"

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

	[ "$CONFIG_HAVE_MRC" = "y" ] && \
		inject_blob_intel_mrc "${rom}"
	[ "${CONFIG_HAVE_ME_BIN}" = "y" ] && \
		inject_blob_intel_me "${rom}"
	[ "${CONFIG_KBC1126_FIRMWARE}" = "y" ] && \
		inject_blob_hp_kbc1126_ec "${rom}"
	[ "${CONFIG_VGA_BIOS_FILE}" != "" ] && \
	    [ "${CONFIG_VGA_BIOS_ID}" != "" ] && \
		inject_blob_dell_e6400_vgarom_nvidia
	[ "${CONFIG_INCLUDE_SMSC_SCH5545_EC_FW}" = "y" ] && \
	    [ "${CONFIG_SMSC_SCH5545_EC_FW_FILE}" != "" ] && \
		inject_blob_smsc_sch5545_ec "${rom}"
	[ "${modifygbe}" = "true" ] && ! [ "${release}" = "true" ] && \
		modify_gbe ${rom}
}

inject_blob_intel_mrc()
{
	rom="${1}"

	printf 'adding mrc\n'

	# mrc.bin must be inserted at a specific offset. the only
	# libreboot platform that needs it, at present, is haswell

	# in cbfstool, -b values above 0x80000000 are interpreted as
	# top-aligned x86 memory locations. this is converted into an
	# absolute offset within the flash, and inserted accordingly
	# at that offset into the ROM image file

	# coreboot's own build system hardcodes the mrc.bin offset
	# because there is only one correct location in memory, but
	# it would be useful for lbmk if it could be easily scanned
	# from Kconfig, with the option to change it where in practise
	# it is not changed

	# the hardcoded offset below is based upon reading of the coreboot
	# source code, and it is *always* correct for haswell platform.
	# TODO: this logic should be tweaked to handle more platforms

	${cbfstool} ${rom} add -f mrc/haswell/mrc.bin -n mrc.bin -t mrc \
		-b 0xfffa0000 || exit 1
}

inject_blob_intel_me()
{
	printf 'adding intel management engine\n'

	rom="${1}"
	[ -z ${CONFIG_ME_BIN_PATH} ] && \
		fail "CONFIG_ME_BIN_PATH not set"

	_me_location=${CONFIG_ME_BIN_PATH#../../}
	[ ! -f "${_me_location}" ] && \
		fail "CONFIG_ME_BIN_PATH points to missing file"

	${ifdtool} -i me:${_me_location} ${rom} -O ${rom} || exit 1
}

inject_blob_hp_kbc1126_ec()
{
	rom="${1}"

	_ec1_location="${CONFIG_KBC1126_FW1#../../}"
	_ec1_offset="${CONFIG_KBC1126_FW1_OFFSET}"
	_ec2_location="${CONFIG_KBC1126_FW2#../../}"
	_ec2_offset="${CONFIG_KBC1126_FW2_OFFSET}"

	printf "adding hp kbc1126 ec firmware\n"

	if [ "${_ec1_offset}" = "" ] || [ "${_ec1_offset}" = "" ]; then
		printf "EC offsets not declared for board: %s\n" \
		    "${board}"
		exit 1
	fi
	if [ "${_ec1_location}" = "" ] || [ "${_ec2_location}" = "" ]; then
		printf "EC firmware path not declared for board: %s\n" \
		    "${board}"
	fi
	if [ ! -f "${_ec1_location}" ] || [ ! -f "${_ec2_location}" ]; then
		printf "EC firmware not downloaded for board: %s\n" \
		    "${board}"
		exit 1
	fi

	${cbfstool} "${rom}" add -f ${_ec1_location} -n ecfw1.bin \
	    -b ${_ec1_offset} -t raw || exit 1
	${cbfstool} "${rom}" add -f ${_ec2_location} -n ecfw2.bin \
	    -b ${_ec2_offset} -t raw || exit 1
}

inject_blob_dell_e6400_vgarom_nvidia()
{
	rom="${1}"

	_vga_location="${CONFIG_VGA_BIOS_FILE#../../}"
	_vga_dir="${_vga_location%/*}"
	_vga_filename="${_vga_location##*/}"

	printf "adding pci option rom\n"

	if [ "${_vga_dir}" != "${pciromsdir}" ]; then
		printf "Invalid PCI ROM directory: %s\n" ${_vga_dir}
		exit 1
	fi
	if [ ! -f "${_vga_location}" ]; then
		printf "No such file exists: %s\n" ${_vga_location}
		exit 1
	fi

	${cbfstool} ${rom} add -f "${_vga_location}" \
	    -n "pci${CONFIG_VGA_BIOS_ID}.rom" \
	    -t optionrom || exit 1
}

inject_blob_smsc_sch5545_ec()
{
	rom="${1}"

	_sch5545ec_location="${CONFIG_SMSC_SCH5545_EC_FW_FILE#../../}"

	if [ ! -f "${_sch5545ec_location}" ]; then
		printf "SCH5545 firmware file missing\n" 1>&2
		exit 1
	fi

	"${cbfstool}" "${rom}" add -f "${_sch5545ec_location}" \
	    -n sch5545_ecfw.bin -t raw || exit 1
}

modify_gbe()
{
	printf "changing mac address in gbe to ${new_mac}\n"

	rom=${1}

	[ -z ${CONFIG_GBE_BIN_PATH} ] && \
		fail "CONFIG_GBE_BIN_PATH not set"

	_gbe_location=${CONFIG_GBE_BIN_PATH#../../}

	[ -f "${_gbe_location}" ] || \
		fail "CONFIG_GBE_BIN_PATH points to missing file"
	[ -f ${nvmutil} ] || \
		make -C util/nvmutil || fail 'failed to build nvmutil'

	_gbe_tmp=$(mktemp -t gbeXXXX.bin)
	cp ${_gbe_location} ${_gbe_tmp}
	${nvmutil} "${_gbe_tmp}" setmac ${new_mac} || \
	    fail 'failed to modify mac address'

	${ifdtool} -i GbE:${_gbe_tmp} "${rom}" -O "${rom}" || exit 1

	rm -f ${_gbe_tmp}
}

listboards()
{
	for boarddir in ${cbcfgsdir}/*; do
		[ -d "${boarddir}" ] || continue
		board="${boarddir##${cbcfgsdir}/}"
		board="${board%/}"
		printf '%s\n' "${board##*/}"
	done
}

fail()
{
	[ -z ${@+x} ] || \
		printf "\n%s: ERROR: ${@}\n" ${sname}
	usage
	exit 1
}

usage()
{
	cat <<- EOF
	USAGE: ./update blobs inject -r [rom path] -b [boardname] -m [macaddress]
	Example: ./update blobs inject -r x230_12mb.rom -b x230_12mb

	Adding a macadress to the gbe is optional.
	If the [-m] parameter is left blank, the gbe will not be touched.

	Type './update blobs inject listboards' to get a list of valid boards
	EOF
}

main $@