Changeset 72 in SVN


Ignore:
Timestamp:
12/07/2018 10:39:54 PM (18 months ago)
Author:
Tim Harvey
Message:

mkimage_jtag: add emmc support

The mkimage_jtag script now supports creating images intended for eMMC
supported on Ventana and Newport product families.

See http://trac.gateworks.com/wiki/jtag_instructions#images

Signed-off-by: Tim Harvey <tharvey@…>

File:
1 edited

Legend:

Unmodified
Added
Removed

  • jtag/linux/x86/mkimage_jtag

    r1 r72  
    1 #!/bin/sh
    2 #
    3 # mkimage_jtag v1.0.0
    4 # Copyright 2014 Gateworks Corporation <support@gateworks.com>
    5 #
    6 # create a binary image suitable for IMX6 targets for jtag_usbv4
    7 #
    8 # usage: mkimage_jtag [<SPL> <u-boot.img>]|[<SPL> <u-boot.img> <ubi>]|[<ubi>]
    9 #
    10 # Examples:
     1#!/bin/bash
     2#
     3# mkimage_jtag v1.1.0
     4# Copyright 2014-2018 Gateworks Corporation <support@gateworks.com>
     5#
     6# create a binary image suitable for jtag_usbv4
     7#
     8# usage: mkimage_jtag [OPTIONS]
     9#
     10# Options:
     11#   --nand - (default) create image suitable for NAND flash (rootfs is a ubi)
     12#   --emmc - create image suitable for block device (rootfs is a disk image)
     13#
     14# NAND Examples:
    1115#   # create jtagable bin containing just bootloader (will not overwrite all)
    12 #   mkimage_jtag <SPL> <u-boot.img> > uboot.bin
     16#   mkimage_jtag -nand <SPL> <u-boot.img> > uboot.bin
    1317#   # create jtagable bin containing bootloader+ubi (will overwrite all)
    14 #   mkimage_jtag <SPL> <u-boot.img> <ubi> > image.bin
     18#   mkimage_jtag -nand <SPL> <u-boot.img> <ubi> > image.bin
    1519#   # create jtagable bin containing ubi (will not overwrite bootloader/env)
    16 #   mkimage_jtag <ubi> > image.bin
     20#   mkimage_jtag -nand <ubi> > image.bin
     21#
     22# EMMC Examples:
     23#   # create jtagable bin for emmc erasing entire part and programming boot fw
     24#   mkimage_jtag --emmc -e --partconf=user firmware.img@user > image.bin
     25#   # create jtagable bin for emmc programming boot fw (will not overwrite all)
     26#   mkimage_jtag --emmc -s --partconf=user firmware.img@user > image.bin
    1727#
    1828# This puts a simple header around the binary parts that make up a bootable
    … …  
    2232#
    2333# u16 magic: GW
    24 # u16 erase_mode:
    25 #      0=erase entire flash (use only on first header)
    26 #      1=erase none (perform no erase)
    27 #      2=erase part (erase only this part - offset must align with flash block)
    28 #      3=erase to end (erase from this part to end of device)
     34# u16 config:
     35#   bit[0:1] - erase_config
     36#      0=entire flash (use only on first header)
     37#      1=none (perform no erase)
     38#      2=part (erase only this part - offset must align with flash block)
     39#      3=to end (erase from this part to end of device)
     40#   bit[2:4]   - partition number (for eMMC: 1-boot0 2=boot1 7=user)
     41#   bit[5]     - gzip compressed data (1=gzip-compressed 0=uncompressed)
     42#   bit[6:12]  - reserved
     43#   bit[13:15] - type (0=NAND 1=eMMC)
    2944# u32 offset: byte offset in flash (logical) to program this data
    3045#      (this must align with a flash block boundary if erasing part or to end
    … …  
    3449#
    3550# The psize value is only used in the special case where dsize=0 which
    36 # specifies a bootstream.  This must be the first part in a series of parts 
     51# specifies a bootstream.  This must be the first part in a series of parts
    3752# and is programmed in a specific fashion on NAND FLASH in accordance with
    3853# the requirements of the i.MX6 BOOT ROM.  In this case the data must
    … …  
    4055#
    4156
     57# erase_config: config[0:1]
    4258ERASE_ALL=0
    4359ERASE_NON=1
    4460ERASE_PRT=2
    4561ERASE_END=3
     62
     63# partition_no: config[2:3]
     64PART_BOOT0=$((1<<2))
     65PART_BOOT1=$((2<<2))
     66PART_USER=$((0<<2))
     67PART_RPMB=$((3<<2))
     68
     69# data type: config[13:15]
     70TYPE_NAND=$((0<<13))
     71TYPE_EMMC=$((1<<13))
     72
     73error() {
     74        echo "$@" 1>&2
     75        exit
     76}
     77
     78debug() {
     79        echo "$@" 1>&2
     80}
     81
     82usage() {
     83echo "
     84usage: $0 [OPTIONS]
     85
     86  NAND:
     87    $0 [<SPL> <u-boot.img>]|[<SPL> <u-boot.img> <ubi>]|[<ubi>]
     88
     89  EMMC:
     90    $0 --emmc [--partconf=<boot0|boot1|user>] <blobopt> [<blobopt>...]
     91"
     92        exit 1
     93}
     94
     95gettype() {
     96        case $(($1 & 0xe000)) in
     97                $TYPE_NAND) echo "NAND";;
     98                $TYPE_EMMC) echo "eMMC";;
     99        esac
     100}
     101
     102getpart() {
     103        case $(($1 & 0x1c)) in
     104                $PART_BOOT0) echo "Boot0";;
     105                $PART_BOOT1) echo "Boot1";;
     106                $PART_USER) echo "User";;
     107                $PART_RPMB) echo "RPMB";;
     108        esac
     109}
     110
     111getmode() {
     112        case $(($1 & 0x3)) in
     113                $ERASE_ALL) echo "all";;
     114                $ERASE_NON) echo "segment";;
     115                $ERASE_PRT) echo "partition";;
     116                $ERASE_END) echo "to-end";;
     117        esac
     118}
     119
     120getsize() {(
     121        local mult=1
     122        local val=$1
     123        local suffix regex
     124
     125        shopt -s nocasematch
     126        for suffix in '' K M G; do
     127                regex="^([0-9]+)(${suffix}i?B?)?\$"
     128                [[ $val =~ $regex ]] && {
     129                        /usr/bin/printf "0x%x" $((${BASH_REMATCH[1]} * mult))
     130                        return 0
     131                }
     132                regex="^0x([0-9A-Fa-f]+)(${suffix}i?B?)?\$"
     133                [[ $1 =~ $regex ]] && {
     134                        echo $((0x${BASH_REMATCH[1]} * mult))
     135                        return 0
     136                }
     137
     138                ((mult *= 1024))
     139        done
     140        echo "invalid size: $1" >&2
     141        return 1
     142)}
    46143
    47144# output binary u32
    … …  
    69166}
    70167
     168# emit a blob of 1byte length to force erasing a partition
     169erasepart() {
     170        debug "erasepart $1"
     171
     172        /usr/bin/printf "GW" # magic
     173        u16 $((config|type))
     174        u32 0 # offset
     175        u32 4 # blob size
     176        u32 0 # partition size
     177
     178        u32 0 # blob data
     179}
     180
     181# emit a configuration header for setting eMMC PART_CONFIG
     182# (if file size and offset are both 0, then PART_CONFIG gets set to part_num)
     183# $1 config
     184emmc_partconf()
     185{
     186        local config=$1
     187        local attr=
     188
     189        debug "  emit Partiton Config=$(getpart $config)"
     190        /usr/bin/printf "GW" # magic
     191        u16 $(($config|$type))
     192        u32 0
     193        u32 0
     194        u32 0
     195}
     196
    71197# emit a part
    72198# $1 file
    73 # $2 erase_mode
    74 # $3 offset
     199# $2 config
     200# $3 offset (bytes for NAND, blocks for eMMC)
    75201# $4 size (only needed if offset==0 for bootloader part size)
    76202emit()
    77203{
    78204        local file=$1
    79         local erase_mode=$2
     205        local config=$2
    80206        local offset=$3
    81207        local part_size=${4:-0}
    82208        local fsize
    83 
     209        local part=""
     210
     211        [ $type = $TYPE_EMMC ] && part="part=$(getpart $config)"
     212        if [ $(($part_size)) -eq 0 ]; then
     213                debug "$(/usr/bin/printf "  emit %s@0x%08x erase:%s %s\n" \
     214                        $file $offset $(getmode $config) $part)"
     215        else
     216                debug "$(/usr/bin/printf "  emit %s@0x%08x-0x%08x erase:%s %s\n" \
     217                        $file $offset $((offset+part_size)) $(getmode $config) $part)"
     218        fi
     219
     220        [ "$file" -a -r "$file" ] || error "invalid file '$file'"
    84221        fsize=$(ls -lL $file | awk '{print $5}')
    85222
    86223        /usr/bin/printf "GW" # magic
    87         u16 $erase_mode
     224        u16 $((config|type))
    88225        u32 $offset
    89226        u32 $fsize
    … …  
    92229}
    93230
    94 # output image to stdout
     231type=$TYPE_NAND
     232[ "$1" == "--emmc" ] && { type=$TYPE_EMMC; shift; }
     233[ "$1" == "--nand" ] && { type=$TYPE_NAND; shift; }
     234
     235# Scripted usage: space separated list of:
     236#  file@[part:]offset[-end]
     237#  if -end not specified will erase up to size of file (rounded to end of block)
     238#  if end not specified will erase to end of device
     239#  -e starts off by erasing the entire part
     240#
     241# Examples:
     242#  - update falcon mode kernel at 18MB:
     243#  mkimage_jtag -s uImage@18M
     244#  - update SPL and uboot with full erase:
     245#  mkimage_jtag -e SPL@0 u-boot.img@14M
     246#  - erase env
     247#  dd if=/dev/zero of=env bs=1M count=1 && ./mkimage_jtag -s env@16M
     248[ "$1" = "-s" -o "$1" = "-e" ] && {
     249        count=0
     250
     251        # initial erase type
     252        mode=$ERASE_NON
     253        [ "$1" = "-e" ] && mode=$ERASE_ALL
     254        shift
     255
     256        # EMMC: optional partconf
     257        [ $type = $TYPE_EMMC ] && {
     258                case "$1" in
     259                        --partconf=boot0) emmc_partconf $PART_BOOT0; shift;;
     260                        --partconf=boot1) emmc_partconf $PART_BOOT1; shift;;
     261                        --partconf=user) emmc_partconf $PART_USER; shift;;
     262                        --partconf=*)
     263                                error "invalid partition: $1"
     264                                usage
     265                                ;;
     266                esac
     267        }
     268
     269        # parse blobs
     270        while [ "$1" ]; do
     271                count=$((count+1))
     272                str=$1
     273                shift
     274
     275                # check for hw partition and erase mode syntax
     276                if [[ $str =~ ^(.*)@(.*):(.*):(.+)$ ]]; then
     277                        #debug "$count:<blob>@<partition>:<erase_mode>:<offset>"
     278                        mode=0
     279                        # parse partition
     280                        case "${BASH_REMATCH[2]}" in
     281                        "user") mode=$((mode|$PART_USER));;
     282                        "boot0") mode=$((mode|$PART_BOOT0));;
     283                        "boot1") mode=$((mode|$PART_BOOT1));;
     284                        "rpmb") mode=$((mode|$PART_RPMB));;
     285                        esac
     286                        # parse erase_mode
     287                        #debug "partition=${BASH_REMATCH[2]} mode=$mode"
     288                        case "${BASH_REMATCH[3]}" in
     289                        "erase_none") mode=$((mode|$ERASE_NON));;
     290                        "erase_all") mode=$((mode|$ERASE_ALL));;
     291                        "erase_part") mode=$((mode|$ERASE_PRT));;
     292                        "erase_end") mode=$((mode|$ERASE_END));;
     293                        *) mode=$((mode|$ERASE_NON));;
     294                        esac
     295                        #debug "erase_mode=${BASH_REMATCH[3]} mode=$mode"
     296                        str=${BASH_REMATCH[1]}@${BASH_REMATCH[4]}
     297                fi
     298
     299                # file@start-end
     300                if [[ $str =~ ^(.*)@(.*)-(.+)$ ]]; then
     301                        debug "$count:<blob>@<start>-<end>"
     302                        file=${BASH_REMATCH[1]}
     303                        start=$(getsize ${BASH_REMATCH[2]})
     304                        end=$(getsize ${BASH_REMATCH[3]})
     305                        size=$(/usr/bin/printf "0x%x" $((end-start)))
     306                        emit $file $mode $start $size
     307                # file@start-
     308                elif [[ $str =~ ^(.*)@(.*)-$ ]]; then
     309                        debug "$count:<blob>@<start>-"
     310                        file=${BASH_REMATCH[1]}
     311                        start=$(getsize ${BASH_REMATCH[2]})
     312                        emit $file $mode $start
     313                # file@start
     314                elif [[ $str =~ ^(.*)@(.*)$ ]]; then
     315                        debug "$count:<blob>@<start>"
     316                        file=${BASH_REMATCH[1]}
     317                        start=$(getsize ${BASH_REMATCH[2]})
     318                        emit $file $mode $start
     319                else
     320                        error "invalid parameter: $str"
     321                fi
     322
     323                mode=$ERASE_NON
     324        done
     325        exit
     326}
     327
     328[ $type = $TYPE_NAND ] || usage
     329
     330# Legacy support for NAND flash
    95331case $# in
    96332        # ubi (w/o touching bootloader+env)
    97333        1)
    98         emit $1 $ERASE_END 0x1100000    # rootfs at 17MB+ (erase to end)
     334        debug "rootfs (erase to end):"
     335        emit $1 $ERASE_END 0x1100000    # rootfs@17MB- (erase to end)
    99336        ;;
    100337
    101338        # bootloader (SPL + u-boot.img) w/o eraseing env/ubi
    102339        2)
    103         emit $1 $ERASE_PRT 0 0xE00000   # SPL from 0 to 12MB
    104         emit $2 $ERASE_PRT 0x0E00000 0x0200000  # u-boot from 12MB-14MB
     340        debug "SPL + u-boot.img (bootloader only):"
     341        emit $1 $ERASE_PRT 0 0xE00000   # SPL@0-14MB
     342        emit $2 $ERASE_PRT 0x0E00000 0x0200000  # u-boot@14MB-16MB
    105343        ;;
    106344
    107345        # erase entire part and program SPL + u-boot.img + ubi
    108346        3)
    109         emit $1 $ERASE_ALL  0 0xE00000  # SPL from 0 to 12MB
    110         emit $2 $ERASE_NON 0x0E00000    # u-boot at 12MB+
    111         emit $3 $ERASE_NON 0x1100000    # rootfs at 17MB+
     347        debug "SPL + u-boot.img + ubi (full erase):"
     348        emit $1 $ERASE_ALL 0 0xE00000   # SPL@0-14MB
     349        emit $2 $ERASE_NON 0x0E00000    # u-boot@14MB
     350        emit $3 $ERASE_NON 0x1100000    # rootfs@17MB
    112351        ;;
    113352
    114353        # usage
    115354        *)
    116         echo "usage: $0 [<SPL> <u-boot.img>]|[<SPL> <u-boot.img> <ubi>]|[<ubi>]"
    117         exit 1
     355        usage
    118356        ;;
    119357esac
Note: See TracChangeset for help on using the changeset viewer.