[linux-2.6-block.git] / scripts / dtc / dtx_diff

#! /bin/bash
# SPDX-License-Identifier: GPL-2.0-only

# Copyright (C) 2015 Frank Rowand
#


usage() {

	# use spaces instead of tabs in the usage message
	cat >&2 <<eod

Usage:

   `basename $0` DTx
        decompile DTx

   `basename $0` DTx_1 DTx_2
        diff DTx_1 and DTx_2


      --annotate    synonym for -T
       -f           print full dts in diff (--unified=99999)
       -h           synonym for --help
       -help        synonym for --help
      --help        print this message and exit
       -s SRCTREE   linux kernel source tree is at path SRCTREE
                        (default is current directory)
       -S           linux kernel source tree is at root of current git repo
       -T           Annotate output .dts with input source file and line (-T -T for more details)
       -u           unsorted, do not sort DTx


Each DTx is processed by the dtc compiler to produce a sorted dts source
file.  If DTx is a dts source file then it is pre-processed in the same
manner as done for the compile of the dts source file in the Linux kernel
build system ('#include' and '/include/' directives are processed).

If two DTx are provided, the resulting dts source files are diffed.

If DTx is a directory, it is treated as a DT subtree, such as
  /proc/device-tree.

If DTx contains the binary blob magic value in the first four bytes,
  it is treated as a binary blob (aka .dtb or FDT).

Otherwise DTx is treated as a dts source file (aka .dts).

   If this script is not run from the root of the linux source tree,
   and DTx utilizes '#include' or '/include/' then the path of the
   linux source tree can be provided by '-s SRCTREE' or '-S' so that
   include paths will be set properly.

   The shell variable \${ARCH} must provide the architecture containing
   the dts source file for include paths to be set properly for '#include'
   or '/include/' to be processed.

   If DTx_1 and DTx_2 are in different architectures, then this script
   may not work since \${ARCH} is part of the include path.  Two possible
   workarounds:

      `basename $0` \\
          <(ARCH=arch_of_dtx_1 `basename $0` DTx_1) \\
          <(ARCH=arch_of_dtx_2 `basename $0` DTx_2)

      `basename $0` ARCH=arch_of_dtx_1 DTx_1 >tmp_dtx_1.dts
      `basename $0` ARCH=arch_of_dtx_2 DTx_2 >tmp_dtx_2.dts
      `basename $0` tmp_dtx_1.dts tmp_dtx_2.dts
      rm tmp_dtx_1.dts tmp_dtx_2.dts

   If DTx_1 and DTx_2 are in different directories, then this script will
   add the path of DTx_1 and DTx_2 to the include paths.  If DTx_2 includes
   a local file that exists in both the path of DTx_1 and DTx_2 then the
   file in the path of DTx_1 will incorrectly be included.  Possible
   workaround:

      `basename $0` DTx_1 >tmp_dtx_1.dts
      `basename $0` DTx_2 >tmp_dtx_2.dts
      `basename $0` tmp_dtx_1.dts tmp_dtx_2.dts
      rm tmp_dtx_1.dts tmp_dtx_2.dts

eod
}


