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