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
31 # Allow for verbose output
34 map="-Map wrapper.map"
54 # cross-compilation prefix
57 # mkimage wrapper script
58 MKIMAGE=$srctree/scripts/mkuboot.sh
60 # directory for object and other files used by this script
61 object=arch/powerpc/boot
65 # directory for working files
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
85 if [ $? -ne "0" ]; then
93 while [ "$#" -gt 0 ]; do
97 [ "$#" -gt 0 ] || usage
102 [ "$#" -gt 0 ] || usage
107 [ "$#" -gt 0 ] || usage
112 [ "$#" -gt 0 ] || usage
117 [ "$#" -gt 0 ] || usage
122 [ "$#" -gt 0 ] || usage
130 [ "$#" -gt 0 ] || usage
135 [ "$#" -gt 0 ] || usage
141 [ "$#" -gt 0 ] || usage
150 [ "$#" -gt 0 ] || usage
151 [ "$1" != "gz" -o "$1" != "xz" -o "$1" != "lzma" -o "$1" != "lzo" -o "$1" != "none" ] || usage
156 if [ $compression = ".none" ]; then
160 if [ $uboot_comp = "gz" ]; then
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.
174 [ -z "$kernel" ] || usage
182 if [ -n "$dts" ]; then
183 if [ ! -r "$dts" -a -r "$object/dts/$dts" ]; then
184 dts="$object/dts/$dts"
186 if [ -z "$dtb" ]; then
189 $dtc -O dtb -o "$dtb" -b 0 "$dts"
192 if [ -z "$kernel" ]; then
196 LC_ALL=C elfformat="`${CROSS}objdump -p "$kernel" | grep 'file format' | awk '{print $4}'`"
198 elf64-powerpcle) format=elf64lppc ;;
199 elf64-powerpc) format=elf32ppc ;;
200 elf32-powerpc) format=elf32ppc ;;
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.
210 gsub(".*version ", "");
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.
217 print a[1]*100000000 + a[2]*1000000 + a[3]*10000;
224 ${CROSS}ld -V 2>&1 | grep -q LLD
227 # Do not include PT_INTERP segment when linking pie. Non-pie linking
228 # just ignores this option.
229 LD_VERSION=$(${CROSS}ld --version | ld_version)
230 LD_NO_DL_MIN_VERSION=$(echo 2.26 | ld_version)
231 if [ "$LD_VERSION" -ge "$LD_NO_DL_MIN_VERSION" ] ; then
232 nodl="--no-dynamic-linker"
235 # suppress some warnings in recent ld versions
236 nowarn="-z noexecstack"
238 if [ "$LD_VERSION" -ge "$(echo 2.39 | ld_version)" ]; then
239 nowarn="$nowarn --no-warn-rwx-segments"
243 platformo=$object/"$platform".o
244 lds=$object/zImage.lds
247 tmp=$tmpdir/zImage.$$.o
248 ksection=.kernel:vmlinux.strip
249 isection=.kernel:initrd
250 esection=.kernel:esm_blob
251 link_address='0x400000'
255 if [ -n "$esm_blob" -a "$platform" != "pseries" ]; then
256 echo "ESM blob not support on non-pseries platforms" >&2
262 platformo="$object/of.o $object/epapr.o"
266 platformo="$object/pseries-head.o $object/of.o $object/epapr.o"
267 link_address='0x4000000'
268 if [ "$format" != "elf32ppc" ]; then
275 platformo="$object/of.o $object/epapr.o"
276 link_address='0x400000'
280 platformo="$object/of.o $object/epapr.o"
284 platformo="$object/crt0.o $object/of.o $object/epapr.o"
285 lds=$object/zImage.coff.lds
286 link_address='0x500000'
291 # miboot and U-boot want just the bare bits, not an ELF binary
302 *-mpc866ads|*-mpc885ads|*-adder875*|*-ep88xc)
303 platformo=$object/cuboot-8xx.o
306 platformo=$object/cuboot-52xx.o
308 *-pq2fads|*-ep8248e|*-mpc8272*|*-storcenter)
309 platformo=$object/cuboot-pq2.o
312 platformo=$object/cuboot-824x.o
315 platformo=$object/cuboot-83xx.o
317 *-tqm8541|*-mpc8560*|*-tqm8560|*-tqm8555|*-ksi8560*)
318 platformo=$object/cuboot-85xx-cpm2.o
321 platformo=$object/cuboot-85xx.o
324 link_address='0x800000'
329 platformo="$object/ps3-head.o $object/ps3-hvcall.o $object/ps3.o"
330 lds=$object/zImage.ps3.lds
333 objflags="-O binary --set-section-flags=.bss=contents,alloc,load,data"
334 ksection=.kernel:vmlinux.bin
335 isection=.kernel:initrd
340 ep88xc|ep405|ep8248e)
341 platformo="$object/fixed-head.o $object/$platform.o"
345 platformo="$object/fixed-head.o $object/redboot-8xx.o"
349 platformo="$object/fixed-head.o $object/simpleboot.o"
353 platformo="$object/fixed-head.o $object/redboot-83xx.o"
357 link_address='0x1400000'
358 platformo=$object/cuboot-85xx.o
361 link_address='0x600000'
362 platformo="$object/$platform-head.o $object/$platform.o"
365 link_address='0x500000'
366 platformo="$object/fixed-head.o $object/$platform.o"
370 link_address='0x1000000'
373 link_address='0x1000000'
375 treeboot-iss4xx-mpic)
376 platformo="$object/treeboot-iss4xx.o"
379 platformo="$object/pseries-head.o $object/epapr.o $object/epapr-wrapper.o"
380 link_address='0x20000000'
383 rodynamic=$(if ${CROSS}ld -V 2>&1 | grep -q LLD ; then echo "-z rodynamic"; fi)
386 platformo="$object/fixed-head.o $object/mvme5100.o"
390 platformo="$object/motload-head.o $object/mvme7100.o"
391 link_address='0x4000000'
396 vmz="$tmpdir/`basename \"$kernel\"`.$ext"
398 # Calculate the vmlinux.strip size
399 ${CROSS}objcopy $objflags "$kernel" "$vmz.$$"
400 strip_size=$(${CONFIG_SHELL} "${srctree}/scripts/file-size.sh" "$vmz.$$")
402 if [ -z "$cacheit" -o ! -f "$vmz$compression" -o "$vmz$compression" -ot "$kernel" ]; then
403 # recompress the image if we need to
406 xz --check=crc32 -f -6 "$vmz.$$"
409 gzip -n -f -9 "$vmz.$$"
412 xz --format=lzma -f -6 "$vmz.$$"
418 # drop the compression suffix so the stripped vmlinux is used
424 if [ -n "$cacheit" ]; then
425 mv -f "$vmz.$$$compression" "$vmz$compression"
433 vmz="$vmz$compression"
435 if [ "$make_space" = "y" ]; then
436 # Round the size to next higher MB limit
437 round_size=$(((strip_size + 0xfffff) & 0xfff00000))
439 round_size=0x$(printf "%x" $round_size)
440 link_addr=$(printf "%d" $link_address)
442 if [ $link_addr -lt $strip_size ]; then
443 echo "INFO: Uncompressed kernel (size 0x$(printf "%x\n" $strip_size))" \
444 "overlaps the address of the wrapper($link_address)"
445 echo "INFO: Fixing the link_address of wrapper to ($round_size)"
446 link_address=$round_size
450 # Extract kernel version information, some platforms want to include
451 # it in the image header
452 version=`${CROSS}strings "$kernel" | grep '^Linux version [-0-9.]' | \
453 head -n1 | cut -d' ' -f3`
454 if [ -n "$version" ]; then
455 uboot_version="-n Linux-$version"
458 # physical offset of kernel image
459 membase=`${CROSS}objdump -p "$kernel" | grep -m 1 LOAD | awk '{print $7}'`
464 ${MKIMAGE} -A ppc -O linux -T kernel -C $uboot_comp -a $membase -e $membase \
465 $uboot_version -d "$vmz" "$ofile"
466 if [ -z "$cacheit" ]; then
473 # obs600 wants a multi image with an initrd, so we need to put a fake
474 # one in even when building a "normal" image.
475 if [ -n "$initrd" ]; then
479 echo "\0" >>"$real_rd"
481 ${MKIMAGE} -A ppc -O linux -T multi -C gzip -a $membase -e $membase \
482 $uboot_version -d "$vmz":"$real_rd":"$dtb" "$ofile"
483 if [ -z "$initrd" ]; then
486 if [ -z "$cacheit" ]; then
494 ${CROSS}objcopy $4 $1 \
495 --add-section=$3="$2" \
496 --set-section-flags=$3=contents,alloc,load,readonly,data
499 addsec $tmp "$vmz" $ksection $object/empty.o
500 if [ -z "$cacheit" ]; then
504 if [ -n "$initrd" ]; then
505 addsec $tmp "$initrd" $isection
508 if [ -n "$dtb" ]; then
509 addsec $tmp "$dtb" .kernel:dtb
510 if [ -n "$dts" ]; then
515 if [ -n "$esm_blob" ]; then
516 addsec $tmp "$esm_blob" $esection
519 if [ "$platform" != "miboot" ]; then
520 if [ -n "$link_address" ] ; then
521 text_start="-Ttext $link_address"
524 ${CROSS}ld -m $format -T $lds $text_start $pie $nodl $nowarn $rodynamic $notext -o "$ofile" $map \
525 $platformo $tmp $object/wrapper.a
529 # Some platforms need the zImage's entry point and base address
530 base=0x`${CROSS}nm "$ofile" | grep ' _start$' | cut -d' ' -f1`
531 entry=`${CROSS}objdump -f "$ofile" | grep '^start address ' | cut -d' ' -f3`
533 if [ -n "$binary" ]; then
534 mv "$ofile" "$ofile".elf
535 ${CROSS}objcopy -O binary "$ofile".elf "$ofile"
538 # post-processing needed for some platforms
541 $objbin/addnote "$ofile"
544 ${CROSS}objcopy -O aixcoff-rs6000 --set-start "$entry" "$ofile"
545 $objbin/hack-coff "$ofile"
548 gzip -n -f -9 "$ofile"
549 ${MKIMAGE} -A ppc -O linux -T kernel -C gzip -a "$base" -e "$entry" \
550 $uboot_version -d "$ofile".gz "$ofile"
553 mv "$ofile" "$ofile.elf"
554 $objbin/mktree "$ofile.elf" "$ofile" "$base" "$entry"
555 if [ -z "$cacheit" ]; then
561 # The ps3's loader supports loading a gzipped binary image from flash
562 # rom to ram addr zero. The loader then enters the system reset
563 # vector at addr 0x100. A bootwrapper overlay is used to arrange for
564 # a binary image of the kernel to be at addr zero, and yet have a
565 # suitable bootwrapper entry at 0x100. To construct the final rom
566 # image 512 bytes from offset 0x100 is copied to the bootwrapper
567 # place holder at symbol __system_reset_kernel. The 512 bytes of the
568 # bootwrapper entry code at symbol __system_reset_overlay is then
569 # copied to offset 0x100. At runtime the bootwrapper program copies
570 # the data at __system_reset_kernel back to addr 0x100.
572 system_reset_overlay=0x`${CROSS}nm "$ofile" \
573 | grep ' __system_reset_overlay$' \
575 system_reset_overlay=`printf "%d" $system_reset_overlay`
576 system_reset_kernel=0x`${CROSS}nm "$ofile" \
577 | grep ' __system_reset_kernel$' \
579 system_reset_kernel=`printf "%d" $system_reset_kernel`
583 ${CROSS}objcopy -O binary "$ofile" "$ofile.bin"
585 run_cmd dd if="$ofile.bin" of="$ofile.bin" conv=notrunc \
586 skip=$overlay_dest seek=$system_reset_kernel \
587 count=$overlay_size bs=1
589 run_cmd dd if="$ofile.bin" of="$ofile.bin" conv=notrunc \
590 skip=$system_reset_overlay seek=$overlay_dest \
591 count=$overlay_size bs=1
593 odir="$(dirname "$ofile.bin")"
595 # The ps3's flash loader has a size limit of 16 MiB for the uncompressed
596 # image. If a compressed image that exceeded this limit is written to
597 # flash the loader will decompress that image until the 16 MiB limit is
598 # reached, then enter the system reset vector of the partially decompressed
599 # image. No warning is issued.
600 rm -f "$odir"/{otheros,otheros-too-big}.bld
601 size=$(${CROSS}nm --no-sort --radix=d "$ofile" | grep -E ' _end$' | cut -d' ' -f1)
603 if [ $size -gt $((0x1000000)) ]; then
604 bld="otheros-too-big.bld"
606 gzip -n --force -9 --stdout "$ofile.bin" > "$odir/$bld"