1 # Copyright (C) 2014 OpenWrt.org
6 # 'kernel' partition or UBI volume on NAND contains the kernel
7 CI_KERNPART
="${CI_KERNPART:-kernel}"
9 # 'ubi' partition on NAND contains UBI
10 # There are also CI_KERN_UBIPART and CI_ROOT_UBIPART if kernel
11 # and rootfs are on separated UBIs.
12 CI_UBIPART
="${CI_UBIPART:-ubi}"
14 # 'rootfs' UBI volume on NAND contains the rootfs
15 CI_ROOTPART
="${CI_ROOTPART:-rootfs}"
19 local dev
="/dev/$(basename $dir)"
21 [ -e "$dev" ] && return 0
23 local devid
="$(cat $dir/dev)"
24 local major
="${devid%%:*}"
25 local minor
="${devid##*:}"
26 mknod
"$dev" c
$major $minor
30 local ubidevdir ubivoldir
31 ubidevdir
="/sys/class/ubi/"
32 [ ! -d "$ubidevdir" ] && return 1
33 for ubivoldir
in $ubidevdir/${1}_
*; do
34 [ ! -d "$ubivoldir" ] && continue
35 if [ "$( cat $ubivoldir/name )" = "$2" ]; then
37 ubi_mknod
"$ubivoldir"
44 local ubidevdir ubidev mtdnum cmtdnum
45 mtdnum
="$( find_mtd_index $1 )"
46 [ ! "$mtdnum" ] && return 1
47 for ubidevdir
in /sys
/class
/ubi
/ubi
*; do
48 [ ! -e "$ubidevdir/mtd_num" ] && continue
49 cmtdnum
="$( cat $ubidevdir/mtd_num )"
50 if [ "$mtdnum" = "$cmtdnum" ]; then
51 ubidev
=$
( basename $ubidevdir )
52 ubi_mknod
"$ubidevdir"
59 nand_get_magic_long
() {
60 (${3}cat "$1" |
dd bs
=4 "skip=${2:-0}" count
=1 |
hexdump -v -n 4 -e '1/1 "%02x"') 2> /dev
/null
63 get_magic_long_tar
() {
64 (tar xO
${3}f
"$1" "$2" |
dd bs
=4 count
=1 |
hexdump -v -n 4 -e '1/1 "%02x"') 2> /dev
/null
68 identify_magic_long $
(nand_get_magic_long
"$@")
72 identify_magic_long $
(get_magic_long_tar
"$@")
76 if [ "$(identify "$1")" = gzip ]; then echo -n z
; fi
79 nand_restore_config
() {
80 local ubidev
=$
( nand_find_ubi
"${CI_ROOT_UBIPART:-$CI_UBIPART}" )
81 local ubivol
="$( nand_find_volume $ubidev rootfs_data )"
82 if [ ! "$ubivol" ]; then
83 ubivol
="$( nand_find_volume $ubidev "$CI_ROOTPART" )"
84 if [ ! "$ubivol" ]; then
85 echo "cannot find ubifs data volume"
90 if ! mount
-t ubifs
/dev
/$ubivol /tmp
/new_root
; then
91 echo "cannot mount ubifs volume $ubivol"
95 if mv "$1" "/tmp/new_root/$BACKUP_FILE"; then
96 if umount
/tmp
/new_root
; then
97 echo "configuration saved"
104 echo "could not save configuration to ubifs volume $ubivol"
109 nand_remove_ubiblock
() {
112 local ubiblk
="ubiblock${ubivol:3}"
113 if [ -e "/dev/$ubiblk" ]; then
114 umount
"/dev/$ubiblk" && echo "unmounted /dev/$ubiblk" ||
:
115 if ! ubiblock
-r "/dev/$ubivol"; then
116 echo "cannot remove $ubiblk"
124 local has_env
="${2:-0}"
126 local mtdnum
="$( find_mtd_index "$ubipart" )"
127 if [ ! "$mtdnum" ]; then
128 >&2 echo "cannot find ubi mtd partition $ubipart"
132 local ubidev
="$( nand_find_ubi "$ubipart" )"
133 if [ ! "$ubidev" ]; then
134 >&2 ubiattach
-m "$mtdnum"
135 ubidev
="$( nand_find_ubi "$ubipart" )"
137 if [ ! "$ubidev" ]; then
138 >&2 ubiformat
/dev
/mtd
$mtdnum -y
139 >&2 ubiattach
-m "$mtdnum"
140 ubidev
="$( nand_find_ubi "$ubipart" )"
142 if [ ! "$ubidev" ]; then
143 >&2 echo "cannot attach ubi mtd partition $ubipart"
147 if [ "$has_env" -gt 0 ]; then
148 >&2 ubimkvol
/dev
/$ubidev -n 0 -N ubootenv
-s 1MiB
149 >&2 ubimkvol
/dev
/$ubidev -n 1 -N ubootenv2
-s 1MiB
161 local mtdnum
="$( find_mtd_index "$ubipart" )"
162 if [ ! "$mtdnum" ]; then
163 echo "cannot find ubi mtd partition $ubipart"
167 local ubidev
="$( nand_find_ubi "$ubipart" )"
168 if [ "$ubidev" ]; then
169 for ubivol
in $
(find /dev
-name "${ubidev}_*" -maxdepth 1 |
sort); do
171 nand_remove_ubiblock
"$ubivol" ||
:
172 umount
"/dev/$ubivol" && echo "unmounted /dev/$ubivol" ||
:
174 if ! ubidetach
-m "$mtdnum"; then
175 echo "cannot detach ubi mtd partition $ubipart"
181 nand_upgrade_prepare_ubi
() {
182 local rootfs_length
="$1"
183 local rootfs_type
="$2"
184 local rootfs_data_max
="$(fw_printenv -n rootfs_data_max 2> /dev/null)"
185 [ -n "$rootfs_data_max" ] && rootfs_data_max
=$
((rootfs_data_max
))
187 local kernel_length
="$3"
188 local has_env
="${4:-0}"
192 [ -n "$rootfs_length" -o -n "$kernel_length" ] ||
return 1
194 if [ -n "$CI_KERN_UBIPART" -a -n "$CI_ROOT_UBIPART" ]; then
195 kern_ubidev
="$( nand_attach_ubi "$CI_KERN_UBIPART" "$has_env" )"
196 [ -n "$kern_ubidev" ] ||
return 1
197 root_ubidev
="$( nand_attach_ubi "$CI_ROOT_UBIPART" )"
198 [ -n "$root_ubidev" ] ||
return 1
200 kern_ubidev
="$( nand_attach_ubi "$CI_UBIPART" "$has_env" )"
201 [ -n "$kern_ubidev" ] ||
return 1
202 root_ubidev
="$kern_ubidev"
205 local kern_ubivol
="$( nand_find_volume $kern_ubidev "$CI_KERNPART" )"
206 local root_ubivol
="$( nand_find_volume $root_ubidev "$CI_ROOTPART" )"
207 local data_ubivol
="$( nand_find_volume $root_ubidev rootfs_data )"
208 [ "$root_ubivol" = "$kern_ubivol" ] && root_ubivol
=
211 [ "$kern_ubivol" ] && { nand_remove_ubiblock
$kern_ubivol ||
return 1; }
212 [ "$root_ubivol" ] && { nand_remove_ubiblock
$root_ubivol ||
return 1; }
213 [ "$data_ubivol" ] && { nand_remove_ubiblock
$data_ubivol ||
return 1; }
216 [ "$kern_ubivol" ] && ubirmvol
/dev
/$kern_ubidev -N "$CI_KERNPART" ||
:
217 [ "$root_ubivol" ] && ubirmvol
/dev
/$root_ubidev -N "$CI_ROOTPART" ||
:
218 [ "$data_ubivol" ] && ubirmvol
/dev
/$root_ubidev -N rootfs_data ||
:
221 if [ -n "$kernel_length" ]; then
222 if ! ubimkvol
/dev
/$kern_ubidev -N "$CI_KERNPART" -s $kernel_length; then
223 echo "cannot create kernel volume"
229 if [ -n "$rootfs_length" ]; then
230 local rootfs_size_param
231 if [ "$rootfs_type" = "ubifs" ]; then
232 rootfs_size_param
="-m"
234 rootfs_size_param
="-s $rootfs_length"
236 if ! ubimkvol
/dev
/$root_ubidev -N "$CI_ROOTPART" $rootfs_size_param; then
237 echo "cannot create rootfs volume"
242 # create rootfs_data vol for non-ubifs rootfs
243 if [ "$rootfs_type" != "ubifs" ]; then
244 local rootfs_data_size_param
="-m"
245 if [ -n "$rootfs_data_max" ]; then
246 rootfs_data_size_param
="-s $rootfs_data_max"
248 if ! ubimkvol
/dev
/$root_ubidev -N rootfs_data
$rootfs_data_size_param; then
249 if ! ubimkvol
/dev
/$root_ubidev -N rootfs_data
-m; then
250 echo "cannot initialize rootfs_data volume"
259 # Write the UBI image to MTD ubi partition
260 nand_upgrade_ubinized
() {
264 local ubi_length
=$
( (${gz}cat "$ubi_file" |
wc -c) 2> /dev
/null
)
266 nand_detach_ubi
"$CI_UBIPART" ||
return 1
268 local mtdnum
="$( find_mtd_index "$CI_UBIPART" )"
269 ${gz}cat "$ubi_file" | ubiformat
"/dev/mtd$mtdnum" -S "$ubi_length" -y -f - && ubiattach
-m "$mtdnum"
272 # Write the UBIFS image to UBI rootfs volume
273 nand_upgrade_ubifs
() {
274 local ubifs_file
="$1"
277 local ubifs_length
=$
( (${gz}cat "$ubifs_file" |
wc -c) 2> /dev
/null
)
279 nand_upgrade_prepare_ubi
"$ubifs_length" "ubifs" "" "" ||
return 1
281 local ubidev
="$( nand_find_ubi "$CI_UBIPART" )"
282 local root_ubivol
="$(nand_find_volume $ubidev "$CI_ROOTPART")"
283 ${gz}cat "$ubifs_file" | ubiupdatevol
/dev
/$root_ubivol -s "$ubifs_length" -
286 # Write the FIT image to UBI kernel volume
291 local fit_length
=$
( (${gz}cat "$fit_file" |
wc -c) 2> /dev
/null
)
293 nand_upgrade_prepare_ubi
"" "" "$fit_length" "1" ||
return 1
295 local fit_ubidev
="$(nand_find_ubi "$CI_UBIPART")"
296 local fit_ubivol
="$(nand_find_volume $fit_ubidev "$CI_KERNPART")"
297 ${gz}cat "$fit_file" | ubiupdatevol
/dev
/$fit_ubivol -s "$fit_length" -
300 # Write images in the TAR file to MTD partitions and/or UBI volumes as required
304 local jffs2_markers
="${CI_JFFS2_CLEAN_MARKERS:-0}"
306 # WARNING: This fails if tar contains more than one 'sysupgrade-*' directory.
307 local board_dir
="$(tar t${gz}f "$tar_file" | grep -m 1 '^sysupgrade-.*/$')"
308 board_dir
="${board_dir%/}"
310 local kernel_mtd kernel_length
311 if [ "$CI_KERNPART" != "none" ]; then
312 kernel_mtd
="$(find_mtd_index "$CI_KERNPART")"
313 kernel_length
=$
( (tar xO
${gz}f
"$tar_file" "$board_dir/kernel" |
wc -c) 2> /dev
/null
)
314 [ "$kernel_length" = 0 ] && kernel_length
=
316 local rootfs_length
=$
( (tar xO
${gz}f
"$tar_file" "$board_dir/root" |
wc -c) 2> /dev
/null
)
317 [ "$rootfs_length" = 0 ] && rootfs_length
=
319 [ "$rootfs_length" ] && rootfs_type
="$(identify_tar "$tar_file" "$board_dir/root
" "$gz")"
321 local ubi_kernel_length
322 if [ "$kernel_length" ]; then
323 if [ "$kernel_mtd" ]; then
324 # On some devices, the raw kernel and ubi partitions overlap.
325 # These devices brick if the kernel partition is erased.
326 # Hence only invalidate kernel for now.
327 dd if=/dev
/zero bs
=4096 count
=1 2> /dev
/null | \
328 mtd
write - "$CI_KERNPART"
330 ubi_kernel_length
="$kernel_length"
335 nand_upgrade_prepare_ubi
"$rootfs_length" "$rootfs_type" "$ubi_kernel_length" "$has_env" ||
return 1
337 if [ "$rootfs_length" ]; then
338 local ubidev
="$( nand_find_ubi "${CI_ROOT_UBIPART:-$CI_UBIPART}" )"
339 local root_ubivol
="$( nand_find_volume $ubidev "$CI_ROOTPART" )"
340 tar xO
${gz}f
"$tar_file" "$board_dir/root" | \
341 ubiupdatevol
/dev
/$root_ubivol -s "$rootfs_length" -
343 if [ "$kernel_length" ]; then
344 if [ "$kernel_mtd" ]; then
345 if [ "$jffs2_markers" = 1 ]; then
346 flash_erase
-j "/dev/mtd${kernel_mtd}" 0 0
347 tar xO
${gz}f
"$tar_file" "$board_dir/kernel" | \
348 nandwrite
"/dev/mtd${kernel_mtd}" -
350 tar xO
${gz}f
"$tar_file" "$board_dir/kernel" | \
351 mtd
write - "$CI_KERNPART"
354 local ubidev
="$( nand_find_ubi "${CI_KERN_UBIPART:-$CI_UBIPART}" )"
355 local kern_ubivol
="$( nand_find_volume $ubidev "$CI_KERNPART" )"
356 tar xO
${gz}f
"$tar_file" "$board_dir/kernel" | \
357 ubiupdatevol
/dev
/$kern_ubivol -s "$kernel_length" -
364 nand_verify_if_gzip_file
() {
368 if [ "$gz" = z
]; then
369 echo "verifying compressed sysupgrade file integrity"
370 if ! gzip -t "$file"; then
371 echo "corrupted compressed sysupgrade file"
377 nand_verify_tar_file
() {
381 echo "verifying sysupgrade tar file integrity"
382 if ! tar xO
${gz}f
"$file" > /dev
/null
; then
383 echo "corrupted sysupgrade tar file"
388 nand_do_flash_file
() {
391 local gz
="$(identify_if_gzip "$file")"
392 local file_type
="$(identify "$file" "" "$gz")"
394 [ ! "$(find_mtd_index "$CI_UBIPART")" ] && CI_UBIPART
=rootfs
398 nand_verify_if_gzip_file
"$file" "$gz" ||
return 1
399 nand_upgrade_fit
"$file" "$gz"
402 nand_verify_if_gzip_file
"$file" "$gz" ||
return 1
403 nand_upgrade_ubinized
"$file" "$gz"
406 nand_verify_if_gzip_file
"$file" "$gz" ||
return 1
407 nand_upgrade_ubifs
"$file" "$gz"
410 nand_verify_tar_file
"$file" "$gz" ||
return 1
411 nand_upgrade_tar
"$file" "$gz"
416 nand_do_restore_config
() {
417 local conf_tar
="/tmp/sysupgrade.tgz"
418 [ ! -f "$conf_tar" ] || nand_restore_config
"$conf_tar"
421 # Recognize type of passed file and start the upgrade process
426 nand_do_flash_file
"$file" && nand_do_upgrade_success
427 nand_do_upgrade_failed
430 nand_do_upgrade_success
() {
431 if nand_do_restore_config
&& sync
; then
432 echo "sysupgrade successful"
436 nand_do_upgrade_failed
439 nand_do_upgrade_failed
() {
441 echo "sysupgrade failed"
442 # Should we reboot or bring up some failsafe mode instead?
447 # Check if passed file is a valid one for NAND sysupgrade.
448 # Currently it accepts 4 types of files:
449 # 1) UBI: a ubinized image containing required UBI volumes.
450 # 2) UBIFS: a UBIFS rootfs volume image.
451 # 3) FIT: a FIT image containing kernel and rootfs.
452 # 4) TAR: an archive that includes directory "sysupgrade-${BOARD_NAME}" containing
453 # a non-empty "CONTROL" file and required partition and/or volume images.
455 # You usually want to call this function in platform_check_image.
457 # $(1): board name, used in case of passing TAR file
458 # $(2): file to be checked
459 nand_do_platform_check
() {
460 local board_name
="$1"
463 local gz
="$(identify_if_gzip "$file")"
464 local file_type
="$(identify "$file" "" "$gz")"
465 local control_length
=$
( (tar xO
${gz}f
"$file" "sysupgrade-${board_name//,/_}/CONTROL" |
wc -c) 2> /dev
/null
)
467 if [ "$control_length" = 0 ]; then
468 control_length
=$
( (tar xO
${gz}f
"$file" "sysupgrade-${board_name//_/,}/CONTROL" |
wc -c) 2> /dev
/null
)
471 if [ "$control_length" != 0 ]; then
472 nand_verify_tar_file
"$file" "$gz" ||
return 1
474 nand_verify_if_gzip_file
"$file" "$gz" ||
return 1
475 if [ "$file_type" != "fit" -a "$file_type" != "ubi" -a "$file_type" != "ubifs" ]; then
476 echo "invalid sysupgrade file"