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 of)
 151     platformo="$object/of.o $object/epapr.o"
 152     make_space=n
 153     ;;
 154 pseries)
 155     platformo="$object/of.o $object/epapr.o"
 156     link_address='0x4000000'
 157     make_space=n
 158     ;;
 159 maple)
 160     platformo="$object/of.o $object/epapr.o"
 161     link_address='0x400000'
 162     make_space=n
 163     ;;
 164 pmac|chrp)
 165     platformo="$object/of.o $object/epapr.o"
 166     make_space=n
 167     ;;
 168 coff)
 169     platformo="$object/crt0.o $object/of.o $object/epapr.o"
 170     lds=$object/zImage.coff.lds
 171     link_address='0x500000'
 172     make_space=n
 173     pie=
 174     ;;
 175 miboot|uboot*)
 176     # miboot and U-boot want just the bare bits, not an ELF binary
 177     ext=bin
 178     objflags="-O binary"
 179     tmp="$ofile"
 180     ksection=image
 181     isection=initrd
 182     ;;
 183 cuboot*)
 184     binary=y
 185     gzip=
 186     case "$platform" in
 187     *-mpc866ads|*-mpc885ads|*-adder875*|*-ep88xc)
 188         platformo=$object/cuboot-8xx.o
 189         ;;
 190     *5200*|*-motionpro)
 191         platformo=$object/cuboot-52xx.o
 192         ;;
 193     *-pq2fads|*-ep8248e|*-mpc8272*|*-storcenter)
 194         platformo=$object/cuboot-pq2.o
 195         ;;
 196     *-mpc824*)
 197         platformo=$object/cuboot-824x.o
 198         ;;
 199     *-mpc83*|*-asp834x*)
 200         platformo=$object/cuboot-83xx.o
 201         ;;
 202     *-tqm8541|*-mpc8560*|*-tqm8560|*-tqm8555|*-ksi8560*)
 203         platformo=$object/cuboot-85xx-cpm2.o
 204         ;;
 205     *-mpc85*|*-tqm85*|*-sbc85*)
 206         platformo=$object/cuboot-85xx.o
 207         ;;
 208     *-amigaone)
 209         link_address='0x800000'
 210         ;;
 211     esac
 212     ;;
 213 ps3)
 214     platformo="$object/ps3-head.o $object/ps3-hvcall.o $object/ps3.o"
 215     lds=$object/zImage.ps3.lds
 216     gzip=
 217     ext=bin
 218     objflags="-O binary --set-section-flags=.bss=contents,alloc,load,data"
 219     ksection=.kernel:vmlinux.bin
 220     isection=.kernel:initrd
 221     link_address=''
 222     make_space=n
 223     pie=
 224     ;;
 225 ep88xc|ep405|ep8248e)
 226     platformo="$object/fixed-head.o $object/$platform.o"
 227     binary=y
 228     ;;
 229 adder875-redboot)
 230     platformo="$object/fixed-head.o $object/redboot-8xx.o"
 231     binary=y
 232     ;;
 233 simpleboot-virtex405-*)
 234     platformo="$object/virtex405-head.o $object/simpleboot.o $object/virtex.o"
 235     binary=y
 236     ;;
 237 simpleboot-virtex440-*)
 238     platformo="$object/fixed-head.o $object/simpleboot.o $object/virtex.o"
 239     binary=y
 240     ;;
 241 simpleboot-*)
 242     platformo="$object/fixed-head.o $object/simpleboot.o"
 243     binary=y
 244     ;;
 245 asp834x-redboot)
 246     platformo="$object/fixed-head.o $object/redboot-83xx.o"
 247     binary=y
 248     ;;
 249 xpedite52*)
 250     link_address='0x1400000'
 251     platformo=$object/cuboot-85xx.o
 252     ;;
 253 gamecube|wii)
 254     link_address='0x600000'
 255     platformo="$object/$platform-head.o $object/$platform.o"
 256     ;;
 257 treeboot-currituck)
 258     link_address='0x1000000'
 259     ;;
 260 treeboot-iss4xx-mpic)
 261     platformo="$object/treeboot-iss4xx.o"
 262     ;;
 263 epapr)
 264     platformo="$object/epapr.o $object/epapr-wrapper.o"
 265     link_address='0x20000000'
 266     pie=-pie
 267     ;;
 268 esac
 269
 270 vmz="$tmpdir/`basename \"$kernel\"`.$ext"
 271 if [ -z "$cacheit" -o ! -f "$vmz$gzip" -o "$vmz$gzip" -ot "$kernel" ]; then
 272     ${CROSS}objcopy $objflags "$kernel" "$vmz.$$"
 273
 274     strip_size=$(stat -c %s $vmz.$$)
 275
 276     if [ -n "$gzip" ]; then
 277         gzip -n -f -9 "$vmz.$$"
 278     fi
 279
 280     if [ -n "$cacheit" ]; then
 281         mv -f "$vmz.$$$gzip" "$vmz$gzip"
 282     else
 283         vmz="$vmz.$$"
 284     fi
 285 else
 286     # Calculate the vmlinux.strip size
 287     ${CROSS}objcopy $objflags "$kernel" "$vmz.$$"
 288     strip_size=$(stat -c %s $vmz.$$)
 289     rm -f $vmz.$$
 290 fi
 291
 292 if [ "$make_space" = "y" ]; then
 293         # Round the size to next higher MB limit
 294         round_size=$(((strip_size + 0xfffff) & 0xfff00000))
 295
 296         round_size=0x$(printf "%x" $round_size)
 297         link_addr=$(printf "%d" $link_address)
 298
 299         if [ $link_addr -lt $strip_size ]; then
 300             echo "INFO: Uncompressed kernel (size 0x$(printf "%x\n" $strip_size))" \
 301                         "overlaps the address of the wrapper($link_address)"
 302             echo "INFO: Fixing the link_address of wrapper to ($round_size)"
 303             link_address=$round_size
 304         fi
 305 fi
 306
 307 vmz="$vmz$gzip"
 308
 309 # Extract kernel version information, some platforms want to include
 310 # it in the image header
 311 version=`${CROSS}strings "$kernel" | grep '^Linux version [-0-9.]' | \
 312     cut -d' ' -f3`
 313 if [ -n "$version" ]; then
 314     uboot_version="-n Linux-$version"
 315 fi
 316
 317 # physical offset of kernel image
 318 membase=`${CROSS}objdump -p "$kernel" | grep -m 1 LOAD | awk '{print $7}'`
 319
 320 case "$platform" in
 321 uboot)
 322     rm -f "$ofile"
 323     ${MKIMAGE} -A ppc -O linux -T kernel -C gzip -a $membase -e $membase \
 324         $uboot_version -d "$vmz" "$ofile"
 325     if [ -z "$cacheit" ]; then
 326         rm -f "$vmz"
 327     fi
 328     exit 0
 329     ;;
 330 uboot-obs600)
 331     rm -f "$ofile"
 332     # obs600 wants a multi image with an initrd, so we need to put a fake
 333     # one in even when building a "normal" image.
 334     if [ -n "$initrd" ]; then
 335         real_rd="$initrd"
 336     else
 337         real_rd=`mktemp`
 338         echo "\0" >>"$real_rd"
 339     fi
 340     ${MKIMAGE} -A ppc -O linux -T multi -C gzip -a $membase -e $membase \
 341         $uboot_version -d "$vmz":"$real_rd":"$dtb" "$ofile"
 342     if [ -z "$initrd" ]; then
 343         rm -f "$real_rd"
 344     fi
 345     if [ -z "$cacheit" ]; then
 346         rm -f "$vmz"
 347     fi
 348     exit 0
 349     ;;
 350 esac
 351
 352 addsec() {
 353     ${CROSS}objcopy $4 $1 \
 354         --add-section=$3="$2" \
 355         --set-section-flags=$3=contents,alloc,load,readonly,data
 356 }
 357
 358 addsec $tmp "$vmz" $ksection $object/empty.o
 359 if [ -z "$cacheit" ]; then
 360     rm -f "$vmz"
 361 fi
 362
 363 if [ -n "$initrd" ]; then
 364     addsec $tmp "$initrd" $isection
 365 fi
 366
 367 if [ -n "$dtb" ]; then
 368     addsec $tmp "$dtb" .kernel:dtb
 369     if [ -n "$dts" ]; then
 370         rm $dtb
 371     fi
 372 fi
 373
 374 if [ "$platform" != "miboot" ]; then
 375     if [ -n "$link_address" ] ; then
 376         text_start="-Ttext $link_address"
 377     fi
 378     ${CROSS}ld -m elf32ppc -T $lds $text_start $pie -o "$ofile" \
 379         $platformo $tmp $object/wrapper.a
 380     rm $tmp
 381 fi
 382
 383 # Some platforms need the zImage's entry point and base address
 384 base=0x`${CROSS}nm "$ofile" | grep ' _start$' | cut -d' ' -f1`
 385 entry=`${CROSS}objdump -f "$ofile" | grep '^start address ' | cut -d' ' -f3`
 386
 387 if [ -n "$binary" ]; then
 388     mv "$ofile" "$ofile".elf
 389     ${CROSS}objcopy -O binary "$ofile".elf "$ofile"
 390 fi
 391
 392 # post-processing needed for some platforms
 393 case "$platform" in
 394 pseries|chrp|maple)
 395     $objbin/addnote "$ofile"
 396     ;;
 397 coff)
 398     ${CROSS}objcopy -O aixcoff-rs6000 --set-start "$entry" "$ofile"
 399     $objbin/hack-coff "$ofile"
 400     ;;
 401 cuboot*)
 402     gzip -n -f -9 "$ofile"
 403     ${MKIMAGE} -A ppc -O linux -T kernel -C gzip -a "$base" -e "$entry" \
 404             $uboot_version -d "$ofile".gz "$ofile"
 405     ;;
 406 treeboot*)
 407     mv "$ofile" "$ofile.elf"
 408     $objbin/mktree "$ofile.elf" "$ofile" "$base" "$entry"
 409     if [ -z "$cacheit" ]; then
 410         rm -f "$ofile.elf"
 411     fi
 412     exit 0
 413     ;;
 414 ps3)
 415     # The ps3's loader supports loading a gzipped binary image from flash
 416     # rom to ram addr zero. The loader then enters the system reset
 417     # vector at addr 0x100.  A bootwrapper overlay is used to arrange for
 418     # a binary image of the kernel to be at addr zero, and yet have a
 419     # suitable bootwrapper entry at 0x100.  To construct the final rom
 420     # image 512 bytes from offset 0x100 is copied to the bootwrapper
 421     # place holder at symbol __system_reset_kernel.  The 512 bytes of the
 422     # bootwrapper entry code at symbol __system_reset_overlay is then
 423     # copied to offset 0x100.  At runtime the bootwrapper program copies
 424     # the data at __system_reset_kernel back to addr 0x100.
 425
 426     system_reset_overlay=0x`${CROSS}nm "$ofile" \
 427         | grep ' __system_reset_overlay$'       \
 428         | cut -d' ' -f1`
 429     system_reset_overlay=`printf "%d" $system_reset_overlay`
 430     system_reset_kernel=0x`${CROSS}nm "$ofile" \
 431         | grep ' __system_reset_kernel$'       \
 432         | cut -d' ' -f1`
 433     system_reset_kernel=`printf "%d" $system_reset_kernel`
 434     overlay_dest="256"
 435     overlay_size="512"
 436
 437     ${CROSS}objcopy -O binary "$ofile" "$ofile.bin"
 438
 439     dd if="$ofile.bin" of="$ofile.bin" conv=notrunc   \
 440         skip=$overlay_dest seek=$system_reset_kernel  \
 441         count=$overlay_size bs=1
 442
 443     dd if="$ofile.bin" of="$ofile.bin" conv=notrunc   \
 444         skip=$system_reset_overlay seek=$overlay_dest \
 445         count=$overlay_size bs=1
 446
 447     odir="$(dirname "$ofile.bin")"
 448     rm -f "$odir/otheros.bld"
 449     gzip -n --force -9 --stdout "$ofile.bin" > "$odir/otheros.bld"
 450     ;;
 451 esac