test_dtoc.py 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521
  1. # SPDX-License-Identifier: GPL-2.0+
  2. # Copyright (c) 2012 The Chromium OS Authors.
  3. #
  4. """Tests for the dtb_platdata module
  5. This includes unit tests for some functions and functional tests for
  6. """
  7. import collections
  8. import os
  9. import struct
  10. import unittest
  11. import dtb_platdata
  12. from dtb_platdata import conv_name_to_c
  13. from dtb_platdata import get_compat_name
  14. from dtb_platdata import get_value
  15. from dtb_platdata import tab_to
  16. import fdt
  17. import fdt_util
  18. import tools
  19. our_path = os.path.dirname(os.path.realpath(__file__))
  20. HEADER = '''/*
  21. * DO NOT MODIFY
  22. *
  23. * This file was generated by dtoc from a .dtb (device tree binary) file.
  24. */
  25. #include <stdbool.h>
  26. #include <linux/libfdt.h>'''
  27. C_HEADER = '''/*
  28. * DO NOT MODIFY
  29. *
  30. * This file was generated by dtoc from a .dtb (device tree binary) file.
  31. */
  32. #include <common.h>
  33. #include <dm.h>
  34. #include <dt-structs.h>
  35. '''
  36. def get_dtb_file(dts_fname):
  37. """Compile a .dts file to a .dtb
  38. Args:
  39. dts_fname: Filename of .dts file in the current directory
  40. Returns:
  41. Filename of compiled file in output directory
  42. """
  43. return fdt_util.EnsureCompiled(os.path.join(our_path, dts_fname))
  44. class TestDtoc(unittest.TestCase):
  45. """Tests for dtoc"""
  46. @classmethod
  47. def setUpClass(cls):
  48. tools.PrepareOutputDir(None)
  49. @classmethod
  50. def tearDownClass(cls):
  51. tools._RemoveOutputDir()
  52. def test_name(self):
  53. """Test conversion of device tree names to C identifiers"""
  54. self.assertEqual('serial_at_0x12', conv_name_to_c('serial@0x12'))
  55. self.assertEqual('vendor_clock_frequency',
  56. conv_name_to_c('vendor,clock-frequency'))
  57. self.assertEqual('rockchip_rk3399_sdhci_5_1',
  58. conv_name_to_c('rockchip,rk3399-sdhci-5.1'))
  59. def test_tab_to(self):
  60. """Test operation of tab_to() function"""
  61. self.assertEqual('fred ', tab_to(0, 'fred'))
  62. self.assertEqual('fred\t', tab_to(1, 'fred'))
  63. self.assertEqual('fred was here ', tab_to(1, 'fred was here'))
  64. self.assertEqual('fred was here\t\t', tab_to(3, 'fred was here'))
  65. self.assertEqual('exactly8 ', tab_to(1, 'exactly8'))
  66. self.assertEqual('exactly8\t', tab_to(2, 'exactly8'))
  67. def test_get_value(self):
  68. """Test operation of get_value() function"""
  69. self.assertEqual('0x45',
  70. get_value(fdt.TYPE_INT, struct.pack('>I', 0x45)))
  71. self.assertEqual('0x45',
  72. get_value(fdt.TYPE_BYTE, struct.pack('<I', 0x45)))
  73. self.assertEqual('0x0',
  74. get_value(fdt.TYPE_BYTE, struct.pack('>I', 0x45)))
  75. self.assertEqual('"test"', get_value(fdt.TYPE_STRING, 'test'))
  76. self.assertEqual('true', get_value(fdt.TYPE_BOOL, None))
  77. def test_get_compat_name(self):
  78. """Test operation of get_compat_name() function"""
  79. Prop = collections.namedtuple('Prop', ['value'])
  80. Node = collections.namedtuple('Node', ['props'])
  81. prop = Prop(['rockchip,rk3399-sdhci-5.1', 'arasan,sdhci-5.1'])
  82. node = Node({'compatible': prop})
  83. self.assertEqual(('rockchip_rk3399_sdhci_5_1', ['arasan_sdhci_5_1']),
  84. get_compat_name(node))
  85. prop = Prop(['rockchip,rk3399-sdhci-5.1'])
  86. node = Node({'compatible': prop})
  87. self.assertEqual(('rockchip_rk3399_sdhci_5_1', []),
  88. get_compat_name(node))
  89. prop = Prop(['rockchip,rk3399-sdhci-5.1', 'arasan,sdhci-5.1', 'third'])
  90. node = Node({'compatible': prop})
  91. self.assertEqual(('rockchip_rk3399_sdhci_5_1',
  92. ['arasan_sdhci_5_1', 'third']),
  93. get_compat_name(node))
  94. def test_empty_file(self):
  95. """Test output from a device tree file with no nodes"""
  96. dtb_file = get_dtb_file('dtoc_test_empty.dts')
  97. output = tools.GetOutputFilename('output')
  98. dtb_platdata.run_steps(['struct'], dtb_file, False, output)
  99. with open(output) as infile:
  100. lines = infile.read().splitlines()
  101. self.assertEqual(HEADER.splitlines(), lines)
  102. dtb_platdata.run_steps(['platdata'], dtb_file, False, output)
  103. with open(output) as infile:
  104. lines = infile.read().splitlines()
  105. self.assertEqual(C_HEADER.splitlines() + [''], lines)
  106. def test_simple(self):
  107. """Test output from some simple nodes with various types of data"""
  108. dtb_file = get_dtb_file('dtoc_test_simple.dts')
  109. output = tools.GetOutputFilename('output')
  110. dtb_platdata.run_steps(['struct'], dtb_file, False, output)
  111. with open(output) as infile:
  112. data = infile.read()
  113. self.assertEqual(HEADER + '''
  114. struct dtd_sandbox_i2c_test {
  115. };
  116. struct dtd_sandbox_pmic_test {
  117. \tbool\t\tlow_power;
  118. \tfdt64_t\t\treg[2];
  119. };
  120. struct dtd_sandbox_spl_test {
  121. \tbool\t\tboolval;
  122. \tunsigned char\tbytearray[3];
  123. \tunsigned char\tbyteval;
  124. \tfdt32_t\t\tintarray[4];
  125. \tfdt32_t\t\tintval;
  126. \tunsigned char\tlongbytearray[9];
  127. \tconst char *\tstringarray[3];
  128. \tconst char *\tstringval;
  129. };
  130. struct dtd_sandbox_spl_test_2 {
  131. };
  132. ''', data)
  133. dtb_platdata.run_steps(['platdata'], dtb_file, False, output)
  134. with open(output) as infile:
  135. data = infile.read()
  136. self.assertEqual(C_HEADER + '''
  137. static struct dtd_sandbox_spl_test dtv_spl_test = {
  138. \t.bytearray\t\t= {0x6, 0x0, 0x0},
  139. \t.byteval\t\t= 0x5,
  140. \t.intval\t\t\t= 0x1,
  141. \t.longbytearray\t\t= {0x9, 0xa, 0xb, 0xc, 0xd, 0xe, 0xf, 0x10,
  142. \t\t0x11},
  143. \t.stringval\t\t= "message",
  144. \t.boolval\t\t= true,
  145. \t.intarray\t\t= {0x2, 0x3, 0x4, 0x0},
  146. \t.stringarray\t\t= {"multi-word", "message", ""},
  147. };
  148. U_BOOT_DEVICE(spl_test) = {
  149. \t.name\t\t= "sandbox_spl_test",
  150. \t.platdata\t= &dtv_spl_test,
  151. \t.platdata_size\t= sizeof(dtv_spl_test),
  152. };
  153. static struct dtd_sandbox_spl_test dtv_spl_test2 = {
  154. \t.bytearray\t\t= {0x1, 0x23, 0x34},
  155. \t.byteval\t\t= 0x8,
  156. \t.intval\t\t\t= 0x3,
  157. \t.longbytearray\t\t= {0x9, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0,
  158. \t\t0x0},
  159. \t.stringval\t\t= "message2",
  160. \t.intarray\t\t= {0x5, 0x0, 0x0, 0x0},
  161. \t.stringarray\t\t= {"another", "multi-word", "message"},
  162. };
  163. U_BOOT_DEVICE(spl_test2) = {
  164. \t.name\t\t= "sandbox_spl_test",
  165. \t.platdata\t= &dtv_spl_test2,
  166. \t.platdata_size\t= sizeof(dtv_spl_test2),
  167. };
  168. static struct dtd_sandbox_spl_test dtv_spl_test3 = {
  169. \t.stringarray\t\t= {"one", "", ""},
  170. };
  171. U_BOOT_DEVICE(spl_test3) = {
  172. \t.name\t\t= "sandbox_spl_test",
  173. \t.platdata\t= &dtv_spl_test3,
  174. \t.platdata_size\t= sizeof(dtv_spl_test3),
  175. };
  176. static struct dtd_sandbox_spl_test_2 dtv_spl_test4 = {
  177. };
  178. U_BOOT_DEVICE(spl_test4) = {
  179. \t.name\t\t= "sandbox_spl_test_2",
  180. \t.platdata\t= &dtv_spl_test4,
  181. \t.platdata_size\t= sizeof(dtv_spl_test4),
  182. };
  183. static struct dtd_sandbox_i2c_test dtv_i2c_at_0 = {
  184. };
  185. U_BOOT_DEVICE(i2c_at_0) = {
  186. \t.name\t\t= "sandbox_i2c_test",
  187. \t.platdata\t= &dtv_i2c_at_0,
  188. \t.platdata_size\t= sizeof(dtv_i2c_at_0),
  189. };
  190. static struct dtd_sandbox_pmic_test dtv_pmic_at_9 = {
  191. \t.low_power\t\t= true,
  192. \t.reg\t\t\t= {0x9, 0x0},
  193. };
  194. U_BOOT_DEVICE(pmic_at_9) = {
  195. \t.name\t\t= "sandbox_pmic_test",
  196. \t.platdata\t= &dtv_pmic_at_9,
  197. \t.platdata_size\t= sizeof(dtv_pmic_at_9),
  198. };
  199. ''', data)
  200. def test_phandle(self):
  201. """Test output from a node containing a phandle reference"""
  202. dtb_file = get_dtb_file('dtoc_test_phandle.dts')
  203. output = tools.GetOutputFilename('output')
  204. dtb_platdata.run_steps(['struct'], dtb_file, False, output)
  205. with open(output) as infile:
  206. data = infile.read()
  207. self.assertEqual(HEADER + '''
  208. struct dtd_source {
  209. \tstruct phandle_2_arg clocks[4];
  210. };
  211. struct dtd_target {
  212. \tfdt32_t\t\tintval;
  213. };
  214. ''', data)
  215. dtb_platdata.run_steps(['platdata'], dtb_file, False, output)
  216. with open(output) as infile:
  217. data = infile.read()
  218. self.assertEqual(C_HEADER + '''
  219. static struct dtd_target dtv_phandle_target = {
  220. \t.intval\t\t\t= 0x0,
  221. };
  222. U_BOOT_DEVICE(phandle_target) = {
  223. \t.name\t\t= "target",
  224. \t.platdata\t= &dtv_phandle_target,
  225. \t.platdata_size\t= sizeof(dtv_phandle_target),
  226. };
  227. static struct dtd_target dtv_phandle2_target = {
  228. \t.intval\t\t\t= 0x1,
  229. };
  230. U_BOOT_DEVICE(phandle2_target) = {
  231. \t.name\t\t= "target",
  232. \t.platdata\t= &dtv_phandle2_target,
  233. \t.platdata_size\t= sizeof(dtv_phandle2_target),
  234. };
  235. static struct dtd_target dtv_phandle3_target = {
  236. \t.intval\t\t\t= 0x2,
  237. };
  238. U_BOOT_DEVICE(phandle3_target) = {
  239. \t.name\t\t= "target",
  240. \t.platdata\t= &dtv_phandle3_target,
  241. \t.platdata_size\t= sizeof(dtv_phandle3_target),
  242. };
  243. static struct dtd_source dtv_phandle_source = {
  244. \t.clocks\t\t\t= {
  245. \t\t\t{&dtv_phandle_target, {}},
  246. \t\t\t{&dtv_phandle2_target, {11}},
  247. \t\t\t{&dtv_phandle3_target, {12, 13}},
  248. \t\t\t{&dtv_phandle_target, {}},},
  249. };
  250. U_BOOT_DEVICE(phandle_source) = {
  251. \t.name\t\t= "source",
  252. \t.platdata\t= &dtv_phandle_source,
  253. \t.platdata_size\t= sizeof(dtv_phandle_source),
  254. };
  255. ''', data)
  256. def test_aliases(self):
  257. """Test output from a node with multiple compatible strings"""
  258. dtb_file = get_dtb_file('dtoc_test_aliases.dts')
  259. output = tools.GetOutputFilename('output')
  260. dtb_platdata.run_steps(['struct'], dtb_file, False, output)
  261. with open(output) as infile:
  262. data = infile.read()
  263. self.assertEqual(HEADER + '''
  264. struct dtd_compat1 {
  265. \tfdt32_t\t\tintval;
  266. };
  267. #define dtd_compat2_1_fred dtd_compat1
  268. #define dtd_compat3 dtd_compat1
  269. ''', data)
  270. dtb_platdata.run_steps(['platdata'], dtb_file, False, output)
  271. with open(output) as infile:
  272. data = infile.read()
  273. self.assertEqual(C_HEADER + '''
  274. static struct dtd_compat1 dtv_spl_test = {
  275. \t.intval\t\t\t= 0x1,
  276. };
  277. U_BOOT_DEVICE(spl_test) = {
  278. \t.name\t\t= "compat1",
  279. \t.platdata\t= &dtv_spl_test,
  280. \t.platdata_size\t= sizeof(dtv_spl_test),
  281. };
  282. ''', data)
  283. def test_addresses64(self):
  284. """Test output from a node with a 'reg' property with na=2, ns=2"""
  285. dtb_file = get_dtb_file('dtoc_test_addr64.dts')
  286. output = tools.GetOutputFilename('output')
  287. dtb_platdata.run_steps(['struct'], dtb_file, False, output)
  288. with open(output) as infile:
  289. data = infile.read()
  290. self.assertEqual(HEADER + '''
  291. struct dtd_test1 {
  292. \tfdt64_t\t\treg[2];
  293. };
  294. struct dtd_test2 {
  295. \tfdt64_t\t\treg[2];
  296. };
  297. struct dtd_test3 {
  298. \tfdt64_t\t\treg[4];
  299. };
  300. ''', data)
  301. dtb_platdata.run_steps(['platdata'], dtb_file, False, output)
  302. with open(output) as infile:
  303. data = infile.read()
  304. self.assertEqual(C_HEADER + '''
  305. static struct dtd_test1 dtv_test1 = {
  306. \t.reg\t\t\t= {0x1234, 0x5678},
  307. };
  308. U_BOOT_DEVICE(test1) = {
  309. \t.name\t\t= "test1",
  310. \t.platdata\t= &dtv_test1,
  311. \t.platdata_size\t= sizeof(dtv_test1),
  312. };
  313. static struct dtd_test2 dtv_test2 = {
  314. \t.reg\t\t\t= {0x1234567890123456, 0x9876543210987654},
  315. };
  316. U_BOOT_DEVICE(test2) = {
  317. \t.name\t\t= "test2",
  318. \t.platdata\t= &dtv_test2,
  319. \t.platdata_size\t= sizeof(dtv_test2),
  320. };
  321. static struct dtd_test3 dtv_test3 = {
  322. \t.reg\t\t\t= {0x1234567890123456, 0x9876543210987654, 0x2, 0x3},
  323. };
  324. U_BOOT_DEVICE(test3) = {
  325. \t.name\t\t= "test3",
  326. \t.platdata\t= &dtv_test3,
  327. \t.platdata_size\t= sizeof(dtv_test3),
  328. };
  329. ''', data)
  330. def test_addresses32(self):
  331. """Test output from a node with a 'reg' property with na=1, ns=1"""
  332. dtb_file = get_dtb_file('dtoc_test_addr32.dts')
  333. output = tools.GetOutputFilename('output')
  334. dtb_platdata.run_steps(['struct'], dtb_file, False, output)
  335. with open(output) as infile:
  336. data = infile.read()
  337. self.assertEqual(HEADER + '''
  338. struct dtd_test1 {
  339. \tfdt32_t\t\treg[2];
  340. };
  341. struct dtd_test2 {
  342. \tfdt32_t\t\treg[4];
  343. };
  344. ''', data)
  345. dtb_platdata.run_steps(['platdata'], dtb_file, False, output)
  346. with open(output) as infile:
  347. data = infile.read()
  348. self.assertEqual(C_HEADER + '''
  349. static struct dtd_test1 dtv_test1 = {
  350. \t.reg\t\t\t= {0x1234, 0x5678},
  351. };
  352. U_BOOT_DEVICE(test1) = {
  353. \t.name\t\t= "test1",
  354. \t.platdata\t= &dtv_test1,
  355. \t.platdata_size\t= sizeof(dtv_test1),
  356. };
  357. static struct dtd_test2 dtv_test2 = {
  358. \t.reg\t\t\t= {0x12345678, 0x98765432, 0x2, 0x3},
  359. };
  360. U_BOOT_DEVICE(test2) = {
  361. \t.name\t\t= "test2",
  362. \t.platdata\t= &dtv_test2,
  363. \t.platdata_size\t= sizeof(dtv_test2),
  364. };
  365. ''', data)
  366. def test_addresses64_32(self):
  367. """Test output from a node with a 'reg' property with na=2, ns=1"""
  368. dtb_file = get_dtb_file('dtoc_test_addr64_32.dts')
  369. output = tools.GetOutputFilename('output')
  370. dtb_platdata.run_steps(['struct'], dtb_file, False, output)
  371. with open(output) as infile:
  372. data = infile.read()
  373. self.assertEqual(HEADER + '''
  374. struct dtd_test1 {
  375. \tfdt64_t\t\treg[2];
  376. };
  377. struct dtd_test2 {
  378. \tfdt64_t\t\treg[2];
  379. };
  380. struct dtd_test3 {
  381. \tfdt64_t\t\treg[4];
  382. };
  383. ''', data)
  384. dtb_platdata.run_steps(['platdata'], dtb_file, False, output)
  385. with open(output) as infile:
  386. data = infile.read()
  387. self.assertEqual(C_HEADER + '''
  388. static struct dtd_test1 dtv_test1 = {
  389. \t.reg\t\t\t= {0x123400000000, 0x5678},
  390. };
  391. U_BOOT_DEVICE(test1) = {
  392. \t.name\t\t= "test1",
  393. \t.platdata\t= &dtv_test1,
  394. \t.platdata_size\t= sizeof(dtv_test1),
  395. };
  396. static struct dtd_test2 dtv_test2 = {
  397. \t.reg\t\t\t= {0x1234567890123456, 0x98765432},
  398. };
  399. U_BOOT_DEVICE(test2) = {
  400. \t.name\t\t= "test2",
  401. \t.platdata\t= &dtv_test2,
  402. \t.platdata_size\t= sizeof(dtv_test2),
  403. };
  404. static struct dtd_test3 dtv_test3 = {
  405. \t.reg\t\t\t= {0x1234567890123456, 0x98765432, 0x2, 0x3},
  406. };
  407. U_BOOT_DEVICE(test3) = {
  408. \t.name\t\t= "test3",
  409. \t.platdata\t= &dtv_test3,
  410. \t.platdata_size\t= sizeof(dtv_test3),
  411. };
  412. ''', data)
  413. def test_addresses32_64(self):
  414. """Test output from a node with a 'reg' property with na=1, ns=2"""
  415. dtb_file = get_dtb_file('dtoc_test_addr32_64.dts')
  416. output = tools.GetOutputFilename('output')
  417. dtb_platdata.run_steps(['struct'], dtb_file, False, output)
  418. with open(output) as infile:
  419. data = infile.read()
  420. self.assertEqual(HEADER + '''
  421. struct dtd_test1 {
  422. \tfdt64_t\t\treg[2];
  423. };
  424. struct dtd_test2 {
  425. \tfdt64_t\t\treg[2];
  426. };
  427. struct dtd_test3 {
  428. \tfdt64_t\t\treg[4];
  429. };
  430. ''', data)
  431. dtb_platdata.run_steps(['platdata'], dtb_file, False, output)
  432. with open(output) as infile:
  433. data = infile.read()
  434. self.assertEqual(C_HEADER + '''
  435. static struct dtd_test1 dtv_test1 = {
  436. \t.reg\t\t\t= {0x1234, 0x567800000000},
  437. };
  438. U_BOOT_DEVICE(test1) = {
  439. \t.name\t\t= "test1",
  440. \t.platdata\t= &dtv_test1,
  441. \t.platdata_size\t= sizeof(dtv_test1),
  442. };
  443. static struct dtd_test2 dtv_test2 = {
  444. \t.reg\t\t\t= {0x12345678, 0x9876543210987654},
  445. };
  446. U_BOOT_DEVICE(test2) = {
  447. \t.name\t\t= "test2",
  448. \t.platdata\t= &dtv_test2,
  449. \t.platdata_size\t= sizeof(dtv_test2),
  450. };
  451. static struct dtd_test3 dtv_test3 = {
  452. \t.reg\t\t\t= {0x12345678, 0x9876543210987654, 0x2, 0x3},
  453. };
  454. U_BOOT_DEVICE(test3) = {
  455. \t.name\t\t= "test3",
  456. \t.platdata\t= &dtv_test3,
  457. \t.platdata_size\t= sizeof(dtv_test3),
  458. };
  459. ''', data)