package/base-files/files/lib/upgrade/nand.sh

   1 # Copyright (C) 2014 OpenWrt.org
   2 #
   3
   4 . /lib/functions.sh
   5
   6 # 'kernel' partition or UBI volume on NAND contains the kernel
   7 CI_KERNPART="${CI_KERNPART:-kernel}"
   8
   9 # 'ubi' partition on NAND contains UBI
  10 CI_UBIPART="${CI_UBIPART:-ubi}"
  11
  12 # 'rootfs' UBI volume on NAND contains the rootfs
  13 CI_ROOTPART="${CI_ROOTPART:-rootfs}"
  14
  15 ubi_mknod() {
  16         local dir="$1"
  17         local dev="/dev/$(basename $dir)"
  18
  19         [ -e "$dev" ] && return 0
  20
  21         local devid="$(cat $dir/dev)"
  22         local major="${devid%%:*}"
  23         local minor="${devid##*:}"
  24         mknod "$dev" c $major $minor
  25 }
  26
  27 nand_find_volume() {
  28         local ubidevdir ubivoldir
  29         ubidevdir="/sys/devices/virtual/ubi/$1"
  30         [ ! -d "$ubidevdir" ] && return 1
  31         for ubivoldir in $ubidevdir/${1}_*; do
  32                 [ ! -d "$ubivoldir" ] && continue
  33                 if [ "$( cat $ubivoldir/name )" = "$2" ]; then
  34                         basename $ubivoldir
  35                         ubi_mknod "$ubivoldir"
  36                         return 0
  37                 fi
  38         done
  39 }
  40
  41 nand_find_ubi() {
  42         local ubidevdir ubidev mtdnum
  43         mtdnum="$( find_mtd_index $1 )"
  44         [ ! "$mtdnum" ] && return 1
  45         for ubidevdir in /sys/devices/virtual/ubi/ubi*; do
  46                 [ ! -d "$ubidevdir" ] && continue
  47                 cmtdnum="$( cat $ubidevdir/mtd_num )"
  48                 [ ! "$mtdnum" ] && continue
  49                 if [ "$mtdnum" = "$cmtdnum" ]; then
  50                         ubidev=$( basename $ubidevdir )
  51                         ubi_mknod "$ubidevdir"
  52                         echo $ubidev
  53                         return 0
  54                 fi
  55         done
  56 }
  57
  58 nand_get_magic_long() {
  59         dd if="$1" skip=$2 bs=4 count=1 2>/dev/null | hexdump -v -n 4 -e '1/1 "%02x"'
  60 }
  61
  62 get_magic_long_tar() {
  63         ( tar xf $1 $2 -O | dd bs=4 count=1 | hexdump -v -n 4 -e '1/1 "%02x"') 2> /dev/null
  64 }
  65
  66 identify_magic() {
  67         local magic=$1
  68         case "$magic" in
  69                 "55424923")
  70                         echo "ubi"
  71                         ;;
  72                 "31181006")
  73                         echo "ubifs"
  74                         ;;
  75                 "68737173")
  76                         echo "squashfs"
  77                         ;;
  78                 "d00dfeed")
  79                         echo "fit"
  80                         ;;
  81                 "4349"*)
  82                         echo "combined"
  83                         ;;
  84                 *)
  85                         echo "unknown $magic"
  86                         ;;
  87         esac
  88 }
  89
  90
  91 identify() {
  92         identify_magic $(nand_get_magic_long "$1" "${2:-0}")
  93 }
  94
  95 identify_tar() {
  96         identify_magic $(get_magic_long_tar "$1" "$2")
  97 }
  98
  99 nand_restore_config() {
 100         sync
 101         local ubidev=$( nand_find_ubi $CI_UBIPART )
 102         local ubivol="$( nand_find_volume $ubidev rootfs_data )"
 103         [ ! "$ubivol" ] &&
 104                 ubivol="$( nand_find_volume $ubidev $CI_ROOTPART )"
 105         mkdir /tmp/new_root
 106         if ! mount -t ubifs /dev/$ubivol /tmp/new_root; then
 107                 echo "mounting ubifs $ubivol failed"
 108                 rmdir /tmp/new_root
 109                 return 1
 110         fi
 111         mv "$1" "/tmp/new_root/$BACKUP_FILE"
 112         umount /tmp/new_root
 113         sync
 114         rmdir /tmp/new_root
 115 }
 116
 117 nand_upgrade_prepare_ubi() {
 118         local rootfs_length="$1"
 119         local rootfs_type="$2"
 120         local rootfs_data_max="$(fw_printenv -n rootfs_data_max 2>/dev/null)"
 121         [ -n "$rootfs_data_max" ] && rootfs_data_max=$(($rootfs_data_max))
 122
 123         local kernel_length="$3"
 124         local has_env="${4:-0}"
 125
 126         [ -n "$rootfs_length" -o -n "$kernel_length" ] || return 1
 127
 128         local mtdnum="$( find_mtd_index "$CI_UBIPART" )"
 129         if [ ! "$mtdnum" ]; then
 130                 echo "cannot find ubi mtd partition $CI_UBIPART"
 131                 return 1
 132         fi
 133
 134         local ubidev="$( nand_find_ubi "$CI_UBIPART" )"
 135         if [ ! "$ubidev" ]; then
 136                 ubiattach -m "$mtdnum"
 137                 sync
 138                 ubidev="$( nand_find_ubi "$CI_UBIPART" )"
 139         fi
 140
 141         if [ ! "$ubidev" ]; then
 142                 ubiformat /dev/mtd$mtdnum -y
 143                 ubiattach -m "$mtdnum"
 144                 sync
 145                 ubidev="$( nand_find_ubi "$CI_UBIPART" )"
 146                 [ "$has_env" -gt 0 ] && {
 147                         ubimkvol /dev/$ubidev -n 0 -N ubootenv -s 1MiB
 148                         ubimkvol /dev/$ubidev -n 1 -N ubootenv2 -s 1MiB
 149                 }
 150         fi
 151
 152         local kern_ubivol="$( nand_find_volume $ubidev $CI_KERNPART )"
 153         local root_ubivol="$( nand_find_volume $ubidev $CI_ROOTPART )"
 154         local data_ubivol="$( nand_find_volume $ubidev rootfs_data )"
 155
 156         local ubiblk ubiblkvol
 157         for ubiblk in /dev/ubiblock*_? ; do
 158                 [ -e "$ubiblk" ] || continue
 159                 echo "removing ubiblock${ubiblk:13}"
 160                 ubiblkvol=ubi${ubiblk:13}
 161                 if ! ubiblock -r /dev/$ubiblkvol; then
 162                         echo "cannot remove $ubiblk"
 163                         return 1
 164                 fi
 165         done
 166
 167         # kill volumes
 168         [ "$kern_ubivol" ] && ubirmvol /dev/$ubidev -N $CI_KERNPART || true
 169         [ "$root_ubivol" -a "$root_ubivol" != "$kern_ubivol" ] && ubirmvol /dev/$ubidev -N $CI_ROOTPART || true
 170         [ "$data_ubivol" ] && ubirmvol /dev/$ubidev -N rootfs_data || true
 171
 172         # update kernel
 173         if [ -n "$kernel_length" ]; then
 174                 if ! ubimkvol /dev/$ubidev -N $CI_KERNPART -s $kernel_length; then
 175                         echo "cannot create kernel volume"
 176                         return 1;
 177                 fi
 178         fi
 179
 180         # update rootfs
 181         if [ -n "$rootfs_length" ]; then
 182                 local rootfs_size_param
 183                 if [ "$rootfs_type" = "ubifs" ]; then
 184                         rootfs_size_param="-m"
 185                 else
 186                         rootfs_size_param="-s $rootfs_length"
 187                 fi
 188                 if ! ubimkvol /dev/$ubidev -N $CI_ROOTPART $rootfs_size_param; then
 189                         echo "cannot create rootfs volume"
 190                         return 1;
 191                 fi
 192         fi
 193
 194         # create rootfs_data for non-ubifs rootfs
 195         if [ "$rootfs_type" != "ubifs" ]; then
 196                 local availeb=$(cat /sys/devices/virtual/ubi/$ubidev/avail_eraseblocks)
 197                 local ebsize=$(cat /sys/devices/virtual/ubi/$ubidev/eraseblock_size)
 198                 local avail_size=$(( $availeb * $ebsize ))
 199                 local rootfs_data_size_param="-m"
 200                 if [ -n "$rootfs_data_max" ] &&
 201                    [ "$rootfs_data_max" != "0" ] &&
 202                    [ "$rootfs_data_max" -le "$avail_size" ]; then
 203                         rootfs_data_size_param="-s $rootfs_data_max"
 204                 fi
 205                 if ! ubimkvol /dev/$ubidev -N rootfs_data $rootfs_data_size_param; then
 206                         echo "cannot initialize rootfs_data volume"
 207                         return 1
 208                 fi
 209         fi
 210         sync
 211         return 0
 212 }
 213
 214 nand_do_upgrade_success() {
 215         local conf_tar="/tmp/sysupgrade.tgz"
 216
 217         sync
 218         [ -f "$conf_tar" ] && nand_restore_config "$conf_tar"
 219         echo "sysupgrade successful"
 220         umount -a
 221         reboot -f
 222 }
 223
 224 # Flash the UBI image to MTD partition
 225 nand_upgrade_ubinized() {
 226         local ubi_file="$1"
 227         local mtdnum="$(find_mtd_index "$CI_UBIPART")"
 228
 229         [ ! "$mtdnum" ] && {
 230                 CI_UBIPART="rootfs"
 231                 mtdnum="$(find_mtd_index "$CI_UBIPART")"
 232         }
 233
 234         if [ ! "$mtdnum" ]; then
 235                 echo "cannot find mtd device $CI_UBIPART"
 236                 umount -a
 237                 reboot -f
 238         fi
 239
 240         local mtddev="/dev/mtd${mtdnum}"
 241         ubidetach -p "${mtddev}" || true
 242         sync
 243         ubiformat "${mtddev}" -y -f "${ubi_file}"
 244         ubiattach -p "${mtddev}"
 245         nand_do_upgrade_success
 246 }
 247
 248 # Write the UBIFS image to UBI volume
 249 nand_upgrade_ubifs() {
 250         local rootfs_length=$( (cat $1 | wc -c) 2> /dev/null)
 251
 252         nand_upgrade_prepare_ubi "$rootfs_length" "ubifs" "" ""
 253
 254         local ubidev="$( nand_find_ubi "$CI_UBIPART" )"
 255         local root_ubivol="$(nand_find_volume $ubidev $CI_ROOTPART)"
 256         ubiupdatevol /dev/$root_ubivol -s $rootfs_length $1
 257
 258         nand_do_upgrade_success
 259 }
 260
 261 nand_upgrade_fit() {
 262         local fit_file="$1"
 263         local fit_length="$(wc -c < "$fit_file")"
 264
 265         nand_upgrade_prepare_ubi "" "" "$fit_length" "1"
 266
 267         local fit_ubidev="$(nand_find_ubi "$CI_UBIPART")"
 268         local fit_ubivol="$(nand_find_volume $fit_ubidev "$CI_KERNPART")"
 269         ubiupdatevol /dev/$fit_ubivol -s $fit_length $fit_file
 270
 271         nand_do_upgrade_success
 272 }
 273
 274 nand_upgrade_tar() {
 275         local tar_file="$1"
 276         local kernel_mtd="$(find_mtd_index $CI_KERNPART)"
 277
 278         local board_dir=$(tar tf "$tar_file" | grep -m 1 '^sysupgrade-.*/$')
 279         board_dir=${board_dir%/}
 280
 281         kernel_length=$( (tar xf "$tar_file" ${board_dir}/kernel -O | wc -c) 2> /dev/null)
 282         local has_rootfs=0
 283         local rootfs_length
 284         local rootfs_type
 285
 286         tar tf "$tar_file" ${board_dir}/root 1>/dev/null 2>/dev/null && has_rootfs=1
 287         [ "$has_rootfs" = "1" ] && {
 288                 rootfs_length=$( (tar xf "$tar_file" ${board_dir}/root -O | wc -c) 2> /dev/null)
 289                 rootfs_type="$(identify_tar "$tar_file" ${board_dir}/root)"
 290         }
 291
 292         local has_kernel=1
 293         local has_env=0
 294
 295         [ "$kernel_length" != 0 -a -n "$kernel_mtd" ] && {
 296                 tar xf "$tar_file" ${board_dir}/kernel -O | mtd write - $CI_KERNPART
 297         }
 298         [ "$kernel_length" = 0 -o ! -z "$kernel_mtd" ] && has_kernel=
 299
 300         nand_upgrade_prepare_ubi "$rootfs_length" "$rootfs_type" "${has_kernel:+$kernel_length}" "$has_env"
 301
 302         local ubidev="$( nand_find_ubi "$CI_UBIPART" )"
 303         [ "$has_kernel" = "1" ] && {
 304                 local kern_ubivol="$( nand_find_volume $ubidev $CI_KERNPART )"
 305                 tar xf "$tar_file" ${board_dir}/kernel -O | \
 306                         ubiupdatevol /dev/$kern_ubivol -s $kernel_length -
 307         }
 308
 309         [ "$has_rootfs" = "1" ] && {
 310                 local root_ubivol="$( nand_find_volume $ubidev $CI_ROOTPART )"
 311                 tar xf "$tar_file" ${board_dir}/root -O | \
 312                         ubiupdatevol /dev/$root_ubivol -s $rootfs_length -
 313         }
 314         nand_do_upgrade_success
 315 }
 316
 317 # Recognize type of passed file and start the upgrade process
 318 nand_do_upgrade() {
 319         local file_type=$(identify $1)
 320
 321         [ ! "$(find_mtd_index "$CI_UBIPART")" ] && CI_UBIPART="rootfs"
 322
 323         case "$file_type" in
 324                 "fit")          nand_upgrade_fit $1;;
 325                 "ubi")          nand_upgrade_ubinized $1;;
 326                 "ubifs")        nand_upgrade_ubifs $1;;
 327                 *)              nand_upgrade_tar $1;;
 328         esac
 329 }
 330
 331 # Check if passed file is a valid one for NAND sysupgrade. Currently it accepts
 332 # 3 types of files:
 333 # 1) UBI - should contain an ubinized image, header is checked for the proper
 334 #    MAGIC
 335 # 2) UBIFS - should contain UBIFS partition that will replace "rootfs" volume,
 336 #    header is checked for the proper MAGIC
 337 # 3) TAR - archive has to include "sysupgrade-BOARD" directory with a non-empty
 338 #    "CONTROL" file (at this point its content isn't verified)
 339 #
 340 # You usually want to call this function in platform_check_image.
 341 #
 342 # $(1): board name, used in case of passing TAR file
 343 # $(2): file to be checked
 344 nand_do_platform_check() {
 345         local board_name="$1"
 346         local tar_file="$2"
 347         local control_length=$( (tar xf $tar_file sysupgrade-$board_name/CONTROL -O | wc -c) 2> /dev/null)
 348         local file_type="$(identify $2)"
 349
 350         [ "$control_length" = 0 -a "$file_type" != "ubi" -a "$file_type" != "ubifs" -a "$file_type" != "fit" ] && {
 351                 echo "Invalid sysupgrade file."
 352                 return 1
 353         }
 354
 355         return 0
 356 }