Loading...
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 ! ld_is_lld; then
238 if [ "$LD_VERSION" -ge "$(echo 2.39 | ld_version)" ]; then
239 nowarn="$nowarn --no-warn-rwx-segments"
240 fi
241fi
242
243platformo=$object/"$platform".o
244lds=$object/zImage.lds
245ext=strip
246objflags=-S
247tmp=$tmpdir/zImage.$$.o
248ksection=.kernel:vmlinux.strip
249isection=.kernel:initrd
250esection=.kernel:esm_blob
251link_address='0x400000'
252make_space=y
253
254
255if [ -n "$esm_blob" -a "$platform" != "pseries" ]; then
256 echo "ESM blob not support on non-pseries platforms" >&2
257 exit 1
258fi
259
260case "$platform" in
261of)
262 platformo="$object/of.o $object/epapr.o"
263 make_space=n
264 ;;
265pseries)
266 platformo="$object/pseries-head.o $object/of.o $object/epapr.o"
267 link_address='0x4000000'
268 if [ "$format" != "elf32ppc" ]; then
269 link_address=
270 pie=-pie
271 fi
272 make_space=n
273 ;;
274pmac|chrp)
275 platformo="$object/of.o $object/epapr.o"
276 make_space=n
277 ;;
278coff)
279 platformo="$object/crt0.o $object/of.o $object/epapr.o"
280 lds=$object/zImage.coff.lds
281 link_address='0x500000'
282 make_space=n
283 pie=
284 ;;
285miboot|uboot*)
286 # miboot and U-boot want just the bare bits, not an ELF binary
287 ext=bin
288 objflags="-O binary"
289 tmp="$ofile"
290 ksection=image
291 isection=initrd
292 ;;
293cuboot*)
294 binary=y
295 compression=
296 case "$platform" in
297 *-mpc866ads|*-mpc885ads|*-adder875*|*-ep88xc)
298 platformo=$object/cuboot-8xx.o
299 ;;
300 *5200*|*-motionpro)
301 platformo=$object/cuboot-52xx.o
302 ;;
303 *-pq2fads|*-ep8248e|*-mpc8272*|*-storcenter)
304 platformo=$object/cuboot-pq2.o
305 ;;
306 *-mpc824*)
307 platformo=$object/cuboot-824x.o
308 ;;
309 *-mpc83*|*-asp834x*)
310 platformo=$object/cuboot-83xx.o
311 ;;
312 *-tqm8541|*-mpc8560*|*-tqm8560|*-tqm8555|*-ksi8560*)
313 platformo=$object/cuboot-85xx-cpm2.o
314 ;;
315 *-mpc85*|*-tqm85*)
316 platformo=$object/cuboot-85xx.o
317 ;;
318 *-amigaone)
319 link_address='0x800000'
320 ;;
321 esac
322 ;;
323ps3)
324 platformo="$object/ps3-head.o $object/ps3-hvcall.o $object/ps3.o"
325 lds=$object/zImage.ps3.lds
326 compression=
327 ext=bin
328 objflags="-O binary --set-section-flags=.bss=contents,alloc,load,data"
329 ksection=.kernel:vmlinux.bin
330 isection=.kernel:initrd
331 link_address=''
332 make_space=n
333 pie=
334 ;;
335ep88xc|ep8248e)
336 platformo="$object/fixed-head.o $object/$platform.o"
337 binary=y
338 ;;
339adder875-redboot)
340 platformo="$object/fixed-head.o $object/redboot-8xx.o"
341 binary=y
342 ;;
343simpleboot-*)
344 platformo="$object/fixed-head.o $object/simpleboot.o"
345 binary=y
346 ;;
347asp834x-redboot)
348 platformo="$object/fixed-head.o $object/redboot-83xx.o"
349 binary=y
350 ;;
351xpedite52*)
352 link_address='0x1400000'
353 platformo=$object/cuboot-85xx.o
354 ;;
355gamecube|wii)
356 link_address='0x600000'
357 platformo="$object/$platform-head.o $object/$platform.o"
358 ;;
359microwatt)
360 link_address='0x500000'
361 platformo="$object/fixed-head.o $object/$platform.o"
362 binary=y
363 ;;
364treeboot-currituck)
365 link_address='0x1000000'
366 ;;
367treeboot-akebono)
368 link_address='0x1000000'
369 ;;
370treeboot-iss4xx-mpic)
371 platformo="$object/treeboot-iss4xx.o"
372 ;;
373epapr)
374 platformo="$object/pseries-head.o $object/epapr.o $object/epapr-wrapper.o"
375 link_address='0x20000000'
376 pie=-pie
377 notext='-z notext'
378 rodynamic=$(if ${CROSS}ld -V 2>&1 | grep -q LLD ; then echo "-z rodynamic"; fi)
379 ;;
380mvme5100)
381 platformo="$object/fixed-head.o $object/mvme5100.o"
382 binary=y
383 ;;
384mvme7100)
385 platformo="$object/motload-head.o $object/mvme7100.o"
386 link_address='0x4000000'
387 binary=y
388 ;;
389esac
390
391vmz="$tmpdir/`basename \"$kernel\"`.$ext"
392
393# Calculate the vmlinux.strip size
394${CROSS}objcopy $objflags "$kernel" "$vmz.$$"
395strip_size=$(${CONFIG_SHELL} "${srctree}/scripts/file-size.sh" "$vmz.$$")
396
397if [ -z "$cacheit" -o ! -f "$vmz$compression" -o "$vmz$compression" -ot "$kernel" ]; then
398 # recompress the image if we need to
399 case $compression in
400 .xz)
401 xz --check=crc32 -f -6 "$vmz.$$"
402 ;;
403 .gz)
404 gzip -n -f -9 "$vmz.$$"
405 ;;
406 .lzma)
407 xz --format=lzma -f -6 "$vmz.$$"
408 ;;
409 .lzo)
410 lzop -f -9 "$vmz.$$"
411 ;;
412 *)
413 # drop the compression suffix so the stripped vmlinux is used
414 compression=
415 uboot_comp=none
416 ;;
417 esac
418
419 if [ -n "$cacheit" ]; then
420 mv -f "$vmz.$$$compression" "$vmz$compression"
421 else
422 vmz="$vmz.$$"
423 fi
424else
425 rm -f $vmz.$$
426fi
427
428vmz="$vmz$compression"
429
430if [ "$make_space" = "y" ]; then
431 # Round the size to next higher MB limit
432 round_size=$(((strip_size + 0xfffff) & 0xfff00000))
433
434 round_size=0x$(printf "%x" $round_size)
435 link_addr=$(printf "%d" $link_address)
436
437 if [ $link_addr -lt $strip_size ]; then
438 echo "INFO: Uncompressed kernel (size 0x$(printf "%x\n" $strip_size))" \
439 "overlaps the address of the wrapper($link_address)"
440 echo "INFO: Fixing the link_address of wrapper to ($round_size)"
441 link_address=$round_size
442 fi
443fi
444
445# Extract kernel version information, some platforms want to include
446# it in the image header
447version=`${CROSS}strings "$kernel" | grep '^Linux version [-0-9.]' | \
448 head -n1 | cut -d' ' -f3`
449if [ -n "$version" ]; then
450 uboot_version="-n Linux-$version"
451fi
452
453# physical offset of kernel image
454membase=`${CROSS}objdump -p "$kernel" | grep -m 1 LOAD | awk '{print $7}'`
455
456case "$platform" in
457uboot)
458 rm -f "$ofile"
459 ${MKIMAGE} -A ppc -O linux -T kernel -C $uboot_comp -a $membase -e $membase \
460 $uboot_version -d "$vmz" "$ofile"
461 if [ -z "$cacheit" ]; then
462 rm -f "$vmz"
463 fi
464 exit 0
465 ;;
466esac
467
468addsec() {
469 ${CROSS}objcopy $4 $1 \
470 --add-section=$3="$2" \
471 --set-section-flags=$3=contents,alloc,load,readonly,data
472}
473
474addsec $tmp "$vmz" $ksection $object/empty.o
475if [ -z "$cacheit" ]; then
476 rm -f "$vmz"
477fi
478
479if [ -n "$initrd" ]; then
480 addsec $tmp "$initrd" $isection
481fi
482
483if [ -n "$dtb" ]; then
484 addsec $tmp "$dtb" .kernel:dtb
485 if [ -n "$dts" ]; then
486 rm $dtb
487 fi
488fi
489
490if [ -n "$esm_blob" ]; then
491 addsec $tmp "$esm_blob" $esection
492fi
493
494if [ "$platform" != "miboot" ]; then
495 if [ -n "$link_address" ] ; then
496 text_start="-Ttext $link_address"
497 fi
498#link everything
499 ${CROSS}ld -m $format -T $lds $text_start $pie $nodl $nowarn $rodynamic $notext -o "$ofile" $map \
500 $platformo $tmp $object/wrapper.a
501 rm $tmp
502fi
503
504# Some platforms need the zImage's entry point and base address
505base=0x`${CROSS}nm "$ofile" | grep ' _start$' | cut -d' ' -f1`
506entry=`${CROSS}objdump -f "$ofile" | grep '^start address ' | cut -d' ' -f3`
507
508if [ -n "$binary" ]; then
509 mv "$ofile" "$ofile".elf
510 ${CROSS}objcopy -O binary "$ofile".elf "$ofile"
511fi
512
513# post-processing needed for some platforms
514case "$platform" in
515pseries|chrp)
516 $objbin/addnote "$ofile"
517 ;;
518coff)
519 ${CROSS}objcopy -O aixcoff-rs6000 --set-start "$entry" "$ofile"
520 $objbin/hack-coff "$ofile"
521 ;;
522cuboot*)
523 gzip -n -f -9 "$ofile"
524 ${MKIMAGE} -A ppc -O linux -T kernel -C gzip -a "$base" -e "$entry" \
525 $uboot_version -d "$ofile".gz "$ofile"
526 ;;
527treeboot*)
528 mv "$ofile" "$ofile.elf"
529 $objbin/mktree "$ofile.elf" "$ofile" "$base" "$entry"
530 if [ -z "$cacheit" ]; then
531 rm -f "$ofile.elf"
532 fi
533 exit 0
534 ;;
535ps3)
536 # The ps3's loader supports loading a gzipped binary image from flash
537 # rom to ram addr zero. The loader then enters the system reset
538 # vector at addr 0x100. A bootwrapper overlay is used to arrange for
539 # a binary image of the kernel to be at addr zero, and yet have a
540 # suitable bootwrapper entry at 0x100. To construct the final rom
541 # image 512 bytes from offset 0x100 is copied to the bootwrapper
542 # place holder at symbol __system_reset_kernel. The 512 bytes of the
543 # bootwrapper entry code at symbol __system_reset_overlay is then
544 # copied to offset 0x100. At runtime the bootwrapper program copies
545 # the data at __system_reset_kernel back to addr 0x100.
546
547 system_reset_overlay=0x`${CROSS}nm "$ofile" \
548 | grep ' __system_reset_overlay$' \
549 | cut -d' ' -f1`
550 system_reset_overlay=`printf "%d" $system_reset_overlay`
551 system_reset_kernel=0x`${CROSS}nm "$ofile" \
552 | grep ' __system_reset_kernel$' \
553 | cut -d' ' -f1`
554 system_reset_kernel=`printf "%d" $system_reset_kernel`
555 overlay_dest="256"
556 overlay_size="512"
557
558 ${CROSS}objcopy -O binary "$ofile" "$ofile.bin"
559
560 run_cmd dd if="$ofile.bin" of="$ofile.bin" conv=notrunc \
561 skip=$overlay_dest seek=$system_reset_kernel \
562 count=$overlay_size bs=1
563
564 run_cmd dd if="$ofile.bin" of="$ofile.bin" conv=notrunc \
565 skip=$system_reset_overlay seek=$overlay_dest \
566 count=$overlay_size bs=1
567
568 odir="$(dirname "$ofile.bin")"
569
570 # The ps3's flash loader has a size limit of 16 MiB for the uncompressed
571 # image. If a compressed image that exceeded this limit is written to
572 # flash the loader will decompress that image until the 16 MiB limit is
573 # reached, then enter the system reset vector of the partially decompressed
574 # image. No warning is issued.
575 rm -f "$odir"/{otheros,otheros-too-big}.bld
576 size=$(${CROSS}nm --no-sort --radix=d "$ofile" | grep -E ' _end$' | cut -d' ' -f1)
577 bld="otheros.bld"
578 if [ $size -gt $((0x1000000)) ]; then
579 bld="otheros-too-big.bld"
580 fi
581 gzip -n --force -9 --stdout "$ofile.bin" > "$odir/$bld"
582 ;;
583esac