tools/dtoc/dtoc.py

   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
  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.txt
  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 import dtb_platdata
  38
  39 def run_tests():
  40     """Run all the test we have for dtoc"""
  41     import test_dtoc
  42
  43     result = unittest.TestResult()
  44     sys.argv = [sys.argv[0]]
  45     for module in (test_dtoc.TestDtoc,):
  46         suite = unittest.TestLoader().loadTestsFromTestCase(module)
  47         suite.run(result)
  48
  49     print result
  50     for _, err in result.errors:
  51         print err
  52     for _, err in result.failures:
  53         print err
  54
  55 if __name__ != '__main__':
  56     sys.exit(1)
  57
  58 parser = OptionParser()
  59 parser.add_option('-d', '--dtb-file', action='store',
  60                   help='Specify the .dtb input file')
  61 parser.add_option('--include-disabled', action='store_true',
  62                   help='Include disabled nodes')
  63 parser.add_option('-o', '--output', action='store', default='-',
  64                   help='Select output filename')
  65 parser.add_option('-t', '--test', action='store_true', dest='test',
  66                   default=False, help='run tests')
  67 (options, args) = parser.parse_args()
  68
  69 # Run our meagre tests
  70 if options.test:
  71     run_tests()
  72
  73 else:
  74     dtb_platdata.run_steps(args, options.dtb_file, options.include_disabled,
  75                            options.output)