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