compile_to_dts() {

	dtx="$1"
	dtc_include="$2"

	if [ -d "${dtx}" ] ; then

		# -----  input is file tree

		if ( ! ${DTC} -I fs ${dtx} ) ; then
			exit 3
		fi

	elif [ -f "${dtx}" ] && [ -r "${dtx}" ] ; then

		magic=`hexdump -n 4 -e '/1 "%02x"' ${dtx}`
		if [ "${magic}" = "d00dfeed" ] ; then

			# -----  input is FDT (binary blob)

			if ( ! ${DTC} -I dtb ${dtx} ) ; then
				exit 3
			fi

			return

		fi

		# -----  input is DTS (source)

		if ( cpp ${cpp_flags} -x assembler-with-cpp ${dtx} \
			| ${DTC} ${dtc_include} -I dts ) ; then
			return
		fi

		echo ""                                                      >&2
		echo "Possible hints to resolve the above error:"            >&2
		echo "  (hints might not fix the problem)"                   >&2

		hint_given=0

		if [ "${ARCH}" = "" ] ; then
			hint_given=1
			echo ""                                              >&2
			echo "  shell variable \$ARCH not set"               >&2
		fi

		dtx_arch=`echo "/${dtx}" | sed -e 's|.*/arch/||' -e 's|/.*||'`

		if [ "${dtx_arch}" != ""  -a "${dtx_arch}" != "${ARCH}" ] ; then
			hint_given=1
			echo ""                                              >&2
			echo "  architecture ${dtx_arch} is in file path,"   >&2
			echo "  but does not match shell variable \$ARCH"    >&2
			echo "  >>\$ARCH<< is: >>${ARCH}<<"                  >&2
		fi

		if [ ! -d ${srctree}/arch/${ARCH} ] ; then
			hint_given=1
			echo ""                                              >&2
			echo "  ${srctree}/arch/${ARCH}/ does not exist"     >&2
			echo "  Is \$ARCH='${ARCH}' correct?"                >&2
			echo "  Possible fix: use '-s' option"               >&2

			git_root=`git rev-parse --show-toplevel 2>/dev/null`
			if [ -d ${git_root}/arch/ ] ; then
				echo "  Possible fix: use '-S' option"       >&2
			fi
		fi

		if [ $hint_given = 0 ] ; then
			echo ""                                              >&2
			echo "  No hints available."                         >&2
		fi

		echo ""                                                      >&2

		exit 3

	else
		echo ""                                                     >&2
		echo "ERROR: ${dtx} does not exist or is not readable"      >&2
		echo ""                                                     >&2
		exit 2
	fi

}


# -----  start of script

annotate=""
cmd_diff=0
diff_flags="-u"
dtx_file_1=""
dtx_file_2=""
dtc_sort="-s"
help=0
srctree=""


while [ $# -gt 0 ] ; do

	case $1 in

	-f )
		diff_flags="--unified=999999"
		shift
		;;

	-h | -help | --help )
		help=1
		shift
		;;

	-s )
		srctree="$2"
		shift 2
		;;

	-S )
		git_root=`git rev-parse --show-toplevel 2>/dev/null`
		srctree="${git_root}"
		shift
		;;

	-T | --annotate )
		if [ "${annotate}"  = "" ] ; then
			annotate="-T"
		elif [ "${annotate}"  = "-T" ] ; then
			annotate="-T -T"
		fi
		shift
		;;
	-u )
		dtc_sort=""
		shift
		;;

	*)
		if [ "${dtx_file_1}"  = "" ] ; then
			dtx_file_1="$1"
		elif [ "${dtx_file_2}" = "" ] ; then
			dtx_file_2="$1"
		else
			echo ""                                             >&2
			echo "ERROR: Unexpected parameter: $1"              >&2
			echo ""                                             >&2
			exit 2
		fi
		shift
		;;

	esac

done

if [ "${srctree}" = "" ] ; then
	srctree="."
fi

if [ "${dtx_file_2}" != "" ]; then
	cmd_diff=1
fi

if (( ${help} )) ; then
	usage
	exit 1
fi

# this must follow check for ${help}
if [ "${dtx_file_1}" = "" ]; then
	echo ""                                                             >&2
	echo "ERROR: parameter DTx required"                                >&2
	echo ""                                                             >&2
	exit 2
fi


# -----  prefer dtc from linux kernel, allow fallback to dtc in $PATH

if [ "${KBUILD_OUTPUT:0:2}" = ".." ] ; then
	__KBUILD_OUTPUT="${srctree}/${KBUILD_OUTPUT}"
elif [ "${KBUILD_OUTPUT}" = "" ] ; then
	__KBUILD_OUTPUT="."
else
	__KBUILD_OUTPUT="${KBUILD_OUTPUT}"
