• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1The source tree contains the Device Tree Compiler (dtc) toolchain for
2working with device tree source and binary files and also libfdt, a
3utility library for reading and manipulating the binary format.
4
5DTC and LIBFDT are maintained by:
6
7David Gibson <david@gibson.dropbear.id.au>
8Jon Loeliger <jdl@jdl.com>
9
10
11Python library
12--------------
13
14A Python library is also available. To build this you will need to install
15swig and Python development files. On Debian distributions:
16
17   sudo apt-get install swig python-dev
18
19The library provides an Fdt class which you can use like this:
20
21$ PYTHONPATH=../pylibfdt python
22>>> import libfdt
23>>> fdt = libfdt.Fdt(open('test_tree1.dtb').read())
24>>> node = fdt.path_offset('/subnode@1')
25>>> print node
26124
27>>> prop_offset = fdt.first_property_offset(node)
28>>> prop = fdt.get_property_by_offset(prop_offset)
29>>> print '%s=%r' % (prop.name, prop.value)
30compatible=bytearray(b'subnode1\x00')
31>>> print '%s=%s' % (prop.name, prop.value)
32compatible=subnode1
33>>> node2 = fdt.path_offset('/')
34>>> print fdt.getprop(node2, 'compatible')
35test_tree1
36
37You will find tests in tests/pylibfdt_tests.py showing how to use each
38method. Help is available using the Python help command, e.g.:
39
40    $ cd pylibfdt
41    $ python -c "import libfdt; help(libfdt)"
42
43If you add new features, please check code coverage:
44
45    $ sudo apt-get install python-pip python-pytest
46    $ sudo pip install coverage
47    $ cd tests
48    $ coverage run pylibfdt_tests.py
49    $ coverage html
50    # Open 'htmlcov/index.html' in your browser
51
52
53To install the library via the normal setup.py method, use:
54
55    ./pylibfdt/setup.py [--prefix=/path/to/install_dir]
56
57If --prefix is not provided, the default prefix is used, typically '/usr'
58or '/usr/local'. See Python's distutils documentation for details. You can
59also install via the Makefile if you like, but the above is more common.
60
61To install both libfdt and pylibfdt you can use:
62
63    make install [SETUP_PREFIX=/path/to/install_dir] \
64            [PREFIX=/path/to/install_dir]
65
66To disable building the python library, even if swig and Python are available,
67use:
68
69    make NO_PYTHON=1
70
71
72More work remains to support all of libfdt, including access to numeric
73values.
74
75
76Mailing list
77------------
78The following list is for discussion about dtc and libfdt implementation
79mailto:devicetree-compiler@vger.kernel.org
80
81Core device tree bindings are discussed on the devicetree-spec list:
82mailto:devicetree-spec@vger.kernel.org
83