summaryrefslogtreecommitdiff
path: root/script/build/release/roms
blob: 1d6bcb76d80ffe423d2cc83947591f731df6d939 (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
#!/usr/bin/env sh

#  helper script: generate release archive (ROM images)
#
#	Copyright (C) 2020,2021,2022,2023 Leah Rowe <info@minifree.org>
#
#	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

. "include/err.sh"

read projectname < projectname
version="version-unknown"
versiondate="version-date-unknown"
tree="default"
target=""
CONFIG_HAVE_MRC=""
CONFIG_HAVE_ME_BIN=""
CONFIG_KBC1126_FIRMWARE=""
CONFIG_INCLUDE_SMSC_SCH5545_EC_FW=""
ifdtool="cbutils/${tree}/ifdtool"
cbfstool="cbutils/${tree}/cbfstool"
microcode_required="y"

main()
{
	printf "Building ROM image archives for version %s\n" "${version}"

	init_check

	for romdir in bin/*; do
		[ -d "${romdir}" ] || continue
		make_archive "${romdir}"
	done

	printf "\nROM archives available at release/%s/roms/\n\n" "${version}"
}

init_check()
{
	[ -f version ] && \
		read version < version
	[ -f versiondate ] && \
		read versiondate < versiondate
	[ ! -d "bin/" ] && \
		err "init_check: no ROMs built yet (error)"
	[ -d "release/" ] || \
		mkdir -p release/ || \
		    err "init_check: !mkdir -p release/"
	[ -d "release/${version}/" ] || \
		mkdir -p "release/${version}/" || \
		    err "init_check: !mkdir -p release/${version}/"
	[ ! -d "release/${version}/roms/" ] || \
		rm -Rf "release/${version}/roms/" || \
		    err "init_check: !rm -Rf release/${version}/roms/"

	if [ ! -d "release/${version}/roms/" ]; then
		mkdir -p "release/${version}/roms/" || \
		    err "init_check: !mkdir -p release/${version}/roms/"
	fi
}

make_archive()
{
	builddir="${1}"
	romdir="$(mktemp -d -t coreboot_rom.XXXXXXXXXX)" || \
	    err "make_archive: cannot create tmpdir"
	rm -Rf "${romdir}" || err "make_archive: can't remove tmpdir"
	target="${builddir##*/}"
	romdir="${romdir}/bin/${target}"
	mkdir -p "${romdir}" || \
	    err "make_archive: can't mkdir tmpdir"
	cp "${builddir}"/* "${romdir}" || \
	    err "make_archive: cannot copy ROM images directory -> ${romdir}"

	echo ${target}

	[ -f "resources/coreboot/${target}/target.cfg" ] || \
		err "make_archive: ${target}: target.cfg is missing"

	. "resources/coreboot/${target}/target.cfg"
	[ "${microcode_required}" = "y" ] || \
	    [ "${microcode_required}" = "n" ] || microcode_required="y"

	CONFIG_HAVE_MRC="y"
	CONFIG_HAVE_ME_BIN="y"
	CONFIG_KBC1126_FIRMWARE="y"
	CONFIG_INCLUDE_SMSC_SCH5545_EC_FW="y"
	grep "CONFIG_HAVE_ME_BIN=y" "resources/coreboot/${target}/config/"* || \
	    CONFIG_HAVE_ME_BIN="n"
	grep "CONFIG_HAVE_MRC=y" "resources/coreboot/${target}/config/"* || \
	    CONFIG_HAVE_MRC="n"
	grep "CONFIG_KBC1126_FIRMWARE=y" \
	    "resources/coreboot/${target}/config"/* || \
	    CONFIG_KBC1126_FIRMWARE="n"
	grep "CONFIG_INCLUDE_SMSC_SCH5545_EC_FW=y" \
	    "resources/coreboot/${target}/config"/* || \
	    CONFIG_INCLUDE_SMSC_SCH5545_EC_FW="n"

	# remove ME/MRC/EC firmware from ROM images
	if [ "${CONFIG_HAVE_ME_BIN}" = "y" ] || \
	    [ "${target}" = "e6400_4mb" ] || \
	    [ "${microcode_required}" = "n" ]; then
		strip_archive "${romdir}"
	fi

	printf "Generating release/%s/roms/%s-%s_%s.tar.xz\n" \
	    "${version}" "${projectname}" "${version}" "${target##*/}"
	printf "%s\n" "${version}" > "${romdir}/version" || \
	    err "make_archive: can't create ${romdir}/version"
	printf "%s\n" "${versiondate}" > "${romdir}/versiondate" || \
	    err "make_archive: can't create ${romdir}/versiondate"
	printf "%s\n" "${projectname}" > "${romdir}/projectname" || \
	    err "make_archive: can't create ${romdir}/projectname"

	archivename="${projectname}-${version}_${target##*/}"
	f="release/${version}/roms/${archivename}"
	(
	cd "${romdir%/bin/${target}}" || err "make_archive: can't cd to tmpdir"
	tar -c "bin/${target}/" | xz -T0 -9e > "${archivename}.tar.xz" || \
	    err "make_archive:cant make ${projectname}-${version}_${target##*/}"
	)
	cp "${romdir%/bin/${target}}/${archivename}.tar.xz" "${f}.tar.xz" || \
	    err "make_archive: can't copy tarball"
	rm -Rf "${romdir%/bin/${target}}" || \
	    err "make_archive: can't delete tmpdir"
}