fi

DTC="${__KBUILD_OUTPUT}/scripts/dtc/dtc"

if [ ! -x ${DTC} ] ; then
	__DTC="dtc"
	if grep -q "^CONFIG_DTC=y" ${__KBUILD_OUTPUT}/.config 2>/dev/null; then
		make_command='
         make scripts'
	else
		make_command='
         Enable CONFIG_DTC in the kernel configuration
         make scripts'
	fi
	if ( ! which ${__DTC} >/dev/null ) ; then

		# use spaces instead of tabs in the error message
		cat >&2 <<eod

ERROR: unable to find a 'dtc' program

   Preferred 'dtc' (built from Linux kernel source tree) was not found or
   is not executable.

      'dtc' is: ${DTC}

      If it does not exist, create it from the root of the Linux source tree:
${make_command}

      If not at the root of the Linux kernel source tree -s SRCTREE or -S
      may need to be specified to find 'dtc'.

      If 'O=\${dir}' is specified in your Linux builds, this script requires
      'export KBUILD_OUTPUT=\${dir}' or add \${dir}/scripts/dtc to \$PATH
      before running.

      If \${KBUILD_OUTPUT} is a relative path, then '-s SRCDIR', -S, or run
      this script from the root of the Linux kernel source tree is required.

   Fallback '${__DTC}' was also not in \${PATH} or is not executable.

eod
		exit 2
	fi
	DTC=${__DTC}
fi


# -----  cpp and dtc flags same as for linux source tree build of .dtb files,
#        plus directories of the dtx file(s)

dtx_path_1_dtc_include="-i `dirname ${dtx_file_1}`"

dtx_path_2_dtc_include=""
if (( ${cmd_diff} )) ; then
	dtx_path_2_dtc_include="-i `dirname ${dtx_file_2}`"
fi

cpp_flags="\
	-nostdinc                                  \
	-I${srctree}/scripts/dtc/include-prefixes  \
	-undef -D__DTS__"

DTC="\
	${DTC}                                     \
	-i ${srctree}/scripts/dtc/include-prefixes \
	-O dts -qq -f ${dtc_sort} ${annotate} -o -"


# -----  do the diff or decompile

if (( ${cmd_diff} )) ; then

	diff ${diff_flags} --label "${dtx_file_1}" --label "${dtx_file_2}" \
		<(compile_to_dts "${dtx_file_1}" "${dtx_path_1_dtc_include}") \
		<(compile_to_dts "${dtx_file_2}" "${dtx_path_2_dtc_include}")

else

	compile_to_dts "${dtx_file_1}" "${dtx_path_1_dtc_include}"

fi
Commit	Line	Data
10eadc25	1	#! /bin/bash
b886d83c	2	# SPDX-License-Identifier: GPL-2.0-only
10eadc25 FR	3
	4	# Copyright (C) 2015 Frank Rowand
	5	#
