Device tree is a tree structured data describes devices on a board. This is used by operating system's kernel in order to manage a computer hardware components including cpus, buses and external peripherals.
A device tree bindings file offers information about the properties supported by Linux kernel device tree blob.
Location for this documents is under Documentation/devicetree/bindings/
.
1 contributor medium-size (175hours)
Level of difficulty: Intermediate
Historically device tree bindings were written in plain .txt
files. These files serve only as documentation but they cannot really be used to validate the syntax used in device tree files.
In order to improve validation of dts files, Linux kernel switched to writing device tree bindings using json-schema.
The goal of the project is to convert as much .txt
files into .yaml
json-schema files.
$ linux/Documentation/devicetree/bindings$ find . -name '*.txt' | wc -l
1795
You can have a look at this example of a conversion patch looks like.
Before writing your proposal you need to:
.txt
file to yaml
How to create a small patch?
Documentation/devicetree/bindings
.txt
file and convert it to yamlDesired knowledge: C, shell scripting, make, git
Code license: GPL-2.0-only OR BSD-2-Clause
The project is considered successful if the code is accepted into mainline Linux kernel tree.
Mentor: Daniel Baluta daniel.baluta@nxp.com