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 b8d6eca782 libfdt: Allow #size-cells of 0 3 weeks ago
Documentation Fix typos in various documentation and source files 3 months ago
libfdt libfdt: Allow #size-cells of 0 3 weeks ago
pylibfdt pylibfdt: Add support for fdt_get_alias() 1 month ago
scripts dtc: Add GPLv2 SPDX tags to files missing license text 1 month ago
tests libfdt: Allow #size-cells of 0 3 weeks ago
.gitignore Add fdtoverlay to .gitignore 1 year ago
.travis.yml Add support for YAML encoded output 11 months ago
BSD-2-Clause README.license: Update to reflect SPDX tag usage 1 month ago
GPL Update the GPL2 text to the latest revision 3 months ago
Makefile Makefile: Add EXTRA_CFLAGS variable 4 weeks ago
Makefile.convert-dtsv0 dtc: Add GPLv2 SPDX tags to files missing license text 1 month ago
Makefile.dtc dtc: Replace GPLv2 boilerplate/reference with SPDX tags 1 month ago
Makefile.utils dtc: Add GPLv2 SPDX tags to files missing license text 1 month ago
README README: Add a note about test_tree1.dts 2 years ago
README.license README.license: Update to reflect SPDX tag usage 1 month ago
TODO dtc: Update TODO files 11 years ago
checks.c dtc: Replace GPLv2 boilerplate/reference with SPDX tags 1 month ago
convert-dtsv0-lexer.l dtc: Replace GPLv2 boilerplate/reference with SPDX tags 1 month ago
data.c dtc: Replace GPLv2 boilerplate/reference with SPDX tags 1 month ago
dtc-lexer.l dtc: Replace GPLv2 boilerplate/reference with SPDX tags 1 month ago
dtc-parser.y dtc: Replace GPLv2 boilerplate/reference with SPDX tags 1 month ago
dtc.c dtc: Replace GPLv2 boilerplate/reference with SPDX tags 1 month ago
dtc.h dtc: Replace GPLv2 boilerplate/reference with SPDX tags 1 month ago
dtdiff dtc: Add GPLv2 SPDX tags to files missing license text 1 month ago
fdtdump.c dtc: Add GPLv2 SPDX tags to files missing license text 1 month ago
fdtget.c dtc: Replace GPLv2 boilerplate/reference with SPDX tags 1 month ago
fdtoverlay.c fdtoverlay: Rework output allocation 1 month ago
fdtput.c dtc: Replace GPLv2 boilerplate/reference with SPDX tags 1 month ago
flattree.c dtc: Replace GPLv2 boilerplate/reference with SPDX tags 1 month ago
fstree.c dtc: Replace GPLv2 boilerplate/reference with SPDX tags 1 month ago
livetree.c dtc: Replace GPLv2 boilerplate/reference with SPDX tags 1 month ago
srcpos.c dtc: Replace GPLv2 boilerplate/reference with SPDX tags 1 month ago
srcpos.h dtc: Replace GPLv2 boilerplate/reference with SPDX tags 1 month ago
treesource.c dtc: Replace GPLv2 boilerplate/reference with SPDX tags 1 month ago
util.c dtc: Replace GPLv2 boilerplate/reference with SPDX tags 1 month ago
util.h dtc: Replace GPLv2 boilerplate/reference with SPDX tags 1 month ago
yamltree.c dtc: Replace GPLv2 boilerplate/reference with SPDX tags 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 python-dev

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

$ PYTHONPATH=../pylibfdt python
>>> import libfdt
>>> fdt = libfdt.Fdt(open('test_tree1.dtb').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=%r' % (prop.name, prop.value)
compatible=bytearray(b'subnode1\x00')
>>> print '%s=%s' % (prop.name, prop.value)
compatible=subnode1
>>> node2 = fdt.path_offset('/')
>>> print fdt.getprop(node2, 'compatible')
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
$ python -c "import libfdt; help(libfdt)"

If you add new features, please check code coverage:

$ sudo apt-get install python-pip python-pytest
$ sudo pip install coverage
$ cd tests
$ coverage run pylibfdt_tests.py
$ coverage html
# Open 'htmlcov/index.html' in your browser


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

./pylibfdt/setup.py [--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