10eadc25 FR	6
	7
	8	usage() {
	9
	10	# use spaces instead of tabs in the usage message
	11	cat >&2 <<eod
	12
	13	Usage:
	14
	15	`basename $0` DTx
	16	decompile DTx
	17
	18	`basename $0` DTx_1 DTx_2
	19	diff DTx_1 and DTx_2
	20
	21
87143fce	22	--annotate synonym for -T
10eadc25 FR	23	-f print full dts in diff (--unified=99999)
	24	-h synonym for --help
	25	-help synonym for --help
	26	--help print this message and exit
	27	-s SRCTREE linux kernel source tree is at path SRCTREE
	28	(default is current directory)
	29	-S linux kernel source tree is at root of current git repo
87143fce	30	-T Annotate output .dts with input source file and line (-T -T for more details)
10eadc25 FR	31	-u unsorted, do not sort DTx
	32
	33
	34	Each DTx is processed by the dtc compiler to produce a sorted dts source
	35	file. If DTx is a dts source file then it is pre-processed in the same
	36	manner as done for the compile of the dts source file in the Linux kernel
	37	build system ('#include' and '/include/' directives are processed).
	38
	39	If two DTx are provided, the resulting dts source files are diffed.
	40
	41	If DTx is a directory, it is treated as a DT subtree, such as
	42	/proc/device-tree.
	43
	44	If DTx contains the binary blob magic value in the first four bytes,
	45	it is treated as a binary blob (aka .dtb or FDT).
	46
	47	Otherwise DTx is treated as a dts source file (aka .dts).
	48
	49	If this script is not run from the root of the linux source tree,
	50	and DTx utilizes '#include' or '/include/' then the path of the
	51	linux source tree can be provided by '-s SRCTREE' or '-S' so that
	52	include paths will be set properly.
	53
	54	The shell variable \${ARCH} must provide the architecture containing
	55	the dts source file for include paths to be set properly for '#include'
	56	or '/include/' to be processed.
	57
	58	If DTx_1 and DTx_2 are in different architectures, then this script
	59	may not work since \${ARCH} is part of the include path. Two possible
	60	workarounds:
	61
	62	`basename $0` \\
	63	<(ARCH=arch_of_dtx_1 `basename $0` DTx_1) \\
	64	<(ARCH=arch_of_dtx_2 `basename $0` DTx_2)
	65
	66	`basename $0` ARCH=arch_of_dtx_1 DTx_1 >tmp_dtx_1.dts
	67	`basename $0` ARCH=arch_of_dtx_2 DTx_2 >tmp_dtx_2.dts
	68	`basename $0` tmp_dtx_1.dts tmp_dtx_2.dts
	69	rm tmp_dtx_1.dts tmp_dtx_2.dts
	70
	71	If DTx_1 and DTx_2 are in different directories, then this script will
	72	add the path of DTx_1 and DTx_2 to the include paths. If DTx_2 includes
	73	a local file that exists in both the path of DTx_1 and DTx_2 then the
	74	file in the path of DTx_1 will incorrectly be included. Possible
	75	workaround:
	76
	77	`basename $0` DTx_1 >tmp_dtx_1.dts
	78	`basename $0` DTx_2 >tmp_dtx_2.dts
	79	`basename $0` tmp_dtx_1.dts tmp_dtx_2.dts
	80	rm tmp_dtx_1.dts tmp_dtx_2.dts
	81
	82	eod
	83	}
	84
	85
	86	compile_to_dts() {
	87
	88	dtx="$1"
35f3c984	89	dtc_include="$2"
10eadc25 FR	90
	91	if [ -d "${dtx}" ] ; then
	92
	93	# ----- input is file tree
	94
	95	if ( ! ${DTC} -I fs ${dtx} ) ; then
	96	exit 3
	97	fi
	98
	99	elif [ -f "${dtx}" ] && [ -r "${dtx}" ] ; then
	100
	101	magic=`hexdump -n 4 -e '/1 "%02x"' ${dtx}`
	102	if [ "${magic}" = "d00dfeed" ] ; then
	103
	104	# ----- input is FDT (binary blob)
	105
	106	if ( ! ${DTC} -I dtb ${dtx} ) ; then
	107	exit 3
	108	fi
	109
	110	return
	111
	112	fi
	113
	114	# ----- input is DTS (source)
	115
	116	if ( cpp ${cpp_flags} -x assembler-with-cpp ${dtx} \
35f3c984	117	\| ${DTC} ${dtc_include} -I dts ) ; then
10eadc25 FR	118	return
	119	fi
	120
	121	echo "" >&2
	122	echo "Possible hints to resolve the above error:" >&2
	123	echo " (hints might not fix the problem)" >&2
	124
	125	hint_given=0
	126
	127	if [ "${ARCH}" = "" ] ; then
	128	hint_given=1
	129	echo "" >&2
	130	echo " shell variable \$ARCH not set" >&2
	131	fi
	132
	133	dtx_arch=`echo "/${dtx}" \| sed -e 's\|./arch/\|\|' -e 's\|/.\|\|'`
	134
	135	if [ "${dtx_arch}" != "" -a "${dtx_arch}" != "${ARCH}" ] ; then
	136	hint_given=1
	137	echo "" >&2
	138	echo " architecture ${dtx_arch} is in file path," >&2
	139	echo " but does not match shell variable \$ARCH" >&2
60c7f4cb	140	echo " >>\$ARCH<< is: >>${ARCH}<<" >&2
10eadc25 FR	141	fi
	142
	143	if [ ! -d ${srctree}/arch/${ARCH} ] ; then
	144	hint_given=1
	145	echo "" >&2
	146	echo " ${srctree}/arch/${ARCH}/ does not exist" >&2
	147	echo " Is \$ARCH='${ARCH}' correct?" >&2
	148	echo " Possible fix: use '-s' option" >&2
	149
	150	git_root=`git rev-parse --show-toplevel 2>/dev/null`
	151	if [ -d ${git_root}/arch/ ] ; then
	152	echo " Possible fix: use '-S' option" >&2
	153	fi
	154	fi
	155
	156	if [ $hint_given = 0 ] ; then
	157	echo "" >&2
	158	echo " No hints available." >&2
	159	fi
	160
	161	echo "" >&2
	162
	163	exit 3
	164
	165	else
	166	echo "" >&2
	167	echo "ERROR: ${dtx} does not exist or is not readable" >&2
	168	echo "" >&2
	169	exit 2
	170	fi
	171
	172	}
	173
	174
	175	# ----- start of script
	176
