root/trunk/freewrt/scripts/flash.sh

# $Id$
#-
# This file is part of the FreeWRT project. FreeWRT is copyrighted
# material, please see the LICENCE file in the top-level directory
# or at http://www.freewrt.org/licence for details.

if test -z "$KSH_VERSION$BASH_VERSION"; then
        echo >&2 Sorry, at the moment, a Korn shell or GNU bash is required.
        exit 255
fi

[[ -n $BASH_VERSION ]] && shopt -s extglob
[[ -n $KSH_VERSION ]] && alias which='whence -p'

me=${0##*/}
wd=$(pwd)

if ! which stat >/dev/null 2>&1; then
        getsize() {
                # no stat(1)
                echo 0
        }
elif stat --help >/dev/null 2>&1; then
        getsize() {
                # GNU stat, not standards-compliant
                stat -c '%s' "$@" 2>/dev/null
        }
else
        getsize() {
                # BSD stat(1)
                stat -f '%z' "$@" 2>/dev/null
        }
fi

die() {
        printf >&2 '%s: %s\n' "$me" "$*"
        exit 1
}

usage() {
        cat >&2 <<-EOF
                Syntax: $me [-nx] [-c tftp] [-D dir | -F | -f fwcf.bin] [-t type] file [ip]
                Valid types are:
                    wl500g wl500gd wl500gp wl500gx linksys
                Meta-types (no support for -f or -F):
                    wl500gx = wl500gd or wl500gp
                    linksys = all linksys models
                Use -x to flash oversized images.
        EOF
        exit 1
}

imgtype=auto
flashtype=auto
typeset -i dopad=0
typeset -i padsize=0
paddir=
padfile=
tftp=tftp
typeset -i nflag=0
typeset -i sflag=0
typeset -i xflag=0

while getopts ":c:D:Ff:nst:x" ch; do
        case $ch in
        (c)     tftp=$OPTARG
                ;;
        (D)     dopad=1
                paddir=$OPTARG
                padfile=
                ;;
        (F)     dopad=1
                paddir=
                padfile=
                ;;
        (f)     dopad=1
                paddir=
                padfile=$OPTARG
                [[ -s $padfile ]] || die "Invalid pad file '$padfile'"
                ;;
        (n)     nflag=1
                ;;
        (s)     sflag=1
                ;;
        (t)     imgtype=$OPTARG
                ;;
        (x)     xflag=1
                ;;
        (:)     echo >&2 "$me: Error: missing argument to -$OPTARG"
                usage
                ;;
        (*)     echo >&2 "$me: Error: invalid option -$OPTARG"
                usage
                ;;
        esac
done
shift $((OPTIND - 1))

[[ $# -lt 1 || $# -gt 2 ]] && usage
imgfile=$1
[[ $imgfile = *@( )* ]] && die Spaces in filenames are not supported
[[ -s $imgfile ]] || die "Image file '$imgfile' non-existent or 0 bytes"
if (( nflag )); then
        ofile=${2:-flash.out}
else
        ip=${2:-192.168.1.1}
        [[ $ip = +([0-9]).+([0-9]).+([0-9]).+([0-9]) ]] || \
            die "Invalid IPv4 address '$ip'"
fi

[[ $imgtype = auto ]] && case ${imgfile%.[bt][ir][nx]} in
*-asus-wl500g-premium-*)
        imgtype=wl500gp ;;
*-asus-wl500g-deluxe-*)
        imgtype=wl500gd ;;
*-asus-wl500g-*)
        imgtype=wl500g ;;
*-linksys-*)
        imgtype=linksys ;;
*)
        die "Cannot determine model from filename '$imgfile', use -t option" ;;
esac

case $imgtype in
wl500g)
        flashtype=wl500g ;;
wl500gd|wl500gp|wl500gx)
        flashtype=wl500gx ;;
linksys)
        flashtype=linksys ;;
*)
        die "Unknown model '$imgtype'" ;;
esac

case $imgtype in
wl500g|wl500gd)
        padsize=3735552 ;;
wl500gp)
        padsize=7929856 ;;
*)
        padsize=0 ;;
esac

typeset -i imgsize="$(getsize "$imgfile")" 2>&-
#   stat retval ok?      know maxsz?      image too large?
(( xflag )) && imgsize=0
(( (imgsize > 65536) && (padsize > 0) && (imgsize > padsize) )) && \
    die "Image '$imgfile' too large ($imgsize bytes, max. $padsize bytes)"

