xref: /openbmc/u-boot/tools/dtoc/dtoc.py (revision ed85f771) 
1#!/usr/bin/env python2
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 two output files:
17
18   dt-structs.h  - contains struct definitions
19   dt-platdata.c - contains data from the device tree using the struct
20                      definitions, as well as U-Boot driver definitions.
21
22This tool is used in U-Boot to provide device tree data to SPL without
23increasing the code size of SPL. This supports the CONFIG_SPL_OF_PLATDATA
24options. For more information about the use of this options and tool please
25see doc/driver-model/of-plat.txt
26"""
27
28from optparse import OptionParser
29import os
30import sys
31import unittest
32
33# Bring in the patman libraries
34our_path = os.path.dirname(os.path.realpath(__file__))
35sys.path.append(os.path.join(our_path, '../patman'))
36
37import dtb_platdata
38import test_util
39
40def run_tests(args):
41    """Run all the test we have for dtoc
42
43    Args:
44        args: List of positional args provided to dtoc. This can hold a test
45            name to execute (as in 'dtoc -t test_empty_file', for example)
46    """
47    import test_dtoc
48
49    result = unittest.TestResult()
50    sys.argv = [sys.argv[0]]
51    test_name = args and args[0] or None
52    for module in (test_dtoc.TestDtoc,):
53        if test_name:
54            try:
55                suite = unittest.TestLoader().loadTestsFromName(test_name, module)
56            except AttributeError:
57                continue
58        else:
59            suite = unittest.TestLoader().loadTestsFromTestCase(module)
60        suite.run(result)
61
62    print result
63    for _, err in result.errors:
64        print err
65    for _, err in result.failures:
66        print err
67
68def RunTestCoverage():
69    """Run the tests and check that we get 100% coverage"""
70    sys.argv = [sys.argv[0]]
71    test_util.RunTestCoverage('tools/dtoc/dtoc.py', '/dtoc.py',
72            ['tools/patman/*.py', '*/fdt*', '*test*'], options.build_dir)
73
74
75if __name__ != '__main__':
76    sys.exit(1)
77
78parser = OptionParser()
79parser.add_option('-B', '--build-dir', type='string', default='b',
80        help='Directory containing the build output')
81parser.add_option('-d', '--dtb-file', action='store',
82                  help='Specify the .dtb input file')
83parser.add_option('--include-disabled', action='store_true',
84                  help='Include disabled nodes')
85parser.add_option('-o', '--output', action='store', default='-',
86                  help='Select output filename')
87parser.add_option('-t', '--test', action='store_true', dest='test',
88                  default=False, help='run tests')
89parser.add_option('-T', '--test-coverage', action='store_true',
90                default=False, help='run tests and check for 100% coverage')
91(options, args) = parser.parse_args()
92
93# Run our meagre tests
94if options.test:
95    run_tests(args)
96
97elif options.test_coverage:
98    RunTestCoverage()
99
100else:
101    dtb_platdata.run_steps(args, options.dtb_file, options.include_disabled,
102                           options.output)
103