1#!/usr/bin/env python3
2# SPDX-License-Identifier: GPL-2.0+
3#
4# Copyright (C) 2016 Google, Inc
5# Written by Simon Glass <sjg@chromium.org>
6#
7
8"""Device tree to C tool
9
10This tool converts a device tree binary file (.dtb) into two C files. The
11indent is to allow a C program to access data from the device tree without
12having to link against libfdt. By putting the data from the device tree into
13C structures, normal C code can be used. This helps to reduce the size of the
14compiled program.
15
16Dtoc produces several output files - see OUTPUT_FILES in dtb_platdata.py
17
18This tool is used in U-Boot to provide device tree data to SPL without
19increasing the code size of SPL. This supports the CONFIG_SPL_OF_PLATDATA
20options. For more information about the use of this options and tool please
21see doc/driver-model/of-plat.rst
22"""
23
24from argparse import ArgumentParser
25import os
26import sys
27import unittest
28
29# Bring in the patman libraries
30our_path = os.path.dirname(os.path.realpath(__file__))
31sys.path.append(os.path.join(our_path, '..'))
32
33# Bring in the libfdt module
34sys.path.insert(0, 'scripts/dtc/pylibfdt')
35sys.path.insert(0, os.path.join(our_path,
36                '../../build-sandbox_spl/scripts/dtc/pylibfdt'))
37
38from dtoc import dtb_platdata
39from patman import test_util
40
41def run_tests(processes, args):
42    """Run all the test we have for dtoc
43
44    Args:
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)
48    """
49    from dtoc import test_src_scan
50    from dtoc import test_dtoc
51
52    result = unittest.TestResult()
53    sys.argv = [sys.argv[0]]
54    test_name = args.files and args.files[0] or None
55
56    test_dtoc.setup()
57
58    test_util.RunTestSuites(
59        result, debug=True, verbosity=1, test_preserve_dirs=False,
60        processes=processes, test_name=test_name, toolpath=[],
61        test_class_list=[test_dtoc.TestDtoc,test_src_scan.TestSrcScan])
62
63    return test_util.ReportResult('binman', test_name, result)
64
65def 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)
70
71
72if __name__ != '__main__':
73    sys.exit(1)
74
75epilog = '''Generate C code from devicetree files. See of-plat.rst for details'''
76
77parser = ArgumentParser(epilog=epilog)
78parser.add_argument('-B', '--build-dir', type=str, default='b',
79        help='Directory containing the build output')
80parser.add_argument('-c', '--c-output-dir', action='store',
81                  help='Select output directory for C files')
82parser.add_argument('-C', '--h-output-dir', action='store',
83                  help='Select output directory for H files (defaults to --c-output-di)')
84parser.add_argument('-d', '--dtb-file', action='store',
85                  help='Specify the .dtb input file')
86parser.add_argument('-i', '--instantiate', action='store_true', default=False,
87                  help='Instantiate devices to avoid needing device_bind()')
88parser.add_argument('--include-disabled', action='store_true',
89                  help='Include disabled nodes')
90parser.add_argument('-o', '--output', action='store',
91                  help='Select output filename')
92parser.add_argument('-p', '--phase', type=str,
93                  help='set phase of U-Boot this invocation is for (spl/tpl)')
94parser.add_argument('-P', '--processes', type=int,
95                  help='set number of processes to use for running tests')
96parser.add_argument('-t', '--test', action='store_true', dest='test',
97                  default=False, help='run tests')
98parser.add_argument('-T', '--test-coverage', action='store_true',
99                default=False, help='run tests and check for 100%% coverage')
100parser.add_argument('files', nargs='*')
101args = parser.parse_args()
102
103# Run our meagre tests
104if args.test:
105    ret_code = run_tests(args.processes, args)
106    sys.exit(ret_code)
107
108elif args.test_coverage:
109    RunTestCoverage()
110
111else:
112    dtb_platdata.run_steps(args.files, args.dtb_file, args.include_disabled,
113                           args.output,
114                           [args.c_output_dir, args.h_output_dir],
115                           args.phase, instantiate=args.instantiate)
116