Mirrors/u-boot
2
0
Fork 0
mirror of https://github.com/AsahiLinux/u-boot synced 2025-03-16 23:07:00 +00:00
Code Issues Projects Releases Packages Wiki Activity

binman: Improve mkimage documentation

Browse source 
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>
This commit is contained in:
Simon Glass 2022-08-13 11:40:47 -06:00
parent 73593e499c
commit e9b5e31a12
2 changed files with 45 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
tools/binman/entries.rst
View file

@ -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::

31
tools/binman/etype/mkimage.py
View file

@ -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::