Merge branch 'bkl-removal' of git://git.lwn.net/linux-2.6
[linux-2.6] / 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 link_address='0x400000'
142
143 case "$platform" in
144 pseries)
145     platformo=$object/of.o
146     link_address='0x4000000'
147     ;;
148 pmac|chrp)
149     platformo=$object/of.o
150     ;;
151 coff)
152     platformo=$object/of.o
153     lds=$object/zImage.coff.lds
154     link_address='0x500000'
155     ;;
156 miboot|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     ;;
164 cuboot*)
165     binary=y
166     gzip=
167     case "$platform" in
168     *-mpc866ads|*-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     *-amigaone)
190         link_address='0x800000'
191         ;;
192     esac
193     ;;
194 ps3)
195     platformo="$object/ps3-head.o $object/ps3-hvcall.o $object/ps3.o"
196     lds=$object/zImage.ps3.lds
197     gzip=
198     ext=bin
199     objflags="-O binary --set-section-flags=.bss=contents,alloc,load,data"
200     ksection=.kernel:vmlinux.bin
201     isection=.kernel:initrd
202     link_address=''
203     ;;
204 ep88xc|ep405|ep8248e)
205     platformo="$object/fixed-head.o $object/$platform.o"
206     binary=y
207     ;;
208 adder875-redboot)
209     platformo="$object/fixed-head.o $object/redboot-8xx.o"
210     binary=y
211     ;;
212 simpleboot-virtex405-*)
213     platformo="$object/virtex405-head.o $object/simpleboot.o $object/virtex.o"
214     binary=y
215     ;;
216 simpleboot-virtex440-*)
217     platformo="$object/fixed-head.o $object/simpleboot.o $object/virtex.o"
218     binary=y
219     ;;
220 simpleboot-*)
221     platformo="$object/fixed-head.o $object/simpleboot.o"
222     binary=y
223     ;;
224 asp834x-redboot)
225     platformo="$object/fixed-head.o $object/redboot-83xx.o"
226     binary=y
227     ;;
228 esac
229
230 vmz="$tmpdir/`basename \"$kernel\"`.$ext"
231 if [ -z "$cacheit" -o ! -f "$vmz$gzip" -o "$vmz$gzip" -ot "$kernel" ]; then
232     ${CROSS}objcopy $objflags "$kernel" "$vmz.$$"
233
234     if [ -n "$gzip" ]; then
235         gzip -f -9 "$vmz.$$"
236     fi
237
238     if [ -n "$cacheit" ]; then
239         mv -f "$vmz.$$$gzip" "$vmz$gzip"
240     else
241         vmz="$vmz.$$"
242     fi
243 fi
244
245 vmz="$vmz$gzip"
246
247 # Extract kernel version information, some platforms want to include
248 # it in the image header
249 version=`${CROSS}strings "$kernel" | grep '^Linux version [-0-9.]' | \
250     cut -d' ' -f3`
251 if [ -n "$version" ]; then
252     uboot_version="-n Linux-$version"
253 fi
254
255 # physical offset of kernel image
256 membase=`${CROSS}objdump -p "$kernel" | grep -m 1 LOAD | awk '{print $7}'`
257
258 case "$platform" in
259 uboot)
260     rm -f "$ofile"
261     mkimage -A ppc -O linux -T kernel -C gzip -a $membase -e $membase \
262         $uboot_version -d "$vmz" "$ofile"
263     if [ -z "$cacheit" ]; then
264         rm -f "$vmz"
265     fi
266     exit 0
267     ;;
268 esac
269
270 addsec() {
271     ${CROSS}objcopy $4 $1 \
272         --add-section=$3="$2" \
273         --set-section-flags=$3=contents,alloc,load,readonly,data
274 }
275
276 addsec $tmp "$vmz" $ksection $object/empty.o
277 if [ -z "$cacheit" ]; then
278     rm -f "$vmz"
279 fi
280
281 if [ -n "$initrd" ]; then
282     addsec $tmp "$initrd" $isection
283 fi
284
285 if [ -n "$dtb" ]; then
286     addsec $tmp "$dtb" .kernel:dtb
287     if [ -n "$dts" ]; then
288         rm $dtb
289     fi
290 fi
291
292 if [ "$platform" != "miboot" ]; then
293     if [ -n "$link_address" ] ; then
294         text_start="-Ttext $link_address --defsym _start=$link_address"
295     fi
296     ${CROSS}ld -m elf32ppc -T $lds $text_start -o "$ofile" \
297         $platformo $tmp $object/wrapper.a
298     rm $tmp
299 fi
300
301 # Some platforms need the zImage's entry point and base address
302 base=0x`${CROSS}nm "$ofile" | grep ' _start$' | cut -d' ' -f1`
303 entry=`${CROSS}objdump -f "$ofile" | grep '^start address ' | cut -d' ' -f3`
304
305 if [ -n "$binary" ]; then
306     mv "$ofile" "$ofile".elf
307     ${CROSS}objcopy -O binary "$ofile".elf "$ofile"
308 fi
309
310 # post-processing needed for some platforms
311 case "$platform" in
312 pseries|chrp)
313     $objbin/addnote "$ofile"
314     ;;
315 coff)
316     ${CROSS}objcopy -O aixcoff-rs6000 --set-start "$entry" "$ofile"
317     $objbin/hack-coff "$ofile"
318     ;;
319 cuboot*)
320     gzip -f -9 "$ofile"
321     mkimage -A ppc -O linux -T kernel -C gzip -a "$base" -e "$entry" \
322             $uboot_version -d "$ofile".gz "$ofile"
323     ;;
324 treeboot*)
325     mv "$ofile" "$ofile.elf"
326     $objbin/mktree "$ofile.elf" "$ofile" "$base" "$entry"
327     if [ -z "$cacheit" ]; then
328         rm -f "$ofile.elf"
329     fi
330     exit 0
331     ;;
332 ps3)
333     # The ps3's loader supports loading a gzipped binary image from flash
334     # rom to ram addr zero. The loader then enters the system reset
335     # vector at addr 0x100.  A bootwrapper overlay is used to arrange for
336     # a binary image of the kernel to be at addr zero, and yet have a
337     # suitable bootwrapper entry at 0x100.  To construct the final rom
338     # image 512 bytes from offset 0x100 is copied to the bootwrapper
339     # place holder at symbol __system_reset_kernel.  The 512 bytes of the
340     # bootwrapper entry code at symbol __system_reset_overlay is then
341     # copied to offset 0x100.  At runtime the bootwrapper program copies
342     # the data at __system_reset_kernel back to addr 0x100.
343
344     system_reset_overlay=0x`${CROSS}nm "$ofile" \
345         | grep ' __system_reset_overlay$'       \
346         | cut -d' ' -f1`
347     system_reset_overlay=`printf "%d" $system_reset_overlay`
348     system_reset_kernel=0x`${CROSS}nm "$ofile" \
349         | grep ' __system_reset_kernel$'       \
350         | cut -d' ' -f1`
351     system_reset_kernel=`printf "%d" $system_reset_kernel`
352     overlay_dest="256"
353     overlay_size="512"
354
355     ${CROSS}objcopy -O binary "$ofile" "$ofile.bin"
356
357     dd if="$ofile.bin" of="$ofile.bin" conv=notrunc   \
358         skip=$overlay_dest seek=$system_reset_kernel  \
359         count=$overlay_size bs=1
360
361     dd if="$ofile.bin" of="$ofile.bin" conv=notrunc   \
362         skip=$system_reset_overlay seek=$overlay_dest \
363         count=$overlay_size bs=1
364
365     odir="$(dirname "$ofile.bin")"
366     rm -f "$odir/otheros.bld"
367     gzip --force -9 --stdout "$ofile.bin" > "$odir/otheros.bld"
368     ;;
369 esac