xref: /rk3399_rockchip-uboot/scripts/fit.sh (revision b6ea0cb4adae620c68f381ac2f0a0e6d716e13f4)
1#!/bin/bash
2#
3# Copyright (c) 2020 Fuzhou Rockchip Electronics Co., Ltd
4#
5# SPDX-License-Identifier: GPL-2.0
6#
7set -e
8
9FIT_DIR="fit"
10IMG_UBOOT="uboot.img"
11IMG_BOOT="boot.img"
12ITB_UBOOT="${FIT_DIR}/uboot.itb"
13ITB_BOOT="${FIT_DIR}/boot.itb"
14SIG_BIN="data2sign.bin"
15SIG_UBOOT="${FIT_DIR}/uboot.data2sign"
16SIG_BOOT="${FIT_DIR}/boot.data2sign"
17# offs
18OFFS_NS_UBOOT="0xa00"
19OFFS_S_UBOOT="0xc00"
20OFFS_NS_BOOT="0x800"
21OFFS_S_BOOT="0xc00"
22# file
23CHIP_FILE="arch/arm/lib/.asm-offsets.s.cmd"
24# placeholder address
25FDT_ADDR_PLACEHOLDER="0xffffff00"
26KERNEL_ADDR_PLACEHOLDER="0xffffff01"
27RAMDISK_ADDR_PLACEHOLDER="0xffffff02"
28# tools
29MKIMAGE="./tools/mkimage"
30FIT_UNPACK="./scripts/fit-unpack.sh"
31CHECK_SIGN="./tools/fit_check_sign"
32# key
33KEY_DIR="keys/"
34RSA_PRI_KEY="keys/dev.key"
35RSA_PUB_KEY="keys/dev.crt"
36SIGNATURE_KEY_NODE="/signature/key-dev"
37SPL_DTB="spl/u-boot-spl.dtb"
38UBOOT_DTB="u-boot.dtb"
39# its
40ITS_UBOOT="u-boot.its"
41ITS_BOOT="boot.its"
42ARG_VER_UBOOT="0"
43ARG_VER_BOOT="0"
44
45function help()
46{
47	echo
48	echo "usage:"
49	echo "    $0 [args]"
50	echo
51	echo "args:"
52	echo "    --rollback-index-boot   <decimal integer>"
53	echo "    --rollback-index-uboot  <decimal integer>"
54	echo "    --version-uboot         <decimal integer>"
55	echo "    --version-boot          <decimal integer>"
56	echo "    --ini-trust"
57	echo "    --ini-loader"
58	echo "    --no-check"
59	echo "    --spl-new"
60	echo "    --boot_img"
61	echo "    --args"
62	echo
63}
64
65function arg_check_decimal()
66{
67	if [ -z $1 ]; then
68		help
69		exit 1
70	fi
71
72	decimal=`echo $1 |sed 's/[0-9]//g'`
73	if [ ! -z ${decimal} ]; then
74		echo "ERROR: $1 is not decimal integer"
75		help
76		exit 1
77	fi
78}
79
80function check_its()
81{
82	cat $1 | while read line
83	do
84		file=`echo ${line} | sed -n "/incbin/p" | awk -F '"' '{ printf $2 }' | tr -d ' '`
85		if [ ! -f ${file} ]; then
86			echo "ERROR: No ${file}"
87			exit 1
88		fi
89	done
90}
91
92function validate_arg()
93{
94	case $1 in
95		--no-check|--spl-new|--burn-key-hash)
96			shift=1
97			;;
98		--ini-trust|--ini-loader|--rollback-index-boot|--rollback-index-uboot|--boot_img|--version-uboot|--version-boot)
99			shift=2
100			;;
101		*)
102			shift=0
103			;;
104	esac
105	echo ${shift}
106}
107
108function fit_process_args()
109{
110	if [ $# -eq 0 ]; then
111		help
112		exit 0
113	fi
114
115	while [ $# -gt 0 ]; do
116		case $1 in
117			--args)
118				ARG_VALIDATE=$2
119				shift 2
120				;;
121			--boot_img)     # boot.img
122				ARG_BOOT_IMG=$2
123				shift 2
124				;;
125			--boot_img_dir) # boot.img components directory
126				ARG_BOOT_IMG_DIR=$2
127				shift 2
128				;;
129			--no-check)     # No hostcc fit signature check
130				ARG_NO_CHECK="y"
131				shift 1
132				;;
133			--ini-trust)    # Assign trust ini file
134				ARG_INI_TRUST=$2
135				shift 2
136				;;
137			--ini-loader)   # Assign loader ini file
138				ARG_INI_LOADER=$2
139				shift 2
140				;;
141			--spl-new)      # Use current build u-boot-spl.bin to pack loader
142				ARG_SPL_NEW="y"
143				shift 1
144				;;
145			--rollback-index-boot)
146				ARG_ROLLBACK_IDX_BOOT=$2
147				arg_check_decimal $2
148				shift 2
149				;;
150			--rollback-index-uboot)
151				ARG_ROLLBACK_IDX_UBOOT=$2
152				arg_check_decimal $2
153				shift 2
154				;;
155			--version-uboot)
156				ARG_VER_UBOOT=$2
157				arg_check_decimal $2
158				shift 2
159				;;
160			--version-boot)
161				ARG_VER_BOOT=$2
162				arg_check_decimal $2
163				shift 2
164				;;
165			--burn-key-hash)
166				ARG_BURN_KEY_HASH="y"
167				shift 1
168				;;
169			*)
170				help
171				exit 1
172				;;
173		esac
174	done
175
176	if grep -q '^CONFIG_FIT_SIGNATURE=y' .config ; then
177		ARG_SIGN="y"
178	fi
179}
180
181function fit_raw_compile()
182{
183	# Verified-boot: should rebuild code but don't need to repack images.
184	if [ "${ARG_SIGN}" == "y" ]; then
185		./make.sh --raw-compile
186	fi
187	rm ${FIT_DIR} -rf && mkdir -p ${FIT_DIR}
188}
189
190function fit_gen_uboot_itb()
191{
192	./make.sh itb ${ARG_INI_TRUST} >/dev/null 2>&1
193	check_its ${ITS_UBOOT}
194
195	if [ "${ARG_SIGN}" != "y" ]; then
196		${MKIMAGE} -f ${ITS_UBOOT} -E -p ${OFFS_NS_UBOOT} ${ITB_UBOOT} -v ${ARG_VER_UBOOT}
197		if [ "${ARG_SPL_NEW}" == "y" ]; then
198			./make.sh --spl ${ARG_INI_LOADER}
199			echo "pack loader with new: spl/u-boot-spl.bin"
200		else
201			./make.sh loader ${ARG_INI_LOADER}
202		fi
203	else
204		if [ ! -f ${RSA_PRI_KEY} ]; then
205			echo "ERROR: No ${RSA_PRI_KEY} "
206			exit 1
207		elif [ ! -f ${RSA_PUB_KEY} ]; then
208			echo "ERROR: No ${RSA_PUB_KEY} "
209			exit 1
210		fi
211
212		if ! grep -q '^CONFIG_SPL_FIT_SIGNATURE=y' .config ; then
213			echo "ERROR: CONFIG_SPL_FIT_SIGNATURE is disabled"
214			exit 1
215		fi
216
217		# rollback-index
218		if grep -q '^CONFIG_SPL_FIT_ROLLBACK_PROTECT=y' .config ; then
219			ARG_SPL_ROLLBACK_PROTECT="y"
220			if [ -z ${ARG_ROLLBACK_IDX_UBOOT} ]; then
221				echo "ERROR: No arg \"--rollback-index-uboot <n>\""
222				exit 1
223			fi
224		fi
225
226		if [ "${ARG_SPL_ROLLBACK_PROTECT}" == "y" ]; then
227			VERSION=`grep 'rollback-index' ${ITS_UBOOT} | awk -F '=' '{ printf $2 }' | tr -d ' '`
228			sed -i "s/rollback-index = ${VERSION}/rollback-index = <${ARG_ROLLBACK_IDX_UBOOT}>;/g" ${ITS_UBOOT}
229		fi
230
231		# burn-key-hash
232		if [ "${ARG_BURN_KEY_HASH}" == "y" ]; then
233			sed -i "s/burn-key-hash = <0>;/burn-key-hash = <1>;/g" ${ITS_UBOOT}
234		fi
235
236		# u-boot.dtb must contains rsa key
237		if ! fdtget -l ${UBOOT_DTB} /signature >/dev/null 2>&1 ; then
238			${MKIMAGE} -f ${ITS_UBOOT} -k ${KEY_DIR} -K ${UBOOT_DTB} -E -p ${OFFS_S_UBOOT} -r ${ITB_UBOOT} -v ${ARG_VER_UBOOT}
239			echo "## Adding RSA public key into ${UBOOT_DTB}"
240		fi
241
242		# Pack
243		${MKIMAGE} -f ${ITS_UBOOT} -k ${KEY_DIR} -K ${SPL_DTB} -E -p ${OFFS_S_UBOOT} -r ${ITB_UBOOT} -v ${ARG_VER_UBOOT}
244		mv ${SIG_BIN} ${SIG_UBOOT}
245
246		# rollback-index read back check
247		if [ "${ARG_SPL_ROLLBACK_PROTECT}" == "y" ]; then
248			VERSION=`fdtget -ti ${ITB_UBOOT} /configurations/conf rollback-index`
249			if [ "${VERSION}" != "${ARG_ROLLBACK_IDX_UBOOT}" ]; then
250				echo "ERROR: Failed to set rollback-index for ${ITB_UBOOT}";
251				exit 1
252			fi
253		fi
254
255		# burn-key-hash read back check
256		if [ "${ARG_BURN_KEY_HASH}" == "y" ]; then
257			if [ "`fdtget -ti ${ITB_UBOOT} /configurations/conf burn-key-hash`" != "1" ]; then
258				echo "ERROR: Failed to set burn-key-hash for ${ITB_UBOOT}";
259				exit 1
260			fi
261		fi
262
263		# host check signature
264		if [ "${ARG_NO_CHECK}" != "y" ]; then
265			if [ "${ARG_SPL_NEW}" == "y" ]; then
266				 ${CHECK_SIGN} -f ${ITB_UBOOT} -k ${SPL_DTB} -s
267			else
268				spl_file="../rkbin/"`sed -n "/FlashBoot=/s/FlashBoot=//p" ${ARG_INI_LOADER}  |tr -d '\r'`
269				offs=`fdtdump -s ${spl_file} | head -1 | awk -F ":" '{ print $2 }' | sed "s/ found fdt at offset //g" | tr -d " "`
270				if [ -z ${offs}  ]; then
271					echo "ERROR: invalid ${spl_file} , unable to find fdt blob"
272				fi
273				offs=`printf %d ${offs} ` # hex -> dec
274				dd if=${spl_file} of=spl/u-boot-spl-old.dtb bs=${offs} skip=1 >/dev/null 2>&1
275				${CHECK_SIGN} -f ${ITB_UBOOT} -k spl/u-boot-spl-old.dtb -s
276			fi
277		fi
278
279		# minimize u-boot-spl.dtb
280		if grep -q '^CONFIG_SPL_FIT_HW_CRYPTO=y' .config ; then
281			fdtput -tx ${SPL_DTB} ${SIGNATURE_KEY_NODE} rsa,r-squared 0x0
282			if grep -q '^CONFIG_SPL_ROCKCHIP_CRYPTO_V1=y' .config ; then
283				fdtput -tx ${SPL_DTB} ${SIGNATURE_KEY_NODE} rsa,np 0x0
284			else
285				fdtput -tx ${SPL_DTB} ${SIGNATURE_KEY_NODE} rsa,c 0x0
286			fi
287		else
288			fdtput -tx ${SPL_DTB} ${SIGNATURE_KEY_NODE} rsa,c 0x0
289			fdtput -tx ${SPL_DTB} ${SIGNATURE_KEY_NODE} rsa,np 0x0
290			fdtput -tx ${SPL_DTB} ${SIGNATURE_KEY_NODE} rsa,exponent-BN 0x0
291		fi
292
293		# repack spl
294		rm -f *_loader_*.bin
295		if [ "${ARG_SPL_NEW}" == "y" ]; then
296			cat spl/u-boot-spl-nodtb.bin > spl/u-boot-spl.bin
297			if ! grep -q '^CONFIG_SPL_SEPARATE_BSS=y' .config ; then
298				cat spl/u-boot-spl-pad.bin >> spl/u-boot-spl.bin
299			fi
300			cat ${SPL_DTB} >> spl/u-boot-spl.bin
301
302			./make.sh --spl ${ARG_INI_LOADER}
303			echo "pack loader with new: spl/u-boot-spl.bin"
304		else
305			./make.sh loader ${ARG_INI_LOADER}
306		fi
307	fi
308
309	rm -f u-boot.itb u-boot.img u-boot-dtb.img
310	mv ${ITS_UBOOT} ${FIT_DIR}
311}
312
313function fit_gen_boot_itb()
314{
315	if [ ! -z ${ARG_BOOT_IMG} ]; then
316		${FIT_UNPACK} -f ${ARG_BOOT_IMG} -o ${FIT_DIR}/unpack
317		ITS_BOOT="${FIT_DIR}/unpack/image.its"
318	else
319		compression=`awk -F"," '/COMPRESSION=/  { printf $1 }' ${ARG_INI_TRUST} | tr -d ' ' | cut -c 13-`
320		if [ -z "${compression}" ]; then
321			compression="none"
322		fi
323		./arch/arm/mach-rockchip/make_fit_boot.sh -c ${compression} > ${ITS_BOOT}
324		check_its ${ITS_BOOT}
325	fi
326
327	if [ "${ARG_SIGN}" != "y" ]; then
328		${MKIMAGE} -f ${ITS_BOOT} -E -p ${OFFS_NS_BOOT} ${ITB_BOOT} -v ${ARG_VER_BOOT}
329	else
330		if [ ! -f ${RSA_PRI_KEY}  ]; then
331			echo "ERROR: No ${RSA_PRI_KEY}"
332			exit 1
333		elif [ ! -f ${RSA_PUB_KEY}  ]; then
334			echo "ERROR: No ${RSA_PUB_KEY}"
335			exit 1
336		fi
337
338		if ! grep -q '^CONFIG_FIT_SIGNATURE=y' .config ; then
339			echo "ERROR: CONFIG_FIT_SIGNATURE is disabled"
340			exit 1
341		fi
342
343		if grep -q '^CONFIG_FIT_ROLLBACK_PROTECT=y' .config ; then
344			ARG_ROLLBACK_PROTECT="y"
345			if [ -z ${ARG_ROLLBACK_IDX_BOOT} ]; then
346				echo "ERROR: No arg \"--rollback-index-boot <n>\""
347				exit 1
348			fi
349		fi
350
351		# fixup
352		COMMON_FILE=`sed -n "/_common.h/p" ${CHIP_FILE} | awk '{ print $1 }'`
353		FDT_ADDR_R=`awk /fdt_addr_r/         ${COMMON_FILE} | awk -F '=' '{ print $2 }' | awk -F '\\' '{ print $1 }'`
354		KERNEL_ADDR_R=`awk /kernel_addr_r/   ${COMMON_FILE} | awk -F '=' '{ print $2 }' | awk -F '\\' '{ print $1 }'`
355		RMADISK_ADDR_R=`awk /ramdisk_addr_r/ ${COMMON_FILE} | awk -F '=' '{ print $2 }' | awk -F '\\' '{ print $1 }'`
356		sed -i "s/${FDT_ADDR_PLACEHOLDER}/${FDT_ADDR_R}/g"         ${ITS_BOOT}
357		sed -i "s/${KERNEL_ADDR_PLACEHOLDER}/${KERNEL_ADDR_R}/g"   ${ITS_BOOT}
358		sed -i "s/${RAMDISK_ADDR_PLACEHOLDER}/${RMADISK_ADDR_R}/g" ${ITS_BOOT}
359		if grep -q '^CONFIG_ARM64=y' .config ; then
360			sed -i 's/arch = "arm";/arch = "arm64";/g' ${ITS_BOOT}
361		fi
362
363		if [ "${ARG_ROLLBACK_PROTECT}" == "y" ]; then
364			VERSION=`grep 'rollback-index' ${ITS_BOOT} | awk -F '=' '{ printf $2 }' | tr -d ' '`
365			sed -i "s/rollback-index = ${VERSION}/rollback-index = <${ARG_ROLLBACK_IDX_BOOT}>;/g" ${ITS_BOOT}
366		fi
367
368		${MKIMAGE} -f ${ITS_BOOT} -k ${KEY_DIR} -K ${UBOOT_DTB} -E -p ${OFFS_S_BOOT} -r ${ITB_BOOT} -v ${ARG_VER_BOOT}
369		mv ${SIG_BIN} ${SIG_BOOT}
370
371		# rollback-index read back check
372		if [ "${ARG_ROLLBACK_PROTECT}" == "y" ]; then
373			VERSION=`fdtget -ti ${ITB_BOOT} /configurations/conf rollback-index`
374			if [ "${VERSION}" != "${ARG_ROLLBACK_IDX_BOOT}" ]; then
375				echo "ERROR: Failed to set rollback-index for ${ITB_BOOT}";
376				exit 1
377			fi
378		fi
379
380		if [ "${ARG_NO_CHECK}" != "y" ]; then
381			 ${CHECK_SIGN} -f ${ITB_BOOT} -k ${UBOOT_DTB}
382		fi
383
384		# minimize u-boot.dtb
385		if grep -q '^CONFIG_FIT_HW_CRYPTO=y' .config ; then
386			fdtput -tx ${UBOOT_DTB} ${SIGNATURE_KEY_NODE} rsa,r-squared 0x0
387			if grep -q '^CONFIG_ROCKCHIP_CRYPTO_V1=y' .config ; then
388				fdtput -tx ${UBOOT_DTB} ${SIGNATURE_KEY_NODE} rsa,np 0x0
389			else
390				fdtput -tx ${UBOOT_DTB} ${SIGNATURE_KEY_NODE} rsa,c 0x0
391			fi
392		else
393			fdtput -tx ${UBOOT_DTB} ${SIGNATURE_KEY_NODE} rsa,c 0x0
394			fdtput -tx ${UBOOT_DTB} ${SIGNATURE_KEY_NODE} rsa,np 0x0
395			fdtput -tx ${UBOOT_DTB} ${SIGNATURE_KEY_NODE} rsa,exponent-BN 0x0
396		fi
397	fi
398
399	mv ${ITS_BOOT} ${FIT_DIR}
400}
401
402function fit_gen_uboot_img()
403{
404	ITB=$1
405
406	if [ -z ${ITB} ]; then
407		ITB=${ITB_UBOOT}
408	fi
409
410	ITB_MAX_NUM=`sed -n "/SPL_FIT_IMAGE_MULTIPLE/p" .config | awk -F "=" '{ print $2 }'`
411	ITB_MAX_KB=`sed  -n "/SPL_FIT_IMAGE_KB/p" .config | awk -F "=" '{ print $2 }'`
412	ITB_MAX_BS=$((ITB_MAX_KB*1024))
413	ITB_BS=`ls -l ${ITB} | awk '{ print $5 }'`
414
415	if [ ${ITB_BS} -gt ${ITB_MAX_BS} ]; then
416		echo "ERROR: pack ${IMG_UBOOT} failed! ${ITB} actual: ${ITB_BS} bytes, max limit: ${ITB_MAX_BS} bytes"
417		exit 1
418	fi
419
420	rm -f ${IMG_UBOOT}
421	for ((i = 0; i < ${ITB_MAX_NUM}; i++));
422	do
423		cat ${ITB} >> ${IMG_UBOOT}
424		truncate -s %${ITB_MAX_KB}K ${IMG_UBOOT}
425	done
426}
427
428function fit_gen_boot_img()
429{
430	ITB=$1
431
432	if [ -z ${ITB} ]; then
433		ITB=${ITB_BOOT}
434	fi
435
436	if [ "${ITB}" != "${IMG_BOOT}" ]; then
437		cp ${ITB} ${IMG_BOOT} -f
438	fi
439}
440
441function fit_msg_uboot()
442{
443	if [ "${ARG_SIGN}" != "y" ]; then
444		MSG_SIGN="no-signed"
445	else
446		MSG_SIGN="signed"
447	fi
448
449	VERSION=`fdtget -ti ${ITB_UBOOT} / version`
450	if [ "${VERSION}" != "" ]; then
451		MSG_VER=", version=${VERSION}"
452	fi
453
454	if [ "${ARG_BURN_KEY_HASH}" == "y" ]; then
455		echo "uboot.img: burn-key-hash=1"
456		echo
457	fi
458
459	if [ "${ARG_SPL_ROLLBACK_PROTECT}" == "y" ]; then
460		echo "Image(${MSG_SIGN}${MSG_VER}, rollback-index=${ARG_ROLLBACK_IDX_UBOOT}):  ${IMG_UBOOT} (with uboot, trust...) is ready"
461	else
462		echo "Image(${MSG_SIGN}${MSG_VER}):  ${IMG_UBOOT} (FIT with uboot, trust...) is ready"
463	fi
464}
465
466function fit_msg_boot()
467{
468	if [ "${ARG_SIGN}" != "y" ]; then
469		MSG_SIGN="no-signed"
470	else
471		MSG_SIGN="signed"
472	fi
473
474	VERSION=`fdtget -ti ${ITB_BOOT} / version`
475	if [ "${VERSION}" != "" ]; then
476		MSG_VER=", version=${VERSION}"
477	fi
478
479	if [ "${ARG_ROLLBACK_PROTECT}" == "y" ]; then
480		echo "Image(${MSG_SIGN}${MSG_VER}, rollback-index=${ARG_ROLLBACK_IDX_BOOT}):  ${IMG_BOOT} is ready"
481	else
482		echo "Image(${MSG_SIGN}${MSG_VER}):  ${IMG_BOOT} (FIT with kernel, fdt, resource...) is ready"
483	fi
484}
485
486function fit_msg_loader()
487{
488	LOADER=`ls *loader*.bin`
489	echo "Image(no-signed):  ${LOADER} (with spl, ddr, usbplug) is ready"
490}
491
492function fit_generate_uboot()
493{
494	fit_raw_compile
495	fit_gen_uboot_itb
496	fit_gen_uboot_img
497	echo
498	fit_msg_uboot
499}
500
501function fit_generate_uboot_boot()
502{
503	fit_raw_compile
504	fit_gen_boot_itb
505	fit_gen_boot_img
506	fit_gen_uboot_itb
507	fit_gen_uboot_img
508	echo
509
510	fit_msg_uboot
511	fit_msg_boot
512	fit_msg_loader
513	echo
514}
515
516fit_process_args $*
517if [ ! -z "${ARG_VALIDATE}" ]; then
518	validate_arg ${ARG_VALIDATE}
519elif [ ! -z "${ARG_BOOT_IMG}" -o ! -z "${ARG_BOOT_IMG_DIR}" ]; then
520	fit_generate_uboot_boot
521else
522	fit_generate_uboot
523fi
524
525