Merge tag 'kbuild-v6.1' of git://git.kernel.org/pub/scm/linux/kernel/git/masahiroy...
[linux-block.git] / arch / powerpc / boot / wrapper
CommitLineData
2bf11819 1#!/bin/sh
00b46d22 2# SPDX-License-Identifier: GPL-2.0-only
2bf11819
PM
3
4# Copyright (C) 2006 Paul Mackerras, IBM Corporation <paulus@samba.org>
2bf11819
PM
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)
528229d2 16# -e esm_blob specify ESM blob for secure images
2bf11819
PM
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 .)
f1e510bb
OH
23# -z use gzip (legacy)
24# -Z zsuffix compression to use (gz, xz or none)
2bf11819 25
d4740373
GL
26# Stop execution if any command fails
27set -e
28
b949d009
CL
29export LC_ALL=C
30
7f66c1fd
GL
31# Allow for verbose output
32if [ "$V" = 1 ]; then
33 set -x
f61200d3 34 map="-Map wrapper.map"
7f66c1fd
GL
35fi
36
2bf11819
PM
37# defaults
38kernel=
39ofile=zImage
40platform=of
41initrd=
42dtb=
43dts=
528229d2 44esm_blob=
2bf11819 45cacheit=
11c146cc 46binary=
f1e510bb 47compression=.gz
fbded57c 48uboot_comp=gzip
6975a783 49pie=
147c0516 50format=
4c078c86 51notext=
26ba9f96 52rodynamic=
2bf11819
PM
53
54# cross-compilation prefix
55CROSS=
56
3f884bf5
PT
57# mkimage wrapper script
58MKIMAGE=$srctree/scripts/mkuboot.sh
59
2bf11819
PM
60# directory for object and other files used by this script
61object=arch/powerpc/boot
5c539ee3 62objbin=$object
c79b2973 63dtc=scripts/dtc/dtc
2bf11819
PM
64
65# directory for working files
66tmpdir=.
67
68usage() {
69 echo 'Usage: wrapper [-o output] [-p platform] [-i initrd]' >&2
528229d2
BH
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
2bf11819
PM
73 exit 1
74}
75
879c26d4
GL
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
2bf11819
PM
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 ;;
528229d2
BH
115 -e)
116 shift
117 [ "$#" -gt 0 ] || usage
118 esm_blob="$1"
119 ;;
2bf11819
PM
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"
5c539ee3 137 objbin="$1"
2bf11819
PM
138 ;;
139 -W)
140 shift
141 [ "$#" -gt 0 ] || usage
142 tmpdir="$1"
143 ;;
f1e510bb
OH
144 -z)
145 compression=.gz
fbded57c 146 uboot_comp=gzip
f1e510bb
OH
147 ;;
148 -Z)
149 shift
150 [ "$#" -gt 0 ] || usage
264bffad 151 [ "$1" != "gz" -o "$1" != "xz" -o "$1" != "lzma" -o "$1" != "lzo" -o "$1" != "none" ] || usage
f1e510bb
OH
152
153 compression=".$1"
fbded57c 154 uboot_comp=$1
f1e510bb
OH
155
156 if [ $compression = ".none" ]; then
157 compression=
fbded57c 158 uboot_comp=none
f1e510bb 159 fi
fbded57c
CL
160 if [ $uboot_comp = "gz" ]; then
161 uboot_comp=gzip
162 fi
f1e510bb 163 ;;
a9903811 164 --no-gzip)
87c78b61 165 # a "feature" of the wrapper script is that it can be used outside
f1e510bb
OH
166 # the kernel tree. So keeping this around for backwards compatibility.
167 compression=
fbded57c 168 uboot_comp=none
a9903811 169 ;;
2bf11819
PM
170 -?)
171 usage
172 ;;
173 *)
174 [ -z "$kernel" ] || usage
175 kernel="$1"
176 ;;
177 esac
178 shift
179done
180
f1e510bb 181
2bf11819 182if [ -n "$dts" ]; then
701172d1
DW
183 if [ ! -r "$dts" -a -r "$object/dts/$dts" ]; then
184 dts="$object/dts/$dts"
185 fi
2bf11819
PM
186 if [ -z "$dtb" ]; then
187 dtb="$platform.dtb"
188 fi
c79b2973 189 $dtc -O dtb -o "$dtb" -b 0 "$dts"
2bf11819
PM
190fi
191
192if [ -z "$kernel" ]; then
193 kernel=vmlinux
194fi
195
77a88274 196LC_ALL=C elfformat="`${CROSS}objdump -p "$kernel" | grep 'file format' | awk '{print $4}'`"
147c0516
CLG
197case "$elfformat" in
198 elf64-powerpcle) format=elf64lppc ;;
199 elf64-powerpc) format=elf32ppc ;;
200 elf32-powerpc) format=elf32ppc ;;
201esac
202
ff45000f
NP
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 print a[1]*100000000 + a[2]*1000000 + a[3]*10000;
214 exit
215 }'
216}
217
218# Do not include PT_INTERP segment when linking pie. Non-pie linking
219# just ignores this option.
220LD_VERSION=$(${CROSS}ld --version | ld_version)
221LD_NO_DL_MIN_VERSION=$(echo 2.26 | ld_version)
222if [ "$LD_VERSION" -ge "$LD_NO_DL_MIN_VERSION" ] ; then
223 nodl="--no-dynamic-linker"
224fi
147c0516 225
2bf11819
PM
226platformo=$object/"$platform".o
227lds=$object/zImage.lds
228ext=strip
229objflags=-S
230tmp=$tmpdir/zImage.$$.o
231ksection=.kernel:vmlinux.strip
232isection=.kernel:initrd
528229d2 233esection=.kernel:esm_blob
9b09c6d9 234link_address='0x400000'
dfbc2d75 235make_space=y
2bf11819 236
528229d2
BH
237
238if [ -n "$esm_blob" -a "$platform" != "pseries" ]; then
239 echo "ESM blob not support on non-pseries platforms" >&2
240 exit 1
241fi
242
2bf11819 243case "$platform" in
44790a0b
BH
244of)
245 platformo="$object/of.o $object/epapr.o"
246 make_space=n
247 ;;
9b09c6d9 248pseries)
2d9afb36 249 platformo="$object/pseries-head.o $object/of.o $object/epapr.o"
9b09c6d9 250 link_address='0x4000000'
147c0516
CLG
251 if [ "$format" != "elf32ppc" ]; then
252 link_address=
253 pie=-pie
254 fi
f5467e28 255 make_space=n
9b09c6d9 256 ;;
58706ef9 257maple)
0c9fa291 258 platformo="$object/of.o $object/epapr.o"
58706ef9 259 link_address='0x400000'
f5467e28 260 make_space=n
58706ef9 261 ;;
9b09c6d9 262pmac|chrp)
0c9fa291 263 platformo="$object/of.o $object/epapr.o"
f5467e28 264 make_space=n
2bf11819 265 ;;
627aa944 266coff)
0c9fa291 267 platformo="$object/crt0.o $object/of.o $object/epapr.o"
2bf11819 268 lds=$object/zImage.coff.lds
9b09c6d9 269 link_address='0x500000'
f5467e28 270 make_space=n
6975a783 271 pie=
2bf11819 272 ;;
11eab297 273miboot|uboot*)
2bf11819
PM
274 # miboot and U-boot want just the bare bits, not an ELF binary
275 ext=bin
276 objflags="-O binary"
277 tmp="$ofile"
278 ksection=image
279 isection=initrd
280 ;;
0fdd717e 281cuboot*)
11c146cc 282 binary=y
f1e510bb 283 compression=
25431333 284 case "$platform" in
8dd217b2 285 *-mpc866ads|*-mpc885ads|*-adder875*|*-ep88xc)
25431333
GL
286 platformo=$object/cuboot-8xx.o
287 ;;
288 *5200*|*-motionpro)
289 platformo=$object/cuboot-52xx.o
290 ;;
291 *-pq2fads|*-ep8248e|*-mpc8272*|*-storcenter)
292 platformo=$object/cuboot-pq2.o
293 ;;
294 *-mpc824*)
295 platformo=$object/cuboot-824x.o
296 ;;
59d13f9d 297 *-mpc83*|*-asp834x*)
25431333
GL
298 platformo=$object/cuboot-83xx.o
299 ;;
ff880112 300 *-tqm8541|*-mpc8560*|*-tqm8560|*-tqm8555|*-ksi8560*)
25431333
GL
301 platformo=$object/cuboot-85xx-cpm2.o
302 ;;
c12adb06 303 *-mpc85*|*-tqm85*)
25431333
GL
304 platformo=$object/cuboot-85xx.o
305 ;;
8f23735d
GP
306 *-amigaone)
307 link_address='0x800000'
308 ;;
25431333 309 esac
0fdd717e 310 ;;
bafdb645
GL
311ps3)
312 platformo="$object/ps3-head.o $object/ps3-hvcall.o $object/ps3.o"
313 lds=$object/zImage.ps3.lds
f1e510bb 314 compression=
bafdb645
GL
315 ext=bin
316 objflags="-O binary --set-section-flags=.bss=contents,alloc,load,data"
317 ksection=.kernel:vmlinux.bin
318 isection=.kernel:initrd
9b09c6d9 319 link_address=''
dfbc2d75 320 make_space=n
6975a783 321 pie=
bafdb645 322 ;;
a55387e5 323ep88xc|ep405|ep8248e)
11c146cc
SW
324 platformo="$object/fixed-head.o $object/$platform.o"
325 binary=y
326 ;;
a55387e5
SW
327adder875-redboot)
328 platformo="$object/fixed-head.o $object/redboot-8xx.o"
329 binary=y
330 ;;
1d46e379 331simpleboot-*)
a7e1cf0c 332 platformo="$object/fixed-head.o $object/simpleboot.o"
1d46e379
GL
333 binary=y
334 ;;
59d13f9d
BD
335asp834x-redboot)
336 platformo="$object/fixed-head.o $object/redboot-83xx.o"
337 binary=y
338 ;;
24760823
NC
339xpedite52*)
340 link_address='0x1400000'
341 platformo=$object/cuboot-85xx.o
342 ;;
6cdd2417 343gamecube|wii)
b68a24bc
AH
344 link_address='0x600000'
345 platformo="$object/$platform-head.o $object/$platform.o"
346 ;;
4a21192e
JS
347microwatt)
348 link_address='0x500000'
349 platformo="$object/fixed-head.o $object/$platform.o"
350 binary=y
351 ;;
228d5505
TB
352treeboot-currituck)
353 link_address='0x1000000'
354 ;;
2a2c74b2
AP
355treeboot-akebono)
356 link_address='0x1000000'
357 ;;
b4e8c8dd
TS
358treeboot-iss4xx-mpic)
359 platformo="$object/treeboot-iss4xx.o"
360 ;;
6c5b59b9 361epapr)
90d1d44e 362 platformo="$object/pseries-head.o $object/epapr.o $object/epapr-wrapper.o"
6c5b59b9
DG
363 link_address='0x20000000'
364 pie=-pie
4c078c86 365 notext='-z notext'
26ba9f96 366 rodynamic=$(if ${CROSS}ld -V 2>&1 | grep -q LLD ; then echo "-z rodynamic"; fi)
6c5b59b9 367 ;;
be201981
SC
368mvme5100)
369 platformo="$object/fixed-head.o $object/mvme5100.o"
370 binary=y
371 ;;
97493e2e
AIB
372mvme7100)
373 platformo="$object/motload-head.o $object/mvme7100.o"
374 link_address='0x4000000'
375 binary=y
376 ;;
2bf11819
PM
377esac
378
379vmz="$tmpdir/`basename \"$kernel\"`.$ext"
a9903811 380
f1e510bb
OH
381# Calculate the vmlinux.strip size
382${CROSS}objcopy $objflags "$kernel" "$vmz.$$"
a670b0b4 383strip_size=$(${CONFIG_SHELL} "${srctree}/scripts/file-size.sh" "$vmz.$$")
c55aef0e 384
f1e510bb
OH
385if [ -z "$cacheit" -o ! -f "$vmz$compression" -o "$vmz$compression" -ot "$kernel" ]; then
386 # recompress the image if we need to
387 case $compression in
388 .xz)
389 xz --check=crc32 -f -6 "$vmz.$$"
390 ;;
391 .gz)
c4f56af0 392 gzip -n -f -9 "$vmz.$$"
f1e510bb 393 ;;
1cc9a21b
CL
394 .lzma)
395 xz --format=lzma -f -6 "$vmz.$$"
396 ;;
264bffad
CL
397 .lzo)
398 lzop -f -9 "$vmz.$$"
399 ;;
f1e510bb
OH
400 *)
401 # drop the compression suffix so the stripped vmlinux is used
402 compression=
fbded57c 403 uboot_comp=none
f1e510bb
OH
404 ;;
405 esac
a9903811 406
2bf11819 407 if [ -n "$cacheit" ]; then
f1e510bb 408 mv -f "$vmz.$$$compression" "$vmz$compression"
2bf11819
PM
409 else
410 vmz="$vmz.$$"
411 fi
c55aef0e 412else
c55aef0e
SP
413 rm -f $vmz.$$
414fi
415
f1e510bb
OH
416vmz="$vmz$compression"
417
dfbc2d75
SR
418if [ "$make_space" = "y" ]; then
419 # Round the size to next higher MB limit
420 round_size=$(((strip_size + 0xfffff) & 0xfff00000))
c55aef0e 421
dfbc2d75
SR
422 round_size=0x$(printf "%x" $round_size)
423 link_addr=$(printf "%d" $link_address)
c55aef0e 424
dfbc2d75
SR
425 if [ $link_addr -lt $strip_size ]; then
426 echo "INFO: Uncompressed kernel (size 0x$(printf "%x\n" $strip_size))" \
427 "overlaps the address of the wrapper($link_address)"
428 echo "INFO: Fixing the link_address of wrapper to ($round_size)"
429 link_address=$round_size
430 fi
2bf11819
PM
431fi
432
a6afacb6
DG
433# Extract kernel version information, some platforms want to include
434# it in the image header
435version=`${CROSS}strings "$kernel" | grep '^Linux version [-0-9.]' | \
2df8220c 436 head -n1 | cut -d' ' -f3`
a6afacb6
DG
437if [ -n "$version" ]; then
438 uboot_version="-n Linux-$version"
439fi
0fdd717e 440
b18796d3
KG
441# physical offset of kernel image
442membase=`${CROSS}objdump -p "$kernel" | grep -m 1 LOAD | awk '{print $7}'`
443
0fdd717e
SW
444case "$platform" in
445uboot)
446 rm -f "$ofile"
fbded57c 447 ${MKIMAGE} -A ppc -O linux -T kernel -C $uboot_comp -a $membase -e $membase \
a6afacb6 448 $uboot_version -d "$vmz" "$ofile"
2bf11819 449 if [ -z "$cacheit" ]; then
a9903811 450 rm -f "$vmz"
2bf11819
PM
451 fi
452 exit 0
453 ;;
11eab297
BH
454uboot-obs600)
455 rm -f "$ofile"
456 # obs600 wants a multi image with an initrd, so we need to put a fake
457 # one in even when building a "normal" image.
458 if [ -n "$initrd" ]; then
459 real_rd="$initrd"
460 else
461 real_rd=`mktemp`
462 echo "\0" >>"$real_rd"
463 fi
464 ${MKIMAGE} -A ppc -O linux -T multi -C gzip -a $membase -e $membase \
465 $uboot_version -d "$vmz":"$real_rd":"$dtb" "$ofile"
466 if [ -z "$initrd" ]; then
467 rm -f "$real_rd"
468 fi
469 if [ -z "$cacheit" ]; then
470 rm -f "$vmz"
471 fi
472 exit 0
473 ;;
2bf11819
PM
474esac
475
476addsec() {
477 ${CROSS}objcopy $4 $1 \
478 --add-section=$3="$2" \
479 --set-section-flags=$3=contents,alloc,load,readonly,data
480}
481
a9903811 482addsec $tmp "$vmz" $ksection $object/empty.o
2bf11819 483if [ -z "$cacheit" ]; then
a9903811 484 rm -f "$vmz"
2bf11819
PM
485fi
486
487if [ -n "$initrd" ]; then
c888554b 488 addsec $tmp "$initrd" $isection
2bf11819
PM
489fi
490
491if [ -n "$dtb" ]; then
c888554b 492 addsec $tmp "$dtb" .kernel:dtb
e9c4b4bd
MG
493 if [ -n "$dts" ]; then
494 rm $dtb
495 fi
2bf11819
PM
496fi
497
528229d2
BH
498if [ -n "$esm_blob" ]; then
499 addsec $tmp "$esm_blob" $esection
500fi
501
2bf11819 502if [ "$platform" != "miboot" ]; then
9b09c6d9 503 if [ -n "$link_address" ] ; then
6975a783 504 text_start="-Ttext $link_address"
9b09c6d9 505 fi
f1e510bb 506#link everything
4c078c86 507 ${CROSS}ld -m $format -T $lds $text_start $pie $nodl $rodynamic $notext -o "$ofile" $map \
cd197ffc 508 $platformo $tmp $object/wrapper.a
2bf11819
PM
509 rm $tmp
510fi
511
a6afacb6
DG
512# Some platforms need the zImage's entry point and base address
513base=0x`${CROSS}nm "$ofile" | grep ' _start$' | cut -d' ' -f1`
514entry=`${CROSS}objdump -f "$ofile" | grep '^start address ' | cut -d' ' -f3`
515
11c146cc
SW
516if [ -n "$binary" ]; then
517 mv "$ofile" "$ofile".elf
aeb4552f 518 ${CROSS}objcopy -O binary "$ofile".elf "$ofile"
11c146cc
SW
519fi
520
2bf11819
PM
521# post-processing needed for some platforms
522case "$platform" in
58706ef9 523pseries|chrp|maple)
5663a123 524 $objbin/addnote "$ofile"
0dcd4401 525 ;;
627aa944 526coff)
cd197ffc 527 ${CROSS}objcopy -O aixcoff-rs6000 --set-start "$entry" "$ofile"
5c539ee3 528 $objbin/hack-coff "$ofile"
2bf11819 529 ;;
0fdd717e 530cuboot*)
c4f56af0 531 gzip -n -f -9 "$ofile"
3f884bf5 532 ${MKIMAGE} -A ppc -O linux -T kernel -C gzip -a "$base" -e "$entry" \
aeb4552f 533 $uboot_version -d "$ofile".gz "$ofile"
0fdd717e 534 ;;
f6dfc805
DG
535treeboot*)
536 mv "$ofile" "$ofile.elf"
5c539ee3 537 $objbin/mktree "$ofile.elf" "$ofile" "$base" "$entry"
f6dfc805
DG
538 if [ -z "$cacheit" ]; then
539 rm -f "$ofile.elf"
540 fi
541 exit 0
542 ;;
bafdb645 543ps3)
5761eaa3
GL
544 # The ps3's loader supports loading a gzipped binary image from flash
545 # rom to ram addr zero. The loader then enters the system reset
546 # vector at addr 0x100. A bootwrapper overlay is used to arrange for
547 # a binary image of the kernel to be at addr zero, and yet have a
548 # suitable bootwrapper entry at 0x100. To construct the final rom
549 # image 512 bytes from offset 0x100 is copied to the bootwrapper
550 # place holder at symbol __system_reset_kernel. The 512 bytes of the
551 # bootwrapper entry code at symbol __system_reset_overlay is then
552 # copied to offset 0x100. At runtime the bootwrapper program copies
553 # the data at __system_reset_kernel back to addr 0x100.
bafdb645 554
aeb4552f 555 system_reset_overlay=0x`${CROSS}nm "$ofile" \
bafdb645
GL
556 | grep ' __system_reset_overlay$' \
557 | cut -d' ' -f1`
558 system_reset_overlay=`printf "%d" $system_reset_overlay`
aeb4552f 559 system_reset_kernel=0x`${CROSS}nm "$ofile" \
bafdb645
GL
560 | grep ' __system_reset_kernel$' \
561 | cut -d' ' -f1`
562 system_reset_kernel=`printf "%d" $system_reset_kernel`
563 overlay_dest="256"
5761eaa3 564 overlay_size="512"
bafdb645 565
aeb4552f
SW
566 ${CROSS}objcopy -O binary "$ofile" "$ofile.bin"
567
879c26d4
GL
568 run_cmd dd if="$ofile.bin" of="$ofile.bin" conv=notrunc \
569 skip=$overlay_dest seek=$system_reset_kernel \
d4740373 570 count=$overlay_size bs=1
bafdb645 571
879c26d4
GL
572 run_cmd dd if="$ofile.bin" of="$ofile.bin" conv=notrunc \
573 skip=$system_reset_overlay seek=$overlay_dest \
d4740373 574 count=$overlay_size bs=1
bafdb645 575
928b9695 576 odir="$(dirname "$ofile.bin")"
aa3bc365
GL
577
578 # The ps3's flash loader has a size limit of 16 MiB for the uncompressed
579 # image. If a compressed image that exceeded this limit is written to
580 # flash the loader will decompress that image until the 16 MiB limit is
581 # reached, then enter the system reset vector of the partially decompressed
582 # image. No warning is issued.
583 rm -f "$odir"/{otheros,otheros-too-big}.bld
584 size=$(${CROSS}nm --no-sort --radix=d "$ofile" | egrep ' _end$' | cut -d' ' -f1)
585 bld="otheros.bld"
586 if [ $size -gt $((0x1000000)) ]; then
587 bld="otheros-too-big.bld"
588 fi
589 gzip -n --force -9 --stdout "$ofile.bin" > "$odir/$bld"
bafdb645 590 ;;
2bf11819 591esac