• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 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 __future__ import print_function
29
30from optparse import OptionParser
31import os
32import sys
33import unittest
34
35# Bring in the patman libraries
36our_path = os.path.dirname(os.path.realpath(__file__))
37sys.path.append(os.path.join(our_path, '../patman'))
38
39# Bring in the libfdt module
40sys.path.insert(0, 'scripts/dtc/pylibfdt')
41sys.path.insert(0, os.path.join(our_path,
42                '../../build-sandbox_spl/scripts/dtc/pylibfdt'))
43
44import dtb_platdata
45import test_util
46
47def run_tests(args):
48    """Run all the test we have for dtoc
49
50    Args:
51        args: List of positional args provided to dtoc. This can hold a test
52            name to execute (as in 'dtoc -t test_empty_file', for example)
53    """
54    import test_dtoc
55
56    result = unittest.TestResult()
57    sys.argv = [sys.argv[0]]
58    test_name = args and args[0] or None
59    for module in (test_dtoc.TestDtoc,):
60        if test_name:
61            try:
62                suite = unittest.TestLoader().loadTestsFromName(test_name, module)
63            except AttributeError:
64                continue
65        else:
66            suite = unittest.TestLoader().loadTestsFromTestCase(module)
67        suite.run(result)
68
69    print(result)
70    for _, err in result.errors:
71        print(err)
72    for _, err in result.failures:
73        print(err)
74    if result.errors or result.failures:
75        print('dtoc tests FAILED')
76        return 1
77    return 0
78
79def RunTestCoverage():
80    """Run the tests and check that we get 100% coverage"""
81    sys.argv = [sys.argv[0]]
82    test_util.RunTestCoverage('tools/dtoc/dtoc.py', '/dtoc.py',
83            ['tools/patman/*.py', '*/fdt*', '*test*'], options.build_dir)
84
85
86if __name__ != '__main__':
87    sys.exit(1)
88
89parser = OptionParser()
90parser.add_option('-B', '--build-dir', type='string', default='b',
91        help='Directory containing the build output')
92parser.add_option('-d', '--dtb-file', action='store',
93                  help='Specify the .dtb input file')
94parser.add_option('--include-disabled', action='store_true',
95                  help='Include disabled nodes')
96parser.add_option('-o', '--output', action='store', default='-',
97                  help='Select output filename')
98parser.add_option('-P', '--processes', type=int,
99                  help='set number of processes to use for running tests')
100parser.add_option('-t', '--test', action='store_true', dest='test',
101                  default=False, help='run tests')
102parser.add_option('-T', '--test-coverage', action='store_true',
103                default=False, help='run tests and check for 100% coverage')
104(options, args) = parser.parse_args()
105
106# Run our meagre tests
107if options.test:
108    ret_code = run_tests(args)
109    sys.exit(ret_code)
110
111elif options.test_coverage:
112    RunTestCoverage()
113
114else:
115    dtb_platdata.run_steps(args, options.dtb_file, options.include_disabled,
116                           options.output)
117