summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorPetr Kubizňák <kubiznak@2n.com>2023-05-09 16:03:58 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2023-05-26 17:32:50 +0100
commit4417a30196b0cac1d9dc83b23e7fd5719b8ebc2d (patch)
tree6ef1f651e33d31f5cbadd16a1467f8ce324f9418 /documentation/ref-manual
parentfd567483808bca68048bcba098703cf7c51b9946 (diff)
downloadpoky-4417a30196b0cac1d9dc83b23e7fd5719b8ebc2d.tar.gz
ref-manual: document devicetree class variables
Document the newly added DT_FILES variable and closely related DT_FILES_PATH. Also add DT_PADDING_SIZE to the glossary. (From yocto-docs rev: 8f3f187e2353c718c6fb4e224d13ba559ad2f85b) Signed-off-by: Petr Kubizňák <kubiznak@2n.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/classes.rst9
-rw-r--r--documentation/ref-manual/variables.rst22
2 files changed, 29 insertions, 2 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index ab1628401e..94b6a3ebd7 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -607,10 +607,15 @@ subdirectory. This avoids clashes with the :ref:`ref-classes-kernel-devicetree`
607output. Additionally, the device trees are populated into the sysroot for 607output. Additionally, the device trees are populated into the sysroot for
608access via the sysroot from within other recipes. 608access via the sysroot from within other recipes.
609 609
610By default, all device tree sources located in :term:`DT_FILES_PATH` directory
611are compiled. To select only particular sources, set :term:`DT_FILES` to
612a space-separated list of files (relative to :term:`DT_FILES_PATH`). For
613convenience, both ``.dts`` and ``.dtb`` extensions can be used.
614
610An extra padding is appended to non-overlay device trees binaries. This 615An extra padding is appended to non-overlay device trees binaries. This
611can typically be used as extra space for adding extra properties at boot time. 616can typically be used as extra space for adding extra properties at boot time.
612The padding size can be modified by setting ``DT_PADDING_SIZE`` to the desired 617The padding size can be modified by setting :term:`DT_PADDING_SIZE`
613size, in bytes. 618to the desired size, in bytes.
614 619
615See :oe_git:`devicetree.bbclass sources 620See :oe_git:`devicetree.bbclass sources
616</openembedded-core/tree/meta/classes-recipe/devicetree.bbclass>` 621</openembedded-core/tree/meta/classes-recipe/devicetree.bbclass>`
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 6ee65e1788..4b69843d4d 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -2247,6 +2247,28 @@ system and gives an overview of their function and contents.
2247 For information on policies and on how to use this variable, see the 2247 For information on policies and on how to use this variable, see the
2248 comments in the ``meta/classes-recipe/compress_doc.bbclass`` file. 2248 comments in the ``meta/classes-recipe/compress_doc.bbclass`` file.
2249 2249
2250 :term:`DT_FILES`
2251 Space-separated list of device tree source files to compile using
2252 a recipe that inherits the :ref:`ref-classes-devicetree` class. These
2253 are relative to the :term:`DT_FILES_PATH`.
2254
2255 For convenience, both ``.dts`` and ``.dtb`` extensions can be used.
2256
2257 Use an empty string (default) to build all device tree sources within
2258 the :term:`DT_FILES_PATH` directory.
2259
2260 :term:`DT_FILES_PATH`
2261 When compiling out-of-tree device tree sources using a recipe that
2262 inherits the :ref:`ref-classes-devicetree` class, this variable specifies
2263 the path to the directory containing dts files to build.
2264
2265 Defaults to the :term:`S` directory.
2266
2267 :term:`DT_PADDING_SIZE`
2268 When inheriting the :ref:`ref-classes-devicetree` class, this variable
2269 specifies the size of padding appended to the device tree blob, used as
2270 extra space typically for additional properties during boot.
2271
2250 :term:`EFI_PROVIDER` 2272 :term:`EFI_PROVIDER`
2251 When building bootable images (i.e. where ``hddimg``, ``iso``, or 2273 When building bootable images (i.e. where ``hddimg``, ``iso``, or
2252 ``wic.vmdk`` is in :term:`IMAGE_FSTYPES`), the 2274 ``wic.vmdk`` is in :term:`IMAGE_FSTYPES`), the