gsoc:2023-gsoc-device-tree-bindings

This is an old revision of the document!


GSoC 2023: Device tree bindings

Device tree

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.

Device tree bindings

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

Proposal 1: Convert device tree bindings to DT schema

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 .

Some tips for working on this: * understand basic concepts about writing a device tree binding file * start with small and simple .txt files * verify your converted .yaml file

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

How do I get started?

gsoc/2023-gsoc-device-tree-bindings.1676280639.txt.gz · Last modified: 2023/02/13 09:30 by dbaluta