[deliverable/linux.git] / arch / powerpc / boot / wrapper

#!/bin/sh

# Copyright (C) 2006 Paul Mackerras, IBM Corporation <paulus@samba.org>
# This program may be used under the terms of version 2 of the GNU
# General Public License.

# This script takes a kernel binary and optionally an initrd image
# and/or a device-tree blob, and creates a bootable zImage for a
# given platform.

# Options:
# -o zImage	specify output file
# -p platform	specify platform (links in $platform.o)
# -i initrd	specify initrd file
# -d devtree	specify device-tree blob
# -s tree.dts	specify device-tree source file (needs dtc installed)
# -c		cache $kernel.strip.gz (use if present & newer, else make)
# -C prefix	specify command prefix for cross-building tools
#		(strip, objcopy, ld)
# -D dir	specify directory containing data files used by script
#		(default ./arch/powerpc/boot)
# -W dir	specify working directory for temporary files (default .)

# Stop execution if any command fails
set -e

# Allow for verbose output
if [ "$V" = 1 ]; then
    set -x
fi

# defaults
kernel=
ofile=zImage
platform=of
initrd=
dtb=
dts=
cacheit=
binary=
gzip=.gz

# cross-compilation prefix
CROSS=

# directory for object and other files used by this script
object=arch/powerpc/boot
objbin=$object

# directory for working files
tmpdir=.

usage() {
    echo 'Usage: wrapper [-o output] [-p platform] [-i initrd]' >&2
    echo '       [-d devtree] [-s tree.dts] [-c] [-C cross-prefix]' >&2
    echo '       [-D datadir] [-W workingdir] [--no-gzip] [vmlinux]' >&2
    exit 1
}

while [ "$#" -gt 0 ]; do
    case "$1" in
    -o)
	shift
	[ "$#" -gt 0 ] || usage
	ofile="$1"
	;;
    -p)
	shift
	[ "$#" -gt 0 ] || usage
	platform="$1"
	;;
    -i)
	shift
	[ "$#" -gt 0 ] || usage
	initrd="$1"
	;;
    -d)
	shift
	[ "$#" -gt 0 ] || usage
	dtb="$1"
	;;
    -s)
	shift
	[ "$#" -gt 0 ] || usage
	dts="$1"
	;;
    -c)
	cacheit=y
	;;
    -C)
	shift
	[ "$#" -gt 0 ] || usage
	CROSS="$1"
	;;
    -D)
	shift
	[ "$#" -gt 0 ] || usage
	object="$1"
	objbin="$1"
	;;
    -W)
	shift
	[ "$#" -gt 0 ] || usage
	tmpdir="$1"
	;;
    --no-gzip)
        gzip=
        ;;
    -?)
	usage
	;;
    *)
	[ -z "$kernel" ] || usage
	kernel="$1"
	;;
    esac
    shift
done

if [ -n "$dts" ]; then
    if [ ! -r "$dts" -a -r "$object/dts/$dts" ]; then
	dts="$object/dts/$dts"
    fi
    if [ -z "$dtb" ]; then
	dtb="$platform.dtb"
    fi
    $object/dtc -O dtb -o "$dtb" -b 0 "$dts"
fi

if [ -z "$kernel" ]; then
    kernel=vmlinux
fi

platformo=$object/"$platform".o
lds=$object/zImage.lds
ext=strip
objflags=-S
tmp=$tmpdir/zImage.$$.o
ksection=.kernel:vmlinux.strip
isection=.kernel:initrd

case "$platform" in
pmac|pseries|chrp)
    platformo=$object/of.o
    ;;
coff)
    platformo=$object/of.o
    lds=$object/zImage.coff.lds
    ;;
miboot|uboot)
    # miboot and U-boot want just the bare bits, not an ELF binary
    ext=bin
    objflags="-O binary"
    tmp="$ofile"
    ksection=image
    isection=initrd
    ;;
