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         local ubidev=$( nand_find_ubi "$CI_UBIPART" )
 101         local ubivol="$( nand_find_volume $ubidev rootfs_data )"
 102         if [ ! "$ubivol" ]; then
 103                 ubivol="$( nand_find_volume $ubidev "$CI_ROOTPART" )"
 104                 if [ ! "$ubivol" ]; then
 105                         echo "cannot find ubifs data volume"
 106                         return 1
 107                 fi
 108         fi
 109         mkdir /tmp/new_root
 110         if ! mount -t ubifs /dev/$ubivol /tmp/new_root; then
 111                 echo "cannot mount ubifs volume $ubivol"
 112                 rmdir /tmp/new_root
 113                 return 1
 114         fi
 115         if mv "$1" "/tmp/new_root/$BACKUP_FILE"; then
 116                 if umount /tmp/new_root; then
 117                         echo "configuration saved"
 118                         rmdir /tmp/new_root
 119                         return 0
 120                 fi
 121         else
 122                 umount /tmp/new_root
 123         fi
 124         echo "could not save configuration to ubifs volume $ubivol"
 125         rmdir /tmp/new_root
 126         return 1
 127 }
 128
 129 nand_remove_ubiblock() {
 130         local ubivol=$1
 131         local ubiblk=ubiblock${ubivol:3}
 132         if [ -e /dev/$ubiblk ]; then
 133                 echo "removing $ubiblk"
 134                 if ! ubiblock -r /dev/$ubivol; then
 135                         echo "cannot remove $ubiblk"
 136                         return 1
 137                 fi
 138         fi
 139 }
 140
 141 nand_upgrade_prepare_ubi() {
 142         local rootfs_length="$1"
 143         local rootfs_type="$2"
 144         local rootfs_data_max="$(fw_printenv -n rootfs_data_max 2>/dev/null)"
 145         [ -n "$rootfs_data_max" ] && rootfs_data_max=$((rootfs_data_max))
 146
 147         local kernel_length="$3"
 148         local has_env="${4:-0}"
 149
 150         [ -n "$rootfs_length" -o -n "$kernel_length" ] || return 1
 151
 152         local mtdnum="$( find_mtd_index "$CI_UBIPART" )"
 153         if [ ! "$mtdnum" ]; then
 154                 echo "cannot find ubi mtd partition $CI_UBIPART"
 155                 return 1
 156         fi
 157
 158         local ubidev="$( nand_find_ubi "$CI_UBIPART" )"
 159         if [ ! "$ubidev" ]; then
 160                 ubiattach -m "$mtdnum"
 161                 ubidev="$( nand_find_ubi "$CI_UBIPART" )"
 162
 163                 if [ ! "$ubidev" ]; then
 164                         ubiformat /dev/mtd$mtdnum -y
 165                         ubiattach -m "$mtdnum"
 166                         ubidev="$( nand_find_ubi "$CI_UBIPART" )"
 167
 168                         if [ ! "$ubidev" ]; then
 169                                 echo "cannot attach ubi mtd partition $CI_UBIPART"
 170                                 return 1
 171                         fi
 172
 173                         if [ "$has_env" -gt 0 ]; then
 174                                 ubimkvol /dev/$ubidev -n 0 -N ubootenv -s 1MiB
 175                                 ubimkvol /dev/$ubidev -n 1 -N ubootenv2 -s 1MiB
 176                         fi
 177                 fi
 178         fi
 179
 180         local kern_ubivol="$( nand_find_volume $ubidev "$CI_KERNPART" )"
 181         local root_ubivol="$( nand_find_volume $ubidev "$CI_ROOTPART" )"
 182         local data_ubivol="$( nand_find_volume $ubidev rootfs_data )"
 183         [ "$root_ubivol" = "$kern_ubivol" ] && root_ubivol=
 184
 185         # remove ubiblocks
 186         [ "$kern_ubivol" ] && { nand_remove_ubiblock $kern_ubivol || return 1; }
 187         [ "$root_ubivol" ] && { nand_remove_ubiblock $root_ubivol || return 1; }
 188         [ "$data_ubivol" ] && { nand_remove_ubiblock $data_ubivol || return 1; }
 189
 190         # kill volumes
 191         [ "$kern_ubivol" ] && ubirmvol /dev/$ubidev -N "$CI_KERNPART" || :
 192         [ "$root_ubivol" ] && ubirmvol /dev/$ubidev -N "$CI_ROOTPART" || :
 193         [ "$data_ubivol" ] && ubirmvol /dev/$ubidev -N rootfs_data || :
 194
 195         # create kernel vol
 196         if [ -n "$kernel_length" ]; then
 197                 if ! ubimkvol /dev/$ubidev -N "$CI_KERNPART" -s $kernel_length; then
 198                         echo "cannot create kernel volume"
 199                         return 1;
 200                 fi
 201         fi
 202
 203         # create rootfs vol
 204         if [ -n "$rootfs_length" ]; then
 205                 local rootfs_size_param
 206                 if [ "$rootfs_type" = "ubifs" ]; then
 207                         rootfs_size_param="-m"
 208                 else
 209                         rootfs_size_param="-s $rootfs_length"
 210                 fi
 211                 if ! ubimkvol /dev/$ubidev -N "$CI_ROOTPART" $rootfs_size_param; then
 212                         echo "cannot create rootfs volume"
 213                         return 1;
 214                 fi
 215         fi
 216
 217         # create rootfs_data vol for non-ubifs rootfs
 218         if [ "$rootfs_type" != "ubifs" ]; then
 219                 local rootfs_data_size_param="-m"
 220                 if [ -n "$rootfs_data_max" ]; then
 221                         rootfs_data_size_param="-s $rootfs_data_max"
 222                 fi
 223                 if ! ubimkvol /dev/$ubidev -N rootfs_data $rootfs_data_size_param; then
 224                         if ! ubimkvol /dev/$ubidev -N rootfs_data -m; then
 225                                 echo "cannot initialize rootfs_data volume"
 226                                 return 1
 227                         fi
 228                 fi
 229         fi
 230
 231         return 0
 232 }
 233
 234 nand_do_upgrade_success() {
 235         local conf_tar="/tmp/sysupgrade.tgz"
 236         if { [ ! -f "$conf_tar" ] || nand_restore_config "$conf_tar"; } && sync; then
 237                 echo "sysupgrade successful"
 238         fi
 239         umount -a
 240         reboot -f
 241 }
 242
 243 # Flash the UBI image to MTD partition
 244 nand_upgrade_ubinized() {
 245         local ubi_file="$1"
 246         local mtdnum="$(find_mtd_index "$CI_UBIPART")"
 247
 248         if [ ! "$mtdnum" ]; then
 249                 echo "cannot find mtd device $CI_UBIPART"
 250                 umount -a
 251                 reboot -f
 252         fi
 253
 254         local mtddev="/dev/mtd${mtdnum}"
 255         ubidetach -p "${mtddev}" || :
 256         ubiformat "${mtddev}" -y -f "${ubi_file}"
 257         ubiattach -p "${mtddev}"
 258
 259         nand_do_upgrade_success
 260 }
 261
 262 # Write the UBIFS image to UBI volume
 263 nand_upgrade_ubifs() {
 264         local rootfs_length=$( (cat $1 | wc -c) 2> /dev/null)
 265
 266         nand_upgrade_prepare_ubi "$rootfs_length" "ubifs" "" ""
 267
 268         local ubidev="$( nand_find_ubi "$CI_UBIPART" )"
 269         local root_ubivol="$(nand_find_volume $ubidev "$CI_ROOTPART")"
 270         ubiupdatevol /dev/$root_ubivol -s $rootfs_length $1
 271
 272         nand_do_upgrade_success
 273 }
 274
 275 nand_upgrade_fit() {
 276         local fit_file="$1"
 277         local fit_length="$(wc -c < "$fit_file")"
 278
 279         nand_upgrade_prepare_ubi "" "" "$fit_length" "1"
 280
 281         local fit_ubidev="$(nand_find_ubi "$CI_UBIPART")"
 282         local fit_ubivol="$(nand_find_volume $fit_ubidev "$CI_KERNPART")"
 283         ubiupdatevol /dev/$fit_ubivol -s $fit_length $fit_file
 284
 285         nand_do_upgrade_success
 286 }
 287
 288 nand_upgrade_tar() {
 289         local tar_file="$1"
 290
 291         local board_dir="$(tar tf "$tar_file" | grep -m 1 '^sysupgrade-.*/$')"
 292         board_dir="${board_dir%/}"
 293
 294         local kernel_mtd kernel_length
 295         if [ "$CI_KERNPART" != "none" ]; then
 296                 kernel_mtd="$(find_mtd_index "$CI_KERNPART")"
 297                 kernel_length=$( (tar xf "$tar_file" "$board_dir/kernel" -O | wc -c) 2> /dev/null)
 298                 [ "$kernel_length" = 0 ] && kernel_length=
 299         fi
 300         local rootfs_length=$( (tar xf "$tar_file" "$board_dir/root" -O | wc -c) 2> /dev/null)
 301         [ "$rootfs_length" = 0 ] && rootfs_length=
 302         local rootfs_type
 303         [ "$rootfs_length" ] && rootfs_type="$(identify_tar "$tar_file" "$board_dir/root")"
 304
 305         local ubi_kernel_length
 306         if [ "$kernel_length" ]; then
 307                 if [ "$kernel_mtd" ]; then
 308                         # On some devices, the raw kernel and ubi partitions overlap.
 309                         # These devices brick if the kernel partition is erased.
 310                         # Hence only invalidate kernel for now.
 311                         dd if=/dev/zero bs=4096 count=1 2>/dev/null | \
 312                                 mtd write - "$CI_KERNPART"
 313                 else
 314                         ubi_kernel_length="$kernel_length"
 315                 fi
 316         fi
 317         local has_env=0
 318         nand_upgrade_prepare_ubi "$rootfs_length" "$rootfs_type" "$ubi_kernel_length" "$has_env"
 319
 320         local ubidev="$( nand_find_ubi "$CI_UBIPART" )"
 321         if [ "$rootfs_length" ]; then
 322                 local root_ubivol="$( nand_find_volume $ubidev "$CI_ROOTPART" )"
 323                 tar xf "$tar_file" "$board_dir/root" -O | \
 324                         ubiupdatevol /dev/$root_ubivol -s $rootfs_length -
 325         fi
 326         if [ "$kernel_length" ]; then
 327                 if [ "$kernel_mtd" ]; then
 328                         tar xf "$tar_file" "$board_dir/kernel" -O | \
 329                                 mtd write - "$CI_KERNPART"
 330                 else
 331                         local kern_ubivol="$( nand_find_volume $ubidev "$CI_KERNPART" )"
 332                         tar xf "$tar_file" "$board_dir/kernel" -O | \
 333                                 ubiupdatevol /dev/$kern_ubivol -s $kernel_length -
 334                 fi
 335         fi
 336
 337         nand_do_upgrade_success
 338 }
 339
 340 # Recognize type of passed file and start the upgrade process
 341 nand_do_upgrade() {
 342         local file_type=$(identify "$1")
 343
 344         [ ! "$(find_mtd_index "$CI_UBIPART")" ] && CI_UBIPART=rootfs
 345
 346         sync
 347         case "$file_type" in
 348                 "fit")          nand_upgrade_fit "$1";;
 349                 "ubi")          nand_upgrade_ubinized "$1";;
 350                 "ubifs")        nand_upgrade_ubifs "$1";;
 351                 *)              nand_upgrade_tar "$1";;
 352         esac
 353 }
 354
 355 # Check if passed file is a valid one for NAND sysupgrade. Currently it accepts
 356 # 3 types of files:
 357 # 1) UBI - should contain an ubinized image, header is checked for the proper
 358 #    MAGIC
 359 # 2) UBIFS - should contain UBIFS partition that will replace "rootfs" volume,
 360 #    header is checked for the proper MAGIC
 361 # 3) TAR - archive has to include "sysupgrade-BOARD" directory with a non-empty
 362 #    "CONTROL" file (at this point its content isn't verified)
 363 #
 364 # You usually want to call this function in platform_check_image.
 365 #
 366 # $(1): board name, used in case of passing TAR file
 367 # $(2): file to be checked
 368 nand_do_platform_check() {
 369         local board_name="$1"
 370         local tar_file="$2"
 371         local control_length=$( (tar xf $tar_file sysupgrade-$board_name/CONTROL -O | wc -c) 2> /dev/null)
 372         local file_type="$(identify $2)"
 373
 374         [ "$control_length" = 0 -a "$file_type" != "ubi" -a "$file_type" != "ubifs" -a "$file_type" != "fit" ] && {
 375                 echo "Invalid sysupgrade file."
 376                 return 1
 377         }
 378
 379         return 0
 380 }