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