You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
David Gibson af57d440d8 libfdt: Correct prototype for fdt_ro_probe_() 1 week ago
Documentation Fix typos in various documentation and source files 5 months ago
libfdt libfdt: Correct prototype for fdt_ro_probe_() 1 week ago
pylibfdt pylibfdt: Correct the type for fdt_property_stub() 2 weeks ago
scripts dtc: Add GPLv2 SPDX tags to files missing license text 4 months ago
tests pylibfdt: Correct the type for fdt_property_stub() 2 weeks ago
.editorconfig Add .editorconfig 1 month ago
.gitignore Add fdtoverlay to .gitignore 2 years ago
.travis.yml Add support for YAML encoded output 1 year ago
BSD-2-Clause README.license: Update to reflect SPDX tag usage 4 months ago
GPL Update the GPL2 text to the latest revision 5 months ago
Makefile support byacc in addition to bison 1 week ago
Makefile.convert-dtsv0 dtc: Add GPLv2 SPDX tags to files missing license text 4 months ago
Makefile.dtc dtc: Replace GPLv2 boilerplate/reference with SPDX tags 4 months ago
Makefile.utils dtc: Add GPLv2 SPDX tags to files missing license text 4 months ago
README README: update for Python 3 2 months ago
README.license README.license: Update to reflect SPDX tag usage 4 months ago
TODO dtc: Update TODO files 12 years ago
checks.c Ignore phandle properties in /aliases 2 months ago
convert-dtsv0-lexer.l dtc: Replace GPLv2 boilerplate/reference with SPDX tags 4 months ago
data.c dtc: Replace GPLv2 boilerplate/reference with SPDX tags 4 months ago
dtc-lexer.l dtc: Replace GPLv2 boilerplate/reference with SPDX tags 4 months ago
dtc-parser.y support byacc in addition to bison 1 week ago
dtc.c dtc: Replace GPLv2 boilerplate/reference with SPDX tags 4 months ago
dtc.h dtc: Replace GPLv2 boilerplate/reference with SPDX tags 4 months ago
dtdiff dtc: Add GPLv2 SPDX tags to files missing license text 4 months ago
fdtdump.c dtc: Add GPLv2 SPDX tags to files missing license text 4 months ago
fdtget.c dtc: Replace GPLv2 boilerplate/reference with SPDX tags 4 months ago
fdtoverlay.c fdtoverlay: Return non-zero exit code if overlays can't be applied 1 month ago
fdtput.c dtc: Replace GPLv2 boilerplate/reference with SPDX tags 4 months ago
flattree.c dtc: Replace GPLv2 boilerplate/reference with SPDX tags 4 months ago
fstree.c fstree: replace lstat with stat 1 month ago
livetree.c livetree: simplify condition in get_node_by_path 2 months ago
srcpos.c dtc: Replace GPLv2 boilerplate/reference with SPDX tags 4 months ago
srcpos.h dtc: Replace GPLv2 boilerplate/reference with SPDX tags 4 months ago
treesource.c dtc: Replace GPLv2 boilerplate/reference with SPDX tags 4 months ago
util.c Use correct inttypes.h format specifier 1 week ago
util.h util: use gnu_printf format attribute 1 month ago
yamltree.c yamltree: Ensure consistent bracketing of properties with phandles 1 month ago

README

The source tree contains the Device Tree Compiler (dtc) toolchain for
working with device tree source and binary files and also libfdt, a
utility library for reading and manipulating the binary format.

DTC and LIBFDT are maintained by:

David Gibson <david@gibson.dropbear.id.au>
Jon Loeliger <jdl@jdl.com>


Python library
--------------

A Python library is also available. To build this you will need to install
swig and Python development files. On Debian distributions:

sudo apt-get install swig python3-dev

The library provides an Fdt class which you can use like this:

$ PYTHONPATH=../pylibfdt python3
>>> import libfdt
>>> fdt = libfdt.Fdt(open('test_tree1.dtb', mode='rb').read())
>>> node = fdt.path_offset('/subnode@1')
>>> print(node)
124
>>> prop_offset = fdt.first_property_offset(node)
>>> prop = fdt.get_property_by_offset(prop_offset)
>>> print('%s=%s' % (prop.name, prop.as_str()))
compatible=subnode1
>>> node2 = fdt.path_offset('/')
>>> print(fdt.getprop(node2, 'compatible').as_str())
test_tree1

You will find tests in tests/pylibfdt_tests.py showing how to use each
method. Help is available using the Python help command, e.g.:

$ cd pylibfdt
$ python3 -c "import libfdt; help(libfdt)"

If you add new features, please check code coverage:

$ sudo apt-get install python3-coverage
$ cd tests
# It's just 'coverage' on most other distributions
$ python3-coverage run pylibfdt_tests.py
$ python3-coverage html
# Open 'htmlcov/index.html' in your browser


To install the library via the normal setup.py method, use:

./pylibfdt/setup.py install [--prefix=/path/to/install_dir]

If --prefix is not provided, the default prefix is used, typically '/usr'
or '/usr/local'. See Python's distutils documentation for details. You can
also install via the Makefile if you like, but the above is more common.

To install both libfdt and pylibfdt you can use:

make install [SETUP_PREFIX=/path/to/install_dir] \
[PREFIX=/path/to/install_dir]

To disable building the python library, even if swig and Python are available,
use:

make NO_PYTHON=1


More work remains to support all of libfdt, including access to numeric
values.


Tests
-----

Test files are kept in the tests/ directory. Use 'make check' to build and run
all tests.

If you want to adjust a test file, be aware that tree_tree1.dts is compiled
and checked against a binary tree from assembler macros in trees.S. So
if you change that file you must change tree.S also.


Mailing list
------------
The following list is for discussion about dtc and libfdt implementation
mailto:devicetree-compiler@vger.kernel.org

Core device tree bindings are discussed on the devicetree-spec list:
mailto:devicetree-spec@vger.kernel.org