Entry_blob_ext contains an implementation of SetAllowFakeBlob that is identical to the one in the base Entry class, remove it.

Signed-off-by: Jonas Karlman jonas@kwiboo.se --- tools/binman/etype/blob_ext.py | 8 -------- 1 file changed, 8 deletions(-)

diff --git a/tools/binman/etype/blob_ext.py b/tools/binman/etype/blob_ext.py index fba6271de2bb..d6b0ca17c3f3 100644 --- a/tools/binman/etype/blob_ext.py +++ b/tools/binman/etype/blob_ext.py @@ -26,11 +26,3 @@ class Entry_blob_ext(Entry_blob): def __init__(self, section, etype, node): Entry_blob.__init__(self, section, etype, node) self.external = True - - def SetAllowFakeBlob(self, allow_fake): - """Set whether the entry allows to create a fake blob - - Args: - allow_fake_blob: True if allowed, False if not allowed - """ - self.allow_fake = allow_fake

The mkimage entry is working like a section entry but inherits from Entry not Entry_section. Copy implementations of missing Check-functions from Entry_section and adopt to Entry_mkimage.

Signed-off-by: Jonas Karlman jonas@kwiboo.se --- tools/binman/etype/mkimage.py | 44 ++++++++++++++++++++++++++++++++++- 1 file changed, 43 insertions(+), 1 deletion(-)

diff --git a/tools/binman/etype/mkimage.py b/tools/binman/etype/mkimage.py index cb264c3cad0b..49d3462a154c 100644 --- a/tools/binman/etype/mkimage.py +++ b/tools/binman/etype/mkimage.py @@ -206,16 +206,31 @@ class Entry_mkimage(Entry): self._imagename.SetAllowMissing(allow_missing)

def SetAllowFakeBlob(self, allow_fake): - """Set whether the sub nodes allows to create a fake blob + """Set whether a section allows to create a fake blob

Args: allow_fake: True if allowed, False if not allowed """ + super().SetAllowFakeBlob(allow_fake) for entry in self._mkimage_entries.values(): entry.SetAllowFakeBlob(allow_fake) if self._imagename: self._imagename.SetAllowFakeBlob(allow_fake)

+ def CheckMissing(self, missing_list): + """Check if any entries in this section have missing external blobs + + If there are missing (non-optional) blobs, the entries are added to the + list + + Args: + missing_list: List of Entry objects to be added to + """ + for entry in self._mkimage_entries.values(): + entry.CheckMissing(missing_list) + if self._imagename: + self._imagename.CheckMissing(missing_list) + def CheckFakedBlobs(self, faked_blobs_list): """Check if any entries in this section have faked external blobs

@@ -229,6 +244,33 @@ class Entry_mkimage(Entry): if self._imagename: self._imagename.CheckFakedBlobs(faked_blobs_list)

+ def CheckOptional(self, optional_list): + """Check the section for missing but optional external blobs + + If there are missing (optional) blobs, the entries are added to the list + + Args: + optional_list (list): List of Entry objects to be added to + """ + for entry in self._mkimage_entries.values(): + entry.CheckOptional(optional_list) + if self._imagename: + self._imagename.CheckOptional(optional_list) + + def check_missing_bintools(self, missing_list): + """Check if any entries in this section have missing bintools + + If there are missing bintools, these are added to the list + + Args: + missing_list: List of Bintool objects to be added to + """ + super().check_missing_bintools(missing_list) + for entry in self._mkimage_entries.values(): + entry.check_missing_bintools(missing_list) + if self._imagename: + self._imagename.check_missing_bintools(missing_list) + def AddBintools(self, btools): super().AddBintools(btools) self.mkimage = self.AddBintool(btools, 'mkimage')

Using the mkimage entry with the multiple-data-files prop and having a missing external blob result in an unexpected ValueError exception using the --allow-missing flag.

ValueError: Filename 'missing.bin' not found in input path (...)

Fix this by using _pathname that is resolved by ObtainContents for blob entries, ObtainContents also handles allow missing for external blobs.

Mark mkimage entry as missing and return without running mkimage when missing entries is reported by CheckMissing.

Signed-off-by: Jonas Karlman jonas@kwiboo.se --- tools/binman/etype/mkimage.py | 10 +++++++++- tools/binman/ftest.py | 9 +++++++++ .../test/278_mkimage_missing_multiple.dts | 19 +++++++++++++++++++ 3 files changed, 37 insertions(+), 1 deletion(-) create mode 100644 tools/binman/test/278_mkimage_missing_multiple.dts

