diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2023-05-11 19:46:25 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2023-05-26 17:32:51 +0100 |
commit | 7475d86c18b15e66ce08359aa6ad00d49de668dc (patch) | |
tree | d849d9d852d0df53ef95ed50c1978a47b590c99e /documentation/ref-manual | |
parent | e3b7b2225578671603363789620d3f7802b88980 (diff) | |
download | poky-7475d86c18b15e66ce08359aa6ad00d49de668dc.tar.gz |
ref-manual: improve documentation for kernel-devicetree class
- Document the new KERNEL_DTBDEST and KERNEL_DTBVENDORED variables
- Also document the related KERNEL_DEVICETREE_BUNDLE
and KERNEL_PACKAGE_NAME variables
(From yocto-docs rev: 19f128e725da35234ec2c234c667ee7ff3d67d8d)
Signed-off-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.rst | 8 | ||||
-rw-r--r-- | documentation/ref-manual/variables.rst | 35 |
2 files changed, 43 insertions, 0 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 78174d51d1..e454a54537 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst | |||
@@ -1576,6 +1576,14 @@ Linux kernel compilation (including modules). | |||
1576 | The :ref:`ref-classes-kernel-devicetree` class, which is inherited by the | 1576 | The :ref:`ref-classes-kernel-devicetree` class, which is inherited by the |
1577 | :ref:`ref-classes-kernel` class, supports device tree generation. | 1577 | :ref:`ref-classes-kernel` class, supports device tree generation. |
1578 | 1578 | ||
1579 | Its behavior is mainly controlled by the following variables: | ||
1580 | |||
1581 | - :term:`KERNEL_DEVICETREE_BUNDLE`: whether to bundle the kernel and device tree | ||
1582 | - :term:`KERNEL_DTBDEST`: directory where to install DTB files | ||
1583 | - :term:`KERNEL_DTBVENDORED`: whether to keep vendor subdirectories | ||
1584 | - :term:`KERNEL_DTC_FLAGS`: flags for ``dtc``, the Device Tree Compiler | ||
1585 | - :term:`KERNEL_PACKAGE_NAME`: base name of the kernel packages | ||
1586 | |||
1579 | .. _ref-classes-kernel-fitimage: | 1587 | .. _ref-classes-kernel-fitimage: |
1580 | 1588 | ||
1581 | ``kernel-fitimage`` | 1589 | ``kernel-fitimage`` |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index b7829ae7af..e213478326 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -4451,6 +4451,16 @@ system and gives an overview of their function and contents. | |||
4451 | In order to use this variable, the :ref:`ref-classes-kernel-devicetree` | 4451 | In order to use this variable, the :ref:`ref-classes-kernel-devicetree` |
4452 | class must be inherited. | 4452 | class must be inherited. |
4453 | 4453 | ||
4454 | :term:`KERNEL_DEVICETREE_BUNDLE` | ||
4455 | When set to "1", this variable allows to bundle the Linux kernel | ||
4456 | and the Device Tree Binary together in a single file. | ||
4457 | |||
4458 | This feature is currently only supported on the "arm" (32 bit) | ||
4459 | architecture. | ||
4460 | |||
4461 | This variable is set to "0" by default by the | ||
4462 | :ref:`ref-classes-kernel-devicetree` class. | ||
4463 | |||
4454 | :term:`KERNEL_DTB_LINK_NAME` | 4464 | :term:`KERNEL_DTB_LINK_NAME` |
4455 | The link name of the kernel device tree binary (DTB). This variable | 4465 | The link name of the kernel device tree binary (DTB). This variable |
4456 | is set in the ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as | 4466 | is set in the ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as |
@@ -4476,6 +4486,23 @@ system and gives an overview of their function and contents. | |||
4476 | 4486 | ||
4477 | See :term:`KERNEL_ARTIFACT_NAME` for additional information. | 4487 | See :term:`KERNEL_ARTIFACT_NAME` for additional information. |
4478 | 4488 | ||
4489 | :term:`KERNEL_DTBDEST` | ||
4490 | This variable, used by the :ref:`ref-classes-kernel-devicetree` | ||
4491 | class, allows to change the installation directory of the DTB | ||
4492 | (Device Tree Binary) files. | ||
4493 | |||
4494 | It is set by default to "${KERNEL_IMAGEDEST}" by the | ||
4495 | :ref:`ref-classes-kernel` class. | ||
4496 | |||
4497 | :term:`KERNEL_DTBVENDORED` | ||
4498 | This variable, used by the :ref:`ref-classes-kernel-devicetree`, | ||
4499 | allows to ignore vendor subdirectories when installing DTB | ||
4500 | (Device Tree Binary) files, when it is set to "false". | ||
4501 | |||
4502 | To keep vendor subdirectories, set this variable to "true". | ||
4503 | |||
4504 | It is set by default to "false" by the :ref:`ref-classes-kernel` class. | ||
4505 | |||
4479 | :term:`KERNEL_DTC_FLAGS` | 4506 | :term:`KERNEL_DTC_FLAGS` |
4480 | Specifies the ``dtc`` flags that are passed to the Linux kernel build | 4507 | Specifies the ``dtc`` flags that are passed to the Linux kernel build |
4481 | system when generating the device trees (via ``DTC_FLAGS`` environment | 4508 | system when generating the device trees (via ``DTC_FLAGS`` environment |
@@ -4624,6 +4651,14 @@ system and gives an overview of their function and contents. | |||
4624 | provide those module configurations, see the | 4651 | provide those module configurations, see the |
4625 | :term:`module_conf_* <module_conf>` variable. | 4652 | :term:`module_conf_* <module_conf>` variable. |
4626 | 4653 | ||
4654 | :term:`KERNEL_PACKAGE_NAME` | ||
4655 | Specifies the base name of the kernel packages, such as "kernel" | ||
4656 | in the kernel packages such as "kernel-modules", "kernel-image" and | ||
4657 | "kernel-dbg". | ||
4658 | |||
4659 | The default value for this variable is set to "kernel" by the | ||
4660 | :ref:`ref-classes-kernel` class. | ||
4661 | |||
4627 | :term:`KERNEL_PATH` | 4662 | :term:`KERNEL_PATH` |
4628 | The location of the kernel sources. This variable is set to the value | 4663 | The location of the kernel sources. This variable is set to the value |
4629 | of the :term:`STAGING_KERNEL_DIR` within the :ref:`ref-classes-module` | 4664 | of the :term:`STAGING_KERNEL_DIR` within the :ref:`ref-classes-module` |