xref: /openbmc/linux/arch/powerpc/boot/wrapper (revision 827634ad) 
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
42pie=
43format=
44
45# cross-compilation prefix
46CROSS=
47
48# mkimage wrapper script
49MKIMAGE=$srctree/scripts/mkuboot.sh
50
51# directory for object and other files used by this script
52object=arch/powerpc/boot
53objbin=$object
54dtc=scripts/dtc/dtc
55
56# directory for working files
57tmpdir=.
58
59usage() {
60    echo 'Usage: wrapper [-o output] [-p platform] [-i initrd]' >&2
61    echo '       [-d devtree] [-s tree.dts] [-c] [-C cross-prefix]' >&2
62    echo '       [-D datadir] [-W workingdir] [--no-gzip] [vmlinux]' >&2
63    exit 1
64}
65
66while [ "$#" -gt 0 ]; do
67    case "$1" in
68    -o)
69	shift
70	[ "$#" -gt 0 ] || usage
71	ofile="$1"
72	;;
73    -p)
74	shift
75	[ "$#" -gt 0 ] || usage
76	platform="$1"
77	;;
78    -i)
79	shift
80	[ "$#" -gt 0 ] || usage
81	initrd="$1"
82	;;
83    -d)
84	shift
85	[ "$#" -gt 0 ] || usage
86	dtb="$1"
87	;;
88    -s)
89	shift
90	[ "$#" -gt 0 ] || usage
91	dts="$1"
92	;;
93    -c)
94	cacheit=y
95	;;
96    -C)
97	shift
98	[ "$#" -gt 0 ] || usage
99	CROSS="$1"
100	;;
101    -D)
102	shift
103	[ "$#" -gt 0 ] || usage
104	object="$1"
105	objbin="$1"
106	;;
107    -W)
108	shift
109	[ "$#" -gt 0 ] || usage
110	tmpdir="$1"
111	;;
112    --no-gzip)
113        gzip=
114        ;;
115    -?)
116	usage
117	;;
118    *)
119	[ -z "$kernel" ] || usage
120	kernel="$1"
121	;;
122    esac
123    shift
124done
125
126if [ -n "$dts" ]; then
127    if [ ! -r "$dts" -a -r "$object/dts/$dts" ]; then
128	dts="$object/dts/$dts"
129    fi
130    if [ -z "$dtb" ]; then
131	dtb="$platform.dtb"
132    fi
133    $dtc -O dtb -o "$dtb" -b 0 "$dts"
134fi
135
136if [ -z "$kernel" ]; then
137    kernel=vmlinux
138fi
139
140elfformat="`${CROSS}objdump -p "$kernel" | grep 'file format' | awk '{print $4}'`"
141case "$elfformat" in
142    elf64-powerpcle)	format=elf64lppc	;;
143    elf64-powerpc)	format=elf32ppc	;;
144    elf32-powerpc)	format=elf32ppc	;;
145esac
146
147
148platformo=$object/"$platform".o
149lds=$object/zImage.lds
150ext=strip
151objflags=-S
152tmp=$tmpdir/zImage.$$.o
153ksection=.kernel:vmlinux.strip
154isection=.kernel:initrd
155link_address='0x400000'
156make_space=y
157
158case "$platform" in
159of)
160    platformo="$object/of.o $object/epapr.o"
161    make_space=n
162    ;;
163pseries)
164    platformo="$object/pseries-head.o $object/of.o $object/epapr.o"
165    link_address='0x4000000'
166    if [ "$format" != "elf32ppc" ]; then
167	link_address=
168	pie=-pie
169    fi
170    make_space=n
171    ;;
172maple)
173    platformo="$object/of.o $object/epapr.o"
174    link_address='0x400000'
175    make_space=n
176    ;;
177pmac|chrp)
178    platformo="$object/of.o $object/epapr.o"
179    make_space=n
180    ;;
181coff)
182    platformo="$object/crt0.o $object/of.o $object/epapr.o"
183    lds=$object/zImage.coff.lds
184    link_address='0x500000'
185    make_space=n
186    pie=
187    ;;
188miboot|uboot*)
189    # miboot and U-boot want just the bare bits, not an ELF binary
190    ext=bin
191    objflags="-O binary"
192    tmp="$ofile"
193    ksection=image
194    isection=initrd
195    ;;
196cuboot*)
197    binary=y
198    gzip=
199    case "$platform" in
200    *-mpc866ads|*-mpc885ads|*-adder875*|*-ep88xc)
201        platformo=$object/cuboot-8xx.o
202        ;;
203    *5200*|*-motionpro)
204        platformo=$object/cuboot-52xx.o
205        ;;
206    *-pq2fads|*-ep8248e|*-mpc8272*|*-storcenter)
207        platformo=$object/cuboot-pq2.o
208        ;;
209    *-mpc824*)
210        platformo=$object/cuboot-824x.o
211        ;;
212    *-mpc83*|*-asp834x*)
213        platformo=$object/cuboot-83xx.o
214        ;;
215    *-tqm8541|*-mpc8560*|*-tqm8560|*-tqm8555|*-ksi8560*)
216        platformo=$object/cuboot-85xx-cpm2.o
217        ;;
218    *-mpc85*|*-tqm85*|*-sbc85*)
219        platformo=$object/cuboot-85xx.o
220        ;;
221    *-amigaone)
222        link_address='0x800000'
223        ;;
224    esac
225    ;;
226ps3)
227    platformo="$object/ps3-head.o $object/ps3-hvcall.o $object/ps3.o"
228    lds=$object/zImage.ps3.lds
229    gzip=
230    ext=bin
231    objflags="-O binary --set-section-flags=.bss=contents,alloc,load,data"
232    ksection=.kernel:vmlinux.bin
233    isection=.kernel:initrd
234    link_address=''
235    make_space=n
236    pie=
237    ;;
238ep88xc|ep405|ep8248e)
239    platformo="$object/fixed-head.o $object/$platform.o"
240    binary=y
241    ;;
242adder875-redboot)
243    platformo="$object/fixed-head.o $object/redboot-8xx.o"
244    binary=y
245    ;;
246simpleboot-virtex405-*)
247    platformo="$object/virtex405-head.o $object/simpleboot.o $object/virtex.o"
248    binary=y
249    ;;
250simpleboot-virtex440-*)
251    platformo="$object/fixed-head.o $object/simpleboot.o $object/virtex.o"
252    binary=y
253    ;;
254simpleboot-*)
255    platformo="$object/fixed-head.o $object/simpleboot.o"
256    binary=y
257    ;;
258asp834x-redboot)
259    platformo="$object/fixed-head.o $object/redboot-83xx.o"
260    binary=y
261    ;;
262xpedite52*)
263    link_address='0x1400000'
264    platformo=$object/cuboot-85xx.o
265    ;;
266gamecube|wii)
267    link_address='0x600000'
268    platformo="$object/$platform-head.o $object/$platform.o"
269    ;;
270treeboot-currituck)
271    link_address='0x1000000'
272    ;;
273treeboot-akebono)
274    link_address='0x1000000'
275    ;;
276treeboot-iss4xx-mpic)
277    platformo="$object/treeboot-iss4xx.o"
278    ;;
279epapr)
280    platformo="$object/pseries-head.o $object/epapr.o $object/epapr-wrapper.o"
281    link_address='0x20000000'
282    pie=-pie
283    ;;
284mvme5100)
285    platformo="$object/fixed-head.o $object/mvme5100.o"
286    binary=y
287    ;;
288esac
289
290vmz="$tmpdir/`basename \"$kernel\"`.$ext"
291if [ -z "$cacheit" -o ! -f "$vmz$gzip" -o "$vmz$gzip" -ot "$kernel" ]; then
292    ${CROSS}objcopy $objflags "$kernel" "$vmz.$$"
293
294    strip_size=$(stat -c %s $vmz.$$)
295
296    if [ -n "$gzip" ]; then
297        gzip -n -f -9 "$vmz.$$"
298    fi
299
300    if [ -n "$cacheit" ]; then
301	mv -f "$vmz.$$$gzip" "$vmz$gzip"
302    else
303	vmz="$vmz.$$"
304    fi
305else
306    # Calculate the vmlinux.strip size
307    ${CROSS}objcopy $objflags "$kernel" "$vmz.$$"
308    strip_size=$(stat -c %s $vmz.$$)
309    rm -f $vmz.$$
310fi
311
312if [ "$make_space" = "y" ]; then
313	# Round the size to next higher MB limit
314	round_size=$(((strip_size + 0xfffff) & 0xfff00000))
315
316	round_size=0x$(printf "%x" $round_size)
317	link_addr=$(printf "%d" $link_address)
318
319	if [ $link_addr -lt $strip_size ]; then
320	    echo "INFO: Uncompressed kernel (size 0x$(printf "%x\n" $strip_size))" \
321			"overlaps the address of the wrapper($link_address)"
322	    echo "INFO: Fixing the link_address of wrapper to ($round_size)"
323	    link_address=$round_size
324	fi
325fi
326
327vmz="$vmz$gzip"
328
329# Extract kernel version information, some platforms want to include
330# it in the image header
331version=`${CROSS}strings "$kernel" | grep '^Linux version [-0-9.]' | \
332    cut -d' ' -f3`
333if [ -n "$version" ]; then
334    uboot_version="-n Linux-$version"
335fi
336
337# physical offset of kernel image
338membase=`${CROSS}objdump -p "$kernel" | grep -m 1 LOAD | awk '{print $7}'`
339
340case "$platform" in
341uboot)
342    rm -f "$ofile"
343    ${MKIMAGE} -A ppc -O linux -T kernel -C gzip -a $membase -e $membase \
344	$uboot_version -d "$vmz" "$ofile"
345    if [ -z "$cacheit" ]; then
346	rm -f "$vmz"
347    fi
348    exit 0
349    ;;
350uboot-obs600)
351    rm -f "$ofile"
352    # obs600 wants a multi image with an initrd, so we need to put a fake
353    # one in even when building a "normal" image.
354    if [ -n "$initrd" ]; then
355	real_rd="$initrd"
356    else
357	real_rd=`mktemp`
358	echo "\0" >>"$real_rd"
359    fi
360    ${MKIMAGE} -A ppc -O linux -T multi -C gzip -a $membase -e $membase \
361	$uboot_version -d "$vmz":"$real_rd":"$dtb" "$ofile"
362    if [ -z "$initrd" ]; then
363	rm -f "$real_rd"
364    fi
365    if [ -z "$cacheit" ]; then
366	rm -f "$vmz"
367    fi
368    exit 0
369    ;;
370esac
371
372addsec() {
373    ${CROSS}objcopy $4 $1 \
374	--add-section=$3="$2" \
375	--set-section-flags=$3=contents,alloc,load,readonly,data
376}
377
378addsec $tmp "$vmz" $ksection $object/empty.o
379if [ -z "$cacheit" ]; then
380    rm -f "$vmz"
381fi
382
383if [ -n "$initrd" ]; then
384    addsec $tmp "$initrd" $isection
385fi
386
387if [ -n "$dtb" ]; then
388    addsec $tmp "$dtb" .kernel:dtb
389    if [ -n "$dts" ]; then
390	rm $dtb
391    fi
392fi
393
394if [ "$platform" != "miboot" ]; then
395    if [ -n "$link_address" ] ; then
396        text_start="-Ttext $link_address"
397    fi
398    ${CROSS}ld -m $format -T $lds $text_start $pie -o "$ofile" \
399	$platformo $tmp $object/wrapper.a
400    rm $tmp
401fi
402
403# Some platforms need the zImage's entry point and base address
404base=0x`${CROSS}nm "$ofile" | grep ' _start$' | cut -d' ' -f1`
405entry=`${CROSS}objdump -f "$ofile" | grep '^start address ' | cut -d' ' -f3`
406
407if [ -n "$binary" ]; then
408    mv "$ofile" "$ofile".elf
409    ${CROSS}objcopy -O binary "$ofile".elf "$ofile"
410fi
411
412# post-processing needed for some platforms
413case "$platform" in
414pseries|chrp|maple)
415    $objbin/addnote "$ofile"
416    ;;
417coff)
418    ${CROSS}objcopy -O aixcoff-rs6000 --set-start "$entry" "$ofile"
419    $objbin/hack-coff "$ofile"
420    ;;
421cuboot*)
422    gzip -n -f -9 "$ofile"
423    ${MKIMAGE} -A ppc -O linux -T kernel -C gzip -a "$base" -e "$entry" \
424            $uboot_version -d "$ofile".gz "$ofile"
425    ;;
426treeboot*)
427    mv "$ofile" "$ofile.elf"
428    $objbin/mktree "$ofile.elf" "$ofile" "$base" "$entry"
429    if [ -z "$cacheit" ]; then
430	rm -f "$ofile.elf"
431    fi
432    exit 0
433    ;;
434ps3)
435    # The ps3's loader supports loading a gzipped binary image from flash
436    # rom to ram addr zero. The loader then enters the system reset
437    # vector at addr 0x100.  A bootwrapper overlay is used to arrange for
438    # a binary image of the kernel to be at addr zero, and yet have a
439    # suitable bootwrapper entry at 0x100.  To construct the final rom
440    # image 512 bytes from offset 0x100 is copied to the bootwrapper
441    # place holder at symbol __system_reset_kernel.  The 512 bytes of the
442    # bootwrapper entry code at symbol __system_reset_overlay is then
443    # copied to offset 0x100.  At runtime the bootwrapper program copies
444    # the data at __system_reset_kernel back to addr 0x100.
445
446    system_reset_overlay=0x`${CROSS}nm "$ofile" \
447        | grep ' __system_reset_overlay$'       \
448        | cut -d' ' -f1`
449    system_reset_overlay=`printf "%d" $system_reset_overlay`
450    system_reset_kernel=0x`${CROSS}nm "$ofile" \
451        | grep ' __system_reset_kernel$'       \
452        | cut -d' ' -f1`
453    system_reset_kernel=`printf "%d" $system_reset_kernel`
454    overlay_dest="256"
455    overlay_size="512"
456
457    ${CROSS}objcopy -O binary "$ofile" "$ofile.bin"
458
459    dd if="$ofile.bin" of="$ofile.bin" conv=notrunc   \
460        skip=$overlay_dest seek=$system_reset_kernel  \
461        count=$overlay_size bs=1
462
463    dd if="$ofile.bin" of="$ofile.bin" conv=notrunc   \
464        skip=$system_reset_overlay seek=$overlay_dest \
465        count=$overlay_size bs=1
466
467    odir="$(dirname "$ofile.bin")"
468    rm -f "$odir/otheros.bld"
469    gzip -n --force -9 --stdout "$ofile.bin" > "$odir/otheros.bld"
470    ;;
471esac
472