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