diff --git a/tools/binman/etype/mkimage.py b/tools/binman/etype/mkimage.py index 49d3462a154c..2673a8607f37 100644 --- a/tools/binman/etype/mkimage.py +++ b/tools/binman/etype/mkimage.py @@ -156,7 +156,8 @@ class Entry_mkimage(Entry): for entry in self._mkimage_entries.values(): if not entry.ObtainContents(fake_size=fake_size): return False - fnames.append(tools.get_input_filename(entry.GetDefaultFilename())) + if entry._pathname: + fnames.append(entry._pathname) input_fname = ":".join(fnames) else: data, input_fname, uniq = self.collect_contents_to_file( @@ -171,6 +172,13 @@ class Entry_mkimage(Entry): outfile = self._filename if self._filename else 'mkimage-out.%s' % uniq output_fname = tools.get_output_filename(outfile)

+ missing_list = [] + self.CheckMissing(missing_list) + self.missing = bool(missing_list) + if self.missing: + self.SetContents(b'') + return self.allow_missing + args = ['-d', input_fname] if self._data_to_imagename: args += ['-n', input_fname] diff --git a/tools/binman/ftest.py b/tools/binman/ftest.py index 48ac1540bfd8..803b8c5accf4 100644 --- a/tools/binman/ftest.py +++ b/tools/binman/ftest.py @@ -6393,6 +6393,15 @@ fdt fdtmap Extract the devicetree blob from the fdtmap data = self._DoReadFile('277_rockchip_tpl.dts') self.assertEqual(ROCKCHIP_TPL_DATA, data[:len(ROCKCHIP_TPL_DATA)])

+ def testMkimageMissingBlobMultiple(self): + """Test using mkimage to build an image""" + with test_util.capture_sys_output() as (stdout, stderr): + self._DoTestFile('278_mkimage_missing_multiple.dts', allow_missing=True) + err = stderr.getvalue() + self.assertRegex( + err, + "Image '.*' is missing external blobs and is non-functional: .*") +

if __name__ == "__main__": unittest.main() diff --git a/tools/binman/test/278_mkimage_missing_multiple.dts b/tools/binman/test/278_mkimage_missing_multiple.dts new file mode 100644 index 000000000000..f84aea49ead9 --- /dev/null +++ b/tools/binman/test/278_mkimage_missing_multiple.dts @@ -0,0 +1,19 @@ +// SPDX-License-Identifier: GPL-2.0+ + +/dts-v1/; + +/ { + #address-cells = <1>; + #size-cells = <1>; + + binman { + mkimage { + args = "-n test -T script"; + multiple-data-files; + + blob-ext { + filename = "missing.bin"; + }; + }; + }; +};

Show the filename next to the node path in missing blob help messages, also show a generic missing blob message when there was no help message for the help tag.

Signed-off-by: Jonas Karlman jonas@kwiboo.se --- tools/binman/control.py | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-)

diff --git a/tools/binman/control.py b/tools/binman/control.py index b5ede60c1cde..a5ff1cb56245 100644 --- a/tools/binman/control.py +++ b/tools/binman/control.py @@ -105,8 +105,8 @@ def _ReadMissingBlobHelp(): _FinishTag(tag, msg, result) return result

-def _ShowBlobHelp(path, text): - tout.warning('%s:' % path) +def _ShowBlobHelp(path, text, fname): + tout.warning('%s (%s):' % (path, fname)) for line in text.splitlines(): tout.warning(' %s' % line) tout.warning('') @@ -126,10 +126,17 @@ def _ShowHelpForMissingBlobs(missing_list): tags = entry.GetHelpTags()

# Show the first match help message + shown_help = False for tag in tags: if tag in missing_blob_help: - _ShowBlobHelp(entry._node.path, missing_blob_help[tag]) + _ShowBlobHelp(entry._node.path, missing_blob_help[tag], + entry.GetDefaultFilename()) + shown_help = True break + # Or a generic help message + if not shown_help: + _ShowBlobHelp(entry._node.path, "Missing blob", + entry.GetDefaultFilename())

