Main GSoC Linux Foundation page: How to apply, deadlines, other workgroups, ...

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/ d

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 .

Tips for writing a good proposal:

• understand basic concepts about writing a device tree binding file. Look here and here .
• demonstrate the knowledge by writing a small patch to convert a .txt file to yaml.
  • start with small and simple .txt file and convert it to yaml
  • create a a small patch and review it with the mentor
  • verify the patch:
    • make dt_binding_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/trivial-devices.yaml
    • make dtbs_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/trivial-devices.yaml
  • send the patch to Linux kernel mailing list and work with the community to get it merged
• before submitting the proposal discuss with the mentor about a plan and a set of .txt files to work on

Code license: GPL-2.0 OR BSD-3-Clause

The project is considered successful if the code is accepted into mainline Linux kernel tree.

Mentor: Daniel Baluta daniel.baluta@nxp.com