2 # SPDX-License-Identifier: GPL-2.0-only
4 # Copyright (C) 2006 Paul Mackerras, IBM Corporation <paulus@samba.org>
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
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)
26 # Stop execution if any command fails
29 # Allow for verbose output
32 map="-Map wrapper.map"
50 # cross-compilation prefix
53 # mkimage wrapper script
54 MKIMAGE=$srctree/scripts/mkuboot.sh
56 # directory for object and other files used by this script
57 object=arch/powerpc/boot
61 # directory for working files
65 echo 'Usage: wrapper [-o output] [-p platform] [-i initrd]' >&2
66 echo ' [-d devtree] [-s tree.dts] [-e esm_blob]' >&2
67 echo ' [-c] [-C cross-prefix] [-D datadir] [-W workingdir]' >&2
68 echo ' [-Z (gz|xz|none)] [--no-compression] [vmlinux]' >&2
81 if [ $? -ne "0" ]; then
89 while [ "$#" -gt 0 ]; do
93 [ "$#" -gt 0 ] || usage
98 [ "$#" -gt 0 ] || usage
103 [ "$#" -gt 0 ] || usage
108 [ "$#" -gt 0 ] || usage
113 [ "$#" -gt 0 ] || usage
118 [ "$#" -gt 0 ] || usage
126 [ "$#" -gt 0 ] || usage
131 [ "$#" -gt 0 ] || usage
137 [ "$#" -gt 0 ] || usage
146 [ "$#" -gt 0 ] || usage
147 [ "$1" != "gz" -o "$1" != "xz" -o "$1" != "lzma" -o "$1" != "lzo" -o "$1" != "none" ] || usage
152 if [ $compression = ".none" ]; then
156 if [ $uboot_comp = "gz" ]; then
161 # a "feature" of the the wrapper script is that it can be used outside
162 # the kernel tree. So keeping this around for backwards compatibility.
170 [ -z "$kernel" ] || usage
178 if [ -n "$dts" ]; then
179 if [ ! -r "$dts" -a -r "$object/dts/$dts" ]; then
180 dts="$object/dts/$dts"
182 if [ -z "$dtb" ]; then
185 $dtc -O dtb -o "$dtb" -b 0 "$dts"
188 if [ -z "$kernel" ]; then
192 LANG=C elfformat="`${CROSS}objdump -p "$kernel" | grep 'file format' | awk '{print $4}'`"
194 elf64-powerpcle) format=elf64lppc ;;
195 elf64-powerpc) format=elf32ppc ;;
196 elf32-powerpc) format=elf32ppc ;;
201 # Poached from scripts/ld-version.sh, but we don't want to call that because
202 # this script (wrapper) is distributed separately from the kernel source.
203 # Extract linker version number from stdin and turn into single number.
206 gsub(".*version ", "");
209 print a[1]*100000000 + a[2]*1000000 + a[3]*10000;
214 # Do not include PT_INTERP segment when linking pie. Non-pie linking
215 # just ignores this option.
216 LD_VERSION=$(${CROSS}ld --version | ld_version)
217 LD_NO_DL_MIN_VERSION=$(echo 2.26 | ld_version)
218 if [ "$LD_VERSION" -ge "$LD_NO_DL_MIN_VERSION" ] ; then
219 nodl="--no-dynamic-linker"
222 platformo=$object/"$platform".o
223 lds=$object/zImage.lds
226 tmp=$tmpdir/zImage.$$.o
227 ksection=.kernel:vmlinux.strip
228 isection=.kernel:initrd
229 esection=.kernel:esm_blob
230 link_address='0x400000'
234 if [ -n "$esm_blob" -a "$platform" != "pseries" ]; then
235 echo "ESM blob not support on non-pseries platforms" >&2
241 platformo="$object/of.o $object/epapr.o"
245 platformo="$object/pseries-head.o $object/of.o $object/epapr.o"
246 link_address='0x4000000'
247 if [ "$format" != "elf32ppc" ]; then
254 platformo="$object/of.o $object/epapr.o"
255 link_address='0x400000'
259 platformo="$object/of.o $object/epapr.o"
263 platformo="$object/crt0.o $object/of.o $object/epapr.o"
264 lds=$object/zImage.coff.lds
265 link_address='0x500000'
270 # miboot and U-boot want just the bare bits, not an ELF binary
281 *-mpc866ads|*-mpc885ads|*-adder875*|*-ep88xc)
282 platformo=$object/cuboot-8xx.o
285 platformo=$object/cuboot-52xx.o
287 *-pq2fads|*-ep8248e|*-mpc8272*|*-storcenter)
288 platformo=$object/cuboot-pq2.o
291 platformo=$object/cuboot-824x.o
294 platformo=$object/cuboot-83xx.o
296 *-tqm8541|*-mpc8560*|*-tqm8560|*-tqm8555|*-ksi8560*)
297 platformo=$object/cuboot-85xx-cpm2.o
299 *-mpc85*|*-tqm85*|*-sbc85*)
300 platformo=$object/cuboot-85xx.o
303 link_address='0x800000'
308 platformo="$object/ps3-head.o $object/ps3-hvcall.o $object/ps3.o"
309 lds=$object/zImage.ps3.lds
312 objflags="-O binary --set-section-flags=.bss=contents,alloc,load,data"
313 ksection=.kernel:vmlinux.bin
314 isection=.kernel:initrd
319 ep88xc|ep405|ep8248e)
320 platformo="$object/fixed-head.o $object/$platform.o"
324 platformo="$object/fixed-head.o $object/redboot-8xx.o"
328 platformo="$object/fixed-head.o $object/simpleboot.o"
332 platformo="$object/fixed-head.o $object/redboot-83xx.o"
336 link_address='0x1400000'
337 platformo=$object/cuboot-85xx.o
340 link_address='0x600000'
341 platformo="$object/$platform-head.o $object/$platform.o"
344 link_address='0x1000000'
347 link_address='0x1000000'
349 treeboot-iss4xx-mpic)
350 platformo="$object/treeboot-iss4xx.o"
353 platformo="$object/pseries-head.o $object/epapr.o $object/epapr-wrapper.o"
354 link_address='0x20000000'
358 platformo="$object/fixed-head.o $object/mvme5100.o"
362 platformo="$object/motload-head.o $object/mvme7100.o"
363 link_address='0x4000000'
368 vmz="$tmpdir/`basename \"$kernel\"`.$ext"
370 # Calculate the vmlinux.strip size
371 ${CROSS}objcopy $objflags "$kernel" "$vmz.$$"
372 strip_size=$(${CONFIG_SHELL} "${srctree}/scripts/file-size.sh" "$vmz.$$")
374 if [ -z "$cacheit" -o ! -f "$vmz$compression" -o "$vmz$compression" -ot "$kernel" ]; then
375 # recompress the image if we need to
378 xz --check=crc32 -f -6 "$vmz.$$"
381 gzip -n -f -9 "$vmz.$$"
384 xz --format=lzma -f -6 "$vmz.$$"
390 # drop the compression suffix so the stripped vmlinux is used
396 if [ -n "$cacheit" ]; then
397 mv -f "$vmz.$$$compression" "$vmz$compression"
405 vmz="$vmz$compression"
407 if [ "$make_space" = "y" ]; then
408 # Round the size to next higher MB limit
409 round_size=$(((strip_size + 0xfffff) & 0xfff00000))
411 round_size=0x$(printf "%x" $round_size)
412 link_addr=$(printf "%d" $link_address)
414 if [ $link_addr -lt $strip_size ]; then
415 echo "INFO: Uncompressed kernel (size 0x$(printf "%x\n" $strip_size))" \
416 "overlaps the address of the wrapper($link_address)"
417 echo "INFO: Fixing the link_address of wrapper to ($round_size)"
418 link_address=$round_size
422 # Extract kernel version information, some platforms want to include
423 # it in the image header
424 version=`${CROSS}strings "$kernel" | grep '^Linux version [-0-9.]' | \
426 if [ -n "$version" ]; then
427 uboot_version="-n Linux-$version"
430 # physical offset of kernel image
431 membase=`${CROSS}objdump -p "$kernel" | grep -m 1 LOAD | awk '{print $7}'`
436 ${MKIMAGE} -A ppc -O linux -T kernel -C $uboot_comp -a $membase -e $membase \
437 $uboot_version -d "$vmz" "$ofile"
438 if [ -z "$cacheit" ]; then
445 # obs600 wants a multi image with an initrd, so we need to put a fake
446 # one in even when building a "normal" image.
447 if [ -n "$initrd" ]; then
451 echo "\0" >>"$real_rd"
453 ${MKIMAGE} -A ppc -O linux -T multi -C gzip -a $membase -e $membase \
454 $uboot_version -d "$vmz":"$real_rd":"$dtb" "$ofile"
455 if [ -z "$initrd" ]; then
458 if [ -z "$cacheit" ]; then
466 ${CROSS}objcopy $4 $1 \
467 --add-section=$3="$2" \
468 --set-section-flags=$3=contents,alloc,load,readonly,data
471 addsec $tmp "$vmz" $ksection $object/empty.o
472 if [ -z "$cacheit" ]; then
476 if [ -n "$initrd" ]; then
477 addsec $tmp "$initrd" $isection
480 if [ -n "$dtb" ]; then
481 addsec $tmp "$dtb" .kernel:dtb
482 if [ -n "$dts" ]; then
487 if [ -n "$esm_blob" ]; then
488 addsec $tmp "$esm_blob" $esection
491 if [ "$platform" != "miboot" ]; then
492 if [ -n "$link_address" ] ; then
493 text_start="-Ttext $link_address"
496 ${CROSS}ld -m $format -T $lds $text_start $pie $nodl -o "$ofile" $map \
497 $platformo $tmp $object/wrapper.a
501 # Some platforms need the zImage's entry point and base address
502 base=0x`${CROSS}nm "$ofile" | grep ' _start$' | cut -d' ' -f1`
503 entry=`${CROSS}objdump -f "$ofile" | grep '^start address ' | cut -d' ' -f3`
505 if [ -n "$binary" ]; then
506 mv "$ofile" "$ofile".elf
507 ${CROSS}objcopy -O binary "$ofile".elf "$ofile"
510 # post-processing needed for some platforms
513 $objbin/addnote "$ofile"
516 ${CROSS}objcopy -O aixcoff-rs6000 --set-start "$entry" "$ofile"
517 $objbin/hack-coff "$ofile"
520 gzip -n -f -9 "$ofile"
521 ${MKIMAGE} -A ppc -O linux -T kernel -C gzip -a "$base" -e "$entry" \
522 $uboot_version -d "$ofile".gz "$ofile"
525 mv "$ofile" "$ofile.elf"
526 $objbin/mktree "$ofile.elf" "$ofile" "$base" "$entry"
527 if [ -z "$cacheit" ]; then
533 # The ps3's loader supports loading a gzipped binary image from flash
534 # rom to ram addr zero. The loader then enters the system reset
535 # vector at addr 0x100. A bootwrapper overlay is used to arrange for
536 # a binary image of the kernel to be at addr zero, and yet have a
537 # suitable bootwrapper entry at 0x100. To construct the final rom
538 # image 512 bytes from offset 0x100 is copied to the bootwrapper
539 # place holder at symbol __system_reset_kernel. The 512 bytes of the
540 # bootwrapper entry code at symbol __system_reset_overlay is then
541 # copied to offset 0x100. At runtime the bootwrapper program copies
542 # the data at __system_reset_kernel back to addr 0x100.
544 system_reset_overlay=0x`${CROSS}nm "$ofile" \
545 | grep ' __system_reset_overlay$' \
547 system_reset_overlay=`printf "%d" $system_reset_overlay`
548 system_reset_kernel=0x`${CROSS}nm "$ofile" \
549 | grep ' __system_reset_kernel$' \
551 system_reset_kernel=`printf "%d" $system_reset_kernel`
555 ${CROSS}objcopy -O binary "$ofile" "$ofile.bin"
557 run_cmd dd if="$ofile.bin" of="$ofile.bin" conv=notrunc \
558 skip=$overlay_dest seek=$system_reset_kernel \
559 count=$overlay_size bs=1
561 run_cmd dd if="$ofile.bin" of="$ofile.bin" conv=notrunc \
562 skip=$system_reset_overlay seek=$overlay_dest \
563 count=$overlay_size bs=1
565 odir="$(dirname "$ofile.bin")"
567 # The ps3's flash loader has a size limit of 16 MiB for the uncompressed
568 # image. If a compressed image that exceeded this limit is written to
569 # flash the loader will decompress that image until the 16 MiB limit is
570 # reached, then enter the system reset vector of the partially decompressed
571 # image. No warning is issued.
572 rm -f "$odir"/{otheros,otheros-too-big}.bld
573 size=$(${CROSS}nm --no-sort --radix=d "$ofile" | egrep ' _end$' | cut -d' ' -f1)
575 if [ $size -gt $((0x1000000)) ]; then
576 bld="otheros-too-big.bld"
578 gzip -n --force -9 --stdout "$ofile.bin" > "$odir/$bld"