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