util: Add scripts to download and extract blobs

This turned out really handy when I tried to build coreboot
for my Chromebox.

These scripts can be used to extract System Agent reference code
and other blobs (e.g. mrc.bin, refcode, VGA option roms) from a
Chrome OS recovery image.

crosfirmware.sh downloads a Chrome OS recovery image from the recovery
image server, unpacks it, extracts the firmware update shell archive,
extracts the firmware images from the shell archive.

To download all Chrome OS firmware images, run
$ ./crosfirmware.sh

To download, e.g. the Panther firmware image, run
$ ./crosfirmware.sh panther

extract_blobs.sh extracts the blobs from a Chrome OS firmware image.

Right now it will produce the ME firmware blob, IFD, VGA option rom,
and mrc.bin

Change-Id: I5fb7e14b10e03e18cd360bc35f1dc92e8ed34e63
Signed-off-by: Joe Pillow <joseph.a.pillow@gmail.com>
Reviewed-on: https://review.coreboot.org/13752
Tested-by: build bot (Jenkins)
Reviewed-by: Martin Roth <martinroth@google.com>
This commit is contained in:
Joe Pillow 2016-02-19 15:18:14 -08:00 committed by Stefan Reinauer
parent 09f2921b5d
commit 9a4881a783
3 changed files with 218 additions and 0 deletions

27
util/chromeos/README.md Normal file
View File

@ -0,0 +1,27 @@
Chrome OS binary extraction
===========================
These scripts can be used to extract System Agent reference code
and other blobs (e.g. mrc.bin, refcode, VGA option roms) from a
Chrome OS recovery image.
crosfirmware.sh
---------------
crosfirmware.sh downloads a Chrome OS recovery image from the recovery
image server, unpacks it, extracts the firmware update shell archive,
extracts the firmware images from the shell archive.
To download all Chrome OS firmware images, run
$ ./crosfirmware.sh
To download, e.g. the Panther firmware image, run
$ ./crosfirmware.sh panther
extract_blobs.sh
----------------
extract_blobs.sh extracts the blobs from a Chrome OS firmware image.
Right now it will produce the ME firmware blob, IFD, VGA option rom,
and mrc.bin

View File

@ -0,0 +1,140 @@
#!/bin/bash -x
#
# This file is part of the coreboot project.
#
# Copyright (C) 2016 Joe Pillow
#
# 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; version 2 of the License.
#
# 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.
#
# This script needs
# * sharutils
#DEBUG=1
debug()
{
test "$DEBUG" == "1" && echo "$*"
}
get_inventory()
{
_conf=$1
_url=https://dl.google.com/dl/edgedl/chromeos/recovery/recovery.conf
debug "Downloading recovery image inventory..."
curl -s "$_url" > $_conf
}
download_image()
{
_url=$1
_file=$2
debug "Downloading recovery image"
curl -s "$_url" > "$_file.zip"
debug "Decompressing recovery image"
unzip -q "$_file.zip"
rm "$_file.zip"
}
extract_partition()
{
NAME=$1
FILE=$2
ROOTFS=$3
_bs=1024
debug "Extracting ROOT-A partition"
ROOTP=$( printf "unit\nB\nprint\nquit\n" | parted $FILE | grep $NAME )
START=$(( $( echo $ROOTP | cut -f2 -d\ | tr -d "B" ) ))
SIZE=$(( $( echo $ROOTP | cut -f4 -d\ | tr -d "B" ) ))
dd if=$FILE of=$ROOTFS bs=$_bs skip=$(( $START / $_bs )) \
count=$(( $SIZE / $_bs )) > /dev/null 2>&1
}
extract_shellball()
{
ROOTFS=$1
SHELLBALL=$2
debug "Extracting chromeos-firmwareupdate"
printf "cd /usr/sbin\ndump chromeos-firmwareupdate $SHELLBALL\nquit" | \
debugfs $ROOTFS > /dev/null 2>&1
}
extract_coreboot()
{
_shellball=$1
_unpacked=$( mktemp -d )
debug "Extracting coreboot image"
sh $_shellball --sb_extract $_unpacked > /dev/null
_version=$( cat $_unpacked/VERSION | grep BIOS\ version: | \
cut -f2 -d: | tr -d \ )
cp $_unpacked/bios.bin coreboot-$_version.bin
rm -r "$_unpacked"
}
do_one_board()
{
_board=$1
_url=$2
_file=$3
download_image $_url $_file
extract_partition ROOT-A $_file root-a.ext2
extract_shellball root-a.ext2 chromeos-firmwareupdate-$_board
rm $_file root-a.ext2
extract_coreboot chromeos-firmwareupdate-$_board
}
#
# Main
#
BOARD=$1
if [ "$BOARD" == "all" ]; then
CONF=$( mktemp )
get_inventory $CONF
grep ^name= $CONF| while read _line; do
name=$( echo $_line | cut -f2 -d= )
echo Processing board $name
eval $( grep -v hwid= $CONF | grep -A11 "$_line" | \
grep '\(url=\|file=\)' )
BOARD=$( echo $url | cut -f3 -d_ )
do_one_board $BOARD $url $file
done
rm "$CONF"
elif [ "$BOARD" != "" ]; then
CONF=$( mktemp )
get_inventory $CONF
echo Processing board $BOARD
eval $( grep $BOARD $CONF | grep '\(url=\|file=\)' )
do_one_board $BOARD $url $file
rm "$CONF"
else
echo "Usage: $0 <boardname>"
echo " $0 all"
echo
exit 1
fi

View File

@ -0,0 +1,51 @@
#!/bin/bash -x
#
# This file is part of the coreboot project.
#
# Copyright (C) 2016 Joe Pillow
#
# 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; version 2 of the License.
#
# 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.
#
IMAGE=$1
if [ ! -r "$IMAGE" ]; then
echo "Can't find image $IMAGE."
exit 1
fi
CBFSTOOL=$(which cbfstool)
if [ $? != 0 ]; then
echo "Can't find cbfstool."
exit 1
fi
IFDTOOL=$(which ifdtool)
if [ $? != 0 ]; then
echo "Can't find ifdtool."
exit 1
fi
$CBFSTOOL $IMAGE print
if [ $? -ne 0 ]; then
echo "Not a coreboot image: $IMAGE"
exit 1
fi
PCI=$($CBFSTOOL $IMAGE print|grep pci|cut -f1 -d\ )
MRC=$($CBFSTOOL $IMAGE print|grep mrc.bin|cut -f1 -d\ )
$CBFSTOOL $IMAGE extract -n $PCI -f $PCI
$CBFSTOOL $IMAGE extract -n $MRC -f $MRC
$IFDTOOL -x $IMAGE
mv flashregion_0_flashdescriptor.bin flashdescriptor.bin
mv flashregion_2_intel_me.bin me.bin
rm flashregion_*.bin