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