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.
Rob Herring 87963ee206 livetree: add missing type markers in generated overlay properties 4 weeks ago
Documentation Fix typos in various documentation and source files 3 weeks ago
libfdt Fix typos in various documentation and source files 3 weeks ago
pylibfdt Use Python3 by default 2 months ago
scripts dtc: Add maintainer script for signing and upload to kernel.org 4 years ago
tests Fix typos in various documentation and source files 3 weeks ago
.gitignore Add fdtoverlay to .gitignore 1 year ago
.travis.yml Add support for YAML encoded output 9 months ago
GPL Update the GPL2 text to the latest revision 3 weeks ago
Makefile Fix bogus error on rebuild 1 month ago
Makefile.convert-dtsv0 Implement and use an xstrdup() function 10 years ago
Makefile.dtc Add support for YAML encoded output 9 months ago
Makefile.utils fdtoverlay: A tool that applies overlays 2 years ago
README README: Add a note about test_tree1.dts 1 year ago
README.license Fix typos in various documentation and source files 3 weeks ago
TODO dtc: Update TODO files 11 years ago
checks.c Avoid assertion in check_interrupts_property() 1 month ago
convert-dtsv0-lexer.l Fix assorted sparse warnings 2 years ago
data.c Kill bogus TYPE_BLOB marker type 9 months ago
dtc-lexer.l Merge nodes with local target label references 8 months ago
dtc-parser.y annotations: add positions 6 months ago
dtc.c annotations: add the annotation functionality 6 months ago
dtc.h livetree: add missing type markers in generated overlay properties 3 days ago
dtdiff dtc: Add code to make diffing trees easier 8 years ago
fdtdump.c Use PRIxPTR for printing uintptr_t values 5 months ago
fdtget.c libfdt: Add helpers for accessing unaligned words 11 months ago
fdtoverlay.c Use size_t for blob lengths in utilfdt_read* 1 year ago
fdtput.c Consolidate utilfdt_read_len() variants 1 year ago
flattree.c Fix typos in various documentation and source files 3 weeks ago
fstree.c annotations: add positions 6 months ago
livetree.c livetree: add missing type markers in generated overlay properties 3 days ago
srcpos.c annotations: add the annotation functionality 6 months ago
srcpos.h annotations: add the annotation functionality 6 months ago
treesource.c annotations: add the annotation functionality 6 months ago
util.c util: Add xa{v}sprintf_append functions 6 months ago
util.h Fix typos in various documentation and source files 3 weeks ago
yamltree.c Add support for YAML encoded output 9 months 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