From 112003a55671ffa5285145280988dc1248b26b08 Mon Sep 17 00:00:00 2001 From: Paul Kocialkowski Date: Fri, 23 Dec 2016 14:20:24 +0100 Subject: Paper build system initial import into Libreboot This is the initial import of the Paper build system into Libreboot. It was written as a flexible and painless replacement for the Libreboot build system, allowing to support many different configurations. It currently only supports the following CrOS devices: * Chromebook 13 CB5-311 (nyan big) * Chromebook 14 (nyan blaze) * Chromebook 11 (HiSense) (veyron jerry) * Chromebit CS10 (veyron mickey) * Chromebook Flip C100PA (veyron minnie) * Chromebook C201PA (veyron speedy) The build system also supports building various tools and provides various scripts to ease the installation on CrOS devices. Signed-off-by: Paul Kocialkowski --- projects/cros-scripts/cros-scripts | 36 +++ projects/cros-scripts/install/cros-kernel-prepare | 155 +++++++++++ projects/cros-scripts/install/cros-medium-setup | 313 ++++++++++++++++++++++ projects/cros-scripts/install/install | 2 + 4 files changed, 506 insertions(+) create mode 100755 projects/cros-scripts/cros-scripts create mode 100755 projects/cros-scripts/install/cros-kernel-prepare create mode 100755 projects/cros-scripts/install/cros-medium-setup create mode 100644 projects/cros-scripts/install/install (limited to 'projects/cros-scripts') diff --git a/projects/cros-scripts/cros-scripts b/projects/cros-scripts/cros-scripts new file mode 100755 index 00000000..4e3bb459 --- /dev/null +++ b/projects/cros-scripts/cros-scripts @@ -0,0 +1,36 @@ +#!/bin/bash + +# Copyright (C) 2016 Paul Kocialkowski +# +# 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 . + +install() { + project_install "$project" +} + +install_check() { + project_install_check "$project" +} + +release() { + project_release_install_archive "$project" "$TOOLS" +} + +release_check() { + project_release_install_archive_check "$project" "$TOOLS" +} + +clean() { + project_clean "$project" +} diff --git a/projects/cros-scripts/install/cros-kernel-prepare b/projects/cros-scripts/install/cros-kernel-prepare new file mode 100755 index 00000000..9a50b0df --- /dev/null +++ b/projects/cros-scripts/install/cros-kernel-prepare @@ -0,0 +1,155 @@ +#!/bin/bash + +# Copyright (C) 2016 Paul Kocialkowski +# +# 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 . + +ARCH="arch" +CMDLINE="cmdline" +BOOTLOADER="bootloader" +KERNEL_ITS="kernel.its" +KERNEL_FIT="kernel.fit" +KERNEL_IMAGE="kernel.img" + +usage() { + printf "$executable [action] [kernel files|kernel image] [medium]\n" >&2 + + printf "\nActions:\n" >&2 + printf " pack - Pack kernel files to a medium-specific image\n" >&2 + printf " sign - Sign kernel image\n" >&2 + printf " verify - Very kernel image signatures\n" >&2 + + printf "\nMedium:\n" >&2 + printf " usb - External USB storage\n" >&2 + printf " mmc - External SD card storage\n" >&2 + printf " emmc - Internal storage\n" >&2 + + printf "\nEnvironment variables:\n" >&2 + printf " VBOOT_KEYS_PATH - Path to the vboot keys\n" >&2 + printf " VBOOT_TOOLS_PATH - Path to vboot tools\n" >&2 +} + +pack() { + local kernel_files_path=$1 + local medium=$2 + + local arch_path="$kernel_files_path/$ARCH" + local arch=$( cat "$arch_path" ) + local cmdline_path="$kernel_files_path/$CMDLINE-$medium" + local bootloader_path="$kernel_files_path/$BOOTLOADER" + local kernel_its_path="$kernel_files_path/$KERNEL_ITS" + local kernel_fit_path="$kernel_files_path/$KERNEL_FIT" + local kernel_image_path="$kernel_files_path/$KERNEL_IMAGE" + + mkimage -f "$kernel_its_path" "$kernel_fit_path" + futility vbutil_kernel --pack "$kernel_image_path" --version 1 --arch "$arch" --keyblock "$VBOOT_KEYS_PATH/kernel.keyblock" --signprivate "$VBOOT_KEYS_PATH/kernel_data_key.vbprivk" --config "$cmdline_path" --vmlinuz "$kernel_fit_path" --bootloader "$bootloader_path" + + printf "\nPacked kernel image $kernel_image_path\n" +} + +sign() { + local kernel_image_path=$1 + + futility vbutil_kernel --repack "$kernel_image_path" --version 1 --keyblock "$VBOOT_KEYS_PATH/kernel.keyblock" --signprivate "$VBOOT_KEYS_PATH/kernel_data_key.vbprivk" --oldblob "$kernel_image_path" + + printf "\nSigned kernel image $kernel_image_path\n" +} + +verify() { + local kernel_image_path=$1 + + futility vbutil_kernel --verify "$kernel_image_path" --signpubkey "$VBOOT_KEYS_PATH/kernel_subkey.vbpubk" + + printf "\nVerified kernel image $kernel_image_path\n" +} + +requirements() { + local requirement + local requirement_path + + for requirement in "$@" + do + requirement_path=$( which "$requirement" || true ) + + if [ -z "$requirement_path" ] + then + printf "Missing requirement: $requirement\n" >&2 + exit 1 + fi + done +} + +setup() { + root=$( realpath "$( dirname "$0" )" ) + executable=$( basename "$0" ) + + if ! [ -z "$VBOOT_TOOLS_PATH" ] + then + PATH="$PATH:$VBOOT_TOOLS_PATH" + fi + + if [ -z "$VBOOT_KEYS_PATH" ] + then + if ! [ -z "$VBOOT_TOOLS_PATH" ] && [ -d "$VBOOT_TOOLS_PATH/devkeys" ] + then + VBOOT_KEYS_PATH="$VBOOT_TOOLS_PATH/devkeys" + else + VBOOT_KEYS_PATH="/usr/share/vboot/devkeys" + fi + fi +} + +cros_media_setup() { + local action=$1 + local kernel_files_path=$2 + local kernel_image_path=$2 + local medium=$3 + + set -e + + setup "$@" + + if [ -z "$action" ] || [ -z "$kernel_files_path" ] || [ -z "$kernel_image_path" ] + then + usage + exit 1 + fi + + case $action in + "pack") + if [ -z "$medium" ] + then + usage + exit 1 + fi + + requirements "mkimage" "futility" + pack "$kernel_files_path" "$medium" + ;; + "sign") + requirements "futility" + sign "$kernel_image_path" + ;; + "verify") + requirements "futility" + verify "$kernel_image_path" + ;; + *) + usage + exit 1 + ;; + esac +} + +cros_media_setup "$@" diff --git a/projects/cros-scripts/install/cros-medium-setup b/projects/cros-scripts/install/cros-medium-setup new file mode 100755 index 00000000..1f8c956b --- /dev/null +++ b/projects/cros-scripts/install/cros-medium-setup @@ -0,0 +1,313 @@ +#!/bin/bash + +# Copyright (C) 2016 Paul Kocialkowski +# +# 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 . + +SYS_BLOCK_PATH="/sys/class/block" +DEV_PATH="/dev" +DEVICE="device" +VENDOR="vendor" +MODEL="model" +NAME="name" +KERNEL_IMAGE="kernel.img" +KERNEL_MODULES="modules/lib" +KERNEL_PARTITION_INDEX=1 +ROOTFS_PARTITION_INDEX=2 + +# Size in blocks (512 kiB) +GPT_SIZE=34 +KERNEL_SIZE=16384 + +usage() { + printf "$executable [action] [storage] [rootfs tarball|kernel files]\n" >&2 + + printf "\nActions:\n" >&2 + printf " partitions - Setup partitions on storage\n" >&2 + printf " rootfs - Install rootfs tarball to storage\n" >&2 + printf " kernel - Install kernel files to storage\n" >&2 + + usage_storage + + printf "\nEnvironment variables:\n" >&2 + printf " KERNEL_PATH - Path to the kernel image\n" >&2 + printf " VBOOT_TOOLS_PATH - Path to vboot tools\n" >&2 +} + +usage_storage() { + printf "\nStorage:\n" >&2 + + local nodes=$( ls "$SYS_BLOCK_PATH" ) + local node_path + local name + + for node in $nodes + do + node_path="$DEV_PATH/$node" + if ! [ -b "$node_path" ] + then + continue + fi + + name=$( storage_name "$node_path" ) + if [ -z "$name" ] + then + continue + fi + + printf " $node_path - $name\n" >&2 + done +} + +storage_affect_confirm() { + local storage_path=$1 + + local name=$( storage_name "$storage_path" ) + local confirm + + printf "This is going to affect the following storage:\n" + printf " $storage_path - $name\n" + printf "Press enter to confirm: " + + read confirm +} + +storage_name() { + local storage_path=$1 + + local node=$( basename "$storage_path" ) + local vendor_path="$SYS_BLOCK_PATH/$node/$DEVICE/$VENDOR" + local model_path="$SYS_BLOCK_PATH/$node/$DEVICE/$MODEL" + local name_path="$SYS_BLOCK_PATH/$node/$DEVICE/$NAME" + local vendor + local name + + if [ -f "$model_path" ] + then + name=$( cat "$model_path" ) + elif [ -f "$name_path" ] + then + name=$( cat "$name_path" ) + else + return 0 + fi + + name=$( echo "$name" | sed -e "s/^[[:space:]]*//;s/[[:space:]]*$//" ) + + if [ -f "$vendor_path" ] + then + vendor=$( cat "$vendor_path" ) + vendor=$( echo "$vendor" | sed -e "s/^[[:space:]]*//;s/[[:space:]]*$//" ) + + name="$vendor $name" + fi + + echo "$name" +} + +storage_partition_path() { + local storage_path=$1 + local index=$2 + + storage_partition_path="$storage_path$index" + + if ! [ -b "$storage_partition_path" ] + then + storage_partition_path="$storage_path""p$index" + fi + + if ! [ -b "$storage_partition_path" ] + then + return 1 + fi + + echo "$storage_partition_path" +} + +storage_partition_mount_path() { + local storage_partition_path=$1 + + local storage_partition_mount_path=$( udisksctl info -b "$storage_partition_path" | grep "MountPoints" | sed "s/.*MountPoints:[[:space:]]*\(.*\)/\1/g" ) + + echo "$storage_partition_mount_path" +} + +partitions() { + local storage_path=$1 + + local storage_rootfs_path + local partitions + local start + + storage_affect_confirm "$storage_path" + + partitions=$( mount | grep -P "^$storage_path" | sed "s/^\([^[:space:]]*\).*/\1/g" ) + + for partition in $partitions + do + # Partition may already be unmounted. + udisksctl unmount -b "$partition" || true + done + + ( echo "g" ; echo "w" ) | fdisk "$storage_path" + + cgpt create "$storage_path" + + start=$GPT_SIZE + size=$KERNEL_SIZE + cgpt add -b "$start" -s "$size" -P 1 -S 1 -t kernel -l kernel "$storage_path" + + start=$(( $start + $size )) + size=$( cgpt show "$storage_path" | grep "Sec GPT table" | sed "s/[[:space:]]*\([0-9]*\).*/\1/g" ) + size=$(( $size - $start )) + cgpt add -b "$start" -s "$size" -t rootfs -l rootfs "$storage_path" + + blockdev --rereadpt "$storage_path" || partprobe "$storage_path" + + storage_rootfs_path=$( storage_partition_path "$storage_path" "$ROOTFS_PARTITION_INDEX" ) + + mkfs.ext4 -F "$storage_rootfs_path" + + printf "\nSetup partitions on storage $storage_path\n" +} + +rootfs() { + local storage_path=$1 + local rootfs_tarball_path=$2 + + local storage_rootfs_path=$( storage_partition_path "$storage_path" "$ROOTFS_PARTITION_INDEX" ) + local storage_rootfs_mount_path + + storage_affect_confirm "$storage_path" + + # Partition may already be mounted. + udisksctl mount -b "$storage_rootfs_path" || true + + storage_rootfs_mount_path=$( storage_partition_mount_path "$storage_rootfs_path" ) + + tar -xf "$rootfs_tarball_path" -ps -C "$storage_rootfs_mount_path" + + udisksctl unmount -b "$storage_rootfs_path" + + printf "\nInstalled rootfs on storage $storage_path\n" +} + +kernel() { + local storage_path=$1 + local kernel_files_path=$2 + + local storage_kernel_path=$( storage_partition_path "$storage_path" "$KERNEL_PARTITION_INDEX" ) + local storage_rootfs_path=$( storage_partition_path "$storage_path" "$ROOTFS_PARTITION_INDEX" ) + local kernel_image_path="$kernel_files_path/$KERNEL_IMAGE" + local kernel_modules_path="$kernel_files_path/$KERNEL_MODULES" + local storage_rootfs_mount_path + + storage_affect_confirm "$storage_path" + + cat "$kernel_image_path" > "$storage_kernel_path" + sync + + # Partition may already be mounted. + udisksctl mount -b "$storage_rootfs_path" || true + + storage_rootfs_mount_path=$( storage_partition_mount_path "$storage_rootfs_path" ) + + rsync -a --keep-dirlinks "$kernel_modules_path" "$storage_rootfs_mount_path/" + sync + + udisksctl unmount -b "$storage_rootfs_path" + + printf "\nInstalled kernel on storage $storage_path\n" +} + +requirements() { + local requirement + local requirement_path + + for requirement in "$@" + do + requirement_path=$( which "$requirement" || true ) + + if [ -z "$requirement_path" ] + then + printf "Missing requirement: $requirement\n" >&2 + exit 1 + fi + done +} + +setup() { + root=$( realpath "$( dirname "$0" )" ) + executable=$( basename "$0" ) + + if [ -z "$KERNEL_PATH" ] + then + KERNEL_PATH=$root + fi + + if ! [ -z "$VBOOT_TOOLS_PATH" ] + then + PATH="$PATH:$VBOOT_TOOLS_PATH" + fi +} + +cros_medium_setup() { + local action=$1 + local storage_path=$2 + local rootfs_tarball_path=$3 + local kernel_files_path=$3 + + set -e + + setup "$@" + + if [ -z "$action" ] || [ -z "$storage_path" ] + then + usage + exit 1 + fi + + case $action in + "partitions") + requirements "udisksctl" "fdisk" "cgpt" "mkfs.ext4" + partitions "$storage_path" + ;; + "rootfs") + if [ -z "$rootfs_tarball_path" ] + then + usage + exit 1 + fi + + requirements "udisksctl" "tar" + rootfs "$storage_path" "$rootfs_tarball_path" + ;; + "kernel") + if [ -z "$kernel_files_path" ] + then + usage + exit 1 + fi + + requirements "udisksctl" "rsync" + kernel "$storage_path" "$kernel_files_path" + ;; + *) + usage + exit 1 + ;; + esac +} + +cros_medium_setup "$@" diff --git a/projects/cros-scripts/install/install b/projects/cros-scripts/install/install new file mode 100644 index 00000000..21c4061e --- /dev/null +++ b/projects/cros-scripts/install/install @@ -0,0 +1,2 @@ +cros-kernel-prepare:cros-kernel-prepare +cros-medium-setup:cros-medium-setup -- cgit v1.2.3-70-g09d2