* [PATCH 1/2] kernel-fitimage: Add FIT_CONF_MAPPINGS for flexible DTB configuration
2025-12-18 20:14 [PATCH 0/2] kernel-fitimage: Add FIT_CONF_MAPPINGS for flexible DTB configuration AdrianF
@ 2025-12-18 20:14 ` AdrianF
2026-01-08 14:29 ` [OE-core] " Quentin Schulz
2025-12-18 20:14 ` [PATCH 2/2] oe-selftest: fitimage: support FIT_CONF_MAPPINGS AdrianF
1 sibling, 1 reply; 4+ messages in thread
From: AdrianF @ 2025-12-18 20:14 UTC (permalink / raw)
To: openembedded-core; +Cc: Adrian Freihofer
From: Adrian Freihofer <adrian.freihofer@siemens.com>
Having a 1-1 mapping between DTB names and configuration nodes names in
FIT images does not always work. Make this a bit more flexible by
allowing users to specify mappings to rename configuration nodes or add
extra configuration nodes for existing DTBs.
The new FIT_CONF_MAPPINGS variable accepts a space-separated list of
mapping commands:
- dtb-conf:DTB_NAME:NEW_NAME
Renames the configuration node for a specific DTB.
- dtb-extra-conf:DTB_NAME:EXTRA_NAME
Creates an additional configuration node for an existing DTB.
Example usage:
FIT_CONF_MAPPINGS = "\
dtb-extra-conf:am335x-bonegreen:bonegreen \
dtb-conf:am335x-boneblack:bbblack"
This generates three configuration nodes from two DTBs:
am335x-bonegreen, bonegreen (extra), and bbblack (renamed).
The implementation validates all mappings and ensures they match
existing DTBs, failing with clear error messages for invalid or unused
mappings.
Also removes leftover debug warning that was printing DTB configuration
details during FIT image generation.
Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
---
meta/classes-recipe/kernel-fit-image.bbclass | 2 +-
meta/conf/image-fitimage.conf | 12 +++++
meta/lib/oe/fitimage.py | 57 ++++++++++++++++++--
3 files changed, 65 insertions(+), 6 deletions(-)
diff --git a/meta/classes-recipe/kernel-fit-image.bbclass b/meta/classes-recipe/kernel-fit-image.bbclass
index fd0d21ceee..ec8e861d7f 100644
--- a/meta/classes-recipe/kernel-fit-image.bbclass
+++ b/meta/classes-recipe/kernel-fit-image.bbclass
@@ -139,7 +139,7 @@ python do_compile() {
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(d.getVar("FIT_CONF_DEFAULT_DTB"))
+ root_node.fitimage_emit_section_config(d.getVar("FIT_CONF_DEFAULT_DTB"), d.getVar("FIT_CONF_MAPPINGS"))
# Write the its file
root_node.write_its_file(itsfile)
diff --git a/meta/conf/image-fitimage.conf b/meta/conf/image-fitimage.conf
index 090ee148f4..b183e64319 100644
--- a/meta/conf/image-fitimage.conf
+++ b/meta/conf/image-fitimage.conf
@@ -47,6 +47,18 @@ FIT_LINUX_BIN ?= "linux.bin"
# Allow user to select the default DTB for FIT image when multiple dtb's exists.
FIT_CONF_DEFAULT_DTB ?= ""
+# Allow user to specify DTB configuration node mappings.
+# The format is a space-separated list of mappings. Supported mapping types are:
+# dtb-conf:DTB_NAME:NEW_NAME - Rename the configuration node for a DTB
+# dtb-extra-conf:DTB_NAME:EXTRA_NAME - Add an additional configuration node for a DTB
+# Example:
+# FIT_CONF_MAPPINGS = "\
+# dtb-extra-conf:am335x-bonegreen:bonegreen \
+# dtb-conf:am335x-boneblack:bbblack"
+# Two DTBs (am335x-bonegreen and am335x-boneblack) result in three
+# configuration nodes: am335x-bonegreen, bonegreen, bbblack
+FIT_CONF_MAPPINGS ?= ""
+
# length of address in number of <u32> cells
# ex: 1 32bits address, 2 64bits address
FIT_ADDRESS_CELLS ?= "1"
diff --git a/meta/lib/oe/fitimage.py b/meta/lib/oe/fitimage.py
index f303799155..4798088259 100644
--- a/meta/lib/oe/fitimage.py
+++ b/meta/lib/oe/fitimage.py
@@ -331,7 +331,6 @@ class ItsNodeRootKernel(ItsNode):
dtb_id = os.path.basename(dtb_path)
dtb_alias_node = ItsNodeDtbAlias("fdt-" + dtb_id, dtb_alias_id, compatible)
self._dtb_alias.append(dtb_alias_node)
- bb.warn(f"compatible: {compatible}, dtb_alias_id: {dtb_alias_id}, dtb_id: {dtb_id}, dtb_path: {dtb_path}")
def fitimage_emit_section_boot_script(self, bootscr_id, bootscr_path):
"""Emit the fitImage ITS u-boot script section"""
@@ -462,15 +461,63 @@ class ItsNodeRootKernel(ItsNode):
}
)
- def fitimage_emit_section_config(self, default_dtb_image=None):
+ def fitimage_emit_section_config(self, default_dtb_image=None, mappings=None):
if self._dtbs:
+ dtb_extra_confs = []
+ dtb_confs = {}
+ if mappings:
+ for mapping in mappings.split():
+ try:
+ mapping_type, dtb_name, alt_name = mapping.split(':')
+ except ValueError:
+ bb.fatal("FIT configuration mapping '%s' is invalid. Expected format: 'mapping_type:dtb_name:alternative_name'" % mapping)
+ if mapping_type == "dtb-conf":
+ if dtb_name in dtb_confs:
+ bb.fatal("FIT configuration mapping 'dtb-conf:%s' specified multiple times" % dtb_name)
+ dtb_confs[dtb_name] = alt_name
+ elif mapping_type == "dtb-extra-conf":
+ dtb_extra_confs.append((dtb_name, alt_name))
+ else:
+ bb.fatal("FIT configuration mapping-type '%s' is invalid" % mapping_type)
+
+ # Process regular DTBs
for dtb in self._dtbs:
dtb_name = dtb.name
if dtb.name.startswith("fdt-"):
dtb_name = dtb.name[len("fdt-"):]
- self._fitimage_emit_one_section_config(self._conf_prefix + dtb_name, dtb)
- for dtb in self._dtb_alias:
- self._fitimage_emit_one_section_config(self._conf_prefix + dtb.alias_name, dtb)
+
+ dtb_renamed = dtb_name
+ if dtb_name in dtb_confs:
+ dtb_renamed = dtb_confs.pop(dtb_name)
+ self._fitimage_emit_one_section_config(self._conf_prefix + dtb_renamed, dtb)
+
+ # Process extra configurations for this DTB
+ for dtb_extra_name, dtb_extra_alias in dtb_extra_confs[:]:
+ if dtb_name == dtb_extra_name:
+ dtb_extra_confs.remove((dtb_extra_name, dtb_extra_alias))
+ self._fitimage_emit_one_section_config(self._conf_prefix + dtb_extra_alias, dtb)
+
+ # Process external DTB sym-link aliases
+ for dtb_alias in self._dtb_alias:
+ alias_name = dtb_alias.alias_name
+ dtb_renamed = alias_name
+ if alias_name in dtb_confs:
+ dtb_renamed = dtb_confs.pop(alias_name)
+ self._fitimage_emit_one_section_config(self._conf_prefix + dtb_renamed, dtb_alias)
+
+ # Process extra configurations for this DTB alias
+ for dtb_extra_name, dtb_extra_alias in dtb_extra_confs[:]:
+ if alias_name == dtb_extra_name:
+ dtb_extra_confs.remove((dtb_extra_name, dtb_extra_alias))
+ self._fitimage_emit_one_section_config(self._conf_prefix + dtb_extra_alias, dtb_alias)
+
+ # Verify all mappings were used
+ if dtb_confs or dtb_extra_confs:
+ unused_conf = (
+ ["dtb-conf:%s:%s" % (name, alt) for name, alt in dtb_confs.items()] +
+ ["dtb-extra-conf:%s:%s" % (name, alias) for name, alias in dtb_extra_confs]
+ )
+ bb.fatal("FIT configuration mapping(s) not matched with any DTB: %s" % ', '.join(unused_conf))
else:
# Currently exactly one kernel is supported.
self._fitimage_emit_one_section_config(self._conf_prefix + "1")
--
2.52.0
^ permalink raw reply related [flat|nested] 4+ messages in thread* [PATCH 2/2] oe-selftest: fitimage: support FIT_CONF_MAPPINGS
2025-12-18 20:14 [PATCH 0/2] kernel-fitimage: Add FIT_CONF_MAPPINGS for flexible DTB configuration AdrianF
2025-12-18 20:14 ` [PATCH 1/2] " AdrianF
@ 2025-12-18 20:14 ` AdrianF
1 sibling, 0 replies; 4+ messages in thread
From: AdrianF @ 2025-12-18 20:14 UTC (permalink / raw)
To: openembedded-core; +Cc: Adrian Freihofer
From: Adrian Freihofer <adrian.freihofer@siemens.com>
Add some quick tests for the FIT_CONF_MAPPINGS handling in fitimage.py
Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
---
meta/lib/oeqa/selftest/cases/fitimage.py | 99 +++++++++++++++++++++++-
1 file changed, 95 insertions(+), 4 deletions(-)
diff --git a/meta/lib/oeqa/selftest/cases/fitimage.py b/meta/lib/oeqa/selftest/cases/fitimage.py
index 8df5e92a34..0f2d9d17db 100644
--- a/meta/lib/oeqa/selftest/cases/fitimage.py
+++ b/meta/lib/oeqa/selftest/cases/fitimage.py
@@ -12,6 +12,7 @@ import pprint
import oe.fitimage
+from bb import BBHandledException
from oeqa.selftest.case import OESelftestTestCase
from oeqa.utils.commands import runCmd, bitbake, get_bb_vars, get_bb_var
@@ -411,6 +412,7 @@ class KernelFitImageBase(FitImageTestCase):
internal_used = {
'DEPLOY_DIR_IMAGE',
'FIT_CONF_DEFAULT_DTB',
+ 'FIT_CONF_MAPPINGS',
'FIT_CONF_PREFIX',
'FIT_DESC',
'FIT_HASH_ALG',
@@ -542,9 +544,52 @@ class KernelFitImageBase(FitImageTestCase):
else:
not_images.append('ramdisk-1')
- # configuration nodes (one per DTB and also one per symlink)
+ # configuration nodes (one per DTB, symlink, and mappings)
+ configurations = []
if dtb_files:
- configurations = [bb_vars['FIT_CONF_PREFIX'] + conf for conf in dtb_files + dtb_symlinks]
+ fit_conf_prefix = bb_vars['FIT_CONF_PREFIX']
+ fit_conf_mappings = bb_vars.get('FIT_CONF_MAPPINGS', '')
+
+ # Parse mappings to build configuration node names
+ dtb_confs = {}
+ dtb_extra_confs = []
+ if fit_conf_mappings:
+ for mapping in fit_conf_mappings.split():
+ mapping_type, dtb_name, alt_name = mapping.split(':')
+ if mapping_type == "dtb-conf":
+ dtb_confs[dtb_name] = alt_name
+ elif mapping_type == "dtb-extra-conf":
+ dtb_extra_confs.append((dtb_name, alt_name))
+ else:
+ self.fail("Invalid FIT_CONF_MAPPINGS type: %s" % mapping_type)
+
+ # Generate configuration names based on DTBs and mappings
+ for dtb in dtb_files:
+ if dtb in dtb_confs:
+ # DTB is renamed via dtb-conf
+ configurations.append(fit_conf_prefix + dtb_confs[dtb])
+ else:
+ # Default configuration name
+ configurations.append(fit_conf_prefix + dtb)
+
+ # Add extra configurations for this DTB
+ for dtb_extra_name, dtb_extra_alias in dtb_extra_confs:
+ if dtb == dtb_extra_name:
+ configurations.append(fit_conf_prefix + dtb_extra_alias)
+
+ # Add symlink configurations with mapping support
+ for dtb_symlink in dtb_symlinks:
+ if dtb_symlink in dtb_confs:
+ # Symlink is renamed via dtb-conf
+ configurations.append(fit_conf_prefix + dtb_confs[dtb_symlink])
+ else:
+ # Default configuration name for symlink
+ configurations.append(fit_conf_prefix + dtb_symlink)
+
+ # Add extra configurations for this DTB symlink
+ for dtb_extra_name, dtb_extra_alias in dtb_extra_confs:
+ if dtb_symlink == dtb_extra_name:
+ configurations.append(fit_conf_prefix + dtb_extra_alias)
else:
configurations = [bb_vars['FIT_CONF_PREFIX'] + '1']
@@ -1069,6 +1114,7 @@ class FitImagePyTests(KernelFitImageBase):
# image-fitimage.conf
'FIT_ADDRESS_CELLS': "1",
'FIT_CONF_DEFAULT_DTB': "",
+ 'FIT_CONF_MAPPINGS': "",
'FIT_CONF_PREFIX': "conf-",
'FIT_DESC': "Kernel fitImage for a dummy distro",
'FIT_GENERATE_KEYS': "0",
@@ -1128,11 +1174,17 @@ class FitImagePyTests(KernelFitImageBase):
bb_vars.get('UBOOT_MKIMAGE_KERNEL_TYPE'), bb_vars.get("UBOOT_ENTRYSYMBOL")
)
- dtb_files, _ = FitImageTestCase._get_dtb_files(bb_vars)
+ dtb_files, dtb_symlinks = FitImageTestCase._get_dtb_files(bb_vars)
for dtb in dtb_files:
root_node.fitimage_emit_section_dtb(dtb, os.path.join("a-dir", dtb),
bb_vars.get("UBOOT_DTB_LOADADDRESS"), bb_vars.get("UBOOT_DTBO_LOADADDRESS"))
+ for dtb_symlink in dtb_symlinks:
+ # For test purposes, assume each symlink points to a DTB with the same basename minus "-alias"
+ # In this case, "am335x-bonegreen-ext-alias.dtb" -> "am335x-bonegreen-ext.dtb"
+ dtb_target = dtb_symlink.replace("-alias", "")
+ root_node.fitimage_emit_section_dtb_alias(dtb_symlink, os.path.join("a-dir", dtb_target))
+
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'])
@@ -1145,7 +1197,7 @@ class FitImagePyTests(KernelFitImageBase):
"core-image-minimal-initramfs",
bb_vars.get("UBOOT_RD_LOADADDRESS"), bb_vars.get("UBOOT_RD_ENTRYPOINT"))
- root_node.fitimage_emit_section_config(bb_vars['FIT_CONF_DEFAULT_DTB'])
+ root_node.fitimage_emit_section_config(bb_vars['FIT_CONF_DEFAULT_DTB'], bb_vars.get('FIT_CONF_MAPPINGS'))
root_node.write_its_file(fitimage_its_path)
self.assertExists(fitimage_its_path, "%s image tree source doesn't exist" % (fitimage_its_path))
@@ -1162,6 +1214,45 @@ class FitImagePyTests(KernelFitImageBase):
}
self._test_fitimage_py(bb_vars_overrides)
+ def test_fitimage_py_conf_mappings(self):
+ """Test FIT_CONF_MAPPINGS functionality with dtb-conf and dtb-extra-conf"""
+ bb_vars_overrides = {
+ 'KERNEL_DEVICETREE': "am335x-bonegreen.dtb am335x-boneblack.dtb beaglebone.dtb",
+ 'FIT_CONF_MAPPINGS': "dtb-extra-conf:am335x-bonegreen.dtb:bonegreen.dtb dtb-conf:am335x-boneblack.dtb:bbblack",
+ 'FIT_CONF_DEFAULT_DTB': "bbblack"
+ }
+ self._test_fitimage_py(bb_vars_overrides)
+
+ def test_fitimage_py_conf_mappings_with_alias(self):
+ """Test FIT_CONF_MAPPINGS with external DTB aliases (symlinks)"""
+ bb_vars_overrides = {
+ 'PREFERRED_PROVIDER_virtual/dtb': "bbb-dtbs-as-ext",
+ 'FIT_CONF_MAPPINGS': "dtb-conf:am335x-bonegreen-ext-alias.dtb:green-alias-renamed dtb-extra-conf:am335x-bonegreen-ext.dtb:green-extra",
+ }
+ self._test_fitimage_py(bb_vars_overrides)
+
+ def test_fitimage_py_conf_mappings_unused_error(self):
+ """Test that unused FIT_CONF_MAPPINGS cause a fatal error"""
+ bb_vars_overrides = {
+ 'KERNEL_DEVICETREE': "am335x-bonegreen.dtb am335x-boneblack.dtb",
+ 'FIT_CONF_MAPPINGS': "dtb-conf:nonexistent.dtb:renamed",
+ }
+
+ # This should raise an exception because the mapping references a non-existent DTB
+ with self.assertRaises(BBHandledException):
+ self._test_fitimage_py(bb_vars_overrides)
+
+ def test_fitimage_py_conf_extra_mappings_unused_error(self):
+ """Test that unused dtb-extra-conf mappings cause a fatal error"""
+ bb_vars_overrides = {
+ 'KERNEL_DEVICETREE': "am335x-bonegreen.dtb",
+ 'FIT_CONF_MAPPINGS': "dtb-extra-conf:nonexistent.dtb:extra-conf",
+ }
+
+ # This should raise an exception because the extra-conf mapping references a non-existent DTB
+ with self.assertRaises(BBHandledException):
+ self._test_fitimage_py(bb_vars_overrides)
+
class UBootFitImageTests(FitImageTestCase):
"""Test cases for the uboot-sign bbclass"""
--
2.52.0
^ permalink raw reply related [flat|nested] 4+ messages in thread