cuboot*)
    binary=y
    gzip=
    case "$platform" in
    *-mpc885ads|*-adder875*|*-ep88xc)
        platformo=$object/cuboot-8xx.o
        ;;
    *5200*|*-motionpro)
        platformo=$object/cuboot-52xx.o
        ;;
    *-pq2fads|*-ep8248e|*-mpc8272*|*-storcenter)
        platformo=$object/cuboot-pq2.o
        ;;
    *-mpc824*)
        platformo=$object/cuboot-824x.o
        ;;
    *-mpc83*)
        platformo=$object/cuboot-83xx.o
        ;;
    *-tqm8541|*-mpc8560*|*-tqm8560|*-tqm8555|*-ksi8560*)
        platformo=$object/cuboot-85xx-cpm2.o
        ;;
    *-mpc85*|*-tqm8540|*-sbc85*)
        platformo=$object/cuboot-85xx.o
        ;;
    esac
    ;;
ps3)
    platformo="$object/ps3-head.o $object/ps3-hvcall.o $object/ps3.o"
    lds=$object/zImage.ps3.lds
    gzip=
    ext=bin
    objflags="-O binary --set-section-flags=.bss=contents,alloc,load,data"
    ksection=.kernel:vmlinux.bin
    isection=.kernel:initrd
    ;;
ep88xc|ep405|ep8248e)
    platformo="$object/fixed-head.o $object/$platform.o"
    binary=y
    ;;
adder875-redboot)
    platformo="$object/fixed-head.o $object/redboot-8xx.o"
    binary=y
    ;;
simpleboot-virtex405-*)
    platformo="$object/virtex405-head.o $object/simpleboot.o"
    binary=y
    ;;
esac

vmz="$tmpdir/`basename \"$kernel\"`.$ext"
if [ -z "$cacheit" -o ! -f "$vmz$gzip" -o "$vmz$gzip" -ot "$kernel" ]; then
    ${CROSS}objcopy $objflags "$kernel" "$vmz.$$"

    if [ -n "$gzip" ]; then
        gzip -f -9 "$vmz.$$"
    fi

    if [ -n "$cacheit" ]; then
	mv -f "$vmz.$$$gzip" "$vmz$gzip"
    else
	vmz="$vmz.$$"
    fi
fi

vmz="$vmz$gzip"

# Extract kernel version information, some platforms want to include
# it in the image header
version=`${CROSS}strings "$kernel" | grep '^Linux version [-0-9.]' | \
    cut -d' ' -f3`
if [ -n "$version" ]; then
    uboot_version="-n Linux-$version"
fi

# physical offset of kernel image
membase=`${CROSS}objdump -p "$kernel" | grep -m 1 LOAD | awk '{print $7}'`

case "$platform" in
uboot)
    rm -f "$ofile"
    mkimage -A ppc -O linux -T kernel -C gzip -a $membase -e $membase \
	$uboot_version -d "$vmz" "$ofile"
    if [ -z "$cacheit" ]; then
	rm -f "$vmz"
    fi
    exit 0
    ;;
esac

addsec() {
    ${CROSS}objcopy $4 $1 \
	--add-section=$3="$2" \
	--set-section-flags=$3=contents,alloc,load,readonly,data
}

addsec $tmp "$vmz" $ksection $object/empty.o
if [ -z "$cacheit" ]; then
    rm -f "$vmz"
fi

if [ -n "$initrd" ]; then
    addsec $tmp "$initrd" $isection
fi

if [ -n "$dtb" ]; then
    addsec $tmp "$dtb" .kernel:dtb
    if [ -n "$dts" ]; then
	rm $dtb
    fi
fi

if [ "$platform" != "miboot" ]; then
    ${CROSS}ld -m elf32ppc -T $lds -o "$ofile" \
	$platformo $tmp $object/wrapper.a
    rm $tmp
fi

# Some platforms need the zImage's entry point and base address
base=0x`${CROSS}nm "$ofile" | grep ' _start$' | cut -d' ' -f1`
entry=`${CROSS}objdump -f "$ofile" | grep '^start address ' | cut -d' ' -f3`

if [ -n "$binary" ]; then
    mv "$ofile" "$ofile".elf
    ${CROSS}objcopy -O binary "$ofile".elf "$ofile"
fi

# post-processing needed for some platforms
case "$platform" in
pseries|chrp)
    $objbin/addnote "$ofile"
    ;;
