From patchwork Fri May 12 09:51:13 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 23870 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 0AA5BC77B7F for ; Fri, 12 May 2023 09:51:22 +0000 (UTC) Received: from relay8-d.mail.gandi.net (relay8-d.mail.gandi.net [217.70.183.201]) by mx.groups.io with SMTP id smtpd.web11.20002.1683885079094263652 for ; Fri, 12 May 2023 02:51:19 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=Sxf6rZb8; spf=pass (domain: bootlin.com, ip: 217.70.183.201, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id 9FB471BF20B; Fri, 12 May 2023 09:51:16 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1683885076; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=9I3R/uFVGfVTBSmORqcaTQdgWvMUtZ0lLPy/QoDfMkI=; b=Sxf6rZb82ukohVdhaFtQ/Yba7L/ZOm3UgzEjKowIlwI9TntKFXFgWiEecevkHxg4E3LmqS MrB3mjvu72TQpS7SghNninaCYUxcACzz4Fa0OOj9HN2+R17bNXCT80uh8i2qfpA+suH72O BFoUlQz54jfwJs7jaTgxHDAL4lCNevusyG5r+8XFTE7isVIhdYzDl6bjz9YyMmpbcKkuOp Br/I+zgTUcOX2LzegxmViQtKKZUaffchSxe7EFQbPWx1l/cqPp6XcLqT67DNUF6kHdClqr 01eCV5pg23e8/TeYr/2108oRiXOteTzAeqFeX0oLDwFr0aAVu4uRHEWghqyPGQ== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker Subject: [PATCH v2] ref-manual: improve documentation for kernel-devicetree class Date: Fri, 12 May 2023 11:51:13 +0200 Message-Id: <20230512095113.2424927-1-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <175E5C355FC6E096.27409@lists.yoctoproject.org> References: <175E5C355FC6E096.27409@lists.yoctoproject.org> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 12 May 2023 09:51:22 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3941 From: Michael Opdenacker - Document the new KERNEL_DTBDEST and KERNEL_DTBVENDORED variables - Also document the related KERNEL_DEVICETREE_BUNDLE and KERNEL_PACKAGE_NAME variables Signed-off-by: Michael Opdenacker --- Changes in V2: - Mention that KERNEL_DEVICETREE_BUNDLE is only supported on 32 bit ARM --- documentation/ref-manual/classes.rst | 8 ++++++ documentation/ref-manual/variables.rst | 35 ++++++++++++++++++++++++++ 2 files changed, 43 insertions(+) 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). The :ref:`ref-classes-kernel-devicetree` class, which is inherited by the :ref:`ref-classes-kernel` class, supports device tree generation. +Its behavior is mainly controlled by the following variables: + +- :term:`KERNEL_DEVICETREE_BUNDLE`: whether to bundle the kernel and device tree +- :term:`KERNEL_DTBDEST`: directory where to install DTB files +- :term:`KERNEL_DTBVENDORED`: whether to keep vendor subdirectories +- :term:`KERNEL_DTC_FLAGS`: flags for ``dtc``, the Device Tree Compiler +- :term:`KERNEL_PACKAGE_NAME`: base name of the kernel packages + .. _ref-classes-kernel-fitimage: ``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. In order to use this variable, the :ref:`ref-classes-kernel-devicetree` class must be inherited. + :term:`KERNEL_DEVICETREE_BUNDLE` + When set to "1", this variable allows to bundle the Linux kernel + and the Device Tree Binary together in a single file. + + This feature is currently only supported on the "arm" (32 bit) + architecture. + + This variable is set to "0" by default by the + :ref:`ref-classes-kernel-devicetree` class. + :term:`KERNEL_DTB_LINK_NAME` The link name of the kernel device tree binary (DTB). This variable 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. See :term:`KERNEL_ARTIFACT_NAME` for additional information. + :term:`KERNEL_DTBDEST` + This variable, used by the :ref:`ref-classes-kernel-devicetree` + class, allows to change the installation directory of the DTB + (Device Tree Binary) files. + + It is set by default to "${KERNEL_IMAGEDEST}" by the + :ref:`ref-classes-kernel` class. + + :term:`KERNEL_DTBVENDORED` + This variable, used by the :ref:`ref-classes-kernel-devicetree`, + allows to ignore vendor subdirectories when installing DTB + (Device Tree Binary) files, when it is set to "false". + + To keep vendor subdirectories, set this variable to "true". + + It is set by default to "false" by the :ref:`ref-classes-kernel` class. + :term:`KERNEL_DTC_FLAGS` Specifies the ``dtc`` flags that are passed to the Linux kernel build system when generating the device trees (via ``DTC_FLAGS`` environment @@ -4624,6 +4651,14 @@ system and gives an overview of their function and contents. provide those module configurations, see the :term:`module_conf_* ` variable. + :term:`KERNEL_PACKAGE_NAME` + Specifies the base name of the kernel packages, such as "kernel" + in the kernel packages such as "kernel-modules", "kernel-image" and + "kernel-dbg". + + The default value for this variable is set to "kernel" by the + :ref:`ref-classes-kernel` class. + :term:`KERNEL_PATH` The location of the kernel sources. This variable is set to the value of the :term:`STAGING_KERNEL_DIR` within the :ref:`ref-classes-module`