if (( dopad )); then
        (( padsize )) || die "Cannot use -F or -f with a $imgtype yet"
        TF=$(mktemp /tmp/fwflash.XXXXXXXXXX) || die Cannot mktemp
        TI=$(mktemp /tmp/fwflash.XXXXXXXXXX) || { rm $TF; die Cannot mktemp; }
        trap 'cd "$wd"; rm -f $TF $TI; exit 0' 0
        trap 'cd "$wd"; rm -f $TF $TI; exit 1' 1 2 3 5 13 15
        randsrc=/dev/arandom
        [[ -e $randsrc ]] || randsrc=/dev/urandom
        [[ -e $randsrc ]] || randsrc=/dev/random
        [[ -e $randsrc ]] || die Cannot find an entropy source
        dd if=$randsrc of=$TF bs=131072 count=1 2>&-
        if [[ -n $padfile ]]; then
                id=
                eval $(dd if="$padfile" bs=7 count=1 2>&- | \
                    hexdump -e '"id=" 4/1 "%02X" " n=" 3/1 "%02X" "\n"')
                if [[ $id = 46574346 ]]; then
                        sz=$(printf 'ibase=16\n%s\n' $(echo -n $n | \
                            sed 's/\(..\)\(..\)\(..\)/\3\2\1/') | bc)
                        dd if="$padfile" bs=$sz count=1
                else
                        cat "$padfile"
                fi | dd of=$TF conv=notrunc 2>&-
                typeset -i fwcfsize="$(getsize $TF)" 2>&-
                (( fwcfsize > 131072 )) && die "FWCF filesystem '$padfile' too" \
                    "large ($fwcfsize bytes, max. 131072 bytes)"
                echo "TRX file constructed from root='$imgfile' and fwcf='$padfile'"
        elif [[ -n $paddir ]]; then
                # locate fwcf.helper
                p=fwcf.helper
                $p -l 2>&1 | fgrep lzo1x1 >/dev/null || \
                    for dir in . .. ../.. ../../.. ../../../.. *wrt* *WRT*; do
                        p=$dir/lbin/fwcf.helper
                        [[ -e $dir/. ]] || continue
                        [[ -x $p ]] || continue
                        $p -l 2>&1 | fgrep lzo1x1 >/dev/null && break
                        p=
                done
                [[ $p = fwcf.helper || -x $p ]] || die Cannot find fwcf.helper
                # create fwcf filesystem image
                $p -M "$paddir" >$TI || die Error creating fwcf filesystem image
                dd if=$TI of=$TF conv=notrunc 2>&-
                echo "TRX file constructed from '$imgfile' and FWCF from '$paddir'"
        else
                printf 'FWCF\x18\x00\x00\x01\x01\x00\x00\x10\x12\x00\x11\x00\x00\x00\x00\x00\x74\x01\x7C\x18' | \
                    dd of=$TF conv=notrunc 2>&-
                echo "TRX file constructed from '$imgfile' and empty fwcf filesystem"
        fi
        dd if=/dev/zero of=$TI bs=$padsize count=1 2>&-
        dd if="$imgfile" of=$TI conv=notrunc 2>&-
        if (( sflag )); then
                [[ -n $padfile || -n $paddir ]] && die Cannot use -s without -F
                printf '!' >>$TI
        else
                cat $TF >>$TI
        fi
        imgfile=$TI
else
        echo "Using TRX file from '$imgfile'"
fi

if (( nflag )); then
        cat "$imgfile" >"$ofile"
        echo "Output file '$ofile' written."
        exit 0
fi

x=$tftp
[[ -x $tftp ]] || tftp=$(which $tftp 2>&-)
[[ -x $tftp ]] || die "TFTP client '${x:-tftp}' not found"

echo ATTENTION: Do not turn off the power on your device $ip now!
sleep 3

imgdir=${imgfile%/*}
[[ $imgdir = $imgfile ]] && imgdir=.
imgfile=${imgfile##*/}
cd "$imgdir"
typeset -i rv=1
text2='This device will reboot itself automatically.'
case $flashtype in
wl500g)
        echo Confirming IP address setting...
        printf 'get ASUSSPACELINK\x01\x01\xA8\xC0 /dev/null\nquit\n' | $tftp $ip
        echo Flashing image...
        printf 'binary\nput %s ASUSSPACELINK\nquit\n' "$imgfile" | $tftp $ip
        rv=$?
        text1='Please wait until the LEDs stop flashing.'
        ;;
wl500gx)
        echo Flashing image...
        printf 'rexmt 1\ntrace\nbinary\nput %s\nquit\n' "$imgfile" | $tftp $ip
        rv=$?
        text1='Please wait 5-6 minutes and then remove the power plug.'
        text2='This device does not reboot automatically after flashing.'
        ;;
linksys)
        echo Flashing image...
        printf 'rexmt 1\ntrace\nbinary\nput %s\nquit\n' "$imgfile" | $tftp $ip
        rv=$?
        text1='Please wait 3-5 minutes.'
        ;;
esac
cd "$wd"
if (( rv )); then
        echo tftp returned with error code $rv.
        echo The device may not have been flashed correctly.
        exit 1
fi
cat <<-EOF
        $text1
        $text2

        After flashing is finished and the device has rebooted, it will need
        to restart once if the filesystem type is squashfs with jffs2 overlay.
        The power LED will flash quickly as long as startup is in progress.

        Once it has finished flashing, you should be able to access the device
        via ssh to the "admin" user, for example: ssh -l admin $ip

        If you didn't change the password in menuconfig, it's "FreeWRT" (case
        sensitive and without the quotation marks). Give the device a while to
        generate the SSH keys for dropbear first.

        After device initialisation and key generation has finished, it is
        highly recommended to log in and issue the command "fwcf commit" so that
        the SSH host keys will be stored in the configuration filesystem and
        do not have to be regenerated each time the device starts.

EOF
exit 0