xref: /openbmc/linux/arch/powerpc/boot/wrapper (revision 738f6ba1) 
1#!/bin/sh
2# SPDX-License-Identifier: GPL-2.0-only
3
4# Copyright (C) 2006 Paul Mackerras, IBM Corporation <paulus@samba.org>
5
6# This script takes a kernel binary and optionally an initrd image
7# and/or a device-tree blob, and creates a bootable zImage for a
8# given platform.
9
10# Options:
11# -o zImage	specify output file
12# -p platform	specify platform (links in $platform.o)
13# -i initrd	specify initrd file
14# -d devtree	specify device-tree blob
15# -s tree.dts	specify device-tree source file (needs dtc installed)
16# -e esm_blob   specify ESM blob for secure images
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# -z		use gzip (legacy)
24# -Z zsuffix    compression to use (gz, xz or none)
25
26# Stop execution if any command fails
27set -e
28
29# Allow for verbose output
30if [ "$V" = 1 ]; then
31    set -x
32    map="-Map wrapper.map"
33fi
34
35# defaults
36kernel=
37ofile=zImage
38platform=of
39initrd=
40dtb=
41dts=
42esm_blob=
43cacheit=
44binary=
45compression=.gz
46uboot_comp=gzip
47pie=
48format=
49notext=
50rodynamic=
51
52# cross-compilation prefix
53CROSS=
54
55# mkimage wrapper script
56MKIMAGE=$srctree/scripts/mkuboot.sh
57
58# directory for object and other files used by this script
59object=arch/powerpc/boot
60objbin=$object
61dtc=scripts/dtc/dtc
62
63# directory for working files
64tmpdir=.
65
66usage() {
67    echo 'Usage: wrapper [-o output] [-p platform] [-i initrd]' >&2
68    echo '       [-d devtree] [-s tree.dts] [-e esm_blob]' >&2
69    echo '       [-c] [-C cross-prefix] [-D datadir] [-W workingdir]' >&2
70    echo '       [-Z (gz|xz|none)] [--no-compression] [vmlinux]' >&2
71    exit 1
72}
73
74run_cmd() {
75    if [ "$V" = 1 ]; then
76        $* 2>&1
77    else
78        local msg
79
80        set +e
81        msg=$($* 2>&1)
82
83        if [ $? -ne "0" ]; then
84                echo $msg
85                exit 1
86        fi
87        set -e
88    fi
89}
90
91while [ "$#" -gt 0 ]; do
92    case "$1" in
93    -o)
94	shift
95	[ "$#" -gt 0 ] || usage
96	ofile="$1"
97	;;
98    -p)
99	shift
100	[ "$#" -gt 0 ] || usage
101	platform="$1"
102	;;
103    -i)
104	shift
105	[ "$#" -gt 0 ] || usage
106	initrd="$1"
107	;;
108    -d)
109	shift
110	[ "$#" -gt 0 ] || usage
111	dtb="$1"
112	;;
113    -e)
114	shift
115	[ "$#" -gt 0 ] || usage
116	esm_blob="$1"
117	;;
118    -s)
119	shift
120	[ "$#" -gt 0 ] || usage
121	dts="$1"
122	;;
123    -c)
124	cacheit=y
125	;;
126    -C)
127	shift
128	[ "$#" -gt 0 ] || usage
129	CROSS="$1"
130	;;
131    -D)
132	shift
133	[ "$#" -gt 0 ] || usage
134	object="$1"
135	objbin="$1"
136	;;
137    -W)
138	shift
139	[ "$#" -gt 0 ] || usage
140	tmpdir="$1"
141	;;
142    -z)
143	compression=.gz
144	uboot_comp=gzip
145	;;
146    -Z)
147	shift
148	[ "$#" -gt 0 ] || usage
149        [ "$1" != "gz" -o "$1" != "xz" -o "$1" != "lzma" -o "$1" != "lzo" -o "$1" != "none" ] || usage
150
151	compression=".$1"
152	uboot_comp=$1
153
154        if [ $compression = ".none" ]; then
155                compression=
156		uboot_comp=none
157        fi
158	if [ $uboot_comp = "gz" ]; then
159		uboot_comp=gzip
160	fi
161	;;
162    --no-gzip)
163        # a "feature" of the the wrapper script is that it can be used outside
164        # the kernel tree. So keeping this around for backwards compatibility.
165        compression=
166	uboot_comp=none
167        ;;
168    -?)
169	usage
170	;;
171    *)
172	[ -z "$kernel" ] || usage
173	kernel="$1"
174	;;
175    esac
176    shift
177done
178
179
180if [ -n "$dts" ]; then
181    if [ ! -r "$dts" -a -r "$object/dts/$dts" ]; then
182	dts="$object/dts/$dts"
183    fi
184    if [ -z "$dtb" ]; then
185	dtb="$platform.dtb"
186    fi
187    $dtc -O dtb -o "$dtb" -b 0 "$dts"
188fi
189
190if [ -z "$kernel" ]; then
191    kernel=vmlinux
192fi
193
194LANG=C elfformat="`${CROSS}objdump -p "$kernel" | grep 'file format' | awk '{print $4}'`"
195case "$elfformat" in
196    elf64-powerpcle)	format=elf64lppc	;;
197    elf64-powerpc)	format=elf32ppc	;;
198    elf32-powerpc)	format=elf32ppc	;;
199esac
200
201ld_version()
202{
203    # Poached from scripts/ld-version.sh, but we don't want to call that because
204    # this script (wrapper) is distributed separately from the kernel source.
205    # Extract linker version number from stdin and turn into single number.
206    awk '{
207	gsub(".*\\)", "");
208	gsub(".*version ", "");
209	gsub("-.*", "");
210	split($1,a, ".");
211	print a[1]*100000000 + a[2]*1000000 + a[3]*10000;
212	exit
213    }'
214}
215
216# Do not include PT_INTERP segment when linking pie. Non-pie linking
217# just ignores this option.
218LD_VERSION=$(${CROSS}ld --version | ld_version)
219LD_NO_DL_MIN_VERSION=$(echo 2.26 | ld_version)
220if [ "$LD_VERSION" -ge "$LD_NO_DL_MIN_VERSION" ] ; then
221	nodl="--no-dynamic-linker"
222fi
223
224platformo=$object/"$platform".o
225lds=$object/zImage.lds
226ext=strip
227objflags=-S
228tmp=$tmpdir/zImage.$$.o
229ksection=.kernel:vmlinux.strip
230isection=.kernel:initrd
231esection=.kernel:esm_blob
232link_address='0x400000'
233make_space=y
234
235
236if [ -n "$esm_blob" -a "$platform" != "pseries" ]; then
237    echo "ESM blob not support on non-pseries platforms" >&2
238    exit 1
239fi
240
241case "$platform" in
242of)
243    platformo="$object/of.o $object/epapr.o"
244    make_space=n
245    ;;
246pseries)
247    platformo="$object/pseries-head.o $object/of.o $object/epapr.o"
248    link_address='0x4000000'
249    if [ "$format" != "elf32ppc" ]; then
250	link_address=
251	pie=-pie
252    fi
253    make_space=n
254    ;;
255maple)
256    platformo="$object/of.o $object/epapr.o"
257    link_address='0x400000'
258    make_space=n
259    ;;
260pmac|chrp)
261    platformo="$object/of.o $object/epapr.o"
262    make_space=n
263    ;;
264coff)
265    platformo="$object/crt0.o $object/of.o $object/epapr.o"
266    lds=$object/zImage.coff.lds
267    link_address='0x500000'
268    make_space=n
269    pie=
270    ;;
271miboot|uboot*)
272    # miboot and U-boot want just the bare bits, not an ELF binary
273    ext=bin
274    objflags="-O binary"
275    tmp="$ofile"
276    ksection=image
277    isection=initrd
278    ;;
279cuboot*)
280    binary=y
281    compression=
282    case "$platform" in
283    *-mpc866ads|*-mpc885ads|*-adder875*|*-ep88xc)
284        platformo=$object/cuboot-8xx.o
285        ;;
286    *5200*|*-motionpro)
287        platformo=$object/cuboot-52xx.o
288        ;;
289    *-pq2fads|*-ep8248e|*-mpc8272*|*-storcenter)
290        platformo=$object/cuboot-pq2.o
291        ;;
292    *-mpc824*)
293        platformo=$object/cuboot-824x.o
294        ;;
295    *-mpc83*|*-asp834x*)
296        platformo=$object/cuboot-83xx.o
297        ;;
298    *-tqm8541|*-mpc8560*|*-tqm8560|*-tqm8555|*-ksi8560*)
299        platformo=$object/cuboot-85xx-cpm2.o
300        ;;
301    *-mpc85*|*-tqm85*|*-sbc85*)
302        platformo=$object/cuboot-85xx.o
303        ;;
304    *-amigaone)
305        link_address='0x800000'
306        ;;
307    esac
308    ;;
309ps3)
310    platformo="$object/ps3-head.o $object/ps3-hvcall.o $object/ps3.o"
311    lds=$object/zImage.ps3.lds
312    compression=
313    ext=bin
314    objflags="-O binary --set-section-flags=.bss=contents,alloc,load,data"
315    ksection=.kernel:vmlinux.bin
316    isection=.kernel:initrd
317    link_address=''
318    make_space=n
319    pie=
320    ;;
321ep88xc|ep405|ep8248e)
322    platformo="$object/fixed-head.o $object/$platform.o"
323    binary=y
324    ;;
325adder875-redboot)
326    platformo="$object/fixed-head.o $object/redboot-8xx.o"
327    binary=y
328    ;;
329simpleboot-*)
330    platformo="$object/fixed-head.o $object/simpleboot.o"
331    binary=y
332    ;;
333asp834x-redboot)
334    platformo="$object/fixed-head.o $object/redboot-83xx.o"
335    binary=y
336    ;;
337xpedite52*)
338    link_address='0x1400000'
339    platformo=$object/cuboot-85xx.o
340    ;;
341gamecube|wii)
342    link_address='0x600000'
343    platformo="$object/$platform-head.o $object/$platform.o"
344    ;;
345treeboot-currituck)
346    link_address='0x1000000'
347    ;;
348treeboot-akebono)
349    link_address='0x1000000'
350    ;;
351treeboot-iss4xx-mpic)
352    platformo="$object/treeboot-iss4xx.o"
353    ;;
354epapr)
355    platformo="$object/pseries-head.o $object/epapr.o $object/epapr-wrapper.o"
356    link_address='0x20000000'
357    pie=-pie
358    notext='-z notext'
359    rodynamic=$(if ${CROSS}ld -V 2>&1 | grep -q LLD ; then echo "-z rodynamic"; fi)
360    ;;
361mvme5100)
362    platformo="$object/fixed-head.o $object/mvme5100.o"
363    binary=y
364    ;;
365mvme7100)
366    platformo="$object/motload-head.o $object/mvme7100.o"
367    link_address='0x4000000'
368    binary=y
369    ;;
370esac
371
372vmz="$tmpdir/`basename \"$kernel\"`.$ext"
373
374# Calculate the vmlinux.strip size
375${CROSS}objcopy $objflags "$kernel" "$vmz.$$"
376strip_size=$(${CONFIG_SHELL} "${srctree}/scripts/file-size.sh" "$vmz.$$")
377
378if [ -z "$cacheit" -o ! -f "$vmz$compression" -o "$vmz$compression" -ot "$kernel" ]; then
379    # recompress the image if we need to
380    case $compression in
381    .xz)
382        xz --check=crc32 -f -6 "$vmz.$$"
383        ;;
384    .gz)
385        gzip -n -f -9 "$vmz.$$"
386        ;;
387    .lzma)
388        xz --format=lzma -f -6 "$vmz.$$"
389	;;
390    .lzo)
391        lzop -f -9 "$vmz.$$"
392	;;
393    *)
394        # drop the compression suffix so the stripped vmlinux is used
395        compression=
396	uboot_comp=none
397	;;
398    esac
399
400    if [ -n "$cacheit" ]; then
401	mv -f "$vmz.$$$compression" "$vmz$compression"
402    else
403	vmz="$vmz.$$"
404    fi
405else
406    rm -f $vmz.$$
407fi
408
409vmz="$vmz$compression"
410
411if [ "$make_space" = "y" ]; then
412	# Round the size to next higher MB limit
413	round_size=$(((strip_size + 0xfffff) & 0xfff00000))
414
415	round_size=0x$(printf "%x" $round_size)
416	link_addr=$(printf "%d" $link_address)
417
418	if [ $link_addr -lt $strip_size ]; then
419	    echo "INFO: Uncompressed kernel (size 0x$(printf "%x\n" $strip_size))" \
420			"overlaps the address of the wrapper($link_address)"
421	    echo "INFO: Fixing the link_address of wrapper to ($round_size)"
422	    link_address=$round_size
423	fi
424fi
425
426# Extract kernel version information, some platforms want to include
427# it in the image header
428version=`${CROSS}strings "$kernel" | grep '^Linux version [-0-9.]' | \
429    cut -d' ' -f3`
430if [ -n "$version" ]; then
431    uboot_version="-n Linux-$version"
432fi
433
434# physical offset of kernel image
435membase=`${CROSS}objdump -p "$kernel" | grep -m 1 LOAD | awk '{print $7}'`
436
437case "$platform" in
438uboot)
439    rm -f "$ofile"
440    ${MKIMAGE} -A ppc -O linux -T kernel -C $uboot_comp -a $membase -e $membase \
441	$uboot_version -d "$vmz" "$ofile"
442    if [ -z "$cacheit" ]; then
443	rm -f "$vmz"
444    fi
445    exit 0
446    ;;
447uboot-obs600)
448    rm -f "$ofile"
449    # obs600 wants a multi image with an initrd, so we need to put a fake
450    # one in even when building a "normal" image.
451    if [ -n "$initrd" ]; then
452	real_rd="$initrd"
453    else
454	real_rd=`mktemp`
455	echo "\0" >>"$real_rd"
456    fi
457    ${MKIMAGE} -A ppc -O linux -T multi -C gzip -a $membase -e $membase \
458	$uboot_version -d "$vmz":"$real_rd":"$dtb" "$ofile"
459    if [ -z "$initrd" ]; then
460	rm -f "$real_rd"
461    fi
462    if [ -z "$cacheit" ]; then
463	rm -f "$vmz"
464    fi
465    exit 0
466    ;;
467esac
468
469addsec() {
470    ${CROSS}objcopy $4 $1 \
471	--add-section=$3="$2" \
472	--set-section-flags=$3=contents,alloc,load,readonly,data
473}
474
475addsec $tmp "$vmz" $ksection $object/empty.o
476if [ -z "$cacheit" ]; then
477    rm -f "$vmz"
478fi
479
480if [ -n "$initrd" ]; then
481    addsec $tmp "$initrd" $isection
482fi
483
484if [ -n "$dtb" ]; then
485    addsec $tmp "$dtb" .kernel:dtb
486    if [ -n "$dts" ]; then
487	rm $dtb
488    fi
489fi
490
491if [ -n "$esm_blob" ]; then
492    addsec $tmp "$esm_blob" $esection
493fi
494
495if [ "$platform" != "miboot" ]; then
496    if [ -n "$link_address" ] ; then
497        text_start="-Ttext $link_address"
498    fi
499#link everything
500    ${CROSS}ld -m $format -T $lds $text_start $pie $nodl $rodynamic $notext -o "$ofile" $map \
501	$platformo $tmp $object/wrapper.a
502    rm $tmp
503fi
504
505# Some platforms need the zImage's entry point and base address
506base=0x`${CROSS}nm "$ofile" | grep ' _start$' | cut -d' ' -f1`
507entry=`${CROSS}objdump -f "$ofile" | grep '^start address ' | cut -d' ' -f3`
508
509if [ -n "$binary" ]; then
510    mv "$ofile" "$ofile".elf
511    ${CROSS}objcopy -O binary "$ofile".elf "$ofile"
512fi
513
514# post-processing needed for some platforms
515case "$platform" in
516pseries|chrp|maple)
517    $objbin/addnote "$ofile"
518    ;;
519coff)
520    ${CROSS}objcopy -O aixcoff-rs6000 --set-start "$entry" "$ofile"
521    $objbin/hack-coff "$ofile"
522    ;;
523cuboot*)
524    gzip -n -f -9 "$ofile"
525    ${MKIMAGE} -A ppc -O linux -T kernel -C gzip -a "$base" -e "$entry" \
526            $uboot_version -d "$ofile".gz "$ofile"
527    ;;
528treeboot*)
529    mv "$ofile" "$ofile.elf"
530    $objbin/mktree "$ofile.elf" "$ofile" "$base" "$entry"
531    if [ -z "$cacheit" ]; then
532	rm -f "$ofile.elf"
533    fi
534    exit 0
535    ;;
536ps3)
537    # The ps3's loader supports loading a gzipped binary image from flash
538    # rom to ram addr zero. The loader then enters the system reset
539    # vector at addr 0x100.  A bootwrapper overlay is used to arrange for
540    # a binary image of the kernel to be at addr zero, and yet have a
541    # suitable bootwrapper entry at 0x100.  To construct the final rom
542    # image 512 bytes from offset 0x100 is copied to the bootwrapper
543    # place holder at symbol __system_reset_kernel.  The 512 bytes of the
544    # bootwrapper entry code at symbol __system_reset_overlay is then
545    # copied to offset 0x100.  At runtime the bootwrapper program copies
546    # the data at __system_reset_kernel back to addr 0x100.
547
548    system_reset_overlay=0x`${CROSS}nm "$ofile" \
549        | grep ' __system_reset_overlay$'       \
550        | cut -d' ' -f1`
551    system_reset_overlay=`printf "%d" $system_reset_overlay`
552    system_reset_kernel=0x`${CROSS}nm "$ofile" \
553        | grep ' __system_reset_kernel$'       \
554        | cut -d' ' -f1`
555    system_reset_kernel=`printf "%d" $system_reset_kernel`
556    overlay_dest="256"
557    overlay_size="512"
558
559    ${CROSS}objcopy -O binary "$ofile" "$ofile.bin"
560
561    run_cmd dd if="$ofile.bin" of="$ofile.bin" conv=notrunc   \
562        skip=$overlay_dest seek=$system_reset_kernel          \
563        count=$overlay_size bs=1
564
565    run_cmd dd if="$ofile.bin" of="$ofile.bin" conv=notrunc   \
566        skip=$system_reset_overlay seek=$overlay_dest         \
567        count=$overlay_size bs=1
568
569    odir="$(dirname "$ofile.bin")"
570
571    # The ps3's flash loader has a size limit of 16 MiB for the uncompressed
572    # image.  If a compressed image that exceeded this limit is written to
573    # flash the loader will decompress that image until the 16 MiB limit is
574    # reached, then enter the system reset vector of the partially decompressed
575    # image.  No warning is issued.
576    rm -f "$odir"/{otheros,otheros-too-big}.bld
577    size=$(${CROSS}nm --no-sort --radix=d "$ofile" | egrep ' _end$' | cut -d' ' -f1)
578    bld="otheros.bld"
579    if [ $size -gt $((0x1000000)) ]; then
580        bld="otheros-too-big.bld"
581    fi
582    gzip -n --force -9 --stdout "$ofile.bin" > "$odir/$bld"
583    ;;
584esac
585