base-files: improve sysupgrade ubiblock handling
[openwrt/openwrt.git] / package / base-files / files / lib / upgrade / nand.sh
index 42f488c118fab514de7d2aee78bc431f7b8be157..ec1335cb2c94859d1444b0c6fa50dbff2efc2c2a 100644 (file)
@@ -1,15 +1,17 @@
-#!/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
 CI_UBIPART="${CI_UBIPART:-ubi}"
 
+# 'rootfs' UBI volume on NAND contains the rootfs
+CI_ROOTPART="${CI_ROOTPART:-rootfs}"
+
 ubi_mknod() {
        local dir="$1"
        local dev="/dev/$(basename $dir)"
@@ -99,25 +101,42 @@ nand_restore_config() {
        local ubidev=$( nand_find_ubi $CI_UBIPART )
        local ubivol="$( nand_find_volume $ubidev rootfs_data )"
        [ ! "$ubivol" ] &&
-               ubivol="$( nand_find_volume $ubidev rootfs )"
+               ubivol="$( nand_find_volume $ubidev $CI_ROOTPART )"
        mkdir /tmp/new_root
        if ! mount -t ubifs /dev/$ubivol /tmp/new_root; then
                echo "mounting ubifs $ubivol failed"
                rmdir /tmp/new_root
                return 1
        fi
-       mv "$1" "/tmp/new_root/sysupgrade.tgz"
+       mv "$1" "/tmp/new_root/$BACKUP_FILE"
        umount /tmp/new_root
        sync
        rmdir /tmp/new_root
 }
 
+nand_remove_ubiblock() {
+       local ubivol=$1
+       local ubiblk=ubiblock${ubivol:3}
+       if [ -e /dev/$ubiblk ]; then
+               echo "removing $ubiblk"
+               if ! ubiblock -r /dev/$ubivol; then
+                       echo "cannot remove $ubiblk"
+                       return 1
+               fi
+       fi
+}
+
 nand_upgrade_prepare_ubi() {
        local rootfs_length="$1"
        local rootfs_type="$2"
-       local has_kernel="${3:-0}"
+       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}"
 
+       [ -n "$rootfs_length" -o -n "$kernel_length" ] || return 1
+
        local mtdnum="$( find_mtd_index "$CI_UBIPART" )"
        if [ ! "$mtdnum" ]; then
                echo "cannot find ubi mtd partition $CI_UBIPART"
@@ -129,40 +148,42 @@ nand_upgrade_prepare_ubi() {
                ubiattach -m "$mtdnum"
                sync
                ubidev="$( nand_find_ubi "$CI_UBIPART" )"
-       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
-               }
+               if [ ! "$ubidev" ]; then
+                       ubiformat /dev/mtd$mtdnum -y
+                       ubiattach -m "$mtdnum"
+                       sync
+                       ubidev="$( nand_find_ubi "$CI_UBIPART" )"
+
+                       if [ ! "$ubidev" ]; then
+                               echo "cannot attach ubi mtd partition $CI_UBIPART"
+                               return 1
+                       fi
+
+                       if [ "$has_env" -gt 0 ]; then
+                               ubimkvol /dev/$ubidev -n 0 -N ubootenv -s 1MiB
+                               ubimkvol /dev/$ubidev -n 1 -N ubootenv2 -s 1MiB
+                       fi
+               fi
        fi
 
        local kern_ubivol="$( nand_find_volume $ubidev $CI_KERNPART )"
-       local root_ubivol="$( nand_find_volume $ubidev rootfs )"
+       local root_ubivol="$( nand_find_volume $ubidev $CI_ROOTPART )"
        local data_ubivol="$( nand_find_volume $ubidev rootfs_data )"
+       [ "$root_ubivol" = "$kern_ubivol" ] && root_ubivol=
 
-       # 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;
-               fi
-       fi
+       # 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 rootfs || true
-       [ "$data_ubivol" ] && ubirmvol /dev/$ubidev -N rootfs_data || true
+       [ "$kern_ubivol" ] && ubirmvol /dev/$ubidev -N $CI_KERNPART || :
+       [ "$root_ubivol" ] && ubirmvol /dev/$ubidev -N $CI_ROOTPART || :
+       [ "$data_ubivol" ] && ubirmvol /dev/$ubidev -N rootfs_data || :
 
        # update kernel
-       if [ "$has_kernel" = "1" ]; then
+       if [ -n "$kernel_length" ]; then
                if ! ubimkvol /dev/$ubidev -N $CI_KERNPART -s $kernel_length; then
                        echo "cannot create kernel volume"
                        return 1;
@@ -170,22 +191,30 @@ nand_upgrade_prepare_ubi() {
        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 rootfs $root_size_param; then
-               echo "cannot create rootfs volume"
-               return 1;
+       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/$ubidev -N $CI_ROOTPART $rootfs_size_param; then
+                       echo "cannot create rootfs volume"
+                       return 1;
+               fi
        fi
 
        # create rootfs_data 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/$ubidev -N rootfs_data $rootfs_data_size_param; then
+                       if ! ubimkvol /dev/$ubidev -N rootfs_data -m; then
+                               echo "cannot initialize rootfs_data volume"
+                               return 1
+                       fi
                fi
        fi
        sync
@@ -228,73 +257,82 @@ nand_upgrade_ubinized() {
 
 # Write the UBIFS image to UBI volume
 nand_upgrade_ubifs() {
-       local rootfs_length=`(cat $1 | wc -c) 2> /dev/null`
+       local rootfs_length=$( (cat $1 | wc -c) 2> /dev/null)
 
-       nand_upgrade_prepare_ubi "$rootfs_length" "ubifs" "0" "0"
+       nand_upgrade_prepare_ubi "$rootfs_length" "ubifs" "" ""
 
        local ubidev="$( nand_find_ubi "$CI_UBIPART" )"
-       local root_ubivol="$(nand_find_volume $ubidev rootfs)"
+       local root_ubivol="$(nand_find_volume $ubidev $CI_ROOTPART)"
        ubiupdatevol /dev/$root_ubivol -s $rootfs_length $1
 
        nand_do_upgrade_success
 }
 
+nand_upgrade_fit() {
+       local fit_file="$1"
+       local fit_length="$(wc -c < "$fit_file")"
+
+       nand_upgrade_prepare_ubi "" "" "$fit_length" "1"
+
+       local fit_ubidev="$(nand_find_ubi "$CI_UBIPART")"
+       local fit_ubivol="$(nand_find_volume $fit_ubidev "$CI_KERNPART")"
+       ubiupdatevol /dev/$fit_ubivol -s $fit_length $fit_file
+
+       nand_do_upgrade_success
+}
+
 nand_upgrade_tar() {
        local tar_file="$1"
        local kernel_mtd="$(find_mtd_index $CI_KERNPART)"
 
-       local board_dir=$(tar tf $tar_file | grep -m 1 '^sysupgrade-.*/$')
+       local board_dir=$(tar tf "$tar_file" | grep -m 1 '^sysupgrade-.*/$')
        board_dir=${board_dir%/}
 
-       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`
+       kernel_length=$( (tar xf "$tar_file" ${board_dir}/kernel -O | wc -c) 2> /dev/null)
+       local has_rootfs=0
+       local rootfs_length
+       local rootfs_type
 
-       local rootfs_type="$(identify_tar "$tar_file" ${board_dir}/root)"
+       tar tf "$tar_file" ${board_dir}/root 1>/dev/null 2>/dev/null && has_rootfs=1
+       [ "$has_rootfs" = "1" ] && {
+               rootfs_length=$( (tar xf "$tar_file" ${board_dir}/root -O | wc -c) 2> /dev/null)
+               rootfs_type="$(identify_tar "$tar_file" ${board_dir}/root)"
+       }
 
        local has_kernel=1
        local has_env=0
 
        [ "$kernel_length" != 0 -a -n "$kernel_mtd" ] && {
-               tar xf $tar_file ${board_dir}/kernel -O | mtd write - $CI_KERNPART
+               tar xf "$tar_file" ${board_dir}/kernel -O | mtd write - $CI_KERNPART
        }
-       [ "$kernel_length" = 0 -o ! -z "$kernel_mtd" ] && has_kernel=0
+       [ "$kernel_length" = 0 -o ! -z "$kernel_mtd" ] && has_kernel=
+       [ "$CI_KERNPART" = "none" ] && has_kernel=
 
-       nand_upgrade_prepare_ubi "$rootfs_length" "$rootfs_type" "$has_kernel" "$has_env"
+       nand_upgrade_prepare_ubi "$rootfs_length" "$rootfs_type" "${has_kernel:+$kernel_length}" "$has_env"
 
        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 | \
+               local kern_ubivol="$( nand_find_volume $ubidev $CI_KERNPART )"
+               tar xf "$tar_file" ${board_dir}/kernel -O | \
                        ubiupdatevol /dev/$kern_ubivol -s $kernel_length -
        }
 
-       local root_ubivol="$(nand_find_volume $ubidev rootfs)"
-       tar xf $tar_file ${board_dir}/root -O | \
-               ubiupdatevol /dev/$root_ubivol -s $rootfs_length -
-
+       [ "$has_rootfs" = "1" ] && {
+               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_upgrade_success
 }
 
 # Recognize type of passed file and start the upgrade process
 nand_do_upgrade() {
-       if [ -n "$IS_PRE_UPGRADE" ]; then
-               # Previously, nand_do_upgrade was called from the platform_pre_upgrade
-               # hook; this piece of code handles scripts that haven't been
-               # updated. All scripts should gradually move to call nand_do_upgrade
-               # from platform_do_upgrade instead.
-               export do_upgrade="nand_do_upgrade '$1'"
-               return
-       fi
-
        local file_type=$(identify $1)
 
-       if type 'platform_nand_pre_upgrade' >/dev/null 2>/dev/null; then
-               platform_nand_pre_upgrade "$1"
-       fi
-
        [ ! "$(find_mtd_index "$CI_UBIPART")" ] && CI_UBIPART="rootfs"
 
        case "$file_type" in
+               "fit")          nand_upgrade_fit $1;;
                "ubi")          nand_upgrade_ubinized $1;;
                "ubifs")        nand_upgrade_ubifs $1;;
                *)              nand_upgrade_tar $1;;
@@ -317,10 +355,10 @@ nand_do_upgrade() {
 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 control_length=$( (tar xf $tar_file sysupgrade-$board_name/CONTROL -O | wc -c) 2> /dev/null)
        local file_type="$(identify $2)"
 
-       [ "$control_length" = 0 -a "$file_type" != "ubi" -a "$file_type" != "ubifs" ] && {
+       [ "$control_length" = 0 -a "$file_type" != "ubi" -a "$file_type" != "ubifs" -a "$file_type" != "fit" ] && {
                echo "Invalid sysupgrade file."
                return 1
        }