87143fce	177	annotate=""
10eadc25 FR	178	cmd_diff=0
	179	diff_flags="-u"
	180	dtx_file_1=""
	181	dtx_file_2=""
	182	dtc_sort="-s"
	183	help=0
	184	srctree=""
	185
	186
	187	while [ $# -gt 0 ] ; do
	188
	189	case $1 in
	190
	191	-f )
	192	diff_flags="--unified=999999"
	193	shift
	194	;;
	195
	196	-h \| -help \| --help )
	197	help=1
	198	shift
	199	;;
	200
	201	-s )
	202	srctree="$2"
	203	shift 2
	204	;;
	205
	206	-S )
	207	git_root=`git rev-parse --show-toplevel 2>/dev/null`
	208	srctree="${git_root}"
	209	shift
	210	;;
	211
87143fce FR	212	-T \| --annotate )
	213	if [ "${annotate}" = "" ] ; then
	214	annotate="-T"
	215	elif [ "${annotate}" = "-T" ] ; then
	216	annotate="-T -T"
	217	fi
	218	shift
	219	;;
10eadc25 FR	220	-u )
	221	dtc_sort=""
	222	shift
	223	;;
	224
	225	*)
	226	if [ "${dtx_file_1}" = "" ] ; then
	227	dtx_file_1="$1"
	228	elif [ "${dtx_file_2}" = "" ] ; then
	229	dtx_file_2="$1"
	230	else
	231	echo "" >&2
	232	echo "ERROR: Unexpected parameter: $1" >&2
	233	echo "" >&2
	234	exit 2
	235	fi
	236	shift
	237	;;
	238
	239	esac
	240
	241	done
	242
	243	if [ "${srctree}" = "" ] ; then
	244	srctree="."
	245	fi
	246
	247	if [ "${dtx_file_2}" != "" ]; then
	248	cmd_diff=1
	249	fi
	250
	251	if (( ${help} )) ; then
	252	usage
	253	exit 1
	254	fi
	255
	256	# this must follow check for ${help}
	257	if [ "${dtx_file_1}" = "" ]; then
	258	echo "" >&2
	259	echo "ERROR: parameter DTx required" >&2
	260	echo "" >&2
	261	exit 2
	262	fi
	263
	264
	265	# ----- prefer dtc from linux kernel, allow fallback to dtc in $PATH
	266
	267	if [ "${KBUILD_OUTPUT:0:2}" = ".." ] ; then
	268	__KBUILD_OUTPUT="${srctree}/${KBUILD_OUTPUT}"
	269	elif [ "${KBUILD_OUTPUT}" = "" ] ; then
	270	__KBUILD_OUTPUT="."
	271	else
	272	__KBUILD_OUTPUT="${KBUILD_OUTPUT}"
	273	fi
	274
	275	DTC="${__KBUILD_OUTPUT}/scripts/dtc/dtc"
	276
	277	if [ ! -x ${DTC} ] ; then
	278	__DTC="dtc"
