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