Difuse/u-boot
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
u-boot/doc/mkimage.1

364 lines
9.5 KiB
Groff
Raw Normal View History

tools: mkimage/dumpimage: Allow to use -l with -T Currently -l option for mkimage and dumpimage ignores option -T and always tries to autodetect image type. With this change it is possible to tell mkimage and dumpimage to parse image file as specific type (and not random autodetected type). This allows to use mkimage -l or dumpimage -l as tool for validating image. params.type for -l option is now by default initialized to zero (IH_TYPE_INVALID) instead of IH_TYPE_KERNEL. imagetool_get_type() for IH_TYPE_INVALID returns NULL, which is assigned to tparams. mkimage and dumpimage code is extended to handle tparams with NULL for -l option. And imagetool_verify_print_header() is extended to do validation via tparams if is not NULL. Signed-off-by: Pali Rohár <pali@kernel.org> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-02-13 00:09:46 +00:00
.TH MKIMAGE 1 "2022-02-07"
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
Add mkimage manpage Some Linux distributions include the "mkimage" as a package. This commit provides a manual page for mkimage. Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org> Added documentation for FIT images and examples. Moved to doc/ directory. Signed-off-by: Wolfgang Denk <wd@denx.de>
2010-06-16 01:38:24 +00:00
.SH NAME
mkimage \- Generate image for U-Boot
.SH SYNOPSIS
doc: mkimage: Use standard style for synopsis The synopsis section is a bit messy. As an example, "uimage file name" is printed in italics, bold, and roman (depending on the line). This cleans things up and converts the synopsis section to use standard style. The .SY/.YS macros set up appropriate formatting for command synopsis sections (such as disabling hyphenation and setting a hanging indent). All parts of the synopsis now use the following style: - Bold for parts of the command which should be typed in by the user (such as the program name and flags) - Italic for parts which should be replaced (such as uimage-file-name) - Roman for parts which should not be typed at all (such as brackets) Multi-word variables now use hyphens to connect their words instead of spaces. This makes it clearer that all the words are part of the same variable. Additionally, "option ..." is used to denote where other options may be specified, as this appears to be standard style. In addition to the above style changes, this also makes some changes to content. The use of the term "legacy" has been removed, since this simply refers to any non-FIT image type. Additionally, wording like "uimage file name" has been replaced with "image-file-name" to better reflect that images may or may not be uImages. Lastly, the "auto" value for -f is documented in the synopsis. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:08 +00:00
.SY mkimage
.OP \-T type
.BI \-l\~ image-file-name
.YS
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
doc: mkimage: Use standard style for synopsis The synopsis section is a bit messy. As an example, "uimage file name" is printed in italics, bold, and roman (depending on the line). This cleans things up and converts the synopsis section to use standard style. The .SY/.YS macros set up appropriate formatting for command synopsis sections (such as disabling hyphenation and setting a hanging indent). All parts of the synopsis now use the following style: - Bold for parts of the command which should be typed in by the user (such as the program name and flags) - Italic for parts which should be replaced (such as uimage-file-name) - Roman for parts which should not be typed at all (such as brackets) Multi-word variables now use hyphens to connect their words instead of spaces. This makes it clearer that all the words are part of the same variable. Additionally, "option ..." is used to denote where other options may be specified, as this appears to be standard style. In addition to the above style changes, this also makes some changes to content. The use of the term "legacy" has been removed, since this simply refers to any non-FIT image type. Additionally, wording like "uimage file name" has been replaced with "image-file-name" to better reflect that images may or may not be uImages. Lastly, the "auto" value for -f is documented in the synopsis. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:08 +00:00
.SY mkimage
.RI [ option\~ .\|.\|.\&]
.OP \-T type
.I image-file-name
.YS
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
doc: mkimage: Use standard style for synopsis The synopsis section is a bit messy. As an example, "uimage file name" is printed in italics, bold, and roman (depending on the line). This cleans things up and converts the synopsis section to use standard style. The .SY/.YS macros set up appropriate formatting for command synopsis sections (such as disabling hyphenation and setting a hanging indent). All parts of the synopsis now use the following style: - Bold for parts of the command which should be typed in by the user (such as the program name and flags) - Italic for parts which should be replaced (such as uimage-file-name) - Roman for parts which should not be typed at all (such as brackets) Multi-word variables now use hyphens to connect their words instead of spaces. This makes it clearer that all the words are part of the same variable. Additionally, "option ..." is used to denote where other options may be specified, as this appears to be standard style. In addition to the above style changes, this also makes some changes to content. The use of the term "legacy" has been removed, since this simply refers to any non-FIT image type. Additionally, wording like "uimage file name" has been replaced with "image-file-name" to better reflect that images may or may not be uImages. Lastly, the "auto" value for -f is documented in the synopsis. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:08 +00:00
.SY mkimage
.RI [ option\~ .\|.\|.\&]
.BI \-f\~ image-tree-source-file\c
.RB | auto
.I image-file-name
.YS
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
doc: mkimage: Use standard style for synopsis The synopsis section is a bit messy. As an example, "uimage file name" is printed in italics, bold, and roman (depending on the line). This cleans things up and converts the synopsis section to use standard style. The .SY/.YS macros set up appropriate formatting for command synopsis sections (such as disabling hyphenation and setting a hanging indent). All parts of the synopsis now use the following style: - Bold for parts of the command which should be typed in by the user (such as the program name and flags) - Italic for parts which should be replaced (such as uimage-file-name) - Roman for parts which should not be typed at all (such as brackets) Multi-word variables now use hyphens to connect their words instead of spaces. This makes it clearer that all the words are part of the same variable. Additionally, "option ..." is used to denote where other options may be specified, as this appears to be standard style. In addition to the above style changes, this also makes some changes to content. The use of the term "legacy" has been removed, since this simply refers to any non-FIT image type. Additionally, wording like "uimage file name" has been replaced with "image-file-name" to better reflect that images may or may not be uImages. Lastly, the "auto" value for -f is documented in the synopsis. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:08 +00:00
.SY mkimage
.RI [ option\~ .\|.\|.\&]
.BI \-F\~ image-file-name
.YS
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
doc: mkimage: Regularize option documentation Square brackets are commonly used to denote optional parts of a command. However, all option arguments are mandatory. Remove these brackets. This also removes some unnecessary quotation marks, and uses hyphens to connect words in option arguments. This is intended to just clean up the formatting, leaving content corrections to later patches. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:11 +00:00
.SH DESCRIPTION
Add mkimage manpage Some Linux distributions include the "mkimage" as a package. This commit provides a manual page for mkimage. Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org> Added documentation for FIT images and examples. Moved to doc/ directory. Signed-off-by: Wolfgang Denk <wd@denx.de>
2010-06-16 01:38:24 +00:00
The
.B mkimage
command is used to create images for use with the U-Boot boot loader.
doc/mkimage.1: Fix some typos Signed-off-by: Horst Kronstorfer <hkronsto@frequentis.com> Acked-by: Mike Frysinger <vapier@gentoo.org>
2011-12-21 04:31:23 +00:00
These images can contain the linux kernel, device tree blob, root file
Add mkimage manpage Some Linux distributions include the "mkimage" as a package. This commit provides a manual page for mkimage. Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org> Added documentation for FIT images and examples. Moved to doc/ directory. Signed-off-by: Wolfgang Denk <wd@denx.de>
2010-06-16 01:38:24 +00:00
system image, firmware images etc., either separate or combined.
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.P
Add mkimage manpage Some Linux distributions include the "mkimage" as a package. This commit provides a manual page for mkimage. Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org> Added documentation for FIT images and examples. Moved to doc/ directory. Signed-off-by: Wolfgang Denk <wd@denx.de>
2010-06-16 01:38:24 +00:00
.B mkimage
supports two different formats:
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.P
doc/mkimage.1: Fix some typos Signed-off-by: Horst Kronstorfer <hkronsto@frequentis.com> Acked-by: Mike Frysinger <vapier@gentoo.org>
2011-12-21 04:31:23 +00:00
The old
Add mkimage manpage Some Linux distributions include the "mkimage" as a package. This commit provides a manual page for mkimage. Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org> Added documentation for FIT images and examples. Moved to doc/ directory. Signed-off-by: Wolfgang Denk <wd@denx.de>
2010-06-16 01:38:24 +00:00
.I legacy image
format concatenates the individual parts (for example, kernel image,
device tree blob and ramdisk image) and adds a 64 bytes header
containing information about target architecture, operating system,
image type, compression method, entry points, time stamp, checksums,
etc.
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.P
doc/mkimage.1: Fix some typos Signed-off-by: Horst Kronstorfer <hkronsto@frequentis.com> Acked-by: Mike Frysinger <vapier@gentoo.org>
2011-12-21 04:31:23 +00:00
The new
Add mkimage manpage Some Linux distributions include the "mkimage" as a package. This commit provides a manual page for mkimage. Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org> Added documentation for FIT images and examples. Moved to doc/ directory. Signed-off-by: Wolfgang Denk <wd@denx.de>
2010-06-16 01:38:24 +00:00
.I FIT (Flattened Image Tree) format
doc/mkimage.1: Fix some typos Signed-off-by: Horst Kronstorfer <hkronsto@frequentis.com> Acked-by: Mike Frysinger <vapier@gentoo.org>
2011-12-21 04:31:23 +00:00
allows for more flexibility in handling images of various types and also
mkimage: Add -k option to specify key directory Keys required for signing images will be in a specific directory. Add a -k option to specify that directory. Also update the mkimage man page with this information and a clearer list of available commands. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Marek Vasut <marex@denx.de> (v1)
2013-06-13 22:10:03 +00:00
enhances integrity protection of images with stronger checksums. It also
supports verified boot.
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
doc: mkimage: Regularize option documentation Square brackets are commonly used to denote optional parts of a command. However, all option arguments are mandatory. Remove these brackets. This also removes some unnecessary quotation marks, and uses hyphens to connect words in option arguments. This is intended to just clean up the formatting, leaving content corrections to later patches. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:11 +00:00
.SH OPTIONS
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
doc: mkimage: Use subsection macro The options are divided up into several subsections. Use the appropriate macro. While we're at it, rename the headings to better reflect the contents of their sections. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:12 +00:00
.SS General options
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
Add mkimage manpage Some Linux distributions include the "mkimage" as a package. This commit provides a manual page for mkimage. Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org> Added documentation for FIT images and examples. Moved to doc/ directory. Signed-off-by: Wolfgang Denk <wd@denx.de>
2010-06-16 01:38:24 +00:00
.TP
doc: mkimage: Rearrange/remove some options This moves some options which work in any mode to the general options section. -p is moved to after -E/-B since those options are related. This also adds documentation for -h and -V. The -F, -l, and -G options are documented twice. Remove the second documentation in each case. The synopsis for -l also suggests an implied second uimage-file-name parameter. E.g. mkimage [-l uimage-file-name] uimage-file-name This is misleading, so remove it. Wrap a few lines to 80 characters as well. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:13 +00:00
.B \-h
Print a help message and exit.
.
.TP
.B \-l
mkimage lists the information contained in the header of an existing U-Boot
image.
.
.TP
.B \-s
Don't copy in the image data. Depending on the image type, this may create
just the header, everything but the image data, or nothing at all.
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
tools: mkimage/dumpimage: Allow to use -l with -T Currently -l option for mkimage and dumpimage ignores option -T and always tries to autodetect image type. With this change it is possible to tell mkimage and dumpimage to parse image file as specific type (and not random autodetected type). This allows to use mkimage -l or dumpimage -l as tool for validating image. params.type for -l option is now by default initialized to zero (IH_TYPE_INVALID) instead of IH_TYPE_KERNEL. imagetool_get_type() for IH_TYPE_INVALID returns NULL, which is assigned to tparams. mkimage and dumpimage code is extended to handle tparams with NULL for -l option. And imagetool_verify_print_header() is extended to do validation via tparams if is not NULL. Signed-off-by: Pali Rohár <pali@kernel.org> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-02-13 00:09:46 +00:00
.TP
doc: mkimage: Regularize option documentation Square brackets are commonly used to denote optional parts of a command. However, all option arguments are mandatory. Remove these brackets. This also removes some unnecessary quotation marks, and uses hyphens to connect words in option arguments. This is intended to just clean up the formatting, leaving content corrections to later patches. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:11 +00:00
.BI \-T " image-type"
tools: mkimage/dumpimage: Allow to use -l with -T Currently -l option for mkimage and dumpimage ignores option -T and always tries to autodetect image type. With this change it is possible to tell mkimage and dumpimage to parse image file as specific type (and not random autodetected type). This allows to use mkimage -l or dumpimage -l as tool for validating image. params.type for -l option is now by default initialized to zero (IH_TYPE_INVALID) instead of IH_TYPE_KERNEL. imagetool_get_type() for IH_TYPE_INVALID returns NULL, which is assigned to tparams. mkimage and dumpimage code is extended to handle tparams with NULL for -l option. And imagetool_verify_print_header() is extended to do validation via tparams if is not NULL. Signed-off-by: Pali Rohár <pali@kernel.org> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-02-13 00:09:46 +00:00
Parse image file as type.
Pass \-h as the image to see the list of supported image type.
Without this option image type is autodetected.
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
mkimage: Document misc options Over the years, several options have not made it into the help message. Document them. Do the same for the man page. Signed-off-by: Sean Anderson <sean.anderson@seco.com>
2022-04-08 20:08:39 +00:00
.TP
doc: mkimage: Regularize option documentation Square brackets are commonly used to denote optional parts of a command. However, all option arguments are mandatory. Remove these brackets. This also removes some unnecessary quotation marks, and uses hyphens to connect words in option arguments. This is intended to just clean up the formatting, leaving content corrections to later patches. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:11 +00:00
.B \-q
doc: mkimage: Rearrange/remove some options This moves some options which work in any mode to the general options section. -p is moved to after -E/-B since those options are related. This also adds documentation for -h and -V. The -F, -l, and -G options are documented twice. Remove the second documentation in each case. The synopsis for -l also suggests an implied second uimage-file-name parameter. E.g. mkimage [-l uimage-file-name] uimage-file-name This is misleading, so remove it. Wrap a few lines to 80 characters as well. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:13 +00:00
Quiet. Don't print the image header.
.
.TP
.B \-v
Verbose. Print file names as they are added to the image.
.
.TP
.B \-V
Print version information and exit.
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
doc: mkimage: Use subsection macro The options are divided up into several subsections. Use the appropriate macro. While we're at it, rename the headings to better reflect the contents of their sections. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:12 +00:00
.SS General image-creation options
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
Add mkimage manpage Some Linux distributions include the "mkimage" as a package. This commit provides a manual page for mkimage. Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org> Added documentation for FIT images and examples. Moved to doc/ directory. Signed-off-by: Wolfgang Denk <wd@denx.de>
2010-06-16 01:38:24 +00:00
.TP
doc: mkimage: Regularize option documentation Square brackets are commonly used to denote optional parts of a command. However, all option arguments are mandatory. Remove these brackets. This also removes some unnecessary quotation marks, and uses hyphens to connect words in option arguments. This is intended to just clean up the formatting, leaving content corrections to later patches. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:11 +00:00
.BI \-A " architecture"
doc: mkimage: Rearrange/remove some options This moves some options which work in any mode to the general options section. -p is moved to after -E/-B since those options are related. This also adds documentation for -h and -V. The -F, -l, and -G options are documented twice. Remove the second documentation in each case. The synopsis for -l also suggests an implied second uimage-file-name parameter. E.g. mkimage [-l uimage-file-name] uimage-file-name This is misleading, so remove it. Wrap a few lines to 80 characters as well. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:13 +00:00
Set architecture. Pass \-h as the architecture to see the list of supported
architectures.
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
Add mkimage manpage Some Linux distributions include the "mkimage" as a package. This commit provides a manual page for mkimage. Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org> Added documentation for FIT images and examples. Moved to doc/ directory. Signed-off-by: Wolfgang Denk <wd@denx.de>
2010-06-16 01:38:24 +00:00
.TP
doc: mkimage: Regularize option documentation Square brackets are commonly used to denote optional parts of a command. However, all option arguments are mandatory. Remove these brackets. This also removes some unnecessary quotation marks, and uses hyphens to connect words in option arguments. This is intended to just clean up the formatting, leaving content corrections to later patches. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:11 +00:00
.BI \-O " os"
Add mkimage manpage Some Linux distributions include the "mkimage" as a package. This commit provides a manual page for mkimage. Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org> Added documentation for FIT images and examples. Moved to doc/ directory. Signed-off-by: Wolfgang Denk <wd@denx.de>
2010-06-16 01:38:24 +00:00
Set operating system. bootm command of u-boot changes boot method by os type.
Escape minus signs in manpage By default, "-" chars are interpreted as hyphens (U+2010) by groff, not as minus signs (U+002D). Since options to programs use minus signs (U+002D), this means for example in UTF-8 locales that you cannot cut and paste options, nor search for them easily. (Reported by lintian.) Signed-off-by: Loc Minier <loic.minier@linaro.org>
2011-01-04 01:32:36 +00:00
Pass \-h as the OS to see the list of supported OS.
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
Add mkimage manpage Some Linux distributions include the "mkimage" as a package. This commit provides a manual page for mkimage. Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org> Added documentation for FIT images and examples. Moved to doc/ directory. Signed-off-by: Wolfgang Denk <wd@denx.de>
2010-06-16 01:38:24 +00:00
.TP
doc: mkimage: Regularize option documentation Square brackets are commonly used to denote optional parts of a command. However, all option arguments are mandatory. Remove these brackets. This also removes some unnecessary quotation marks, and uses hyphens to connect words in option arguments. This is intended to just clean up the formatting, leaving content corrections to later patches. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:11 +00:00
.BI \-C " compression-type"
Add mkimage manpage Some Linux distributions include the "mkimage" as a package. This commit provides a manual page for mkimage. Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org> Added documentation for FIT images and examples. Moved to doc/ directory. Signed-off-by: Wolfgang Denk <wd@denx.de>
2010-06-16 01:38:24 +00:00
Set compression type.
Escape minus signs in manpage By default, "-" chars are interpreted as hyphens (U+2010) by groff, not as minus signs (U+002D). Since options to programs use minus signs (U+002D), this means for example in UTF-8 locales that you cannot cut and paste options, nor search for them easily. (Reported by lintian.) Signed-off-by: Loc Minier <loic.minier@linaro.org>
2011-01-04 01:32:36 +00:00
Pass \-h as the compression to see the list of supported compression type.
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
Add mkimage manpage Some Linux distributions include the "mkimage" as a package. This commit provides a manual page for mkimage. Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org> Added documentation for FIT images and examples. Moved to doc/ directory. Signed-off-by: Wolfgang Denk <wd@denx.de>
2010-06-16 01:38:24 +00:00
.TP
doc: mkimage: Regularize option documentation Square brackets are commonly used to denote optional parts of a command. However, all option arguments are mandatory. Remove these brackets. This also removes some unnecessary quotation marks, and uses hyphens to connect words in option arguments. This is intended to just clean up the formatting, leaving content corrections to later patches. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:11 +00:00
.BI \-a " load-address"
Add mkimage manpage Some Linux distributions include the "mkimage" as a package. This commit provides a manual page for mkimage. Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org> Added documentation for FIT images and examples. Moved to doc/ directory. Signed-off-by: Wolfgang Denk <wd@denx.de>
2010-06-16 01:38:24 +00:00
Set load address with a hex number.
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
Add mkimage manpage Some Linux distributions include the "mkimage" as a package. This commit provides a manual page for mkimage. Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org> Added documentation for FIT images and examples. Moved to doc/ directory. Signed-off-by: Wolfgang Denk <wd@denx.de>
2010-06-16 01:38:24 +00:00
.TP
doc: mkimage: Regularize option documentation Square brackets are commonly used to denote optional parts of a command. However, all option arguments are mandatory. Remove these brackets. This also removes some unnecessary quotation marks, and uses hyphens to connect words in option arguments. This is intended to just clean up the formatting, leaving content corrections to later patches. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:11 +00:00
.BI \-e " entry-point"
Add mkimage manpage Some Linux distributions include the "mkimage" as a package. This commit provides a manual page for mkimage. Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org> Added documentation for FIT images and examples. Moved to doc/ directory. Signed-off-by: Wolfgang Denk <wd@denx.de>
2010-06-16 01:38:24 +00:00
Set entry point with a hex number.
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
mkimage: Add -k option to specify key directory Keys required for signing images will be in a specific directory. Add a -k option to specify that directory. Also update the mkimage man page with this information and a clearer list of available commands. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Marek Vasut <marex@denx.de> (v1)
2013-06-13 22:10:03 +00:00
.TP
doc: mkimage: Regularize option documentation Square brackets are commonly used to denote optional parts of a command. However, all option arguments are mandatory. Remove these brackets. This also removes some unnecessary quotation marks, and uses hyphens to connect words in option arguments. This is intended to just clean up the formatting, leaving content corrections to later patches. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:11 +00:00
.BI \-n " image-name"
Add mkimage manpage Some Linux distributions include the "mkimage" as a package. This commit provides a manual page for mkimage. Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org> Added documentation for FIT images and examples. Moved to doc/ directory. Signed-off-by: Wolfgang Denk <wd@denx.de>
2010-06-16 01:38:24 +00:00
Set image name to 'image name'.
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
mkimage: Document misc options Over the years, several options have not made it into the help message. Document them. Do the same for the man page. Signed-off-by: Sean Anderson <sean.anderson@seco.com>
2022-04-08 20:08:39 +00:00
.TP
doc: mkimage: Regularize option documentation Square brackets are commonly used to denote optional parts of a command. However, all option arguments are mandatory. Remove these brackets. This also removes some unnecessary quotation marks, and uses hyphens to connect words in option arguments. This is intended to just clean up the formatting, leaving content corrections to later patches. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:11 +00:00
.BI \-R " secondary-image-name"
mkimage: Document misc options Over the years, several options have not made it into the help message. Document them. Do the same for the man page. Signed-off-by: Sean Anderson <sean.anderson@seco.com>
2022-04-08 20:08:39 +00:00
Some image types support a second image for additional data. For these types,
use \-R to specify this second image.
mkimage: Document more misc options Document -G and the secondary image types which can be used with -R. Also reword the documentation of -s for clarity. Signed-off-by: Sean Anderson <sean.anderson@seco.com>
2022-05-16 20:11:07 +00:00
.TS
allbox;
lb lbx
l l.
Image Type Secondary Image Description
pblimage Additional RCW-style header, typically used for PBI commands.
zynqimage, zynqmpimage T{
Initialization parameters, one per line. Each parameter has the form
.sp
.ti 4
.I address data
.sp
where
.I address
and
.I data
are hexadecimal integers. The boot ROM will write each
.I data
to
.I address
when loading the image. At most 256 parameters may be specified in this
manner.
T}
.TE
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
Add mkimage manpage Some Linux distributions include the "mkimage" as a package. This commit provides a manual page for mkimage. Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org> Added documentation for FIT images and examples. Moved to doc/ directory. Signed-off-by: Wolfgang Denk <wd@denx.de>
2010-06-16 01:38:24 +00:00
.TP
doc: mkimage: Regularize option documentation Square brackets are commonly used to denote optional parts of a command. However, all option arguments are mandatory. Remove these brackets. This also removes some unnecessary quotation marks, and uses hyphens to connect words in option arguments. This is intended to just clean up the formatting, leaving content corrections to later patches. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:11 +00:00
.BI \-d " image-data-file"
Add mkimage manpage Some Linux distributions include the "mkimage" as a package. This commit provides a manual page for mkimage. Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org> Added documentation for FIT images and examples. Moved to doc/ directory. Signed-off-by: Wolfgang Denk <wd@denx.de>
2010-06-16 01:38:24 +00:00
Use image data from 'image data file'.
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
Add mkimage manpage Some Linux distributions include the "mkimage" as a package. This commit provides a manual page for mkimage. Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org> Added documentation for FIT images and examples. Moved to doc/ directory. Signed-off-by: Wolfgang Denk <wd@denx.de>
2010-06-16 01:38:24 +00:00
.TP
doc: mkimage: Regularize option documentation Square brackets are commonly used to denote optional parts of a command. However, all option arguments are mandatory. Remove these brackets. This also removes some unnecessary quotation marks, and uses hyphens to connect words in option arguments. This is intended to just clean up the formatting, leaving content corrections to later patches. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:11 +00:00
.B \-x
Add mkimage manpage Some Linux distributions include the "mkimage" as a package. This commit provides a manual page for mkimage. Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org> Added documentation for FIT images and examples. Moved to doc/ directory. Signed-off-by: Wolfgang Denk <wd@denx.de>
2010-06-16 01:38:24 +00:00
Set XIP (execute in place) flag.
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
doc: mkimage: Use subsection macro The options are divided up into several subsections. Use the appropriate macro. While we're at it, rename the headings to better reflect the contents of their sections. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:12 +00:00
.SS Options for creating FIT images
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
mkimage: Support adding device tree files to a FIT To make the auto-FIT feature useful we need to be able to provide a list of device tree files on the command line for mkimage to add into the FIT. Add support for this feature. So far there is no support for hashing or verified boot using this method. For those cases, a .its file must still be provided. Signed-off-by: Simon Glass <sjg@chromium.org>
2016-02-23 05:55:52 +00:00
.TP
doc: mkimage: Regularize option documentation Square brackets are commonly used to denote optional parts of a command. However, all option arguments are mandatory. Remove these brackets. This also removes some unnecessary quotation marks, and uses hyphens to connect words in option arguments. This is intended to just clean up the formatting, leaving content corrections to later patches. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:11 +00:00
.BI \-b " device-tree-file"
mkimage: fix argument parsing on BSD systems The getopt(3) optstring '-' is a GNU extension which is not available on BSD systems like OS X. Remove this dependency by implementing argument parsing in another way. This will also change the lately introduced '-b' switch behaviour. Signed-off-by: Andreas Bießmann <andreas.devel@googlemail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2016-05-01 01:01:27 +00:00
Appends the device tree binary file (.dtb) to the FIT.
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
mkimage: Add -c option to specify a comment for key signing When signing an image, it is useful to add some details about which tool or person is authorising the signing. Add a comment field which can take care of miscellaneous requirements. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Marek Vasut <marex@denx.de>
2013-06-13 22:10:06 +00:00
.TP
doc: mkimage: Regularize option documentation Square brackets are commonly used to denote optional parts of a command. However, all option arguments are mandatory. Remove these brackets. This also removes some unnecessary quotation marks, and uses hyphens to connect words in option arguments. This is intended to just clean up the formatting, leaving content corrections to later patches. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:11 +00:00
.BI \-c " comment"
mkimage: Add -c option to specify a comment for key signing When signing an image, it is useful to add some details about which tool or person is authorising the signing. Add a comment field which can take care of miscellaneous requirements. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Marek Vasut <marex@denx.de>
2013-06-13 22:10:06 +00:00
Specifies a comment to be added when signing. This is typically a useful
message which describes how the image was signed or some other useful
information.
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
Add mkimage manpage Some Linux distributions include the "mkimage" as a package. This commit provides a manual page for mkimage. Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org> Added documentation for FIT images and examples. Moved to doc/ directory. Signed-off-by: Wolfgang Denk <wd@denx.de>
2010-06-16 01:38:24 +00:00
.TP
doc: mkimage: Regularize option documentation Square brackets are commonly used to denote optional parts of a command. However, all option arguments are mandatory. Remove these brackets. This also removes some unnecessary quotation marks, and uses hyphens to connect words in option arguments. This is intended to just clean up the formatting, leaving content corrections to later patches. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:11 +00:00
.BI \-D " dtc-options"
Add mkimage manpage Some Linux distributions include the "mkimage" as a package. This commit provides a manual page for mkimage. Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org> Added documentation for FIT images and examples. Moved to doc/ directory. Signed-off-by: Wolfgang Denk <wd@denx.de>
2010-06-16 01:38:24 +00:00
Provide special options to the device tree compiler that is used to
create the image.
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
mkimage: Support placing data outside the FIT One limitation of FIT is that all the data is 'inline' within it, using a 'data' property in each image node. This means that to find out what is in the FIT it is necessary to scan the entire file. Once loaded it can be scanned and then the images can be copied to the correct place in memory. In SPL it can take a significant amount of time to copy images around in memory. Also loading data that does not end up being used is wasteful. It would be useful if the FIT were small, acting as a directory, with the actual data stored elsewhere. This allows SPL to load the entire FIT, without the images, then load the images it wants later. Add a -E option to mkimage to request that it output an 'external' FIT. Signed-off-by: Simon Glass <sjg@chromium.org>
2016-02-23 05:55:53 +00:00
.TP
doc: mkimage: Regularize option documentation Square brackets are commonly used to denote optional parts of a command. However, all option arguments are mandatory. Remove these brackets. This also removes some unnecessary quotation marks, and uses hyphens to connect words in option arguments. This is intended to just clean up the formatting, leaving content corrections to later patches. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:11 +00:00
.BI \-E
mkimage: Support placing data outside the FIT One limitation of FIT is that all the data is 'inline' within it, using a 'data' property in each image node. This means that to find out what is in the FIT it is necessary to scan the entire file. Once loaded it can be scanned and then the images can be copied to the correct place in memory. In SPL it can take a significant amount of time to copy images around in memory. Also loading data that does not end up being used is wasteful. It would be useful if the FIT were small, acting as a directory, with the actual data stored elsewhere. This allows SPL to load the entire FIT, without the images, then load the images it wants later. Add a -E option to mkimage to request that it output an 'external' FIT. Signed-off-by: Simon Glass <sjg@chromium.org>
2016-02-23 05:55:53 +00:00
After processing, move the image data outside the FIT and store a data offset
in the FIT. Images will be placed one after the other immediately after the
FIT, with each one aligned to a 4-byte boundary. The existing 'data' property
in each image will be replaced with 'data-offset' and 'data-size' properties.
A 'data-offset' of 0 indicates that it starts in the first (4-byte aligned)
byte after the FIT.
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
mkimage: Document misc options Over the years, several options have not made it into the help message. Document them. Do the same for the man page. Signed-off-by: Sean Anderson <sean.anderson@seco.com>
2022-04-08 20:08:39 +00:00
.TP
doc: mkimage: Regularize option documentation Square brackets are commonly used to denote optional parts of a command. However, all option arguments are mandatory. Remove these brackets. This also removes some unnecessary quotation marks, and uses hyphens to connect words in option arguments. This is intended to just clean up the formatting, leaving content corrections to later patches. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:11 +00:00
.BI \-B " alignment"
mkimage: Document misc options Over the years, several options have not made it into the help message. Document them. Do the same for the man page. Signed-off-by: Sean Anderson <sean.anderson@seco.com>
2022-04-08 20:08:39 +00:00
The alignment, in hexadecimal, that external data will be aligned to. This
option only has an effect when \-E is specified.
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
Add mkimage manpage Some Linux distributions include the "mkimage" as a package. This commit provides a manual page for mkimage. Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org> Added documentation for FIT images and examples. Moved to doc/ directory. Signed-off-by: Wolfgang Denk <wd@denx.de>
2010-06-16 01:38:24 +00:00
.TP
doc: mkimage: Rearrange/remove some options This moves some options which work in any mode to the general options section. -p is moved to after -E/-B since those options are related. This also adds documentation for -h and -V. The -F, -l, and -G options are documented twice. Remove the second documentation in each case. The synopsis for -l also suggests an implied second uimage-file-name parameter. E.g. mkimage [-l uimage-file-name] uimage-file-name This is misleading, so remove it. Wrap a few lines to 80 characters as well. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:13 +00:00
.BI \-p " external-position"
Place external data at a static external position. See \-E. Instead of writing
a 'data-offset' property defining the offset from the end of the FIT, \-p will
use 'data-position' as the absolute position from the base of the FIT.
.
.TP
doc: mkimage: Regularize option documentation Square brackets are commonly used to denote optional parts of a command. However, all option arguments are mandatory. Remove these brackets. This also removes some unnecessary quotation marks, and uses hyphens to connect words in option arguments. This is intended to just clean up the formatting, leaving content corrections to later patches. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:11 +00:00
.BI \-f " image-tree-source-file"
doc/mkimage.1: Fix some typos Signed-off-by: Horst Kronstorfer <hkronsto@frequentis.com> Acked-by: Mike Frysinger <vapier@gentoo.org>
2011-12-21 04:31:23 +00:00
Image tree source file that describes the structure and contents of the
Add mkimage manpage Some Linux distributions include the "mkimage" as a package. This commit provides a manual page for mkimage. Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org> Added documentation for FIT images and examples. Moved to doc/ directory. Signed-off-by: Wolfgang Denk <wd@denx.de>
2010-06-16 01:38:24 +00:00
FIT image.
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.IP
mkimage: Support automatic creating of a FIT without a .its At present, when generating a FIT, mkimage requires a .its file containing the structure of the FIT and referring to the images to be included. Creating the .its file is a separate step that makes it harder to use FIT. This is not required for creating legacy images. Often the FIT is pretty standard, consisting of an OS image, some device tree files and a single configuration. We can handle this case automatically and avoid needing a .its file at all. To start with, support automatically generate the FIT using a new '-f auto' option. Initially this only supports adding a single image (e.g. a linux kernel) and a single configuration. Signed-off-by: Simon Glass <sjg@chromium.org>
2016-02-23 05:55:51 +00:00
This can be automatically generated for some simple cases.
Use "-f auto" for this. In that case the arguments -d, -A, -O, -T, -C, -a
and -e are used to specify the image to include in the FIT and its attributes.
No .its file is required.
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
mkimage: Add -F option to modify an existing .fit file When signing images it is sometimes necessary to sign with different keys at different times, or make the signer entirely separate from the FIT creation to avoid needing the private keys to be publicly available in the system. Add a -F option so that key signing can be a separate step, and possibly done multiple times as different keys are avaiable. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Marek Vasut <marex@denx.de>
2013-06-13 22:10:05 +00:00
.TP
doc: mkimage: Regularize option documentation Square brackets are commonly used to denote optional parts of a command. However, all option arguments are mandatory. Remove these brackets. This also removes some unnecessary quotation marks, and uses hyphens to connect words in option arguments. This is intended to just clean up the formatting, leaving content corrections to later patches. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:11 +00:00
.B \-F
mkimage: Add -F option to modify an existing .fit file When signing images it is sometimes necessary to sign with different keys at different times, or make the signer entirely separate from the FIT creation to avoid needing the private keys to be publicly available in the system. Add a -F option so that key signing can be a separate step, and possibly done multiple times as different keys are avaiable. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Marek Vasut <marex@denx.de>
2013-06-13 22:10:05 +00:00
Indicates that an existing FIT image should be modified. No dtc
Fix cosmetic issues in mkimage manpage * Escape use of - in description of -F. * Fix line continuations in examples so that the continued lines are also bold. Signed-off-by: Vagrant Cascadian <vagrant@debian.org>
2014-11-02 01:09:01 +00:00
compilation is performed and the \-f flag should not be given.
mkimage: Add -F option to modify an existing .fit file When signing images it is sometimes necessary to sign with different keys at different times, or make the signer entirely separate from the FIT creation to avoid needing the private keys to be publicly available in the system. Add a -F option so that key signing can be a separate step, and possibly done multiple times as different keys are avaiable. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Marek Vasut <marex@denx.de>
2013-06-13 22:10:05 +00:00
This can be used to sign images with additional keys after initial image
creation.
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
mkimage: Allow including a ramdisk in FIT auto mode Adds -i option that allows specifying a ramdisk file to be added to the FIT image when we are using the automatic FIT mode (no ITS file). This makes adding Depthcharge support to LAVA much more convenient, as no additional configuration files need to be kept around in the machine that dispatches jobs to the boards. Signed-off-by: Tomeu Vizoso <tomeu.vizoso@collabora.com> Cc: Simon Glass <sjg@chromium.org> Cc: Matt Hart <matthew.hart@linaro.org> Cc: Neil Williams <codehelp@debian.org> Reviewed-by: Simon Glass <sjg@chromium.org>
2016-11-04 13:22:15 +00:00
.TP
doc: mkimage: Regularize option documentation Square brackets are commonly used to denote optional parts of a command. However, all option arguments are mandatory. Remove these brackets. This also removes some unnecessary quotation marks, and uses hyphens to connect words in option arguments. This is intended to just clean up the formatting, leaving content corrections to later patches. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:11 +00:00
.BI \-i " ramdisk-file"
mkimage: Allow including a ramdisk in FIT auto mode Adds -i option that allows specifying a ramdisk file to be added to the FIT image when we are using the automatic FIT mode (no ITS file). This makes adding Depthcharge support to LAVA much more convenient, as no additional configuration files need to be kept around in the machine that dispatches jobs to the boards. Signed-off-by: Tomeu Vizoso <tomeu.vizoso@collabora.com> Cc: Simon Glass <sjg@chromium.org> Cc: Matt Hart <matthew.hart@linaro.org> Cc: Neil Williams <codehelp@debian.org> Reviewed-by: Simon Glass <sjg@chromium.org>
2016-11-04 13:22:15 +00:00
Appends the ramdisk file to the FIT.
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
mkimage: Add -k option to specify key directory Keys required for signing images will be in a specific directory. Add a -k option to specify that directory. Also update the mkimage man page with this information and a clearer list of available commands. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Marek Vasut <marex@denx.de> (v1)
2013-06-13 22:10:03 +00:00
.TP
doc: mkimage: Regularize option documentation Square brackets are commonly used to denote optional parts of a command. However, all option arguments are mandatory. Remove these brackets. This also removes some unnecessary quotation marks, and uses hyphens to connect words in option arguments. This is intended to just clean up the formatting, leaving content corrections to later patches. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:11 +00:00
.BI \-k " key-directory"
mkimage: Add -k option to specify key directory Keys required for signing images will be in a specific directory. Add a -k option to specify that directory. Also update the mkimage man page with this information and a clearer list of available commands. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Marek Vasut <marex@denx.de> (v1)
2013-06-13 22:10:03 +00:00
Specifies the directory containing keys to use for signing. This directory
should contain a private key file <name>.key for use with signing and a
certificate <name>.crt (containing the public key) for use with verification.
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
mkimage: Document more misc options Document -G and the secondary image types which can be used with -R. Also reword the documentation of -s for clarity. Signed-off-by: Sean Anderson <sean.anderson@seco.com>
2022-05-16 20:11:07 +00:00
.TP
doc: mkimage: Regularize option documentation Square brackets are commonly used to denote optional parts of a command. However, all option arguments are mandatory. Remove these brackets. This also removes some unnecessary quotation marks, and uses hyphens to connect words in option arguments. This is intended to just clean up the formatting, leaving content corrections to later patches. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:11 +00:00
.BI \-G " key-file"
mkimage: Document more misc options Document -G and the secondary image types which can be used with -R. Also reword the documentation of -s for clarity. Signed-off-by: Sean Anderson <sean.anderson@seco.com>
2022-05-16 20:11:07 +00:00
Specifies the private key file to use when signing. This option may be used
instead of \-k.
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
mkimage: Add -K to write public keys to an FDT blob FIT image verification requires public keys. Add a convenient option to mkimage to write the public keys to an FDT blob when it uses then for signing an image. This allows us to use: mkimage -f test.its -K dest.dtb -k keys test.fit and have the signatures written to test.fit and the corresponding public keys written to dest.dtb. Then dest.dtb can be used as the control FDT for U-Boot (CONFIG_OF_CONTROL), thus providing U-Boot with access to the public keys it needs. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Marek Vasut <marex@denx.de>
2013-06-13 22:10:04 +00:00
.TP
doc: mkimage: Regularize option documentation Square brackets are commonly used to denote optional parts of a command. However, all option arguments are mandatory. Remove these brackets. This also removes some unnecessary quotation marks, and uses hyphens to connect words in option arguments. This is intended to just clean up the formatting, leaving content corrections to later patches. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:11 +00:00
.BI \-K " key-destination"
mkimage: Add -K to write public keys to an FDT blob FIT image verification requires public keys. Add a convenient option to mkimage to write the public keys to an FDT blob when it uses then for signing an image. This allows us to use: mkimage -f test.its -K dest.dtb -k keys test.fit and have the signatures written to test.fit and the corresponding public keys written to dest.dtb. Then dest.dtb can be used as the control FDT for U-Boot (CONFIG_OF_CONTROL), thus providing U-Boot with access to the public keys it needs. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Marek Vasut <marex@denx.de>
2013-06-13 22:10:04 +00:00
Specifies a compiled device tree binary file (typically .dtb) to write
public key information into. When a private key is used to sign an image,
the corresponding public key is written into this file for for run-time
verification. Typically the file here is the device tree binary used by
CONFIG_OF_CONTROL in U-Boot.
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
mkimage: Document misc options Over the years, several options have not made it into the help message. Document them. Do the same for the man page. Signed-off-by: Sean Anderson <sean.anderson@seco.com>
2022-04-08 20:08:39 +00:00
.TP
doc: mkimage: Regularize option documentation Square brackets are commonly used to denote optional parts of a command. However, all option arguments are mandatory. Remove these brackets. This also removes some unnecessary quotation marks, and uses hyphens to connect words in option arguments. This is intended to just clean up the formatting, leaving content corrections to later patches. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:11 +00:00
.BI \-g " key-name-hint"
mkimage: Support signing 'auto' FITs This adds support for signing images in auto-generated FITs. To do this, we need to add a signature node. The algorithm name property already has its own option, but we need one for the key name hint. We could have gone the -G route and added an explicit name for the public key (like what is done for the private key). However, many places assume the public key can be constructed from the key dir and hint, and I don't want to do the refactoring necessary. As a consequence of this, it is now easier to add public keys to an existing image without signing something. This could be done all along, but now you don't have to create an its just to do it. Ideally, we wouldn't create a FIT at the end. This could be done by calling fit_image_setup_sig/info.crypto->add_verify_data directly. Signed-off-by: Sean Anderson <sean.anderson@seco.com>
2022-05-16 20:11:08 +00:00
Sets the key-name-hint property when used with \-f auto. This is the <name>
part of the key. The directory part is set by \-k. This option also indicates
that the images included in the FIT should be signed. If this option is
specified, \-o must be specified as well.
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
mkimage: Allow to specify the signature algorithm on the command line This permits to prepare FIT image description that do not hard-code the final choice of the signature algorithm, possibly requiring the user to patch the sources. When -o <algo> is specified, this information is used in favor of the 'algo' property in the signature node. Furthermore, that property is set accordingly when writing the image. Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2022-01-14 09:21:19 +00:00
.TP
doc: mkimage: Regularize option documentation Square brackets are commonly used to denote optional parts of a command. However, all option arguments are mandatory. Remove these brackets. This also removes some unnecessary quotation marks, and uses hyphens to connect words in option arguments. This is intended to just clean up the formatting, leaving content corrections to later patches. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:11 +00:00
.BI \-o " signing-algorithm"
mkimage: Allow to specify the signature algorithm on the command line This permits to prepare FIT image description that do not hard-code the final choice of the signature algorithm, possibly requiring the user to patch the sources. When -o <algo> is specified, this information is used in favor of the 'algo' property in the signature node. Furthermore, that property is set accordingly when writing the image. Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2022-01-14 09:21:19 +00:00
Specifies the algorithm to be used for signing a FIT image. The default is
mkimage: Improve documentation of algo-name parameter Addresses the feedback provided on 5902a397d029 ("mkimage: Allow to specify the signature algorithm on the command line") which raced with the merge. Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-02-05 12:19:36 +00:00
taken from the signature node's 'algo' property.
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
mkimage: fit: spl: Add an optional static offset for external data When building a FIT with external data (-E), U-Boot proper may require absolute positioning for executing the external firmware. To acheive this use the (-p) switch, which will replace the amended 'data-offset' with 'data-position' indicating the absolute position of external data. It is considered an error if the requested absolute position overlaps with the initial data required for the compact FIT. Signed-off-by: Teddy Reed <teddy.reed@gmail.com>
2016-06-10 02:38:02 +00:00
.TP
doc: mkimage: Regularize option documentation Square brackets are commonly used to denote optional parts of a command. However, all option arguments are mandatory. Remove these brackets. This also removes some unnecessary quotation marks, and uses hyphens to connect words in option arguments. This is intended to just clean up the formatting, leaving content corrections to later patches. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:11 +00:00
.B \-r
mkimage: Add -r option to specify keys that must be verified Normally, multiple public keys can be provided and U-Boot is not required to use all of them for verification. This is because some images may not be signed, or may be optionally signed. But we still need a mechanism to determine when a key must be used. This feature cannot be implemented in the FIT itself, since anyone could change it to mark a key as optional. The requirement for key verification must go in with the public keys, in a place that is protected from modification. Add a -r option which tells mkimage to mark all keys that it uses for signing as 'required'. If some keys are optional and some are required, run mkimage several times (perhaps with different key directories if some keys are very secret) using the -F flag to update an existing FIT. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Marek Vasut <marex@denx.de>
2013-06-13 22:10:07 +00:00
Specifies that keys used to sign the FIT are required. This means that they
must be verified for the image to boot. Without this option, the verification
will be optional (useful for testing but not for release).
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
mkimage: Document misc options Over the years, several options have not made it into the help message. Document them. Do the same for the man page. Signed-off-by: Sean Anderson <sean.anderson@seco.com>
2022-04-08 20:08:39 +00:00
.TP
doc: mkimage: Regularize option documentation Square brackets are commonly used to denote optional parts of a command. However, all option arguments are mandatory. Remove these brackets. This also removes some unnecessary quotation marks, and uses hyphens to connect words in option arguments. This is intended to just clean up the formatting, leaving content corrections to later patches. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:11 +00:00
.BI \-N " engine"
mkimage: Document misc options Over the years, several options have not made it into the help message. Document them. Do the same for the man page. Signed-off-by: Sean Anderson <sean.anderson@seco.com>
2022-04-08 20:08:39 +00:00
The openssl engine to use when signing and verifying the image. For a complete list of
available engines, refer to
.BR engine (1).
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
mkimage: Allow updating the FIT timestamp Normally the FIT timestamp is created the first time mkimage is run on a FIT, when converting the source .its to the binary .fit file. This corresponds to using the -f flag. But if the original input to mkimage is a binary file (already compiled) then the timestamp is assumed to have been set previously. Add a -t flag to allow setting the timestamp in this case. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
2020-07-10 00:39:43 +00:00
.TP
doc: mkimage: Regularize option documentation Square brackets are commonly used to denote optional parts of a command. However, all option arguments are mandatory. Remove these brackets. This also removes some unnecessary quotation marks, and uses hyphens to connect words in option arguments. This is intended to just clean up the formatting, leaving content corrections to later patches. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:11 +00:00
.B \-t
mkimage: Allow updating the FIT timestamp Normally the FIT timestamp is created the first time mkimage is run on a FIT, when converting the source .its to the binary .fit file. This corresponds to using the -f flag. But if the original input to mkimage is a binary file (already compiled) then the timestamp is assumed to have been set previously. Add a -t flag to allow setting the timestamp in this case. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
2020-07-10 00:39:43 +00:00
Update the timestamp in the FIT.
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.IP
mkimage: Allow updating the FIT timestamp Normally the FIT timestamp is created the first time mkimage is run on a FIT, when converting the source .its to the binary .fit file. This corresponds to using the -f flag. But if the original input to mkimage is a binary file (already compiled) then the timestamp is assumed to have been set previously. Add a -t flag to allow setting the timestamp in this case. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
2020-07-10 00:39:43 +00:00
Normally the FIT timestamp is created the first time mkimage is run on a FIT,
when converting the source .its to the binary .fit file. This corresponds to
using the -f flag. But if the original input to mkimage is a binary file
(already compiled) then the timestamp is assumed to have been set previously.
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
doc/mkimage.1: Fix some typos Signed-off-by: Horst Kronstorfer <hkronsto@frequentis.com> Acked-by: Mike Frysinger <vapier@gentoo.org>
2011-12-21 04:31:23 +00:00
.SH EXAMPLES
doc: mkimage: Reformat examples This puts each example in a new paragraph and uses a hanging indent for continued lines to increase clarity. We use tabs instead of .in or .RS for the indent because it renders properly in both man and mandoc (which is what many common HTML man pages use). The only nit is that the tab stops in man default to something like 2", so reduce that to 1". We also escape every "minus" as recommended by man-pages(7). Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:10 +00:00
.\" Reduce the width of the tab stops to something reasonable
.ta T 1i
Add mkimage manpage Some Linux distributions include the "mkimage" as a package. This commit provides a manual page for mkimage. Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org> Added documentation for FIT images and examples. Moved to doc/ directory. Signed-off-by: Wolfgang Denk <wd@denx.de>
2010-06-16 01:38:24 +00:00
List image information:
doc: mkimage: Reformat examples This puts each example in a new paragraph and uses a hanging indent for continued lines to increase clarity. We use tabs instead of .in or .RS for the indent because it renders properly in both man and mandoc (which is what many common HTML man pages use). The only nit is that the tab stops in man default to something like 2", so reduce that to 1". We also escape every "minus" as recommended by man-pages(7). Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:10 +00:00
.RS
.P
.EX
\fBmkimage \-l uImage
.EE
.RE
Add mkimage manpage Some Linux distributions include the "mkimage" as a package. This commit provides a manual page for mkimage. Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org> Added documentation for FIT images and examples. Moved to doc/ directory. Signed-off-by: Wolfgang Denk <wd@denx.de>
2010-06-16 01:38:24 +00:00
.P
Create legacy image with compressed PowerPC Linux kernel:
doc: mkimage: Reformat examples This puts each example in a new paragraph and uses a hanging indent for continued lines to increase clarity. We use tabs instead of .in or .RS for the indent because it renders properly in both man and mandoc (which is what many common HTML man pages use). The only nit is that the tab stops in man default to something like 2", so reduce that to 1". We also escape every "minus" as recommended by man-pages(7). Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:10 +00:00
.RS
.P
.EX
\fBmkimage \-A powerpc \-O linux \-T kernel \-C gzip \\
\-a 0 \-e 0 \-n Linux \-d vmlinux.gz uImage
.EE
.RE
Add mkimage manpage Some Linux distributions include the "mkimage" as a package. This commit provides a manual page for mkimage. Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org> Added documentation for FIT images and examples. Moved to doc/ directory. Signed-off-by: Wolfgang Denk <wd@denx.de>
2010-06-16 01:38:24 +00:00
.P
Create FIT image with compressed PowerPC Linux kernel:
doc: mkimage: Reformat examples This puts each example in a new paragraph and uses a hanging indent for continued lines to increase clarity. We use tabs instead of .in or .RS for the indent because it renders properly in both man and mandoc (which is what many common HTML man pages use). The only nit is that the tab stops in man default to something like 2", so reduce that to 1". We also escape every "minus" as recommended by man-pages(7). Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:10 +00:00
.RS
.P
.EX
\fBmkimage \-f kernel.its kernel.itb
.EE
.RE
mkimage: Add -K to write public keys to an FDT blob FIT image verification requires public keys. Add a convenient option to mkimage to write the public keys to an FDT blob when it uses then for signing an image. This allows us to use: mkimage -f test.its -K dest.dtb -k keys test.fit and have the signatures written to test.fit and the corresponding public keys written to dest.dtb. Then dest.dtb can be used as the control FDT for U-Boot (CONFIG_OF_CONTROL), thus providing U-Boot with access to the public keys it needs. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Marek Vasut <marex@denx.de>
2013-06-13 22:10:04 +00:00
.P
Create FIT image with compressed kernel and sign it with keys in the
doc: mkimage: Reformat examples This puts each example in a new paragraph and uses a hanging indent for continued lines to increase clarity. We use tabs instead of .in or .RS for the indent because it renders properly in both man and mandoc (which is what many common HTML man pages use). The only nit is that the tab stops in man default to something like 2", so reduce that to 1". We also escape every "minus" as recommended by man-pages(7). Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:10 +00:00
/public/signing\-keys directory. Add corresponding public keys into u\-boot.dtb,
mkimage: Add -K to write public keys to an FDT blob FIT image verification requires public keys. Add a convenient option to mkimage to write the public keys to an FDT blob when it uses then for signing an image. This allows us to use: mkimage -f test.its -K dest.dtb -k keys test.fit and have the signatures written to test.fit and the corresponding public keys written to dest.dtb. Then dest.dtb can be used as the control FDT for U-Boot (CONFIG_OF_CONTROL), thus providing U-Boot with access to the public keys it needs. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Marek Vasut <marex@denx.de>
2013-06-13 22:10:04 +00:00
skipping those for which keys cannot be found. Also add a comment.
doc: mkimage: Reformat examples This puts each example in a new paragraph and uses a hanging indent for continued lines to increase clarity. We use tabs instead of .in or .RS for the indent because it renders properly in both man and mandoc (which is what many common HTML man pages use). The only nit is that the tab stops in man default to something like 2", so reduce that to 1". We also escape every "minus" as recommended by man-pages(7). Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:10 +00:00
.RS
.P
.EX
\fBmkimage \-f kernel.its \-k /public/signing\-keys \-K u\-boot.dtb \\
\-c \(dqKernel 3.8 image for production devices\(dq kernel.itb
.EE
.RE
mkimage: Support signing 'auto' FITs This adds support for signing images in auto-generated FITs. To do this, we need to add a signature node. The algorithm name property already has its own option, but we need one for the key name hint. We could have gone the -G route and added an explicit name for the public key (like what is done for the private key). However, many places assume the public key can be constructed from the key dir and hint, and I don't want to do the refactoring necessary. As a consequence of this, it is now easier to add public keys to an existing image without signing something. This could be done all along, but now you don't have to create an its just to do it. Ideally, we wouldn't create a FIT at the end. This could be done by calling fit_image_setup_sig/info.crypto->add_verify_data directly. Signed-off-by: Sean Anderson <sean.anderson@seco.com>
2022-05-16 20:11:08 +00:00
.P
doc: mkimage: Reformat examples This puts each example in a new paragraph and uses a hanging indent for continued lines to increase clarity. We use tabs instead of .in or .RS for the indent because it renders properly in both man and mandoc (which is what many common HTML man pages use). The only nit is that the tab stops in man default to something like 2", so reduce that to 1". We also escape every "minus" as recommended by man-pages(7). Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:10 +00:00
Add public keys to u\-boot.dtb without needing a FIT to sign. This will also
mkimage: Support signing 'auto' FITs This adds support for signing images in auto-generated FITs. To do this, we need to add a signature node. The algorithm name property already has its own option, but we need one for the key name hint. We could have gone the -G route and added an explicit name for the public key (like what is done for the private key). However, many places assume the public key can be constructed from the key dir and hint, and I don't want to do the refactoring necessary. As a consequence of this, it is now easier to add public keys to an existing image without signing something. This could be done all along, but now you don't have to create an its just to do it. Ideally, we wouldn't create a FIT at the end. This could be done by calling fit_image_setup_sig/info.crypto->add_verify_data directly. Signed-off-by: Sean Anderson <sean.anderson@seco.com>
2022-05-16 20:11:08 +00:00
create a FIT containing an images node with no data named unused.itb.
doc: mkimage: Reformat examples This puts each example in a new paragraph and uses a hanging indent for continued lines to increase clarity. We use tabs instead of .in or .RS for the indent because it renders properly in both man and mandoc (which is what many common HTML man pages use). The only nit is that the tab stops in man default to something like 2", so reduce that to 1". We also escape every "minus" as recommended by man-pages(7). Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:10 +00:00
.RS
.P
.EX
\fBmkimage \-f auto \-d /dev/null \-k /public/signing\-keys \-g dev \\
\-o sha256,rsa2048 \-K u\-boot.dtb unused.itb
.EE
.RE
mkimage: Add -F option to modify an existing .fit file When signing images it is sometimes necessary to sign with different keys at different times, or make the signer entirely separate from the FIT creation to avoid needing the private keys to be publicly available in the system. Add a -F option so that key signing can be a separate step, and possibly done multiple times as different keys are avaiable. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Marek Vasut <marex@denx.de>
2013-06-13 22:10:05 +00:00
.P
Update an existing FIT image, signing it with additional keys.
doc: mkimage: Reformat examples This puts each example in a new paragraph and uses a hanging indent for continued lines to increase clarity. We use tabs instead of .in or .RS for the indent because it renders properly in both man and mandoc (which is what many common HTML man pages use). The only nit is that the tab stops in man default to something like 2", so reduce that to 1". We also escape every "minus" as recommended by man-pages(7). Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:10 +00:00
Add corresponding public keys into u\-boot.dtb. This will resign all images
mkimage: Add -F option to modify an existing .fit file When signing images it is sometimes necessary to sign with different keys at different times, or make the signer entirely separate from the FIT creation to avoid needing the private keys to be publicly available in the system. Add a -F option so that key signing can be a separate step, and possibly done multiple times as different keys are avaiable. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Marek Vasut <marex@denx.de>
2013-06-13 22:10:05 +00:00
with keys that are available in the new directory. Images that request signing
with unavailable keys are skipped.
doc: mkimage: Reformat examples This puts each example in a new paragraph and uses a hanging indent for continued lines to increase clarity. We use tabs instead of .in or .RS for the indent because it renders properly in both man and mandoc (which is what many common HTML man pages use). The only nit is that the tab stops in man default to something like 2", so reduce that to 1". We also escape every "minus" as recommended by man-pages(7). Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:10 +00:00
.RS
.P
.EX
\fBmkimage \-F \-k /secret/signing\-keys \-K u\-boot.dtb \\
\-c \(dqKernel 3.8 image for production devices\(dq kernel.itb
.EE
.RE
mkimage: Support automatic creating of a FIT without a .its At present, when generating a FIT, mkimage requires a .its file containing the structure of the FIT and referring to the images to be included. Creating the .its file is a separate step that makes it harder to use FIT. This is not required for creating legacy images. Often the FIT is pretty standard, consisting of an OS image, some device tree files and a single configuration. We can handle this case automatically and avoid needing a .its file at all. To start with, support automatically generate the FIT using a new '-f auto' option. Initially this only supports adding a single image (e.g. a linux kernel) and a single configuration. Signed-off-by: Simon Glass <sjg@chromium.org>
2016-02-23 05:55:51 +00:00
.P
Create a FIT image containing a kernel, using automatic mode. No .its file
is required.
doc: mkimage: Reformat examples This puts each example in a new paragraph and uses a hanging indent for continued lines to increase clarity. We use tabs instead of .in or .RS for the indent because it renders properly in both man and mandoc (which is what many common HTML man pages use). The only nit is that the tab stops in man default to something like 2", so reduce that to 1". We also escape every "minus" as recommended by man-pages(7). Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:10 +00:00
.RS
.P
.EX
\fBmkimage \-f auto \-A arm \-O linux \-T kernel \-C none \-a 43e00000 \-e 0 \\
\-c \(dqKernel 4.4 image for production devices\(dq \-d vmlinuz kernel.itb
.EE
.RE
mkimage: Support adding device tree files to a FIT To make the auto-FIT feature useful we need to be able to provide a list of device tree files on the command line for mkimage to add into the FIT. Add support for this feature. So far there is no support for hashing or verified boot using this method. For those cases, a .its file must still be provided. Signed-off-by: Simon Glass <sjg@chromium.org>
2016-02-23 05:55:52 +00:00
.P
Create a FIT image containing a kernel and some device tree files, using
automatic mode. No .its file is required.
doc: mkimage: Reformat examples This puts each example in a new paragraph and uses a hanging indent for continued lines to increase clarity. We use tabs instead of .in or .RS for the indent because it renders properly in both man and mandoc (which is what many common HTML man pages use). The only nit is that the tab stops in man default to something like 2", so reduce that to 1". We also escape every "minus" as recommended by man-pages(7). Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:10 +00:00
.RS
.P
.EX
\fBmkimage \-f auto \-A arm \-O linux \-T kernel \-C none \-a 43e00000 \-e 0 \\
\-c \(dqKernel 4.4 image for production devices\(dq \-d vmlinuz \\
\-b /path/to/rk3288\-firefly.dtb \-b /path/to/rk3288\-jerry.dtb kernel.itb
.EE
.RE
mkimage: Support signing 'auto' FITs This adds support for signing images in auto-generated FITs. To do this, we need to add a signature node. The algorithm name property already has its own option, but we need one for the key name hint. We could have gone the -G route and added an explicit name for the public key (like what is done for the private key). However, many places assume the public key can be constructed from the key dir and hint, and I don't want to do the refactoring necessary. As a consequence of this, it is now easier to add public keys to an existing image without signing something. This could be done all along, but now you don't have to create an its just to do it. Ideally, we wouldn't create a FIT at the end. This could be done by calling fit_image_setup_sig/info.crypto->add_verify_data directly. Signed-off-by: Sean Anderson <sean.anderson@seco.com>
2022-05-16 20:11:08 +00:00
.P
Create a FIT image containing a signed kernel, using automatic mode. No .its
file is required.
doc: mkimage: Reformat examples This puts each example in a new paragraph and uses a hanging indent for continued lines to increase clarity. We use tabs instead of .in or .RS for the indent because it renders properly in both man and mandoc (which is what many common HTML man pages use). The only nit is that the tab stops in man default to something like 2", so reduce that to 1". We also escape every "minus" as recommended by man-pages(7). Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:10 +00:00
.RS
.P
.EX
\fBmkimage \-f auto \-A arm \-O linux \-T kernel \-C none \-a 43e00000 \-e 0 \\
\-d vmlinuz \-k /secret/signing\-keys \-g dev \-o sha256,rsa2048 kernel.itb
.EE
.RE
doc: mkimage: Use empty request instead of blank lines Blank lines do not have well-defined semantics in fill mode (the default). Instead, use empty requests (.) where vertical space is necessary for readability. There are a few places where we use a paragraph instead. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-06-25 17:12:09 +00:00
.
Add mkimage manpage Some Linux distributions include the "mkimage" as a package. This commit provides a manual page for mkimage. Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org> Added documentation for FIT images and examples. Moved to doc/ directory. Signed-off-by: Wolfgang Denk <wd@denx.de>
2010-06-16 01:38:24 +00:00
.SH HOMEPAGE
http://www.denx.de/wiki/U-Boot/WebHome
.PP
.SH AUTHOR
This manual page was written by Nobuhiro Iwamatsu <iwamatsu@nigauri.org>
mkimage: Add -k option to specify key directory Keys required for signing images will be in a specific directory. Add a -k option to specify that directory. Also update the mkimage man page with this information and a clearer list of available commands. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Marek Vasut <marex@denx.de> (v1)
2013-06-13 22:10:03 +00:00
and Wolfgang Denk <wd@denx.de>. It was updated for image signing by
Simon Glass <sjg@chromium.org>.
Reference in a new issue Copy permalink