coff)
    ${CROSS}objcopy -O aixcoff-rs6000 --set-start "$entry" "$ofile"
    $objbin/hack-coff "$ofile"
    ;;
cuboot*)
    gzip -f -9 "$ofile"
    mkimage -A ppc -O linux -T kernel -C gzip -a "$base" -e "$entry" \
            $uboot_version -d "$ofile".gz "$ofile"
    ;;
treeboot*)
    mv "$ofile" "$ofile.elf"
    $objbin/mktree "$ofile.elf" "$ofile" "$base" "$entry"
    if [ -z "$cacheit" ]; then
	rm -f "$ofile.elf"
    fi
    exit 0
    ;;
ps3)
    # The ps3's loader supports loading a gzipped binary image from flash
    # rom to ram addr zero. The loader then enters the system reset
    # vector at addr 0x100.  A bootwrapper overlay is used to arrange for
    # a binary image of the kernel to be at addr zero, and yet have a
    # suitable bootwrapper entry at 0x100.  To construct the final rom
    # image 512 bytes from offset 0x100 is copied to the bootwrapper
    # place holder at symbol __system_reset_kernel.  The 512 bytes of the
    # bootwrapper entry code at symbol __system_reset_overlay is then
    # copied to offset 0x100.  At runtime the bootwrapper program copies
    # the data at __system_reset_kernel back to addr 0x100.

    system_reset_overlay=0x`${CROSS}nm "$ofile" \
        | grep ' __system_reset_overlay$'       \
        | cut -d' ' -f1`
    system_reset_overlay=`printf "%d" $system_reset_overlay`
    system_reset_kernel=0x`${CROSS}nm "$ofile" \
        | grep ' __system_reset_kernel$'       \
        | cut -d' ' -f1`
    system_reset_kernel=`printf "%d" $system_reset_kernel`
    overlay_dest="256"
    overlay_size="512"

    ${CROSS}objcopy -O binary "$ofile" "$ofile.bin"

    dd if="$ofile.bin" of="$ofile.bin" conv=notrunc   \
        skip=$overlay_dest seek=$system_reset_kernel  \
        count=$overlay_size bs=1

    dd if="$ofile.bin" of="$ofile.bin" conv=notrunc   \
        skip=$system_reset_overlay seek=$overlay_dest \
        count=$overlay_size bs=1

    odir="$(dirname "$ofile.bin")"
    rm -f "$odir/otheros.bld"
    gzip --force -9 --stdout "$ofile.bin" > "$odir/otheros.bld"
    ;;
esac
Commit	Line	Data
2bf11819 PM	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
d4740373 GL	24	# Stop execution if any command fails
	25	set -e
	26
7f66c1fd GL	27	# Allow for verbose output
	28	if [ "$V" = 1 ]; then
	29	set -x
	30	fi
	31
2bf11819 PM	32	# defaults
	33	kernel=
	34	ofile=zImage
	35	platform=of
	36	initrd=
	37	dtb=
	38	dts=
	39	cacheit=
11c146cc	40	binary=
a9903811	41	gzip=.gz
2bf11819 PM	42
	43	# cross-compilation prefix
	44	CROSS=
	45
	46	# directory for object and other files used by this script
	47	object=arch/powerpc/boot
5c539ee3	48	objbin=$object
2bf11819 PM	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
a9903811	56	echo ' [-D datadir] [-W workingdir] [--no-gzip] [vmlinux]' >&2
2bf11819 PM	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"
5c539ee3	99	objbin="$1"
2bf11819 PM	100	;;
	101	-W)
	102	shift
	103	[ "$#" -gt 0 ] \|\| usage
	104	tmpdir="$1"
	105	;;
a9903811 SW	106	--no-gzip)
	107	gzip=
	108	;;
2bf11819 PM	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
701172d1 DW	121	if [ ! -r "$dts" -a -r "$object/dts/$dts" ]; then
	122	dts="$object/dts/$dts"
	123	fi
2bf11819 PM	124	if [ -z "$dtb" ]; then
	125	dtb="$platform.dtb"
	126	fi
