Go to file
Vivian Wang 52f07dcca4 dtc: Add informative error for stray identifier
When a DTS is preprocessed, sometimes the user fails to include the
correct header files, or make a spelling mistake on a macro name. This
leads to a stray identifier in the DTS, like:

  property = <1 2 FOO BAR(3, 4)>;

Give a more helpful error message than "syntax error" by recognizing and
reporting the identifier, like this:

  Lexical error: <stdin>:2.21-24 Unexpected 'FOO'

Also, treat that identifier as literal, which often helps the parser go
further and may generate more helpful error messages.

Signed-off-by: Vivian Wang <wangruikang@iscas.ac.cn>
Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
2025-07-14 18:32:02 +10:00
.github/workflows .github/workflows: update ubuntu runner to supported version 2024-11-25 12:27:23 +11:00
Documentation Remove duplicated words in documentation and comments 2025-03-14 13:48:10 +11:00
libfdt meson: use override_find_program/override_dependency 2025-06-12 15:55:00 +10:00
pylibfdt meson: port python bindings to build natively via meson and meson-python 2025-05-01 19:27:10 +07:00
scripts github: add workflow for Meson builds 2023-09-03 22:20:35 +10:00
tests Use __ASSEMBLER__ instead of __ASSEMBLY__ 2025-03-14 13:51:31 +11:00
.clang-format Add clang-format config 2024-12-06 14:44:46 +11:00
.editorconfig editorconfig: use tab indentation for version.lds 2023-08-04 18:02:21 +10:00
.gitignore pylibfdt: clean up python build directory 2024-07-01 11:49:27 +10:00
BSD-2-Clause README.license: Update to reflect SPDX tag usage 2019-06-21 21:06:10 +10:00
CONTRIBUTING.md Remove duplicated words in documentation and comments 2025-03-14 13:48:10 +11:00
GPL Update the GPL2 text to the latest revision 2019-05-21 09:58:37 +10:00
Makefile meson: port python bindings to build natively via meson and meson-python 2025-05-01 19:27:10 +07: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.license Fix some typos 2025-03-14 13:50:32 +11:00
README.md Split out information for contributors to CONTRIBUTING.md 2022-07-28 16:25:56 +10:00
TODO dtc: Update TODO files 2007-12-19 08:20:26 -06:00
VERSION.txt Bump version to v1.7.2 2024-11-06 14:01:37 +11:00
checks.c checks: Fix detection of 'i2c-bus' node 2025-07-10 19:09:39 +10:00
convert-dtsv0-lexer.l convert-dtsv0: Fix signedness comparisons warning 2020-10-13 15:48:40 +11:00
data.c dtc: Add data_insert_data function 2025-06-12 16:37:31 +10:00
dtc-lexer.l dtc: Add informative error for stray identifier 2025-07-14 18:32:02 +10:00
dtc-parser.y Make name_node() xstrdup its name argument 2023-03-01 17:55:35 +11:00
dtc.c Fix some typos 2025-03-14 13:50:32 +11:00
dtc.h dtc: Add data_insert_data function 2025-06-12 16:37:31 +10:00
dtdiff dtdiff: Use input format dtb for dtbo files 2025-07-01 20:42:22 +10:00
fdtdump.c fdtdump: fix -Werror=int-to-pointer-cast 2021-08-26 10:58:26 +10:00
fdtget.c Support 'r' format for printing raw bytes with fdtget 2021-12-09 17:48:58 +11:00
fdtoverlay.c fdtoverlay: provide better error message for missing `/__symbols__` 2024-10-30 16:01:37 +11:00
fdtput.c fdtput: Fix documentation about existing nodes 2025-07-01 20:47:15 +10:00
flattree.c Fix some typos 2025-03-14 13:50:32 +11:00
fstree.c Make build_property() xstrdup its name argument 2023-03-01 17:47:27 +11:00
livetree.c srcpos: Define srcpos_free 2025-06-09 22:27:00 +10:00
meson.build meson: use override_find_program/override_dependency 2025-06-12 15:55:00 +10:00
meson_options.txt meson: port python bindings to build natively via meson and meson-python 2025-05-01 19:27:10 +07:00
pyproject.toml meson: port python bindings to build natively via meson and meson-python 2025-05-01 19:27:10 +07:00
srcpos.c srcpos: Define srcpos_free 2025-06-09 22:27:00 +10:00
srcpos.h srcpos: Define srcpos_free 2025-06-09 22:27:00 +10:00
treesource.c New helper to add markers 2025-07-02 15:46:47 +10:00
util.c Escape spaces in depfile with backslashes. 2024-10-24 15:44:47 +11:00
util.h Escape spaces in depfile with backslashes. 2024-10-24 15:44:47 +11:00
version_gen.h.in build-sys: add meson build 2020-10-21 14:36:07 +11:00
yamltree.c Fix use of <ctype.h> functions 2023-07-28 20:55:34 +10:00

README.md

Device Tree Compiler and libfdt

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:

Python library

A Python library wrapping libfdt 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

The library can be installed with pip from a local source tree:

$ pip install . [--user|--prefix=/path/to/install_dir]

Or directly from a remote git repo:

$ pip install git+git://git.kernel.org/pub/scm/utils/dtc/dtc.git@main

The install depends on libfdt shared library being installed on the host system first. Generally, using --user or --prefix is not necessary and pip will use the default location for the Python installation which varies if the user is root or not.

You can also install everything via make if you like, but pip is recommended.

To install both libfdt and pylibfdt you can use:

$ make install [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.

Mailing lists