projects/linux·blob master · refs

578 lines · 13.7 KiB

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