freedombone-image-hardware-setup

#!/bin/sh
#  _____               _           _
# |   __|___ ___ ___ _| |___ _____| |_ ___ ___ ___
# |   __|  _| -_| -_| . | . |     | . | . |   | -_|
# |__|  |_| |___|___|___|___|_|_|_|___|___|_|_|___|
#
#                              Freedom in the Cloud
#
# Hardware setup based on bin/freedombox-hardware-setup from freedom-maker
#
# Booting beaglebones from a USB drive does not work at present, due to
# missing kernel config. See:
# http://processors.wiki.ti.com/index.php/MUSB_Linux_Driver_Configuration
#
# License
# =======
#
# Copyright (C) 2015-2019 Bob Mottram <bob@freedombone.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

PROJECT_NAME='freedombone'

export TEXTDOMAIN=${PROJECT_NAME}-image-hardware-setup
export TEXTDOMAINDIR="/usr/share/locale"

INSTALL_PACKAGES='apt-get -yq install'
INSTALL_PACKAGES_BACKPORTS='apt-get -yq -t stretch-backports install'

convert_dts() {
    dts="$1"
    $INSTALL_PACKAGES device-tree-compiler
    dtc -I dts -O dtb "${dts}.dts" > "${dts}.dtb"
}

enable_serial_console() {
    # By default, spawn a console on the serial port
    device="$1"
    echo "Adding a getty on the serial port"
    echo "T0:12345:respawn:/sbin/getty -L $device 115200 vt100" >> /etc/inittab
}

arm_flash() {
    # allow flash-kernel to work without valid /proc contents
    # ** this doesn't *really* work, since there are too many checks
    #    that fail in an emulated environment!  We'll have to do it by
    #    hand below anyway...
    export FK_MACHINE="$1"
    if ! $INSTALL_PACKAGES flash-kernel; then
        echo "Unable to flash kernel for $FK_MACHINE"
        exit 64
    fi
}

arm_repack_kernel() {
    dtb="$1"
    arm_loadaddr="$2"
    arm_initrd_addr="$3"
    arm_arch="$4"
    # process installed kernel to create uImage, uInitrd, dtb
    # using flash-kernel would be a good approach, except it fails in the
    # cross build environment due to too many environment checks...
    #FK_MACHINE="TI AM335x BeagleBone" flash-kernel
    #  so, let's do it manually...

    # flash-kernel's hook-functions provided to mkinitramfs have the
    # unfortunate side-effect of creating /conf/param.conf in the initrd
    # when run from our emulated chroot environment, which means our root=
    # on the kernel command line is completely ignored!  repack the initrd
    # to remove this evil...

    echo "info: repacking $dtb kernel and initrd"

    # shellcheck disable=SC2012,SC2086
    kernelVersion=$(ls /usr/lib/*/${dtb}.dtb | head -1 | cut -d/ -f4)
    version=$(echo "$kernelVersion" | sed 's/linux-image-\(.*\)/\1/')
    initRd=initrd.img-$version
    vmlinuz=vmlinuz-$version

    # optionally use a separately compiled kernel
    dtb_file=/usr/lib/$kernelVersion/${dtb}.dtb

    mkdir /tmp/initrd-repack

    (cd /tmp/initrd-repack || exit 24 ; \
     zcat "/boot/$initRd" | cpio -i ; \
     rm -f conf/param.conf ; \
     find . | cpio --quiet -o -H newc | \
         gzip -9 > "/boot/$initRd" )

    rm -rf /tmp/initrd-repack

    (cd /boot || exit 24 ; \
     cp "${dtb_file}" dtb ; \
     cat "$vmlinuz" dtb >> temp-kernel ; \
     mkimage -A "${arm_arch}" -O linux -T kernel -n "Debian kernel ${version}" \
             -C none -a "${arm_loadaddr}" -e "${arm_loadaddr}" -d temp-kernel uImage ; \
     rm -f temp-kernel ; \
     mkimage -A "${arm_arch}" -O linux -T ramdisk -C gzip -a "${arm_initrd_addr}" -e "${arm_initrd_addr}" \
             -n "Debian ramdisk ${version}" \
             -d "$initRd" uInitrd )
}

setup_flash_kernel() {
    if [ ! -d /etc/flash-kernel ] ; then
       mkdir /etc/flash-kernel
    fi
    printf "%s" "$1" > /etc/flash-kernel/machine

    command_line=""
    if [ -n "$2" ] ; then
        command_line="console=$2"
    fi

    if [ -n "$command_line" ] ; then
        echo "flash-kernel flash-kernel/linux_cmdline string \"$command_line\"" | debconf-set-selections
    fi

    $INSTALL_PACKAGES flash-kernel
}

arm_setup_boot() {
    dtb="$1"
    arm_root_device='mmcblk0p2'
    if [ "$EXTERNAL_DRIVE" ]; then
        arm_root_device="$EXTERNAL_DRIVE"
    fi

    arm_flash_name=
    if [ "$2" ]; then
        arm_flash_name="$2"
    fi

    # Setup boot.cmd
    if grep -q btrfs /etc/fstab ; then
        fstype=btrfs
    else
        fstype=ext4
    fi

    mkdir -p /boot/dtbs

    # shellcheck disable=SC2012,SC2086
    kernelVersion=$(ls /usr/lib/*/${dtb}.dtb | head -1 | cut -d/ -f4)
    version=$(echo "$kernelVersion" | sed 's/linux-image-\(.*\)/\1/')
    initRd=initrd.img-$version
    vmlinuz=vmlinuz-$version

    arm_loadaddr='0x46000000'
    arm_initrd_addr='0x48000000'
    arm_fdtaddr='0x47000000'
    arm_boot_device="mmc \${mmcdev}:\${mmcpart}"
    arm_boot_start=
    arm_boot_console='ttyO0,115200n8'
    arm_arch=arm
    arm_uenv=
    arm_repack=

    case "$dtb" in
        "am"*) arm_loadaddr='0x82000000'
               arm_initrd_addr='0x88080000'
               arm_fdtaddr='0x88000000'
               arm_uenv=1
               arm_repack=1
               if [ "$EXTERNAL_DRIVE" ]; then
                   arm_boot_device="usb 0:1"
                   arm_loadaddr='0x80300000'
                   arm_initrd_addr='0x81600000'
                   arm_fdtaddr='0x815f0000'
                   arm_boot_start='usb start; '
               fi
               ;;
        "sun"*) arm_boot_device="mmc 0:1"
                { echo "rtc_sunxi";
                  echo "vfat"; } >> /etc/initramfs-tools/modules
                ;;
        "rk3328-rock64") arm_arch=arm64
                         cp /root/${PROJECT_NAME}/image_build/dts/rk3328-rock64.dtb /boot/dtbs
                         arm_boot_device="usb 0:1"
                         arm_loadaddr='0x80300000'
                         arm_initrd_addr='0x81600000'
                         arm_fdtaddr='0x815f0000'
                         arm_boot_start='usb start; '
                         echo "vfat" >> /etc/initramfs-tools/modules
                         ;;
    esac

    if [ $arm_uenv ]; then
        cat >> /boot/uEnv.txt <<EOF