e2dc87a1	127	$object/dtc -O dtb -o "$dtb" -b 0 "$dts"
2bf11819 PM	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	;;
627aa944	146	coff)
2bf11819 PM	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	;;
0fdd717e	158	cuboot*)
11c146cc	159	binary=y
0fdd717e	160	gzip=
25431333 GL	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	;;
ff880112	177	-tqm8541\|-mpc8560\|-tqm8560\|-tqm8555\|-ksi8560*)
25431333 GL	178	platformo=$object/cuboot-85xx-cpm2.o
25431333 GL	179	;;
a72a6f53	180	-mpc85\|-tqm8540\|-sbc85*)
25431333 GL	181	platformo=$object/cuboot-85xx.o
	182	;;
	183	esac
0fdd717e	184	;;
bafdb645 GL	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	;;
a55387e5	194	ep88xc\|ep405\|ep8248e)
11c146cc SW	195	platformo="$object/fixed-head.o $object/$platform.o"
	196	binary=y
	197	;;
a55387e5 SW	198	adder875-redboot)
	199	platformo="$object/fixed-head.o $object/redboot-8xx.o"
	200	binary=y
	201	;;
d2477b5c GL	202	simpleboot-virtex405-*)
	203	platformo="$object/virtex405-head.o $object/simpleboot.o"
	204	binary=y
	205	;;
2bf11819 PM	206	esac
	207
	208	vmz="$tmpdir/`basename \"$kernel\"`.$ext"
1383a34f	209	if [ -z "$cacheit" -o ! -f "$vmz$gzip" -o "$vmz$gzip" -ot "$kernel" ]; then
2bf11819	210	${CROSS}objcopy $objflags "$kernel" "$vmz.$$"
a9903811 SW	211
	212	if [ -n "$gzip" ]; then
	213	gzip -f -9 "$vmz.$$"
	214	fi
	215
2bf11819	216	if [ -n "$cacheit" ]; then
a9903811	217	mv -f "$vmz.$$$gzip" "$vmz$gzip"
2bf11819 PM	218	else
	219	vmz="$vmz.$$"
	220	fi
	221	fi
	222
a9903811 SW	223	vmz="$vmz$gzip"
a9903811 SW	224
a6afacb6 DG	225	# Extract kernel version information, some platforms want to include
	226	# it in the image header
	227	version=`${CROSS}strings "$kernel" \| grep '^Linux version [-0-9.]' \| \
	228	cut -d' ' -f3`
	229	if [ -n "$version" ]; then
	230	uboot_version="-n Linux-$version"
	231	fi
0fdd717e	232
b18796d3 KG	233	# physical offset of kernel image
	234	membase=`${CROSS}objdump -p "$kernel" \| grep -m 1 LOAD \| awk '{print $7}'`
	235
0fdd717e SW	236	case "$platform" in
	237	uboot)
	238	rm -f "$ofile"
b18796d3	239	mkimage -A ppc -O linux -T kernel -C gzip -a $membase -e $membase \
a6afacb6	240	$uboot_version -d "$vmz" "$ofile"
2bf11819	241	if [ -z "$cacheit" ]; then
a9903811	242	rm -f "$vmz"
2bf11819 PM	243	fi
	244	exit 0
	245	;;
	246	esac
	247
	248	addsec() {
	249	${CROSS}objcopy $4 $1 \
	250	--add-section=$3="$2" \
	251	--set-section-flags=$3=contents,alloc,load,readonly,data
	252	}
	253
a9903811	254	addsec $tmp "$vmz" $ksection $object/empty.o
2bf11819	255	if [ -z "$cacheit" ]; then
a9903811	256	rm -f "$vmz"
2bf11819 PM	257	fi
	258
	259	if [ -n "$initrd" ]; then
c888554b	260	addsec $tmp "$initrd" $isection
2bf11819 PM	261	fi
	262
	263	if [ -n "$dtb" ]; then
c888554b	264	addsec $tmp "$dtb" .kernel:dtb
e9c4b4bd MG	265	if [ -n "$dts" ]; then
	266	rm $dtb
	267	fi
2bf11819 PM	268	fi
	269
	270	if [ "$platform" != "miboot" ]; then
	271	${CROSS}ld -m elf32ppc -T $lds -o "$ofile" \
cd197ffc	272	$platformo $tmp $object/wrapper.a
2bf11819 PM	273	rm $tmp
	274	fi
	275
