tools/dtoc/dtoc.py

   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
  10 This tool converts a device tree binary file (.dtb) into two C files. The
  11 indent is to allow a C program to access data from the device tree without
  12 having to link against libfdt. By putting the data from the device tree into
  13 C structures, normal C code can be used. This helps to reduce the size of the
  14 compiled program.
  15
  16 Dtoc 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
  22 This tool is used in U-Boot to provide device tree data to SPL without
  23 increasing the code size of SPL. This supports the CONFIG_SPL_OF_PLATDATA
  24 options. For more information about the use of this options and tool please
  25 see doc/driver-model/of-plat.rst
  26 """
  27
  28 from optparse import OptionParser
  29 import os
  30 import sys
  31 import unittest
  32
  33 # Bring in the patman libraries
  34 our_path = os.path.dirname(os.path.realpath(__file__))
  35 sys.path.append(os.path.join(our_path, '../patman'))
  36
  37 # Bring in the libfdt module
  38 sys.path.insert(0, 'scripts/dtc/pylibfdt')
  39 sys.path.insert(0, os.path.join(our_path,
  40                 '../../build-sandbox_spl/scripts/dtc/pylibfdt'))
  41
  42 import dtb_platdata
  43 import test_util
  44
  45 def run_tests(args):
  46     """Run all the test we have for dtoc
  47
  48     Args:
  49         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)
  51     """
  52     import test_dtoc
  53
  54     result = unittest.TestResult()
  55     sys.argv = [sys.argv[0]]
  56     test_name = args and args[0] or None
  57     for module in (test_dtoc.TestDtoc,):
  58         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)
  65         suite.run(result)
  66
  67     print(result)
  68     for _, err in result.errors:
  69         print(err)
  70     for _, err in result.failures:
  71         print(err)
  72     if result.errors or result.failures:
  73         print('dtoc tests FAILED')
  74         return 1
  75     return 0
  76
  77 def RunTestCoverage():
  78     """Run the tests and check that we get 100% coverage"""
  79     sys.argv = [sys.argv[0]]
  80     test_util.RunTestCoverage('tools/dtoc/dtoc.py', '/dtoc.py',
  81             ['tools/patman/*.py', '*/fdt*', '*test*'], options.build_dir)
  82
  83
  84 if __name__ != '__main__':
  85     sys.exit(1)
  86
  87 parser = OptionParser()
  88 parser.add_option('-B', '--build-dir', type='string', default='b',
  89         help='Directory containing the build output')
  90 parser.add_option('-d', '--dtb-file', action='store',
  91                   help='Specify the .dtb input file')
  92 parser.add_option('--include-disabled', action='store_true',
  93                   help='Include disabled nodes')
  94 parser.add_option('-o', '--output', action='store', default='-',
  95                   help='Select output filename')
  96 parser.add_option('-P', '--processes', type=int,
  97                   help='set number of processes to use for running tests')
  98 parser.add_option('-t', '--test', action='store_true', dest='test',
  99                   default=False, help='run tests')
 100 parser.add_option('-T', '--test-coverage', action='store_true',
 101                 default=False, help='run tests and check for 100% coverage')
 102 (options, args) = parser.parse_args()
 103
 104 # Run our meagre tests
 105 if options.test:
 106     ret_code = run_tests(args)
 107     sys.exit(ret_code)
 108
 109 elif options.test_coverage:
 110     RunTestCoverage()
 111
 112 else:
 113     dtb_platdata.run_steps(args, options.dtb_file, options.include_disabled,
 114                            options.output)