3 # Copyright (C) 2015 Frank Rowand
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; version 2 of the License.
12 # use spaces instead of tabs in the usage message
20 `basename $0` DTx_1 DTx_2
24 -f print full dts in diff (--unified=99999)
26 -help synonym for --help
27 --help print this message and exit
28 -s SRCTREE linux kernel source tree is at path SRCTREE
29 (default is current directory)
30 -S linux kernel source tree is at root of current git repo
31 -u unsorted, do not sort DTx
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).
39 If two DTx are provided, the resulting dts source files are diffed.
41 If DTx is a directory, it is treated as a DT subtree, such as
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).
47 Otherwise DTx is treated as a dts source file (aka .dts).
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.
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.
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. The following
60 workaround can be used:
62 `basename $0` ARCH=arch_of_dtx_1 DTx_1 >tmp_dtx_1.dts
63 `basename $0` ARCH=arch_of_dtx_2 DTx_2 >tmp_dtx_2.dts
64 `basename $0` tmp_dtx_1.dts tmp_dtx_2.dts
65 rm tmp_dtx_1.dts tmp_dtx_2.dts
67 If DTx_1 and DTx_2 are in different directories, then this script will
68 add the path of DTx_1 and DTx_2 to the include paths. If DTx_2 includes
69 a local file that exists in both the path of DTx_1 and DTx_2 then the
70 file in the path of DTx_1 will incorrectly be included. Possible
73 `basename $0` DTx_1 >tmp_dtx_1.dts
74 `basename $0` DTx_2 >tmp_dtx_2.dts
75 `basename $0` tmp_dtx_1.dts tmp_dtx_2.dts
76 rm tmp_dtx_1.dts tmp_dtx_2.dts
87 if [ -d "${dtx}" ] ; then
89 # ----- input is file tree
91 if ( ! ${DTC} -I fs ${dtx} ) ; then
95 elif [ -f "${dtx}" ] && [ -r "${dtx}" ] ; then
97 magic=`hexdump -n 4 -e '/1 "%02x"' ${dtx}`
98 if [ "${magic}" = "d00dfeed" ] ; then
100 # ----- input is FDT (binary blob)
102 if ( ! ${DTC} -I dtb ${dtx} ) ; then
110 # ----- input is DTS (source)
112 if ( cpp ${cpp_flags} -x assembler-with-cpp ${dtx} \
113 | ${DTC} ${dtc_include} -I dts ) ; then
118 echo "Possible hints to resolve the above error:" >&2
119 echo " (hints might not fix the problem)" >&2
123 if [ "${ARCH}" = "" ] ; then
126 echo " shell variable \$ARCH not set" >&2
129 dtx_arch=`echo "/${dtx}" | sed -e 's|.*/arch/||' -e 's|/.*||'`
131 if [ "${dtx_arch}" != "" -a "${dtx_arch}" != "${ARCH}" ] ; then
134 echo " architecture ${dtx_arch} is in file path," >&2
135 echo " but does not match shell variable \$ARCH" >&2
136 echo " >>\$ARCH<< is: >>${ARCH}<<" >&2
139 if [ ! -d ${srctree}/arch/${ARCH} ] ; then
142 echo " ${srctree}/arch/${ARCH}/ does not exist" >&2
143 echo " Is \$ARCH='${ARCH}' correct?" >&2
144 echo " Possible fix: use '-s' option" >&2
146 git_root=`git rev-parse --show-toplevel 2>/dev/null`
147 if [ -d ${git_root}/arch/ ] ; then
148 echo " Possible fix: use '-S' option" >&2
152 if [ $hint_given = 0 ] ; then
154 echo " No hints available." >&2
163 echo "ERROR: ${dtx} does not exist or is not readable" >&2
171 # ----- start of script
182 while [ $# -gt 0 ] ; do
187 diff_flags="--unified=999999"
191 -h | -help | --help )
202 git_root=`git rev-parse --show-toplevel 2>/dev/null`
203 srctree="${git_root}"
213 if [ "${dtx_file_1}" = "" ] ; then
215 elif [ "${dtx_file_2}" = "" ] ; then
219 echo "ERROR: Unexpected parameter: $1" >&2
230 if [ "${srctree}" = "" ] ; then
234 if [ "${dtx_file_2}" != "" ]; then
238 if (( ${help} )) ; then
243 # this must follow check for ${help}
244 if [ "${dtx_file_1}" = "" ]; then
246 echo "ERROR: parameter DTx required" >&2
252 # ----- prefer dtc from linux kernel, allow fallback to dtc in $PATH
254 if [ "${KBUILD_OUTPUT:0:2}" = ".." ] ; then
255 __KBUILD_OUTPUT="${srctree}/${KBUILD_OUTPUT}"
256 elif [ "${KBUILD_OUTPUT}" = "" ] ; then
259 __KBUILD_OUTPUT="${KBUILD_OUTPUT}"
262 DTC="${__KBUILD_OUTPUT}/scripts/dtc/dtc"
264 if [ ! -x ${DTC} ] ; then
266 if grep -q "^CONFIG_DTC=y" ${__KBUILD_OUTPUT}/.config 2>/dev/null; then
271 Enable CONFIG_DTC in the kernel configuration
274 if ( ! which ${__DTC} >/dev/null ) ; then
276 # use spaces instead of tabs in the error message
279 ERROR: unable to find a 'dtc' program
281 Preferred 'dtc' (built from Linux kernel source tree) was not found or
286 If it does not exist, create it from the root of the Linux source tree:
289 If not at the root of the Linux kernel source tree -s SRCTREE or -S
290 may need to be specified to find 'dtc'.
292 If 'O=\${dir}' is specified in your Linux builds, this script requires
293 'export KBUILD_OUTPUT=\${dir}' or add \${dir}/scripts/dtc to \$PATH
296 If \${KBUILD_OUTPUT} is a relative path, then '-s SRCDIR', -S, or run
297 this script from the root of the Linux kernel source tree is required.
299 Fallback '${__DTC}' was also not in \${PATH} or is not executable.
308 # ----- cpp and dtc flags same as for linux source tree build of .dtb files,
309 # plus directories of the dtx file(s)
311 dtx_path_1_dtc_include="-i `dirname ${dtx_file_1}`"
313 dtx_path_2_dtc_include=""
314 if (( ${cmd_diff} )) ; then
315 dtx_path_2_dtc_include="-i `dirname ${dtx_file_2}`"
320 -I${srctree}/scripts/dtc/include-prefixes \
325 -i ${srctree}/scripts/dtc/include-prefixes \
326 -O dts -qq -f ${dtc_sort} -o -"
329 # ----- do the diff or decompile
331 if (( ${cmd_diff} )) ; then
333 diff ${diff_flags} --label "${dtx_file_1}" --label "${dtx_file_2}" \
334 <(compile_to_dts "${dtx_file_1}" "${dtx_path_1_dtc_include}") \
335 <(compile_to_dts "${dtx_file_2}" "${dtx_path_2_dtc_include}")
339 compile_to_dts "${dtx_file_1}" "${dtx_path_1_dtc_include}"