Debian Codegraph @

arch/powerpc/boot/wrapper

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