From 86e54468ec67bee213b855bfce34aba346c1d20e Mon Sep 17 00:00:00 2001 From: Simon Glass Date: Thu, 18 Aug 2022 02:16:46 -0600 Subject: [PATCH] binman: Document how to handle dependent images Binman does not support this properly at present. Add documentation about it including a work-around. Signed-off-by: Simon Glass --- tools/binman/binman.rst | 50 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) diff --git a/tools/binman/binman.rst b/tools/binman/binman.rst index 338b5500e8..4ee6f41f35 100644 --- a/tools/binman/binman.rst +++ b/tools/binman/binman.rst @@ -858,6 +858,55 @@ allow-repack: image description to be stored in the FDT and fdtmap. +Image dependencies +------------------ + +Binman does not currently support images that depend on each other. For example, +if one image creates `fred.bin` and then the next uses this `fred.bin` to +produce a final `image.bin`, then the behaviour is undefined. It may work, or it +may produce an error about `fred.bin` being missing, or it may use a version of +`fred.bin` from a previous run. + +Often this can be handled by incorporating the dependency into the second +image. For example, instead of:: + + binman { + multiple-images; + + fred { + u-boot { + }; + fill { + size = <0x100>; + }; + }; + + image { + blob { + filename = "fred.bin"; + }; + u-boot-spl { + }; + }; + +you can do this:: + + binman { + image { + fred { + type = "section"; + u-boot { + }; + fill { + size = <0x100>; + }; + }; + u-boot-spl { + }; + }; + + + Hashing Entries --------------- @@ -1688,6 +1737,7 @@ Some ideas: - Figure out how to make Fdt support changing the node order, so that Node.AddSubnode() can support adding a node before another, existing node. Perhaps it should completely regenerate the flat tree? +- Support images which depend on each other -- Simon Glass -- 2.39.5