strip_archive()
{
	romdir=${1}

	[ -d "coreboot/${tree}" ] || \
		./update project trees coreboot ${tree} || \
		    err "strip_archive: coreboot/${tree}: can't fetch source"
	./build coreboot utils ${tree} || \
	    err "strip_archive: coreboot/${tree}: can't build utils"

	if [ "${microcode_required}" = "n" ]; then
		for romfile in "${romdir}"/*.rom; do
			[ -f "${romfile}" ] || continue
			strip_ucode "${romfile}"
		done
		for romfile in "${romdir}"/*.tmprom; do
			[ -f "${romfile}" ] || continue
			mv "${romfile}" "${romfile%.tmprom}.rom" || \
			    err "can't make no-u rom: ${romfile%.tmprom}.rom"
		done
	fi

	# Hash the rom before removing blobs
	rm -f "${romdir}/blobhashes" || \
	    err "strip_archive: !rm -f ${blobdir}/blobhashes"
	touch "${romdir}/blobhashes" || \
	    err "strip_archive: !touch ${blobdir}/blobhashes"

	(
	cd "${romdir}" || err "strip_archive: !cd ${romdir}"
	sha1sum *.rom >> blobhashes || \
	    err "strip_archive: ${romdir}: !sha1sum *.rom >> blobhashes"
	)

	for romfile in "${romdir}"/*.rom; do
		[ -f "${romfile}" ] || continue
		strip_rom_image "${romfile}"
	done
}

strip_ucode()
{
	romfile=${1}

	_newrom_b="${romfile%.rom}_nomicrocode.tmprom"
	cp "${romfile}" "${_newrom_b}" || \
	    err "strip_rom_image: cp \"${romfile}\" \"${_newrom_b}\""
	microcode_present="y"
	"${cbfstool}" "${_newrom_b}" remove -n \
	    cpu_microcode_blob.bin 2>/dev/null || microcode_present="n"
	if [ "${microcode_present}" = "n" ]; then
		printf "REMARK: '%s' already lacks microcode\n" \
		    "${romfile}"
		printf "Renaming default ROM file instead.\n"
		mv "${romfile}" "${_newrom_b}" || \
		    err "strip_rom_image: can't rename no-u ${romfile}"
	fi
}

strip_rom_image()
{
	romfile=${1}

	[ -f "${romfile}" ] || return 0

	if [ "${CONFIG_HAVE_ME_BIN}" = "y" ]; then
		"${ifdtool}" --nuke me "${romfile}" -O "${romfile}" || \
		    err "strip_rom_images: ${romfile}: cannot nuke Intel ME"
	fi

	if [ "${CONFIG_HAVE_MRC}" = "y" ]; then
		"${cbfstool}" "${romfile}" remove -n mrc.bin || \
		    err "strip_rom_images: ${romfile}: cannot nuke mrc.bin"
		"${cbfstool}" "${romfile}" print || :
	fi

	if [ "${CONFIG_KBC1126_FIRMWARE}" = "y" ]; then
		"${cbfstool}" "${romfile}" remove -n ecfw1.bin || \
		    err "strip_rom_images: ${romfile}: can't nuke ecfw1.bin"
		"${cbfstool}" "${romfile}" remove -n ecfw2.bin || \
		    err "strip_rom_images: ${romfile}: can't nuke ecfw2.bin"
	fi

	[ "${CONFIG_INCLUDE_SMSC_SCH5545_EC_FW}" != "y" ] || \
		"${cbfstool}" "${romfile}" remove -n sch5545_ecfw.bin || \
		    err "strip_rom_images: ${romfile}: can't nuke sch5545ec fw"

	# TODO: replace this board-specific hack
	if [ "${target}" = "e6400_4mb" ]; then
		"${cbfstool}" "${romfile}" remove -n "pci10de,06eb.rom" || \
		    err "strip_rom_images: ${romfile}: can't nuke e6400 vga rom"
	fi
}

main $@