2 # SPDX-License-Identifier: GPL-2.0+
4 # Copyright (C) 2016 Google, Inc
5 # Written by Simon Glass <sjg@chromium.org>
8 """Device tree to C tool
10 This tool converts a device tree binary file (.dtb) into two C files. The
11 indent is to allow a C program to access data from the device tree without
12 having to link against libfdt. By putting the data from the device tree into
13 C structures, normal C code can be used. This helps to reduce the size of the
16 Dtoc produces several output files - see OUTPUT_FILES in dtb_platdata.py
18 This tool is used in U-Boot to provide device tree data to SPL without
19 increasing the code size of SPL. This supports the CONFIG_SPL_OF_PLATDATA
20 options. For more information about the use of this options and tool please
21 see doc/driver-model/of-plat.rst
24 from argparse import ArgumentParser
29 # Bring in the patman libraries
30 our_path = os.path.dirname(os.path.realpath(__file__))
31 sys.path.append(os.path.join(our_path, '..'))
33 # Bring in the libfdt module
34 sys.path.insert(0, 'scripts/dtc/pylibfdt')
35 sys.path.insert(0, os.path.join(our_path,
36 '../../build-sandbox_spl/scripts/dtc/pylibfdt'))
38 from dtoc import dtb_platdata
39 from patman import test_util
41 def run_tests(processes, args):
42 """Run all the test we have for dtoc
45 processes: Number of processes to use to run tests (None=same as #CPUs)
46 args: List of positional args provided to dtoc. This can hold a test
47 name to execute (as in 'dtoc -t test_empty_file', for example)
49 from dtoc import test_src_scan
50 from dtoc import test_dtoc
52 result = unittest.TestResult()
53 sys.argv = [sys.argv[0]]
54 test_name = args.files and args.files[0] or None
58 test_util.RunTestSuites(
59 result, debug=True, verbosity=1, test_preserve_dirs=False,
60 processes=processes, test_name=test_name, toolpath=[],
61 class_and_module_list=[test_dtoc.TestDtoc,test_src_scan.TestSrcScan])
63 return test_util.ReportResult('binman', test_name, result)
65 def RunTestCoverage():
66 """Run the tests and check that we get 100% coverage"""
67 sys.argv = [sys.argv[0]]
68 test_util.RunTestCoverage('tools/dtoc/dtoc', '/main.py',
69 ['tools/patman/*.py', '*/fdt*', '*test*'], args.build_dir)
72 if __name__ != '__main__':
75 epilog = '''Generate C code from devicetree files. See of-plat.rst for details'''
77 parser = ArgumentParser(epilog=epilog)
78 parser.add_argument('-B', '--build-dir', type=str, default='b',
79 help='Directory containing the build output')
80 parser.add_argument('-c', '--c-output-dir', action='store',
81 help='Select output directory for C files')
82 parser.add_argument('-C', '--h-output-dir', action='store',
83 help='Select output directory for H files (defaults to --c-output-di)')
84 parser.add_argument('-d', '--dtb-file', action='store',
85 help='Specify the .dtb input file')
86 parser.add_argument('-i', '--instantiate', action='store_true', default=False,
87 help='Instantiate devices to avoid needing device_bind()')
88 parser.add_argument('--include-disabled', action='store_true',
89 help='Include disabled nodes')
90 parser.add_argument('-o', '--output', action='store',
91 help='Select output filename')
92 parser.add_argument('-p', '--phase', type=str,
93 help='set phase of U-Boot this invocation is for (spl/tpl)')
94 parser.add_argument('-P', '--processes', type=int,
95 help='set number of processes to use for running tests')
96 parser.add_argument('-t', '--test', action='store_true', dest='test',
97 default=False, help='run tests')
98 parser.add_argument('-T', '--test-coverage', action='store_true',
99 default=False, help='run tests and check for 100%% coverage')
100 parser.add_argument('files', nargs='*')
101 args = parser.parse_args()
103 # Run our meagre tests
105 ret_code = run_tests(args.processes, args)
108 elif args.test_coverage:
112 dtb_platdata.run_steps(args.files, args.dtb_file, args.include_disabled,
114 [args.c_output_dir, args.h_output_dir],
115 args.phase, instantiate=args.instantiate)