mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-09-03 05:01:56 +00:00
6e57b42758
This is joint work with Kumar Gala (see signed-off-by). Document the changes to the generated node macros in macros.bnf, moving the old file to legacy-macros.bnf and putting it in its own section. The actual generated macros are now a low-level detail, so rewrite the foregoing sections as examples in terms of the new <devicetree.h> APIs. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no> Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
32 lines
821 B
ReStructuredText
32 lines
821 B
ReStructuredText
.. _dt-guide:
|
|
|
|
Devicetree Guide
|
|
################
|
|
|
|
A *devicetree* is a hierarchical data structure which describes hardware\
|
|
[#dt_spelling]_. The `Devicetree specification`_ fully defines its source and
|
|
binary representations. Zephyr uses devicetree to describe the hardware
|
|
available on its :ref:`boards`, as well as that hardware's initial
|
|
configuration.
|
|
|
|
This page is the index for a guide to devicetree and how to use it in Zephyr.
|
|
For an API reference, see :ref:`devicetree_api`.
|
|
|
|
.. _Devicetree specification: https://www.devicetree.org/
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
intro.rst
|
|
design.rst
|
|
bindings.rst
|
|
api-usage.rst
|
|
legacy-macros.rst
|
|
howtos.rst
|
|
dt-vs-kconfig.rst
|
|
|
|
.. rubric:: Footnotes
|
|
|
|
.. [#dt_spelling] Note that "devicetree" (without spaces) is preferred to
|
|
"device tree".
|