xref: /openbmc/u-boot/tools/dtoc/dtoc.py (revision 3def0cf2) 
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
38
39def run_tests(args):
40    """Run all the test we have for dtoc
41
42    Args:
43        args: List of positional args provided to binman. This can hold a test
44            name to execute (as in 'binman -t testSections', for example)
45    """
46    import test_dtoc
47
48    result = unittest.TestResult()
49    sys.argv = [sys.argv[0]]
50    test_name = args and args[0] or None
51    for module in (test_dtoc.TestDtoc,):
52        if test_name:
53            try:
54                suite = unittest.TestLoader().loadTestsFromName(test_name, module)
55            except AttributeError:
56                continue
57        else:
58            suite = unittest.TestLoader().loadTestsFromTestCase(module)
59        suite.run(result)
60
61    print result
62    for _, err in result.errors:
63        print err
64    for _, err in result.failures:
65        print err
66
67if __name__ != '__main__':
68    sys.exit(1)
69
70parser = OptionParser()
71parser.add_option('-d', '--dtb-file', action='store',
72                  help='Specify the .dtb input file')
73parser.add_option('--include-disabled', action='store_true',
74                  help='Include disabled nodes')
75parser.add_option('-o', '--output', action='store', default='-',
76                  help='Select output filename')
77parser.add_option('-t', '--test', action='store_true', dest='test',
78                  default=False, help='run tests')
79(options, args) = parser.parse_args()
80
81# Run our meagre tests
82if options.test:
83    run_tests(args)
84
85else:
86    dtb_platdata.run_steps(args, options.dtb_file, options.include_disabled,
87                           options.output)
88