aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimon Glass2022-08-13 11:40:47 -0600
committerSimon Glass2022-08-20 18:07:32 -0600
commite9b5e31a12b9a459ca4c35161851674aba84f9af (patch)
tree0e078b808e2b47ba3ecfbc7d51e45cb402f6e3fb
parent73593e499cf33d22e04498d684a5aef29cea2a1e (diff)
binman: Improve mkimage documentation
Expand this a little to make things clearer. Also drop the invalid entry arg. Series-changes 2 - Make it clear that -d data is concatenated/collected by binman - Fix mulitple typoe - Reword a sentence for grammar Signed-off-by: Simon Glass <sjg@chromium.org>
-rw-r--r--tools/binman/entries.rst28
-rw-r--r--tools/binman/etype/mkimage.py31
2 files changed, 45 insertions, 14 deletions
diff --git a/tools/binman/entries.rst b/tools/binman/entries.rst
index 283751e393e..fc15c45d29e 100644
--- a/tools/binman/entries.rst
+++ b/tools/binman/entries.rst
@@ -1166,11 +1166,10 @@ Entry: mkimage: Binary produced by mkimage
------------------------------------------
Properties / Entry arguments:
- - datafile: Filename for -d argument
- - args: Other arguments to pass
+ - args: Arguments to pass
-The data passed to mkimage is collected from subnodes of the mkimage node,
-e.g.::
+The data passed to mkimage via the -d flag is collected from subnodes of the
+mkimage node, e.g.::
mkimage {
args = "-n test -T imximage";
@@ -1179,9 +1178,24 @@ e.g.::
};
};
-This calls mkimage to create an imximage with u-boot-spl.bin as the input
-file. The output from mkimage then becomes part of the image produced by
-binman.
+This calls mkimage to create an imximage with `u-boot-spl.bin` as the data
+file, which mkimage being called like this::
+
+ mkimage -d <data_file> -n test -T imximage <output_file>
+
+The output from mkimage then becomes part of the image produced by
+binman. If you need to put mulitple things in the data file, you can use
+a section, or just multiple subnodes like this::
+
+ mkimage {
+ args = "-n test -T imximage";
+
+ u-boot-spl {
+ };
+
+ u-boot-tpl {
+ };
+ };
To use CONFIG options in the arguments, use a string list instead, as in
this example which also produces four arguments::
diff --git a/tools/binman/etype/mkimage.py b/tools/binman/etype/mkimage.py
index f3b3df6fe04..a5d94da6a91 100644
--- a/tools/binman/etype/mkimage.py
+++ b/tools/binman/etype/mkimage.py
@@ -15,11 +15,10 @@ class Entry_mkimage(Entry):
"""Binary produced by mkimage
Properties / Entry arguments:
- - datafile: Filename for -d argument
- - args: Other arguments to pass
+ - args: Arguments to pass
- The data passed to mkimage is collected from subnodes of the mkimage node,
- e.g.::
+ The data passed to mkimage via the -d flag is collected from subnodes of the
+ mkimage node, e.g.::
mkimage {
args = "-n test -T imximage";
@@ -28,9 +27,27 @@ class Entry_mkimage(Entry):
};
};
- This calls mkimage to create an imximage with u-boot-spl.bin as the input
- file. The output from mkimage then becomes part of the image produced by
- binman.
+ This calls mkimage to create an imximage with `u-boot-spl.bin` as the data
+ file, with mkimage being called like this::
+
+ mkimage -d <data_file> -n test -T imximage <output_file>
+
+ The output from mkimage then becomes part of the image produced by
+ binman. If you need to put multiple things in the data file, you can use
+ a section, or just multiple subnodes like this::
+
+ mkimage {
+ args = "-n test -T imximage";
+
+ u-boot-spl {
+ };
+
+ u-boot-tpl {
+ };
+ };
+
+ Note that binman places the contents (here SPL and TPL) into a single file
+ and passes that to mkimage using the -d option.
To use CONFIG options in the arguments, use a string list instead, as in
this example which also produces four arguments::