xref: /openbmc/linux/arch/powerpc/boot/wrapper (revision 96de0e252cedffad61b3cb5e05662c591898e69a) 
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# defaults
25kernel=
26ofile=zImage
27platform=of
28initrd=
29dtb=
30dts=
31cacheit=
32binary=
33gzip=.gz
34
35# cross-compilation prefix
36CROSS=
37
38# directory for object and other files used by this script
39object=arch/powerpc/boot
40
41# directory for working files
42tmpdir=.
43
44usage() {
45    echo 'Usage: wrapper [-o output] [-p platform] [-i initrd]' >&2
46    echo '       [-d devtree] [-s tree.dts] [-c] [-C cross-prefix]' >&2
47    echo '       [-D datadir] [-W workingdir] [--no-gzip] [vmlinux]' >&2
48    exit 1
49}
50
51while [ "$#" -gt 0 ]; do
52    case "$1" in
53    -o)
54	shift
55	[ "$#" -gt 0 ] || usage
56	ofile="$1"
57	;;
58    -p)
59	shift
60	[ "$#" -gt 0 ] || usage
61	platform="$1"
62	;;
63    -i)
64	shift
65	[ "$#" -gt 0 ] || usage
66	initrd="$1"
67	;;
68    -d)
69	shift
70	[ "$#" -gt 0 ] || usage
71	dtb="$1"
72	;;
73    -s)
74	shift
75	[ "$#" -gt 0 ] || usage
76	dts="$1"
77	;;
78    -c)
79	cacheit=y
80	;;
81    -C)
82	shift
83	[ "$#" -gt 0 ] || usage
84	CROSS="$1"
85	;;
86    -D)
87	shift
88	[ "$#" -gt 0 ] || usage
89	object="$1"
90	;;
91    -W)
92	shift
93	[ "$#" -gt 0 ] || usage
94	tmpdir="$1"
95	;;
96    --no-gzip)
97        gzip=
98        ;;
99    -?)
100	usage
101	;;
102    *)
103	[ -z "$kernel" ] || usage
104	kernel="$1"
105	;;
106    esac
107    shift
108done
109
110if [ -n "$dts" ]; then
111    if [ -z "$dtb" ]; then
112	dtb="$platform.dtb"
113    fi
114    dtc -O dtb -o "$dtb" -b 0 -V 16 "$dts" || exit 1
115fi
116
117if [ -z "$kernel" ]; then
118    kernel=vmlinux
119fi
120
121platformo=$object/"$platform".o
122lds=$object/zImage.lds
123ext=strip
124objflags=-S
125tmp=$tmpdir/zImage.$$.o
126ksection=.kernel:vmlinux.strip
127isection=.kernel:initrd
128
129case "$platform" in
130pmac|pseries|chrp)
131    platformo=$object/of.o
132    ;;
133coff)
134    platformo=$object/of.o
135    lds=$object/zImage.coff.lds
136    ;;
137miboot|uboot)
138    # miboot and U-boot want just the bare bits, not an ELF binary
139    ext=bin
140    objflags="-O binary"
141    tmp="$ofile"
142    ksection=image
143    isection=initrd
144    ;;
145cuboot*)
146    binary=y
147    gzip=
148    ;;
149ps3)
150    platformo="$object/ps3-head.o $object/ps3-hvcall.o $object/ps3.o"
151    lds=$object/zImage.ps3.lds
152    binary=y
153    gzip=
154    ext=bin
155    objflags="-O binary --set-section-flags=.bss=contents,alloc,load,data"
156    ksection=.kernel:vmlinux.bin
157    isection=.kernel:initrd
158    ;;
159ep88xc)
160    platformo="$object/fixed-head.o $object/$platform.o"
161    binary=y
162    ;;
163esac
164
165vmz="$tmpdir/`basename \"$kernel\"`.$ext"
166if [ -z "$cacheit" -o ! -f "$vmz$gzip" -o "$vmz$gzip" -ot "$kernel" ]; then
167    ${CROSS}objcopy $objflags "$kernel" "$vmz.$$"
168
169    if [ -n "$gzip" ]; then
170        gzip -f -9 "$vmz.$$"
171    fi
172
173    if [ -n "$cacheit" ]; then
174	mv -f "$vmz.$$$gzip" "$vmz$gzip"
175    else
176	vmz="$vmz.$$"
177    fi
178fi
179
180vmz="$vmz$gzip"
181
182# Extract kernel version information, some platforms want to include
183# it in the image header
184version=`${CROSS}strings "$kernel" | grep '^Linux version [-0-9.]' | \
185    cut -d' ' -f3`
186if [ -n "$version" ]; then
187    uboot_version="-n Linux-$version"
188fi
189
190case "$platform" in
191uboot)
192    rm -f "$ofile"
193    mkimage -A ppc -O linux -T kernel -C gzip -a 00000000 -e 00000000 \
194	$uboot_version -d "$vmz" "$ofile"
195    if [ -z "$cacheit" ]; then
196	rm -f "$vmz"
197    fi
198    exit 0
199    ;;
200esac
201
202addsec() {
203    ${CROSS}objcopy $4 $1 \
204	--add-section=$3="$2" \
205	--set-section-flags=$3=contents,alloc,load,readonly,data
206}
207
208addsec $tmp "$vmz" $ksection $object/empty.o
209if [ -z "$cacheit" ]; then
210    rm -f "$vmz"
211fi
212
213if [ -n "$initrd" ]; then
214    addsec $tmp "$initrd" $isection
215fi
216
217if [ -n "$dtb" ]; then
218    addsec $tmp "$dtb" .kernel:dtb
219    if [ -n "$dts" ]; then
220	rm $dtb
221    fi
222fi
223
224if [ "$platform" != "miboot" ]; then
225    ${CROSS}ld -m elf32ppc -T $lds -o "$ofile" \
226	$platformo $tmp $object/wrapper.a
227    rm $tmp
228fi
229
230# Some platforms need the zImage's entry point and base address
231base=0x`${CROSS}nm "$ofile" | grep ' _start$' | cut -d' ' -f1`
232entry=`${CROSS}objdump -f "$ofile" | grep '^start address ' | cut -d' ' -f3`
233
234if [ -n "$binary" ]; then
235    mv "$ofile" "$ofile".elf
236    ${CROSS}objcopy -O binary "$ofile".elf "$ofile".bin
237fi
238
239# post-processing needed for some platforms
240case "$platform" in
241pseries|chrp)
242    $object/addnote "$ofile"
243    ;;
244coff)
245    ${CROSS}objcopy -O aixcoff-rs6000 --set-start "$entry" "$ofile"
246    $object/hack-coff "$ofile"
247    ;;
248cuboot*)
249    gzip -f -9 "$ofile".bin
250    mkimage -A ppc -O linux -T kernel -C gzip -a "$base" -e "$entry" \
251            $uboot_version -d "$ofile".bin.gz "$ofile"
252    ;;
253treeboot*)
254    mv "$ofile" "$ofile.elf"
255    $object/mktree "$ofile.elf" "$ofile" "$base" "$entry"
256    if [ -z "$cacheit" ]; then
257	rm -f "$ofile.elf"
258    fi
259    exit 0
260    ;;
261ps3)
262    # The ps3's loader supports loading gzipped binary images from flash
263    # rom to addr zero. The loader enters the image at addr 0x100.  A
264    # bootwrapper overlay is use to arrange for the kernel to be loaded
265    # to addr zero and to have a suitable bootwrapper entry at 0x100.
266    # To construct the rom image, 0x100 bytes from offset 0x100 in the
267    # kernel is copied to the bootwrapper symbol __system_reset_kernel.
268    # The 0x100 bytes at the bootwrapper symbol __system_reset_overlay is
269    # then copied to offset 0x100.  At runtime the bootwrapper program
270    # copies the 0x100 bytes at __system_reset_kernel to addr 0x100.
271
272    system_reset_overlay=0x`${CROSS}nm "$ofile".elf \
273        | grep ' __system_reset_overlay$'       \
274        | cut -d' ' -f1`
275    system_reset_overlay=`printf "%d" $system_reset_overlay`
276    system_reset_kernel=0x`${CROSS}nm "$ofile".elf \
277        | grep ' __system_reset_kernel$'       \
278        | cut -d' ' -f1`
279    system_reset_kernel=`printf "%d" $system_reset_kernel`
280    overlay_dest="256"
281    overlay_size="256"
282
283    rm -f "$object/otheros.bld"
284
285    msg=$(dd if="$ofile.bin" of="$ofile.bin" conv=notrunc \
286        skip=$overlay_dest seek=$system_reset_kernel      \
287        count=$overlay_size bs=1 2>&1)
288
289    if [ $? -ne "0" ]; then
290       echo $msg
291       exit 1
292    fi
293
294    msg=$(dd if="$ofile.bin" of="$ofile.bin" conv=notrunc \
295        skip=$system_reset_overlay seek=$overlay_dest     \
296        count=$overlay_size bs=1 2>&1)
297
298    if [ $? -ne "0" ]; then
299       echo $msg
300       exit 2
301    fi
302
303    gzip --force -9 --stdout "$ofile.bin" > "$object/otheros.bld"
304    ;;
305esac
306