def GetEntryModules(include_testing=True): """Get a set of entry class implementations

There is no blank line between last missing blob help message and the header line for optional blob help messages.

Image 'simple-bin' is missing external blobs and is non-functional: atf-bl31

/binman/simple-bin/fit/images/@atf-SEQ/atf-bl31: See the documentation for your board. You may need to build ARM Trusted Firmware and build with BL31=/path/to/bl31.bin Image 'simple-bin' is missing external blobs but is still functional: tee-os

/binman/simple-bin/fit/images/@tee-SEQ/tee-os: See the documentation for your board. You may need to build Open Portable Trusted Execution Environment (OP-TEE) with TEE=/path/to/tee.bin

Some images are invalid

With this a blank line is inserted to make the text more readable.

Signed-off-by: Jonas Karlman jonas@kwiboo.se --- tools/binman/control.py | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-)

diff --git a/tools/binman/control.py b/tools/binman/control.py index e64740094f60..b5ede60c1cde 100644 --- a/tools/binman/control.py +++ b/tools/binman/control.py @@ -106,9 +106,10 @@ def _ReadMissingBlobHelp(): return result

def _ShowBlobHelp(path, text): - tout.warning('\n%s:' % path) + tout.warning('%s:' % path) for line in text.splitlines(): tout.warning(' %s' % line) + tout.warning('')

def _ShowHelpForMissingBlobs(missing_list): """Show help for each missing blob to help the user take action @@ -598,7 +599,7 @@ def ProcessImage(image, update_fdt, write_map, get_contents=True, missing_list = [] image.CheckMissing(missing_list) if missing_list: - tout.warning("Image '%s' is missing external blobs and is non-functional: %s" % + tout.warning("Image '%s' is missing external blobs and is non-functional: %s\n" % (image.name, ' '.join([e.name for e in missing_list]))) _ShowHelpForMissingBlobs(missing_list)

@@ -606,7 +607,7 @@ def ProcessImage(image, update_fdt, write_map, get_contents=True, image.CheckFakedBlobs(faked_list) if faked_list: tout.warning( - "Image '%s' has faked external blobs and is non-functional: %s" % + "Image '%s' has faked external blobs and is non-functional: %s\n" % (image.name, ' '.join([os.path.basename(e.GetDefaultFilename()) for e in faked_list])))

@@ -614,7 +615,7 @@ def ProcessImage(image, update_fdt, write_map, get_contents=True, image.CheckOptional(optional_list) if optional_list: tout.warning( - "Image '%s' is missing external blobs but is still functional: %s" % + "Image '%s' is missing external blobs but is still functional: %s\n" % (image.name, ' '.join([e.name for e in optional_list]))) _ShowHelpForMissingBlobs(optional_list)

@@ -622,7 +623,7 @@ def ProcessImage(image, update_fdt, write_map, get_contents=True, image.check_missing_bintools(missing_bintool_list) if missing_bintool_list: tout.warning( - "Image '%s' has missing bintools and is non-functional: %s" % + "Image '%s' has missing bintools and is non-functional: %s\n" % (image.name, ' '.join([os.path.basename(bintool.name) for bintool in missing_bintool_list]))) return any([missing_list, faked_list, missing_bintool_list]) @@ -756,7 +757,7 @@ def Binman(args): # This can only be True if -M is provided, since otherwise binman # would have raised an error already if invalid: - msg = '\nSome images are invalid' + msg = 'Some images are invalid' if args.ignore_missing: tout.warning(msg) else:

When binman is invoked during a build of U-Boot and an external blob is missing, the user is usually presented with a generic file not found in input path message.

Invoke binman with --allow-missing so that binman can show relevant missing blob help messages. Build continue to fail with missing blobs unless BINMAN_ALLOW_MISSING=1 is used.

This changes the following error message:

binman: Filename 'atf-bl31' not found in input path (...)

to the following:

Image 'itb' is missing external blobs and is non-functional: atf-blob

/binman/itb/fit/images/atf/atf-blob (bl31.bin): See the documentation for your board. You may need to build ARM Trusted Firmware and build with BL31=/path/to/bl31.bin

Signed-off-by: Jonas Karlman jonas@kwiboo.se --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Makefile b/Makefile index 58f8c7a35335..c2860824f6f2 100644 --- a/Makefile +++ b/Makefile @@ -1326,7 +1326,7 @@ cmd_binman = $(srctree)/tools/binman/binman $(if $(BINMAN_DEBUG),-D) \ --toolpath $(objtree)/tools \ $(if $(BINMAN_VERBOSE),-v$(BINMAN_VERBOSE)) \ build -u -d u-boot.dtb -O . -m \ - $(if $(BINMAN_ALLOW_MISSING),--allow-missing --ignore-missing) \ + --allow-missing $(if $(BINMAN_ALLOW_MISSING),--ignore-missing) \ -I . -I $(srctree) -I $(srctree)/board/$(BOARDDIR) \ -I arch/$(ARCH)/dts -a of-list=$(CONFIG_OF_LIST) \ $(foreach f,$(BINMAN_INDIRS),-I $(f)) \