xref: /openbmc/linux/arch/powerpc/boot/wrapper (revision 643d1f7f) 
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
141
142case "$platform" in
143pmac|pseries|chrp)
144    platformo=$object/of.o
145    ;;
146coff)
147    platformo=$object/of.o
148    lds=$object/zImage.coff.lds
149    ;;
150miboot|uboot)
151    # miboot and U-boot want just the bare bits, not an ELF binary
152    ext=bin
153    objflags="-O binary"
154    tmp="$ofile"
155    ksection=image
156    isection=initrd
157    ;;
158cuboot*)
159    binary=y
160    gzip=
161    ;;
162ps3)
163    platformo="$object/ps3-head.o $object/ps3-hvcall.o $object/ps3.o"
164    lds=$object/zImage.ps3.lds
165    gzip=
166    ext=bin
167    objflags="-O binary --set-section-flags=.bss=contents,alloc,load,data"
168    ksection=.kernel:vmlinux.bin
169    isection=.kernel:initrd
170    ;;
171ep88xc|ep405|redboot*|ep8248e)
172    platformo="$object/fixed-head.o $object/$platform.o"
173    binary=y
174    ;;
175esac
176
177vmz="$tmpdir/`basename \"$kernel\"`.$ext"
178if [ -z "$cacheit" -o ! -f "$vmz$gzip" -o "$vmz$gzip" -ot "$kernel" ]; then
179    ${CROSS}objcopy $objflags "$kernel" "$vmz.$$"
180
181    if [ -n "$gzip" ]; then
182        gzip -f -9 "$vmz.$$"
183    fi
184
185    if [ -n "$cacheit" ]; then
186	mv -f "$vmz.$$$gzip" "$vmz$gzip"
187    else
188	vmz="$vmz.$$"
189    fi
190fi
191
192vmz="$vmz$gzip"
193
194# Extract kernel version information, some platforms want to include
195# it in the image header
196version=`${CROSS}strings "$kernel" | grep '^Linux version [-0-9.]' | \
197    cut -d' ' -f3`
198if [ -n "$version" ]; then
199    uboot_version="-n Linux-$version"
200fi
201
202case "$platform" in
203uboot)
204    rm -f "$ofile"
205    mkimage -A ppc -O linux -T kernel -C gzip -a 00000000 -e 00000000 \
206	$uboot_version -d "$vmz" "$ofile"
207    if [ -z "$cacheit" ]; then
208	rm -f "$vmz"
209    fi
210    exit 0
211    ;;
212esac
213
214addsec() {
215    ${CROSS}objcopy $4 $1 \
216	--add-section=$3="$2" \
217	--set-section-flags=$3=contents,alloc,load,readonly,data
218}
219
220addsec $tmp "$vmz" $ksection $object/empty.o
221if [ -z "$cacheit" ]; then
222    rm -f "$vmz"
223fi
224
225if [ -n "$initrd" ]; then
226    addsec $tmp "$initrd" $isection
227fi
228
229if [ -n "$dtb" ]; then
230    addsec $tmp "$dtb" .kernel:dtb
231    if [ -n "$dts" ]; then
232	rm $dtb
233    fi
234fi
235
236if [ "$platform" != "miboot" ]; then
237    ${CROSS}ld -m elf32ppc -T $lds -o "$ofile" \
238	$platformo $tmp $object/wrapper.a
239    rm $tmp
240fi
241
242# Some platforms need the zImage's entry point and base address
243base=0x`${CROSS}nm "$ofile" | grep ' _start$' | cut -d' ' -f1`
244entry=`${CROSS}objdump -f "$ofile" | grep '^start address ' | cut -d' ' -f3`
245
246if [ -n "$binary" ]; then
247    mv "$ofile" "$ofile".elf
248    ${CROSS}objcopy -O binary "$ofile".elf "$ofile"
249fi
250
251# post-processing needed for some platforms
252case "$platform" in
253pseries|chrp)
254    $objbin/addnote "$ofile"
255    ;;
256coff)
257    ${CROSS}objcopy -O aixcoff-rs6000 --set-start "$entry" "$ofile"
258    $objbin/hack-coff "$ofile"
259    ;;
260cuboot*)
261    gzip -f -9 "$ofile"
262    mkimage -A ppc -O linux -T kernel -C gzip -a "$base" -e "$entry" \
263            $uboot_version -d "$ofile".gz "$ofile"
264    ;;
265treeboot*)
266    mv "$ofile" "$ofile.elf"
267    $objbin/mktree "$ofile.elf" "$ofile" "$base" "$entry"
268    if [ -z "$cacheit" ]; then
269	rm -f "$ofile.elf"
270    fi
271    exit 0
272    ;;
273ps3)
274    # The ps3's loader supports loading gzipped binary images from flash
275    # rom to addr zero. The loader enters the image at addr 0x100.  A
276    # bootwrapper overlay is use to arrange for the kernel to be loaded
277    # to addr zero and to have a suitable bootwrapper entry at 0x100.
278    # To construct the rom image, 0x100 bytes from offset 0x100 in the
279    # kernel is copied to the bootwrapper symbol __system_reset_kernel.
280    # The 0x100 bytes at the bootwrapper symbol __system_reset_overlay is
281    # then copied to offset 0x100.  At runtime the bootwrapper program
282    # copies the 0x100 bytes at __system_reset_kernel to addr 0x100.
283
284    system_reset_overlay=0x`${CROSS}nm "$ofile" \
285        | grep ' __system_reset_overlay$'       \
286        | cut -d' ' -f1`
287    system_reset_overlay=`printf "%d" $system_reset_overlay`
288    system_reset_kernel=0x`${CROSS}nm "$ofile" \
289        | grep ' __system_reset_kernel$'       \
290        | cut -d' ' -f1`
291    system_reset_kernel=`printf "%d" $system_reset_kernel`
292    overlay_dest="256"
293    overlay_size="256"
294
295    ${CROSS}objcopy -O binary "$ofile" "$ofile.bin"
296
297    dd if="$ofile.bin" of="$ofile.bin" conv=notrunc   \
298        skip=$overlay_dest seek=$system_reset_kernel  \
299        count=$overlay_size bs=1
300
301    dd if="$ofile.bin" of="$ofile.bin" conv=notrunc   \
302        skip=$system_reset_overlay seek=$overlay_dest \
303        count=$overlay_size bs=1
304
305    odir="$(dirname "$ofile.bin")"
306    rm -f "$odir/otheros.bld"
307    gzip --force -9 --stdout "$ofile.bin" > "$odir/otheros.bld"
308    ;;
309esac
310