No description
Find a file
Andre Przywara 73e0f143b7 libfdt: fdt_strerror(): Fix comparison warning
With -Wsign-compare, compilers warn about a mismatching signedness
in a comparison in fdt_strerror().

Force FDT_ERRTABSIZE to be signed (it's surely small enough to fit), so
that the types match. Also move the minus sign to errval, as this is
actually what we use in the next line.

Signed-off-by: Andre Przywara <andre.przywara@arm.com>
Message-Id: <20201001164630.4980-7-andre.przywara@arm.com>
Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
2020-10-02 10:34:18 +10:00
Documentation Fix typos in various documentation and source files 2019-05-21 10:01:01 +10:00
libfdt libfdt: fdt_strerror(): Fix comparison warning 2020-10-02 10:34:18 +10:00
pylibfdt pylibfdt: Correct the type for fdt_property_stub() 2019-10-27 17:50:53 +01:00
scripts dtc: Add GPLv2 SPDX tags to files missing license text 2019-06-21 21:06:10 +10:00
tests checks: Add interrupt provider test 2020-05-18 14:26:12 +10:00
.cirrus.yml Execute tests on FreeBSD with Cirrus CI 2020-03-04 16:40:00 +11:00
.editorconfig Add .editorconfig 2019-10-09 22:41:44 +11:00
.gitignore tests: Properly clean up .bak file from tests 2020-03-04 16:05:31 +11:00
.travis.yml travis.yml: Run tests on the non-x86 builders, too 2019-12-04 16:54:04 +11:00
BSD-2-Clause README.license: Update to reflect SPDX tag usage 2019-06-21 21:06:10 +10:00
checks.c checks: Improve i2c reg property checking 2020-06-22 17:52:50 +10:00
convert-dtsv0-lexer.l dtc: Replace GPLv2 boilerplate/reference with SPDX tags 2019-06-21 21:06:10 +10:00
data.c dtc: Replace GPLv2 boilerplate/reference with SPDX tags 2019-06-21 21:06:10 +10:00
dtc-lexer.l Remove redundant YYLOC global declaration 2020-01-16 11:00:19 +10:00
dtc-parser.y dtc: Avoid UB when shifting 2020-07-15 20:40:54 +10:00
dtc.c dtc: Replace GPLv2 boilerplate/reference with SPDX tags 2019-06-21 21:06:10 +10:00
dtc.h Fix some potential unaligned accesses in dtc 2020-04-14 15:02:51 +10:00
dtdiff dtc: Add GPLv2 SPDX tags to files missing license text 2019-06-21 21:06:10 +10:00
fdtdump.c dtc: Add GPLv2 SPDX tags to files missing license text 2019-06-21 21:06:10 +10:00
fdtget.c dtc: Replace GPLv2 boilerplate/reference with SPDX tags 2019-06-21 21:06:10 +10:00
fdtoverlay.c fdtoverlay: Return non-zero exit code if overlays can't be applied 2019-10-11 15:58:18 +11:00
fdtput.c dtc: Replace GPLv2 boilerplate/reference with SPDX tags 2019-06-21 21:06:10 +10:00
flattree.c Fix some potential unaligned accesses in dtc 2020-04-14 15:02:51 +10:00
fstree.c fstree: replace lstat with stat 2019-10-14 17:07:10 +11:00
GPL Update the GPL2 text to the latest revision 2019-05-21 09:58:37 +10:00
livetree.c livetree: simplify condition in get_node_by_path 2019-08-28 13:57:27 +10:00
Makefile Makefile: Specify cflags for libyaml 2020-08-25 12:34:18 +02:00
Makefile.convert-dtsv0 dtc: Add GPLv2 SPDX tags to files missing license text 2019-06-21 21:06:10 +10:00
Makefile.dtc dtc: Replace GPLv2 boilerplate/reference with SPDX tags 2019-06-21 21:06:10 +10:00
Makefile.utils dtc: Add GPLv2 SPDX tags to files missing license text 2019-06-21 21:06:10 +10:00
README README: update for Python 3 2019-08-29 11:06:11 +10:00
README.license README.license: Update to reflect SPDX tag usage 2019-06-21 21:06:10 +10:00
srcpos.c dtc: Replace GPLv2 boilerplate/reference with SPDX tags 2019-06-21 21:06:10 +10:00
srcpos.h dtc: Replace GPLv2 boilerplate/reference with SPDX tags 2019-06-21 21:06:10 +10:00
TODO dtc: Update TODO files 2007-12-19 08:20:26 -06:00
treesource.c dtc: Consider one-character strings as strings 2020-06-24 16:11:55 +10:00
util.c Use correct inttypes.h format specifier 2019-11-07 17:46:43 +01:00
util.h dtc: Include stdlib.h in util.h 2020-07-22 16:41:28 +10:00
yamltree.c Fix some potential unaligned accesses in dtc 2020-04-14 15:02:51 +10:00

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