OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/doc/reference/devicetree/index.rst

18 lines
408 B
ReStructuredText
Raw Normal View History

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
.. _devicetree:
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
##########
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 reference documentation for devicetree as it is used for Zephyr
development. For a high-level guide, see :ref:`dt-guide`. For a
platform-independent specification, see the `Devicetree specification`_.
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
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
.. _Devicetree specification: https://www.devicetree.org/
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
doc: reference: add devicetree bindings content Add generated documentation content for known devicetree bindings using the Binding abstraction which was just added to edtlib. This works similarly to the way Kconfig content is generated, so extract a bit of common helper code for doing that out and rename the relevant files to keep the distinction clear. Make the documentation build system respect a preset DTS_ROOT. In this way, out of tree bindings can be added to the generated content by telling the documentation build system where to find them, identically to how out of tree bindings can be added to a Zephyr application. Similarly, make the output directory configurable. Fixes: #28865 Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-10-13 02:02:46 +08:00
.. We use ":glob:" with "*" here to add the generated bindings page.
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
.. toctree::
:glob:
doc: write documentation about DT-based device instantiation Add more HOWTO information for the two current devicetree-based device instantiation styles, and a bit more information on how to create devices that depend on others. Point to this from the Kconfig tips page, since it is meant as a replacement for existing Kconfig practice. Update macros.bnf. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-05-02 01:54:26 +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
*