arch/powerpc/boot/wrapper

   1 #!/bin/sh
   2
   3 # Copyright (C) 2006 Paul Mackerras, IBM Corporation <paulus@samba.org>
   4 # This program may be used under the terms of version 2 of the GNU
   5 # General Public License.
   6
   7 # This script takes a kernel binary and optionally an initrd image
   8 # and/or a device-tree blob, and creates a bootable zImage for a
   9 # given platform.
  10
  11 # Options:
  12 # -o zImage     specify output file
  13 # -p platform   specify platform (links in $platform.o)
  14 # -i initrd     specify initrd file
  15 # -d devtree    specify device-tree blob
  16 # -s tree.dts   specify device-tree source file (needs dtc installed)
  17 # -c            cache $kernel.strip.gz (use if present & newer, else make)
  18 # -C prefix     specify command prefix for cross-building tools
  19 #               (strip, objcopy, ld)
  20 # -D dir        specify directory containing data files used by script
  21 #               (default ./arch/powerpc/boot)
  22 # -W dir        specify working directory for temporary files (default .)
  23
  24 # Stop execution if any command fails
  25 set -e
  26
  27 # Allow for verbose output
  28 if [ "$V" = 1 ]; then
  29     set -x
  30 fi
  31
  32 # defaults
  33 kernel=
  34 ofile=zImage
  35 platform=of
  36 initrd=
  37 dtb=
  38 dts=
  39 cacheit=
  40 binary=
  41 gzip=.gz
  42 pie=
  43
  44 # cross-compilation prefix
  45 CROSS=
  46
  47 # mkimage wrapper script
  48 MKIMAGE=$srctree/scripts/mkuboot.sh
  49
  50 # directory for object and other files used by this script
  51 object=arch/powerpc/boot
  52 objbin=$object
  53 dtc=scripts/dtc/dtc
  54
  55 # directory for working files
  56 tmpdir=.
  57
  58 usage() {
  59     echo 'Usage: wrapper [-o output] [-p platform] [-i initrd]' >&2
  60     echo '       [-d devtree] [-s tree.dts] [-c] [-C cross-prefix]' >&2
  61     echo '       [-D datadir] [-W workingdir] [--no-gzip] [vmlinux]' >&2
  62     exit 1
  63 }
  64
  65 while [ "$#" -gt 0 ]; do
  66     case "$1" in
  67     -o)
  68         shift
  69         [ "$#" -gt 0 ] || usage
  70         ofile="$1"
  71         ;;
  72     -p)
  73         shift
  74         [ "$#" -gt 0 ] || usage
  75         platform="$1"
  76         ;;
  77     -i)
  78         shift
  79         [ "$#" -gt 0 ] || usage
  80         initrd="$1"
  81         ;;
  82     -d)
  83         shift
  84         [ "$#" -gt 0 ] || usage
  85         dtb="$1"
  86         ;;
  87     -s)
  88         shift
  89         [ "$#" -gt 0 ] || usage
  90         dts="$1"
  91         ;;
  92     -c)
  93         cacheit=y
  94         ;;
  95     -C)
  96         shift
  97         [ "$#" -gt 0 ] || usage
  98         CROSS="$1"
  99         ;;
 100     -D)
 101         shift
 102         [ "$#" -gt 0 ] || usage
 103         object="$1"
 104         objbin="$1"
 105         ;;
 106     -W)
 107         shift
 108         [ "$#" -gt 0 ] || usage
 109         tmpdir="$1"
 110         ;;
 111     --no-gzip)
 112         gzip=
 113         ;;
 114     -?)
 115         usage
 116         ;;
 117     *)
 118         [ -z "$kernel" ] || usage
 119         kernel="$1"
 120         ;;
 121     esac
 122     shift
 123 done
 124
 125 if [ -n "$dts" ]; then
 126     if [ ! -r "$dts" -a -r "$object/dts/$dts" ]; then
 127         dts="$object/dts/$dts"
 128     fi
 129     if [ -z "$dtb" ]; then
 130         dtb="$platform.dtb"
 131     fi
 132     $dtc -O dtb -o "$dtb" -b 0 "$dts"
 133 fi
 134
 135 if [ -z "$kernel" ]; then
 136     kernel=vmlinux
 137 fi
 138
 139 platformo=$object/"$platform".o
 140 lds=$object/zImage.lds
 141 ext=strip
 142 objflags=-S
 143 tmp=$tmpdir/zImage.$$.o
 144 ksection=.kernel:vmlinux.strip
 145 isection=.kernel:initrd
 146 link_address='0x400000'
 147 make_space=y
 148
 149 case "$platform" in
 150 pseries)
 151     platformo="$object/of.o $object/epapr.o"
 152     link_address='0x4000000'
 153     ;;
 154 maple)
 155     platformo="$object/of.o $object/epapr.o"
 156     link_address='0x400000'
 157     ;;
 158 pmac|chrp)
 159     platformo="$object/of.o $object/epapr.o"
 160     ;;
 161 coff)
 162     platformo="$object/crt0.o $object/of.o $object/epapr.o"
 163     lds=$object/zImage.coff.lds
 164     link_address='0x500000'
 165     pie=
 166     ;;
 167 miboot|uboot*)
 168     # miboot and U-boot want just the bare bits, not an ELF binary
 169     ext=bin
 170     objflags="-O binary"
 171     tmp="$ofile"
 172     ksection=image
 173     isection=initrd
 174     ;;
 175 cuboot*)
 176     binary=y
 177     gzip=
 178     case "$platform" in
 179     *-mpc866ads|*-mpc885ads|*-adder875*|*-ep88xc)
 180         platformo=$object/cuboot-8xx.o
 181         ;;
 182     *5200*|*-motionpro)
 183         platformo=$object/cuboot-52xx.o
 184         ;;
 185     *-pq2fads|*-ep8248e|*-mpc8272*|*-storcenter)
 186         platformo=$object/cuboot-pq2.o
 187         ;;
 188     *-mpc824*)
 189         platformo=$object/cuboot-824x.o
 190         ;;
 191     *-mpc83*|*-asp834x*)
 192         platformo=$object/cuboot-83xx.o
 193         ;;
 194     *-tqm8541|*-mpc8560*|*-tqm8560|*-tqm8555|*-ksi8560*)
 195         platformo=$object/cuboot-85xx-cpm2.o
 196         ;;
 197     *-mpc85*|*-tqm85*|*-sbc85*)
 198         platformo=$object/cuboot-85xx.o
 199         ;;
 200     *-amigaone)
 201         link_address='0x800000'
 202         ;;
 203     esac
 204     ;;
 205 ps3)
 206     platformo="$object/ps3-head.o $object/ps3-hvcall.o $object/ps3.o"
 207     lds=$object/zImage.ps3.lds
 208     gzip=
 209     ext=bin
 210     objflags="-O binary --set-section-flags=.bss=contents,alloc,load,data"
 211     ksection=.kernel:vmlinux.bin
 212     isection=.kernel:initrd
 213     link_address=''
 214     make_space=n
 215     pie=
 216     ;;
 217 ep88xc|ep405|ep8248e)
 218     platformo="$object/fixed-head.o $object/$platform.o"
 219     binary=y
 220     ;;
 221 adder875-redboot)
 222     platformo="$object/fixed-head.o $object/redboot-8xx.o"
 223     binary=y
 224     ;;
 225 simpleboot-virtex405-*)
 226     platformo="$object/virtex405-head.o $object/simpleboot.o $object/virtex.o"
 227     binary=y
 228     ;;
 229 simpleboot-virtex440-*)
 230     platformo="$object/fixed-head.o $object/simpleboot.o $object/virtex.o"
 231     binary=y
 232     ;;
 233 simpleboot-*)
 234     platformo="$object/fixed-head.o $object/simpleboot.o"
 235     binary=y
 236     ;;
 237 asp834x-redboot)
 238     platformo="$object/fixed-head.o $object/redboot-83xx.o"
 239     binary=y
 240     ;;
 241 xpedite52*)
 242     link_address='0x1400000'
 243     platformo=$object/cuboot-85xx.o
 244     ;;
 245 gamecube|wii)
 246     link_address='0x600000'
 247     platformo="$object/$platform-head.o $object/$platform.o"
 248     ;;
 249 treeboot-currituck)
 250     link_address='0x1000000'
 251     ;;
 252 treeboot-iss4xx-mpic)
 253     platformo="$object/treeboot-iss4xx.o"
 254     ;;
 255 epapr)
 256     platformo="$object/epapr.o $object/epapr-wrapper.o"
 257     link_address='0x20000000'
 258     pie=-pie
 259     ;;
 260 esac
 261
 262 vmz="$tmpdir/`basename \"$kernel\"`.$ext"
 263 if [ -z "$cacheit" -o ! -f "$vmz$gzip" -o "$vmz$gzip" -ot "$kernel" ]; then
 264     ${CROSS}objcopy $objflags "$kernel" "$vmz.$$"
 265
 266     strip_size=$(stat -c %s $vmz.$$)
 267
 268     if [ -n "$gzip" ]; then
 269         gzip -n -f -9 "$vmz.$$"
 270     fi
 271
 272     if [ -n "$cacheit" ]; then
 273         mv -f "$vmz.$$$gzip" "$vmz$gzip"
 274     else
 275         vmz="$vmz.$$"
 276     fi
 277 else
 278     # Calculate the vmlinux.strip size
 279     ${CROSS}objcopy $objflags "$kernel" "$vmz.$$"
 280     strip_size=$(stat -c %s $vmz.$$)
 281     rm -f $vmz.$$
 282 fi
 283
 284 if [ "$make_space" = "y" ]; then
 285         # Round the size to next higher MB limit
 286         round_size=$(((strip_size + 0xfffff) & 0xfff00000))
 287
 288         round_size=0x$(printf "%x" $round_size)
 289         link_addr=$(printf "%d" $link_address)
 290
 291         if [ $link_addr -lt $strip_size ]; then
 292             echo "INFO: Uncompressed kernel (size 0x$(printf "%x\n" $strip_size))" \
 293                         "overlaps the address of the wrapper($link_address)"
 294             echo "INFO: Fixing the link_address of wrapper to ($round_size)"
 295             link_address=$round_size
 296         fi
 297 fi
 298
 299 vmz="$vmz$gzip"
 300
 301 # Extract kernel version information, some platforms want to include
 302 # it in the image header
 303 version=`${CROSS}strings "$kernel" | grep '^Linux version [-0-9.]' | \
 304     cut -d' ' -f3`
 305 if [ -n "$version" ]; then
 306     uboot_version="-n Linux-$version"
 307 fi
 308
 309 # physical offset of kernel image
 310 membase=`${CROSS}objdump -p "$kernel" | grep -m 1 LOAD | awk '{print $7}'`
 311
 312 case "$platform" in
 313 uboot)
 314     rm -f "$ofile"
 315     ${MKIMAGE} -A ppc -O linux -T kernel -C gzip -a $membase -e $membase \
 316         $uboot_version -d "$vmz" "$ofile"
 317     if [ -z "$cacheit" ]; then
 318         rm -f "$vmz"
 319     fi
 320     exit 0
 321     ;;
 322 uboot-obs600)
 323     rm -f "$ofile"
 324     # obs600 wants a multi image with an initrd, so we need to put a fake
 325     # one in even when building a "normal" image.
 326     if [ -n "$initrd" ]; then
 327         real_rd="$initrd"
 328     else
 329         real_rd=`mktemp`
 330         echo "\0" >>"$real_rd"
 331     fi
 332     ${MKIMAGE} -A ppc -O linux -T multi -C gzip -a $membase -e $membase \
 333         $uboot_version -d "$vmz":"$real_rd":"$dtb" "$ofile"
 334     if [ -z "$initrd" ]; then
 335         rm -f "$real_rd"
 336     fi
 337     if [ -z "$cacheit" ]; then
 338         rm -f "$vmz"
 339     fi
 340     exit 0
 341     ;;
 342 esac
 343
 344 addsec() {
 345     ${CROSS}objcopy $4 $1 \
 346         --add-section=$3="$2" \
 347         --set-section-flags=$3=contents,alloc,load,readonly,data
 348 }
 349
 350 addsec $tmp "$vmz" $ksection $object/empty.o
 351 if [ -z "$cacheit" ]; then
 352     rm -f "$vmz"
 353 fi
 354
 355 if [ -n "$initrd" ]; then
 356     addsec $tmp "$initrd" $isection
 357 fi
 358
 359 if [ -n "$dtb" ]; then
 360     addsec $tmp "$dtb" .kernel:dtb
 361     if [ -n "$dts" ]; then
 362         rm $dtb
 363     fi
 364 fi
 365
 366 if [ "$platform" != "miboot" ]; then
 367     if [ -n "$link_address" ] ; then
 368         text_start="-Ttext $link_address"
 369     fi
 370     ${CROSS}ld -m elf32ppc -T $lds $text_start $pie -o "$ofile" \
 371         $platformo $tmp $object/wrapper.a
 372     rm $tmp
 373 fi
 374
 375 # Some platforms need the zImage's entry point and base address
 376 base=0x`${CROSS}nm "$ofile" | grep ' _start$' | cut -d' ' -f1`
 377 entry=`${CROSS}objdump -f "$ofile" | grep '^start address ' | cut -d' ' -f3`
 378
 379 if [ -n "$binary" ]; then
 380     mv "$ofile" "$ofile".elf
 381     ${CROSS}objcopy -O binary "$ofile".elf "$ofile"
 382 fi
 383
 384 # post-processing needed for some platforms
 385 case "$platform" in
 386 pseries|chrp|maple)
 387     $objbin/addnote "$ofile"
 388     ;;
 389 coff)
 390     ${CROSS}objcopy -O aixcoff-rs6000 --set-start "$entry" "$ofile"
 391     $objbin/hack-coff "$ofile"
 392     ;;
 393 cuboot*)
 394     gzip -n -f -9 "$ofile"
 395     ${MKIMAGE} -A ppc -O linux -T kernel -C gzip -a "$base" -e "$entry" \
 396             $uboot_version -d "$ofile".gz "$ofile"
 397     ;;
 398 treeboot*)
 399     mv "$ofile" "$ofile.elf"
 400     $objbin/mktree "$ofile.elf" "$ofile" "$base" "$entry"
 401     if [ -z "$cacheit" ]; then
 402         rm -f "$ofile.elf"
 403     fi
 404     exit 0
 405     ;;
 406 ps3)
 407     # The ps3's loader supports loading a gzipped binary image from flash
 408     # rom to ram addr zero. The loader then enters the system reset
 409     # vector at addr 0x100.  A bootwrapper overlay is used to arrange for
 410     # a binary image of the kernel to be at addr zero, and yet have a
 411     # suitable bootwrapper entry at 0x100.  To construct the final rom
 412     # image 512 bytes from offset 0x100 is copied to the bootwrapper
 413     # place holder at symbol __system_reset_kernel.  The 512 bytes of the
 414     # bootwrapper entry code at symbol __system_reset_overlay is then
 415     # copied to offset 0x100.  At runtime the bootwrapper program copies
 416     # the data at __system_reset_kernel back to addr 0x100.
 417
 418     system_reset_overlay=0x`${CROSS}nm "$ofile" \
 419         | grep ' __system_reset_overlay$'       \
 420         | cut -d' ' -f1`
 421     system_reset_overlay=`printf "%d" $system_reset_overlay`
 422     system_reset_kernel=0x`${CROSS}nm "$ofile" \
 423         | grep ' __system_reset_kernel$'       \
 424         | cut -d' ' -f1`
 425     system_reset_kernel=`printf "%d" $system_reset_kernel`
 426     overlay_dest="256"
 427     overlay_size="512"
 428
 429     ${CROSS}objcopy -O binary "$ofile" "$ofile.bin"
 430
 431     dd if="$ofile.bin" of="$ofile.bin" conv=notrunc   \
 432         skip=$overlay_dest seek=$system_reset_kernel  \
 433         count=$overlay_size bs=1
 434
 435     dd if="$ofile.bin" of="$ofile.bin" conv=notrunc   \
 436         skip=$system_reset_overlay seek=$overlay_dest \
 437         count=$overlay_size bs=1
 438
 439     odir="$(dirname "$ofile.bin")"
 440     rm -f "$odir/otheros.bld"
 441     gzip -n --force -9 --stdout "$ofile.bin" > "$odir/otheros.bld"
 442     ;;
 443 esac