a6afacb6 DG	276	# Some platforms need the zImage's entry point and base address
	277	base=0x`${CROSS}nm "$ofile" \| grep ' _start$' \| cut -d' ' -f1`
	278	entry=`${CROSS}objdump -f "$ofile" \| grep '^start address ' \| cut -d' ' -f3`
	279
11c146cc SW	280	if [ -n "$binary" ]; then
11c146cc SW	281	mv "$ofile" "$ofile".elf
aeb4552f	282	${CROSS}objcopy -O binary "$ofile".elf "$ofile"
11c146cc SW	283	fi
11c146cc SW	284
2bf11819 PM	285	# post-processing needed for some platforms
	286	case "$platform" in
	287	pseries\|chrp)
5c539ee3	288	$objbin/addnote "$ofile"
2bf11819	289	;;
627aa944	290	coff)
cd197ffc	291	${CROSS}objcopy -O aixcoff-rs6000 --set-start "$entry" "$ofile"
5c539ee3	292	$objbin/hack-coff "$ofile"
2bf11819	293	;;
0fdd717e	294	cuboot*)
aeb4552f	295	gzip -f -9 "$ofile"
0fdd717e	296	mkimage -A ppc -O linux -T kernel -C gzip -a "$base" -e "$entry" \
aeb4552f	297	$uboot_version -d "$ofile".gz "$ofile"
0fdd717e	298	;;
f6dfc805 DG	299	treeboot*)
f6dfc805 DG	300	mv "$ofile" "$ofile.elf"
5c539ee3	301	$objbin/mktree "$ofile.elf" "$ofile" "$base" "$entry"
f6dfc805 DG	302	if [ -z "$cacheit" ]; then
	303	rm -f "$ofile.elf"
	304	fi
	305	exit 0
	306	;;
bafdb645	307	ps3)
5761eaa3 GL	308	# The ps3's loader supports loading a gzipped binary image from flash
	309	# rom to ram addr zero. The loader then enters the system reset
	310	# vector at addr 0x100. A bootwrapper overlay is used to arrange for
	311	# a binary image of the kernel to be at addr zero, and yet have a
	312	# suitable bootwrapper entry at 0x100. To construct the final rom
	313	# image 512 bytes from offset 0x100 is copied to the bootwrapper
	314	# place holder at symbol __system_reset_kernel. The 512 bytes of the
	315	# bootwrapper entry code at symbol __system_reset_overlay is then
	316	# copied to offset 0x100. At runtime the bootwrapper program copies
	317	# the data at __system_reset_kernel back to addr 0x100.
bafdb645	318
aeb4552f	319	system_reset_overlay=0x`${CROSS}nm "$ofile" \
bafdb645 GL	320	\| grep ' __system_reset_overlay$' \
	321	\| cut -d' ' -f1`
	322	system_reset_overlay=`printf "%d" $system_reset_overlay`
aeb4552f	323	system_reset_kernel=0x`${CROSS}nm "$ofile" \
bafdb645 GL	324	\| grep ' __system_reset_kernel$' \
	325	\| cut -d' ' -f1`
	326	system_reset_kernel=`printf "%d" $system_reset_kernel`
	327	overlay_dest="256"
5761eaa3	328	overlay_size="512"
bafdb645	329
aeb4552f SW	330	${CROSS}objcopy -O binary "$ofile" "$ofile.bin"
aeb4552f SW	331
d4740373 GL	332	dd if="$ofile.bin" of="$ofile.bin" conv=notrunc \
	333	skip=$overlay_dest seek=$system_reset_kernel \
	334	count=$overlay_size bs=1
bafdb645	335
d4740373 GL	336	dd if="$ofile.bin" of="$ofile.bin" conv=notrunc \
	337	skip=$system_reset_overlay seek=$overlay_dest \
	338	count=$overlay_size bs=1
bafdb645	339
928b9695 DW	340	odir="$(dirname "$ofile.bin")"
	341	rm -f "$odir/otheros.bld"
	342	gzip --force -9 --stdout "$ofile.bin" > "$odir/otheros.bld"
bafdb645	343	;;
2bf11819	344	esac