xref: /rkbin/scripts/checkpatch.sh (revision 6f2bc86d6ba789c0e02549b797208093a1f01473)
1#!/bin/bash
2set -e
3
4DIFF_SUBSET="scripts/.diff_*"
5DIFF_DOC_ALL="scripts/.diff_all.txt"
6DIFF_DOC_FIXED="scripts/.diff_fixed.txt"
7
8function check_doc()
9{
10	local TOP_SEVERITY LANGUAGE=$1
11
12	if [ "${LANGUAGE}" == "EN" ] ; then
13		SVT_CRITIAL="critical"
14		SVT_IMPORTANT="important"
15		SVT_MODERATE="moderate"
16		DOC=`git log -1 --name-only | sed -n "/_EN\.md/p"`
17	else
18		SVT_CRITIAL="紧急"
19		SVT_IMPORTANT="重要"
20		SVT_MODERATE="普通"
21		DOC=`git log -1 --name-only | sed -n "/_CN\.md/p"`
22	fi
23
24	echo "Checking doc: ${DOC}"
25
26	# check DOS encoding
27	git show -1 ${DOC} | sed -n "/^+/p" > ${DIFF_DOC_ALL}
28	git show -1 ${DOC} | sed -n "/^+/p" > ${DIFF_DOC_ALL}.dos
29	dos2unix ${DIFF_DOC_ALL}.dos >/dev/null 2>&1
30	CSUM1=`md5sum ${DIFF_DOC_ALL} | awk '{ print $1 }'`
31	CSUM2=`md5sum ${DIFF_DOC_ALL}.dos | awk '{ print $1 }'`
32	if [ "${CSUM1}" != "${CSUM2}" ]; then
33		echo "ERROR: ${DOC} is DOS encoding. Fix it by: 'dos2unix ${DOC}'"
34		exit 1
35	fi
36
37	TITLE=`sed -n "/^+## /p" ${DIFF_DOC_ALL} | tr -d " +#"`
38	FILE=`sed -n "/^+| 20[0-9][0-9]-/p" ${DIFF_DOC_ALL} | tr -d " " | awk -F "|" '{ print $3 }'`
39	COMMIT=`sed -n "/^+| 20[0-9][0-9]-/p" ${DIFF_DOC_ALL} | tr -d " " | awk -F "|" '{ print $4 }'`
40	SEVERITY=`sed -n "/^+| 20[0-9][0-9]-/p" ${DIFF_DOC_ALL} | tr -d " " | awk -F "|" '{ print $5 }'`
41	HORIZONTAL_LINE=`sed -n "/^+------$/p" ${DIFF_DOC_ALL}`
42	# echo "### ${COMMIT}, ${SEVERITY}, ${TITLE}, ${FILE}"
43
44	# check standalone file
45	if ! echo ${FILE} | grep -q { ; then
46		if ! git log -1 --name-only | grep -q ${FILE}; then
47			echo "ERROR: ${DOC}: '${FILE}' is not update in this patch"
48			exit 1
49		fi
50	fi
51
52	# check title
53	if [ "${TITLE}" != "${FILE}" ]; then
54		echo "ERROR: ${DOC}: Title '${TITLE}' is not match with '${FILE}'"
55		exit 1
56	fi
57
58	# check commit
59	COMMIT=${COMMIT//#/ }
60	for LIST in ${COMMIT}; do
61		CMT=`echo ${LIST} | cut -d : -f 2`
62		if ! git log -1 | grep -q ${CMT} ; then
63			echo "ERROR: ${DOC}: '${CMT}' is not match in commit message"
64			exit 1
65		fi
66
67		if ! echo ${FILE} | grep -q { ; then
68			if echo ${FILE} | grep -Eq 'spl_|tpl_|bl31_|bl32_|tee_' ; then
69				FILE_PATH=`find -name ${FILE}`
70				if ! strings ${FILE_PATH} | grep -q ${CMT} ; then
71					echo "ERROR: ${DOC}: ${FILE} is not build from '${CMT}'"
72					exit 1
73				fi
74			fi
75		fi
76	done
77
78	# check severity
79	if [ "${SEVERITY}" != "${SVT_CRITIAL}" -a "${SEVERITY}" != "${SVT_IMPORTANT}" -a "${SEVERITY}" != "${SVT_MODERATE}" ]; then
80		echo "ERROR: ${DOC}: Unknown main severity: ${SEVERITY}"
81		exit 1
82	fi
83
84	# check horizontal line
85	if [ -z "${HORIZONTAL_LINE}" ]; then
86		echo "ERROR: ${DOC}: No horizontal line '------' at the last"
87		exit 1
88	fi
89
90	# check 'Fixed' content
91	if grep -q "^+### Fixed" ${DIFF_DOC_ALL} ; then
92		awk -v RS='### Fixed' 'END{printf "%s", $0}' ${DIFF_DOC_ALL} > ${DIFF_DOC_FIXED}
93		sed -i "/^$/d"    ${DIFF_DOC_FIXED}
94		sed -i "/Index/d" ${DIFF_DOC_FIXED}
95		sed -i "/---/d"   ${DIFF_DOC_FIXED}
96		sed -i "/^+$/d"   ${DIFF_DOC_FIXED}
97
98		while read LINE
99		do
100			EACH_SEVERITY=`echo "${LINE}" | awk -F "|" '{ print $3 }' | tr -d " "`
101			if [ "${EACH_SEVERITY}" != "${SVT_CRITIAL}" -a "${EACH_SEVERITY}" != "${SVT_IMPORTANT}" -a "${EACH_SEVERITY}" != "${SVT_MODERATE}" ]; then
102				echo "ERROR: ${DOC}: Unknown severity: ${EACH_SEVERITY}"
103				exit 1
104			fi
105
106			# echo "## EACH: $EACH_SEVERITY"
107			if [ -z "${TOP_SEVERITY}" ]; then
108				TOP_SEVERITY="${EACH_SEVERITY}"
109			elif [ "${TOP_SEVERITY}" == "${SVT_MODERATE}" ]; then
110				if [ "${EACH_SEVERITY}" == "${SVT_CRITIAL}" -o "${EACH_SEVERITY}" == "${SVT_IMPORTANT}" ]; then
111						TOP_SEVERITY="${EACH_SEVERITY}"
112				fi
113			elif [ "${TOP_SEVERITY}" == "${SVT_IMPORTANT}" ]; then
114				if [ "${EACH_SEVERITY}" == "${SVT_CRITIAL}" ]; then
115						TOP_SEVERITY="${EACH_SEVERITY}"
116				fi
117			fi
118		done < ${DIFF_DOC_FIXED}
119
120		if [ "${SEVERITY}" != "${TOP_SEVERITY}" ]; then
121			echo "ERROR: ${DOC}: Main severity should be '${TOP_SEVERITY}'"
122			exit 1
123		fi
124	fi
125}
126
127function check_docs()
128{
129	if git log -1 --name-only | grep -Eq '\.bin|\.elf' ; then
130		DOC_CN=`git log -1 --name-only | sed -n "/_CN\.md/p"`
131		DOC_EN=`git log -1 --name-only | sed -n "/_EN\.md/p"`
132		if [ -z "${DOC_CN}" -o -z "${DOC_EN}" ]; then
133			echo "ERROR: Update CN/EN Release-Note when .bin or .elf changes"
134			exit 1
135		fi
136		check_doc CN
137		check_doc EN
138	fi
139
140	rm -f ${DIFF_SUBSET}
141}
142
143function pack_loader_image()
144{
145	for FILE in `ls ./RKBOOT/*MINIALL*.ini`
146	do
147		if [ "${FILE}" = "./RKBOOT/RK302AMINIALL.ini" -o \
148			 "${FILE}" = "./RKBOOT/RK30BMINIALL.ini" -o \
149			 "${FILE}" = "./RKBOOT/RK30MINIALL.ini" -o \
150			 "${FILE}" = "./RKBOOT/RK310BMINIALL.ini" ]; then
151			continue;
152		fi
153
154		if grep -q '^PATH=img/' ${FILE}; then
155			continue;
156		fi
157
158		echo "Pack loader: ${FILE}"
159		./tools/boot_merger ${FILE}
160		rm -f *loader*.bin *download*.bin *idblock*.img
161		echo
162	done
163}
164
165function pack_trust_image()
166{
167	# Pack 32-bit trust
168	for FILE in `ls ./RKTRUST/*TOS*.ini`
169	do
170		if ! test -s ${FILE}; then
171			continue;
172		elif ! grep -q 'TOS' ${FILE}; then
173			continue;
174		elif grep -q '^PATH=img/' ${FILE}; then
175			continue;
176		fi
177
178		echo "Pack trust: ${FILE}"
179		# Parse orignal path
180		TOS=`sed -n "/TOS=/s/TOS=//p" ${FILE}|tr -d '\r'`
181		TOS_TA=`sed -n "/TOSTA=/s/TOSTA=//p" ${FILE}|tr -d '\r'`
182
183		# replace "./tools/rk_tools/" with "./" to compatible legacy ini content of rkdevelop branch
184		TOS=$(echo ${TOS} | sed "s/tools\/rk_tools\//\.\//g")
185		TOS_TA=$(echo ${TOS_TA} | sed "s/tools\/rk_tools\//\.\//g")
186
187		if [ x${TOS_TA} != x -a x${TOS} != x ]; then
188			./tools/loaderimage --pack --trustos ${TOS} ./trust.img 0x68400000
189			./tools/loaderimage --pack --trustos ${TOS_TA} ./trust_with_ta.img 0x68400000
190		elif [ ${TOS} ]; then
191			./tools/loaderimage --pack --trustos ${TOS} ./trust.img 0x68400000
192		elif [ ${TOS_TA} ]; then
193			./tools/loaderimage --pack --trustos ${TOS_TA} ./trust.img 0x68400000
194		else
195			exit 1
196		fi
197		rm -f trust*.img
198		echo
199	done
200
201	# Pack 64-bit trust
202	for FILE in `ls ./RKTRUST/*TRUST*.ini`
203	do
204		if grep -q '^PATH=img/' ${FILE}; then
205			continue;
206		fi
207
208		echo "Pack trust: ${FILE}"
209		./tools/trust_merger ${FILE}
210		rm -f trust*.img
211		echo
212	done
213}
214
215function check_dirty()
216{
217	for FILE in `find -name '*spl*.bin' -o -name '*tpl*.bin' -o -name '*usbplug*.bin' -o -name '*bl31*.elf' -o -name '*bl32*.bin'`; do
218		echo "Checking clean: ${FILE}"
219		if strings ${FILE} | grep '\-dirty ' ; then
220			echo "ERROR: ${FILE} is dirty"
221			exit 1
222		fi
223	done
224}
225
226function check_stripped()
227{
228	for FILE in `find -name '*bl31*.elf'`; do
229		echo "Checking strip: ${FILE}"
230		INFO=`file ${FILE}`
231		if echo ${INFO} | grep -q "not stripped" ; then
232			echo "ERROR: ${FILE} is not stripped"
233			exit 1
234		fi
235	done
236}
237
238function check_mode()
239{
240	echo "Checking file mode..."
241	if git whatchanged -1 --oneline | sed -n '/RKBOOT\//p; /RKTRUST\//p; /bin\//p; /doc\//p;' | awk '{ print $2 }' | grep -q 755 ; then
242		git whatchanged -1 --oneline | sed -n '/RKBOOT\//p; /RKTRUST\//p; /bin\//p; /doc\//p;' | grep 755
243		echo "ERROR: Set 644 permission but not 755."
244		exit 1
245	fi
246}
247
248function finish()
249{
250	echo "OK, everything is nice."
251	echo
252}
253
254check_mode
255check_docs
256check_dirty
257check_stripped
258pack_loader_image
259pack_trust_image
260finish
261