xref: /openbmc/linux/arch/powerpc/boot/wrapper (revision 84d517f3) 
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
25set -e
26
27# Allow for verbose output
28if [ "$V" = 1 ]; then
29    set -x
30fi
31
32# defaults
33kernel=
34ofile=zImage
35platform=of
36initrd=
37dtb=
38dts=
39cacheit=
40binary=
41gzip=.gz
42pie=
43
44# cross-compilation prefix
45CROSS=
46
47# mkimage wrapper script
48MKIMAGE=$srctree/scripts/mkuboot.sh
49
50# directory for object and other files used by this script
51object=arch/powerpc/boot
52objbin=$object
53dtc=scripts/dtc/dtc
54
55# directory for working files
56tmpdir=.
57
58usage() {
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
65while [ "$#" -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
123done
124
125if [ -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"
133fi
134
135if [ -z "$kernel" ]; then
136    kernel=vmlinux
137fi
138
139platformo=$object/"$platform".o
140lds=$object/zImage.lds
141ext=strip
142objflags=-S
143tmp=$tmpdir/zImage.$$.o
144ksection=.kernel:vmlinux.strip
145isection=.kernel:initrd
146link_address='0x400000'
147make_space=y
148
149case "$platform" in
150of)
151    platformo="$object/of.o $object/epapr.o"
152    make_space=n
153    ;;
154pseries)
155    platformo="$object/of.o $object/epapr.o"
156    link_address='0x4000000'
157    make_space=n
158    ;;
159maple)
160    platformo="$object/of.o $object/epapr.o"
161    link_address='0x400000'
162    make_space=n
163    ;;
164pmac|chrp)
165    platformo="$object/of.o $object/epapr.o"
166    make_space=n
167    ;;
168coff)
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    ;;
175miboot|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    ;;
183cuboot*)
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    ;;
213ps3)
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    ;;
225ep88xc|ep405|ep8248e)
226    platformo="$object/fixed-head.o $object/$platform.o"
227    binary=y
228    ;;
229adder875-redboot)
230    platformo="$object/fixed-head.o $object/redboot-8xx.o"
231    binary=y
232    ;;
233simpleboot-virtex405-*)
234    platformo="$object/virtex405-head.o $object/simpleboot.o $object/virtex.o"
235    binary=y
236    ;;
237simpleboot-virtex440-*)
238    platformo="$object/fixed-head.o $object/simpleboot.o $object/virtex.o"
239    binary=y
240    ;;
241simpleboot-*)
242    platformo="$object/fixed-head.o $object/simpleboot.o"
243    binary=y
244    ;;
245asp834x-redboot)
246    platformo="$object/fixed-head.o $object/redboot-83xx.o"
247    binary=y
248    ;;
249xpedite52*)
250    link_address='0x1400000'
251    platformo=$object/cuboot-85xx.o
252    ;;
253gamecube|wii)
254    link_address='0x600000'
255    platformo="$object/$platform-head.o $object/$platform.o"
256    ;;
257treeboot-currituck)
258    link_address='0x1000000'
259    ;;
260treeboot-iss4xx-mpic)
261    platformo="$object/treeboot-iss4xx.o"
262    ;;
263epapr)
264    platformo="$object/epapr.o $object/epapr-wrapper.o"
265    link_address='0x20000000'
266    pie=-pie
267    ;;
268mvme5100)
269    platformo="$object/fixed-head.o $object/mvme5100.o"
270    binary=y
271    ;;
272esac
273
274vmz="$tmpdir/`basename \"$kernel\"`.$ext"
275if [ -z "$cacheit" -o ! -f "$vmz$gzip" -o "$vmz$gzip" -ot "$kernel" ]; then
276    ${CROSS}objcopy $objflags "$kernel" "$vmz.$$"
277
278    strip_size=$(stat -c %s $vmz.$$)
279
280    if [ -n "$gzip" ]; then
281        gzip -n -f -9 "$vmz.$$"
282    fi
283
284    if [ -n "$cacheit" ]; then
285	mv -f "$vmz.$$$gzip" "$vmz$gzip"
286    else
287	vmz="$vmz.$$"
288    fi
289else
290    # Calculate the vmlinux.strip size
291    ${CROSS}objcopy $objflags "$kernel" "$vmz.$$"
292    strip_size=$(stat -c %s $vmz.$$)
293    rm -f $vmz.$$
294fi
295
296if [ "$make_space" = "y" ]; then
297	# Round the size to next higher MB limit
298	round_size=$(((strip_size + 0xfffff) & 0xfff00000))
299
300	round_size=0x$(printf "%x" $round_size)
301	link_addr=$(printf "%d" $link_address)
302
303	if [ $link_addr -lt $strip_size ]; then
304	    echo "INFO: Uncompressed kernel (size 0x$(printf "%x\n" $strip_size))" \
305			"overlaps the address of the wrapper($link_address)"
306	    echo "INFO: Fixing the link_address of wrapper to ($round_size)"
307	    link_address=$round_size
308	fi
309fi
310
311vmz="$vmz$gzip"
312
313# Extract kernel version information, some platforms want to include
314# it in the image header
315version=`${CROSS}strings "$kernel" | grep '^Linux version [-0-9.]' | \
316    cut -d' ' -f3`
317if [ -n "$version" ]; then
318    uboot_version="-n Linux-$version"
319fi
320
321# physical offset of kernel image
322membase=`${CROSS}objdump -p "$kernel" | grep -m 1 LOAD | awk '{print $7}'`
323
324case "$platform" in
325uboot)
326    rm -f "$ofile"
327    ${MKIMAGE} -A ppc -O linux -T kernel -C gzip -a $membase -e $membase \
328	$uboot_version -d "$vmz" "$ofile"
329    if [ -z "$cacheit" ]; then
330	rm -f "$vmz"
331    fi
332    exit 0
333    ;;
334uboot-obs600)
335    rm -f "$ofile"
336    # obs600 wants a multi image with an initrd, so we need to put a fake
337    # one in even when building a "normal" image.
338    if [ -n "$initrd" ]; then
339	real_rd="$initrd"
340    else
341	real_rd=`mktemp`
342	echo "\0" >>"$real_rd"
343    fi
344    ${MKIMAGE} -A ppc -O linux -T multi -C gzip -a $membase -e $membase \
345	$uboot_version -d "$vmz":"$real_rd":"$dtb" "$ofile"
346    if [ -z "$initrd" ]; then
347	rm -f "$real_rd"
348    fi
349    if [ -z "$cacheit" ]; then
350	rm -f "$vmz"
351    fi
352    exit 0
353    ;;
354esac
355
356addsec() {
357    ${CROSS}objcopy $4 $1 \
358	--add-section=$3="$2" \
359	--set-section-flags=$3=contents,alloc,load,readonly,data
360}
361
362addsec $tmp "$vmz" $ksection $object/empty.o
363if [ -z "$cacheit" ]; then
364    rm -f "$vmz"
365fi
366
367if [ -n "$initrd" ]; then
368    addsec $tmp "$initrd" $isection
369fi
370
371if [ -n "$dtb" ]; then
372    addsec $tmp "$dtb" .kernel:dtb
373    if [ -n "$dts" ]; then
374	rm $dtb
375    fi
376fi
377
378if [ "$platform" != "miboot" ]; then
379    if [ -n "$link_address" ] ; then
380        text_start="-Ttext $link_address"
381    fi
382    ${CROSS}ld -m elf32ppc -T $lds $text_start $pie -o "$ofile" \
383	$platformo $tmp $object/wrapper.a
384    rm $tmp
385fi
386
387# Some platforms need the zImage's entry point and base address
388base=0x`${CROSS}nm "$ofile" | grep ' _start$' | cut -d' ' -f1`
389entry=`${CROSS}objdump -f "$ofile" | grep '^start address ' | cut -d' ' -f3`
390
391if [ -n "$binary" ]; then
392    mv "$ofile" "$ofile".elf
393    ${CROSS}objcopy -O binary "$ofile".elf "$ofile"
394fi
395
396# post-processing needed for some platforms
397case "$platform" in
398pseries|chrp|maple)
399    $objbin/addnote "$ofile"
400    ;;
401coff)
402    ${CROSS}objcopy -O aixcoff-rs6000 --set-start "$entry" "$ofile"
403    $objbin/hack-coff "$ofile"
404    ;;
405cuboot*)
406    gzip -n -f -9 "$ofile"
407    ${MKIMAGE} -A ppc -O linux -T kernel -C gzip -a "$base" -e "$entry" \
408            $uboot_version -d "$ofile".gz "$ofile"
409    ;;
410treeboot*)
411    mv "$ofile" "$ofile.elf"
412    $objbin/mktree "$ofile.elf" "$ofile" "$base" "$entry"
413    if [ -z "$cacheit" ]; then
414	rm -f "$ofile.elf"
415    fi
416    exit 0
417    ;;
418ps3)
419    # The ps3's loader supports loading a gzipped binary image from flash
420    # rom to ram addr zero. The loader then enters the system reset
421    # vector at addr 0x100.  A bootwrapper overlay is used to arrange for
422    # a binary image of the kernel to be at addr zero, and yet have a
423    # suitable bootwrapper entry at 0x100.  To construct the final rom
424    # image 512 bytes from offset 0x100 is copied to the bootwrapper
425    # place holder at symbol __system_reset_kernel.  The 512 bytes of the
426    # bootwrapper entry code at symbol __system_reset_overlay is then
427    # copied to offset 0x100.  At runtime the bootwrapper program copies
428    # the data at __system_reset_kernel back to addr 0x100.
429
430    system_reset_overlay=0x`${CROSS}nm "$ofile" \
431        | grep ' __system_reset_overlay$'       \
432        | cut -d' ' -f1`
433    system_reset_overlay=`printf "%d" $system_reset_overlay`
434    system_reset_kernel=0x`${CROSS}nm "$ofile" \
435        | grep ' __system_reset_kernel$'       \
436        | cut -d' ' -f1`
437    system_reset_kernel=`printf "%d" $system_reset_kernel`
438    overlay_dest="256"
439    overlay_size="512"
440
441    ${CROSS}objcopy -O binary "$ofile" "$ofile.bin"
442
443    dd if="$ofile.bin" of="$ofile.bin" conv=notrunc   \
444        skip=$overlay_dest seek=$system_reset_kernel  \
445        count=$overlay_size bs=1
446
447    dd if="$ofile.bin" of="$ofile.bin" conv=notrunc   \
448        skip=$system_reset_overlay seek=$overlay_dest \
449        count=$overlay_size bs=1
450
451    odir="$(dirname "$ofile.bin")"
452    rm -f "$odir/otheros.bld"
453    gzip -n --force -9 --stdout "$ofile.bin" > "$odir/otheros.bld"
454    ;;
455esac
456