zephyr/doc/build/dts/bindings.rst
Marti Bolivar eb21bd36eb doc: dts: split up bindings docs
The bindings.rst page has gotten too big. Split it up into
sub-documents to improve readability and restore maintainability.

As part of this effort, move the /zephyr,user node documentation into
its own page in the guide. This page has proven extremely difficult
for users to spot in my experience, and it's meant as a convenience,
so let's make the documentation more convenient as well.

Signed-off-by: Marti Bolivar <marti.bolivar@nordicsemi.no>
2023-01-23 07:16:04 -08:00

29 lines
819 B
ReStructuredText

.. _dt-bindings:
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 :ref:`devicetree_binding_index` for reference information on
bindings built in to Zephyr.
.. toctree::
:maxdepth: 2
bindings-intro.rst
bindings-syntax.rst
bindings-upstream.rst