-#!/bin/sh
# Copyright (C) 2014 OpenWrt.org
#
. /lib/functions.sh
-# 'kernel' partition on NAND contains the kernel
+# 'kernel' partition or UBI volume on NAND contains the kernel
CI_KERNPART="${CI_KERNPART:-kernel}"
# 'ubi' partition on NAND contains UBI
+# There are also CI_KERN_UBIPART and CI_ROOT_UBIPART if kernel
+# and rootfs are on separated UBIs.
CI_UBIPART="${CI_UBIPART:-ubi}"
-# 'rootfs' partition on NAND contains the rootfs
+# 'rootfs' UBI volume on NAND contains the rootfs
CI_ROOTPART="${CI_ROOTPART:-rootfs}"
ubi_mknod() {
}
nand_get_magic_long() {
- dd if="$1" skip=$2 bs=4 count=1 2>/dev/null | hexdump -v -n 4 -e '1/1 "%02x"'
+ (${3}cat "$1" | dd bs=4 "skip=${2:-0}" count=1 | hexdump -v -n 4 -e '1/1 "%02x"') 2> /dev/null
}
get_magic_long_tar() {
- ( tar xf $1 $2 -O | dd bs=4 count=1 | hexdump -v -n 4 -e '1/1 "%02x"') 2> /dev/null
+ (tar xO${3}f "$1" "$2" | dd bs=4 count=1 | hexdump -v -n 4 -e '1/1 "%02x"') 2> /dev/null
}
identify_magic() {
"4349"*)
echo "combined"
;;
+ "1f8b"*)
+ echo "gzip"
+ ;;
*)
echo "unknown $magic"
;;
identify() {
- identify_magic $(nand_get_magic_long "$1" "${2:-0}")
+ identify_magic $(nand_get_magic_long "$@")
}
identify_tar() {
- identify_magic $(get_magic_long_tar "$1" "$2")
+ identify_magic $(get_magic_long_tar "$@")
+}
+
+identify_if_gzip() {
+ if [ "$(identify "$1")" = gzip ]; then echo -n z; fi
}
nand_restore_config() {
- sync
- local ubidev=$( nand_find_ubi $CI_UBIPART )
+ local ubidev=$( nand_find_ubi "${CI_ROOT_UBIPART:-$CI_UBIPART}" )
local ubivol="$( nand_find_volume $ubidev rootfs_data )"
- [ ! "$ubivol" ] &&
- ubivol="$( nand_find_volume $ubidev $CI_ROOTPART )"
+ if [ ! "$ubivol" ]; then
+ ubivol="$( nand_find_volume $ubidev "$CI_ROOTPART" )"
+ if [ ! "$ubivol" ]; then
+ echo "cannot find ubifs data volume"
+ return 1
+ fi
+ fi
mkdir /tmp/new_root
if ! mount -t ubifs /dev/$ubivol /tmp/new_root; then
- echo "mounting ubifs $ubivol failed"
+ echo "cannot mount ubifs volume $ubivol"
rmdir /tmp/new_root
return 1
fi
- mv "$1" "/tmp/new_root/sysupgrade.tgz"
- umount /tmp/new_root
- sync
+ if mv "$1" "/tmp/new_root/$BACKUP_FILE"; then
+ if umount /tmp/new_root; then
+ echo "configuration saved"
+ rmdir /tmp/new_root
+ return 0
+ fi
+ else
+ umount /tmp/new_root
+ fi
+ echo "could not save configuration to ubifs volume $ubivol"
rmdir /tmp/new_root
+ return 1
}
-nand_upgrade_prepare_ubi() {
- local rootfs_length="$1"
- local rootfs_type="$2"
- local has_kernel="${3:-0}"
- local has_env="${4:-0}"
+nand_remove_ubiblock() {
+ local ubivol="$1"
- local mtdnum="$( find_mtd_index "$CI_UBIPART" )"
+ local ubiblk="ubiblock${ubivol:3}"
+ if [ -e "/dev/$ubiblk" ]; then
+ umount "/dev/$ubiblk" && echo "unmounted /dev/$ubiblk" || :
+ if ! ubiblock -r "/dev/$ubivol"; then
+ echo "cannot remove $ubiblk"
+ return 1
+ fi
+ fi
+}
+
+nand_attach_ubi() {
+ local ubipart="$1"
+ local has_env="${2:-0}"
+
+ local mtdnum="$( find_mtd_index "$ubipart" )"
if [ ! "$mtdnum" ]; then
- echo "cannot find ubi mtd partition $CI_UBIPART"
+ >&2 echo "cannot find ubi mtd partition $ubipart"
return 1
fi
- local ubidev="$( nand_find_ubi "$CI_UBIPART" )"
+ local ubidev="$( nand_find_ubi "$ubipart" )"
if [ ! "$ubidev" ]; then
- ubiattach -m "$mtdnum"
- sync
- ubidev="$( nand_find_ubi "$CI_UBIPART" )"
+ >&2 ubiattach -m "$mtdnum"
+ ubidev="$( nand_find_ubi "$ubipart" )"
+
+ if [ ! "$ubidev" ]; then
+ >&2 ubiformat /dev/mtd$mtdnum -y
+ >&2 ubiattach -m "$mtdnum"
+ ubidev="$( nand_find_ubi "$ubipart" )"
+
+ if [ ! "$ubidev" ]; then
+ >&2 echo "cannot attach ubi mtd partition $ubipart"
+ return 1
+ fi
+
+ if [ "$has_env" -gt 0 ]; then
+ >&2 ubimkvol /dev/$ubidev -n 0 -N ubootenv -s 1MiB
+ >&2 ubimkvol /dev/$ubidev -n 1 -N ubootenv2 -s 1MiB
+ fi
+ fi
fi
- if [ ! "$ubidev" ]; then
- ubiformat /dev/mtd$mtdnum -y
- ubiattach -m "$mtdnum"
- sync
- ubidev="$( nand_find_ubi "$CI_UBIPART" )"
- [ "$has_env" -gt 0 ] && {
- ubimkvol /dev/$ubidev -n 0 -N ubootenv -s 1MiB
- ubimkvol /dev/$ubidev -n 1 -N ubootenv2 -s 1MiB
- }
- fi
+ echo "$ubidev"
+ return 0
+}
- local kern_ubivol="$( nand_find_volume $ubidev $CI_KERNPART )"
- local root_ubivol="$( nand_find_volume $ubidev $CI_ROOTPART )"
- local data_ubivol="$( nand_find_volume $ubidev rootfs_data )"
+nand_detach_ubi() {
+ local ubipart="$1"
- # remove ubiblock device of rootfs
- local root_ubiblk="ubiblock${root_ubivol:3}"
- if [ "$root_ubivol" -a -e "/dev/$root_ubiblk" ]; then
- echo "removing $root_ubiblk"
- if ! ubiblock -r /dev/$root_ubivol; then
- echo "cannot remove $root_ubiblk"
- return 1;
+ local mtdnum="$( find_mtd_index "$ubipart" )"
+ if [ ! "$mtdnum" ]; then
+ echo "cannot find ubi mtd partition $ubipart"
+ return 1
+ fi
+
+ local ubidev="$( nand_find_ubi "$ubipart" )"
+ if [ "$ubidev" ]; then
+ for ubivol in $(find /dev -name "${ubidev}_*" -maxdepth 1 | sort); do
+ ubivol="${ubivol:5}"
+ nand_remove_ubiblock "$ubivol" || :
+ umount "/dev/$ubivol" && echo "unmounted /dev/$ubivol" || :
+ done
+ if ! ubidetach -m "$mtdnum"; then
+ echo "cannot detach ubi mtd partition $ubipart"
+ return 1
fi
fi
+}
+
+nand_upgrade_prepare_ubi() {
+ local rootfs_length="$1"
+ local rootfs_type="$2"
+ local rootfs_data_max="$(fw_printenv -n rootfs_data_max 2> /dev/null)"
+ [ -n "$rootfs_data_max" ] && rootfs_data_max=$((rootfs_data_max))
+
+ local kernel_length="$3"
+ local has_env="${4:-0}"
+ local kern_ubidev
+ local root_ubidev
+
+ [ -n "$rootfs_length" -o -n "$kernel_length" ] || return 1
+
+ if [ -n "$CI_KERN_UBIPART" -a -n "$CI_ROOT_UBIPART" ]; then
+ kern_ubidev="$( nand_attach_ubi "$CI_KERN_UBIPART" "$has_env" )"
+ [ -n "$kern_ubidev" ] || return 1
+ root_ubidev="$( nand_attach_ubi "$CI_ROOT_UBIPART" )"
+ [ -n "$root_ubidev" ] || return 1
+ else
+ kern_ubidev="$( nand_attach_ubi "$CI_UBIPART" "$has_env" )"
+ [ -n "$kern_ubidev" ] || return 1
+ root_ubidev="$kern_ubidev"
+ fi
+
+ local kern_ubivol="$( nand_find_volume $kern_ubidev "$CI_KERNPART" )"
+ local root_ubivol="$( nand_find_volume $root_ubidev "$CI_ROOTPART" )"
+ local data_ubivol="$( nand_find_volume $root_ubidev rootfs_data )"
+ [ "$root_ubivol" = "$kern_ubivol" ] && root_ubivol=
+
+ # remove ubiblocks
+ [ "$kern_ubivol" ] && { nand_remove_ubiblock $kern_ubivol || return 1; }
+ [ "$root_ubivol" ] && { nand_remove_ubiblock $root_ubivol || return 1; }
+ [ "$data_ubivol" ] && { nand_remove_ubiblock $data_ubivol || return 1; }
# kill volumes
- [ "$kern_ubivol" ] && ubirmvol /dev/$ubidev -N $CI_KERNPART || true
- [ "$root_ubivol" ] && ubirmvol /dev/$ubidev -N $CI_ROOTPART || true
- [ "$data_ubivol" ] && ubirmvol /dev/$ubidev -N rootfs_data || true
+ [ "$kern_ubivol" ] && ubirmvol /dev/$kern_ubidev -N "$CI_KERNPART" || :
+ [ "$root_ubivol" ] && ubirmvol /dev/$root_ubidev -N "$CI_ROOTPART" || :
+ [ "$data_ubivol" ] && ubirmvol /dev/$root_ubidev -N rootfs_data || :
- # update kernel
- if [ "$has_kernel" = "1" ]; then
- if ! ubimkvol /dev/$ubidev -N $CI_KERNPART -s $kernel_length; then
+ # create kernel vol
+ if [ -n "$kernel_length" ]; then
+ if ! ubimkvol /dev/$kern_ubidev -N "$CI_KERNPART" -s $kernel_length; then
echo "cannot create kernel volume"
return 1;
fi
fi
- # update rootfs
- local root_size_param
- if [ "$rootfs_type" = "ubifs" ]; then
- root_size_param="-m"
- else
- root_size_param="-s $rootfs_length"
- fi
- if ! ubimkvol /dev/$ubidev -N $CI_ROOTPART $root_size_param; then
- echo "cannot create rootfs volume"
- return 1;
+ # create rootfs vol
+ if [ -n "$rootfs_length" ]; then
+ local rootfs_size_param
+ if [ "$rootfs_type" = "ubifs" ]; then
+ rootfs_size_param="-m"
+ else
+ rootfs_size_param="-s $rootfs_length"
+ fi
+ if ! ubimkvol /dev/$root_ubidev -N "$CI_ROOTPART" $rootfs_size_param; then
+ echo "cannot create rootfs volume"
+ return 1;
+ fi
fi
- # create rootfs_data for non-ubifs rootfs
+ # create rootfs_data vol for non-ubifs rootfs
if [ "$rootfs_type" != "ubifs" ]; then
- if ! ubimkvol /dev/$ubidev -N rootfs_data -m; then
- echo "cannot initialize rootfs_data volume"
- return 1
+ local rootfs_data_size_param="-m"
+ if [ -n "$rootfs_data_max" ]; then
+ rootfs_data_size_param="-s $rootfs_data_max"
+ fi
+ if ! ubimkvol /dev/$root_ubidev -N rootfs_data $rootfs_data_size_param; then
+ if ! ubimkvol /dev/$root_ubidev -N rootfs_data -m; then
+ echo "cannot initialize rootfs_data volume"
+ return 1
+ fi
fi
fi
- sync
- return 0
-}
-
-nand_do_upgrade_success() {
- local conf_tar="/tmp/sysupgrade.tgz"
- sync
- [ -f "$conf_tar" ] && nand_restore_config "$conf_tar"
- echo "sysupgrade successful"
- umount -a
- reboot -f
+ return 0
}
-# Flash the UBI image to MTD partition
+# Write the UBI image to MTD ubi partition
nand_upgrade_ubinized() {
local ubi_file="$1"
- local mtdnum="$(find_mtd_index "$CI_UBIPART")"
-
- [ ! "$mtdnum" ] && {
- CI_UBIPART="rootfs"
- mtdnum="$(find_mtd_index "$CI_UBIPART")"
- }
+ local gz="$2"
- if [ ! "$mtdnum" ]; then
- echo "cannot find mtd device $CI_UBIPART"
- umount -a
- reboot -f
- fi
+ nand_detach_ubi "$CI_UBIPART" || return 1
- local mtddev="/dev/mtd${mtdnum}"
- ubidetach -p "${mtddev}" || true
- sync
- ubiformat "${mtddev}" -y -f "${ubi_file}"
- ubiattach -p "${mtddev}"
- nand_do_upgrade_success
+ local mtdnum="$( find_mtd_index "$CI_UBIPART" )"
+ ${gz}cat "$ubi_file" | ubiformat "/dev/mtd$mtdnum" -y -f - && ubiattach -m "$mtdnum"
}
-# Write the UBIFS image to UBI volume
+# Write the UBIFS image to UBI rootfs volume
nand_upgrade_ubifs() {
- local rootfs_length=`(cat $1 | wc -c) 2> /dev/null`
+ local ubifs_file="$1"
+ local gz="$2"
- nand_upgrade_prepare_ubi "$rootfs_length" "ubifs" "0" "0"
+ local ubifs_length=$( (${gz}cat "$ubifs_file" | wc -c) 2> /dev/null)
+
+ nand_upgrade_prepare_ubi "$ubifs_length" "ubifs" "" "" || return 1
local ubidev="$( nand_find_ubi "$CI_UBIPART" )"
- local root_ubivol="$(nand_find_volume $ubidev $CI_ROOTPART)"
- ubiupdatevol /dev/$root_ubivol -s $rootfs_length $1
+ local root_ubivol="$(nand_find_volume $ubidev "$CI_ROOTPART")"
+ ${gz}cat "$ubifs_file" | ubiupdatevol /dev/$root_ubivol -s "$ubifs_length" -
+}
+
+# Write the FIT image to UBI kernel volume
+nand_upgrade_fit() {
+ local fit_file="$1"
+ local gz="$2"
+
+ local fit_length=$( (${gz}cat "$fit_file" | wc -c) 2> /dev/null)
- nand_do_upgrade_success
+ nand_upgrade_prepare_ubi "" "" "$fit_length" "1" || return 1
+
+ local fit_ubidev="$(nand_find_ubi "$CI_UBIPART")"
+ local fit_ubivol="$(nand_find_volume $fit_ubidev "$CI_KERNPART")"
+ ${gz}cat "$fit_file" | ubiupdatevol /dev/$fit_ubivol -s "$fit_length" -
}
+# Write images in the TAR file to MTD partitions and/or UBI volumes as required
nand_upgrade_tar() {
local tar_file="$1"
- local kernel_mtd="$(find_mtd_index $CI_KERNPART)"
+ local gz="$2"
+
+ # WARNING: This fails if tar contains more than one 'sysupgrade-*' directory.
+ local board_dir="$(tar t${gz}f "$tar_file" | grep -m 1 '^sysupgrade-.*/$')"
+ board_dir="${board_dir%/}"
- local board_dir=$(tar tf $tar_file | grep -m 1 '^sysupgrade-.*/$')
- board_dir=${board_dir%/}
+ local kernel_mtd kernel_length
+ if [ "$CI_KERNPART" != "none" ]; then
+ kernel_mtd="$(find_mtd_index "$CI_KERNPART")"
+ kernel_length=$( (tar xO${gz}f "$tar_file" "$board_dir/kernel" | wc -c) 2> /dev/null)
+ [ "$kernel_length" = 0 ] && kernel_length=
+ fi
+ local rootfs_length=$( (tar xO${gz}f "$tar_file" "$board_dir/root" | wc -c) 2> /dev/null)
+ [ "$rootfs_length" = 0 ] && rootfs_length=
+ local rootfs_type
+ [ "$rootfs_length" ] && rootfs_type="$(identify_tar "$tar_file" "$board_dir/root" "$gz")"
+
+ local ubi_kernel_length
+ if [ "$kernel_length" ]; then
+ if [ "$kernel_mtd" ]; then
+ # On some devices, the raw kernel and ubi partitions overlap.
+ # These devices brick if the kernel partition is erased.
+ # Hence only invalidate kernel for now.
+ dd if=/dev/zero bs=4096 count=1 2> /dev/null | \
+ mtd write - "$CI_KERNPART"
+ else
+ ubi_kernel_length="$kernel_length"
+ fi
+ fi
+ local has_env=0
+ nand_upgrade_prepare_ubi "$rootfs_length" "$rootfs_type" "$ubi_kernel_length" "$has_env" || return 1
- local kernel_length=`(tar xf $tar_file ${board_dir}/kernel -O | wc -c) 2> /dev/null`
- local rootfs_length=`(tar xf $tar_file ${board_dir}/root -O | wc -c) 2> /dev/null`
+ if [ "$rootfs_length" ]; then
+ local ubidev="$( nand_find_ubi "${CI_ROOT_UBIPART:-$CI_UBIPART}" )"
+ local root_ubivol="$( nand_find_volume $ubidev "$CI_ROOTPART" )"
+ tar xO${gz}f "$tar_file" "$board_dir/root" | \
+ ubiupdatevol /dev/$root_ubivol -s "$rootfs_length" -
+ fi
+ if [ "$kernel_length" ]; then
+ if [ "$kernel_mtd" ]; then
+ tar xO${gz}f "$tar_file" "$board_dir/kernel" | \
+ mtd write - "$CI_KERNPART"
+ else
+ local ubidev="$( nand_find_ubi "${CI_KERN_UBIPART:-$CI_UBIPART}" )"
+ local kern_ubivol="$( nand_find_volume $ubidev "$CI_KERNPART" )"
+ tar xO${gz}f "$tar_file" "$board_dir/kernel" | \
+ ubiupdatevol /dev/$kern_ubivol -s "$kernel_length" -
+ fi
+ fi
- local rootfs_type="$(identify_tar "$tar_file" ${board_dir}/root)"
+ return 0
+}
- local has_kernel=1
- local has_env=0
+nand_verify_if_gzip_file() {
+ local file="$1"
+ local gz="$2"
- [ "$kernel_length" != 0 -a -n "$kernel_mtd" ] && {
- tar xf $tar_file ${board_dir}/kernel -O | mtd write - $CI_KERNPART
- }
- [ "$kernel_length" = 0 -o ! -z "$kernel_mtd" ] && has_kernel=0
+ if [ "$gz" = z ]; then
+ echo "verifying compressed sysupgrade file integrity"
+ if ! gzip -t "$file"; then
+ echo "corrupted compressed sysupgrade file"
+ return 1
+ fi
+ fi
+}
- nand_upgrade_prepare_ubi "$rootfs_length" "$rootfs_type" "$has_kernel" "$has_env"
+nand_verify_tar_file() {
+ local file="$1"
+ local gz="$2"
- local ubidev="$( nand_find_ubi "$CI_UBIPART" )"
- [ "$has_kernel" = "1" ] && {
- local kern_ubivol="$(nand_find_volume $ubidev $CI_KERNPART)"
- tar xf $tar_file ${board_dir}/kernel -O | \
- ubiupdatevol /dev/$kern_ubivol -s $kernel_length -
- }
+ echo "verifying sysupgrade tar file integrity"
+ if ! tar xO${gz}f "$file" > /dev/null; then
+ echo "corrupted sysupgrade tar file"
+ return 1
+ fi
+}
- local root_ubivol="$(nand_find_volume $ubidev $CI_ROOTPART)"
- tar xf $tar_file ${board_dir}/root -O | \
- ubiupdatevol /dev/$root_ubivol -s $rootfs_length -
+nand_do_flash_file() {
+ local file="$1"
- nand_do_upgrade_success
+ local gz="$(identify_if_gzip "$file")"
+ local file_type="$(identify "$file" "" "$gz")"
+
+ [ ! "$(find_mtd_index "$CI_UBIPART")" ] && CI_UBIPART=rootfs
+
+ case "$file_type" in
+ "fit")
+ nand_verify_if_gzip_file "$file" "$gz" || return 1
+ nand_upgrade_fit "$file" "$gz"
+ ;;
+ "ubi")
+ nand_verify_if_gzip_file "$file" "$gz" || return 1
+ nand_upgrade_ubinized "$file" "$gz"
+ ;;
+ "ubifs")
+ nand_verify_if_gzip_file "$file" "$gz" || return 1
+ nand_upgrade_ubifs "$file" "$gz"
+ ;;
+ *)
+ nand_verify_tar_file "$file" "$gz" || return 1
+ nand_upgrade_tar "$file" "$gz"
+ ;;
+ esac
+}
+
+nand_do_restore_config() {
+ local conf_tar="/tmp/sysupgrade.tgz"
+ [ ! -f "$conf_tar" ] || nand_restore_config "$conf_tar"
}
# Recognize type of passed file and start the upgrade process
nand_do_upgrade() {
- local file_type=$(identify $1)
+ local file="$1"
- if type 'platform_nand_pre_upgrade' >/dev/null 2>/dev/null; then
- platform_nand_pre_upgrade "$1"
- fi
+ sync
+ nand_do_flash_file "$file" && nand_do_upgrade_success
+ nand_do_upgrade_failed
+}
- [ ! "$(find_mtd_index "$CI_UBIPART")" ] && CI_UBIPART="rootfs"
+nand_do_upgrade_success() {
+ if nand_do_restore_config && sync; then
+ echo "sysupgrade successful"
+ umount -a
+ reboot -f
+ fi
+ nand_do_upgrade_failed
+}
- case "$file_type" in
- "ubi") nand_upgrade_ubinized $1;;
- "ubifs") nand_upgrade_ubifs $1;;
- *) nand_upgrade_tar $1;;
- esac
+nand_do_upgrade_failed() {
+ sync
+ echo "sysupgrade failed"
+ # Should we reboot or bring up some failsafe mode instead?
+ umount -a
+ reboot -f
}
-# Check if passed file is a valid one for NAND sysupgrade. Currently it accepts
-# 3 types of files:
-# 1) UBI - should contain an ubinized image, header is checked for the proper
-# MAGIC
-# 2) UBIFS - should contain UBIFS partition that will replace "rootfs" volume,
-# header is checked for the proper MAGIC
-# 3) TAR - archive has to include "sysupgrade-BOARD" directory with a non-empty
-# "CONTROL" file (at this point its content isn't verified)
+# Check if passed file is a valid one for NAND sysupgrade.
+# Currently it accepts 4 types of files:
+# 1) UBI: a ubinized image containing required UBI volumes.
+# 2) UBIFS: a UBIFS rootfs volume image.
+# 3) FIT: a FIT image containing kernel and rootfs.
+# 4) TAR: an archive that includes directory "sysupgrade-${BOARD_NAME}" containing
+# a non-empty "CONTROL" file and required partition and/or volume images.
#
# You usually want to call this function in platform_check_image.
#
# $(2): file to be checked
nand_do_platform_check() {
local board_name="$1"
- local tar_file="$2"
- local control_length=`(tar xf $tar_file sysupgrade-$board_name/CONTROL -O | wc -c) 2> /dev/null`
- local file_type="$(identify $2)"
+ local file="$2"
- [ "$control_length" = 0 -a "$file_type" != "ubi" -a "$file_type" != "ubifs" ] && {
- echo "Invalid sysupgrade file."
- return 1
- }
+ local gz="$(identify_if_gzip "$file")"
+ local file_type="$(identify "$file" "" "$gz")"
+ local control_length=$( (tar xO${gz}f "$file" "sysupgrade-$board_name/CONTROL" | wc -c) 2> /dev/null)
+
+ if [ "$control_length" != 0 ]; then
+ nand_verify_tar_file "$file" "$gz" || return 1
+ else
+ nand_verify_if_gzip_file "$file" "$gz" || return 1
+ if [ "$file_type" != "fit" -a "$file_type" != "ubi" -a "$file_type" != "ubifs" ]; then
+ echo "invalid sysupgrade file"
+ return 1
+ fi
+ fi
return 0
}