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 e671852042 checks: add aliases node checks 7 years ago
Documentation fdtoverlay: A tool that applies overlays 8 years ago
libfdt implement strnlen for systems that need it 7 years ago
pylibfdt pylibfdt: Use Python2 explicitly 7 years ago
scripts dtc: Add maintainer script for signing and upload to kernel.org 10 years ago
tests checks: add string list check for *-names properties 7 years ago
.gitignore Add fdtoverlay to .gitignore 7 years ago
.travis.yml Add Coverity Scan support 8 years ago
GPL dtc: Remove redundant copy of the GPL 18 years ago
Makefile dtc: Bump version to v1.4.5 7 years ago
Makefile.convert-dtsv0 Implement and use an xstrdup() function 16 years ago
Makefile.dtc Implement and use an xstrdup() function 16 years ago
Makefile.utils fdtoverlay: A tool that applies overlays 8 years ago
README README: Add a note about test_tree1.dts 7 years ago
README.license dtc/libfdt: Add README clarifying licensing 17 years ago
TODO dtc: Update TODO files 17 years ago
checks.c checks: add aliases node checks 7 years ago
convert-dtsv0-lexer.l Fix assorted sparse warnings 8 years ago
data.c Fix assorted sparse warnings 8 years ago
dtc-lexer.l Clean up gcc attributes 8 years ago
dtc-parser.y Fix ambiguous grammar for devicetree rule 7 years ago
dtc.c livetree: avoid assertion of orphan phandles with overlays 7 years ago
dtc.h Fix ambiguous grammar for devicetree rule 7 years ago
dtdiff dtc: Add code to make diffing trees easier 14 years ago
fdtdump.c fdtdump: Discourage use of fdtdump 8 years ago
fdtget.c fdtget: Split out cell list display into a new function 7 years ago
fdtoverlay.c fdtoverlay: Sanity check blob size 7 years ago
fdtput.c Remove leading underscores from identifiers 7 years ago
flattree.c Add strstarts() helper function 7 years ago
fstree.c Rename boot_info 8 years ago
livetree.c Fix ambiguous grammar for devicetree rule 7 years ago
srcpos.c dtc: pos parameter to srcpos_string() can't be NULL 8 years ago
srcpos.h Remove leading underscores from identifiers 7 years ago
treesource.c Fix assorted sparse warnings 8 years ago
util.c Fix assorted sparse warnings 8 years ago
util.h Remove leading underscores from identifiers 7 years 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