summaryrefslogtreecommitdiff
path: root/script/build/release/roms
blob: 026f4eaed693646e5409633b4537b5ff521c4df7 (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
#!/usr/bin/env sh
# SPDX-License-Identifier: GPL-3.0-or-later
# SPDX-FileCopyrightText: 2020,2021,2022,2023 Leah Rowe <leah@libreboot.org>

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

. "include/err.sh"

read projectname < projectname
version="version-unknown"
versiondate="version-date-unknown"
tree="default"
eval "$(setvars "" 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/"
	[ -d "release/${version}/roms/" ] && return 0
	mkdir -p "release/${version}/roms/" || \
	    err "init_check: !mkdir -p release/${version}/roms/"
}

make_archive()
{
	builddir="${1}"
	romdir="tmp/romdir" || \
	    err "make_archive: cannot create tmpdir"
	rm -Rf "${romdir}" || err "make_archive: can't remove tmpdir"
	target="${builddir##*/}"

	if [ ! -f "config/coreboot/${target}/target.cfg" ]; then
		# No config, just make a tarball
		tarball=release/${version}/roms/${target}_${version}.tar.xz
		tar -c "${builddir}" | xz -T0 -6 > ${tarball} || \
			(rm ${tarball}
			 err "make_archive: cannot make \"${tarball}\"")
		return 0
	fi

	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}"

	printf "%s\n" "${target}"

	microcode_required="y"
	. "config/coreboot/${target}/target.cfg"
	if [ "${microcode_required}" != "y" ] && \
	    [ "${microcode_required}" != "n" ]; then microcode_required="y"; fi

	for x in CONFIG_HAVE_MRC CONFIG_HAVE_ME_BIN CONFIG_KBC1126_FIRMWARE \
	    CONFIG_INCLUDE_SMSC_SCH5545_EC_FW; do
		eval "${x}=\"y\""
		grep "${x}=y" "config/coreboot/${target}/config/"* || \
		    eval "${x}=\"n\""
	done

	# 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##*/}"
	)
	mv "${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}"
	sha512sum *.rom >> blobhashes || \
	    err "strip_archive: ${romdir}: !sha512sum *.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"
	[ "${microcode_present}" = "n" ] || return 0
	printf "REMARK: '%s' already lacks microcode\n" "${romfile}" 1>&2
	printf "Renaming default ROM file instead.\n" 1>&2
	mv "${romfile}" "${_newrom_b}" || \
	    err "strip_rom_image: can't rename no-u ${romfile}"
}

strip_rom_image()
{
	[ -f "${1}" ] || return 0
	[ "${CONFIG_HAVE_ME_BIN}" != "y" ] || \
		"${ifdtool}" --nuke me "${1}" -O "${1}" || \
		    err "strip_rom_images: ${1}: cannot nuke Intel ME"
	[ "${CONFIG_HAVE_MRC}" != "y" ] || \
		"${cbfstool}" "${1}" remove -n mrc.bin || \
		    err "strip_rom_images: ${1}: cannot nuke mrc.bin"
	[ "${CONFIG_INCLUDE_SMSC_SCH5545_EC_FW}" != "y" ] || \
		"${cbfstool}" "${1}" remove -n sch5545_ecfw.bin || \
		    err "strip_rom_images: ${1}: can't nuke sch5545ec fw"
	if [ "${CONFIG_KBC1126_FIRMWARE}" = "y" ]; then
		"${cbfstool}" "${1}" remove -n ecfw1.bin || \
		    err "strip_rom_images: ${1}: can't nuke ecfw1.bin"
		"${cbfstool}" "${1}" remove -n ecfw2.bin || \
		    err "strip_rom_images: ${1}: can't nuke ecfw2.bin"
	fi
	# TODO: replace this board-specific hack
	[ "${target}" = "e6400_4mb" ] || return 0
	"${cbfstool}" "${1}" remove -n "pci10de,06eb.rom" || \
	    err "strip_rom_images: ${1}: can't nuke e6400 vga rom"
}

main $@