From cb06e3df8a35962f2dbd7b65993b4531933b183e Mon Sep 17 00:00:00 2001 From: Kristian Amlie Date: Mon, 21 Sep 2020 19:54:03 +0200 Subject: [PATCH] MEN-3952: beaglebone: Implement workaround for broken U-Boot and kernel. Originally the intention was to fix the U-Boot integration for Beaglebone, but this seems to have been broken for a long time, almost a year, and no one has complained about it. The problem appears to be connected to this commit [1], but it's not entirely clear to me what the fix should be, and there are a lot of patches for our U-Boot fork. However, since the U-Boot integration is supposed to be the backup solution, rather than dig into U-Boot I decided to just fix the UEFI path instead. This method doesn't require any patching, but there is a problem with the specific image which is available for download at the time of writing. So just grab the boot loader and kernel pieces from a later, yet unbuilt, image, and it all works again. Changelog: Title Changelog: beaglebone: Remove U-Boot integration, which has not worked for a long time. U-Boot will still be used for booting, but GRUB will be used for integration with Mender, by chainloading via UEFI. [1] https://github.com/mendersoftware/uboot-mender/commit/e88d5dbf01dc8c3822c695267b43d6000d9b2a19 Signed-off-by: Kristian Amlie (cherry picked from commit ce2b1f46cfcbed54b4bc0198fd722c909bf01b6e) --- configs/beaglebone_black_base_config | 75 +++++++++++++------ configs/beaglebone_black_debian_emmc_config | 4 - configs/beaglebone_black_debian_sdcard_config | 1 - modules/probe.sh | 32 +++++--- scripts/test/run-tests.sh | 10 ++- 5 files changed, 82 insertions(+), 40 deletions(-) diff --git a/configs/beaglebone_black_base_config b/configs/beaglebone_black_base_config index 1b8c437..c948d8c 100644 --- a/configs/beaglebone_black_base_config +++ b/configs/beaglebone_black_base_config @@ -1,39 +1,70 @@ -# Binaries generated with the following script: -# https://github.com/mendersoftware/mender-convert-integration-scripts/blob/master/build-uboot-bbb.sh - -# There are reported issues with GRUB bootloader integration, fallback to U-boot. -MENDER_GRUB_EFI_INTEGRATION=n +# At the time of writing, the binaries below were uploaded manually. However, +# they are simply a vanilla U-Boot build of v2020.07, from Ubuntu 18.04, using +# these commands: +# make CROSS_COMPILE=arm-linux-gnueabihf- am335x_boneblack_vboot_defconfig +# make CROSS_COMPILE=arm-linux-gnueabihf- +# make CROSS_COMPILE=arm-linux-gnueabihf- envtools +BEAGLEBONE_BLACK_BINARIES="beaglebone_black_uefi-2020.07.tar.gz" +BEAGLEBONE_BLACK_BINARIES_URL="${MENDER_STORAGE_URL}/mender-convert/uboot/beaglebone/${BEAGLEBONE_BLACK_BINARIES}" -# We will write a modified bootloader -MENDER_COPY_BOOT_GAP=n +# At the time of writing, the binaries below were uploaded manually. They are +# simply a dump of the deb package from the link below, with the addition of the +# initrd file, which is not part of the package, but which is generated when +# installed on a live Beaglebone device. +# Original deb URL: http://repos.rcn-ee.com/debian/pool/main/l/linux-upstream/linux-image-4.19.94-ti-r51_1buster_armhf.deb +BEAGLEBONE_EFI_COMPATIBLE_KERNEL="linux-image-4.19.94-ti-r51_1buster_armhf-deb-dump.tar.xz" +BEAGLEBONE_EFI_COMPATIBLE_KERNEL_URL="${MENDER_STORAGE_URL}/mender-convert/beaglebone/kernel/${BEAGLEBONE_EFI_COMPATIBLE_KERNEL}" +BEAGLEBONE_EFI_COMPATIBLE_KERNEL_VERSION=4.19.94-ti-r51 -# 4MB alignment -MENDER_PARTITION_ALIGNMENT="4194304" +MENDER_IGNORE_UBOOT_BROKEN_UEFI=1 +MENDER_IGNORE_MISSING_EFI_STUB=1 -BEAGLEBONE_BLACK_BINARIES="${BEAGLEBONE_BLACK_CONFIG}-2018.07.tar.gz" -BEAGLEBONE_BLACK_BINARIES_URL="${MENDER_STORAGE_URL}/mender-convert/uboot/beaglebone/${BEAGLEBONE_BLACK_BINARIES}" +function beaglebone_fix_broken_uefi_uboot() { + log_warn "Attempting to work around broken UEFI support in U-Boot by forcing a newer U-Boot version." -function platform_modify() { mkdir -p work/bbb/binaries run_and_log_cmd "wget -q ${BEAGLEBONE_BLACK_BINARIES_URL} -P work/bbb/binaries" run_and_log_cmd "tar xzvf work/bbb/binaries/${BEAGLEBONE_BLACK_BINARIES} -C work/bbb/binaries" - # Mask udisks2.service, otherwise it will mount the inactive part and we - # might write an update while it is mounted which often result in - # corruptions. - # - # TODO: Find a way to only blacklist mmcblk0pX devices instead of masking - # the service. - run_and_log_cmd "sudo ln -sf /dev/null work/rootfs/etc/systemd/system/udisks2.service" - # Place u-boot and MLO into rootfs/boot run_and_log_cmd "sudo mkdir -p work/rootfs/boot" run_and_log_cmd "sudo cp work/bbb/binaries/MLO work/boot/" run_and_log_cmd "sudo cp work/bbb/binaries/u-boot.img work/boot/" - run_and_log_cmd "sudo cp work/bbb/binaries/fw_env.config work/rootfs/etc/" - run_and_log_cmd "sudo cp work/bbb/binaries/uboot-git-log.txt work/boot" run_and_log_cmd "sudo install -m 755 work/bbb/binaries/fw_printenv work/rootfs/sbin/fw_printenv" run_and_log_cmd "sudo ln -fs /sbin/fw_printenv work/rootfs/sbin/fw_setenv" } + +function beaglebone_fix_broken_uefi_kernel() { + log_warn "Attempting to work around kernel without EFI stub by using a newer kernel." + + mkdir -p work/bbb/kernel + run_and_log_cmd "wget -q $BEAGLEBONE_EFI_COMPATIBLE_KERNEL_URL -P work/bbb/kernel" + mkdir -p work/bbb/kernel/extract + run_and_log_cmd "tar xJf work/bbb/kernel/$BEAGLEBONE_EFI_COMPATIBLE_KERNEL -C work/bbb/kernel/extract" + run_and_log_cmd "cp -r work/bbb/kernel/extract/* work/rootfs/" + run_and_log_cmd "ln -sf vmlinuz-$BEAGLEBONE_EFI_COMPATIBLE_KERNEL_VERSION work/rootfs/boot/kernel" + run_and_log_cmd "ln -sf initrd.img-$BEAGLEBONE_EFI_COMPATIBLE_KERNEL_VERSION work/rootfs/boot/initrd" +} + +function beaglebone_fix_broken_uefi() { + if ! is_uboot_with_uefi_support work/boot-gap.bin; then + beaglebone_fix_broken_uefi_uboot + fi + if ! is_efi_compatible_kernel work/rootfs/boot/$kernel_imagetype; then + beaglebone_fix_broken_uefi_kernel + fi +} +PLATFORM_MODIFY_HOOKS+=(beaglebone_fix_broken_uefi) + +function disable_udisks2_service() { + # Mask udisks2.service, otherwise it will mount the inactive part and we + # might write an update while it is mounted which often result in + # corruptions. + # + # TODO: Find a way to only blacklist mmcblk0pX devices instead of masking + # the service. + run_and_log_cmd "sudo ln -sf /dev/null work/rootfs/etc/systemd/system/udisks2.service" +} +PLATFORM_MODIFY_HOOKS+=(disable_udisks2_service) diff --git a/configs/beaglebone_black_debian_emmc_config b/configs/beaglebone_black_debian_emmc_config index fff03d8..b703148 100644 --- a/configs/beaglebone_black_debian_emmc_config +++ b/configs/beaglebone_black_debian_emmc_config @@ -1,7 +1,3 @@ -# Binaries generated with the following script: -# https://github.com/mendersoftware/mender-convert-integration-scripts/blob/master/build-uboot-bbb.sh - -BEAGLEBONE_BLACK_CONFIG="beaglebone_black_debian_emmc" source configs/beaglebone_black_base_config MENDER_STORAGE_TOTAL_SIZE_MB="3648" MENDER_DEVICE_TYPE="beaglebone-emmc" diff --git a/configs/beaglebone_black_debian_sdcard_config b/configs/beaglebone_black_debian_sdcard_config index d72e5e5..65a7772 100644 --- a/configs/beaglebone_black_debian_sdcard_config +++ b/configs/beaglebone_black_debian_sdcard_config @@ -1,4 +1,3 @@ -BEAGLEBONE_BLACK_CONFIG="beaglebone_black_debian_sdcard" source configs/beaglebone_black_base_config MENDER_DEVICE_TYPE="beaglebone-sdcard" MENDER_STORAGE_DEVICE_BASE="/dev/mmcblk0p" diff --git a/modules/probe.sh b/modules/probe.sh index 5be853b..5f3f898 100644 --- a/modules/probe.sh +++ b/modules/probe.sh @@ -272,33 +272,46 @@ probe_initrd_in_boot_and_root() { } check_for_broken_uboot_uefi_support() { + if ! is_uboot_with_uefi_support "$@"; then + local log_level=log_fatal + if [ "$MENDER_IGNORE_UBOOT_BROKEN_UEFI" = 1 ]; then + log_level=log_warn + fi + $log_level 'Detected a U-Boot version in the range v2018.09 - v2019.07. These U-Boot versions are known to have broken UEFI support, and therefore the MENDER_GRUB_EFI_INTEGRATION feature is unlikely to work. This only affects newly flashed devices using the partition image (extension ending in "img"). The Mender artifact should still work to upgrade an existing, working device. There are two possible workarounds for this issue: 1) Use either an older or a newer image that works, and use a Mender artifact afterwards to up/down-grade it to the version you want. 2) If the device has a non-UEFI U-Boot port in mender-convert, use that (look for a board specific file in `configs`) . If you want to ignore this error and force creation of the image, set the MENDER_IGNORE_UBOOT_BROKEN_UEFI=1 config option.' + fi +} + +is_uboot_with_uefi_support() { local path="$1" # Broken UEFI support in range v2018.09 - v2019.07 (see MEN-2404) local regex='U-Boot 20(18\.(09|1[0-2])|19\.0[1-7])' if egrep -qr "$regex" "$path"; then + return 1 + fi + return 0 +} + +check_efi_compatible_kernel() { + if ! is_efi_compatible_kernel "$@"; then local log_level=log_fatal - if [ "$MENDER_IGNORE_UBOOT_BROKEN_UEFI" = 1 ]; then + if [ "$MENDER_IGNORE_MISSING_EFI_STUB" = 1 ]; then log_level=log_warn fi - $log_level 'Detected a U-Boot version in the range v2018.09 - v2019.07. These U-Boot versions are known to have broken UEFI support, and therefore the MENDER_GRUB_EFI_INTEGRATION feature is unlikely to work. This only affects newly flashed devices using the partition image (extension ending in "img"). The Mender artifact should still work to upgrade an existing, working device. There are two possible workarounds for this issue: 1) Use either an older or a newer image that works, and use a Mender artifact afterwards to up/down-grade it to the version you want. 2) If the device has a non-UEFI U-Boot port in mender-convert, use that (look for a board specific file in `configs`) . If you want to ignore this error and force creation of the image, set the MENDER_IGNORE_UBOOT_BROKEN_UEFI=1 config option.' + $log_level 'Detected a kernel which does not have an EFI stub. This kernel is not supported when booting with UEFI. Please consider using a U-Boot port if the board has one (look for a board specific file in `configs`), or find a kernel which has the CONFIG_EFI_STUB turned on. To ignore this message and proceed anyway, set the MENDER_IGNORE_MISSING_EFI_STUB=1 config option.' fi } -check_efi_compatible_kernel() { +is_efi_compatible_kernel() { kernel_path="$1" case "$(probe_arch)" in arm|aarch64) # On ARM, as of version 2.04, GRUB can only boot kernels which have an EFI # stub in them. See MEN-2404. - if ! file -k $kernel_path | fgrep 'EFI application'; then - local log_level=log_fatal - if [ "$MENDER_IGNORE_MISSING_EFI_STUB" = 1 ]; then - log_level=log_warn - fi - $log_level 'Detected a kernel which does not have an EFI stub. This kernel is not supported when booting with UEFI. Please consider using a U-Boot port if the board has one (look for a board specific file in `configs`), or find a kernel which has the CONFIG_EFI_STUB turned on. To ignore this message and proceed anyway, set the MENDER_IGNORE_MISSING_EFI_STUB=1 config option.' + if ! file -k $kernel_path | fgrep -q 'EFI application'; then + return 1 fi ;; *) @@ -306,4 +319,5 @@ check_efi_compatible_kernel() { : ;; esac + return 0 } diff --git a/scripts/test/run-tests.sh b/scripts/test/run-tests.sh index a3e89d3..1b1d49c 100755 --- a/scripts/test/run-tests.sh +++ b/scripts/test/run-tests.sh @@ -102,18 +102,20 @@ else if [ "$1" == "--all" -o "$1" == "--only" -a "$2" == "beaglebone" ]; then wget --progress=dot:giga -N ${BBB_DEBIAN_IMAGE_URL} -P input/ - convert_and_test "beaglebone" \ + convert_and_test "beaglebone-sdcard" \ "release-1" \ - "input/bone-debian-9.5-iot-armhf-2018-08-30-4gb.img.xz" || test_result=$? + "input/bone-debian-9.5-iot-armhf-2018-08-30-4gb.img.xz" \ + "--config configs/beaglebone_black_debian_sdcard_config" || test_result=$? echo >&2 "----------------------------------------" echo >&2 "Running the uncompressed test" echo >&2 "----------------------------------------" rm -rf deploy unxz --force "input/bone-debian-9.5-iot-armhf-2018-08-30-4gb.img.xz" - convert_and_test "beaglebone" \ + convert_and_test "beaglebone-emmc" \ "release-1" \ - "input/bone-debian-9.5-iot-armhf-2018-08-30-4gb.img" || test_result=$? + "input/bone-debian-9.5-iot-armhf-2018-08-30-4gb.img" \ + "--config configs/beaglebone_black_debian_emmc_config" || test_result=$? fi if [ "$1" == "--all" -o "$1" == "--only" -a "$2" == "ubuntu" ]; then