d50e498a072b99cd50af01960655a8edae9af27e
[linux-2.6.git] / arch / powerpc / boot / wrapper
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
25 set -e
26
27 # Allow for verbose output
28 if [ "$V" = 1 ]; then
29     set -x
30 fi
31
32 # defaults
33 kernel=
34 ofile=zImage
35 platform=of
36 initrd=
37 dtb=
38 dts=
39 cacheit=
40 binary=
41 gzip=.gz
42
43 # cross-compilation prefix
44 CROSS=
45
46 # directory for object and other files used by this script
47 object=arch/powerpc/boot
48 objbin=$object
49
50 # directory for working files
51 tmpdir=.
52
53 usage() {
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
60 while [ "$#" -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
118 done
119
120 if [ -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"
128 fi
129
130 if [ -z "$kernel" ]; then
131     kernel=vmlinux
132 fi
133
134 platformo=$object/"$platform".o
135 lds=$object/zImage.lds
136 ext=strip
137 objflags=-S
138 tmp=$tmpdir/zImage.$$.o
139 ksection=.kernel:vmlinux.strip
140 isection=.kernel:initrd
141
142 case "$platform" in
143 pmac|pseries|chrp)
144     platformo=$object/of.o
145     ;;
146 coff)
147     platformo=$object/of.o
148     lds=$object/zImage.coff.lds
149     ;;
150 miboot|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     ;;
158 cuboot*)
159     binary=y
160     gzip=
161     case "$platform" in
162     *-mpc885ads|*-adder875*|*-ep88xc)
163         platformo=$object/cuboot-8xx.o
164         ;;
165     *5200*|*-motionpro)
166         platformo=$object/cuboot-52xx.o
167         ;;
168     *-pq2fads|*-ep8248e|*-mpc8272*|*-storcenter)
169         platformo=$object/cuboot-pq2.o
170         ;;
171     *-mpc824*)
172         platformo=$object/cuboot-824x.o
173         ;;
174     *-mpc83*)
175         platformo=$object/cuboot-83xx.o
176         ;;
177     *-tqm8541|*-mpc8560*|*-tqm8560|*-tqm8555*)
178         platformo=$object/cuboot-85xx-cpm2.o
179         ;;
180     *-mpc85*)
181         platformo=$object/cuboot-85xx.o
182         ;;
183     esac
184     ;;
185 ps3)
186     platformo="$object/ps3-head.o $object/ps3-hvcall.o $object/ps3.o"
187     lds=$object/zImage.ps3.lds
188     gzip=
189     ext=bin
190     objflags="-O binary --set-section-flags=.bss=contents,alloc,load,data"
191     ksection=.kernel:vmlinux.bin
192     isection=.kernel:initrd
193     ;;
194 ep88xc|ep405|ep8248e)
195     platformo="$object/fixed-head.o $object/$platform.o"
196     binary=y
197     ;;
198 adder875-redboot)
199     platformo="$object/fixed-head.o $object/redboot-8xx.o"
200     binary=y
201     ;;
202 esac
203
204 vmz="$tmpdir/`basename \"$kernel\"`.$ext"
205 if [ -z "$cacheit" -o ! -f "$vmz$gzip" -o "$vmz$gzip" -ot "$kernel" ]; then
206     ${CROSS}objcopy $objflags "$kernel" "$vmz.$$"
207
208     if [ -n "$gzip" ]; then
209         gzip -f -9 "$vmz.$$"
210     fi
211
212     if [ -n "$cacheit" ]; then
213         mv -f "$vmz.$$$gzip" "$vmz$gzip"
214     else
215         vmz="$vmz.$$"
216     fi
217 fi
218
219 vmz="$vmz$gzip"
220
221 # Extract kernel version information, some platforms want to include
222 # it in the image header
223 version=`${CROSS}strings "$kernel" | grep '^Linux version [-0-9.]' | \
224     cut -d' ' -f3`
225 if [ -n "$version" ]; then
226     uboot_version="-n Linux-$version"
227 fi
228
229 case "$platform" in
230 uboot)
231     rm -f "$ofile"
232     mkimage -A ppc -O linux -T kernel -C gzip -a 00000000 -e 00000000 \
233         $uboot_version -d "$vmz" "$ofile"
234     if [ -z "$cacheit" ]; then
235         rm -f "$vmz"
236     fi
237     exit 0
238     ;;
239 esac
240
241 addsec() {
242     ${CROSS}objcopy $4 $1 \
243         --add-section=$3="$2" \
244         --set-section-flags=$3=contents,alloc,load,readonly,data
245 }
246
247 addsec $tmp "$vmz" $ksection $object/empty.o
248 if [ -z "$cacheit" ]; then
249     rm -f "$vmz"
250 fi
251
252 if [ -n "$initrd" ]; then
253     addsec $tmp "$initrd" $isection
254 fi
255
256 if [ -n "$dtb" ]; then
257     addsec $tmp "$dtb" .kernel:dtb
258     if [ -n "$dts" ]; then
259         rm $dtb
260     fi
261 fi
262
263 if [ "$platform" != "miboot" ]; then
264     ${CROSS}ld -m elf32ppc -T $lds -o "$ofile" \
265         $platformo $tmp $object/wrapper.a
266     rm $tmp
267 fi
268
269 # Some platforms need the zImage's entry point and base address
270 base=0x`${CROSS}nm "$ofile" | grep ' _start$' | cut -d' ' -f1`
271 entry=`${CROSS}objdump -f "$ofile" | grep '^start address ' | cut -d' ' -f3`
272
273 if [ -n "$binary" ]; then
274     mv "$ofile" "$ofile".elf
275     ${CROSS}objcopy -O binary "$ofile".elf "$ofile"
276 fi
277
278 # post-processing needed for some platforms
279 case "$platform" in
280 pseries|chrp)
281     $objbin/addnote "$ofile"
282     ;;
283 coff)
284     ${CROSS}objcopy -O aixcoff-rs6000 --set-start "$entry" "$ofile"
285     $objbin/hack-coff "$ofile"
286     ;;
287 cuboot*)
288     gzip -f -9 "$ofile"
289     mkimage -A ppc -O linux -T kernel -C gzip -a "$base" -e "$entry" \
290             $uboot_version -d "$ofile".gz "$ofile"
291     ;;
292 treeboot*)
293     mv "$ofile" "$ofile.elf"
294     $objbin/mktree "$ofile.elf" "$ofile" "$base" "$entry"
295     if [ -z "$cacheit" ]; then
296         rm -f "$ofile.elf"
297     fi
298     exit 0
299     ;;
300 ps3)
301     # The ps3's loader supports loading gzipped binary images from flash
302     # rom to addr zero. The loader enters the image at addr 0x100.  A
303     # bootwrapper overlay is use to arrange for the kernel to be loaded
304     # to addr zero and to have a suitable bootwrapper entry at 0x100.
305     # To construct the rom image, 0x100 bytes from offset 0x100 in the
306     # kernel is copied to the bootwrapper symbol __system_reset_kernel.
307     # The 0x100 bytes at the bootwrapper symbol __system_reset_overlay is
308     # then copied to offset 0x100.  At runtime the bootwrapper program
309     # copies the 0x100 bytes at __system_reset_kernel to addr 0x100.
310
311     system_reset_overlay=0x`${CROSS}nm "$ofile" \
312         | grep ' __system_reset_overlay$'       \
313         | cut -d' ' -f1`
314     system_reset_overlay=`printf "%d" $system_reset_overlay`
315     system_reset_kernel=0x`${CROSS}nm "$ofile" \
316         | grep ' __system_reset_kernel$'       \
317         | cut -d' ' -f1`
318     system_reset_kernel=`printf "%d" $system_reset_kernel`
319     overlay_dest="256"
320     overlay_size="256"
321
322     ${CROSS}objcopy -O binary "$ofile" "$ofile.bin"
323
324     dd if="$ofile.bin" of="$ofile.bin" conv=notrunc   \
325         skip=$overlay_dest seek=$system_reset_kernel  \
326         count=$overlay_size bs=1
327
328     dd if="$ofile.bin" of="$ofile.bin" conv=notrunc   \
329         skip=$system_reset_overlay seek=$overlay_dest \
330         count=$overlay_size bs=1
331
332     odir="$(dirname "$ofile.bin")"
333     rm -f "$odir/otheros.bld"
334     gzip --force -9 --stdout "$ofile.bin" > "$odir/otheros.bld"
335     ;;
336 esac