410 lines
12 KiB
Bash
410 lines
12 KiB
Bash
#!/bin/sh
|
|
#===============================================================================
|
|
#
|
|
# Copyright (C) 2020-2025 by Digi International Inc.
|
|
# All rights reserved.
|
|
#
|
|
# This program is free software; you can redistribute it and/or modify it
|
|
# under the terms of the GNU General Public License version 2 as published by
|
|
# the Free Software Foundation.
|
|
#
|
|
#
|
|
# Description:
|
|
# Script to flash Yocto build artifacts over USB to the target.
|
|
#===============================================================================
|
|
# set -x
|
|
|
|
#
|
|
# U-Boot script for installing Linux images created by Yocto
|
|
#
|
|
|
|
# Exit on any error
|
|
set -e
|
|
|
|
# Parse uuu cmd output
|
|
getenv()
|
|
{
|
|
uuu -v fb: ucmd printenv "${1}" | sed -ne "s,^${1}=,,g;T;p"
|
|
}
|
|
|
|
# Grep for string in command output
|
|
# Params:
|
|
# 1. Command
|
|
# 2. String to grep
|
|
grep_string()
|
|
{
|
|
uuu -v fb: ucmd ${1} | grep "${2}"
|
|
}
|
|
|
|
show_usage()
|
|
{
|
|
echo "Usage: $0 [options]"
|
|
echo ""
|
|
echo " Options:"
|
|
echo " -b Activate bootcount mechanism (3 boot attempts)."
|
|
echo " -d Install firmware on dualboot partitions (system A and system B)."
|
|
echo " (Implies -b)."
|
|
echo " -h Show this help."
|
|
echo " -i <dey-image-name> Image name that prefixes the image filenames, such as 'dey-image-qt', "
|
|
echo " 'dey-image-webkit', 'core-image-base'..."
|
|
echo " Defaults to '##DEFAULT_IMAGE_NAME##' if not provided."
|
|
echo " -k <dek-filename> Update includes dek file."
|
|
echo " (implies -t)."
|
|
echo " -n No wait. Skips 10 seconds delay to stop script."
|
|
echo " -u <u-boot-filename> U-Boot filename."
|
|
echo " Auto-determined by variant if not provided."
|
|
echo " -U Update redundant bootloader partition."
|
|
|
|
exit 2
|
|
}
|
|
|
|
# Update a partition
|
|
# Params:
|
|
# 1. partition
|
|
# 2. file
|
|
# 3. dek file when updating an encrypted bootloader
|
|
part_update()
|
|
{
|
|
echo "\033[36m"
|
|
echo "====================================================================================="
|
|
echo "Updating '${1}' partition with file: ${2}"
|
|
echo "====================================================================================="
|
|
echo "\033[0m"
|
|
|
|
if [ "${1}" = "bootloader" ] || [ "${1}" = "bootloader_redundant" ]; then
|
|
if [ "${ENCRYPTED}" = "true" ]; then
|
|
uuu fb: download -f "${2}"
|
|
if [ -n "${DEK_FILE}" ]; then
|
|
# Encrypted bootloader + dek
|
|
uuu fb: ucmd setenv uboot_size \${filesize}
|
|
uuu fb: ucmd setenv fastboot_buffer \${initrd_addr}
|
|
uuu fb: download -f "${3}"
|
|
uuu fb: ucmd setenv dek_size \${filesize}
|
|
uuu fb: ucmd trustfence update ram \${loadaddr} \${uboot_size} \${initrd_addr} \${dek_size}
|
|
else
|
|
# Encrypted bootloader (re-use existing dek)
|
|
uuu fb: ucmd trustfence update ram \${fastboot_buffer} \${fastboot_bytes}
|
|
fi
|
|
else
|
|
# Non-encrypted bootloader (can be signed or not)
|
|
uuu fb: flash "${1}" "${2}"
|
|
fi
|
|
else
|
|
# Non-bootloader image
|
|
uuu fb: flash -raw2sparse "${1}" "${2}"
|
|
fi
|
|
}
|
|
|
|
clear
|
|
echo "############################################################"
|
|
echo "# Linux firmware install through USB OTG #"
|
|
echo "############################################################"
|
|
|
|
# Command line admits the following parameters:
|
|
# -b, -d, -n (booleans)
|
|
# -i <image-name>
|
|
# -u <u-boot-filename>
|
|
# -k <dek-filename>
|
|
while getopts ':bdhi:nu:Uk:' c
|
|
do
|
|
if [ "${c}" = ":" ]; then
|
|
c="${OPTARG}"
|
|
unset OPTARG
|
|
elif echo "${OPTARG}" | grep -qs '^-'; then
|
|
OPTIND="$((OPTIND-1))"
|
|
unset OPTARG
|
|
fi
|
|
case $c in
|
|
b) BOOTCOUNT=true ;;
|
|
d) INSTALL_DUALBOOT=true && BOOTCOUNT=true ;;
|
|
h) show_usage ;;
|
|
i) IMAGE_NAME=${OPTARG} ;;
|
|
k) DEK_FILE=${OPTARG} ;;
|
|
n) NOWAIT=true ;;
|
|
u) INSTALL_UBOOT_FILENAME=${OPTARG} ;;
|
|
U) INSTALL_REDUNDANT_UBOOT=true ;;
|
|
esac
|
|
done
|
|
|
|
# Enable the redirect support to get u-boot variables values
|
|
uuu fb: ucmd setenv stdout serial,fastboot
|
|
|
|
# Check if dualboot variable is active
|
|
dualboot=$(getenv "dualboot")
|
|
if [ "${dualboot}" = "yes" ]; then
|
|
DUALBOOT=true;
|
|
fi
|
|
|
|
echo ""
|
|
echo "Determining image files to use..."
|
|
|
|
# Determine U-Boot file to program basing on SOM's SOC revision
|
|
if [ -z "${INSTALL_UBOOT_FILENAME}" ]; then
|
|
soc_type="$(getenv soc_type)"
|
|
if [ "${soc_type}" = "imx93" ]; then
|
|
soc_rev="$(getenv soc_rev)"
|
|
if [ -n "${soc_rev}" ]; then
|
|
[ "${soc_rev}" = "0x10" ] && SOCREV="-A0"
|
|
else
|
|
# Fallback to hardware version if soc_rev is empty
|
|
hwid_2="$(getenv hwid_2)"
|
|
hwid_2="0x${hwid_2#0x}"
|
|
som_hv="$(((hwid_2 & 0x78) >> 3))"
|
|
[ "${som_hv}" -lt "2" ] && SOCREV="-A0"
|
|
fi
|
|
fi
|
|
INSTALL_UBOOT_FILENAME="imx-boot-##SIGNED##-##MACHINE##${SOCREV}.bin"
|
|
fi
|
|
|
|
# Determine if bootloader is signed and/or encrypted
|
|
if echo "$INSTALL_UBOOT_FILENAME" | grep -q -e "signed"; then
|
|
SIGNED=true
|
|
fi
|
|
if echo "$INSTALL_UBOOT_FILENAME" | grep -q -e "encrypted"; then
|
|
ENCRYPTED=true
|
|
fi
|
|
|
|
if [ "${ENCRYPTED}" = "true" ]; then
|
|
tf_status=$(grep_string "trustfence status" "Secure boot:")
|
|
if echo "${tf_status}" | grep -q -e "OPEN"; then
|
|
echo "\033[93m"
|
|
echo "WARNING!"
|
|
echo "You are trying to program encrypted images but the device status is OPEN."
|
|
echo "An OPEN device requires manual procedure for installing an encrypted bootloader,"
|
|
echo "programming the secure keys, and closing the device."
|
|
echo "Continuing would result in a non-secure setup or a non-bootable device after the"
|
|
echo "close operation."
|
|
echo ""
|
|
echo "Check the online documentation for manual steps at:"
|
|
echo "https://docs.digi.com/resources/documentation/digidocs/embedded/trustfence_home.html"
|
|
echo ""
|
|
echo "You can run this installer to program encrypted artifacts when the device has been closed."
|
|
echo "\033[0m"
|
|
echo "Exiting."
|
|
exit 1
|
|
fi
|
|
fi
|
|
|
|
# remove redirect
|
|
uuu fb: ucmd setenv stdout serial
|
|
|
|
# Determine linux, recovery, and rootfs image filenames to update
|
|
if [ -z "${IMAGE_NAME}" ]; then
|
|
IMAGE_NAME="##DEFAULT_IMAGE_NAME##"
|
|
fi
|
|
GRAPHICAL_IMAGES="##GRAPHICAL_IMAGES##"
|
|
for g in ${GRAPHICAL_IMAGES}; do
|
|
if [ "${IMAGE_NAME}" = "${g}" ]; then
|
|
BASEFILENAME="${IMAGE_NAME}-##GRAPHICAL_BACKEND##"
|
|
fi
|
|
done
|
|
if [ -z "${BASEFILENAME}" ]; then
|
|
BASEFILENAME="${IMAGE_NAME}"
|
|
fi
|
|
INSTALL_LINUX_FILENAME="${BASEFILENAME}-##MACHINE##.boot.vfat"
|
|
INSTALL_RECOVERY_FILENAME="${BASEFILENAME}-##MACHINE##.recovery.vfat"
|
|
INSTALL_ROOTFS_FILENAME="${BASEFILENAME}-##MACHINE##.ext4"
|
|
|
|
COMPRESSED_ROOTFS_IMAGE="${INSTALL_ROOTFS_FILENAME}.gz"
|
|
|
|
# If the rootfs image is compressed, make sure to decompress it before the update
|
|
if [ -f ${COMPRESSED_ROOTFS_IMAGE} ] && [ ! -f ${INSTALL_ROOTFS_FILENAME} ]; then
|
|
echo "\033[36m"
|
|
echo "====================================================================================="
|
|
echo "Decompressing rootfs image '${COMPRESSED_ROOTFS_IMAGE}'"
|
|
echo "====================================================================================="
|
|
echo "\033[0m"
|
|
gzip -d -k -f "${COMPRESSED_ROOTFS_IMAGE}"
|
|
fi
|
|
|
|
# Verify existence of files before starting the update
|
|
FILES="${INSTALL_UBOOT_FILENAME} ${INSTALL_LINUX_FILENAME}"
|
|
if [ "${DUALBOOT}" != true ]; then
|
|
FILES="${FILES} ${INSTALL_RECOVERY_FILENAME}"
|
|
fi
|
|
for f in ${FILES}; do
|
|
if [ ! -f ${f} ]; then
|
|
echo "\033[31m[ERROR] Could not find file '${f}'\033[0m"
|
|
ABORT=true
|
|
fi
|
|
done;
|
|
|
|
# Verify what kind of rootfs is going to be programmed
|
|
if [ ! -f ${INSTALL_ROOTFS_FILENAME} ]; then
|
|
echo "\033[31m[ERROR] Could not find file '${INSTALL_ROOTFS_FILENAME}'\033[0m"
|
|
INSTALL_ROOTFS_FILENAME="${BASEFILENAME}-##MACHINE##.squashfs"
|
|
echo "\033[32m[INFO] Trying with file '${INSTALL_ROOTFS_FILENAME}'\033[0m"
|
|
if [ ! -f "${INSTALL_ROOTFS_FILENAME}" ]; then
|
|
echo "\033[31m[ERROR] Could not find file '${INSTALL_ROOTFS_FILENAME}'\033[0m"
|
|
ABORT=true
|
|
fi
|
|
fi
|
|
|
|
[ "${ABORT}" = true ] && exit 1
|
|
|
|
# Enable bootcount mechanism by setting a bootlimit
|
|
if [ "${BOOTCOUNT}" = true ]; then
|
|
bootlimit_cmd="setenv bootlimit 3"
|
|
fi
|
|
|
|
# parts names
|
|
LINUX_NAME="linux"
|
|
RECOVERY_NAME="recovery"
|
|
ROOTFS_NAME="rootfs"
|
|
# Print warning about storage media being deleted
|
|
if [ "${NOWAIT}" != true ]; then
|
|
WAIT=10
|
|
printf "\n"
|
|
printf " ====================\n"
|
|
printf " = IMPORTANT! =\n"
|
|
printf " ====================\n"
|
|
printf " This process will erase your eMMC and will install the following files\n"
|
|
printf " on the partitions of the eMMC.\n"
|
|
printf "\n"
|
|
printf " PARTITION\tFILENAME\n"
|
|
printf " ---------\t--------\n"
|
|
printf " bootloader\t${INSTALL_UBOOT_FILENAME}\n"
|
|
if [ "${INSTALL_REDUNDANT_UBOOT}" = true ]; then
|
|
printf " bootloader_redundant\t${INSTALL_UBOOT_FILENAME}\n"
|
|
fi
|
|
if [ "${DUALBOOT}" = true ]; then
|
|
printf " ${LINUX_NAME}_a\t${INSTALL_LINUX_FILENAME}\n"
|
|
if [ "${INSTALL_DUALBOOT}" = true ]; then
|
|
printf " ${LINUX_NAME}_b\t${INSTALL_LINUX_FILENAME}\n"
|
|
fi
|
|
printf " ${ROOTFS_NAME}_a\t${INSTALL_ROOTFS_FILENAME}\n"
|
|
if [ "${INSTALL_DUALBOOT}" = true ]; then
|
|
printf " ${ROOTFS_NAME}_b\t${INSTALL_ROOTFS_FILENAME}\n"
|
|
fi
|
|
else
|
|
printf " ${LINUX_NAME}\t${INSTALL_LINUX_FILENAME}\n"
|
|
printf " ${RECOVERY_NAME}\t${INSTALL_RECOVERY_FILENAME}\n"
|
|
printf " ${ROOTFS_NAME}\t${INSTALL_ROOTFS_FILENAME}\n"
|
|
fi
|
|
printf "\n"
|
|
printf " Press CTRL+C now if you wish to abort.\n"
|
|
printf "\n"
|
|
while [ ${WAIT} -gt 0 ]; do
|
|
printf "\r Update process starts in %d " ${WAIT}
|
|
sleep 1
|
|
WAIT=$(( ${WAIT} - 1 ))
|
|
done
|
|
printf "\r \n"
|
|
printf " Starting update process\n"
|
|
fi
|
|
|
|
# Set fastboot buffer address to $loadaddr, just in case
|
|
uuu fb: ucmd setenv fastboot_buffer \${loadaddr}
|
|
|
|
# Skip user confirmation for U-Boot update
|
|
uuu fb: ucmd setenv forced_update 1
|
|
|
|
# Update U-Boot
|
|
part_update "bootloader" "${INSTALL_UBOOT_FILENAME}" "${DEK_FILE}"
|
|
if [ "${INSTALL_REDUNDANT_UBOOT}" = true ]; then
|
|
part_update bootloader_redundant "${INSTALL_UBOOT_FILENAME}"
|
|
fi
|
|
|
|
# Set MMC to boot from BOOT1 partition
|
|
uuu fb: ucmd mmc partconf 0 1 1 1
|
|
|
|
# Set 'bootcmd' for the second part of the script that will
|
|
# - Reset environment to defaults
|
|
# - Reset the bootcount
|
|
# - Set bootlimit (if required)
|
|
# - Save the environment
|
|
# - Partition the eMMC user data area for Linux
|
|
# - Update the 'linux' partition
|
|
# - Update the 'recovery' partition
|
|
# - Update the 'rootfs' partition
|
|
uuu fb: ucmd setenv bootcmd "
|
|
env default -a;
|
|
setenv dualboot \${dualboot};
|
|
bootcount reset;
|
|
${bootlimit_cmd};
|
|
saveenv;
|
|
echo \"\";
|
|
echo \"\";
|
|
echo \">> Creating Linux partition table on the eMMC\";
|
|
echo \"\";
|
|
echo \"\";
|
|
run partition_mmc_linux;
|
|
if test \$? -eq 1; then
|
|
echo \"[ERROR] Failed to create Linux partition table!\";
|
|
echo \"\";
|
|
echo \"Aborted.\";
|
|
exit;
|
|
fi;
|
|
echo \"\";
|
|
echo \"\";
|
|
echo \">> Start installation Linux firmware files\";
|
|
echo \"\";
|
|
echo \"\";
|
|
saveenv;
|
|
fastboot 0;
|
|
"
|
|
|
|
uuu fb: ucmd saveenv
|
|
uuu fb: acmd reset
|
|
|
|
# Wait for the target to reset
|
|
sleep 3
|
|
|
|
# Restart fastboot with the latest MMC partition configuration
|
|
uuu fb: ucmd setenv fastboot_dev sata
|
|
uuu fb: ucmd setenv fastboot_dev mmc
|
|
|
|
# Set fastboot buffer address to $loadaddr, just in case
|
|
uuu fb: ucmd setenv fastboot_buffer \${loadaddr}
|
|
|
|
if [ "${DUALBOOT}" = true ]; then
|
|
# Update Linux A
|
|
part_update "${LINUX_NAME}_a" "${INSTALL_LINUX_FILENAME}"
|
|
# Update Linux B
|
|
if [ "${INSTALL_DUALBOOT}" = true ]; then
|
|
part_update "${LINUX_NAME}_b" "${INSTALL_LINUX_FILENAME}"
|
|
fi
|
|
# Update Rootfs A
|
|
part_update "${ROOTFS_NAME}_a" "${INSTALL_ROOTFS_FILENAME}"
|
|
# Update Rootfs B
|
|
if [ "${INSTALL_DUALBOOT}" = true ]; then
|
|
part_update "${ROOTFS_NAME}_b" "${INSTALL_ROOTFS_FILENAME}"
|
|
fi
|
|
else
|
|
# Update Linux
|
|
part_update "${LINUX_NAME}" "${INSTALL_LINUX_FILENAME}"
|
|
# Update Recovery
|
|
part_update "${RECOVERY_NAME}" "${INSTALL_RECOVERY_FILENAME}"
|
|
# Update Rootfs
|
|
part_update "${ROOTFS_NAME}" "${INSTALL_ROOTFS_FILENAME}"
|
|
fi
|
|
|
|
# If the rootfs image was originally compressed, remove the uncompressed image
|
|
if [ -f ${COMPRESSED_ROOTFS_IMAGE} ] && [ -f ${INSTALL_ROOTFS_FILENAME} ]; then
|
|
rm -f "${INSTALL_ROOTFS_FILENAME}"
|
|
fi
|
|
# Set the dboot_kernel_var to fitimage if Trustfence is enabled
|
|
if [ "${SIGNED}" = "true" ] || [ "${ENCRYPTED}" = "true" ]; then
|
|
uuu fb: ucmd setenv dboot_kernel_var fitimage
|
|
fi
|
|
|
|
if [ "${DUALBOOT}" != true ]; then
|
|
# Configure u-boot to boot into recovery mode
|
|
uuu fb: ucmd setenv boot_recovery yes
|
|
uuu fb: ucmd setenv recovery_command wipe_update
|
|
fi
|
|
uuu fb: ucmd saveenv
|
|
|
|
# Reset the bootcount
|
|
uuu fb: ucmd bootcount reset
|
|
# Reset the target
|
|
uuu fb: acmd reset
|
|
|
|
echo "\033[32m"
|
|
echo "============================================================="
|
|
echo "Done! Wait for the target to complete first boot process."
|
|
echo "============================================================="
|
|
echo "\033[0m"
|
|
|
|
exit
|