b141c72a2a
Phandles, specifier spaces, and cell names are simultaneously extremely common and woefully underdocumented. Address that by: - reworking our existing documentation on these subjects in bindings-syntax.rst, fixing missing information in the property syntax template as well - adding a standalone guide which describes how all the pieces fit together, providing a bridge for the gap between DTS/bindings and C APIs My goal is not to eventually make this a comprehensive place where *all* specifier spaces are documented. It would be better (more scalable, more discoverable) to improve the individual API pages to cover the devicetree-related conventions that apply in each case. That's a problem for someone else and another day, but we do need a few concrete references in the DTS guides to keep the motivation clear. Signed-off-by: Marti Bolivar <marti.bolivar@nordicsemi.no>
55 lines
1.1 KiB
ReStructuredText
55 lines
1.1 KiB
ReStructuredText
.. _devicetree:
|
|
|
|
Devicetree
|
|
##########
|
|
|
|
A *devicetree* is a hierarchical data structure primarily used to describe
|
|
hardware. Zephyr uses devicetree in two main ways:
|
|
|
|
- to describe hardware to the :ref:`device_model_api`
|
|
- to provide that hardware's initial configuration
|
|
|
|
This page links to a high level guide on devicetree as well as reference
|
|
material.
|
|
|
|
.. _dt-guide:
|
|
|
|
Devicetree Guide
|
|
****************
|
|
|
|
The pages in this section are a high-level guide to using devicetree for Zephyr
|
|
development.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
intro.rst
|
|
design.rst
|
|
bindings.rst
|
|
api-usage.rst
|
|
phandles.rst
|
|
zephyr-user-node.rst
|
|
howtos.rst
|
|
troubleshooting.rst
|
|
dt-vs-kconfig.rst
|
|
|
|
.. _dt-reference:
|
|
|
|
Devicetree Reference
|
|
********************
|
|
|
|
These pages contain reference material for Zephyr's devicetree APIs and
|
|
built-in bindings.
|
|
|
|
For the platform-independent details, see the `Devicetree specification`_.
|
|
|
|
.. _Devicetree specification: https://www.devicetree.org/
|
|
|
|
.. We use ":glob:" with "*" here to add the generated bindings page.
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
:glob:
|
|
|
|
api/*
|