zephyr/doc/guides/dts/index.rst

.. _dt-guide:

Devicetree Guide
################

This is a high-level guide to devicetree as it is used for Zephyr development.
See :ref:`devicetree` for reference material.

.. toctree::
   :maxdepth: 2

   intro.rst
   design.rst
   bindings.rst
   api-usage.rst
   howtos.rst
   dt-vs-kconfig.rst
doc: dts: revisit documentation 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> 2020-03-11 09:16:25 +08:00			`.. _dt-guide:`
doc: Add Device Tree documentation This patch adds documention for device tree development in Zephyr. This includes a description of device tree, how it is integrated into Zephyr, and other related information. Signed-off-by: Andy Gross <andy.gross@linaro.org> 2017-05-24 13:24:50 +08:00
doc: dts: revisit documentation 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> 2020-03-11 09:16:25 +08:00			`Devicetree Guide`
			`################`
doc: Add Device Tree documentation This patch adds documention for device tree development in Zephyr. This includes a description of device tree, how it is integrated into Zephyr, and other related information. Signed-off-by: Andy Gross <andy.gross@linaro.org> 2017-05-24 13:24:50 +08:00
doc: devicetree: reorganize a bit Rework some section titles and separate the API into its own sub-page in the reference section. This is prep work for adding generated reference material on devicetree bindings. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no> 2020-10-08 03:39:32 +08:00			`This is a high-level guide to devicetree as it is used for Zephyr development.`
			See :ref:`devicetree` for reference material.
doc: Add Device Tree documentation This patch adds documention for device tree development in Zephyr. This includes a description of device tree, how it is integrated into Zephyr, and other related information. Signed-off-by: Andy Gross <andy.gross@linaro.org> 2017-05-24 13:24:50 +08:00
doc: split devicetree docs into multiple pages The one page on devicetree is too long. Split it into multiple pages to make it easier to digest and more squintable. This is basically just moving content around; minimal changes have been made apart from redoing some transitions and adding a couple of introductory paragraphs. Rename the 'device-tree' Sphinx :ref: target while we are here. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no> 2020-02-19 06:05:58 +08:00			`.. toctree::`
			`:maxdepth: 2`
doc: dts: describe nexus node magic required for shield gpio translation Document why and how we use the devicetree nexus map properties to preserve devicetree flag specifications. Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no> 2019-10-18 05:47:44 +08:00
doc: split devicetree docs into multiple pages The one page on devicetree is too long. Split it into multiple pages to make it easier to digest and more squintable. This is basically just moving content around; minimal changes have been made apart from redoing some transitions and adding a couple of introductory paragraphs. Rename the 'device-tree' Sphinx :ref: target while we are here. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no> 2020-02-19 06:05:58 +08:00			`intro.rst`
doc: dts: add design goals defining the scope of DT Add a page describing the high-level design goals for how Zephyr should use DT, with examples and counter-examples from current practice. Add a TBD section for code generation. It's not clear (to me at least) where the discussion on that has landed. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no> 2020-02-19 09:28:41 +08:00			`design.rst`
doc: split devicetree docs into multiple pages The one page on devicetree is too long. Split it into multiple pages to make it easier to digest and more squintable. This is basically just moving content around; minimal changes have been made apart from redoing some transitions and adding a couple of introductory paragraphs. Rename the 'device-tree' Sphinx :ref: target while we are here. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no> 2020-02-19 06:05:58 +08:00			`bindings.rst`
doc: dts: revisit documentation 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> 2020-03-11 09:16:25 +08:00			`api-usage.rst`
doc: split devicetree docs into multiple pages The one page on devicetree is too long. Split it into multiple pages to make it easier to digest and more squintable. This is basically just moving content around; minimal changes have been made apart from redoing some transitions and adding a couple of introductory paragraphs. Rename the 'device-tree' Sphinx :ref: target while we are here. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no> 2020-02-19 06:05:58 +08:00			`howtos.rst`
			`dt-vs-kconfig.rst`