blob: b94d9c301f492ae203abe3d0f929e4fc201964ed [file] [log] [blame]
Simon Glass3c19dc82019-10-31 07:42:55 -06001#!/usr/bin/env python3
Tom Rini83d290c2018-05-06 17:58:06 -04002# SPDX-License-Identifier: GPL-2.0+
Simon Glass69f2ed72016-07-04 11:58:09 -06003#
4# Copyright (C) 2016 Google, Inc
5# Written by Simon Glass <sjg@chromium.org>
6#
Simon Glass69f2ed72016-07-04 11:58:09 -06007
Simon Glass14f5acf2017-06-18 22:08:57 -06008"""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
Heinrich Schuchardt2799a692020-02-25 21:35:39 +010025see doc/driver-model/of-plat.rst
Simon Glass14f5acf2017-06-18 22:08:57 -060026"""
27
Simon Glass7581c012017-06-18 22:08:58 -060028from optparse import OptionParser
Simon Glass69f2ed72016-07-04 11:58:09 -060029import os
30import sys
Simon Glassc0791922017-06-18 22:09:06 -060031import unittest
Simon Glass69f2ed72016-07-04 11:58:09 -060032
Simon Glass69f2ed72016-07-04 11:58:09 -060033# Bring in the patman libraries
34our_path = os.path.dirname(os.path.realpath(__file__))
Simon Glassbf776672020-04-17 18:09:04 -060035sys.path.append(os.path.join(our_path, '..'))
Simon Glass69f2ed72016-07-04 11:58:09 -060036
Simon Glassed59e002018-10-01 21:12:40 -060037# Bring in the libfdt module
38sys.path.insert(0, 'scripts/dtc/pylibfdt')
39sys.path.insert(0, os.path.join(our_path,
40 '../../build-sandbox_spl/scripts/dtc/pylibfdt'))
41
Simon Glassbf776672020-04-17 18:09:04 -060042from dtoc import dtb_platdata
43from patman import test_util
Simon Glass69f2ed72016-07-04 11:58:09 -060044
Simon Glass3def0cf2018-07-06 10:27:20 -060045def run_tests(args):
46 """Run all the test we have for dtoc
47
48 Args:
Simon Glassdfe5f5b2018-07-06 10:27:32 -060049 args: List of positional args provided to dtoc. This can hold a test
50 name to execute (as in 'dtoc -t test_empty_file', for example)
Simon Glass3def0cf2018-07-06 10:27:20 -060051 """
Simon Glassc0791922017-06-18 22:09:06 -060052 import test_dtoc
Simon Glass69f2ed72016-07-04 11:58:09 -060053
Simon Glassc0791922017-06-18 22:09:06 -060054 result = unittest.TestResult()
55 sys.argv = [sys.argv[0]]
Simon Glass3def0cf2018-07-06 10:27:20 -060056 test_name = args and args[0] or None
Simon Glassc0791922017-06-18 22:09:06 -060057 for module in (test_dtoc.TestDtoc,):
Simon Glass3def0cf2018-07-06 10:27:20 -060058 if test_name:
59 try:
60 suite = unittest.TestLoader().loadTestsFromName(test_name, module)
61 except AttributeError:
62 continue
63 else:
64 suite = unittest.TestLoader().loadTestsFromTestCase(module)
Simon Glassc0791922017-06-18 22:09:06 -060065 suite.run(result)
66
Simon Glass90a81322019-05-17 22:00:31 -060067 print(result)
Simon Glassc0791922017-06-18 22:09:06 -060068 for _, err in result.errors:
Simon Glass90a81322019-05-17 22:00:31 -060069 print(err)
Simon Glassc0791922017-06-18 22:09:06 -060070 for _, err in result.failures:
Simon Glass90a81322019-05-17 22:00:31 -060071 print(err)
Simon Glass10000962019-07-20 12:23:23 -060072 if result.errors or result.failures:
73 print('dtoc tests FAILED')
74 return 1
75 return 0
Simon Glassc0791922017-06-18 22:09:06 -060076
Simon Glassba765212018-07-06 10:27:33 -060077def RunTestCoverage():
78 """Run the tests and check that we get 100% coverage"""
79 sys.argv = [sys.argv[0]]
Simon Glass4d25fe22020-04-17 18:08:57 -060080 test_util.RunTestCoverage('tools/dtoc/dtoc', '/main.py',
Simon Glassba765212018-07-06 10:27:33 -060081 ['tools/patman/*.py', '*/fdt*', '*test*'], options.build_dir)
82
83
Simon Glassc0791922017-06-18 22:09:06 -060084if __name__ != '__main__':
85 sys.exit(1)
Simon Glass69f2ed72016-07-04 11:58:09 -060086
87parser = OptionParser()
Simon Glassba765212018-07-06 10:27:33 -060088parser.add_option('-B', '--build-dir', type='string', default='b',
89 help='Directory containing the build output')
Simon Glass69f2ed72016-07-04 11:58:09 -060090parser.add_option('-d', '--dtb-file', action='store',
91 help='Specify the .dtb input file')
92parser.add_option('--include-disabled', action='store_true',
93 help='Include disabled nodes')
94parser.add_option('-o', '--output', action='store', default='-',
95 help='Select output filename')
Simon Glass11ae93e2018-10-01 21:12:47 -060096parser.add_option('-P', '--processes', type=int,
97 help='set number of processes to use for running tests')
Simon Glassc0791922017-06-18 22:09:06 -060098parser.add_option('-t', '--test', action='store_true', dest='test',
99 default=False, help='run tests')
Simon Glassba765212018-07-06 10:27:33 -0600100parser.add_option('-T', '--test-coverage', action='store_true',
101 default=False, help='run tests and check for 100% coverage')
Simon Glass69f2ed72016-07-04 11:58:09 -0600102(options, args) = parser.parse_args()
103
Simon Glassc0791922017-06-18 22:09:06 -0600104# Run our meagre tests
105if options.test:
Simon Glass10000962019-07-20 12:23:23 -0600106 ret_code = run_tests(args)
107 sys.exit(ret_code)
Simon Glassc0791922017-06-18 22:09:06 -0600108
Simon Glassba765212018-07-06 10:27:33 -0600109elif options.test_coverage:
110 RunTestCoverage()
111
Simon Glassc0791922017-06-18 22:09:06 -0600112else:
113 dtb_platdata.run_steps(args, options.dtb_file, options.include_disabled,
114 options.output)