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