mmcroot=/dev/${arm_root_device} ro
mmcrootfstype=$fstype rootwait fixrtc
mmcrootflags=subvol=@

console=${arm_boot_console}

kernel_file=$vmlinuz
initrd_file=$initRd

loadaddr=$arm_loadaddr
initrd_addr=$arm_initrd_addr
fdtaddr=$arm_fdtaddr

initrd_high=0xffffffff
fdt_high=0xffffffff

loadkernel=load ${arm_boot_device} \${loadaddr} \${kernel_file}
loadinitrd=load ${arm_boot_device} \${initrd_addr} \${initrd_file}; setenv initrd_size \${filesize}
loadfdt=load ${arm_boot_device} \${fdtaddr} /dtbs/\${fdtfile}

loadfiles=run loadkernel; run loadinitrd; run loadfdt
mmcargs=setenv bootargs init=/lib/systemd/systemd console=tty0 console=\${console} root=\${mmcroot} rootfstype=\${mmcrootfstype} rootflags=\${mmcrootflags} ifnames=0 slub_debug=FZP slab_nomerge page_poison=1

uenvcmd=${arm_boot_start}run loadfiles; run mmcargs; bootz \${loadaddr} \${initrd_addr}:\${initrd_size} \${fdtaddr}
EOF
        # Copy all DTBs
        cp /usr/lib/linux-image-*-armmp/* /boot/dtbs
    else
        cat >> /boot/boot.cmd <<EOF
scsi scan
setenv bootargs init=/lib/systemd/systemd console=${arm_boot_console} root=/dev/${arm_root_device} panic=10 rootflags=subvol=@ ro ${fstype} rootwait fixrtc earlyprintk ifnames=0 slub_debug=FZP slab_nomerge page_poison=1
fatload ${arm_boot_device} ${arm_fdtaddr} /dtbs/${dtb}.dtb
fatload ${arm_boot_device} ${arm_loadaddr} ${vmlinuz}
fatload ${arm_boot_device} ${arm_initrd_addr} ${initRd}
bootz ${arm_loadaddr} ${arm_initrd_addr}:\${filesize} ${arm_fdtaddr}
EOF
        # Create boot.scr
        mkimage -C none -A arm -T script -d /boot/boot.cmd /boot/boot.scr

        # shellcheck disable=SC2086
        cp /usr/lib/$kernelVersion/* /boot/dtbs
    fi

    if [ $arm_repack ]; then
        arm_flash "$arm_flash_name"
        arm_repack_kernel "${dtb}" "$arm_loadaddr" "$arm_initrd_addr" "$arm_arch"
    fi

    enable_serial_console ttyS0
}

case "$MACHINE" in
    beagleboneblack)
        arm_setup_boot am335x-boneblack "TI AM335x BeagleBone Black"
        ;;
    beaglebonegreen)
        arm_setup_boot am335x-bonegreen "TI AM335x BeagleBone Green"
        ;;
    beaglex15)
        arm_setup_boot am57xx-beagle-x15 "TI AM5728 BeagleBoard-X15"
        ;;
    cubietruck)
        arm_setup_boot sun7i-a20-cubietruck
        ;;
    a20-olinuxino-lime)
        arm_setup_boot sun7i-a20-olinuxino-lime
        ;;
    a20-olinuxino-lime2)
        arm_setup_boot sun7i-a20-olinuxino-lime2
        ;;
    a20-olinuxino-micro)
        arm_setup_boot sun7i-a20-olinuxino-micro
        ;;
    banana-pro)
        arm_setup_boot sun7i-a20-bananapro
        ;;
    cubieboard2)
        arm_setup_boot sun7i-a20-cubieboard2
        ;;
    pcduino3)
        arm_setup_boot sun7i-a20-pcduino3
        ;;
    rock64)
        if [ -f /root/${PROJECT_NAME}/image_build/dts/rk3328-rock64.dts ]; then
            convert_dts /root/${PROJECT_NAME}/image_build/dts/rk3328-rock64
            arm_setup_boot "rk3328-rock64"
        fi
        ;;
esac