From patchwork Wed May 14 18:50:45 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: AdrianF X-Patchwork-Id: 62958 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 074ABC3ABDA for ; Wed, 14 May 2025 18:53:23 +0000 (UTC) Received: from mta-64-228.siemens.flowmailer.net (mta-64-228.siemens.flowmailer.net [185.136.64.228]) by mx.groups.io with SMTP id smtpd.web10.109891.1747248795566885635 for ; Wed, 14 May 2025 11:53:15 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=adrian.freihofer@siemens.com header.s=fm1 header.b=U6jaU0AR; spf=pass (domain: rts-flowmailer.siemens.com, ip: 185.136.64.228, mailfrom: fm-1329275-20250514185312137207b5cd9eb22787-ol_0y1@rts-flowmailer.siemens.com) Received: by mta-64-228.siemens.flowmailer.net with ESMTPSA id 20250514185312137207b5cd9eb22787 for ; Wed, 14 May 2025 20:53:13 +0200 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; s=fm1; d=siemens.com; i=adrian.freihofer@siemens.com; h=Date:From:Subject:To:Message-ID:MIME-Version:Content-Type:Content-Transfer-Encoding:Cc:References:In-Reply-To; bh=AcvuOY2g3YF2/NGw1sTjLx/jnbsuEvLASeaPQT2Jegc=; b=U6jaU0ARtjqS5Tq+77T4tQ26+Qbly5FZRo8f9ejEa1qVQ1mZ+XDsCoDNJNHyJAFr5lsqFH QqpmP0kplQVIMeH7jEYteSEM5OUdPPbhYxzkZ06SgoUQametHviv0QmyazHoZO+AWphd8kGz 2xqYISAdircmYkyeTh6eHnRbrpU55LjNkTrjvs5WkKHQ/Qo53/OwtH05QlOdGdSuWHPRVjSj Dh8z8qXvNmFowkl90rMrcH7KCzEg5wB/IIsauNf6Yn+1n6R27U1tVo6xUnuS4RGVfsgrVmjF vf+oAg9AfZHVPp+r9F2KOK5DPaig8vVhZGfPLJjz778MZs3OtYlk36Bg==; From: AdrianF To: openembedded-core@lists.openembedded.org Cc: marex@denx.de, Adrian Freihofer Subject: [PATCH v3 01/22] oe-selftest: fitimage: test coverage for ext dtb Date: Wed, 14 May 2025 20:50:45 +0200 Message-ID: <20250514185225.162998-2-adrian.freihofer@siemens.com> In-Reply-To: <20250514185225.162998-1-adrian.freihofer@siemens.com> References: <20250514185225.162998-1-adrian.freihofer@siemens.com> MIME-Version: 1.0 X-Flowmailer-Platform: Siemens Feedback-ID: 519:519-1329275:519-21489:flowmailer 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 ; Wed, 14 May 2025 18:53:23 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/openembedded-core/message/216525 From: Adrian Freihofer There are several ways to insert external devicetrees and devicetree overlays into the kernel and thus at least to some extent into the FIT image. So far there is no test coverage. Let's improve this as much as possible without fully understanding all use cases. This first test adds a devicetree overlay to a build configuration without signing, since signing is apparently not yet meaningful when PREFERRED_PROVIDER_virtual/dtb = “bborg-relay-00a2” is used. It is also not entirely clear how these external devicetree overlays are used by the configuration nodes of the FIT image. Currently, one configuration is created per dtb dtbo node, which is not really useful for dtbo nodes. Before this test can be extended to test devicetree overlays and signing, the code that creates the configuration nodes in its file probably needs some improvements in terms of more flexibility in defining the references from configuration nodes to image nodes. Signed-off-by: Adrian Freihofer --- meta/lib/oeqa/selftest/cases/fitimage.py | 58 +++++++++++++++++++++--- 1 file changed, 51 insertions(+), 7 deletions(-) diff --git a/meta/lib/oeqa/selftest/cases/fitimage.py b/meta/lib/oeqa/selftest/cases/fitimage.py index b39f2622dff..c3554d4499a 100644 --- a/meta/lib/oeqa/selftest/cases/fitimage.py +++ b/meta/lib/oeqa/selftest/cases/fitimage.py @@ -161,10 +161,21 @@ class FitImageTestCase(OESelftestTestCase): @staticmethod def _get_dtb_files(bb_vars): + """Return a list of devicetree names + + The list should be used to check the dtb and conf nodes in the FIT image or its file. + In addition to the entries from KERNEL_DEVICETREE, the external devicetree overlay + added by the test recipe bborg-relay-00a2.bb is also handled. + """ kernel_devicetree = bb_vars.get('KERNEL_DEVICETREE') + all_dtbs = [] if kernel_devicetree: - return [os.path.basename(dtb) for dtb in kernel_devicetree.split()] - return [] + all_dtbs += [os.path.basename(dtb) for dtb in kernel_devicetree.split()] + # Support only the test recipe which provides 1 devicetree overlay + pref_prov_dtb = bb_vars.get('PREFERRED_PROVIDER_virtual/dtb') + if pref_prov_dtb == "bborg-relay-00a2": + all_dtbs.append("BBORG_RELAY-00A2.dtbo") + return all_dtbs def _is_req_dict_in_dict(self, found_dict, req_dict): """ @@ -379,6 +390,7 @@ class KernelFitImageTests(FitImageTestCase): 'KERNEL_DEVICETREE', 'KERNEL_FIT_LINK_NAME', 'MACHINE', + 'PREFERRED_PROVIDER_virtual/dtb', 'UBOOT_ARCH', 'UBOOT_ENTRYPOINT', 'UBOOT_LOADADDRESS', @@ -585,10 +597,16 @@ class KernelFitImageTests(FitImageTestCase): # Create a configuration section for each DTB if dtb_files: for dtb in dtb_files: - req_sections['conf-' + dtb] = { - "Kernel": "kernel-1", - "FDT": 'fdt-' + dtb, - } + # dtb overlays do not refer to a kernel (yet?) + if dtb.endswith('.dtbo'): + req_sections['conf-' + dtb] = { + "FDT": 'fdt-' + dtb, + } + else: + req_sections['conf-' + dtb] = { + "Kernel": "kernel-1", + "FDT": 'fdt-' + dtb, + } if initramfs_image and initramfs_image_bundle != "1": req_sections['conf-' + dtb]['Init Ramdisk'] = "ramdisk-1" else: @@ -635,7 +653,12 @@ class KernelFitImageTests(FitImageTestCase): self.assertEqual(sign_algo, req_sign_algo, 'Signature algorithm for %s not expected value' % section) sign_value = values.get('Sign value', None) self.assertEqual(len(sign_value), fit_sign_alg_len, 'Signature value for section %s not expected length' % section) - dtb_path = os.path.join(deploy_dir_image, section.replace('conf-', '')) + dtb_file_name = section.replace('conf-', '') + dtb_path = os.path.join(deploy_dir_image, dtb_file_name) + # External devicetrees created by devicetree.bbclass are in a subfolder and have priority + dtb_path_ext = os.path.join(deploy_dir_image, "devicetree", dtb_file_name) + if os.path.exists(dtb_path_ext): + dtb_path = dtb_path_ext self._verify_fit_image_signature(uboot_tools_bindir, fitimage_path, dtb_path, section) else: # Image nodes always need a hash which gets indirectly signed by the config signature @@ -696,6 +719,27 @@ FIT_DESC = "A model description" self._test_fitimage(bb_vars) + def test_fit_image_ext_dtbo(self): + """ + Summary: Check if FIT image and Image Tree Source (its) are created correctly. + Expected: 1) its and FIT image are built successfully + 2) The its file contains also the external devicetree overlay + 3) Dumping the FIT image indicates the devicetree overlay + """ + config = """ +# Enable creation of fitImage +MACHINE = "beaglebone-yocto" +KERNEL_IMAGETYPES += " fitImage " +KERNEL_CLASSES = " kernel-fitimage " +# Add a devicetree overlay which does not need kernel sources +PREFERRED_PROVIDER_virtual/dtb = "bborg-relay-00a2" +""" + config = self._config_add_uboot_env(config) + self.write_config(config) + bb_vars = self._fit_get_bb_vars() + self._test_fitimage(bb_vars) + + def test_sign_fit_image_configurations(self): """ Summary: Check if FIT image and Image Tree Source (its) are created From patchwork Wed May 14 18:50:46 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: AdrianF X-Patchwork-Id: 62960 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 013AEC3ABD8 for ; Wed, 14 May 2025 18:53:33 +0000 (UTC) Received: from mta-65-225.siemens.flowmailer.net (mta-65-225.siemens.flowmailer.net [185.136.65.225]) by mx.groups.io with SMTP id smtpd.web10.109895.1747248804852796917 for ; Wed, 14 May 2025 11:53:25 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=adrian.freihofer@siemens.com header.s=fm1 header.b=VyunNgaz; spf=pass (domain: rts-flowmailer.siemens.com, ip: 185.136.65.225, mailfrom: fm-1329275-2025051418532258fc653699a46ddce1-skd0jj@rts-flowmailer.siemens.com) Received: by mta-65-225.siemens.flowmailer.net with ESMTPSA id 2025051418532258fc653699a46ddce1 for ; Wed, 14 May 2025 20:53:22 +0200 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; s=fm1; d=siemens.com; i=adrian.freihofer@siemens.com; h=Date:From:Subject:To:Message-ID:MIME-Version:Content-Type:Content-Transfer-Encoding:Cc:References:In-Reply-To; bh=LqpF9Qb/j5yDW1Gm2havmAuiNBH6Bf9qilWZ+xHDJmE=; b=VyunNgazMIdf+K8IYx0TZqCEwOQ485HFf7QcLjXkyc770fErfJN7m1KkuKlRS9q73rWN+R pBes4lmZEm5qstj1MjgzfLrxwx9RyOhKO14kP006xNqaxsd+9GzD+Ooezc5raEexjCr7/UGe 1U8qUdfQzvuCP9SXWgpN7rRosrJFqGN/H1T7qYDiRJkYMtEXXKDULM8dDehjSzSmTNM+8ic7 JXuz64VrIOHDdxeYA2x795uJSgCgsq7qyFKHSeWHgI/ur73/NqYIPou/CKFVjYji0tFHyxHS kyvnSxuLZMzAzOhebnWkTubhrAiXdX8Y1U7ywdelwWJo9bDac+0YzdWQ==; From: AdrianF To: openembedded-core@lists.openembedded.org Cc: marex@denx.de, Adrian Freihofer Subject: [PATCH v3 02/22] kernel-signing-keys-native: refactor key generation into a new recipe Date: Wed, 14 May 2025 20:50:46 +0200 Message-ID: <20250514185225.162998-3-adrian.freihofer@siemens.com> In-Reply-To: <20250514185225.162998-1-adrian.freihofer@siemens.com> References: <20250514185225.162998-1-adrian.freihofer@siemens.com> MIME-Version: 1.0 X-Flowmailer-Platform: Siemens Feedback-ID: 519:519-1329275:519-21489:flowmailer 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 ; Wed, 14 May 2025 18:53:33 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/openembedded-core/message/216526 From: Adrian Freihofer The do_kernel_generate_rsa_keys function from kernel-fitimage.bbclass is moved to a new recipe, kernel-signing-keys-native.bb. This refactoring introduces no functional changes. Intention this change: - Remove the dependency of uboot-sign.bbclass on kernel-fitimage.bbclass. - Simplify the use of custom key generation implementations by isolating the functionality into a separate recipe. Known limitations of this (and also the previous) implementation: - When generating from an existing TMPDIR, the existing key is reused. However, when generating from an empty TMPDIR or an SDK using the sstate-cache, a new key is generated, which may lead to inconsistencies. - The use of random keys (via FIT_GENERATE_KEYS) is convenient for experiments but unsuitable for production environments requiring deterministic and secure key management. Future improvements to consider: - Ensure reproducibility, even when using the sstate-cache. However, simply storing the private key in a potentially shared sstate artifact may not always be ideal from a security perspective. - Support encrypted keys via `SRC_URI` for reliable key updates. - Enable signing with an HSM (Hardware Security Module) through mechanisms like PKCS#11 or post-processing scripts. Signed-off-by: Adrian Freihofer --- meta/classes-recipe/kernel-fitimage.bbclass | 52 ++-------------- meta/classes-recipe/uboot-sign.bbclass | 5 +- .../kernel-signing-keys-native.bb | 61 +++++++++++++++++++ 3 files changed, 68 insertions(+), 50 deletions(-) create mode 100644 meta/recipes-kernel/kernel-signing-keys/kernel-signing-keys-native.bb diff --git a/meta/classes-recipe/kernel-fitimage.bbclass b/meta/classes-recipe/kernel-fitimage.bbclass index 07786647e19..f5f02f30f0a 100644 --- a/meta/classes-recipe/kernel-fitimage.bbclass +++ b/meta/classes-recipe/kernel-fitimage.bbclass @@ -27,7 +27,10 @@ def get_fit_replacement_type(d): return replacementtype KERNEL_IMAGETYPE_REPLACEMENT ?= "${@get_fit_replacement_type(d)}" -DEPENDS:append = " ${@'u-boot-tools-native dtc-native' if 'fitImage' in (d.getVar('KERNEL_IMAGETYPES') or '').split() else ''}" +DEPENDS:append = " \ + ${@'u-boot-tools-native dtc-native' if 'fitImage' in (d.getVar('KERNEL_IMAGETYPES') or '').split() else ''} \ + ${@'kernel-signing-keys-native' if d.getVar('FIT_GENERATE_KEYS') == '1' else ''} \ +" python __anonymous () { # Override KERNEL_IMAGETYPE_FOR_MAKE variable, which is internal @@ -754,53 +757,6 @@ do_assemble_fitimage_initramfs() { addtask assemble_fitimage_initramfs before do_deploy after do_bundle_initramfs -do_kernel_generate_rsa_keys() { - if [ "${UBOOT_SIGN_ENABLE}" = "0" ] && [ "${FIT_GENERATE_KEYS}" = "1" ]; then - bbwarn "FIT_GENERATE_KEYS is set to 1 even though UBOOT_SIGN_ENABLE is set to 0. The keys will not be generated as they won't be used." - fi - - if [ "${UBOOT_SIGN_ENABLE}" = "1" ] && [ "${FIT_GENERATE_KEYS}" = "1" ]; then - - # Generate keys to sign configuration nodes, only if they don't already exist - if [ ! -f "${UBOOT_SIGN_KEYDIR}/${UBOOT_SIGN_KEYNAME}".key ] || \ - [ ! -f "${UBOOT_SIGN_KEYDIR}/${UBOOT_SIGN_KEYNAME}".crt ]; then - - # make directory if it does not already exist - mkdir -p "${UBOOT_SIGN_KEYDIR}" - - bbnote "Generating RSA private key for signing fitImage" - openssl genrsa ${FIT_KEY_GENRSA_ARGS} -out \ - "${UBOOT_SIGN_KEYDIR}/${UBOOT_SIGN_KEYNAME}".key \ - "${FIT_SIGN_NUMBITS}" - - bbnote "Generating certificate for signing fitImage" - openssl req ${FIT_KEY_REQ_ARGS} "${FIT_KEY_SIGN_PKCS}" \ - -key "${UBOOT_SIGN_KEYDIR}/${UBOOT_SIGN_KEYNAME}".key \ - -out "${UBOOT_SIGN_KEYDIR}/${UBOOT_SIGN_KEYNAME}".crt - fi - - # Generate keys to sign image nodes, only if they don't already exist - if [ ! -f "${UBOOT_SIGN_KEYDIR}/${UBOOT_SIGN_IMG_KEYNAME}".key ] || \ - [ ! -f "${UBOOT_SIGN_KEYDIR}/${UBOOT_SIGN_IMG_KEYNAME}".crt ]; then - - # make directory if it does not already exist - mkdir -p "${UBOOT_SIGN_KEYDIR}" - - bbnote "Generating RSA private key for signing fitImage" - openssl genrsa ${FIT_KEY_GENRSA_ARGS} -out \ - "${UBOOT_SIGN_KEYDIR}/${UBOOT_SIGN_IMG_KEYNAME}".key \ - "${FIT_SIGN_NUMBITS}" - - bbnote "Generating certificate for signing fitImage" - openssl req ${FIT_KEY_REQ_ARGS} "${FIT_KEY_SIGN_PKCS}" \ - -key "${UBOOT_SIGN_KEYDIR}/${UBOOT_SIGN_IMG_KEYNAME}".key \ - -out "${UBOOT_SIGN_KEYDIR}/${UBOOT_SIGN_IMG_KEYNAME}".crt - fi - fi -} - -addtask kernel_generate_rsa_keys before do_assemble_fitimage after do_compile - kernel_do_deploy[vardepsexclude] = "DATETIME" kernel_do_deploy:append() { # Update deploy directory diff --git a/meta/classes-recipe/uboot-sign.bbclass b/meta/classes-recipe/uboot-sign.bbclass index e0771b54291..ae700515d25 100644 --- a/meta/classes-recipe/uboot-sign.bbclass +++ b/meta/classes-recipe/uboot-sign.bbclass @@ -108,13 +108,14 @@ UBOOT_FIT_CONF_USER_LOADABLES ?= '' UBOOT_FIT_UBOOT_LOADADDRESS ?= "${UBOOT_LOADADDRESS}" UBOOT_FIT_UBOOT_ENTRYPOINT ?= "${UBOOT_ENTRYPOINT}" + +DEPENDS:append = " ${@'kernel-signing-keys-native' if d.getVar('FIT_GENERATE_KEYS') == '1' else ''}" + python() { # We need u-boot-tools-native if we're creating a U-Boot fitImage sign = d.getVar('UBOOT_SIGN_ENABLE') == '1' if d.getVar('UBOOT_FITIMAGE_ENABLE') == '1' or sign: d.appendVar('DEPENDS', " u-boot-tools-native dtc-native") - if d.getVar('FIT_GENERATE_KEYS') == '1' and sign: - d.appendVarFlag('do_uboot_assemble_fitimage', 'depends', ' virtual/kernel:do_kernel_generate_rsa_keys') } concat_dtb() { diff --git a/meta/recipes-kernel/kernel-signing-keys/kernel-signing-keys-native.bb b/meta/recipes-kernel/kernel-signing-keys/kernel-signing-keys-native.bb new file mode 100644 index 00000000000..bc01984d756 --- /dev/null +++ b/meta/recipes-kernel/kernel-signing-keys/kernel-signing-keys-native.bb @@ -0,0 +1,61 @@ +SUMMARY = "Signing keys for the kernel FIT image" +LICENSE = "MIT" +LIC_FILES_CHKSUM = "file://${COREBASE}/meta/COPYING.MIT;md5=3da9cfbcb788c80a0384361b4de20420" + +require conf/image-fitimage.conf + +DEPENDS += "openssl-native" + +inherit native + +do_fetch[noexec] = "1" +do_unpack[noexec] = "1" +do_patch[noexec] = "1" +do_configure[noexec] = "1" +do_install[noexec] = "1" + + +do_compile() { + if [ "${UBOOT_SIGN_ENABLE}" = "0" ] && [ "${FIT_GENERATE_KEYS}" = "1" ]; then + bbwarn "FIT_GENERATE_KEYS is set to 1 even though UBOOT_SIGN_ENABLE is set to 0. The keys will not be generated as they won't be used." + fi + + if [ "${UBOOT_SIGN_ENABLE}" = "1" ] && [ "${FIT_GENERATE_KEYS}" = "1" ]; then + + # Generate keys to sign configuration nodes, only if they don't already exist + if [ ! -f "${UBOOT_SIGN_KEYDIR}/${UBOOT_SIGN_KEYNAME}".key ] || \ + [ ! -f "${UBOOT_SIGN_KEYDIR}/${UBOOT_SIGN_KEYNAME}".crt ]; then + + # make directory if it does not already exist + mkdir -p "${UBOOT_SIGN_KEYDIR}" + + bbnote "Generating RSA private key for signing fitImage" + openssl genrsa ${FIT_KEY_GENRSA_ARGS} -out \ + "${UBOOT_SIGN_KEYDIR}/${UBOOT_SIGN_KEYNAME}".key \ + "${FIT_SIGN_NUMBITS}" + + bbnote "Generating certificate for signing fitImage" + openssl req ${FIT_KEY_REQ_ARGS} "${FIT_KEY_SIGN_PKCS}" \ + -key "${UBOOT_SIGN_KEYDIR}/${UBOOT_SIGN_KEYNAME}".key \ + -out "${UBOOT_SIGN_KEYDIR}/${UBOOT_SIGN_KEYNAME}".crt + fi + + # Generate keys to sign image nodes, only if they don't already exist + if [ ! -f "${UBOOT_SIGN_KEYDIR}/${UBOOT_SIGN_IMG_KEYNAME}".key ] || \ + [ ! -f "${UBOOT_SIGN_KEYDIR}/${UBOOT_SIGN_IMG_KEYNAME}".crt ]; then + + # make directory if it does not already exist + mkdir -p "${UBOOT_SIGN_KEYDIR}" + + bbnote "Generating RSA private key for signing fitImage" + openssl genrsa ${FIT_KEY_GENRSA_ARGS} -out \ + "${UBOOT_SIGN_KEYDIR}/${UBOOT_SIGN_IMG_KEYNAME}".key \ + "${FIT_SIGN_NUMBITS}" + + bbnote "Generating certificate for signing fitImage" + openssl req ${FIT_KEY_REQ_ARGS} "${FIT_KEY_SIGN_PKCS}" \ + -key "${UBOOT_SIGN_KEYDIR}/${UBOOT_SIGN_IMG_KEYNAME}".key \ + -out "${UBOOT_SIGN_KEYDIR}/${UBOOT_SIGN_IMG_KEYNAME}".crt + fi + fi +} From patchwork Wed May 14 18:50:47 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: AdrianF X-Patchwork-Id: 62959 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 023EBC3ABDD for ; Wed, 14 May 2025 18:53:33 +0000 (UTC) Received: from mta-65-228.siemens.flowmailer.net (mta-65-228.siemens.flowmailer.net [185.136.65.228]) by mx.groups.io with SMTP id smtpd.web10.109898.1747248809491062992 for ; Wed, 14 May 2025 11:53:29 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=adrian.freihofer@siemens.com header.s=fm1 header.b=cZ/xUj1e; spf=pass (domain: rts-flowmailer.siemens.com, ip: 185.136.65.228, mailfrom: fm-1329275-202505141853279d6d4b23734dfbffb8-oafsyw@rts-flowmailer.siemens.com) Received: by mta-65-228.siemens.flowmailer.net with ESMTPSA id 202505141853279d6d4b23734dfbffb8 for ; Wed, 14 May 2025 20:53:27 +0200 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; s=fm1; d=siemens.com; i=adrian.freihofer@siemens.com; h=Date:From:Subject:To:Message-ID:MIME-Version:Content-Type:Content-Transfer-Encoding:Cc:References:In-Reply-To; bh=KqmqVZan7/t5N3Q6U09RScxWIkVGDuAdTBjMfpOo3Mw=; b=cZ/xUj1ewzl/2lT4KIWesSnV7jT8pLnADXbditDzb6OJhoBmxJn6HJS25oubqvURLqlFhT U8/TI0QTOyXIVal3R+elwEX3TeXWiGbXcNcURaxFC00S4+k9g4zrUvPrGdJJQFRBH3n/riaS oFWAUhqkqZNgzx2yQd/ko5PogiITcn9W4XYqiK9yWk2QG+fBa/rWXzy/J+V5I+q30qRx+vpb NcgRk4iZnNPzcRYsUzJy4aEwc++fY8sEH0wIrDZfQz1617UwTU3r6+TbLHtlMIuKXO9jBspz LahgxJcE9mRcRVnD9DO8TFV6LMGIyPmy62ynyrIOOgrmbA9Ue2UkX9rg==; From: AdrianF To: openembedded-core@lists.openembedded.org Cc: marex@denx.de, Adrian Freihofer Subject: [PATCH v3 03/22] kernel-uboot: do not require the kernel build folder Date: Wed, 14 May 2025 20:50:47 +0200 Message-ID: <20250514185225.162998-4-adrian.freihofer@siemens.com> In-Reply-To: <20250514185225.162998-1-adrian.freihofer@siemens.com> References: <20250514185225.162998-1-adrian.freihofer@siemens.com> MIME-Version: 1.0 X-Flowmailer-Platform: Siemens Feedback-ID: 519:519-1329275:519-21489:flowmailer 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 ; Wed, 14 May 2025 18:53:33 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/openembedded-core/message/216527 From: Adrian Freihofer The function must be executed in CWD. Make it more flexible by specifying the kernel build folder as a parameter. This is a refactoring without functional change. But later this change will allow to use this function also with a kernel from the sstate-cache instead of requiring the full kernel build folder structure. Another preparation for using a kernel from sstate-cache is to persist the linux_comp variable in a file next to the linux.bin file rather than using a global shell variable. This change also requires to adapt the kernel-uimage.bbclass accordingly. This change also fixes a minor detail: the kernel-uimage.bbclass used ${ instead of $ for evaluatiing a local shell variable. Signed-off-by: Adrian Freihofer --- meta/classes-recipe/kernel-uboot.bbclass | 40 ++++++++++++++--------- meta/classes-recipe/kernel-uimage.bbclass | 3 +- 2 files changed, 26 insertions(+), 17 deletions(-) diff --git a/meta/classes-recipe/kernel-uboot.bbclass b/meta/classes-recipe/kernel-uboot.bbclass index 6d4aff6b11b..d2a63524ece 100644 --- a/meta/classes-recipe/kernel-uboot.bbclass +++ b/meta/classes-recipe/kernel-uboot.bbclass @@ -12,19 +12,27 @@ FIT_KERNEL_COMP_ALG_EXTENSION ?= ".gz" UBOOT_MKIMAGE_KERNEL_TYPE ?= "kernel" uboot_prep_kimage() { - if [ -e arch/${ARCH}/boot/compressed/vmlinux ]; then + output_dir=$1 + # For backward compatibility with kernel-fitimage.bbclass and kernel-uboot.bbclass + # support calling without parameter as well + if [ -z "$output_dir" ]; then + output_dir='.' + fi + + linux_bin=$output_dir/linux.bin + if [ -e "arch/${ARCH}/boot/compressed/vmlinux" ]; then vmlinux_path="arch/${ARCH}/boot/compressed/vmlinux" linux_suffix="" linux_comp="none" - elif [ -e arch/${ARCH}/boot/vmlinuz.bin ]; then - rm -f linux.bin - cp -l arch/${ARCH}/boot/vmlinuz.bin linux.bin + elif [ -e "arch/${ARCH}/boot/vmlinuz.bin" ]; then + rm -f "$linux_bin" + cp -l "arch/${ARCH}/boot/vmlinuz.bin" "$linux_bin" vmlinux_path="" linux_suffix="" linux_comp="none" else vmlinux_path="vmlinux" - # Use vmlinux.initramfs for linux.bin when INITRAMFS_IMAGE_BUNDLE set + # Use vmlinux.initramfs for $linux_bin when INITRAMFS_IMAGE_BUNDLE set # As per the implementation in kernel.bbclass. # See do_bundle_initramfs function if [ "${INITRAMFS_IMAGE_BUNDLE}" = "1" ] && [ -e vmlinux.initramfs ]; then @@ -34,18 +42,18 @@ uboot_prep_kimage() { linux_comp="${FIT_KERNEL_COMP_ALG}" fi - [ -n "${vmlinux_path}" ] && ${KERNEL_OBJCOPY} -O binary -R .note -R .comment -S "${vmlinux_path}" linux.bin + [ -n "$vmlinux_path" ] && ${KERNEL_OBJCOPY} -O binary -R .note -R .comment -S "$vmlinux_path" "$linux_bin" - if [ "${linux_comp}" != "none" ] ; then - if [ "${linux_comp}" = "gzip" ] ; then - gzip -9 linux.bin - elif [ "${linux_comp}" = "lzo" ] ; then - lzop -9 linux.bin - elif [ "${linux_comp}" = "lzma" ] ; then - xz --format=lzma -f -6 linux.bin + if [ "$linux_comp" != "none" ] ; then + if [ "$linux_comp" = "gzip" ] ; then + gzip -9 "$linux_bin" + elif [ "$linux_comp" = "lzo" ] ; then + lzop -9 "$linux_bin" + elif [ "$linux_comp" = "lzma" ] ; then + xz --format=lzma -f -6 "$linux_bin" fi - mv -f "linux.bin${linux_suffix}" linux.bin + mv -f "$linux_bin$linux_suffix" "$linux_bin" fi - echo "${linux_comp}" -} + printf "$linux_comp" > "$output_dir/linux_comp" +} \ No newline at end of file diff --git a/meta/classes-recipe/kernel-uimage.bbclass b/meta/classes-recipe/kernel-uimage.bbclass index 1a599e656c8..e353232a0e9 100644 --- a/meta/classes-recipe/kernel-uimage.bbclass +++ b/meta/classes-recipe/kernel-uimage.bbclass @@ -29,6 +29,7 @@ python __anonymous () { do_uboot_mkimage[dirs] += "${B}" do_uboot_mkimage() { uboot_prep_kimage + linux_comp="$(cat linux_comp)" ENTRYPOINT=${UBOOT_ENTRYPOINT} if [ -n "${UBOOT_ENTRYSYMBOL}" ]; then @@ -36,6 +37,6 @@ do_uboot_mkimage() { awk '$3=="${UBOOT_ENTRYSYMBOL}" {print "0x"$1;exit}'` fi - uboot-mkimage -A ${UBOOT_ARCH} -O linux -T ${UBOOT_MKIMAGE_KERNEL_TYPE} -C "${linux_comp}" -a ${UBOOT_LOADADDRESS} -e $ENTRYPOINT -n "${DISTRO_NAME}/${PV}/${MACHINE}" -d linux.bin ${B}/arch/${ARCH}/boot/uImage + uboot-mkimage -A ${UBOOT_ARCH} -O linux -T ${UBOOT_MKIMAGE_KERNEL_TYPE} -C "$linux_comp" -a ${UBOOT_LOADADDRESS} -e $ENTRYPOINT -n "${DISTRO_NAME}/${PV}/${MACHINE}" -d linux.bin ${B}/arch/${ARCH}/boot/uImage rm -f linux.bin } From patchwork Wed May 14 18:50:48 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: AdrianF X-Patchwork-Id: 62961 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 0739FC3ABDA for ; Wed, 14 May 2025 18:53:33 +0000 (UTC) Received: from mta-64-226.siemens.flowmailer.net (mta-64-226.siemens.flowmailer.net [185.136.64.226]) by mx.groups.io with SMTP id smtpd.web11.110589.1747248811553974163 for ; Wed, 14 May 2025 11:53:31 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=adrian.freihofer@siemens.com header.s=fm1 header.b=J7ZJ0ApO; spf=pass (domain: rts-flowmailer.siemens.com, ip: 185.136.64.226, mailfrom: fm-1329275-2025051418532908eb881c27d8ffa9c2-wkbkai@rts-flowmailer.siemens.com) Received: by mta-64-226.siemens.flowmailer.net with ESMTPSA id 2025051418532908eb881c27d8ffa9c2 for ; Wed, 14 May 2025 20:53:29 +0200 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; s=fm1; d=siemens.com; i=adrian.freihofer@siemens.com; h=Date:From:Subject:To:Message-ID:MIME-Version:Content-Type:Content-Transfer-Encoding:Cc:References:In-Reply-To; bh=Rzni6iaY70dKUayc/tWEL2wUKwWH+EMxTBbyTrVmDTA=; b=J7ZJ0ApO2peMs+bFTQJVYwviEG9vAb5upOqryoh8eI0241uuYeFz/IU/F2m1Q8joMx0Lha 6xXYGPsNLCDRj8He4duxTXeTRgTUhSS/WBl50y4yjwgYjR/zspxaHKws94/iiLfSuJHeFk7n tZsls8itNCByjAUvGl9iusRgzl8UEVmUIlXO/fYGfiS00wFacj7qTZz30GbsDv0IgtQpHjfd lfvlFe4kMbzyxCST03w45kc62lQgWzsBdnKWJDoB0s/Xhj2atiUSyuqmAq5Oi8xIK2cxk3DI 7BeGoPPzaS3KBIVkbIRU+58RiXEDJf3rr7CSu4IZGdqqQw9jD5XYwSQQ==; From: AdrianF To: openembedded-core@lists.openembedded.org Cc: marex@denx.de, Adrian Freihofer Subject: [PATCH v3 04/22] kernel-devicetree: export dtbs to sysroot Date: Wed, 14 May 2025 20:50:48 +0200 Message-ID: <20250514185225.162998-5-adrian.freihofer@siemens.com> In-Reply-To: <20250514185225.162998-1-adrian.freihofer@siemens.com> References: <20250514185225.162998-1-adrian.freihofer@siemens.com> MIME-Version: 1.0 X-Flowmailer-Platform: Siemens Feedback-ID: 519:519-1329275:519-21489:flowmailer 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 ; Wed, 14 May 2025 18:53:33 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/openembedded-core/message/216528 From: Adrian Freihofer Forward the devicetree blobs via sstate-cached sysroot directory to other recipes. The intention is to create FIT images independently from the kernel build folder structure later on. Signed-off-by: Adrian Freihofer --- meta/classes-recipe/kernel-devicetree.bbclass | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/meta/classes-recipe/kernel-devicetree.bbclass b/meta/classes-recipe/kernel-devicetree.bbclass index eff052b4029..75e394c5826 100644 --- a/meta/classes-recipe/kernel-devicetree.bbclass +++ b/meta/classes-recipe/kernel-devicetree.bbclass @@ -88,6 +88,10 @@ do_install:append() { dtb=$dtb_base_name.$dtb_ext fi install -Dm 0644 $dtb_path ${D}/${KERNEL_DTBDEST}/$dtb + + # Provide the DTBs also to other recipes + install -d ${D}/sysroot-only + install -Dm 0644 $dtb_path ${D}/sysroot-only/$dtb done } From patchwork Wed May 14 18:50:49 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: AdrianF X-Patchwork-Id: 62967 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 1E496C5475C for ; Wed, 14 May 2025 18:53:43 +0000 (UTC) Received: from mta-65-227.siemens.flowmailer.net (mta-65-227.siemens.flowmailer.net [185.136.65.227]) by mx.groups.io with SMTP id smtpd.web10.109902.1747248814347842213 for ; Wed, 14 May 2025 11:53:34 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=adrian.freihofer@siemens.com header.s=fm1 header.b=U2tFQGHK; spf=pass (domain: rts-flowmailer.siemens.com, ip: 185.136.65.227, mailfrom: fm-1329275-202505141853321db8402a61f8a15324-xgglvu@rts-flowmailer.siemens.com) Received: by mta-65-227.siemens.flowmailer.net with ESMTPSA id 202505141853321db8402a61f8a15324 for ; Wed, 14 May 2025 20:53:32 +0200 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; s=fm1; d=siemens.com; i=adrian.freihofer@siemens.com; h=Date:From:Subject:To:Message-ID:MIME-Version:Content-Type:Content-Transfer-Encoding:Cc:References:In-Reply-To; bh=cgMGKgObSCfEiQCtJ1hVP9kpoYsOioXU3jStOhAHJLQ=; b=U2tFQGHK3fHUNPO4MYf7DuDhONxtlkPs5Skwn2mvwahreT2hOi57oPjWCiohW4osNbuthP m7ZmSqMjQ67JZm8r12q4Pw5AkcY+ZdPkWfIYHM5QLI5jNIdekx41WCRGxmbow0YCtXTcq3pW ihHChIJhgUp0fVb8HBPoxw6S69mxQLmJaWFQa80yLBLufovISu7I87WkDoJUs0OLPF1VZF2G DzD0kYoKRupu9PcZVEQkjLhCxyQus/jdwvegIbH5txs417SUuTOfrJky5O/lOSHmv76mOa2W KQDIuz1C8CidmfSXJAv3fsJAfkbTbAM8QCd10O414LcyWaRejnvl3D3A==; From: AdrianF To: openembedded-core@lists.openembedded.org Cc: marex@denx.de, Adrian Freihofer Subject: [PATCH v3 05/22] kernel.bbclass: stage the sysroot-only folder Date: Wed, 14 May 2025 20:50:49 +0200 Message-ID: <20250514185225.162998-6-adrian.freihofer@siemens.com> In-Reply-To: <20250514185225.162998-1-adrian.freihofer@siemens.com> References: <20250514185225.162998-1-adrian.freihofer@siemens.com> MIME-Version: 1.0 X-Flowmailer-Platform: Siemens Feedback-ID: 519:519-1329275:519-21489:flowmailer 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 ; Wed, 14 May 2025 18:53:43 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/openembedded-core/message/216533 From: Adrian Freihofer Move the configuration for staging the sysroot-only directory from the kernel-fitimage.bbclass to the kernel.bbclass. This is a preparation for using the FIT image related artifacts also from an independent recipe which creates the FIT image from artifacts going via sstate-cache. Signed-off-by: Adrian Freihofer --- meta/classes-recipe/kernel-fitimage.bbclass | 1 - meta/classes-recipe/kernel.bbclass | 4 ++-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/meta/classes-recipe/kernel-fitimage.bbclass b/meta/classes-recipe/kernel-fitimage.bbclass index f5f02f30f0a..3975e657003 100644 --- a/meta/classes-recipe/kernel-fitimage.bbclass +++ b/meta/classes-recipe/kernel-fitimage.bbclass @@ -734,7 +734,6 @@ do_assemble_fitimage() { addtask assemble_fitimage before do_install after do_compile -SYSROOT_DIRS:append = " /sysroot-only" do_install:append() { if echo ${KERNEL_IMAGETYPES} | grep -wq "fitImage" && \ [ "${UBOOT_SIGN_ENABLE}" = "1" ]; then diff --git a/meta/classes-recipe/kernel.bbclass b/meta/classes-recipe/kernel.bbclass index 36ce659762e..1a7a60eadfc 100644 --- a/meta/classes-recipe/kernel.bbclass +++ b/meta/classes-recipe/kernel.bbclass @@ -631,8 +631,8 @@ do_shared_workdir () { } -# We don't need to stage anything, not the modules/firmware since those would clash with linux-firmware -SYSROOT_DIRS = "" +# Stage the sysroot-only folder e.g. for FIT image related artifacts +SYSROOT_DIRS = "/sysroot-only" KERNEL_CONFIG_COMMAND ?= "oe_runmake_call -C ${S} O=${B} olddefconfig || oe_runmake -C ${S} O=${B} oldnoconfig" From patchwork Wed May 14 18:50:50 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: AdrianF X-Patchwork-Id: 62962 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 02A47C3ABDD for ; Wed, 14 May 2025 18:53:43 +0000 (UTC) Received: from mta-64-226.siemens.flowmailer.net (mta-64-226.siemens.flowmailer.net [185.136.64.226]) by mx.groups.io with SMTP id smtpd.web11.110589.1747248811553974163 for ; Wed, 14 May 2025 11:53:33 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=adrian.freihofer@siemens.com header.s=fm1 header.b=W7axeXV+; spf=pass (domain: rts-flowmailer.siemens.com, ip: 185.136.64.226, mailfrom: fm-1329275-202505141853326e8927888b58a32486-bgt5ow@rts-flowmailer.siemens.com) Received: by mta-64-226.siemens.flowmailer.net with ESMTPSA id 202505141853326e8927888b58a32486 for ; Wed, 14 May 2025 20:53:32 +0200 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; s=fm1; d=siemens.com; i=adrian.freihofer@siemens.com; h=Date:From:Subject:To:Message-ID:MIME-Version:Content-Type:Content-Transfer-Encoding:Cc:References:In-Reply-To; bh=nhMgxIzZ3iXlaOg+kmuGvadbhHiHFjNEdNIsjBj7FIc=; b=W7axeXV+TqJZZnMD4AnuOhN14L4BgEe6oYZXF13PgQWmmERYsytKXwxp3mOUB/wuTqwVzh G+9c3xXHJqLU9xtu8G7MnAwEbEUflsmOp8fE9LVbJ770Yrvo6jn2g/0Ggsjxx1jnKzgYaTyz DlJREbszSLzvjVp3UxAJdem2ynygzq5bt4vnp70P09CxgJKOmR/GrPKQbFH/lx3kDkFoEeH0 Wf1fon0QsU/yaxTXqDRPRdxEaktZqaGOI7xXTqgnbQZaLilL1dfxtuxC14AiWTge/MjyGU3m KTFHNvvbPNUS7QfFC8i80Em3LIsYFMWXl3dhIwPjpY+eeEievBan2imw==; From: AdrianF To: openembedded-core@lists.openembedded.org Cc: marex@denx.de, Adrian Freihofer Subject: [PATCH v3 06/22] kernel-uboot.bbclass: stage the kernel binary Date: Wed, 14 May 2025 20:50:50 +0200 Message-ID: <20250514185225.162998-7-adrian.freihofer@siemens.com> In-Reply-To: <20250514185225.162998-1-adrian.freihofer@siemens.com> References: <20250514185225.162998-1-adrian.freihofer@siemens.com> MIME-Version: 1.0 X-Flowmailer-Platform: Siemens Feedback-ID: 519:519-1329275:519-21489:flowmailer 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 ; Wed, 14 May 2025 18:53:43 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/openembedded-core/message/216529 From: Adrian Freihofer Extend the kernel-uboot.bbclass to expport the kernel binary which is needed for creating a FIT image to the sysroot-only directory. This will allow to use KERNEL_CLASSES += "kernel-uboot" and a recipe which creates the FIT image using artifacts from sysroot-only instead of the kernel-fitimage.bbclass KERNEL_CLASSES = " kernel-fitimage " which does not work with sstate-cache. Signed-off-by: Adrian Freihofer --- meta/classes-recipe/kernel-uboot.bbclass | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/meta/classes-recipe/kernel-uboot.bbclass b/meta/classes-recipe/kernel-uboot.bbclass index d2a63524ece..7aafd4757c2 100644 --- a/meta/classes-recipe/kernel-uboot.bbclass +++ b/meta/classes-recipe/kernel-uboot.bbclass @@ -56,4 +56,14 @@ uboot_prep_kimage() { fi printf "$linux_comp" > "$output_dir/linux_comp" -} \ No newline at end of file +} + +do_install:append() { + # Provide the kernel artifacts to post processing recipes e.g. for creating a FIT image + install -d ${D}/sysroot-only + uboot_prep_kimage ${D}/sysroot-only + # For x86 a setup.bin needs to be included in a fitImage as well + if [ -e ${KERNEL_OUTPUT_DIR}/setup.bin ]; then + install -D ${B}/${KERNEL_OUTPUT_DIR}/setup.bin ${D}/sysroot-only/setup.bin + fi +} From patchwork Wed May 14 18:50:51 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: AdrianF X-Patchwork-Id: 62976 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 72D26C54E71 for ; Wed, 14 May 2025 18:53:43 +0000 (UTC) Received: from mta-65-226.siemens.flowmailer.net (mta-65-226.siemens.flowmailer.net [185.136.65.226]) by mx.groups.io with SMTP id smtpd.web10.109901.1747248814197199931 for ; Wed, 14 May 2025 11:53:34 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=adrian.freihofer@siemens.com header.s=fm1 header.b=KjlyYxkY; spf=pass (domain: rts-flowmailer.siemens.com, ip: 185.136.65.226, mailfrom: fm-1329275-2025051418533236fd5f11a6ed395b1c-wq0ip1@rts-flowmailer.siemens.com) Received: by mta-65-226.siemens.flowmailer.net with ESMTPSA id 2025051418533236fd5f11a6ed395b1c for ; Wed, 14 May 2025 20:53:32 +0200 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; s=fm1; d=siemens.com; i=adrian.freihofer@siemens.com; h=Date:From:Subject:To:Message-ID:MIME-Version:Content-Type:Content-Transfer-Encoding:Cc:References:In-Reply-To; bh=NTyd9QST9L+3g97EmLgFlxmACFJ9472SX2fG64s29qE=; b=KjlyYxkYf7eew5it4MqGZrKNSTancGl6ClaAETge7O16JzlGwyzo0qI4kyqVK5dkuMyR/O Is/uO7bG0389JwqA2YudnSwCeulks6NszuD7w1TGKl/ZDTkvC3sE7dIqjAtYoKcTDfvq7Kjg 1VMbU20CE44QAWyWPaMmIOMuJx0oJKF9NAKJau9x96oT8s2t36SD7dLc/JP6hiMUx0V44PsB O34qMB/ZVEix5JAck/y/evD3Yso5OeQyR4F5BCLQArMkIuy7pSf16JdxsayzneND8JIC3dg7 ocDH9nFn4yCGiFXrO00aWwE2pgiRG1bnj/wsXqt5w50GKXUt/zA/ynig==; From: AdrianF To: openembedded-core@lists.openembedded.org Cc: marex@denx.de, Adrian Freihofer Subject: [PATCH v3 07/22] kernel-fitimage: refactor order in its Date: Wed, 14 May 2025 20:50:51 +0200 Message-ID: <20250514185225.162998-8-adrian.freihofer@siemens.com> In-Reply-To: <20250514185225.162998-1-adrian.freihofer@siemens.com> References: <20250514185225.162998-1-adrian.freihofer@siemens.com> MIME-Version: 1.0 X-Flowmailer-Platform: Siemens Feedback-ID: 519:519-1329275:519-21489:flowmailer 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 ; Wed, 14 May 2025 18:53:43 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/openembedded-core/message/216532 From: Adrian Freihofer When the ITS file is created, the mandatory properties are written first before the optional properties are written. This is not really useful for the current implementation. But it is a preparation for a new Python-based implementation that will expect mandatory properties first. This change makes it possible to run the tests with both the old and the new implementation. Signed-off-by: Adrian Freihofer --- meta/classes-recipe/kernel-fitimage.bbclass | 20 ++++++++++---------- meta/lib/oeqa/selftest/cases/fitimage.py | 4 ++-- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/meta/classes-recipe/kernel-fitimage.bbclass b/meta/classes-recipe/kernel-fitimage.bbclass index 3975e657003..18c7c9bf872 100644 --- a/meta/classes-recipe/kernel-fitimage.bbclass +++ b/meta/classes-recipe/kernel-fitimage.bbclass @@ -128,11 +128,11 @@ fitimage_emit_section_kernel() { cat << EOF >> $1 kernel-$2 { description = "Linux kernel"; - data = /incbin/("$3"); type = "${UBOOT_MKIMAGE_KERNEL_TYPE}"; + compression = "$4"; + data = /incbin/("$3"); arch = "${UBOOT_ARCH}"; os = "linux"; - compression = "$4"; load = <${UBOOT_LOADADDRESS}>; entry = <$ENTRYPOINT>; hash-1 { @@ -177,10 +177,10 @@ fitimage_emit_section_dtb() { cat << EOF >> $1 fdt-$2 { description = "Flattened Device Tree blob"; - data = /incbin/("$3"); type = "flat_dt"; - arch = "${UBOOT_ARCH}"; compression = "none"; + data = /incbin/("$3"); + arch = "${UBOOT_ARCH}"; $dtb_loadline hash-1 { algo = "$dtb_csum"; @@ -215,10 +215,10 @@ fitimage_emit_section_boot_script() { cat << EOF >> $1 bootscr-$2 { description = "U-boot script"; - data = /incbin/("$3"); type = "script"; - arch = "${UBOOT_ARCH}"; compression = "none"; + data = /incbin/("$3"); + arch = "${UBOOT_ARCH}"; hash-1 { algo = "$bootscr_csum"; }; @@ -252,11 +252,11 @@ fitimage_emit_section_setup() { cat << EOF >> $1 setup-$2 { description = "Linux setup.bin"; - data = /incbin/("$3"); type = "x86_setup"; + compression = "none"; + data = /incbin/("$3"); arch = "${UBOOT_ARCH}"; os = "linux"; - compression = "none"; load = <0x00090000>; entry = <0x00090000>; hash-1 { @@ -301,11 +301,11 @@ fitimage_emit_section_ramdisk() { cat << EOF >> $1 ramdisk-$2 { description = "${INITRAMFS_IMAGE}"; - data = /incbin/("$3"); type = "ramdisk"; + compression = "none"; + data = /incbin/("$3"); arch = "${UBOOT_ARCH}"; os = "linux"; - compression = "none"; $ramdisk_loadline $ramdisk_entryline hash-1 { diff --git a/meta/lib/oeqa/selftest/cases/fitimage.py b/meta/lib/oeqa/selftest/cases/fitimage.py index c3554d4499a..47fb8534b37 100644 --- a/meta/lib/oeqa/selftest/cases/fitimage.py +++ b/meta/lib/oeqa/selftest/cases/fitimage.py @@ -509,11 +509,11 @@ class KernelFitImageTests(FitImageTestCase): its_field_check = [ 'description = "%s";' % bb_vars['FIT_DESC'], 'description = "Linux kernel";', - 'data = /incbin/("linux.bin");', 'type = "' + str(bb_vars['UBOOT_MKIMAGE_KERNEL_TYPE']) + '";', + # 'compression = "' + str(bb_vars['FIT_KERNEL_COMP_ALG']) + '";', defined based on files in TMPDIR, not ideal... + 'data = /incbin/("linux.bin");', 'arch = "' + str(bb_vars['UBOOT_ARCH']) + '";', 'os = "linux";', - # 'compression = "' + str(bb_vars['FIT_KERNEL_COMP_ALG']) + '";', defined based on files in TMPDIR, not ideal... 'load = <' + str(bb_vars['UBOOT_LOADADDRESS']) + '>;', 'entry = <' + str(bb_vars['UBOOT_ENTRYPOINT']) + '>;', ] From patchwork Wed May 14 18:50:52 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: AdrianF X-Patchwork-Id: 62979 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 62EC1C54ED1 for ; Wed, 14 May 2025 18:53:43 +0000 (UTC) Received: from mta-64-226.siemens.flowmailer.net (mta-64-226.siemens.flowmailer.net [185.136.64.226]) by mx.groups.io with SMTP id smtpd.web11.110592.1747248814332466105 for ; Wed, 14 May 2025 11:53:34 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=adrian.freihofer@siemens.com header.s=fm1 header.b=SW0rCfiC; spf=pass (domain: rts-flowmailer.siemens.com, ip: 185.136.64.226, mailfrom: fm-1329275-202505141853325ec6070b3b19522436-zmxt9g@rts-flowmailer.siemens.com) Received: by mta-64-226.siemens.flowmailer.net with ESMTPSA id 202505141853325ec6070b3b19522436 for ; Wed, 14 May 2025 20:53:32 +0200 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; s=fm1; d=siemens.com; i=adrian.freihofer@siemens.com; h=Date:From:Subject:To:Message-ID:MIME-Version:Content-Type:Content-Transfer-Encoding:Cc:References:In-Reply-To; bh=zQSBbygCRkMDcWPthdpBM8weGVlfeLvIEYRjrFYiuMQ=; b=SW0rCfiCJPBynLbV1a/SK68eU5kcURxKYGCus4JNYbd7+hbrE3ORakj9qJR0CRFVLIICfi s0JL4vVEq0uzGxGuYurcSWleGM/a8tLzZYhenspig+fM3yFplmavYFghKCzLHwxHX3ODeG5m RO27qLfCRk9f7eIZKkGesa7R5hCO9H1XwB1ta1HTN84KFZ61nKeFV/AcyihcQtaeVNoQX9j+ TXbxpmTbywtlgVjU/6DFhtkFAaMyMMumR1xGz4tOJ17fTC4HaquUDeOskFuyxoh0V6bsfM7P rRKtb4/OXy8NkmvEedUlQZuVvVfKwUVE1htAS8WWpZAIbODWE9xncbow==; From: AdrianF To: openembedded-core@lists.openembedded.org Cc: marex@denx.de, Adrian Freihofer Subject: [PATCH v3 08/22] kernel-fit-image.bbclass: add a new FIT image implementation Date: Wed, 14 May 2025 20:50:52 +0200 Message-ID: <20250514185225.162998-9-adrian.freihofer@siemens.com> In-Reply-To: <20250514185225.162998-1-adrian.freihofer@siemens.com> References: <20250514185225.162998-1-adrian.freihofer@siemens.com> MIME-Version: 1.0 X-Flowmailer-Platform: Siemens Feedback-ID: 519:519-1329275:519-21489:flowmailer 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 ; Wed, 14 May 2025 18:53:43 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/openembedded-core/message/216535 From: Adrian Freihofer The new recipe linux-yocto-fitimage.bb and the new kernel-fit-image.bbclass are intended to become successors of the kernel-fitimage.bbclass. Instead of injecting the FIT image related build steps into the kernel recipe, the new recipe takes the kernel artifacts from the kernel recipe and creates the FIT image as an independent task. This solves some basic problems: * sstate does not work well when a fitImage contains an initramfs. The kernel is rebuilt from scratch if the build runs from an empty TMPDIR. * A fitImage kernel is not available as a package, but all other kernel image types are. * The task dependencies in the kernel are very complex and difficult to debug if something goes wrong. As a separate, downstream recipe, this is now much easier. The long story about this issue is here: [YOCTO #12912] Signed-off-by: Adrian Freihofer --- meta/classes-recipe/kernel-fit-image.bbclass | 180 +++++++ meta/classes/multilib.bbclass | 1 + meta/lib/oe/fitimage.py | 463 ++++++++++++++++++ .../linux/linux-yocto-fitimage_6.12.bb | 13 + 4 files changed, 657 insertions(+) create mode 100644 meta/classes-recipe/kernel-fit-image.bbclass create mode 100644 meta/lib/oe/fitimage.py create mode 100644 meta/recipes-kernel/linux/linux-yocto-fitimage_6.12.bb diff --git a/meta/classes-recipe/kernel-fit-image.bbclass b/meta/classes-recipe/kernel-fit-image.bbclass new file mode 100644 index 00000000000..f4620aa0f86 --- /dev/null +++ b/meta/classes-recipe/kernel-fit-image.bbclass @@ -0,0 +1,180 @@ + +inherit kernel-arch kernel-artifact-names uboot-config deploy +require conf/image-fitimage.conf + +S = "${WORKDIR}/sources" +UNPACKDIR = "${S}" + +PACKAGE_ARCH = "${MACHINE_ARCH}" + +DEPENDS += "\ + u-boot-tools-native dtc-native virtual/kernel \ + ${@'kernel-signing-keys-native' if d.getVar('FIT_GENERATE_KEYS') == '1' else ''} \ +" + +python () { + image = d.getVar('INITRAMFS_IMAGE') + if image and not bb.utils.to_boolean(d.getVar('INITRAMFS_IMAGE_BUNDLE')): + if d.getVar('INITRAMFS_MULTICONFIG'): + mc = d.getVar('BB_CURRENT_MC') + d.appendVarFlag('do_compile', 'mcdepends', ' mc:' + mc + ':${INITRAMFS_MULTICONFIG}:${INITRAMFS_IMAGE}:do_image_complete') + else: + d.appendVarFlag('do_compile', 'depends', ' ${INITRAMFS_IMAGE}:do_image_complete') + + #check if there are any dtb providers + providerdtb = d.getVar("PREFERRED_PROVIDER_virtual/dtb") + if providerdtb: + d.appendVarFlag('do_compile', 'depends', ' virtual/dtb:do_populate_sysroot') + d.setVar('EXTERNAL_KERNEL_DEVICETREE', "${RECIPE_SYSROOT}/boot/devicetree") +} + +do_configure[noexec] = "1" + +UBOOT_MKIMAGE_KERNEL_TYPE ?= "kernel" +KERNEL_IMAGEDEST ?= "/boot" + +python do_compile() { + import shutil + import oe.fitimage + + itsfile = "fit-image.its" + fitname = "fitImage" + recipe_sysroot = d.getVar('RECIPE_SYSROOT') + + # Collect all the its nodes before the its file is generated and mkimage gets executed + root_node = oe.fitimage.ItsNodeRootKernel( + d.getVar("FIT_DESC"), d.getVar("FIT_ADDRESS_CELLS"), + d.getVar('HOST_PREFIX'), d.getVar('UBOOT_ARCH'), d.getVar("FIT_CONF_PREFIX"), + oe.types.boolean(d.getVar('UBOOT_SIGN_ENABLE')), d.getVar("UBOOT_SIGN_KEYDIR"), + d.getVar("UBOOT_MKIMAGE"), d.getVar("UBOOT_MKIMAGE_DTCOPTS"), + d.getVar("UBOOT_MKIMAGE_SIGN"), d.getVar("UBOOT_MKIMAGE_SIGN_ARGS"), + d.getVar('FIT_HASH_ALG'), d.getVar('FIT_SIGN_ALG'), d.getVar('FIT_PAD_ALG'), + d.getVar('UBOOT_SIGN_KEYNAME'), + oe.types.boolean(d.getVar('FIT_SIGN_INDIVIDUAL')), d.getVar('UBOOT_SIGN_IMG_KEYNAME') + ) + + # Prepare a kernel image section. + shutil.copyfile(os.path.join(recipe_sysroot, "sysroot-only", "linux.bin"), "linux.bin") + with open(os.path.join(recipe_sysroot, "sysroot-only", "linux_comp")) as linux_comp_f: + linux_comp = linux_comp_f.read() + root_node.fitimage_emit_section_kernel("kernel-1", "linux.bin", linux_comp, + d.getVar('UBOOT_LOADADDRESS'), d.getVar('UBOOT_ENTRYPOINT'), + d.getVar('UBOOT_MKIMAGE_KERNEL_TYPE'), d.getVar("UBOOT_ENTRYSYMBOL")) + + # Prepare a DTB image section + kernel_devicetree = d.getVar('KERNEL_DEVICETREE') + external_kernel_devicetree = d.getVar("EXTERNAL_KERNEL_DEVICETREE") + if kernel_devicetree: + for dtb in kernel_devicetree.split(): + dtb_name = os.path.basename(dtb) + + # Skip DTB if it's also provided in EXTERNAL_KERNEL_DEVICETREE directory + if external_kernel_devicetree: + ext_dtb_path = os.path.join(d.getVar("EXTERNAL_KERNEL_DEVICETREE"), dtb_name) + if os.path.exists(ext_dtb_path) and os.path.getsize(ext_dtb_path) > 0: + continue + + # Copy the dtb or dtbo file into the FIT image assembly directory + shutil.copyfile(os.path.join(recipe_sysroot, "sysroot-only", dtb_name), dtb_name) + root_node.fitimage_emit_section_dtb(dtb_name, dtb_name, + d.getVar("UBOOT_DTB_LOADADDRESS"), d.getVar("UBOOT_DTBO_LOADADDRESS")) + + if external_kernel_devicetree: + # iterate over all .dtb and .dtbo files in the external kernel devicetree directory + # and copy them to the FIT image assembly directory + for dtb_name in os.listdir(external_kernel_devicetree): + if dtb_name.endswith('.dtb') or dtb_name.endswith('.dtbo'): + dtb_path = os.path.join(external_kernel_devicetree, dtb_name) + + # Also skip if a symlink. We'll later have each config section point at it + if oe.fitimage.symlink_points_below(dtb_name, external_kernel_devicetree): + continue + + shutil.copyfile(dtb_path, dtb_name) + root_node.fitimage_emit_section_dtb(dtb_name, dtb_name, + d.getVar("UBOOT_DTB_LOADADDRESS"), d.getVar("UBOOT_DTBO_LOADADDRESS")) + + # Prepare a u-boot script section + fit_uboot_env = d.getVar("FIT_UBOOT_ENV") + if fit_uboot_env: + root_node.fitimage_emit_section_boot_script("bootscr-"+fit_uboot_env , fit_uboot_env) + + # Prepare a setup section (For x86) + setup_bin_path = os.path.join(recipe_sysroot, "sysroot-only", "setup.bin") + if os.path.exists(setup_bin_path): + shutil.copyfile(setup_bin_path, "setup.bin") + root_node.fitimage_emit_section_setup("setup-1", "setup.bin") + + # Prepare a ramdisk section. + initramfs_image = d.getVar('INITRAMFS_IMAGE') + if initramfs_image and not oe.types.boolean(d.getVar("INITRAMFS_IMAGE_BUNDLE")): + # Find and use the first initramfs image archive type we find + found = False + for img in d.getVar("FIT_SUPPORTED_INITRAMFS_FSTYPES").split(): + initramfs_path = os.path.join(d.getVar("DEPLOY_DIR_IMAGE"), "%s.%s" % (d.getVar('INITRAMFS_IMAGE_NAME'), img)) + if os.path.exists(initramfs_path): + bb.note("Found initramfs image: " + initramfs_path) + found = True + root_node.fitimage_emit_section_ramdisk("ramdisk-1", initramfs_path, + initramfs_image, + d.getVar("UBOOT_RD_LOADADDRESS"), + d.getVar("UBOOT_RD_ENTRYPOINT")) + break + else: + bb.note("Did not find initramfs image: " + initramfs_path) + + if not found: + bb.fatal("Could not find a valid initramfs type for %s, the supported types are: %s" % (d.getVar('INITRAMFS_IMAGE_NAME'), d.getVar('FIT_SUPPORTED_INITRAMFS_FSTYPES'))) + + # Generate the configuration section + root_node.fitimage_emit_section_config() + + # Write the its file + root_node.write_its_file(itsfile) + + # Assemble the FIT image + root_node.run_mkimage_assemble(itsfile, fitname) + + # Sign the FIT image if required + root_node.run_mkimage_sign(fitname) +} + +do_install() { + install -d "${D}/${KERNEL_IMAGEDEST}" + install -m 0644 "${B}/fitImage" "${D}/${KERNEL_IMAGEDEST}/fitImage" +} + +FILES:${PN} = "${KERNEL_IMAGEDEST}" + + +do_deploy() { + deploy_dir="${DEPLOYDIR}" + if [ -n "${KERNEL_DEPLOYSUBDIR}" ]; then + deploy_dir="${DEPLOYDIR}/${KERNEL_DEPLOYSUBDIR}" + fi + install -d "$deploy_dir" + install -m 0644 "${B}/fitImage" "$deploy_dir/fitImage" + install -m 0644 "${B}/fit-image.its" "$deploy_dir/fit-image.its" + + if [ "${INITRAMFS_IMAGE_BUNDLE}" != "1" ]; then + ln -snf fit-image.its "$deploy_dir/fitImage-its-${KERNEL_FIT_NAME}.its" + if [ -n "${KERNEL_FIT_LINK_NAME}" ] ; then + ln -snf fit-image.its "$deploy_dir/fitImage-its-${KERNEL_FIT_LINK_NAME}" + fi + fi + + if [ -n "${INITRAMFS_IMAGE}" ]; then + ln -snf fit-image-its "$deploy_dir/fitImage-its-${INITRAMFS_IMAGE_NAME}-${KERNEL_FIT_NAME}.its" + if [ -n "${KERNEL_FIT_LINK_NAME}" ]; then + ln -snf fit-image.its "$deploy_dir/fitImage-its-${INITRAMFS_IMAGE_NAME}-${KERNEL_FIT_LINK_NAME}" + fi + + if [ "${INITRAMFS_IMAGE_BUNDLE}" != "1" ]; then + ln -snf fitImage "$deploy_dir/fitImage-${INITRAMFS_IMAGE_NAME}-${KERNEL_FIT_NAME}${KERNEL_FIT_BIN_EXT}" + if [ -n "${KERNEL_FIT_LINK_NAME}" ] ; then + ln -snf fitImage "$deploy_dir/fitImage-${INITRAMFS_IMAGE_NAME}-${KERNEL_FIT_LINK_NAME}" + fi + fi + fi +} +addtask deploy after do_compile before do_build diff --git a/meta/classes/multilib.bbclass b/meta/classes/multilib.bbclass index a4151658a62..b959bbd93c0 100644 --- a/meta/classes/multilib.bbclass +++ b/meta/classes/multilib.bbclass @@ -21,6 +21,7 @@ python multilib_virtclass_handler () { bpn = d.getVar("BPN") if ("virtual/kernel" in provides or bb.data.inherits_class('module-base', d) + or bb.data.inherits_class('kernel-fit-image', d) or bpn in non_ml_recipes): raise bb.parse.SkipRecipe("We shouldn't have multilib variants for %s" % bpn) diff --git a/meta/lib/oe/fitimage.py b/meta/lib/oe/fitimage.py new file mode 100644 index 00000000000..735c09b151d --- /dev/null +++ b/meta/lib/oe/fitimage.py @@ -0,0 +1,463 @@ +# +# Copyright OpenEmbedded Contributors +# +# SPDX-License-Identifier: GPL-2.0-only +# +# This file contains common functions for the fitimage generation + +import os +import shlex +import subprocess +import bb + +from oeqa.utils.commands import runCmd + +class ItsNode: + INDENT_SIZE = 8 + + def __init__(self, name, parent_node, sub_nodes=None, properties=None): + self.name = name + self.parent_node = parent_node + + self.sub_nodes = [] + if sub_nodes: + self.sub_nodes = sub_nodes + + self.properties = {} + if properties: + self.properties = properties + + if parent_node: + parent_node.add_sub_node(self) + + def add_sub_node(self, sub_node): + self.sub_nodes.append(sub_node) + + def add_property(self, key, value): + self.properties[key] = value + + def emit(self, f, indent): + indent_str_name = " " * indent + indent_str_props = " " * (indent + self.INDENT_SIZE) + f.write("%s%s {\n" % (indent_str_name, self.name)) + for key, value in self.properties.items(): + bb.debug(1, "key: %s, value: %s" % (key, str(value))) + # Single integer: <0x12ab> + if isinstance(value, int): + f.write(indent_str_props + key + ' = <0x%x>;\n' % value) + # list of strings: "string1", "string2" or integers: <0x12ab 0x34cd> + elif isinstance(value, list): + if len(value) == 0: + f.write(indent_str_props + key + ' = "";\n') + elif isinstance(value[0], int): + list_entries = ' '.join('0x%x' % entry for entry in value) + f.write(indent_str_props + key + ' = <%s>;\n' % list_entries) + else: + list_entries = ', '.join('"%s"' % entry for entry in value) + f.write(indent_str_props + key + ' = %s;\n' % list_entries) + elif isinstance(value, str): + # path: /incbin/("path/to/file") + if key in ["data"] and value.startswith('/incbin/('): + f.write(indent_str_props + key + ' = %s;\n' % value) + # Integers which are already string formatted + elif value.startswith("<") and value.endswith(">"): + f.write(indent_str_props + key + ' = %s;\n' % value) + else: + f.write(indent_str_props + key + ' = "%s";\n' % value) + else: + bb.fatal("%s has unexpexted data type." % str(value)) + for sub_node in self.sub_nodes: + sub_node.emit(f, indent + self.INDENT_SIZE) + f.write(indent_str_name + '};\n') + +class ItsNodeImages(ItsNode): + def __init__(self, parent_node): + super().__init__("images", parent_node) + +class ItsNodeConfigurations(ItsNode): + def __init__(self, parent_node): + super().__init__("configurations", parent_node) + +class ItsNodeHash(ItsNode): + def __init__(self, name, parent_node, algo, opt_props=None): + properties = { + "algo": algo + } + if opt_props: + properties.update(opt_props) + super().__init__(name, parent_node, None, properties) + +class ItsImageSignature(ItsNode): + def __init__(self, name, parent_node, algo, keyname, opt_props=None): + properties = { + "algo": algo, + "key-name-hint": keyname + } + if opt_props: + properties.update(opt_props) + super().__init__(name, parent_node, None, properties) + +class ItsNodeImage(ItsNode): + def __init__(self, name, parent_node, description, type, compression, sub_nodes=None, opt_props=None): + properties = { + "description": description, + "type": type, + "compression": compression, + } + if opt_props: + properties.update(opt_props) + super().__init__(name, parent_node, sub_nodes, properties) + +class ItsNodeConfigurationSignature(ItsNode): + def __init__(self, name, parent_node, algo, keyname, opt_props=None): + properties = { + "algo": algo, + "key-name-hint": keyname + } + if opt_props: + properties.update(opt_props) + super().__init__(name, parent_node, None, properties) + +class ItsNodeConfiguration(ItsNode): + def __init__(self, name, parent_node, description, sub_nodes=None, opt_props=None): + properties = { + "description": description, + } + if opt_props: + properties.update(opt_props) + super().__init__(name, parent_node, sub_nodes, properties) + +class ItsNodeRootKernel(ItsNode): + """Create FIT images for the kernel + + Currently only a single kernel (no less or more) can be added to the FIT + image along with 0 or more device trees and 0 or 1 ramdisk. + + If a device tree included in the FIT image, the default configuration is the + firt DTB. If there is no dtb present than the default configuation the kernel. + """ + def __init__(self, description, address_cells, host_prefix, arch, conf_prefix, + sign_enable=False, sign_keydir=None, + mkimage=None, mkimage_dtcopts=None, + mkimage_sign=None, mkimage_sign_args=None, + hash_algo=None, sign_algo=None, pad_algo=None, + sign_keyname_conf=None, + sign_individual=False, sign_keyname_img=None): + props = { + "description": description, + "#address-cells": f"<{address_cells}>" + } + super().__init__("/", None, None, props) + self.images = ItsNodeImages(self) + self.configurations = ItsNodeConfigurations(self) + + self._host_prefix = host_prefix + self._arch = arch + self._conf_prefix = conf_prefix + + # Signature related properties + self._sign_enable = sign_enable + self._sign_keydir = sign_keydir + self._mkimage = mkimage + self._mkimage_dtcopts = mkimage_dtcopts + self._mkimage_sign = mkimage_sign + self._mkimage_sign_args = mkimage_sign_args + self._hash_algo = hash_algo + self._sign_algo = sign_algo + self._pad_algo = pad_algo + self._sign_keyname_conf = sign_keyname_conf + self._sign_individual = sign_individual + self._sign_keyname_img = sign_keyname_img + self._sanitize_sign_config() + + self._dtbs = [] + self._kernel = None + self._ramdisk = None + self._bootscr = None + self._setup = None + + def _sanitize_sign_config(self): + if self._sign_enable: + if not self._hash_algo: + bb.fatal("FIT image signing is enabled but no hash algorithm is provided.") + if not self._sign_algo: + bb.fatal("FIT image signing is enabled but no signature algorithm is provided.") + if not self._pad_algo: + bb.fatal("FIT image signing is enabled but no padding algorithm is provided.") + if not self._sign_keyname_conf: + bb.fatal("FIT image signing is enabled but no configuration key name is provided.") + if self._sign_individual and not self._sign_keyname_img: + bb.fatal("FIT image signing is enabled for individual images but no image key name is provided.") + + def write_its_file(self, itsfile): + with open(itsfile, 'w') as f: + f.write("/dts-v1/;\n\n") + self.emit(f, 0) + + def its_add_node_image(self, image_id, description, image_type, compression, opt_props): + image_node = ItsNodeImage( + image_id, + self.images, + description, + image_type, + compression, + opt_props=opt_props + ) + if self._hash_algo: + ItsNodeHash( + "hash-1", + image_node, + self._hash_algo + ) + if self._sign_individual: + ItsImageSignature( + "signature-1", + image_node, + f"{self._hash_algo},{self._sign_algo}", + self._sign_keyname_img + ) + return image_node + + def fitimage_emit_section_kernel(self, kernel_id, kernel_path, compression, + load, entrypoint, mkimage_kernel_type, entrysymbol=None): + """Emit the fitImage ITS kernel section""" + if self._kernel: + bb.fatal("Kernel section already exists in the ITS file.") + if entrysymbol: + result = subprocess.run([self._host_prefix + "nm", "vmlinux"], capture_output=True, text=True) + for line in result.stdout.splitlines(): + parts = line.split() + if len(parts) == 3 and parts[2] == entrysymbol: + entrypoint = "<0x%s>" % parts[0] + break + kernel_node = self.its_add_node_image( + kernel_id, + "Linux kernel", + mkimage_kernel_type, + compression, + { + "data": '/incbin/("' + kernel_path + '")', + "arch": self._arch, + "os": "linux", + "load": f"<{load}>", + "entry": f"<{entrypoint}>" + } + ) + self._kernel = kernel_node + + def fitimage_emit_section_dtb(self, dtb_id, dtb_path, dtb_loadaddress=None, dtbo_loadaddress=None): + """Emit the fitImage ITS DTB section""" + load=None + dtb_ext = os.path.splitext(dtb_path)[1] + if dtb_ext == ".dtbo": + if dtbo_loadaddress: + load = dtbo_loadaddress + elif dtb_loadaddress: + load = dtb_loadaddress + + opt_props = { + "data": '/incbin/("' + dtb_path + '")', + "arch": self._arch + } + if load: + opt_props["load"] = f"<{load}>" + + dtb_node = self.its_add_node_image( + "fdt-" + dtb_id, + "Flattened Device Tree blob", + "flat_dt", + "none", + opt_props + ) + self._dtbs.append(dtb_node) + + def fitimage_emit_section_boot_script(self, bootscr_id, bootscr_path): + """Emit the fitImage ITS u-boot script section""" + if self._bootscr: + bb.fatal("U-boot script section already exists in the ITS file.") + bootscr_node = self.its_add_node_image( + bootscr_id, + "U-boot script", + "script", + "none", + { + "data": '/incbin/("' + bootscr_path + '")', + "arch": self._arch, + "type": "script" + } + ) + self._bootscr = bootscr_node + + def fitimage_emit_section_setup(self, setup_id, setup_path): + """Emit the fitImage ITS setup section""" + if self._setup: + bb.fatal("Setup section already exists in the ITS file.") + load = "<0x00090000>" + entry = "<0x00090000>" + setup_node = self.its_add_node_image( + setup_id, + "Linux setup.bin", + "x86_setup", + "none", + { + "data": '/incbin/("' + setup_path + '")', + "arch": self._arch, + "os": "linux", + "load": load, + "entry": entry + } + ) + self._setup = setup_node + + def fitimage_emit_section_ramdisk(self, ramdisk_id, ramdisk_path, description="ramdisk", load=None, entry=None): + """Emit the fitImage ITS ramdisk section""" + if self._ramdisk: + bb.fatal("Ramdisk section already exists in the ITS file.") + opt_props = { + "data": '/incbin/("' + ramdisk_path + '")', + "type": "ramdisk", + "arch": self._arch, + "os": "linux" + } + if load: + opt_props["load"] = f"<{load}>" + if entry: + opt_props["entry"] = f"<{entry}>" + + ramdisk_node = self.its_add_node_image( + ramdisk_id, + description, + "ramdisk", + "none", + opt_props + ) + self._ramdisk = ramdisk_node + + def _fitimage_emit_one_section_config(self, conf_node_name, dtb=None): + """Emit the fitImage ITS configuration section""" + opt_props = {} + conf_desc = [] + sign_entries = [] + + if self._kernel: + conf_desc.append("Linux kernel") + opt_props["kernel"] = self._kernel.name + if self._sign_enable: + sign_entries.append("kernel") + + if dtb: + conf_desc.append("FDT blob") + opt_props["fdt"] = dtb.name + if self._sign_enable: + sign_entries.append("fdt") + + if self._ramdisk: + conf_desc.append("ramdisk") + opt_props["ramdisk"] = self._ramdisk.name + if self._sign_enable: + sign_entries.append("ramdisk") + + if self._bootscr: + conf_desc.append("u-boot script") + opt_props["bootscr"] = self._bootscr.name + if self._sign_enable: + sign_entries.append("bootscr") + + if self._setup: + conf_desc.append("setup") + opt_props["setup"] = self._setup.name + if self._sign_enable: + sign_entries.append("setup") + + # First added configuration is the default configuration + default_flag = "0" + if len(self.configurations.sub_nodes) == 0: + default_flag = "1" + + conf_node = ItsNodeConfiguration( + conf_node_name, + self.configurations, + f"{default_flag} {', '.join(conf_desc)}", + opt_props=opt_props + ) + if self._hash_algo: + ItsNodeHash( + "hash-1", + conf_node, + self._hash_algo + ) + if self._sign_enable: + ItsNodeConfigurationSignature( + "signature-1", + conf_node, + f"{self._hash_algo},{self._sign_algo}", + self._sign_keyname_conf, + opt_props={ + "padding": self._pad_algo, + "sign-images": sign_entries + } + ) + + def fitimage_emit_section_config(self): + if self._dtbs: + for dtb in self._dtbs: + self._fitimage_emit_one_section_config('conf-' + dtb.name.lstrip("fdt-"), dtb) + else: + self._fitimage_emit_one_section_config("conf-1") + self.configurations.add_property('default', self.configurations.sub_nodes[0].name) + + def run_mkimage_assemble(self, itsfile, fitfile): + cmd = [ + self._mkimage, + '-f', itsfile, + fitfile + ] + if self._mkimage_dtcopts: + cmd.insert(1, '-D') + cmd.insert(2, self._mkimage_dtcopts) + try: + subprocess.run(cmd, check=True, capture_output=True) + except subprocess.CalledProcessError as e: + bb.fatal(f"Command '{' '.join(cmd)}' failed with return code {e.returncode}\nstdout: {e.stdout.decode()}\nstderr: {e.stderr.decode()}\nitsflile: {os.path.abspath(itsfile)}") + + def run_mkimage_sign(self, fitfile): + if not self._sign_enable: + bb.debug(1, "FIT image signing is disabled. Skipping signing.") + return + + # Some sanity checks because mkimage exits with 0 also without needed keys + sign_key_path = os.path.join(self._sign_keydir, self._sign_keyname_conf) + if not os.path.exists(sign_key_path + '.key') or not os.path.exists(sign_key_path + '.crt'): + bb.fatal("%s.key or .crt does not exist" % sign_key_path) + if self._sign_individual: + sign_key_img_path = os.path.join(self._sign_keydir, self._sign_keyname_img) + if not os.path.exists(sign_key_img_path + '.key') or not os.path.exists(sign_key_img_path + '.crt'): + bb.fatal("%s.key or .crt does not exist" % sign_key_img_path) + + cmd = [ + self._mkimage_sign, + '-F', + '-k', self._sign_keydir, + '-r', fitfile + ] + if self._mkimage_dtcopts: + cmd.extend(['-D', self._mkimage_dtcopts]) + if self._mkimage_sign_args: + cmd.extend(shlex.split(self._mkimage_sign_args)) + try: + subprocess.run(cmd, check=True, capture_output=True) + except subprocess.CalledProcessError as e: + bb.fatal(f"Command '{' '.join(cmd)}' failed with return code {e.returncode}\nstdout: {e.stdout.decode()}\nstderr: {e.stderr.decode()}") + + +def symlink_points_below(file_or_symlink, expected_parent_dir): + """returns symlink destination if it points below directory""" + file_path = os.path.join(expected_parent_dir, file_or_symlink) + if not os.path.islink(file_path): + return None + + realpath = os.path.relpath(os.path.realpath(file_path), expected_parent_dir) + if realpath.startswith(".."): + return None + + return realpath diff --git a/meta/recipes-kernel/linux/linux-yocto-fitimage_6.12.bb b/meta/recipes-kernel/linux/linux-yocto-fitimage_6.12.bb new file mode 100644 index 00000000000..d5efc60737e --- /dev/null +++ b/meta/recipes-kernel/linux/linux-yocto-fitimage_6.12.bb @@ -0,0 +1,13 @@ +SUMMARY = "The Linux kernel as a FIT image (optionally with initramfs)" +SECTION = "kernel" + +# If an initramfs is included in the FIT image more licenses apply. +# But also the kernel uses more than one license (see Documentation/process/license-rules.rst) +LICENSE = "GPL-2.0-with-Linux-syscall-note" +LIC_FILES_CHKSUM = "file://${COREBASE}/meta/files/common-licenses/GPL-2.0-with-Linux-syscall-note;md5=0bad96c422c41c3a94009dcfe1bff992" + +LINUX_VERSION ?= "6.12.23" + +PV = "${LINUX_VERSION}+git" + +inherit kernel-fit-image From patchwork Wed May 14 18:50:53 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: AdrianF X-Patchwork-Id: 62971 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 5528DC54E93 for ; Wed, 14 May 2025 18:53:43 +0000 (UTC) Received: from mta-64-227.siemens.flowmailer.net (mta-64-227.siemens.flowmailer.net [185.136.64.227]) by mx.groups.io with SMTP id smtpd.web11.110593.1747248814475061249 for ; Wed, 14 May 2025 11:53:34 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=adrian.freihofer@siemens.com header.s=fm1 header.b=SH4AgUif; spf=pass (domain: rts-flowmailer.siemens.com, ip: 185.136.64.227, mailfrom: fm-1329275-2025051418533213cd08957f5afeda19-sbpai7@rts-flowmailer.siemens.com) Received: by mta-64-227.siemens.flowmailer.net with ESMTPSA id 2025051418533213cd08957f5afeda19 for ; Wed, 14 May 2025 20:53:32 +0200 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; s=fm1; d=siemens.com; i=adrian.freihofer@siemens.com; h=Date:From:Subject:To:Message-ID:MIME-Version:Content-Type:Content-Transfer-Encoding:Cc:References:In-Reply-To; bh=Y+ckxu6IjctbBk0NDwTYJHq6+C44dHRhe6QUgVCl4Qo=; b=SH4AgUifn9pHIMFs2Wcqr6kZNRRePik457nwbVha98QHe+tkD/dQWUPY9W+kgynlD8AHu6 mooZ0W7EGynE01t9TuWFSKf5SSrdP4IrRaGWeX1/iMVHa6NmhyTsqnkLrOpSSzT+NhIGFkZ/ V3MexS3g3E1ZixFYYdU5Ej196uLAe8XtyFRBEh1dZNR+p0d5BqUCzDmATX4zGNwlOTMyZzSb kb901on69YS9HDsUeOC8MCR3lCs60lxICL78xNCpIFGN7Jwhm1vEoBYre+dC3J5PDIyO7F0R KLtbD9m/uoON+CubuNMF3fCs8w6vOfXe3G4oPDITbgaE+jrEfVNPDzVA==; From: AdrianF To: openembedded-core@lists.openembedded.org Cc: marex@denx.de, Adrian Freihofer Subject: [PATCH v3 09/22] maintainers: add myself for linux-yocto-fitimage Date: Wed, 14 May 2025 20:50:53 +0200 Message-ID: <20250514185225.162998-10-adrian.freihofer@siemens.com> In-Reply-To: <20250514185225.162998-1-adrian.freihofer@siemens.com> References: <20250514185225.162998-1-adrian.freihofer@siemens.com> MIME-Version: 1.0 X-Flowmailer-Platform: Siemens Feedback-ID: 519:519-1329275:519-21489:flowmailer 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 ; Wed, 14 May 2025 18:53:43 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/openembedded-core/message/216534 From: Adrian Freihofer Signed-off-by: Adrian Freihofer --- meta/conf/distro/include/maintainers.inc | 1 + 1 file changed, 1 insertion(+) diff --git a/meta/conf/distro/include/maintainers.inc b/meta/conf/distro/include/maintainers.inc index 69f6a2d2846..a8e23360e15 100644 --- a/meta/conf/distro/include/maintainers.inc +++ b/meta/conf/distro/include/maintainers.inc @@ -472,6 +472,7 @@ RECIPE_MAINTAINER:pn-libxxf86vm = "Unassigned " RECIPE_MAINTAINER:pn-libyaml = "Wang Mingyu " RECIPE_MAINTAINER:pn-lighttpd = "Unassigned " RECIPE_MAINTAINER:pn-linux-dummy = "Unassigned " +RECIPE_MAINTAINER:pn-linux-yocto-fitimage = "Adrian Freihofer " RECIPE_MAINTAINER:pn-linux-firmware = "Otavio Salvador " RECIPE_MAINTAINER:pn-linux-libc-headers = "Bruce Ashfield " RECIPE_MAINTAINER:pn-linux-yocto = "Bruce Ashfield " From patchwork Wed May 14 18:50:54 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: AdrianF X-Patchwork-Id: 62973 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 55062C54E92 for ; Wed, 14 May 2025 18:53:43 +0000 (UTC) Received: from mta-65-227.siemens.flowmailer.net (mta-65-227.siemens.flowmailer.net [185.136.65.227]) by mx.groups.io with SMTP id smtpd.web11.110594.1747248814675310645 for ; Wed, 14 May 2025 11:53:34 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=adrian.freihofer@siemens.com header.s=fm1 header.b=hhWRVhaB; spf=pass (domain: rts-flowmailer.siemens.com, ip: 185.136.65.227, mailfrom: fm-1329275-20250514185332d4f29d4e4e84d12146-2zzchl@rts-flowmailer.siemens.com) Received: by mta-65-227.siemens.flowmailer.net with ESMTPSA id 20250514185332d4f29d4e4e84d12146 for ; Wed, 14 May 2025 20:53:32 +0200 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; s=fm1; d=siemens.com; i=adrian.freihofer@siemens.com; h=Date:From:Subject:To:Message-ID:MIME-Version:Content-Type:Content-Transfer-Encoding:Cc:References:In-Reply-To; bh=PhjmjClip/o9NSERA8G8Yw12V2dNnYUM3Z5JT3Tffhc=; b=hhWRVhaBtdsP3I1/Q6gvaK9InycElqC8Qqii6A+rh8U+TGMRAKdJispsberOwsr3dSPKmK Xoqc7L1gsNp8Zh4m68Sz51TYWaz8KKh8Q/A8we7FNU3mpXhtBaGwPjZ2uq4ZvjSWLo6cT7P8 N+9sPk7T1EzGOUg14ufwRVyxQ0fBGGnN8ZQ4dFLGqPXXsYDVAupKCRUlXa03MHa2qDF/H/Kv hJ7ByyDbpx26eC3OT9ZNHdmznNI0YdRcdGzBOb9ZddSg9dNABPcZxmVbCb+Zxjf0uFh9ZcC8 PLx07H/bNqgVW3bpwPqqyMGLpDDMFFQzyrJh0J/WXx0S/eMJ/JN61mqQ==; From: AdrianF To: openembedded-core@lists.openembedded.org Cc: marex@denx.de, Adrian Freihofer Subject: [PATCH v3 10/22] oe-selftest: fitimage add tests for fitimage.py Date: Wed, 14 May 2025 20:50:54 +0200 Message-ID: <20250514185225.162998-11-adrian.freihofer@siemens.com> In-Reply-To: <20250514185225.162998-1-adrian.freihofer@siemens.com> References: <20250514185225.162998-1-adrian.freihofer@siemens.com> MIME-Version: 1.0 X-Flowmailer-Platform: Siemens Feedback-ID: 519:519-1329275:519-21489:flowmailer 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 ; Wed, 14 May 2025 18:53:43 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/openembedded-core/message/216536 From: Adrian Freihofer Having the FIT image generator code as a separate class, which is essentially independent of BitBake, also allows testing the code separately from BitBake. Take advantage of this enables testing more use cases with significantly faster tests. Signed-off-by: Adrian Freihofer --- meta/lib/oeqa/selftest/cases/fitimage.py | 145 ++++++++++++++++++++++- 1 file changed, 141 insertions(+), 4 deletions(-) diff --git a/meta/lib/oeqa/selftest/cases/fitimage.py b/meta/lib/oeqa/selftest/cases/fitimage.py index 47fb8534b37..d9d1211b074 100644 --- a/meta/lib/oeqa/selftest/cases/fitimage.py +++ b/meta/lib/oeqa/selftest/cases/fitimage.py @@ -4,13 +4,36 @@ # SPDX-License-Identifier: MIT # -from oeqa.selftest.case import OESelftestTestCase -from oeqa.utils.commands import runCmd, bitbake, get_bb_vars import os import re import shlex import logging import pprint +import tempfile + +import oe.fitimage + +from oeqa.selftest.case import OESelftestTestCase +from oeqa.utils.commands import runCmd, bitbake, get_bb_vars + + +class BbVarsMockGenKeys: + def __init__(self, keydir, gen_keys="0", sign_enabled="0", keyname="", sign_ind="0", img_keyname=""): + self.bb_vars = { + 'FIT_GENERATE_KEYS': gen_keys, + 'FIT_KEY_GENRSA_ARGS': "-F4", + 'FIT_KEY_REQ_ARGS': "-batch -new", + 'FIT_KEY_SIGN_PKCS': "-x509", + 'FIT_SIGN_INDIVIDUAL': sign_ind, + 'FIT_SIGN_NUMBITS': "2048", + 'UBOOT_SIGN_ENABLE': sign_enabled, + 'UBOOT_SIGN_IMG_KEYNAME': img_keyname, + 'UBOOT_SIGN_KEYDIR': keydir, + 'UBOOT_SIGN_KEYNAME': keyname, + } + + def getVar(self, var): + return self.bb_vars[var] class FitImageTestCase(OESelftestTestCase): """Test functions usable for testing kernel-fitimage.bbclass and uboot-sign.bbclass @@ -85,6 +108,25 @@ class FitImageTestCase(OESelftestTestCase): sing_key_path )) + @staticmethod + def generate_rsa_key(keydir, keyname, numbits, genrsa_args, req_args, sign_pkcs, openssl_path="openssl"): + sing_key_path = os.path.join(keydir, keyname) + if not os.path.isdir(keydir): + os.makedirs(keydir) + runCmd("%s genrsa %s -out %s.key %s" % ( + openssl_path, + genrsa_args, + sing_key_path, + numbits + )) + runCmd("%s req %s %s -key %s.key -out %s.crt" % ( + openssl_path, + req_args, + sign_pkcs, + sing_key_path, + sing_key_path + )) + @staticmethod def _gen_random_file(file_path, num_bytes=65536): with open(file_path, 'wb') as file_out: @@ -367,8 +409,7 @@ class FitImageTestCase(OESelftestTestCase): # Verify the FIT image self._check_fitimage(bb_vars, fitimage_path, uboot_tools_bindir) - -class KernelFitImageTests(FitImageTestCase): +class KernelFitImageBase(FitImageTestCase): """Test cases for the kernel-fitimage bbclass""" def _fit_get_bb_vars(self, additional_vars=[]): @@ -683,6 +724,8 @@ class KernelFitImageTests(FitImageTestCase): self.assertEqual(found_comments, num_signatures, "Expected %d signed and commented (%s) sections in the fitImage." % (num_signatures, a_comment)) +class KernelFitImageTests(KernelFitImageBase): + """Test cases for the kernel-fitimage bbclass""" def test_fit_image(self): """ @@ -928,6 +971,100 @@ FIT_HASH_ALG = "sha256" bb_vars = self._fit_get_bb_vars() self._test_fitimage(bb_vars) +class FitImagePyTests(KernelFitImageBase): + """Test cases for the fitimage.py module without calling bitbake""" + + def _test_fitimage_py(self, bb_vars_overrides=None): + topdir = os.path.join(os.environ['BUILDDIR']) + fitimage_its_path = os.path.join(topdir, self._testMethodName + '.its') + + # Provide variables without calling bitbake + bb_vars = { + # image-fitimage.conf + 'FIT_DESC': "Kernel fitImage for a dummy distro", + 'FIT_HASH_ALG': "sha256", + 'FIT_SIGN_ALG': "rsa2048", + 'FIT_PAD_ALG': "pkcs-1.5", + 'FIT_GENERATE_KEYS': "0", + 'FIT_SIGN_NUMBITS': "2048", + 'FIT_KEY_GENRSA_ARGS': "-F4", + 'FIT_KEY_REQ_ARGS': "-batch -new", + 'FIT_KEY_SIGN_PKCS': "-x509", + 'FIT_SIGN_INDIVIDUAL': "0", + 'FIT_CONF_PREFIX': "conf-", + 'FIT_SUPPORTED_INITRAMFS_FSTYPES': "cpio.lz4 cpio.lzo cpio.lzma cpio.xz cpio.zst cpio.gz ext2.gz cpio", + 'FIT_CONF_DEFAULT_DTB': "", + 'FIT_ADDRESS_CELLS': "1", + 'FIT_UBOOT_ENV': "", + # kernel.bbclass + 'UBOOT_ENTRYPOINT': "0x20008000", + 'UBOOT_LOADADDRESS': "0x20008000", + 'INITRAMFS_IMAGE': "", + 'INITRAMFS_IMAGE_BUNDLE': "", + # kernel-uboot.bbclass + 'FIT_KERNEL_COMP_ALG': "gzip", + 'FIT_KERNEL_COMP_ALG_EXTENSION': ".gz", + 'UBOOT_MKIMAGE_KERNEL_TYPE': "kernel", + # uboot-config.bbclass + 'UBOOT_MKIMAGE_DTCOPTS': "", + 'UBOOT_MKIMAGE': "uboot-mkimage", + 'UBOOT_MKIMAGE_SIGN': "uboot-mkimage", + 'UBOOT_MKIMAGE_SIGN_ARGS': "", + 'UBOOT_SIGN_ENABLE': "0", + 'UBOOT_SIGN_KEYDIR': None, + 'UBOOT_SIGN_KEYNAME': None, + 'UBOOT_SIGN_IMG_KEYNAME': None, + # others + 'MACHINE': "qemux86-64", + 'UBOOT_ARCH': "x86", + 'HOST_PREFIX': "x86_64-poky-linux-" + } + if bb_vars_overrides: + bb_vars.update(bb_vars_overrides) + + root_node = oe.fitimage.ItsNodeRootKernel( + bb_vars["FIT_DESC"], bb_vars["FIT_ADDRESS_CELLS"], + bb_vars['HOST_PREFIX'], bb_vars['UBOOT_ARCH'], bb_vars["FIT_CONF_PREFIX"], + oe.types.boolean(bb_vars['UBOOT_SIGN_ENABLE']), bb_vars["UBOOT_SIGN_KEYDIR"], + bb_vars["UBOOT_MKIMAGE"], bb_vars["UBOOT_MKIMAGE_DTCOPTS"], + bb_vars["UBOOT_MKIMAGE_SIGN"], bb_vars["UBOOT_MKIMAGE_SIGN_ARGS"], + bb_vars['FIT_HASH_ALG'], bb_vars['FIT_SIGN_ALG'], bb_vars['FIT_PAD_ALG'], + bb_vars['UBOOT_SIGN_KEYNAME'], + oe.types.boolean(bb_vars['FIT_SIGN_INDIVIDUAL']), bb_vars['UBOOT_SIGN_IMG_KEYNAME'] + ) + + root_node.fitimage_emit_section_kernel("kernel-1", "linux.bin", "none", + bb_vars.get('UBOOT_LOADADDRESS'), bb_vars.get('UBOOT_ENTRYPOINT'), + bb_vars.get('UBOOT_MKIMAGE_KERNEL_TYPE'), bb_vars.get("UBOOT_ENTRYSYMBOL") + ) + + dtb_files = FitImageTestCase._get_dtb_files(bb_vars) + for dtb in dtb_files: + root_node.fitimage_emit_section_dtb("fdt-" + dtb, os.path.join("a-dir", dtb), + bb_vars.get("UBOOT_DTB_LOADADDRESS"), bb_vars.get("UBOOT_DTBO_LOADADDRESS")) + + if bb_vars.get('FIT_UBOOT_ENV'): + root_node.fitimage_emit_section_boot_script( + "bootscr-" + bb_vars['FIT_UBOOT_ENV'], bb_vars['FIT_UBOOT_ENV']) + + if bb_vars['MACHINE'] == "qemux86-64": # Not really the right if + root_node.fitimage_emit_section_setup("setup-1", "setup1.bin") + + if bb_vars.get('INITRAMFS_IMAGE') and bb_vars.get("INITRAMFS_IMAGE_BUNDLE") != "1": + root_node.fitimage_emit_section_ramdisk("ramdisk-1", "a-dir/a-initramfs-1", + "core-image-minimal-initramfs", + bb_vars.get("UBOOT_RD_LOADADDRESS"), bb_vars.get("UBOOT_RD_ENTRYPOINT")) + + root_node.fitimage_emit_section_config() + root_node.write_its_file(fitimage_its_path) + + self.assertExists(fitimage_its_path, "%s image tree source doesn't exist" % (fitimage_its_path)) + self.logger.debug("Checking its: %s" % fitimage_its_path) + self._check_its_file(bb_vars, fitimage_its_path) + + def test_fitimage_py_default(self): + self._test_fitimage_py() + class UBootFitImageTests(FitImageTestCase): """Test cases for the uboot-sign bbclass""" From patchwork Wed May 14 18:50:55 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: AdrianF X-Patchwork-Id: 62977 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 628CDC54ED0 for ; Wed, 14 May 2025 18:53:43 +0000 (UTC) Received: from mta-64-226.siemens.flowmailer.net (mta-64-226.siemens.flowmailer.net [185.136.64.226]) by mx.groups.io with SMTP id smtpd.web11.110589.1747248811553974163 for ; Wed, 14 May 2025 11:53:33 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=adrian.freihofer@siemens.com header.s=fm1 header.b=dyX+Ak/S; spf=pass (domain: rts-flowmailer.siemens.com, ip: 185.136.64.226, mailfrom: fm-1329275-20250514185332cd640b7e58f6b2c9b0-7u93ha@rts-flowmailer.siemens.com) Received: by mta-64-226.siemens.flowmailer.net with ESMTPSA id 20250514185332cd640b7e58f6b2c9b0 for ; Wed, 14 May 2025 20:53:33 +0200 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; s=fm1; d=siemens.com; i=adrian.freihofer@siemens.com; h=Date:From:Subject:To:Message-ID:MIME-Version:Content-Type:Content-Transfer-Encoding:Cc:References:In-Reply-To; bh=dzshWsMc+mdnlUa6NWp7EK8QUVyToUKOudo26ZgSiwM=; b=dyX+Ak/Sh7OrLVKZ9T4EzNYq9fo7jr50/rKwYdI9WY4riRk8+rG14AOw693SnPR04QIpPp nZpBrF9aDP46RMlLvrrQIk5d4yGRfRSDl1gmQczCZ+FzsRhSXAXVQ7IqBaPF52CGTpebh1MV kQphGAGNfN0KSr15nx7fO0vesQTsdjSDTvaauf8FL/Q4URxGpaTos+oUa/w7/cf0OCq3ai2l 4i8lU3t+DOMN3UtURq9wCY50RL6QTXE2kjRoSmmH4M1wZUzDCbBo/C8HTZPzB7vvqSzOoYlt LzDVH6ES2PINZX0bJp6bZhAEVXc4ZlxkTuuP28y+NTzwZMMv1i+u6bvQ==; From: AdrianF To: openembedded-core@lists.openembedded.org Cc: marex@denx.de, Adrian Freihofer Subject: [PATCH v3 11/22] oe-selftest: fitimage refactor kernel-fitimage.bbclass Date: Wed, 14 May 2025 20:50:55 +0200 Message-ID: <20250514185225.162998-12-adrian.freihofer@siemens.com> In-Reply-To: <20250514185225.162998-1-adrian.freihofer@siemens.com> References: <20250514185225.162998-1-adrian.freihofer@siemens.com> MIME-Version: 1.0 X-Flowmailer-Platform: Siemens Feedback-ID: 519:519-1329275:519-21489:flowmailer 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 ; Wed, 14 May 2025 18:53:43 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/openembedded-core/message/216530 From: Adrian Freihofer Support that a recipe other than virtual/kernel provides the kernel FIT image. Therefore * Support building with either: - KERNEL_IMAGETYPES += " fitImage " - KERNEL_CLASSES = " kernel-fitimage " or - KERNEL_CLASSES = " kernel-uboot " * allow to specify which recipe gets bitbaked. --- meta/lib/oeqa/selftest/cases/fitimage.py | 55 +++++++++++++++--------- 1 file changed, 34 insertions(+), 21 deletions(-) diff --git a/meta/lib/oeqa/selftest/cases/fitimage.py b/meta/lib/oeqa/selftest/cases/fitimage.py index d9d1211b074..b001339b73b 100644 --- a/meta/lib/oeqa/selftest/cases/fitimage.py +++ b/meta/lib/oeqa/selftest/cases/fitimage.py @@ -428,6 +428,7 @@ class KernelFitImageBase(FitImageTestCase): 'INITRAMFS_IMAGE_BUNDLE', 'INITRAMFS_IMAGE_NAME', 'INITRAMFS_IMAGE', + 'KERNEL_DEPLOYSUBDIR', 'KERNEL_DEVICETREE', 'KERNEL_FIT_LINK_NAME', 'MACHINE', @@ -444,10 +445,21 @@ class KernelFitImageBase(FitImageTestCase): 'UBOOT_SIGN_KEYDIR', 'UBOOT_SIGN_KEYNAME', } - bb_vars = get_bb_vars(list(internal_used | set(additional_vars)), "virtual/kernel") + bb_vars = get_bb_vars(list(internal_used | set(additional_vars)), self.kernel_recipe) self.logger.debug("bb_vars: %s" % pprint.pformat(bb_vars, indent=4)) return bb_vars + def _config_add_kernel_classes(self, config): + config += '# Use kernel-fitimage.bbclass for the creation of the fitImage' + os.linesep + config += 'KERNEL_IMAGETYPES += " fitImage "' + os.linesep + config += 'KERNEL_CLASSES = " kernel-fitimage "' + os.linesep + return config + + @property + def kernel_recipe(self): + # virtual/kernel does not work with SRC_URI:append:pn-%s + return "linux-yocto" + def _config_add_uboot_env(self, config): """Generate an u-boot environment @@ -461,7 +473,7 @@ class KernelFitImageBase(FitImageTestCase): config += '# Add an u-boot script to the fitImage' + os.linesep config += 'FIT_UBOOT_ENV = "%s"' % fit_uenv_file + os.linesep config += 'FILESEXTRAPATHS:prepend := "${TOPDIR}/%s:"' % test_files_dir + os.linesep - config += 'SRC_URI:append:pn-linux-yocto = " file://${FIT_UBOOT_ENV}"' + os.linesep + config += 'SRC_URI:append:pn-%s = " file://${FIT_UBOOT_ENV}"' % self.kernel_recipe + os.linesep if not os.path.isdir(test_files_dir): os.makedirs(test_files_dir) @@ -473,7 +485,7 @@ class KernelFitImageBase(FitImageTestCase): def _bitbake_fit_image(self, bb_vars): """Bitbake the kernel and return the paths to the its file and the FIT image""" - bitbake("virtual/kernel") + bitbake(self.kernel_recipe) # Find the right its file and the final fitImage and check if both files are available deploy_dir_image = bb_vars['DEPLOY_DIR_IMAGE'] @@ -492,8 +504,13 @@ class KernelFitImageBase(FitImageTestCase): fitimage_name = "fitImage" # or fitImage-${KERNEL_IMAGE_LINK_NAME}${KERNEL_IMAGE_BIN_EXT} else: self.fail('Invalid configuration: INITRAMFS_IMAGE_BUNDLE = "1" and not INITRAMFS_IMAGE') - fitimage_its_path = os.path.realpath(os.path.join(deploy_dir_image, fitimage_its_name)) - fitimage_path = os.path.realpath(os.path.join(deploy_dir_image, fitimage_name)) + kernel_deploysubdir = bb_vars['KERNEL_DEPLOYSUBDIR'] + if kernel_deploysubdir: + fitimage_its_path = os.path.realpath(os.path.join(deploy_dir_image, kernel_deploysubdir, fitimage_its_name)) + fitimage_path = os.path.realpath(os.path.join(deploy_dir_image, kernel_deploysubdir, fitimage_name)) + else: + fitimage_its_path = os.path.realpath(os.path.join(deploy_dir_image, fitimage_its_name)) + fitimage_path = os.path.realpath(os.path.join(deploy_dir_image, fitimage_name)) return (fitimage_its_path, fitimage_path) def _get_req_its_paths(self, bb_vars): @@ -741,10 +758,7 @@ class KernelFitImageTests(KernelFitImageBase): Author: Usama Arif """ config = """ -# Enable creation of fitImage KERNEL_IMAGETYPE = "Image" -KERNEL_IMAGETYPES += " fitImage " -KERNEL_CLASSES = " kernel-fitimage " # RAM disk variables including load address and entrypoint for kernel and RAM disk IMAGE_FSTYPES += "cpio.gz" @@ -757,6 +771,7 @@ UBOOT_LOADADDRESS = "0x80080000" UBOOT_ENTRYPOINT = "0x80080000" FIT_DESC = "A model description" """ + config = self._config_add_kernel_classes(config) self.write_config(config) bb_vars = self._fit_get_bb_vars() self._test_fitimage(bb_vars) @@ -772,11 +787,10 @@ FIT_DESC = "A model description" config = """ # Enable creation of fitImage MACHINE = "beaglebone-yocto" -KERNEL_IMAGETYPES += " fitImage " -KERNEL_CLASSES = " kernel-fitimage " # Add a devicetree overlay which does not need kernel sources PREFERRED_PROVIDER_virtual/dtb = "bborg-relay-00a2" """ + config = self._config_add_kernel_classes(config) config = self._config_add_uboot_env(config) self.write_config(config) bb_vars = self._fit_get_bb_vars() @@ -801,13 +815,12 @@ PREFERRED_PROVIDER_virtual/dtb = "bborg-relay-00a2" config = """ # Enable creation of fitImage MACHINE = "beaglebone-yocto" -KERNEL_IMAGETYPES += " fitImage " -KERNEL_CLASSES = " kernel-fitimage " UBOOT_SIGN_ENABLE = "1" UBOOT_SIGN_KEYDIR = "${TOPDIR}/signing-keys" UBOOT_SIGN_KEYNAME = "dev" UBOOT_MKIMAGE_SIGN_ARGS = "-c 'a smart comment'" """ + config = self._config_add_kernel_classes(config) config = self._config_add_uboot_env(config) self.write_config(config) @@ -852,8 +865,6 @@ UBOOT_MKIMAGE_SIGN_ARGS = "-c 'a smart comment'" config = """ # Enable creation of fitImage MACHINE = "beaglebone-yocto" -KERNEL_IMAGETYPES += " fitImage " -KERNEL_CLASSES = " kernel-fitimage " UBOOT_SIGN_ENABLE = "1" FIT_GENERATE_KEYS = "1" UBOOT_SIGN_KEYDIR = "${TOPDIR}/signing-keys" @@ -862,6 +873,7 @@ UBOOT_SIGN_KEYNAME = "cfg-oe-selftest" FIT_SIGN_INDIVIDUAL = "1" UBOOT_MKIMAGE_SIGN_ARGS = "-c 'a smart comment'" """ + config = self._config_add_kernel_classes(config) config = self._config_add_uboot_env(config) self.write_config(config) bb_vars = self._fit_get_bb_vars() @@ -888,8 +900,6 @@ MACHINE = "beaglebone-yocto" INITRAMFS_IMAGE = "core-image-minimal-initramfs" INITRAMFS_SCRIPTS = "" UBOOT_MACHINE = "am335x_evm_defconfig" -KERNEL_CLASSES = " kernel-fitimage " -KERNEL_IMAGETYPES = "fitImage" UBOOT_SIGN_ENABLE = "1" UBOOT_SIGN_KEYNAME = "beaglebonekey" UBOOT_SIGN_KEYDIR ?= "${DEPLOY_DIR_IMAGE}" @@ -908,6 +918,7 @@ KERNEL_IMAGETYPE_REPLACEMENT = "zImage" FIT_KERNEL_COMP_ALG = "none" FIT_HASH_ALG = "sha256" """ + config = self._config_add_kernel_classes(config) config = self._config_add_uboot_env(config) self.write_config(config) @@ -948,8 +959,6 @@ INITRAMFS_IMAGE_BUNDLE = "1" INITRAMFS_IMAGE = "core-image-minimal-initramfs" INITRAMFS_SCRIPTS = "" UBOOT_MACHINE = "am335x_evm_defconfig" -KERNEL_CLASSES = " kernel-fitimage " -KERNEL_IMAGETYPES = "fitImage" UBOOT_SIGN_ENABLE = "1" UBOOT_SIGN_KEYNAME = "beaglebonekey" UBOOT_SIGN_KEYDIR ?= "${DEPLOY_DIR_IMAGE}" @@ -966,11 +975,13 @@ KERNEL_IMAGETYPE_REPLACEMENT = "zImage" FIT_KERNEL_COMP_ALG = "none" FIT_HASH_ALG = "sha256" """ + config = self._config_add_kernel_classes(config) config = self._config_add_uboot_env(config) self.write_config(config) bb_vars = self._fit_get_bb_vars() self._test_fitimage(bb_vars) + class FitImagePyTests(KernelFitImageBase): """Test cases for the fitimage.py module without calling bitbake""" @@ -1069,6 +1080,8 @@ class FitImagePyTests(KernelFitImageBase): class UBootFitImageTests(FitImageTestCase): """Test cases for the uboot-sign bbclass""" + BOOTLOADER_RECIPE = "virtual/bootloader" + def _fit_get_bb_vars(self, additional_vars=[]): """Get bb_vars as needed by _test_sign_fit_image @@ -1110,13 +1123,13 @@ class UBootFitImageTests(FitImageTestCase): 'UBOOT_SIGN_KEYDIR', 'UBOOT_SIGN_KEYNAME', } - bb_vars = get_bb_vars(list(internal_used | set(additional_vars)), "virtual/bootloader") + bb_vars = get_bb_vars(list(internal_used | set(additional_vars)), UBootFitImageTests.BOOTLOADER_RECIPE) self.logger.debug("bb_vars: %s" % pprint.pformat(bb_vars, indent=4)) return bb_vars def _bitbake_fit_image(self, bb_vars): """Bitbake the bootloader and return the paths to the its file and the FIT image""" - bitbake("virtual/bootloader") + bitbake(UBootFitImageTests.BOOTLOADER_RECIPE) deploy_dir_image = bb_vars['DEPLOY_DIR_IMAGE'] machine = bb_vars['MACHINE'] @@ -1634,7 +1647,7 @@ FIT_SIGN_INDIVIDUAL = "1" # Using a static key. FIT_GENERATE_KEYS = "1" does not work without kernel-fitimage.bbclass self._gen_signing_key(bb_vars) - bitbake("virtual/bootloader") + bitbake(UBootFitImageTests.BOOTLOADER_RECIPE) # Just check the DTB of u-boot since there is no u-boot FIT image self._check_kernel_dtb(bb_vars) From patchwork Wed May 14 18:50:56 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: AdrianF X-Patchwork-Id: 62974 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 55D73C54ECC for ; Wed, 14 May 2025 18:53:43 +0000 (UTC) Received: from mta-65-228.siemens.flowmailer.net (mta-65-228.siemens.flowmailer.net [185.136.65.228]) by mx.groups.io with SMTP id smtpd.web11.110595.1747248814770269389 for ; Wed, 14 May 2025 11:53:35 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=adrian.freihofer@siemens.com header.s=fm1 header.b=AmlhW5EJ; spf=pass (domain: rts-flowmailer.siemens.com, ip: 185.136.65.228, mailfrom: fm-1329275-202505141853336431afb89725fa6b78-k_pexf@rts-flowmailer.siemens.com) Received: by mta-65-228.siemens.flowmailer.net with ESMTPSA id 202505141853336431afb89725fa6b78 for ; Wed, 14 May 2025 20:53:33 +0200 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; s=fm1; d=siemens.com; i=adrian.freihofer@siemens.com; h=Date:From:Subject:To:Message-ID:MIME-Version:Content-Type:Content-Transfer-Encoding:Cc:References:In-Reply-To; bh=JDU8pjxsBlfA45+CQjhC/j2ZvCR/eQWZyN5YnwjI8LQ=; b=AmlhW5EJMP+qhPqHGOUUBMLc4Fws7npG3mH+ALyroB5kSh2XZv+wnBb/NlQHAjZ8rsxslo XJHVxP0z3ht4x8jrLjgtI28SCm/zV3+hrwiW5lVhl07+rN/bNXGR3BB3BSXZ+OLp6b/YTLXf /TBhwHiyXGNgYMAjEvvdkiMsrSPeYde6//4K86Q5Nq6Of1VwsR4Zk53qSw8GDnHQD5FuCqpR MygoWnWIK6eF8g8N0u8uyUapdJdsUgzCUzvNQX721n98ciZnyLbO0xuQ9DphLR35owsKwop9 FmwRwNhZkmlSW4I/U9CG9mqM7CUhUkwQxB3FzVEg65LTQhYEm4HmhhxA==; From: AdrianF To: openembedded-core@lists.openembedded.org Cc: marex@denx.de, Adrian Freihofer Subject: [PATCH v3 12/22] oe-selftest: fitimage: run all tests for the FIT image recipe Date: Wed, 14 May 2025 20:50:56 +0200 Message-ID: <20250514185225.162998-13-adrian.freihofer@siemens.com> In-Reply-To: <20250514185225.162998-1-adrian.freihofer@siemens.com> References: <20250514185225.162998-1-adrian.freihofer@siemens.com> MIME-Version: 1.0 X-Flowmailer-Platform: Siemens Feedback-ID: 519:519-1329275:519-21489:flowmailer 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 ; Wed, 14 May 2025 18:53:43 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/openembedded-core/message/216537 From: Adrian Freihofer Run all existing tests for the kernel-fitimage.bbclass also for the new linux-yocto-fitimage recipe. This also ensures that both implementations are compatible with each other. Note: The vmlinux kernel artifacts required by the new linux-yocto-fitimage recipe are exported by the kernel-uboot.bbclass, which is inherited from the kernel-uimage.bbclass, which in turn is inherited by default from the kernel.bbclass as follows: KERNEL_CLASSES = " kernel-uboot " It is therefore no longer necessary to add anything to KERNEL_CLASSES when creating a fitImage. Signed-off-by: Adrian Freihofer --- meta/lib/oeqa/selftest/cases/fitimage.py | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/meta/lib/oeqa/selftest/cases/fitimage.py b/meta/lib/oeqa/selftest/cases/fitimage.py index b001339b73b..aadec58c30e 100644 --- a/meta/lib/oeqa/selftest/cases/fitimage.py +++ b/meta/lib/oeqa/selftest/cases/fitimage.py @@ -981,6 +981,17 @@ FIT_HASH_ALG = "sha256" bb_vars = self._fit_get_bb_vars() self._test_fitimage(bb_vars) +class KernelFitImageRecipeTests(KernelFitImageTests): + """Test cases for the linux-yocto-fitimage recipe""" + + @property + def kernel_recipe(self): + return "linux-yocto-fitimage" + + def _config_add_kernel_classes(self, config): + config += '# Avoid naming clashes in the deploy folder with kernel-fitimage.bbclass artifacts' + os.linesep + config += 'KERNEL_DEPLOYSUBDIR:pn-linux-yocto-fitimage = "linux-yocto-fitimage"' + os.linesep + return config class FitImagePyTests(KernelFitImageBase): """Test cases for the fitimage.py module without calling bitbake""" From patchwork Wed May 14 18:50:57 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: AdrianF X-Patchwork-Id: 62969 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 359DBC5479B for ; Wed, 14 May 2025 18:53:43 +0000 (UTC) Received: from mta-64-227.siemens.flowmailer.net (mta-64-227.siemens.flowmailer.net [185.136.64.227]) by mx.groups.io with SMTP id smtpd.web11.110596.1747248815037622799 for ; Wed, 14 May 2025 11:53:35 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=adrian.freihofer@siemens.com header.s=fm1 header.b=W+aTq119; spf=pass (domain: rts-flowmailer.siemens.com, ip: 185.136.64.227, mailfrom: fm-1329275-20250514185333a36d90d0dad40f163a-f_habg@rts-flowmailer.siemens.com) Received: by mta-64-227.siemens.flowmailer.net with ESMTPSA id 20250514185333a36d90d0dad40f163a for ; Wed, 14 May 2025 20:53:33 +0200 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; s=fm1; d=siemens.com; i=adrian.freihofer@siemens.com; h=Date:From:Subject:To:Message-ID:MIME-Version:Content-Type:Content-Transfer-Encoding:Cc:References:In-Reply-To; bh=9xWH8sIT9TBRjaRbRaGgLAJYrXhLwPSEwfjJNNkktdA=; b=W+aTq119D+XOeRQmYCUMQRc8PHQWAUixiOZ5Cl3Xl8+TGTzTAzRGMAu1b0NrmNsPItjbNK xQVhCcQ4mqsWQtpHrbGhjogHW4OBmju4RUxz/357QPLgOsBOs5+H5rAWmSqYGDUm6qTQ21cS sI8JH++pMT1zhFhZVHZhkuVq7Q9Yvixl1lEhTenvm3AJuh8hd431XKZuHG2uPhIQKpmNU7jw DieW0mJxw6hAvYz/rPy0jebCpqW+VC+WELc9T4/1olA/Ns3hBShycduKdDpgmMDOXntT9Pvg nldlfGVMY0UostM7nEDc9hy0QNOryC8dRcQxgeo+2MVyp0Wv6tmBBdSg==; From: AdrianF To: openembedded-core@lists.openembedded.org Cc: marex@denx.de, Adrian Freihofer Subject: [PATCH v3 13/22] oe-selftest: fitimage refactor classes Date: Wed, 14 May 2025 20:50:57 +0200 Message-ID: <20250514185225.162998-14-adrian.freihofer@siemens.com> In-Reply-To: <20250514185225.162998-1-adrian.freihofer@siemens.com> References: <20250514185225.162998-1-adrian.freihofer@siemens.com> MIME-Version: 1.0 X-Flowmailer-Platform: Siemens Feedback-ID: 519:519-1329275:519-21489:flowmailer 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 ; Wed, 14 May 2025 18:53:43 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/openembedded-core/message/216540 From: Adrian Freihofer Make the new KernelFitImageRecipeTests class the one that contains the code, and keep the KernelFitImageTests class as the one that just adds back the same tests. This will make it easier to delete the tests later, which will hopefully become obsolete when the kernel-fitimage.bbclass class is no longer needed. Signed-off-by: Adrian Freihofer --- meta/lib/oeqa/selftest/cases/fitimage.py | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/meta/lib/oeqa/selftest/cases/fitimage.py b/meta/lib/oeqa/selftest/cases/fitimage.py index aadec58c30e..4d0712b6f01 100644 --- a/meta/lib/oeqa/selftest/cases/fitimage.py +++ b/meta/lib/oeqa/selftest/cases/fitimage.py @@ -410,7 +410,7 @@ class FitImageTestCase(OESelftestTestCase): self._check_fitimage(bb_vars, fitimage_path, uboot_tools_bindir) class KernelFitImageBase(FitImageTestCase): - """Test cases for the kernel-fitimage bbclass""" + """Test cases for the linux-yocto-fitimage recipe""" def _fit_get_bb_vars(self, additional_vars=[]): """Retrieve BitBake variables specific to the test case. @@ -450,15 +450,13 @@ class KernelFitImageBase(FitImageTestCase): return bb_vars def _config_add_kernel_classes(self, config): - config += '# Use kernel-fitimage.bbclass for the creation of the fitImage' + os.linesep - config += 'KERNEL_IMAGETYPES += " fitImage "' + os.linesep - config += 'KERNEL_CLASSES = " kernel-fitimage "' + os.linesep + config += '# Avoid naming clashes in the deploy folder with kernel-fitimage.bbclass artifacts' + os.linesep + config += 'KERNEL_DEPLOYSUBDIR:pn-linux-yocto-fitimage = "linux-yocto-fitimage"' + os.linesep return config @property def kernel_recipe(self): - # virtual/kernel does not work with SRC_URI:append:pn-%s - return "linux-yocto" + return "linux-yocto-fitimage" def _config_add_uboot_env(self, config): """Generate an u-boot environment @@ -741,7 +739,7 @@ class KernelFitImageBase(FitImageTestCase): self.assertEqual(found_comments, num_signatures, "Expected %d signed and commented (%s) sections in the fitImage." % (num_signatures, a_comment)) -class KernelFitImageTests(KernelFitImageBase): +class KernelFitImageRecipeTests(KernelFitImageBase): """Test cases for the kernel-fitimage bbclass""" def test_fit_image(self): @@ -981,16 +979,18 @@ FIT_HASH_ALG = "sha256" bb_vars = self._fit_get_bb_vars() self._test_fitimage(bb_vars) -class KernelFitImageRecipeTests(KernelFitImageTests): - """Test cases for the linux-yocto-fitimage recipe""" +class KernelFitImageTests(KernelFitImageRecipeTests): + """Test cases for the kernel-fitimage.bbclass""" @property def kernel_recipe(self): - return "linux-yocto-fitimage" + # virtual/kernel does not work with SRC_URI:append:pn-%s + return "linux-yocto" def _config_add_kernel_classes(self, config): - config += '# Avoid naming clashes in the deploy folder with kernel-fitimage.bbclass artifacts' + os.linesep - config += 'KERNEL_DEPLOYSUBDIR:pn-linux-yocto-fitimage = "linux-yocto-fitimage"' + os.linesep + config += '# Use kernel-fitimage.bbclass for the creation of the fitImage' + os.linesep + config += 'KERNEL_IMAGETYPES += " fitImage "' + os.linesep + config += 'KERNEL_CLASSES = " kernel-fitimage "' + os.linesep return config class FitImagePyTests(KernelFitImageBase): From patchwork Wed May 14 18:50:58 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: AdrianF X-Patchwork-Id: 62975 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 39162C54799 for ; Wed, 14 May 2025 18:53:43 +0000 (UTC) Received: from mta-64-227.siemens.flowmailer.net (mta-64-227.siemens.flowmailer.net [185.136.64.227]) by mx.groups.io with SMTP id smtpd.web11.110597.1747248815189843296 for ; Wed, 14 May 2025 11:53:35 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=adrian.freihofer@siemens.com header.s=fm1 header.b=M92GGo0U; spf=pass (domain: rts-flowmailer.siemens.com, ip: 185.136.64.227, mailfrom: fm-1329275-202505141853334cea5ca6f6ad365090-o8h0lb@rts-flowmailer.siemens.com) Received: by mta-64-227.siemens.flowmailer.net with ESMTPSA id 202505141853334cea5ca6f6ad365090 for ; Wed, 14 May 2025 20:53:33 +0200 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; s=fm1; d=siemens.com; i=adrian.freihofer@siemens.com; h=Date:From:Subject:To:Message-ID:MIME-Version:Content-Type:Content-Transfer-Encoding:Cc:References:In-Reply-To; bh=AHQk8NMClnHnqaHYkPyaJwPmdJOyHXwLz4OOKYdDuT8=; b=M92GGo0UiuAI33N5ZxXT6T0lXH7KMrh8kFQGgm7XCKcGKZOfdLhWKm4GSuJBqfyeAKXlzj nb2MEe87ZjfvHfopgNpAIZVh44EhcqewITGEr9gCt9BDpRr97m1gzK9KR235y458ZPYPCcpN cfA+T3XlxCUeAGFZMAgTf/rgFTft7/ngVmYYbLPXHpG4VIsnAATefQZdTt3rBYIWTA4NtcMM agMhuIRVEkuRWxUAZWBJO2mjoqu1iF/JXcNPo08K6v/CLEpWDFpDRCYeEgxYogt0HSqjKE5c FRWHnSUltoSEDhHZVUOLzwqeHi8OClWqmWgVFikAOqYGZ8EkeYGlzy7g==; From: AdrianF To: openembedded-core@lists.openembedded.org Cc: marex@denx.de, Adrian Freihofer Subject: [PATCH v3 14/22] kernel-fitimage: re-write its code in Python Date: Wed, 14 May 2025 20:50:58 +0200 Message-ID: <20250514185225.162998-15-adrian.freihofer@siemens.com> In-Reply-To: <20250514185225.162998-1-adrian.freihofer@siemens.com> References: <20250514185225.162998-1-adrian.freihofer@siemens.com> MIME-Version: 1.0 X-Flowmailer-Platform: Siemens Feedback-ID: 519:519-1329275:519-21489:flowmailer 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 ; Wed, 14 May 2025 18:53:43 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/openembedded-core/message/216542 From: Adrian Freihofer Rewrite the kernel-fitimage.bbclass file in Python. This allows the reuse of the new fitimage Python library and a clear alignment of the two implementations. Actually, the motivation for an implementation in Python was different. During the transition from the kernel-fitimage.bbclass to the new linux-yocto-fitimage.bb, the existing shell code was rewritten in Python so that the fitimage.py library could be extracted. The new kernel-fit-image.bbclass and linux-yocto-fitimage.bb were then developed on this basis. This approach makes it possible to run the same tests for all different implementations: - kernel-fitimage.bbclass in Shell - kernel-fitimage.bbclass in Python - linux-yocto-fitimage.bb Changing the commit order now enables a smooth transition. The two implementations can coexist. Maintenance and testing should be feasible for a few months with reasonable effort as they share most of the code. But of course, the goal is to remove the kernel-fitimage.bbclass as soon as possible. Signed-off-by: Adrian Freihofer --- meta/classes-recipe/kernel-fitimage.bbclass | 860 ++++---------------- meta/classes-recipe/kernel-uboot.bbclass | 45 + 2 files changed, 220 insertions(+), 685 deletions(-) diff --git a/meta/classes-recipe/kernel-fitimage.bbclass b/meta/classes-recipe/kernel-fitimage.bbclass index 18c7c9bf872..58d1cc458b4 100644 --- a/meta/classes-recipe/kernel-fitimage.bbclass +++ b/meta/classes-recipe/kernel-fitimage.bbclass @@ -56,680 +56,170 @@ python __anonymous () { d.setVar('EXTERNAL_KERNEL_DEVICETREE', "${RECIPE_SYSROOT}/boot/devicetree") } -# -# Emit the fitImage ITS header -# -# $1 ... .its filename -fitimage_emit_fit_header() { - cat << EOF >> $1 -/dts-v1/; - -/ { - description = "${FIT_DESC}"; - #address-cells = <${FIT_ADDRESS_CELLS}>; -EOF -} - -# -# Emit the fitImage section bits -# -# $1 ... .its filename -# $2 ... Section bit type: imagestart - image section start -# confstart - configuration section start -# sectend - section end -# fitend - fitimage end -# -fitimage_emit_section_maint() { - case $2 in - imagestart) - cat << EOF >> $1 - - images { -EOF - ;; - confstart) - cat << EOF >> $1 - - configurations { -EOF - ;; - sectend) - cat << EOF >> $1 - }; -EOF - ;; - fitend) - cat << EOF >> $1 -}; -EOF - ;; - esac -} - -# -# Emit the fitImage ITS kernel section -# -# $1 ... .its filename -# $2 ... Image counter -# $3 ... Path to kernel image -# $4 ... Compression type -fitimage_emit_section_kernel() { - - kernel_csum="${FIT_HASH_ALG}" - kernel_sign_algo="${FIT_SIGN_ALG}" - kernel_sign_keyname="${UBOOT_SIGN_IMG_KEYNAME}" - - ENTRYPOINT="${UBOOT_ENTRYPOINT}" - if [ -n "${UBOOT_ENTRYSYMBOL}" ]; then - ENTRYPOINT=`${HOST_PREFIX}nm vmlinux | \ - awk '$3=="${UBOOT_ENTRYSYMBOL}" {print "0x"$1;exit}'` - fi - - cat << EOF >> $1 - kernel-$2 { - description = "Linux kernel"; - type = "${UBOOT_MKIMAGE_KERNEL_TYPE}"; - compression = "$4"; - data = /incbin/("$3"); - arch = "${UBOOT_ARCH}"; - os = "linux"; - load = <${UBOOT_LOADADDRESS}>; - entry = <$ENTRYPOINT>; - hash-1 { - algo = "$kernel_csum"; - }; - }; -EOF - - if [ "${UBOOT_SIGN_ENABLE}" = "1" -a "${FIT_SIGN_INDIVIDUAL}" = "1" -a -n "$kernel_sign_keyname" ] ; then - sed -i '$ d' $1 - cat << EOF >> $1 - signature-1 { - algo = "$kernel_csum,$kernel_sign_algo"; - key-name-hint = "$kernel_sign_keyname"; - }; - }; -EOF - fi -} - -# -# Emit the fitImage ITS DTB section -# -# $1 ... .its filename -# $2 ... Image counter -# $3 ... Path to DTB image -fitimage_emit_section_dtb() { - - dtb_csum="${FIT_HASH_ALG}" - dtb_sign_algo="${FIT_SIGN_ALG}" - dtb_sign_keyname="${UBOOT_SIGN_IMG_KEYNAME}" - - dtb_loadline="" - dtb_ext=${DTB##*.} - if [ "${dtb_ext}" = "dtbo" ]; then - if [ -n "${UBOOT_DTBO_LOADADDRESS}" ]; then - dtb_loadline="load = <${UBOOT_DTBO_LOADADDRESS}>;" - fi - elif [ -n "${UBOOT_DTB_LOADADDRESS}" ]; then - dtb_loadline="load = <${UBOOT_DTB_LOADADDRESS}>;" - fi - cat << EOF >> $1 - fdt-$2 { - description = "Flattened Device Tree blob"; - type = "flat_dt"; - compression = "none"; - data = /incbin/("$3"); - arch = "${UBOOT_ARCH}"; - $dtb_loadline - hash-1 { - algo = "$dtb_csum"; - }; - }; -EOF - - if [ "${UBOOT_SIGN_ENABLE}" = "1" -a "${FIT_SIGN_INDIVIDUAL}" = "1" -a -n "$dtb_sign_keyname" ] ; then - sed -i '$ d' $1 - cat << EOF >> $1 - signature-1 { - algo = "$dtb_csum,$dtb_sign_algo"; - key-name-hint = "$dtb_sign_keyname"; - }; - }; -EOF - fi -} - -# -# Emit the fitImage ITS u-boot script section -# -# $1 ... .its filename -# $2 ... Image counter -# $3 ... Path to boot script image -fitimage_emit_section_boot_script() { - - bootscr_csum="${FIT_HASH_ALG}" - bootscr_sign_algo="${FIT_SIGN_ALG}" - bootscr_sign_keyname="${UBOOT_SIGN_IMG_KEYNAME}" - - cat << EOF >> $1 - bootscr-$2 { - description = "U-boot script"; - type = "script"; - compression = "none"; - data = /incbin/("$3"); - arch = "${UBOOT_ARCH}"; - hash-1 { - algo = "$bootscr_csum"; - }; - }; -EOF - - if [ "${UBOOT_SIGN_ENABLE}" = "1" -a "${FIT_SIGN_INDIVIDUAL}" = "1" -a -n "$bootscr_sign_keyname" ] ; then - sed -i '$ d' $1 - cat << EOF >> $1 - signature-1 { - algo = "$bootscr_csum,$bootscr_sign_algo"; - key-name-hint = "$bootscr_sign_keyname"; - }; - }; -EOF - fi -} - -# -# Emit the fitImage ITS setup section -# -# $1 ... .its filename -# $2 ... Image counter -# $3 ... Path to setup image -fitimage_emit_section_setup() { - - setup_csum="${FIT_HASH_ALG}" - setup_sign_algo="${FIT_SIGN_ALG}" - setup_sign_keyname="${UBOOT_SIGN_IMG_KEYNAME}" - - cat << EOF >> $1 - setup-$2 { - description = "Linux setup.bin"; - type = "x86_setup"; - compression = "none"; - data = /incbin/("$3"); - arch = "${UBOOT_ARCH}"; - os = "linux"; - load = <0x00090000>; - entry = <0x00090000>; - hash-1 { - algo = "$setup_csum"; - }; - }; -EOF - - if [ "${UBOOT_SIGN_ENABLE}" = "1" -a "${FIT_SIGN_INDIVIDUAL}" = "1" -a -n "$setup_sign_keyname" ] ; then - sed -i '$ d' $1 - cat << EOF >> $1 - signature-1 { - algo = "$setup_csum,$setup_sign_algo"; - key-name-hint = "$setup_sign_keyname"; - }; - }; -EOF - fi -} - -# -# Emit the fitImage ITS ramdisk section -# -# $1 ... .its filename -# $2 ... Image counter -# $3 ... Path to ramdisk image -fitimage_emit_section_ramdisk() { - - ramdisk_csum="${FIT_HASH_ALG}" - ramdisk_sign_algo="${FIT_SIGN_ALG}" - ramdisk_sign_keyname="${UBOOT_SIGN_IMG_KEYNAME}" - ramdisk_loadline="" - ramdisk_entryline="" - - if [ -n "${UBOOT_RD_LOADADDRESS}" ]; then - ramdisk_loadline="load = <${UBOOT_RD_LOADADDRESS}>;" - fi - if [ -n "${UBOOT_RD_ENTRYPOINT}" ]; then - ramdisk_entryline="entry = <${UBOOT_RD_ENTRYPOINT}>;" - fi - - cat << EOF >> $1 - ramdisk-$2 { - description = "${INITRAMFS_IMAGE}"; - type = "ramdisk"; - compression = "none"; - data = /incbin/("$3"); - arch = "${UBOOT_ARCH}"; - os = "linux"; - $ramdisk_loadline - $ramdisk_entryline - hash-1 { - algo = "$ramdisk_csum"; - }; - }; -EOF - - if [ "${UBOOT_SIGN_ENABLE}" = "1" -a "${FIT_SIGN_INDIVIDUAL}" = "1" -a -n "$ramdisk_sign_keyname" ] ; then - sed -i '$ d' $1 - cat << EOF >> $1 - signature-1 { - algo = "$ramdisk_csum,$ramdisk_sign_algo"; - key-name-hint = "$ramdisk_sign_keyname"; - }; - }; -EOF - fi -} - -# -# echoes symlink destination if it points below directory -# -# $1 ... file that's a potential symlink -# $2 ... expected parent directory -symlink_points_below() { - file="$2/$1" - dir=$2 - - if ! [ -L "$file" ]; then - return - fi - - realpath="$(realpath --relative-to=$dir $file)" - if [ -z "${realpath%%../*}" ]; then - return - fi - - echo "$realpath" -} - -# -# Emit the fitImage ITS configuration section -# -# $1 ... .its filename -# $2 ... Linux kernel ID -# $3 ... DTB image name -# $4 ... ramdisk ID -# $5 ... u-boot script ID -# $6 ... config ID -# $7 ... default flag -# $8 ... default DTB image name -fitimage_emit_section_config() { - - conf_csum="${FIT_HASH_ALG}" - conf_sign_algo="${FIT_SIGN_ALG}" - conf_padding_algo="${FIT_PAD_ALG}" - if [ "${UBOOT_SIGN_ENABLE}" = "1" ] ; then - conf_sign_keyname="${UBOOT_SIGN_KEYNAME}" - fi - - its_file="$1" - kernel_id="$2" - dtb_image="$3" - ramdisk_id="$4" - bootscr_id="$5" - config_id="$6" - default_flag="$7" - default_dtb_image="$8" - - # Test if we have any DTBs at all - sep="" - conf_desc="" - conf_node="${FIT_CONF_PREFIX}" - kernel_line="" - fdt_line="" - ramdisk_line="" - bootscr_line="" - setup_line="" - default_line="" - compatible_line="" - - dtb_image_sect=$(symlink_points_below $dtb_image "${EXTERNAL_KERNEL_DEVICETREE}") - if [ -z "$dtb_image_sect" ]; then - dtb_image_sect=$dtb_image - fi - - dtb_path="${EXTERNAL_KERNEL_DEVICETREE}/${dtb_image_sect}" - if [ -f "$dtb_path" ] || [ -L "$dtb_path" ]; then - compat=$(fdtget -t s "$dtb_path" / compatible | sed 's/ /", "/g') - if [ -n "$compat" ]; then - compatible_line="compatible = \"$compat\";" - fi - fi - - dtb_image=$(echo $dtb_image | tr '/' '_') - dtb_image_sect=$(echo "${dtb_image_sect}" | tr '/' '_') - - # conf node name is selected based on dtb ID if it is present, - # otherwise its selected based on kernel ID - if [ -n "$dtb_image" ]; then - conf_node=$conf_node$dtb_image - else - conf_node=$conf_node$kernel_id - fi - - if [ -n "$kernel_id" ]; then - conf_desc="Linux kernel" - sep=", " - kernel_line="kernel = \"kernel-$kernel_id\";" - fi - - if [ -n "$dtb_image" ]; then - conf_desc="$conf_desc${sep}FDT blob" - sep=", " - fdt_line="fdt = \"fdt-$dtb_image_sect\";" - fi - - if [ -n "$ramdisk_id" ]; then - conf_desc="$conf_desc${sep}ramdisk" - sep=", " - ramdisk_line="ramdisk = \"ramdisk-$ramdisk_id\";" - fi - - if [ -n "$bootscr_id" ]; then - conf_desc="$conf_desc${sep}u-boot script" - sep=", " - bootscr_line="bootscr = \"bootscr-$bootscr_id\";" - fi - - if [ -n "$config_id" ]; then - conf_desc="$conf_desc${sep}setup" - setup_line="setup = \"setup-$config_id\";" - fi - - if [ "$default_flag" = "1" ]; then - # default node is selected based on dtb ID if it is present, - # otherwise its selected based on kernel ID - if [ -n "$dtb_image" ]; then - # Select default node as user specified dtb when - # multiple dtb exists. - if [ -n "$default_dtb_image" ]; then - default_line="default = \"${FIT_CONF_PREFIX}$default_dtb_image\";" - else - default_line="default = \"${FIT_CONF_PREFIX}$dtb_image\";" - fi - else - default_line="default = \"${FIT_CONF_PREFIX}$kernel_id\";" - fi - fi - - cat << EOF >> $its_file - $default_line - $conf_node { - description = "$default_flag $conf_desc"; - $compatible_line - $kernel_line - $fdt_line - $ramdisk_line - $bootscr_line - $setup_line - hash-1 { - algo = "$conf_csum"; - }; -EOF - - if [ -n "$conf_sign_keyname" ] ; then - - sign_line="sign-images = " - sep="" - - if [ -n "$kernel_id" ]; then - sign_line="$sign_line${sep}\"kernel\"" - sep=", " - fi - - if [ -n "$dtb_image" ]; then - sign_line="$sign_line${sep}\"fdt\"" - sep=", " - fi - - if [ -n "$ramdisk_id" ]; then - sign_line="$sign_line${sep}\"ramdisk\"" - sep=", " - fi - - if [ -n "$bootscr_id" ]; then - sign_line="$sign_line${sep}\"bootscr\"" - sep=", " - fi - - if [ -n "$config_id" ]; then - sign_line="$sign_line${sep}\"setup\"" - fi - - sign_line="$sign_line;" - - cat << EOF >> $its_file - signature-1 { - algo = "$conf_csum,$conf_sign_algo"; - key-name-hint = "$conf_sign_keyname"; - padding = "$conf_padding_algo"; - $sign_line - }; -EOF - fi - - cat << EOF >> $its_file - }; -EOF -} - -# -# Assemble fitImage -# -# $1 ... .its filename -# $2 ... fitImage name -# $3 ... include ramdisk -fitimage_assemble() { - kernelcount=1 - dtbcount="" - DTBS="" - ramdiskcount=$3 - setupcount="" - bootscr_id="" - default_dtb_image="" - rm -f $1 arch/${ARCH}/boot/$2 - - if [ -n "${UBOOT_SIGN_IMG_KEYNAME}" -a "${UBOOT_SIGN_KEYNAME}" = "${UBOOT_SIGN_IMG_KEYNAME}" ]; then - bbfatal "Keys used to sign images and configuration nodes must be different." - fi - - fitimage_emit_fit_header $1 - - # - # Step 1: Prepare a kernel image section. - # - fitimage_emit_section_maint $1 imagestart - - uboot_prep_kimage - fitimage_emit_section_kernel $1 $kernelcount linux.bin "$linux_comp" - - # - # Step 2: Prepare a DTB image section - # - - if [ -n "${KERNEL_DEVICETREE}" ]; then - dtbcount=1 - for DTB in ${KERNEL_DEVICETREE}; do - if echo $DTB | grep -q '/dts/'; then - bbwarn "$DTB contains the full path to the the dts file, but only the dtb name should be used." - DTB=`basename $DTB | sed 's,\.dts$,.dtb,g'` - fi - - # Skip ${DTB} if it's also provided in ${EXTERNAL_KERNEL_DEVICETREE} - if [ -n "${EXTERNAL_KERNEL_DEVICETREE}" ] && [ -s ${EXTERNAL_KERNEL_DEVICETREE}/${DTB} ]; then - continue - fi - - DTB_PATH="${KERNEL_OUTPUT_DIR}/dts/$DTB" - if [ ! -e "$DTB_PATH" ]; then - DTB_PATH="${KERNEL_OUTPUT_DIR}/$DTB" - fi - - # Strip off the path component from the filename - if "${@'false' if oe.types.boolean(d.getVar('KERNEL_DTBVENDORED')) else 'true'}"; then - DTB=`basename $DTB` - fi - - # Set the default dtb image if it exists in the devicetree. - if [ "${FIT_CONF_DEFAULT_DTB}" = "$DTB" ];then - default_dtb_image=$(echo "$DTB" | tr '/' '_') - fi - - DTB=$(echo "$DTB" | tr '/' '_') - - # Skip DTB if we've picked it up previously - echo "$DTBS" | tr ' ' '\n' | grep -xq "$DTB" && continue - - DTBS="$DTBS $DTB" - DTB=$(echo $DTB | tr '/' '_') - fitimage_emit_section_dtb $1 $DTB $DTB_PATH - done - fi - - if [ -n "${EXTERNAL_KERNEL_DEVICETREE}" ]; then - dtbcount=1 - for DTB in $(find "${EXTERNAL_KERNEL_DEVICETREE}" -name '*.dtb' -printf '%P\n' | sort) \ - $(find "${EXTERNAL_KERNEL_DEVICETREE}" -name '*.dtbo' -printf '%P\n' | sort); do - # Set the default dtb image if it exists in the devicetree. - if [ ${FIT_CONF_DEFAULT_DTB} = $DTB ];then - default_dtb_image=$(echo "$DTB" | tr '/' '_') - fi - - DTB=$(echo "$DTB" | tr '/' '_') - - # Skip DTB/DTBO if we've picked it up previously - echo "$DTBS" | tr ' ' '\n' | grep -xq "$DTB" && continue - - DTBS="$DTBS $DTB" - - # Also skip if a symlink. We'll later have each config section point at it - [ $(symlink_points_below $DTB "${EXTERNAL_KERNEL_DEVICETREE}") ] && continue - - DTB=$(echo $DTB | tr '/' '_') - fitimage_emit_section_dtb $1 $DTB "${EXTERNAL_KERNEL_DEVICETREE}/$DTB" - done - fi - - if [ -n "${FIT_CONF_DEFAULT_DTB}" ] && [ -z $default_dtb_image ]; then - bbwarn "${FIT_CONF_DEFAULT_DTB} is not available in the list of device trees." - fi - - # - # Step 3: Prepare a u-boot script section - # - - if [ -n "${FIT_UBOOT_ENV}" ]; then - cp ${UNPACKDIR}/${FIT_UBOOT_ENV} ${B} - bootscr_id="${FIT_UBOOT_ENV}" - fitimage_emit_section_boot_script $1 "$bootscr_id" ${FIT_UBOOT_ENV} - fi - - # - # Step 4: Prepare a setup section. (For x86) - # - if [ -e ${KERNEL_OUTPUT_DIR}/setup.bin ]; then - setupcount=1 - fitimage_emit_section_setup $1 $setupcount ${KERNEL_OUTPUT_DIR}/setup.bin - fi - - # - # Step 5: Prepare a ramdisk section. - # - if [ "x${ramdiskcount}" = "x1" ] && [ "${INITRAMFS_IMAGE_BUNDLE}" != "1" ]; then - # Find and use the first initramfs image archive type we find - found= - for img in ${FIT_SUPPORTED_INITRAMFS_FSTYPES}; do - initramfs_path="${INITRAMFS_DEPLOY_DIR_IMAGE}/${INITRAMFS_IMAGE_NAME}.$img" - if [ -e "$initramfs_path" ]; then - bbnote "Found initramfs image: $initramfs_path" - found=true - fitimage_emit_section_ramdisk $1 "$ramdiskcount" "$initramfs_path" - break - else - bbnote "Did not find initramfs image: $initramfs_path" - fi - done - - if [ -z "$found" ]; then - bbfatal "Could not find a valid initramfs type for ${INITRAMFS_IMAGE_NAME}, the supported types are: ${FIT_SUPPORTED_INITRAMFS_FSTYPES}" - fi - fi - - fitimage_emit_section_maint $1 sectend - - # Force the first Kernel and DTB in the default config - kernelcount=1 - if [ -n "$dtbcount" ]; then - dtbcount=1 - fi - - # - # Step 6: Prepare a configurations section - # - fitimage_emit_section_maint $1 confstart - - # kernel-fitimage.bbclass currently only supports a single kernel (no less or - # more) to be added to the FIT image along with 0 or more device trees and - # 0 or 1 ramdisk. - # It is also possible to include an initramfs bundle (kernel and rootfs in one binary) - # When the initramfs bundle is used ramdisk is disabled. - # If a device tree is to be part of the FIT image, then select - # the default configuration to be used is based on the dtbcount. If there is - # no dtb present than select the default configuation to be based on - # the kernelcount. - if [ -n "$DTBS" ]; then - i=1 - for DTB in ${DTBS}; do - dtb_ext=${DTB##*.} - if [ "$dtb_ext" = "dtbo" ]; then - fitimage_emit_section_config $1 "" "$DTB" "" "$bootscr_id" "" "`expr $i = $dtbcount`" "$default_dtb_image" - else - fitimage_emit_section_config $1 $kernelcount "$DTB" "$ramdiskcount" "$bootscr_id" "$setupcount" "`expr $i = $dtbcount`" "$default_dtb_image" - fi - i=`expr $i + 1` - done - else - defaultconfigcount=1 - fitimage_emit_section_config $1 $kernelcount "" "$ramdiskcount" "$bootscr_id" "$setupcount" $defaultconfigcount "$default_dtb_image" - fi - - fitimage_emit_section_maint $1 sectend - - fitimage_emit_section_maint $1 fitend - - # - # Step 7: Assemble the image - # - ${UBOOT_MKIMAGE} \ - ${@'-D "${UBOOT_MKIMAGE_DTCOPTS}"' if len('${UBOOT_MKIMAGE_DTCOPTS}') else ''} \ - -f $1 \ - ${KERNEL_OUTPUT_DIR}/$2 - - # - # Step 8: Sign the image - # - if [ "x${UBOOT_SIGN_ENABLE}" = "x1" ] ; then - ${UBOOT_MKIMAGE_SIGN} \ - ${@'-D "${UBOOT_MKIMAGE_DTCOPTS}"' if len('${UBOOT_MKIMAGE_DTCOPTS}') else ''} \ - -F -k "${UBOOT_SIGN_KEYDIR}" \ - -r ${KERNEL_OUTPUT_DIR}/$2 \ - ${UBOOT_MKIMAGE_SIGN_ARGS} - fi -} - -do_assemble_fitimage() { - if echo ${KERNEL_IMAGETYPES} | grep -wq "fitImage"; then - cd ${B} - fitimage_assemble fit-image.its fitImage-none "" - if [ "${INITRAMFS_IMAGE_BUNDLE}" != "1" ]; then - ln -sf fitImage-none ${B}/${KERNEL_OUTPUT_DIR}/fitImage - fi - fi +def fitimage_assemble(d, itsfile, fitname, ramdiskcount): + import shutil + import glob + import oe.fitimage + + DTBS="" + default_dtb_image="" + + for f in [itsfile, os.path.join("arch", d.getVar("ARCH"), "boot", fitname)]: + if os.path.exists(f): + os.remove(f) + + root_node = oe.fitimage.ItsNodeRootKernel( + d.getVar("FIT_DESC"), d.getVar("FIT_ADDRESS_CELLS"), + d.getVar('HOST_PREFIX'), d.getVar('UBOOT_ARCH'), d.getVar("FIT_CONF_PREFIX"), + d.getVar('UBOOT_SIGN_ENABLE') == "1", d.getVar("UBOOT_SIGN_KEYDIR"), + d.getVar("UBOOT_MKIMAGE"), d.getVar("UBOOT_MKIMAGE_DTCOPTS"), + d.getVar("UBOOT_MKIMAGE_SIGN"), d.getVar("UBOOT_MKIMAGE_SIGN_ARGS"), + d.getVar('FIT_HASH_ALG'), d.getVar('FIT_SIGN_ALG'), d.getVar('FIT_PAD_ALG'), + d.getVar('UBOOT_SIGN_KEYNAME'), + d.getVar('FIT_SIGN_INDIVIDUAL') == "1", d.getVar('UBOOT_SIGN_IMG_KEYNAME') + ) + + # + # Step 1: Prepare a kernel image section. + # + linux_comp = uboot_prep_kimage_py(d) + root_node.fitimage_emit_section_kernel("kernel-1", "linux.bin", linux_comp, + d.getVar('UBOOT_LOADADDRESS'), d.getVar('UBOOT_ENTRYPOINT'), + d.getVar('UBOOT_MKIMAGE_KERNEL_TYPE'), d.getVar("UBOOT_ENTRYSYMBOL")) + + # + # Step 2: Prepare a DTB image section + # + if d.getVar("KERNEL_DEVICETREE"): + for DTB in d.getVar("KERNEL_DEVICETREE").split(): + if "/dts/" in DTB: + bb.warn(f"{DTB} contains the full path to the dts file, but only the dtb name should be used.") + DTB = os.path.basename(DTB).replace(".dts", ".dtb") + + # Skip DTB if it's also provided in EXTERNAL_KERNEL_DEVICETREE + if d.getVar("EXTERNAL_KERNEL_DEVICETREE"): + ext_dtb_path = os.path.join(d.getVar("EXTERNAL_KERNEL_DEVICETREE"), DTB) + if os.path.exists(ext_dtb_path) and os.path.getsize(ext_dtb_path) > 0: + continue + + DTB_PATH = os.path.join(d.getVar("KERNEL_OUTPUT_DIR"), "dts", DTB) + if not os.path.exists(DTB_PATH): + DTB_PATH = os.path.join(d.getVar("KERNEL_OUTPUT_DIR"), DTB) + + # Strip off the path component from the filename + if not oe.types.boolean(d.getVar("KERNEL_DTBVENDORED")): + DTB = os.path.basename(DTB) + + # Set the default dtb image if it exists in the devicetree. + if d.getVar("FIT_CONF_DEFAULT_DTB") == DTB: + default_dtb_image = DTB.replace("/", "_") + + DTB = DTB.replace("/", "_") + + # Skip DTB if we've picked it up previously + if DTB in DTBS.split(): + continue + + DTBS += " " + DTB + + root_node.fitimage_emit_section_dtb(DTB, DTB_PATH, + d.getVar("UBOOT_DTB_LOADADDRESS"), d.getVar("UBOOT_DTBO_LOADADDRESS")) + + if d.getVar("EXTERNAL_KERNEL_DEVICETREE"): + dtb_files = [] + for ext in ['*.dtb', '*.dtbo']: + dtb_files.extend(sorted(glob.glob(os.path.join(d.getVar("EXTERNAL_KERNEL_DEVICETREE"), ext)))) + + for dtb_path in dtb_files: + dtb_name = os.path.relpath(dtb_path, d.getVar("EXTERNAL_KERNEL_DEVICETREE")) + dtb_name_underscore = dtb_name.replace('/', '_') + + # Set the default dtb image if it exists in the devicetree. + if d.getVar("FIT_CONF_DEFAULT_DTB") == dtb_name: + default_dtb_image = dtb_name_underscore + + # Skip DTB/DTBO if we've picked it up previously + if dtb_name_underscore in DTBS.split(): + continue + + DTBS += " " + dtb_name_underscore + + # Also skip if a symlink. We'll later have each config section point at it + if oe.fitimage.symlink_points_below(dtb_name, d.getVar("EXTERNAL_KERNEL_DEVICETREE")): + continue + + root_node.fitimage_emit_section_dtb(dtb_name_underscore, dtb_path, + d.getVar("UBOOT_DTB_LOADADDRESS"), d.getVar("UBOOT_DTBO_LOADADDRESS")) + + if d.getVar("FIT_CONF_DEFAULT_DTB") and not default_dtb_image: + bb.warn("%s is not available in the list of device trees." % d.getVar('FIT_CONF_DEFAULT_DTB')) + + # + # Step 3: Prepare a u-boot script section + # + fit_uboot_env = d.getVar("FIT_UBOOT_ENV") + if fit_uboot_env: + unpack_dir = d.getVar("UNPACKDIR") + shutil.copy(os.path.join(unpack_dir, fit_uboot_env), fit_uboot_env) + root_node.fitimage_emit_section_boot_script("bootscr-"+fit_uboot_env , fit_uboot_env) + + # + # Step 4: Prepare a setup section. (For x86) + # + setup_bin_path = os.path.join(d.getVar("KERNEL_OUTPUT_DIR"), "setup.bin") + if os.path.exists(setup_bin_path): + root_node.fitimage_emit_section_setup("setup-1", setup_bin_path) + + # + # Step 5: Prepare a ramdisk section. + # + if ramdiskcount == 1 and d.getVar("INITRAMFS_IMAGE_BUNDLE") != "1": + # Find and use the first initramfs image archive type we find + found = False + for img in d.getVar("FIT_SUPPORTED_INITRAMFS_FSTYPES").split(): + initramfs_path = os.path.join(d.getVar("DEPLOY_DIR_IMAGE"), "%s.%s" % (d.getVar('INITRAMFS_IMAGE_NAME'), img)) + if os.path.exists(initramfs_path): + bb.note("Found initramfs image: " + initramfs_path) + found = True + root_node.fitimage_emit_section_ramdisk("ramdisk-%d" % ramdiskcount, initramfs_path, + d.getVar('INITRAMFS_IMAGE'), + d.getVar("UBOOT_RD_LOADADDRESS"), + d.getVar("UBOOT_RD_ENTRYPOINT")) + break + else: + bb.note("Did not find initramfs image: " + initramfs_path) + + if not found: + bb.fatal("Could not find a valid initramfs type for %s, the supported types are: %s" % (d.getVar('INITRAMFS_IMAGE_NAME'), d.getVar('FIT_SUPPORTED_INITRAMFS_FSTYPES'))) + + # Generate the configuration section + root_node.fitimage_emit_section_config() + + # + # Write the ITS file + root_node.write_its_file(itsfile) + + # + # Step 7: Assemble the image + # + fitfile = os.path.join(d.getVar("KERNEL_OUTPUT_DIR"), fitname) + root_node.run_mkimage_assemble(itsfile, fitfile) + + # + # Step 8: Sign the image if required + # + root_node.run_mkimage_sign(fitfile) + + +python do_assemble_fitimage() { + if "fitImage" in d.getVar("KERNEL_IMAGETYPES").split(): + os.chdir(d.getVar("B")) + fitimage_assemble(d, "fit-image.its", "fitImage-none", "") + if d.getVar("INITRAMFS_IMAGE_BUNDLE") != "1": + link_name = os.path.join(d.getVar("B"), d.getVar("KERNEL_OUTPUT_DIR"), "fitImage") + if os.path.islink(link_name): + os.unlink(link_name) + os.symlink("fitImage-none", link_name) } addtask assemble_fitimage before do_install after do_compile @@ -741,17 +231,17 @@ do_install:append() { fi } -do_assemble_fitimage_initramfs() { - if echo ${KERNEL_IMAGETYPES} | grep -wq "fitImage" && \ - test -n "${INITRAMFS_IMAGE}" ; then - cd ${B} - if [ "${INITRAMFS_IMAGE_BUNDLE}" = "1" ]; then - fitimage_assemble fit-image-${INITRAMFS_IMAGE}.its fitImage-bundle "" - ln -sf fitImage-bundle ${B}/${KERNEL_OUTPUT_DIR}/fitImage - else - fitimage_assemble fit-image-${INITRAMFS_IMAGE}.its fitImage-${INITRAMFS_IMAGE} 1 - fi - fi +python do_assemble_fitimage_initramfs() { + if "fitImage" in d.getVar("KERNEL_IMAGETYPES").split() and d.getVar("INITRAMFS_IMAGE"): + os.chdir(d.getVar("B")) + if d.getVar("INITRAMFS_IMAGE_BUNDLE") == "1": + fitimage_assemble(d, "fit-image-%s.its" % d.getVar("INITRAMFS_IMAGE"), "fitImage-bundle", "") + link_name = os.path.join(d.getVar("B"), d.getVar("KERNEL_OUTPUT_DIR"), "fitImage") + if os.path.islink(link_name): + os.unlink(link_name) + os.symlink("fitImage-bundle", link_name) + else: + fitimage_assemble(d, "fit-image-%s.its" % d.getVar("INITRAMFS_IMAGE"), "fitImage-%s" % d.getVar("INITRAMFS_IMAGE"), 1) } addtask assemble_fitimage_initramfs before do_deploy after do_bundle_initramfs diff --git a/meta/classes-recipe/kernel-uboot.bbclass b/meta/classes-recipe/kernel-uboot.bbclass index 7aafd4757c2..888664678d1 100644 --- a/meta/classes-recipe/kernel-uboot.bbclass +++ b/meta/classes-recipe/kernel-uboot.bbclass @@ -67,3 +67,48 @@ do_install:append() { install -D ${B}/${KERNEL_OUTPUT_DIR}/setup.bin ${D}/sysroot-only/setup.bin fi } + +def uboot_prep_kimage_py(d): + import subprocess + + arch = d.getVar('ARCH') + initramfs_image_bundle = d.getVar('INITRAMFS_IMAGE_BUNDLE') + fit_kernel_comp_alg = d.getVar('FIT_KERNEL_COMP_ALG') or 'gzip' + fit_kernel_comp_alg_extension = d.getVar('FIT_KERNEL_COMP_ALG_EXTENSION') or '.gz' + kernel_objcopy = d.getVar('KERNEL_OBJCOPY') + + vmlinux_path = "" + linux_suffix = "" + linux_comp = "none" + + if os.path.exists(f'arch/{arch}/boot/compressed/vmlinux'): + vmlinux_path = f'arch/{arch}/boot/compressed/vmlinux' + elif os.path.exists(f'arch/{arch}/boot/vmlinuz.bin'): + if os.path.exists('linux.bin'): + os.remove('linux.bin') + os.link(f'arch/{arch}/boot/vmlinuz.bin', 'linux.bin') + else: + vmlinux_path = 'vmlinux' + # Use vmlinux.initramfs for linux.bin when INITRAMFS_IMAGE_BUNDLE set + # As per the implementation in kernel.bbclass. + # See do_bundle_initramfs function + if initramfs_image_bundle == '1' and os.path.exists('vmlinux.initramfs'): + vmlinux_path = 'vmlinux.initramfs' + linux_suffix = fit_kernel_comp_alg_extension + linux_comp = fit_kernel_comp_alg + + if vmlinux_path: + subprocess.run([kernel_objcopy.strip(), '-O', 'binary', '-R', '.note', '-R', '.comment', '-S', os.path.abspath(vmlinux_path), 'linux.bin'], check=True) + # if ret.returncode != 0: + # bb.fatal(f"Error: stderr: {ret.stderr.decode('utf-8')} stdout: {ret.stdout.decode('utf-8')}, vmlinux_path: {os.path.abspath(vmlinux_path)}, pwd: {os.getcwd()}, args: {ret.args}") + + if linux_comp != "none": + if linux_comp == "gzip": + subprocess.run(['gzip', '-9', 'linux.bin'], check=True) + elif linux_comp == "lzo": + subprocess.run(['lzop', '-9', 'linux.bin'], check=True) + elif linux_comp == "lzma": + subprocess.run(['xz', '--format=lzma', '-f', '-6', 'linux.bin'], check=True) + os.rename(f'linux.bin{linux_suffix}', 'linux.bin') + + return linux_comp From patchwork Wed May 14 18:50:59 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: AdrianF X-Patchwork-Id: 62964 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 1A04FC54755 for ; Wed, 14 May 2025 18:53:43 +0000 (UTC) Received: from mta-64-228.siemens.flowmailer.net (mta-64-228.siemens.flowmailer.net [185.136.64.228]) by mx.groups.io with SMTP id smtpd.web11.110598.1747248815520801533 for ; Wed, 14 May 2025 11:53:35 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=adrian.freihofer@siemens.com header.s=fm1 header.b=KODbTu7c; spf=pass (domain: rts-flowmailer.siemens.com, ip: 185.136.64.228, mailfrom: fm-1329275-20250514185333602989377084b5b302-8_wto5@rts-flowmailer.siemens.com) Received: by mta-64-228.siemens.flowmailer.net with ESMTPSA id 20250514185333602989377084b5b302 for ; Wed, 14 May 2025 20:53:33 +0200 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; s=fm1; d=siemens.com; i=adrian.freihofer@siemens.com; h=Date:From:Subject:To:Message-ID:MIME-Version:Content-Type:Content-Transfer-Encoding:Cc:References:In-Reply-To; bh=sUT+anTtqAh5U9H6EcQ+TeEW01qL2eH694EjAi/nvA8=; b=KODbTu7cu42DHbeloNybiMuUCD49n1uGC+q9DENJtWRDrgIKfNQdRD2Pn/dbV/Gv080AaK 6JwF/uIBO+N7msyVfAoFWTY7pLMuxVtKDQFh6EOekEfaPMYEAjI2EWpzYOxM9RuRbCk8D2fS GZQF0uSx2cW8b3cwqfwo4wGGmh0bePMhFFu2BxRc5zUghsLlhZZSnuyTWi8zykHTbU0RfWq2 UcTId8DWBDT+KGTbMIMUdDlpJyq5kcRvOi4JdvYVUGhldfYNqTiQ4cho5J7CifFAUG2UaIJ7 1xlhwCl87HTpeh7FKGjOl7BcS1UarNzxw4Io5scv+EMjfk9s/2OHVj3w==; From: AdrianF To: openembedded-core@lists.openembedded.org Cc: marex@denx.de, Adrian Freihofer Subject: [PATCH v3 15/22] kernel.bbclass: remove support for type fitImage Date: Wed, 14 May 2025 20:50:59 +0200 Message-ID: <20250514185225.162998-16-adrian.freihofer@siemens.com> In-Reply-To: <20250514185225.162998-1-adrian.freihofer@siemens.com> References: <20250514185225.162998-1-adrian.freihofer@siemens.com> MIME-Version: 1.0 X-Flowmailer-Platform: Siemens Feedback-ID: 519:519-1329275:519-21489:flowmailer 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 ; Wed, 14 May 2025 18:53:43 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/openembedded-core/message/216543 From: Adrian Freihofer Support for fitImage inf KERNEL_IMAGETYPE or KERNEL_IMAGETYPES has been removed from kernel.bbclass. There is now the new kernel-fit-image.bbclass which allows to write an independent recipe like the linux-yocto-fitimage.bb which provides the same functionality. This new recipe has the advantage that it can use kernel artifacts from the sstate-cache when the initramfs changes but the kernel remains unchanged. This was not possible with the old kernel-fitimage.bbclass. The combination of INITRAMFS_IMAGE_BUNDLE = “1” and the creation of a FIT image is no longer supported. But there is probably no real use case for such a configuration. The FIT image can contain multiple artifacts such as a kernel and an initramfs without bundling the initramfs into the kernel artifact. Bundling the initramfs into the kernel artifact also requires the full kernel build directory, which inherently prevents the use of the kernel from the sstate cache. Signed-off-by: Adrian Freihofer --- meta/classes-recipe/kernel.bbclass | 20 +++++++------------- 1 file changed, 7 insertions(+), 13 deletions(-) diff --git a/meta/classes-recipe/kernel.bbclass b/meta/classes-recipe/kernel.bbclass index 1a7a60eadfc..847eb2f046f 100644 --- a/meta/classes-recipe/kernel.bbclass +++ b/meta/classes-recipe/kernel.bbclass @@ -84,6 +84,10 @@ python __anonymous () { types = (alttype + ' ' + types).strip() d.setVar('KERNEL_IMAGETYPES', types) + # Since kernel-fitimage.bbclass got replaced by kernel-fit-image.bbclass + if "fitImage" in types: + bb.error("fitImage is no longer supported as a KERNEL_IMAGETYPE(S)") + # KERNEL_IMAGETYPES may contain a mixture of image types supported directly # by the kernel build system and types which are created by post-processing # the output of the kernel build system (e.g. compressing vmlinux -> @@ -477,17 +481,10 @@ kernel_do_install() { install -d ${D}/${KERNEL_IMAGEDEST} # - # When including an initramfs bundle inside a FIT image, the fitImage is created after the install task - # by do_assemble_fitimage_initramfs. - # This happens after the generation of the initramfs bundle (done by do_bundle_initramfs). - # So, at the level of the install task we should not try to install the fitImage. fitImage is still not - # generated yet. - # After the generation of the fitImage, the deploy task copies the fitImage from the build directory to - # the deploy folder. + # bundle_initramfs runs after do_install before do_deploy. do_deploy does what's needed therefore. # - for imageType in ${KERNEL_IMAGETYPES} ; do - if [ $imageType != "fitImage" ] || [ "${INITRAMFS_IMAGE_BUNDLE}" != "1" ] ; then + if [ "${INITRAMFS_IMAGE_BUNDLE}" != "1" ] ; then install -m 0644 ${KERNEL_OUTPUT_DIR}/$imageType ${D}/${KERNEL_IMAGEDEST}/$imageType-${KERNEL_VERSION} fi done @@ -843,11 +840,8 @@ kernel_do_deploy() { fi fi - if [ ! -z "${INITRAMFS_IMAGE}" -a x"${INITRAMFS_IMAGE_BUNDLE}" = x1 ]; then + if [ -n "${INITRAMFS_IMAGE}" ] && [ "${INITRAMFS_IMAGE_BUNDLE}" = "1" ]; then for imageType in ${KERNEL_IMAGETYPES} ; do - if [ "$imageType" = "fitImage" ] ; then - continue - fi initramfsBaseName=$imageType-${INITRAMFS_NAME} install -m 0644 ${KERNEL_OUTPUT_DIR}/$imageType.initramfs $deployDir/$initramfsBaseName${KERNEL_IMAGE_BIN_EXT} if [ -n "${INITRAMFS_LINK_NAME}" ] ; then From patchwork Wed May 14 18:51:00 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: AdrianF X-Patchwork-Id: 62978 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 7E9FFC54EDA for ; Wed, 14 May 2025 18:53:43 +0000 (UTC) Received: from mta-64-226.siemens.flowmailer.net (mta-64-226.siemens.flowmailer.net [185.136.64.226]) by mx.groups.io with SMTP id smtpd.web11.110589.1747248811553974163 for ; Wed, 14 May 2025 11:53:34 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=adrian.freihofer@siemens.com header.s=fm1 header.b=MZMCIQGK; spf=pass (domain: rts-flowmailer.siemens.com, ip: 185.136.64.226, mailfrom: fm-1329275-20250514185333b61cab65c2b3c1657d-vtabhc@rts-flowmailer.siemens.com) Received: by mta-64-226.siemens.flowmailer.net with ESMTPSA id 20250514185333b61cab65c2b3c1657d for ; Wed, 14 May 2025 20:53:33 +0200 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; s=fm1; d=siemens.com; i=adrian.freihofer@siemens.com; h=Date:From:Subject:To:Message-ID:MIME-Version:Content-Type:Content-Transfer-Encoding:Cc:References:In-Reply-To; bh=yoXnNJc7I6oAAI/w5nlPs9t2I7W8tZE0iR95DWRh1BA=; b=MZMCIQGKuuTSJdt++5Ns6E78M8SaABuypxWhPhJFFwrZOmjQ1PnXayoaCQkZ7Q0WKsZ4yK k4aEJ4AvkkcazBhWQtQA2hVNlC0quUKkCZo5djHAg2EDVah67SvfBUYC8Hsr/zyHdm12Npmv BCItSL5JP7lFvPqfiKgo4hRmcVqxVyZT5s4OQ1/K/PRHVsAvJiNUzjexE6iREmv5unjzlS46 J2kiopH3A7zR27T2XTU0n6We5fHA8rDjZrT12YM/YxQ6d2AMjQiwqW7tazsysT9GQfSjVG+2 JoLZESP8kdvpaRdzT0+gIFq+IrX0F16SV0fwhys0kJomoReYlLJzxo0w==; From: AdrianF To: openembedded-core@lists.openembedded.org Cc: marex@denx.de, Adrian Freihofer Subject: [PATCH v3 16/22] oe-selftest: fitimage: remove kernel-fitimage tests Date: Wed, 14 May 2025 20:51:00 +0200 Message-ID: <20250514185225.162998-17-adrian.freihofer@siemens.com> In-Reply-To: <20250514185225.162998-1-adrian.freihofer@siemens.com> References: <20250514185225.162998-1-adrian.freihofer@siemens.com> MIME-Version: 1.0 X-Flowmailer-Platform: Siemens Feedback-ID: 519:519-1329275:519-21489:flowmailer 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 ; Wed, 14 May 2025 18:53:43 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/openembedded-core/message/216531 From: Adrian Freihofer Remove the test cases for the kernel-fitimage.bbclass. The _config_add_kernel_classes function is no longer needed since the kernel-fitimage.bbclass is no longer handled. Signed-off-by: Adrian Freihofer --- meta/lib/oeqa/selftest/cases/fitimage.py | 25 ------------------------ 1 file changed, 25 deletions(-) diff --git a/meta/lib/oeqa/selftest/cases/fitimage.py b/meta/lib/oeqa/selftest/cases/fitimage.py index 4d0712b6f01..d204a07bf0c 100644 --- a/meta/lib/oeqa/selftest/cases/fitimage.py +++ b/meta/lib/oeqa/selftest/cases/fitimage.py @@ -449,11 +449,6 @@ class KernelFitImageBase(FitImageTestCase): self.logger.debug("bb_vars: %s" % pprint.pformat(bb_vars, indent=4)) return bb_vars - def _config_add_kernel_classes(self, config): - config += '# Avoid naming clashes in the deploy folder with kernel-fitimage.bbclass artifacts' + os.linesep - config += 'KERNEL_DEPLOYSUBDIR:pn-linux-yocto-fitimage = "linux-yocto-fitimage"' + os.linesep - return config - @property def kernel_recipe(self): return "linux-yocto-fitimage" @@ -769,7 +764,6 @@ UBOOT_LOADADDRESS = "0x80080000" UBOOT_ENTRYPOINT = "0x80080000" FIT_DESC = "A model description" """ - config = self._config_add_kernel_classes(config) self.write_config(config) bb_vars = self._fit_get_bb_vars() self._test_fitimage(bb_vars) @@ -788,7 +782,6 @@ MACHINE = "beaglebone-yocto" # Add a devicetree overlay which does not need kernel sources PREFERRED_PROVIDER_virtual/dtb = "bborg-relay-00a2" """ - config = self._config_add_kernel_classes(config) config = self._config_add_uboot_env(config) self.write_config(config) bb_vars = self._fit_get_bb_vars() @@ -818,7 +811,6 @@ UBOOT_SIGN_KEYDIR = "${TOPDIR}/signing-keys" UBOOT_SIGN_KEYNAME = "dev" UBOOT_MKIMAGE_SIGN_ARGS = "-c 'a smart comment'" """ - config = self._config_add_kernel_classes(config) config = self._config_add_uboot_env(config) self.write_config(config) @@ -871,7 +863,6 @@ UBOOT_SIGN_KEYNAME = "cfg-oe-selftest" FIT_SIGN_INDIVIDUAL = "1" UBOOT_MKIMAGE_SIGN_ARGS = "-c 'a smart comment'" """ - config = self._config_add_kernel_classes(config) config = self._config_add_uboot_env(config) self.write_config(config) bb_vars = self._fit_get_bb_vars() @@ -916,7 +907,6 @@ KERNEL_IMAGETYPE_REPLACEMENT = "zImage" FIT_KERNEL_COMP_ALG = "none" FIT_HASH_ALG = "sha256" """ - config = self._config_add_kernel_classes(config) config = self._config_add_uboot_env(config) self.write_config(config) @@ -973,26 +963,11 @@ KERNEL_IMAGETYPE_REPLACEMENT = "zImage" FIT_KERNEL_COMP_ALG = "none" FIT_HASH_ALG = "sha256" """ - config = self._config_add_kernel_classes(config) config = self._config_add_uboot_env(config) self.write_config(config) bb_vars = self._fit_get_bb_vars() self._test_fitimage(bb_vars) -class KernelFitImageTests(KernelFitImageRecipeTests): - """Test cases for the kernel-fitimage.bbclass""" - - @property - def kernel_recipe(self): - # virtual/kernel does not work with SRC_URI:append:pn-%s - return "linux-yocto" - - def _config_add_kernel_classes(self, config): - config += '# Use kernel-fitimage.bbclass for the creation of the fitImage' + os.linesep - config += 'KERNEL_IMAGETYPES += " fitImage "' + os.linesep - config += 'KERNEL_CLASSES = " kernel-fitimage "' + os.linesep - return config - class FitImagePyTests(KernelFitImageBase): """Test cases for the fitimage.py module without calling bitbake""" From patchwork Wed May 14 18:51:01 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: AdrianF X-Patchwork-Id: 62966 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 0EF14C54756 for ; Wed, 14 May 2025 18:53:43 +0000 (UTC) Received: from mta-65-225.siemens.flowmailer.net (mta-65-225.siemens.flowmailer.net [185.136.65.225]) by mx.groups.io with SMTP id smtpd.web11.110599.1747248815655415908 for ; Wed, 14 May 2025 11:53:36 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=adrian.freihofer@siemens.com header.s=fm1 header.b=AcNKABnK; spf=pass (domain: rts-flowmailer.siemens.com, ip: 185.136.65.225, mailfrom: fm-1329275-20250514185333e58e3974fa73212172-jb435w@rts-flowmailer.siemens.com) Received: by mta-65-225.siemens.flowmailer.net with ESMTPSA id 20250514185333e58e3974fa73212172 for ; Wed, 14 May 2025 20:53:33 +0200 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; s=fm1; d=siemens.com; i=adrian.freihofer@siemens.com; h=Date:From:Subject:To:Message-ID:MIME-Version:Content-Type:Content-Transfer-Encoding:Cc:References:In-Reply-To; bh=oi3gKULn648VuJYxsJVgNq8G4VXFHDsDERnj+6GEBis=; b=AcNKABnK8UMNDD+kM2DKNcVAtjf7tzViid0h0qEZhGoTmQ0C7qvFq/l6IHQx4kMESbZyzS iB8IRuixX8zRwSgX5t72PX2E143wsFJ6znssJnxo9Qa6DqnVNAXc9e5HH759GMC/XVDqOeL3 eBM9lPoShkf3iyFlkqtrPELhYUCkoSKjUbQAyTvHRuSUtPviMD8gqFhk9yzy31JaGLjyxWMJ CKR7wiSn3wyY+Xu86GevhlXfpy9uAHVOckvJYNyszzMatgs9uQ/sWKw6VQjQP0vbIibwbogx KXRo9UIAug2O1t7x1wOZHTxjbPNMN2j/VH04evp6xjXw1hhMjbcXu1og==; From: AdrianF To: openembedded-core@lists.openembedded.org Cc: marex@denx.de, Adrian Freihofer Subject: [PATCH v3 17/22] kernel-fitimage.bbclass: remove it Date: Wed, 14 May 2025 20:51:01 +0200 Message-ID: <20250514185225.162998-18-adrian.freihofer@siemens.com> In-Reply-To: <20250514185225.162998-1-adrian.freihofer@siemens.com> References: <20250514185225.162998-1-adrian.freihofer@siemens.com> MIME-Version: 1.0 X-Flowmailer-Platform: Siemens Feedback-ID: 519:519-1329275:519-21489:flowmailer 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 ; Wed, 14 May 2025 18:53:43 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/openembedded-core/message/216544 From: Adrian Freihofer The integration of the FIT image-related build steps into the kernel recipe has proven to be not very good. The new implementation with kernel-fit-image.bbclass fixes some design issues: * sstate does not work well when a fitImage contains an initramfs. The kernel is rebuilt from scratch if the build runs from an empty TMPDIR. * A fitImage kernel is not available as a package, but all other kernel image types are. * The task dependencies in the kernel are very complex and difficult to debug if something goes wrong. As a separate, downstream recipe, this is now much easier. The long storry about this issue is here: [YOCTO #12912] Signed-off-by: Adrian Freihofer --- meta/classes-recipe/kernel-fitimage.bbclass | 284 -------------------- meta/classes-recipe/kernel-uboot.bbclass | 45 ---- 2 files changed, 329 deletions(-) delete mode 100644 meta/classes-recipe/kernel-fitimage.bbclass diff --git a/meta/classes-recipe/kernel-fitimage.bbclass b/meta/classes-recipe/kernel-fitimage.bbclass deleted file mode 100644 index 58d1cc458b4..00000000000 --- a/meta/classes-recipe/kernel-fitimage.bbclass +++ /dev/null @@ -1,284 +0,0 @@ -# -# Copyright OpenEmbedded Contributors -# -# SPDX-License-Identifier: MIT -# - -inherit kernel-uboot kernel-artifact-names uboot-config -require conf/image-fitimage.conf - -def get_fit_replacement_type(d): - kerneltypes = d.getVar('KERNEL_IMAGETYPES') or "" - replacementtype = "" - if 'fitImage' in kerneltypes.split(): - uarch = d.getVar("UBOOT_ARCH") - if uarch == "arm64": - replacementtype = "Image" - elif uarch == "riscv": - replacementtype = "Image" - elif uarch == "mips": - replacementtype = "vmlinuz.bin" - elif uarch == "x86": - replacementtype = "bzImage" - elif uarch == "microblaze": - replacementtype = "linux.bin" - else: - replacementtype = "zImage" - return replacementtype - -KERNEL_IMAGETYPE_REPLACEMENT ?= "${@get_fit_replacement_type(d)}" -DEPENDS:append = " \ - ${@'u-boot-tools-native dtc-native' if 'fitImage' in (d.getVar('KERNEL_IMAGETYPES') or '').split() else ''} \ - ${@'kernel-signing-keys-native' if d.getVar('FIT_GENERATE_KEYS') == '1' else ''} \ -" - -python __anonymous () { - # Override KERNEL_IMAGETYPE_FOR_MAKE variable, which is internal - # to kernel.bbclass . We have to override it, since we pack zImage - # (at least for now) into the fitImage . - typeformake = d.getVar("KERNEL_IMAGETYPE_FOR_MAKE") or "" - if 'fitImage' in typeformake.split(): - d.setVar('KERNEL_IMAGETYPE_FOR_MAKE', typeformake.replace('fitImage', d.getVar('KERNEL_IMAGETYPE_REPLACEMENT'))) - - image = d.getVar('INITRAMFS_IMAGE') - if image and not bb.utils.to_boolean(d.getVar('INITRAMFS_IMAGE_BUNDLE')): - if d.getVar('INITRAMFS_MULTICONFIG'): - mc = d.getVar('BB_CURRENT_MC') - d.appendVarFlag('do_assemble_fitimage_initramfs', 'mcdepends', ' mc:' + mc + ':${INITRAMFS_MULTICONFIG}:${INITRAMFS_IMAGE}:do_image_complete') - else: - d.appendVarFlag('do_assemble_fitimage_initramfs', 'depends', ' ${INITRAMFS_IMAGE}:do_image_complete') - - #check if there are any dtb providers - providerdtb = d.getVar("PREFERRED_PROVIDER_virtual/dtb") - if providerdtb: - d.appendVarFlag('do_assemble_fitimage', 'depends', ' virtual/dtb:do_populate_sysroot') - d.appendVarFlag('do_assemble_fitimage_initramfs', 'depends', ' virtual/dtb:do_populate_sysroot') - d.setVar('EXTERNAL_KERNEL_DEVICETREE', "${RECIPE_SYSROOT}/boot/devicetree") -} - -def fitimage_assemble(d, itsfile, fitname, ramdiskcount): - import shutil - import glob - import oe.fitimage - - DTBS="" - default_dtb_image="" - - for f in [itsfile, os.path.join("arch", d.getVar("ARCH"), "boot", fitname)]: - if os.path.exists(f): - os.remove(f) - - root_node = oe.fitimage.ItsNodeRootKernel( - d.getVar("FIT_DESC"), d.getVar("FIT_ADDRESS_CELLS"), - d.getVar('HOST_PREFIX'), d.getVar('UBOOT_ARCH'), d.getVar("FIT_CONF_PREFIX"), - d.getVar('UBOOT_SIGN_ENABLE') == "1", d.getVar("UBOOT_SIGN_KEYDIR"), - d.getVar("UBOOT_MKIMAGE"), d.getVar("UBOOT_MKIMAGE_DTCOPTS"), - d.getVar("UBOOT_MKIMAGE_SIGN"), d.getVar("UBOOT_MKIMAGE_SIGN_ARGS"), - d.getVar('FIT_HASH_ALG'), d.getVar('FIT_SIGN_ALG'), d.getVar('FIT_PAD_ALG'), - d.getVar('UBOOT_SIGN_KEYNAME'), - d.getVar('FIT_SIGN_INDIVIDUAL') == "1", d.getVar('UBOOT_SIGN_IMG_KEYNAME') - ) - - # - # Step 1: Prepare a kernel image section. - # - linux_comp = uboot_prep_kimage_py(d) - root_node.fitimage_emit_section_kernel("kernel-1", "linux.bin", linux_comp, - d.getVar('UBOOT_LOADADDRESS'), d.getVar('UBOOT_ENTRYPOINT'), - d.getVar('UBOOT_MKIMAGE_KERNEL_TYPE'), d.getVar("UBOOT_ENTRYSYMBOL")) - - # - # Step 2: Prepare a DTB image section - # - if d.getVar("KERNEL_DEVICETREE"): - for DTB in d.getVar("KERNEL_DEVICETREE").split(): - if "/dts/" in DTB: - bb.warn(f"{DTB} contains the full path to the dts file, but only the dtb name should be used.") - DTB = os.path.basename(DTB).replace(".dts", ".dtb") - - # Skip DTB if it's also provided in EXTERNAL_KERNEL_DEVICETREE - if d.getVar("EXTERNAL_KERNEL_DEVICETREE"): - ext_dtb_path = os.path.join(d.getVar("EXTERNAL_KERNEL_DEVICETREE"), DTB) - if os.path.exists(ext_dtb_path) and os.path.getsize(ext_dtb_path) > 0: - continue - - DTB_PATH = os.path.join(d.getVar("KERNEL_OUTPUT_DIR"), "dts", DTB) - if not os.path.exists(DTB_PATH): - DTB_PATH = os.path.join(d.getVar("KERNEL_OUTPUT_DIR"), DTB) - - # Strip off the path component from the filename - if not oe.types.boolean(d.getVar("KERNEL_DTBVENDORED")): - DTB = os.path.basename(DTB) - - # Set the default dtb image if it exists in the devicetree. - if d.getVar("FIT_CONF_DEFAULT_DTB") == DTB: - default_dtb_image = DTB.replace("/", "_") - - DTB = DTB.replace("/", "_") - - # Skip DTB if we've picked it up previously - if DTB in DTBS.split(): - continue - - DTBS += " " + DTB - - root_node.fitimage_emit_section_dtb(DTB, DTB_PATH, - d.getVar("UBOOT_DTB_LOADADDRESS"), d.getVar("UBOOT_DTBO_LOADADDRESS")) - - if d.getVar("EXTERNAL_KERNEL_DEVICETREE"): - dtb_files = [] - for ext in ['*.dtb', '*.dtbo']: - dtb_files.extend(sorted(glob.glob(os.path.join(d.getVar("EXTERNAL_KERNEL_DEVICETREE"), ext)))) - - for dtb_path in dtb_files: - dtb_name = os.path.relpath(dtb_path, d.getVar("EXTERNAL_KERNEL_DEVICETREE")) - dtb_name_underscore = dtb_name.replace('/', '_') - - # Set the default dtb image if it exists in the devicetree. - if d.getVar("FIT_CONF_DEFAULT_DTB") == dtb_name: - default_dtb_image = dtb_name_underscore - - # Skip DTB/DTBO if we've picked it up previously - if dtb_name_underscore in DTBS.split(): - continue - - DTBS += " " + dtb_name_underscore - - # Also skip if a symlink. We'll later have each config section point at it - if oe.fitimage.symlink_points_below(dtb_name, d.getVar("EXTERNAL_KERNEL_DEVICETREE")): - continue - - root_node.fitimage_emit_section_dtb(dtb_name_underscore, dtb_path, - d.getVar("UBOOT_DTB_LOADADDRESS"), d.getVar("UBOOT_DTBO_LOADADDRESS")) - - if d.getVar("FIT_CONF_DEFAULT_DTB") and not default_dtb_image: - bb.warn("%s is not available in the list of device trees." % d.getVar('FIT_CONF_DEFAULT_DTB')) - - # - # Step 3: Prepare a u-boot script section - # - fit_uboot_env = d.getVar("FIT_UBOOT_ENV") - if fit_uboot_env: - unpack_dir = d.getVar("UNPACKDIR") - shutil.copy(os.path.join(unpack_dir, fit_uboot_env), fit_uboot_env) - root_node.fitimage_emit_section_boot_script("bootscr-"+fit_uboot_env , fit_uboot_env) - - # - # Step 4: Prepare a setup section. (For x86) - # - setup_bin_path = os.path.join(d.getVar("KERNEL_OUTPUT_DIR"), "setup.bin") - if os.path.exists(setup_bin_path): - root_node.fitimage_emit_section_setup("setup-1", setup_bin_path) - - # - # Step 5: Prepare a ramdisk section. - # - if ramdiskcount == 1 and d.getVar("INITRAMFS_IMAGE_BUNDLE") != "1": - # Find and use the first initramfs image archive type we find - found = False - for img in d.getVar("FIT_SUPPORTED_INITRAMFS_FSTYPES").split(): - initramfs_path = os.path.join(d.getVar("DEPLOY_DIR_IMAGE"), "%s.%s" % (d.getVar('INITRAMFS_IMAGE_NAME'), img)) - if os.path.exists(initramfs_path): - bb.note("Found initramfs image: " + initramfs_path) - found = True - root_node.fitimage_emit_section_ramdisk("ramdisk-%d" % ramdiskcount, initramfs_path, - d.getVar('INITRAMFS_IMAGE'), - d.getVar("UBOOT_RD_LOADADDRESS"), - d.getVar("UBOOT_RD_ENTRYPOINT")) - break - else: - bb.note("Did not find initramfs image: " + initramfs_path) - - if not found: - bb.fatal("Could not find a valid initramfs type for %s, the supported types are: %s" % (d.getVar('INITRAMFS_IMAGE_NAME'), d.getVar('FIT_SUPPORTED_INITRAMFS_FSTYPES'))) - - # Generate the configuration section - root_node.fitimage_emit_section_config() - - # - # Write the ITS file - root_node.write_its_file(itsfile) - - # - # Step 7: Assemble the image - # - fitfile = os.path.join(d.getVar("KERNEL_OUTPUT_DIR"), fitname) - root_node.run_mkimage_assemble(itsfile, fitfile) - - # - # Step 8: Sign the image if required - # - root_node.run_mkimage_sign(fitfile) - - -python do_assemble_fitimage() { - if "fitImage" in d.getVar("KERNEL_IMAGETYPES").split(): - os.chdir(d.getVar("B")) - fitimage_assemble(d, "fit-image.its", "fitImage-none", "") - if d.getVar("INITRAMFS_IMAGE_BUNDLE") != "1": - link_name = os.path.join(d.getVar("B"), d.getVar("KERNEL_OUTPUT_DIR"), "fitImage") - if os.path.islink(link_name): - os.unlink(link_name) - os.symlink("fitImage-none", link_name) -} - -addtask assemble_fitimage before do_install after do_compile - -do_install:append() { - if echo ${KERNEL_IMAGETYPES} | grep -wq "fitImage" && \ - [ "${UBOOT_SIGN_ENABLE}" = "1" ]; then - install -D ${B}/${KERNEL_OUTPUT_DIR}/fitImage-none ${D}/sysroot-only/fitImage - fi -} - -python do_assemble_fitimage_initramfs() { - if "fitImage" in d.getVar("KERNEL_IMAGETYPES").split() and d.getVar("INITRAMFS_IMAGE"): - os.chdir(d.getVar("B")) - if d.getVar("INITRAMFS_IMAGE_BUNDLE") == "1": - fitimage_assemble(d, "fit-image-%s.its" % d.getVar("INITRAMFS_IMAGE"), "fitImage-bundle", "") - link_name = os.path.join(d.getVar("B"), d.getVar("KERNEL_OUTPUT_DIR"), "fitImage") - if os.path.islink(link_name): - os.unlink(link_name) - os.symlink("fitImage-bundle", link_name) - else: - fitimage_assemble(d, "fit-image-%s.its" % d.getVar("INITRAMFS_IMAGE"), "fitImage-%s" % d.getVar("INITRAMFS_IMAGE"), 1) -} - -addtask assemble_fitimage_initramfs before do_deploy after do_bundle_initramfs - -kernel_do_deploy[vardepsexclude] = "DATETIME" -kernel_do_deploy:append() { - # Update deploy directory - if echo ${KERNEL_IMAGETYPES} | grep -wq "fitImage"; then - - if [ "${INITRAMFS_IMAGE_BUNDLE}" != "1" ]; then - bbnote "Copying fit-image.its source file..." - install -m 0644 ${B}/fit-image.its "$deployDir/fitImage-its-${KERNEL_FIT_NAME}.its" - if [ -n "${KERNEL_FIT_LINK_NAME}" ] ; then - ln -snf fitImage-its-${KERNEL_FIT_NAME}.its "$deployDir/fitImage-its-${KERNEL_FIT_LINK_NAME}" - fi - - bbnote "Copying linux.bin file..." - install -m 0644 ${B}/linux.bin $deployDir/fitImage-linux.bin-${KERNEL_FIT_NAME}${KERNEL_FIT_BIN_EXT} - if [ -n "${KERNEL_FIT_LINK_NAME}" ] ; then - ln -snf fitImage-linux.bin-${KERNEL_FIT_NAME}${KERNEL_FIT_BIN_EXT} "$deployDir/fitImage-linux.bin-${KERNEL_FIT_LINK_NAME}" - fi - fi - - if [ -n "${INITRAMFS_IMAGE}" ]; then - bbnote "Copying fit-image-${INITRAMFS_IMAGE}.its source file..." - install -m 0644 ${B}/fit-image-${INITRAMFS_IMAGE}.its "$deployDir/fitImage-its-${INITRAMFS_IMAGE_NAME}-${KERNEL_FIT_NAME}.its" - if [ -n "${KERNEL_FIT_LINK_NAME}" ] ; then - ln -snf fitImage-its-${INITRAMFS_IMAGE_NAME}-${KERNEL_FIT_NAME}.its "$deployDir/fitImage-its-${INITRAMFS_IMAGE_NAME}-${KERNEL_FIT_LINK_NAME}" - fi - - if [ "${INITRAMFS_IMAGE_BUNDLE}" != "1" ]; then - bbnote "Copying fitImage-${INITRAMFS_IMAGE} file..." - install -m 0644 ${B}/${KERNEL_OUTPUT_DIR}/fitImage-${INITRAMFS_IMAGE} "$deployDir/fitImage-${INITRAMFS_IMAGE_NAME}-${KERNEL_FIT_NAME}${KERNEL_FIT_BIN_EXT}" - if [ -n "${KERNEL_FIT_LINK_NAME}" ] ; then - ln -snf fitImage-${INITRAMFS_IMAGE_NAME}-${KERNEL_FIT_NAME}${KERNEL_FIT_BIN_EXT} "$deployDir/fitImage-${INITRAMFS_IMAGE_NAME}-${KERNEL_FIT_LINK_NAME}" - fi - fi - fi - fi -} diff --git a/meta/classes-recipe/kernel-uboot.bbclass b/meta/classes-recipe/kernel-uboot.bbclass index 888664678d1..7aafd4757c2 100644 --- a/meta/classes-recipe/kernel-uboot.bbclass +++ b/meta/classes-recipe/kernel-uboot.bbclass @@ -67,48 +67,3 @@ do_install:append() { install -D ${B}/${KERNEL_OUTPUT_DIR}/setup.bin ${D}/sysroot-only/setup.bin fi } - -def uboot_prep_kimage_py(d): - import subprocess - - arch = d.getVar('ARCH') - initramfs_image_bundle = d.getVar('INITRAMFS_IMAGE_BUNDLE') - fit_kernel_comp_alg = d.getVar('FIT_KERNEL_COMP_ALG') or 'gzip' - fit_kernel_comp_alg_extension = d.getVar('FIT_KERNEL_COMP_ALG_EXTENSION') or '.gz' - kernel_objcopy = d.getVar('KERNEL_OBJCOPY') - - vmlinux_path = "" - linux_suffix = "" - linux_comp = "none" - - if os.path.exists(f'arch/{arch}/boot/compressed/vmlinux'): - vmlinux_path = f'arch/{arch}/boot/compressed/vmlinux' - elif os.path.exists(f'arch/{arch}/boot/vmlinuz.bin'): - if os.path.exists('linux.bin'): - os.remove('linux.bin') - os.link(f'arch/{arch}/boot/vmlinuz.bin', 'linux.bin') - else: - vmlinux_path = 'vmlinux' - # Use vmlinux.initramfs for linux.bin when INITRAMFS_IMAGE_BUNDLE set - # As per the implementation in kernel.bbclass. - # See do_bundle_initramfs function - if initramfs_image_bundle == '1' and os.path.exists('vmlinux.initramfs'): - vmlinux_path = 'vmlinux.initramfs' - linux_suffix = fit_kernel_comp_alg_extension - linux_comp = fit_kernel_comp_alg - - if vmlinux_path: - subprocess.run([kernel_objcopy.strip(), '-O', 'binary', '-R', '.note', '-R', '.comment', '-S', os.path.abspath(vmlinux_path), 'linux.bin'], check=True) - # if ret.returncode != 0: - # bb.fatal(f"Error: stderr: {ret.stderr.decode('utf-8')} stdout: {ret.stdout.decode('utf-8')}, vmlinux_path: {os.path.abspath(vmlinux_path)}, pwd: {os.getcwd()}, args: {ret.args}") - - if linux_comp != "none": - if linux_comp == "gzip": - subprocess.run(['gzip', '-9', 'linux.bin'], check=True) - elif linux_comp == "lzo": - subprocess.run(['lzop', '-9', 'linux.bin'], check=True) - elif linux_comp == "lzma": - subprocess.run(['xz', '--format=lzma', '-f', '-6', 'linux.bin'], check=True) - os.rename(f'linux.bin{linux_suffix}', 'linux.bin') - - return linux_comp From patchwork Wed May 14 18:51:02 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: AdrianF X-Patchwork-Id: 62963 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 08B8BC3ABDA for ; Wed, 14 May 2025 18:53:43 +0000 (UTC) Received: from mta-65-226.siemens.flowmailer.net (mta-65-226.siemens.flowmailer.net [185.136.65.226]) by mx.groups.io with SMTP id smtpd.web11.110600.1747248815936119106 for ; Wed, 14 May 2025 11:53:36 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=adrian.freihofer@siemens.com header.s=fm1 header.b=NRuf3Fff; spf=pass (domain: rts-flowmailer.siemens.com, ip: 185.136.65.226, mailfrom: fm-1329275-20250514185334429544792dbb775732-eeylua@rts-flowmailer.siemens.com) Received: by mta-65-226.siemens.flowmailer.net with ESMTPSA id 20250514185334429544792dbb775732 for ; Wed, 14 May 2025 20:53:34 +0200 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; s=fm1; d=siemens.com; i=adrian.freihofer@siemens.com; h=Date:From:Subject:To:Message-ID:MIME-Version:Content-Type:Content-Transfer-Encoding:Cc:References:In-Reply-To; bh=WqFkUcHuRoIWxhdLDP4pRqY//pRB5VYYNsEd87Pc6fg=; b=NRuf3Fff79lsi7NRB3ncTpEtPp8mBBr6tPzh7cHeAgzPqWJGq1Yuwd+/DB2eFyVtqg4LxM KRoFW2GdQhg13qzMwUSwAp7fINMV/N5JCzeSlrwfUOgWiOJNtAVcT8c5uv7QmLpT41NPhPCA dVgmQBSLsS6B3ZhZUm0wXWyNLGg7sO0E8ssNjzCL8Qh1XHqKl7z/Jm4Is7r64CiGVNneFTtx oksFquNci/jZCjO0Tw7WyKOjrKbbsj4TeGnWz2qVMHt2teV0cvv04qMrNHMKxWjdFwXJl3ML DOCS+unKjB+yWr1Ma+QIZ90lALDhIG+PkAB41FhfzojoudNG6C0o0RJw==; From: AdrianF To: openembedded-core@lists.openembedded.org Cc: marex@denx.de, Adrian Freihofer Subject: [PATCH v3 18/22] kernel-uboot.bbclass: merge it into kernel-uimage.bbclass Date: Wed, 14 May 2025 20:51:02 +0200 Message-ID: <20250514185225.162998-19-adrian.freihofer@siemens.com> In-Reply-To: <20250514185225.162998-1-adrian.freihofer@siemens.com> References: <20250514185225.162998-1-adrian.freihofer@siemens.com> MIME-Version: 1.0 X-Flowmailer-Platform: Siemens Feedback-ID: 519:519-1329275:519-21489:flowmailer 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 ; Wed, 14 May 2025 18:53:43 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/openembedded-core/message/216545 From: Adrian Freihofer After the kernel-fitimage.bbclass has been removed, the kernel-uimage.bbclass is the only user of the kernel-uboot.bbclass. Simplify the implementation by merging these two classes into one. Until "uImage" is in KERNEL_IMAGETYPES the kernel-uimage.bbclass does nothing else than exporting the artifiacts which are required for creating the fitImage. It should also be remembered that the kernel.bbclass inherits the kernel-uimage.bbclass by default: KERNEL_CLASSES ?= " kernel-uimage " Signed-off-by: Adrian Freihofer --- meta/classes-recipe/kernel-uboot.bbclass | 69 ---------------------- meta/classes-recipe/kernel-uimage.bbclass | 71 +++++++++++++++++++++-- 2 files changed, 67 insertions(+), 73 deletions(-) delete mode 100644 meta/classes-recipe/kernel-uboot.bbclass diff --git a/meta/classes-recipe/kernel-uboot.bbclass b/meta/classes-recipe/kernel-uboot.bbclass deleted file mode 100644 index 7aafd4757c2..00000000000 --- a/meta/classes-recipe/kernel-uboot.bbclass +++ /dev/null @@ -1,69 +0,0 @@ -# -# Copyright OpenEmbedded Contributors -# -# SPDX-License-Identifier: MIT -# - -# fitImage kernel compression algorithm -FIT_KERNEL_COMP_ALG ?= "gzip" -FIT_KERNEL_COMP_ALG_EXTENSION ?= ".gz" - -# Kernel image type passed to mkimage (i.e. kernel kernel_noload...) -UBOOT_MKIMAGE_KERNEL_TYPE ?= "kernel" - -uboot_prep_kimage() { - output_dir=$1 - # For backward compatibility with kernel-fitimage.bbclass and kernel-uboot.bbclass - # support calling without parameter as well - if [ -z "$output_dir" ]; then - output_dir='.' - fi - - linux_bin=$output_dir/linux.bin - if [ -e "arch/${ARCH}/boot/compressed/vmlinux" ]; then - vmlinux_path="arch/${ARCH}/boot/compressed/vmlinux" - linux_suffix="" - linux_comp="none" - elif [ -e "arch/${ARCH}/boot/vmlinuz.bin" ]; then - rm -f "$linux_bin" - cp -l "arch/${ARCH}/boot/vmlinuz.bin" "$linux_bin" - vmlinux_path="" - linux_suffix="" - linux_comp="none" - else - vmlinux_path="vmlinux" - # Use vmlinux.initramfs for $linux_bin when INITRAMFS_IMAGE_BUNDLE set - # As per the implementation in kernel.bbclass. - # See do_bundle_initramfs function - if [ "${INITRAMFS_IMAGE_BUNDLE}" = "1" ] && [ -e vmlinux.initramfs ]; then - vmlinux_path="vmlinux.initramfs" - fi - linux_suffix="${FIT_KERNEL_COMP_ALG_EXTENSION}" - linux_comp="${FIT_KERNEL_COMP_ALG}" - fi - - [ -n "$vmlinux_path" ] && ${KERNEL_OBJCOPY} -O binary -R .note -R .comment -S "$vmlinux_path" "$linux_bin" - - if [ "$linux_comp" != "none" ] ; then - if [ "$linux_comp" = "gzip" ] ; then - gzip -9 "$linux_bin" - elif [ "$linux_comp" = "lzo" ] ; then - lzop -9 "$linux_bin" - elif [ "$linux_comp" = "lzma" ] ; then - xz --format=lzma -f -6 "$linux_bin" - fi - mv -f "$linux_bin$linux_suffix" "$linux_bin" - fi - - printf "$linux_comp" > "$output_dir/linux_comp" -} - -do_install:append() { - # Provide the kernel artifacts to post processing recipes e.g. for creating a FIT image - install -d ${D}/sysroot-only - uboot_prep_kimage ${D}/sysroot-only - # For x86 a setup.bin needs to be included in a fitImage as well - if [ -e ${KERNEL_OUTPUT_DIR}/setup.bin ]; then - install -D ${B}/${KERNEL_OUTPUT_DIR}/setup.bin ${D}/sysroot-only/setup.bin - fi -} diff --git a/meta/classes-recipe/kernel-uimage.bbclass b/meta/classes-recipe/kernel-uimage.bbclass index e353232a0e9..f04a2c6d691 100644 --- a/meta/classes-recipe/kernel-uimage.bbclass +++ b/meta/classes-recipe/kernel-uimage.bbclass @@ -4,7 +4,13 @@ # SPDX-License-Identifier: MIT # -inherit kernel-uboot +# fitImage kernel compression algorithm +FIT_KERNEL_COMP_ALG ?= "gzip" +FIT_KERNEL_COMP_ALG_EXTENSION ?= ".gz" + +# Kernel image type passed to mkimage (i.e. kernel kernel_noload...) +UBOOT_MKIMAGE_KERNEL_TYPE ?= "kernel" + python __anonymous () { if "uImage" in d.getVar('KERNEL_IMAGETYPES'): @@ -26,10 +32,67 @@ python __anonymous () { bb.build.addtask('do_uboot_mkimage', 'do_install', 'do_kernel_link_images', d) } +uboot_prep_kimage() { + output_dir=$1 + # For backward compatibility with kernel-fitimage.bbclass and kernel-uboot.bbclass + # support calling without parameter as well + if [ -z "$output_dir" ]; then + output_dir='.' + fi + + linux_bin=$output_dir/linux.bin + if [ -e "arch/${ARCH}/boot/compressed/vmlinux" ]; then + vmlinux_path="arch/${ARCH}/boot/compressed/vmlinux" + linux_suffix="" + linux_comp="none" + elif [ -e "arch/${ARCH}/boot/vmlinuz.bin" ]; then + rm -f "$linux_bin" + cp -l "arch/${ARCH}/boot/vmlinuz.bin" "$linux_bin" + vmlinux_path="" + linux_suffix="" + linux_comp="none" + else + vmlinux_path="vmlinux" + # Use vmlinux.initramfs for $linux_bin when INITRAMFS_IMAGE_BUNDLE set + # As per the implementation in kernel.bbclass. + # See do_bundle_initramfs function + if [ "${INITRAMFS_IMAGE_BUNDLE}" = "1" ] && [ -e vmlinux.initramfs ]; then + vmlinux_path="vmlinux.initramfs" + fi + linux_suffix="${FIT_KERNEL_COMP_ALG_EXTENSION}" + linux_comp="${FIT_KERNEL_COMP_ALG}" + fi + + [ -n "$vmlinux_path" ] && ${KERNEL_OBJCOPY} -O binary -R .note -R .comment -S "$vmlinux_path" "$linux_bin" + + if [ "$linux_comp" != "none" ] ; then + if [ "$linux_comp" = "gzip" ] ; then + gzip -9 "$linux_bin" + elif [ "$linux_comp" = "lzo" ] ; then + lzop -9 "$linux_bin" + elif [ "$linux_comp" = "lzma" ] ; then + xz --format=lzma -f -6 "$linux_bin" + fi + mv -f "$linux_bin$linux_suffix" "$linux_bin" + fi + + printf "$linux_comp" > "$output_dir/linux_comp" +} + +do_install:append() { + # Provide the kernel artifacts to post processing recipes e.g. for creating a FIT image + install -d ${D}/sysroot-only + uboot_prep_kimage ${D}/sysroot-only + # For x86 a setup.bin needs to be included in a fitImage as well + if [ -e ${KERNEL_OUTPUT_DIR}/setup.bin ]; then + install -D ${B}/${KERNEL_OUTPUT_DIR}/setup.bin ${D}/sysroot-only/setup.bin + fi +} + do_uboot_mkimage[dirs] += "${B}" do_uboot_mkimage() { - uboot_prep_kimage - linux_comp="$(cat linux_comp)" + linux_bin=${D}/sysroot-only/setup.bin + linux_comp=$(cat "${D}/sysroot-only/linux_comp") ENTRYPOINT=${UBOOT_ENTRYPOINT} if [ -n "${UBOOT_ENTRYSYMBOL}" ]; then @@ -37,6 +100,6 @@ do_uboot_mkimage() { awk '$3=="${UBOOT_ENTRYSYMBOL}" {print "0x"$1;exit}'` fi - uboot-mkimage -A ${UBOOT_ARCH} -O linux -T ${UBOOT_MKIMAGE_KERNEL_TYPE} -C "$linux_comp" -a ${UBOOT_LOADADDRESS} -e $ENTRYPOINT -n "${DISTRO_NAME}/${PV}/${MACHINE}" -d linux.bin ${B}/arch/${ARCH}/boot/uImage + uboot-mkimage -A ${UBOOT_ARCH} -O linux -T ${UBOOT_MKIMAGE_KERNEL_TYPE} -C "$linux_comp" -a ${UBOOT_LOADADDRESS} -e $ENTRYPOINT -n "${DISTRO_NAME}/${PV}/${MACHINE}" -d "$linux_bin" ${B}/arch/${ARCH}/boot/uImage rm -f linux.bin } From patchwork Wed May 14 18:51:03 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: AdrianF X-Patchwork-Id: 62965 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 EF84DC3ABD8 for ; Wed, 14 May 2025 18:53:42 +0000 (UTC) Received: from mta-64-225.siemens.flowmailer.net (mta-64-225.siemens.flowmailer.net [185.136.64.225]) by mx.groups.io with SMTP id smtpd.web10.109905.1747248816287757469 for ; Wed, 14 May 2025 11:53:36 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=adrian.freihofer@siemens.com header.s=fm1 header.b=IRu+pe4b; spf=pass (domain: rts-flowmailer.siemens.com, ip: 185.136.64.225, mailfrom: fm-1329275-2025051418533400c7957c20a1cea00f-sqvils@rts-flowmailer.siemens.com) Received: by mta-64-225.siemens.flowmailer.net with ESMTPSA id 2025051418533400c7957c20a1cea00f for ; Wed, 14 May 2025 20:53:34 +0200 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; s=fm1; d=siemens.com; i=adrian.freihofer@siemens.com; h=Date:From:Subject:To:Message-ID:MIME-Version:Content-Type:Content-Transfer-Encoding:Cc:References:In-Reply-To; bh=cv2MAUXgEgD5BRr9mmy5xkazaT7T3x/5mXdYNfTknjs=; b=IRu+pe4b0ulgB0cT1XfzeCvxTA6L3Mmn4nTnS/alDNXMaM+qDiF0+lZ5Go5jKW7aMmKW+P alxCdROys5ZTfwSczf71vSlb26mDwLfKON5V81bMRbrAlq5Uk58asZ7fNOsKXfBJA7ZDawuz mEWvmOG4+4/k7jsHIHxDZpIua8e7BN3NqNgb3MQy2mLT6Ae+it1LFh6oaVck9cnd6AZDEhoo +acult0RZO96gYxGEsyWgmDK0MmP7A2jIZZiNAX3Os1WCfQj+RBw3LRe+OZjAPGegCqqVeU5 ByaECJTZSV1X2S6FWIXJvoTL5afKMdtYhzTD3XEMsN/PJmIUsMnzkZ6A==; From: AdrianF To: openembedded-core@lists.openembedded.org Cc: marex@denx.de, Adrian Freihofer Subject: [PATCH v3 19/22] oe-selftest: fitimage: drop initramfs bundle test Date: Wed, 14 May 2025 20:51:03 +0200 Message-ID: <20250514185225.162998-20-adrian.freihofer@siemens.com> In-Reply-To: <20250514185225.162998-1-adrian.freihofer@siemens.com> References: <20250514185225.162998-1-adrian.freihofer@siemens.com> MIME-Version: 1.0 X-Flowmailer-Platform: Siemens Feedback-ID: 519:519-1329275:519-21489:flowmailer 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 ; Wed, 14 May 2025 18:53:42 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/openembedded-core/message/216546 From: Adrian Freihofer This test case is no longer useful. Sure, it is possible to build a kernel with an initramfs bundled. But since this is not the kernel which gets included into the FIT image, there is no need for testing this as part of the FIT image test suite. Signed-off-by: Adrian Freihofer --- meta/lib/oeqa/selftest/cases/fitimage.py | 42 ------------------------ 1 file changed, 42 deletions(-) diff --git a/meta/lib/oeqa/selftest/cases/fitimage.py b/meta/lib/oeqa/selftest/cases/fitimage.py index d204a07bf0c..80aa63bb91a 100644 --- a/meta/lib/oeqa/selftest/cases/fitimage.py +++ b/meta/lib/oeqa/selftest/cases/fitimage.py @@ -925,48 +925,6 @@ FIT_HASH_ALG = "sha256" self._test_fitimage(bb_vars) - def test_fit_image_sign_initramfs_bundle(self): - """ - Summary: Verifies the content of the initramfs bundle node in the FIT Image Tree Source (its) - The FIT settings are set by the test case. - The machine used is beaglebone-yocto. - Expected: 1. The ITS is generated with initramfs bundle support - 2. All the fields in the kernel node are as expected (matching the - conf settings) - 3. The kernel is included in all the available configurations and - its hash is included in the configuration signature - - Product: oe-core - Author: Abdellatif El Khlifi - """ - - config = """ -DISTRO="poky" -MACHINE = "beaglebone-yocto" -INITRAMFS_IMAGE_BUNDLE = "1" -INITRAMFS_IMAGE = "core-image-minimal-initramfs" -INITRAMFS_SCRIPTS = "" -UBOOT_MACHINE = "am335x_evm_defconfig" -UBOOT_SIGN_ENABLE = "1" -UBOOT_SIGN_KEYNAME = "beaglebonekey" -UBOOT_SIGN_KEYDIR ?= "${DEPLOY_DIR_IMAGE}" -UBOOT_DTB_BINARY = "u-boot.dtb" -UBOOT_ENTRYPOINT = "0x80000000" -UBOOT_LOADADDRESS = "0x80000000" -UBOOT_DTB_LOADADDRESS = "0x82000000" -UBOOT_ARCH = "arm" -UBOOT_MKIMAGE_DTCOPTS = "-I dts -O dtb -p 2000" -UBOOT_MKIMAGE_KERNEL_TYPE = "kernel" -UBOOT_EXTLINUX = "0" -FIT_GENERATE_KEYS = "1" -KERNEL_IMAGETYPE_REPLACEMENT = "zImage" -FIT_KERNEL_COMP_ALG = "none" -FIT_HASH_ALG = "sha256" -""" - config = self._config_add_uboot_env(config) - self.write_config(config) - bb_vars = self._fit_get_bb_vars() - self._test_fitimage(bb_vars) class FitImagePyTests(KernelFitImageBase): """Test cases for the fitimage.py module without calling bitbake""" From patchwork Wed May 14 18:51:04 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: AdrianF X-Patchwork-Id: 62972 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 49C07C54E65 for ; Wed, 14 May 2025 18:53:43 +0000 (UTC) Received: from mta-64-226.siemens.flowmailer.net (mta-64-226.siemens.flowmailer.net [185.136.64.226]) by mx.groups.io with SMTP id smtpd.web11.110589.1747248811553974163 for ; Wed, 14 May 2025 11:53:35 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=adrian.freihofer@siemens.com header.s=fm1 header.b=XqTTfSSZ; spf=pass (domain: rts-flowmailer.siemens.com, ip: 185.136.64.226, mailfrom: fm-1329275-20250514185334fcd65affa4bb14e241-h_xboj@rts-flowmailer.siemens.com) Received: by mta-64-226.siemens.flowmailer.net with ESMTPSA id 20250514185334fcd65affa4bb14e241 for ; Wed, 14 May 2025 20:53:34 +0200 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; s=fm1; d=siemens.com; i=adrian.freihofer@siemens.com; h=Date:From:Subject:To:Message-ID:MIME-Version:Content-Type:Content-Transfer-Encoding:Cc:References:In-Reply-To; bh=r25NZ1wmwEV4MECCuZ1IG9qbnAu0UYr3sVTwHUutj+0=; b=XqTTfSSZLq9nN0YcRbdYtzowmEEJoznj9OgD15CkrVCK7Z+AiNktz0iEKF6pTgxG6bOmgG iiQRr+pEbWZALFCAh7Yu1vAAHkJI8joesBIM1LMAvU+ir4NKMAmuIJdvDh45oBpfjuqOHoko W+paPO2qPzJXQeZhARhX5IZ2m9+LpKItQLQP+8hDJYAFSJbOrYiD8/9eVaq3JDQaGfvYnaQX X/zntGJlwr/WJXQoW96ubwwCmtBrSWbA9e4Lrx0zzCX6064QWIsxi/pqzd9Y/wg2f8HxUZT8 i2KcrQt5+IgLp3BCcPri27Ro9IiJ08k9w//X41C+K78ebH8hZx6PYA+g==; From: AdrianF To: openembedded-core@lists.openembedded.org Cc: marex@denx.de, Adrian Freihofer Subject: [PATCH v3 20/22] kernel-fit-image.bbclass: ignore INITRAMFS_IMAGE_BUNDLE Date: Wed, 14 May 2025 20:51:04 +0200 Message-ID: <20250514185225.162998-21-adrian.freihofer@siemens.com> In-Reply-To: <20250514185225.162998-1-adrian.freihofer@siemens.com> References: <20250514185225.162998-1-adrian.freihofer@siemens.com> MIME-Version: 1.0 X-Flowmailer-Platform: Siemens Feedback-ID: 519:519-1329275:519-21489:flowmailer 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 ; Wed, 14 May 2025 18:53:43 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/openembedded-core/message/216538 From: Adrian Freihofer The new recipe includes the initramfs unbundled anyway. Remove the code which does not work in the context of a recipe which takes the kernel artifacts from recipe-sysroot. The kernel in the recipe-sysroot is exported by the do_install function of the kernel which runs before do_bundle_initramfs. It would be possible to support the bundled in FIT image use case if the recipe would take the kernel artifacts from the deploy folder where also the bundled kernel artifact could be found. But what's the use case of a bundled artifact included in a FIT image? Rather than supporting something which does not work well with the sstate-cache lets guide the users to a better implementation and simplify the code where possible. Signed-off-by: Adrian Freihofer --- meta/classes-recipe/kernel-fit-image.bbclass | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/meta/classes-recipe/kernel-fit-image.bbclass b/meta/classes-recipe/kernel-fit-image.bbclass index f4620aa0f86..dd8a6200328 100644 --- a/meta/classes-recipe/kernel-fit-image.bbclass +++ b/meta/classes-recipe/kernel-fit-image.bbclass @@ -14,7 +14,7 @@ DEPENDS += "\ python () { image = d.getVar('INITRAMFS_IMAGE') - if image and not bb.utils.to_boolean(d.getVar('INITRAMFS_IMAGE_BUNDLE')): + if image: if d.getVar('INITRAMFS_MULTICONFIG'): mc = d.getVar('BB_CURRENT_MC') d.appendVarFlag('do_compile', 'mcdepends', ' mc:' + mc + ':${INITRAMFS_MULTICONFIG}:${INITRAMFS_IMAGE}:do_image_complete') @@ -107,7 +107,7 @@ python do_compile() { # Prepare a ramdisk section. initramfs_image = d.getVar('INITRAMFS_IMAGE') - if initramfs_image and not oe.types.boolean(d.getVar("INITRAMFS_IMAGE_BUNDLE")): + if initramfs_image: # Find and use the first initramfs image archive type we find found = False for img in d.getVar("FIT_SUPPORTED_INITRAMFS_FSTYPES").split(): @@ -156,11 +156,9 @@ do_deploy() { install -m 0644 "${B}/fitImage" "$deploy_dir/fitImage" install -m 0644 "${B}/fit-image.its" "$deploy_dir/fit-image.its" - if [ "${INITRAMFS_IMAGE_BUNDLE}" != "1" ]; then - ln -snf fit-image.its "$deploy_dir/fitImage-its-${KERNEL_FIT_NAME}.its" - if [ -n "${KERNEL_FIT_LINK_NAME}" ] ; then - ln -snf fit-image.its "$deploy_dir/fitImage-its-${KERNEL_FIT_LINK_NAME}" - fi + ln -snf fit-image.its "$deploy_dir/fitImage-its-${KERNEL_FIT_NAME}.its" + if [ -n "${KERNEL_FIT_LINK_NAME}" ] ; then + ln -snf fit-image.its "$deploy_dir/fitImage-its-${KERNEL_FIT_LINK_NAME}" fi if [ -n "${INITRAMFS_IMAGE}" ]; then @@ -169,11 +167,9 @@ do_deploy() { ln -snf fit-image.its "$deploy_dir/fitImage-its-${INITRAMFS_IMAGE_NAME}-${KERNEL_FIT_LINK_NAME}" fi - if [ "${INITRAMFS_IMAGE_BUNDLE}" != "1" ]; then - ln -snf fitImage "$deploy_dir/fitImage-${INITRAMFS_IMAGE_NAME}-${KERNEL_FIT_NAME}${KERNEL_FIT_BIN_EXT}" - if [ -n "${KERNEL_FIT_LINK_NAME}" ] ; then - ln -snf fitImage "$deploy_dir/fitImage-${INITRAMFS_IMAGE_NAME}-${KERNEL_FIT_LINK_NAME}" - fi + ln -snf fitImage "$deploy_dir/fitImage-${INITRAMFS_IMAGE_NAME}-${KERNEL_FIT_NAME}${KERNEL_FIT_BIN_EXT}" + if [ -n "${KERNEL_FIT_LINK_NAME}" ] ; then + ln -snf fitImage "$deploy_dir/fitImage-${INITRAMFS_IMAGE_NAME}-${KERNEL_FIT_LINK_NAME}" fi fi } From patchwork Wed May 14 18:51:05 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: AdrianF X-Patchwork-Id: 62968 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 2E368C54795 for ; Wed, 14 May 2025 18:53:43 +0000 (UTC) Received: from mta-65-226.siemens.flowmailer.net (mta-65-226.siemens.flowmailer.net [185.136.65.226]) by mx.groups.io with SMTP id smtpd.web10.109901.1747248814197199931 for ; Wed, 14 May 2025 11:53:35 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=adrian.freihofer@siemens.com header.s=fm1 header.b=NAorV5vM; spf=pass (domain: rts-flowmailer.siemens.com, ip: 185.136.65.226, mailfrom: fm-1329275-202505141853346749c19343ae7e6a9d-eb13ih@rts-flowmailer.siemens.com) Received: by mta-65-226.siemens.flowmailer.net with ESMTPSA id 202505141853346749c19343ae7e6a9d for ; Wed, 14 May 2025 20:53:34 +0200 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; s=fm1; d=siemens.com; i=adrian.freihofer@siemens.com; h=Date:From:Subject:To:Message-ID:MIME-Version:Content-Type:Content-Transfer-Encoding:Cc:References:In-Reply-To; bh=1Ab1+zaAhqeOH76ZDlF+LXUJi8CaThinRsa9/UPbzN0=; b=NAorV5vM1/No+NDzEr6ux6KrDbReoMhgXHAft33yYtU3YiKKxpJkXf3LfsckvX7Gsc1PjZ SHauylHkBXmuFCiJ+K7Kqw5SVod/n1b7B0xX12PXGpcFizH8wEaWHchbXZaYfl/U19RMeddK tEn9CUUqq0IGOsVFmprXc5x6hLi8uEA5h8j7rM0HAsbDsDNQX2/79CGC0xR6wDAfWbcqFjtF wzD3ucFeAEPe2VIWZgbq5ZNSCexoiq13fuzO8Wa7bLnP0rDHv4QsNl3LwbjMGboS1U5SLups C2NIpnu/GwoxI4bzEKspkge13IBqnYhqUtlHVvzL4bkCP2P05GKYUMzQ==; From: AdrianF To: openembedded-core@lists.openembedded.org Cc: marex@denx.de, Adrian Freihofer Subject: [PATCH v3 21/22] ref-manual: replace kernel-fitimage.bbclass by kernel-fit-image.bbclass Date: Wed, 14 May 2025 20:51:05 +0200 Message-ID: <20250514185225.162998-22-adrian.freihofer@siemens.com> In-Reply-To: <20250514185225.162998-1-adrian.freihofer@siemens.com> References: <20250514185225.162998-1-adrian.freihofer@siemens.com> MIME-Version: 1.0 X-Flowmailer-Platform: Siemens Feedback-ID: 519:519-1329275:519-21489:flowmailer 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 ; Wed, 14 May 2025 18:53:43 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/openembedded-core/message/216541 From: Adrian Freihofer Signed-off-by: Adrian Freihofer --- documentation/ref-manual/classes.rst | 103 +++++++++++++++---------- documentation/ref-manual/variables.rst | 60 +++++++------- 2 files changed, 92 insertions(+), 71 deletions(-) diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 59efcbe19a7..4ea8677a1b2 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst @@ -1732,77 +1732,100 @@ Its behavior is mainly controlled by the following variables: - :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: +.. _ref-classes-kernel-fit-image: -``kernel-fitimage`` -=================== +``kernel-fit-image`` +==================== -The :ref:`ref-classes-kernel-fitimage` class provides support to pack a kernel image, -device trees, a U-boot script, an :term:`Initramfs` bundle and a RAM disk -into a single FIT image. In theory, a FIT image can support any number -of kernels, U-boot scripts, :term:`Initramfs` bundles, RAM disks and device-trees. -However, :ref:`ref-classes-kernel-fitimage` currently only supports +The :ref:`ref-classes-kernel-fit-image` class provides support to pack a kernel image, +device trees, a U-boot script, an :term:`Initramfs` into a single FIT image. +In theory, a FIT image can support any number of kernels, U-boot scripts, +:term:`Initramfs`, device-trees. +However, :ref:`ref-classes-kernel-fit-image` currently only supports limited usecases: just one kernel image, an optional U-boot script, -an optional :term:`Initramfs` bundle, an optional RAM disk, and any number of -device trees. +an optional :term:`Initramfs`, and any number of device trees. -To create a FIT image, it is required that :term:`KERNEL_CLASSES` -is set to include ":ref:`ref-classes-kernel-fitimage`" and one of :term:`KERNEL_IMAGETYPE`, -:term:`KERNEL_ALT_IMAGETYPE` or :term:`KERNEL_IMAGETYPES` to include "fitImage". +The FIT image is created by a recipe which inherits the +:ref:`ref-classes-kernel-fit-image` class. +One such example is the ``linux-yocto-fitimage`` recipe which creates a FIT +image for the Linux Yocto kernel. +Additionally, it is required that :term:`KERNEL_CLASSES` is set to include +":ref:`ref-classes-kernel-uimage`", which is the default. +The :ref:`ref-classes-kernel-uimage` exposes the required kernel and device +tree artifacts to the recipe-sysroot which are used by the +:ref:`ref-classes-kernel-fit-image` class to create the FIT image. The options for the device tree compiler passed to ``mkimage -D`` when creating the FIT image are specified using the :term:`UBOOT_MKIMAGE_DTCOPTS` variable. Only a single kernel can be added to the FIT image created by -:ref:`ref-classes-kernel-fitimage` and the kernel image in FIT is mandatory. The -address where the kernel image is to be loaded by U-Boot is +:ref:`ref-classes-kernel-fit-image` and the kernel image in FIT is mandatory. +The address where the kernel image is to be loaded by U-Boot is specified by :term:`UBOOT_LOADADDRESS` and the entrypoint by :term:`UBOOT_ENTRYPOINT`. Setting :term:`FIT_ADDRESS_CELLS` to "2" is necessary if such addresses are 64 bit ones. Multiple device trees can be added to the FIT image created by -:ref:`ref-classes-kernel-fitimage` and the device tree is optional. +:ref:`ref-classes-kernel-fit-image` and the device tree is optional. The address where the device tree is to be loaded by U-Boot is specified by :term:`UBOOT_DTBO_LOADADDRESS` for device tree overlays and by :term:`UBOOT_DTB_LOADADDRESS` for device tree binaries. -Only a single RAM disk can be added to the FIT image created by -:ref:`ref-classes-kernel-fitimage` and the RAM disk in FIT is optional. +Only a single :term:`Initramfs` can be added to the FIT image created by +:ref:`ref-classes-kernel-fit-image`. The :term:`Initramfs` in FIT is optional. The address where the RAM disk image is to be loaded by U-Boot is specified by :term:`UBOOT_RD_LOADADDRESS` and the entrypoint by -:term:`UBOOT_RD_ENTRYPOINT`. The ramdisk is added to the FIT image when -:term:`INITRAMFS_IMAGE` is specified and requires that :term:`INITRAMFS_IMAGE_BUNDLE` -is not set to 1. +:term:`UBOOT_RD_ENTRYPOINT`. The :term:`Initramfs` is added to the FIT image +when :term:`INITRAMFS_IMAGE` is specified. -Only a single :term:`Initramfs` bundle can be added to the FIT image created by -:ref:`ref-classes-kernel-fitimage` and the :term:`Initramfs` bundle in FIT is optional. -In case of :term:`Initramfs`, the kernel is configured to be bundled with the root filesystem -in the same binary (example: zImage-initramfs-:term:`MACHINE`.bin). -When the kernel is copied to RAM and executed, it unpacks the :term:`Initramfs` root filesystem. -The :term:`Initramfs` bundle can be enabled when :term:`INITRAMFS_IMAGE` -is specified and requires that :term:`INITRAMFS_IMAGE_BUNDLE` is set to 1. -The address where the :term:`Initramfs` bundle is to be loaded by U-boot is specified -by :term:`UBOOT_LOADADDRESS` and the entrypoint by :term:`UBOOT_ENTRYPOINT`. +Note that (in contradiction to the previous `kernel-fitimage.bbclass`) the +:term:`INITRAMFS_IMAGE_BUNDLE` variable is not evaluated by the +:ref:`ref-classes-kernel-fit-image` class. +The :term:`Initramfs` and the kernel image are added as independent image +nodes to the FIT image. +Bundling a RAM disk image with the kernel image and including the bundle in the +FIT image would be possible. However, this approach has the disadvantage that +any change to the RAM disk image would necessitate rebuilding the kernel image. +This process requires the full kernel build directory, which is kind of +incompatible with the `sstate-cache` and, consequently, with SDKs. Only a single U-boot boot script can be added to the FIT image created by -:ref:`ref-classes-kernel-fitimage` and the boot script is optional. +:ref:`ref-classes-kernel-fit-image`. The boot script is optional. The boot script is specified in the ITS file as a text file containing -U-boot commands. When using a boot script the user should configure the -U-boot :ref:`ref-tasks-install` task to copy the script to sysroot. -So the script can be included in the FIT image by the :ref:`ref-classes-kernel-fitimage` -class. At run-time, U-boot CONFIG_BOOTCOMMAND define can be configured to -load the boot script from the FIT image and execute it. +U-boot commands. When using a boot script the recipe which inherits the +:ref:`ref-classes-kernel-fit-image` class should add the script to +:term:`SRC_URI` and set the :term:`FIT_UBOOT_ENV` variable to the name of the +like the following:: -The FIT image generated by the :ref:`ref-classes-kernel-fitimage` class is signed when the + FIT_UBOOT_ENV = "boot.txt" + SRC_URI += "file://${FIT_UBOOT_ENV}" + +At run-time, U-boot CONFIG_BOOTCOMMAND define can be configured to +load the boot script from the FIT image and source it. + +The FIT image generated by the :ref:`ref-classes-kernel-fit-image` class is signed when the variables :term:`UBOOT_SIGN_ENABLE`, :term:`UBOOT_MKIMAGE_DTCOPTS`, :term:`UBOOT_SIGN_KEYDIR` and :term:`UBOOT_SIGN_KEYNAME` are set appropriately. The default values used for :term:`FIT_HASH_ALG` and -:term:`FIT_SIGN_ALG` in :ref:`ref-classes-kernel-fitimage` are "sha256" and +:term:`FIT_SIGN_ALG` in :ref:`ref-classes-kernel-fit-image` are "sha256" and "rsa2048" respectively. The keys for signing the FIT image can be generated using -the :ref:`ref-classes-kernel-fitimage` class when both :term:`FIT_GENERATE_KEYS` and +the :ref:`ref-classes-kernel-fit-image` class when both :term:`FIT_GENERATE_KEYS` and :term:`UBOOT_SIGN_ENABLE` are set to "1". +If the FIT image should be used as a replacement for the kernel image which +is installed in the root filesystem, then the following variables can be set +e.g. in the machine configuration file:: + + # Do not install the kernel image package + RRECOMMENDS:${KERNEL_PACKAGE_NAME}-base = "" + + # Install the FIT image package + MACHINE_EXTRA_RDEPENDS += "${PREFERRED_PROVIDER_virtual/kernel}-fitimage" + + # Configure the image.bbclass to depend on the fitImage instead of only + # the kernel to ensure the fitImage is built with the image + KERNEL_DEPLOY_DEPEND = "${PREFERRED_PROVIDER_virtual/kernel}-fitimage:do_deploy" .. _ref-classes-kernel-grub: @@ -3434,7 +3457,7 @@ See U-Boot's documentation for details about `verified boot and the `signature process `__. -See also the description of :ref:`ref-classes-kernel-fitimage` class, which this class +See also the description of :ref:`ref-classes-kernel-fit-image` class, which this class imitates. .. _ref-classes-uki: diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index c22abd4a8e5..5612c1487d2 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -2790,7 +2790,7 @@ system and gives an overview of their function and contents. ``meta/classes-recipe`` to see how the variable is used. :term:`EXTERNAL_KERNEL_DEVICETREE` - When inheriting :ref:`ref-classes-kernel-fitimage` and a + When inheriting :ref:`ref-classes-kernel-fit-image` and a :term:`PREFERRED_PROVIDER` for ``virtual/dtb`` set to ``devicetree``, the variable :term:`EXTERNAL_KERNEL_DEVICETREE` can be used to specify a directory containing one or more compiled device tree or device tree @@ -3318,7 +3318,7 @@ system and gives an overview of their function and contents. Specifies the value of the ``#address-cells`` value for the description of the FIT image. - The default value is set to "1" by the :ref:`ref-classes-kernel-fitimage` + The default value is set to "1" by the :ref:`ref-classes-kernel-fit-image` class, which corresponds to 32 bit addresses. For platforms that need to set 64 bit addresses, for example in @@ -3337,11 +3337,11 @@ system and gives an overview of their function and contents. Specifies the default device tree binary (dtb) file for a FIT image when multiple ones are provided. - This variable is used in the :ref:`ref-classes-kernel-fitimage` class. + This variable is used in the :ref:`ref-classes-kernel-fit-image` class. :term:`FIT_DESC` Specifies the description string encoded into a FIT image. The - default value is set by the :ref:`ref-classes-kernel-fitimage` class as + default value is set by the :ref:`ref-classes-kernel-fit-image` class as follows:: FIT_DESC ?= "U-Boot fitImage for ${DISTRO_NAME}/${PV}/${MACHINE}" @@ -3350,12 +3350,12 @@ system and gives an overview of their function and contents. Decides whether to generate the keys for signing the FIT image if they don't already exist. The keys are created in :term:`UBOOT_SIGN_KEYDIR`. The default value is set to "0" - by the :ref:`ref-classes-kernel-fitimage` class. + by the :ref:`ref-classes-kernel-fit-image` class. :term:`FIT_HASH_ALG` Specifies the hash algorithm used in creating the FIT Image. This variable is set by default to "sha256" by the - :ref:`ref-classes-kernel-fitimage` class. + :ref:`ref-classes-kernel-fit-image` class. :term:`FIT_KERNEL_COMP_ALG` The compression algorithm to use for the kernel image inside the FIT Image. @@ -3374,31 +3374,31 @@ system and gives an overview of their function and contents. :term:`FIT_KEY_GENRSA_ARGS` Arguments to ``openssl genrsa`` for generating a RSA private key for signing the FIT image. The default value is set to "-F4" by the - :ref:`ref-classes-kernel-fitimage` class. + :ref:`ref-classes-kernel-fit-image` class. :term:`FIT_KEY_REQ_ARGS` Arguments to ``openssl req`` for generating a certificate for signing the FIT image. The default value is "-batch -new" by the - :ref:`ref-classes-kernel-fitimage` class, "batch" for + :ref:`ref-classes-kernel-fit-image` class, "batch" for non interactive mode and "new" for generating new keys. :term:`FIT_KEY_SIGN_PKCS` Format for the public key certificate used for signing the FIT image. The default value is set to "x509" by the - :ref:`ref-classes-kernel-fitimage` class. + :ref:`ref-classes-kernel-fit-image` class. :term:`FIT_SIGN_ALG` Specifies the signature algorithm used in creating the FIT Image. This variable is set by default to "rsa2048" by the - :ref:`ref-classes-kernel-fitimage` class. + :ref:`ref-classes-kernel-fit-image` class. :term:`FIT_PAD_ALG` Specifies the padding algorithm used in creating the FIT Image. The default value is set to "pkcs-1.5" by the - :ref:`ref-classes-kernel-fitimage` class. + :ref:`ref-classes-kernel-fit-image` class. :term:`FIT_SIGN_INDIVIDUAL` - If set to "1", the :ref:`ref-classes-kernel-fitimage` class signs each + If set to "1", the :ref:`ref-classes-kernel-fit-image` class signs each image node individually, including the kernel, DTB, RAM disk, and any other image types present in the FIT image, in addition to signing the configuration nodes. @@ -3431,13 +3431,13 @@ system and gives an overview of their function and contents. :term:`FIT_SIGN_NUMBITS` Size of the private key used in the FIT image, in number of bits. The default value for this variable is set to "2048" - by the :ref:`ref-classes-kernel-fitimage` class. + by the :ref:`ref-classes-kernel-fit-image` class. :term:`FIT_UBOOT_ENV` This variable allows to add a U-Boot script as a text file to the FIT image. Such a script can be sourced from the U-Boot shell. - When inheriting the :ref:`ref-classes-kernel-fitimage` class a + When inheriting the :ref:`ref-classes-kernel-fit-image` class a script file should be included in the :term:`SRC_URI` of the Linux kernel recipe. @@ -4990,9 +4990,7 @@ system and gives an overview of their function and contents. :term:`KERNEL_CLASSES` A list of classes defining kernel image types that the :ref:`ref-classes-kernel` class should inherit. You typically - append this variable to enable extended image types. An example is - ":ref:`ref-classes-kernel-fitimage`", which enables - FIT image support and resides in ``meta/classes-recipe/kernel-fitimage.bbclass``. + append this variable to enable extended image types. You can register custom kernel image types with the :ref:`ref-classes-kernel` class using this variable. @@ -10221,13 +10219,13 @@ system and gives an overview of their function and contents. :term:`UBOOT_DTB_LOADADDRESS` Specifies the load address for the dtb image used by U-Boot. During FIT image creation, the :term:`UBOOT_DTB_LOADADDRESS` variable is used in - :ref:`ref-classes-kernel-fitimage` class to specify the load address to be + :ref:`ref-classes-kernel-fit-image` class to specify the load address to be used in creating the dtb sections of Image Tree Source for the FIT image. :term:`UBOOT_DTBO_LOADADDRESS` Specifies the load address for the dtbo image used by U-Boot. During FIT image creation, the :term:`UBOOT_DTBO_LOADADDRESS` variable is used in - :ref:`ref-classes-kernel-fitimage` class to specify the load address to be + :ref:`ref-classes-kernel-fit-image` class to specify the load address to be used in creating the dtbo sections of Image Tree Source for the FIT image. :term:`UBOOT_ENTRYPOINT` @@ -10239,7 +10237,7 @@ system and gives an overview of their function and contents. - The :term:`FIT_ADDRESS_CELLS` variable for FIT image creation. - The :term:`UBOOT_FIT_ADDRESS_CELLS` variable for U-Boot FIT image creation. - This variable is used by the :ref:`ref-classes-kernel-fitimage`, + This variable is used by the :ref:`ref-classes-kernel-fit-image`, :ref:`ref-classes-kernel-uimage`, :ref:`ref-classes-kernel`, :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign` classes. @@ -10507,7 +10505,7 @@ system and gives an overview of their function and contents. - The :term:`FIT_ADDRESS_CELLS` variable for FIT image creation. - The :term:`UBOOT_FIT_ADDRESS_CELLS` variable for U-Boot FIT image creation. - This variable is used by the :ref:`ref-classes-kernel-fitimage`, + This variable is used by the :ref:`ref-classes-kernel-fit-image`, :ref:`ref-classes-kernel-uimage`, :ref:`ref-classes-kernel`, :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign` classes. @@ -10535,15 +10533,15 @@ system and gives an overview of their function and contents. :term:`UBOOT_MKIMAGE` Specifies the name of the mkimage command as used by the - :ref:`ref-classes-kernel-fitimage` class to assemble + :ref:`ref-classes-kernel-fit-image` class to assemble the FIT image. This can be used to substitute an alternative command, wrapper script or function if desired. The default is "uboot-mkimage". :term:`UBOOT_MKIMAGE_DTCOPTS` Options for the device tree compiler passed to ``mkimage -D`` feature - while creating a FIT image with the :ref:`ref-classes-kernel-fitimage` + while creating a FIT image with the :ref:`ref-classes-kernel-fit-image` class. If :term:`UBOOT_MKIMAGE_DTCOPTS` is not set then the - :ref:`ref-classes-kernel-fitimage` class will not pass the ``-D`` option + :ref:`ref-classes-kernel-fit-image` class will not pass the ``-D`` option to ``mkimage``. This variable is also used by the :ref:`ref-classes-uboot-sign` class. @@ -10554,42 +10552,42 @@ system and gives an overview of their function and contents. :term:`UBOOT_MKIMAGE_SIGN` Specifies the name of the mkimage command as used by the - :ref:`ref-classes-kernel-fitimage` class to sign + :ref:`ref-classes-kernel-fit-image` class to sign the FIT image after it has been assembled (if enabled). This can be used to substitute an alternative command, wrapper script or function if desired. The default is "${:term:`UBOOT_MKIMAGE`}". :term:`UBOOT_MKIMAGE_SIGN_ARGS` Optionally specifies additional arguments for the - :ref:`ref-classes-kernel-fitimage` class to pass to the + :ref:`ref-classes-kernel-fit-image` class to pass to the mkimage command when signing the FIT image. :term:`UBOOT_RD_ENTRYPOINT` Specifies the entrypoint for the RAM disk image. During FIT image creation, the :term:`UBOOT_RD_ENTRYPOINT` variable is used in - :ref:`ref-classes-kernel-fitimage` class to specify the entrypoint to be + :ref:`ref-classes-kernel-fit-image` class to specify the entrypoint to be used in creating the Image Tree Source for the FIT image. :term:`UBOOT_RD_LOADADDRESS` Specifies the load address for the RAM disk image. During FIT image creation, the :term:`UBOOT_RD_LOADADDRESS` variable is used in - :ref:`ref-classes-kernel-fitimage` class to specify the load address to + :ref:`ref-classes-kernel-fit-image` class to specify the load address to be used in creating the Image Tree Source for the FIT image. :term:`UBOOT_SIGN_ENABLE` Enable signing of FIT image. The default value is "0". - This variable is used by the :ref:`ref-classes-kernel-fitimage`, + This variable is used by the :ref:`ref-classes-kernel-fit-image`, :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign` classes. :term:`UBOOT_SIGN_KEYDIR` Location of the directory containing the RSA key and certificate used for - signing FIT image, used by the :ref:`ref-classes-kernel-fitimage` and + signing FIT image, used by the :ref:`ref-classes-kernel-fit-image` and :ref:`ref-classes-uboot-sign` classes. :term:`UBOOT_SIGN_KEYNAME` - The name of keys used by the :ref:`ref-classes-kernel-fitimage` class + The name of keys used by the :ref:`ref-classes-kernel-fit-image` class for signing U-Boot FIT image stored in the :term:`UBOOT_SIGN_KEYDIR` directory. If we have for example a ``dev.key`` key and a ``dev.crt`` certificate stored in the :term:`UBOOT_SIGN_KEYDIR` directory, you will From patchwork Wed May 14 18:51:06 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: AdrianF X-Patchwork-Id: 62970 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 49C38C54E90 for ; Wed, 14 May 2025 18:53:43 +0000 (UTC) Received: from mta-65-227.siemens.flowmailer.net (mta-65-227.siemens.flowmailer.net [185.136.65.227]) by mx.groups.io with SMTP id smtpd.web10.109902.1747248814347842213 for ; Wed, 14 May 2025 11:53:35 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=adrian.freihofer@siemens.com header.s=fm1 header.b=bfR98tXW; spf=pass (domain: rts-flowmailer.siemens.com, ip: 185.136.65.227, mailfrom: fm-1329275-2025051418533488a44be7b2f004a7f2-eoz_qm@rts-flowmailer.siemens.com) Received: by mta-65-227.siemens.flowmailer.net with ESMTPSA id 2025051418533488a44be7b2f004a7f2 for ; Wed, 14 May 2025 20:53:34 +0200 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; s=fm1; d=siemens.com; i=adrian.freihofer@siemens.com; h=Date:From:Subject:To:Message-ID:MIME-Version:Content-Type:Content-Transfer-Encoding:Cc:References:In-Reply-To; bh=oXXuIQ2Agrdjwt+i5UFvBlAsnJZCKYqwJWiEN5Ov1Gw=; b=bfR98tXWjL6TczeBIQcTTa5Ivz5U+IL7l5idZDkVsKEsPk5QbyZFblPCh531/xWM3H7MeA M+CGizo52jBeqGl3ToaIOdxUvIybT5yrkWK1BVOlDtN6xIM8h50avDSXxyYO7N7DyRhQ0wXY Dv8SHxepQ6e3wUsudbJRv+m6A9npeedAw4sV5BDqxRMTbqsU0uBmVLGQlKPNL0yRdgFQYEM6 fPwmyqcIy1UAC6cXt9alSARsN14IxGsMjJW9pEeIu6/STioeJsjAOY89L433WIIspyDQaTLo EkJOMvv+oE67MZWP1st630n5/TjBSrZ9LH992oeDzh8xGsvCsbf2w3pg==; From: AdrianF To: openembedded-core@lists.openembedded.org Cc: marex@denx.de, Adrian Freihofer Subject: [PATCH v3 22/22] release-notes: drop references to kernel-fitimage.bbclass Date: Wed, 14 May 2025 20:51:06 +0200 Message-ID: <20250514185225.162998-23-adrian.freihofer@siemens.com> In-Reply-To: <20250514185225.162998-1-adrian.freihofer@siemens.com> References: <20250514185225.162998-1-adrian.freihofer@siemens.com> MIME-Version: 1.0 X-Flowmailer-Platform: Siemens Feedback-ID: 519:519-1329275:519-21489:flowmailer 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 ; Wed, 14 May 2025 18:53:43 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/openembedded-core/message/216539 From: Adrian Freihofer This commit drops references to the kernel-fitimage.bbclass to prevent from build errors when the label is no longer available. Signed-off-by: Adrian Freihofer --- documentation/migration-guides/release-notes-5.1.rst | 2 +- documentation/migration-guides/release-notes-5.2.rst | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/migration-guides/release-notes-5.1.rst b/documentation/migration-guides/release-notes-5.1.rst index 267934a71ed..bab0c145814 100644 --- a/documentation/migration-guides/release-notes-5.1.rst +++ b/documentation/migration-guides/release-notes-5.1.rst @@ -377,7 +377,7 @@ New Features / Enhancements in 5.1 :term:`SIGGEN_EXCLUDERECIPES_ABISAFE` and does not trigger a rebuild on a change for dependent tasks. - - In :ref:`ref-classes-kernel-fitimage`, the existence of + - In ``kernel-fitimage``, the existence of :term:`EXTERNAL_KERNEL_DEVICETREE` is checked more thoroughly to avoid false positives. diff --git a/documentation/migration-guides/release-notes-5.2.rst b/documentation/migration-guides/release-notes-5.2.rst index dd541a7e3a4..42c6d60f9b8 100644 --- a/documentation/migration-guides/release-notes-5.2.rst +++ b/documentation/migration-guides/release-notes-5.2.rst @@ -29,7 +29,7 @@ New Features / Enhancements in |yocto-ver| ``RuntimeWatchdogSec`` option in ``/etc/systemd/system.conf``. - :term:`FIT_UBOOT_ENV` to allow including a u-boot script as a text in a - fit image. See the :ref:`ref-classes-kernel-fitimage` for more information. + fit image. See the ``kernel-fitimage`` for more information. - :ref:`ref-classes-meson`: :term:`MESON_INSTALL_TAGS` to allow passing install tags (``--tags``) to the ``meson install`` command during the @@ -684,7 +684,7 @@ New Features / Enhancements in |yocto-ver| command-line tool was added to the different Yocto Project and OpenEmbedded repositories. - - :ref:`ref-classes-kernel-fitimage`: handle :doc:`multiconfig + - ``kernel-fitimage``: handle :doc:`multiconfig ` dependency when :term:`INITRAMFS_MULTICONFIG` is set.