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