lbmk/resources/scripts/blobs/extract

#!/usr/bin/env sh
# script to automate extracting blobs from an existing vendor bios

# SPDX-FileCopyrightText: 2022 Caleb La Grange <thonkpeasant@protonmail.com>
# SPDX-FileCopyrightText: 2023 Leah Rowe <leah@libreboot.org>
# SPDX-License-Identifier: GPL-3.0-only

sname=""
board=""
vendor_rom=""

main()
{
	sname=${0}
	if [ $# -lt 2 ]; then
		Fail "Missing arguments (less than two)."
	fi

	board="${1}"
	vendor_rom="${2}"

	if [ ! -f "${vendor_rom}" ] ; then
		Print_help
		exit 1
	fi

	if [ ! -d "resources/coreboot/${board}" ]; then
		Print_help
		printf "build/roms %s: target not defined.\n" \
				"${projectname}" ${board}
		exit 1
	fi

	if [ ! -f "resources/coreboot/${board}/board.cfg" ]; then
		Print_help
		printf "build/roms %s: missing board.cfg.\n" ${board}
		exit 1
	fi

	Build_deps
	Extract_blobs
}

Build_deps(){
	if [ ! -d me_cleaner ]; then
		printf "downloading me_cleaner\n"
		./download me_cleaner || Fail 'could not download me_cleaner'
	else
		printf "me_cleaner already downloaded. Skipping.\n"
		printf "run ./download me_cleaner to manually overwrite\n"
	fi

	if [ ! -d coreboot/default ]; then
		printf "downloading coreboot\n"
		./download coreboot default \
				|| Fail "could not download coreboot"
	else
		printf "coreboot already downloaded. Skipping.\n"
		printf "run ./download coreboot to manually overwrite\n"
	fi

	if ! [ -f coreboot/default/util/ifdtool/ifdtool ]; then
		printf "building ifdtool from coreboot\n"
		make -C coreboot/default/util/ifdtool \
				|| Fail "could not build ifdtool"
	fi
}

Extract_blobs(){
	printf "extracting blobs for %s from %s\n" ${board} ${vendor_rom}

	# TODO: find a better way to know which coreboot config to source
	set -- "resources/coreboot/${board}/config/"*
	. ${1} 2>/dev/null
	. "resources/coreboot/${board}/board.cfg"

	if [ "$CONFIG_HAVE_MRC" = "y" ]; then
		printf 'haswell board detected, downloading mrc\n'
		./download mrc || Fail "could not download mrc"
	fi

	_me_destination=${CONFIG_ME_BIN_PATH#../../}
	_gbe_destination=${CONFIG_GBE_BIN_PATH#../../}
	_ifd_destination=${CONFIG_IFD_BIN_PATH#../../}

	printf "extracting clean ime and modified ifd\n"
	./me_cleaner/me_cleaner.py -D ${_ifd_destination} \
			-M ${_me_destination} ${vendor_rom} -t -r -S || \
		./resources/blobs/me7_update_parser.py
				-O ${_me_destination} ${vendor_rom} \
			|| Fail 'me_cleaner failed to extract blobs from rom'

	printf "extracting gigabit ethernet firmware"
	./coreboot/default/util/ifdtool/ifdtool -x ${vendor_rom}
	mv flashregion*gbe.bin ${_gbe_destination} \
			|| Fail 'could not extract gbe'
	
	# Cleans up other files extracted with ifdtool
	rm flashregion*.bin 2> /dev/null

	if [ -f ${_ifd_destination} ]; then
		printf "gbe, ifd, and me extracted to ${_me_destination%/*}\n"
	else
		printf "WARNING: Intel firmware descriptor could not "
		printf "be extracted with modified me\n"
	fi
}

Print_help(){
	printf "Usage: ./blobutil extract {boardname} {path/to/vendor_rom}\n"
	printf "Example: ./blobutil extract x230 12mb_flash.bin\n"
	printf "\nYou need to specify exactly 2 arguments\n"
}

Fail(){
	Print_help
	printf "\n%s: ERROR: %s\n" ${sname} $@
	exit 1 
}

main $@