ca0cd118	279	if grep -q "^CONFIG_DTC=y" ${__KBUILD_OUTPUT}/.config 2>/dev/null; then
60c7f4cb FR	280	make_command='
	281	make scripts'
	282	else
	283	make_command='
	284	Enable CONFIG_DTC in the kernel configuration
	285	make scripts'
	286	fi
10eadc25 FR	287	if ( ! which ${__DTC} >/dev/null ) ; then
	288
	289	# use spaces instead of tabs in the error message
	290	cat >&2 <<eod
	291
	292	ERROR: unable to find a 'dtc' program
	293
	294	Preferred 'dtc' (built from Linux kernel source tree) was not found or
	295	is not executable.
	296
	297	'dtc' is: ${DTC}
	298
	299	If it does not exist, create it from the root of the Linux source tree:
60c7f4cb	300	${make_command}
10eadc25 FR	301
	302	If not at the root of the Linux kernel source tree -s SRCTREE or -S
	303	may need to be specified to find 'dtc'.
	304
	305	If 'O=\${dir}' is specified in your Linux builds, this script requires
	306	'export KBUILD_OUTPUT=\${dir}' or add \${dir}/scripts/dtc to \$PATH
	307	before running.
	308
	309	If \${KBUILD_OUTPUT} is a relative path, then '-s SRCDIR', -S, or run
	310	this script from the root of the Linux kernel source tree is required.
	311
	312	Fallback '${__DTC}' was also not in \${PATH} or is not executable.
	313
	314	eod
	315	exit 2
	316	fi
	317	DTC=${__DTC}
	318	fi
	319
	320
	321	# ----- cpp and dtc flags same as for linux source tree build of .dtb files,
	322	# plus directories of the dtx file(s)
	323
	324	dtx_path_1_dtc_include="-i `dirname ${dtx_file_1}`"
	325
	326	dtx_path_2_dtc_include=""
	327	if (( ${cmd_diff} )) ; then
	328	dtx_path_2_dtc_include="-i `dirname ${dtx_file_2}`"
	329	fi
	330
	331	cpp_flags="\
	332	-nostdinc \
b4b201d8	333	-I${srctree}/scripts/dtc/include-prefixes \
10eadc25 FR	334	-undef -D__DTS__"
10eadc25 FR	335
35f3c984 FR	336	DTC="\
	337	${DTC} \
	338	-i ${srctree}/scripts/dtc/include-prefixes \
87143fce	339	-O dts -qq -f ${dtc_sort} ${annotate} -o -"
10eadc25 FR	340
	341
	342	# ----- do the diff or decompile
	343
	344	if (( ${cmd_diff} )) ; then
	345
7782b144	346	diff ${diff_flags} --label "${dtx_file_1}" --label "${dtx_file_2}" \
35f3c984 FR	347	<(compile_to_dts "${dtx_file_1}" "${dtx_path_1_dtc_include}") \
35f3c984 FR	348	<(compile_to_dts "${dtx_file_2}" "${dtx_path_2_dtc_include}")
10eadc25 FR	349
	350	else
	351
35f3c984	352	compile_to_dts "${dtx_file_1}" "${dtx_path_1_dtc_include}"
10eadc25 FR	353
10eadc25 FR	354	fi