This is the documentation for the latest (main) development branch of Zephyr. If you are looking for the documentation of previous releases, use the drop-down menu on the left and select the desired version.

Devicetree bindings

A devicetree on its own is only half the story for describing hardware, as it is a relatively unstructured format. Devicetree bindings provide the other half.

A devicetree binding declares requirements on the contents of nodes, and provides semantic information about the contents of valid nodes. Zephyr devicetree bindings are YAML files in a custom format (Zephyr does not use the dt-schema tools used by the Linux kernel).

These pages introduce bindings, describe what they do, note where they are found, and explain their data format.

Note

See the Bindings index for reference information on bindings built in to Zephyr.

• Introduction to Devicetree Bindings
  • A simple example
  • What the build system does with bindings
  • Other ways nodes are matched to bindings
  • Where bindings are located
• Devicetree bindings syntax
  • Top level keys
  • Description
  • Compatible
  • Properties
  • Child-binding
  • Bus
  • On-bus
  • Specifier cell names (*-cells)
  • Include
  • Nexus nodes and maps
• Rules for upstream bindings
  • Always check for existing bindings
  • General rules
  • Rules for vendor prefixes
  • Rules for default values
  • The zephyr, prefix