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>
This commit is contained in:

committed by
Heinrich Schuchardt

parent
ecd4e5cf18
commit
deb2638aa0
@@ -53,6 +53,10 @@ Parse image file as type.
|
|||||||
Pass \-h as the image to see the list of supported image type.
|
Pass \-h as the image to see the list of supported image type.
|
||||||
Without this option image type is autodetected.
|
Without this option image type is autodetected.
|
||||||
|
|
||||||
|
.TP
|
||||||
|
.BI "\-q"
|
||||||
|
Quiet. Don't print the image header on successful verification.
|
||||||
|
|
||||||
.P
|
.P
|
||||||
.B Create old legacy image:
|
.B Create old legacy image:
|
||||||
|
|
||||||
@@ -91,6 +95,11 @@ List the contents of an image.
|
|||||||
.BI "\-n [" "image name" "]"
|
.BI "\-n [" "image name" "]"
|
||||||
Set image name to 'image name'.
|
Set image name to 'image name'.
|
||||||
|
|
||||||
|
.TP
|
||||||
|
.BI "\-R [" "secondary image name" "]"
|
||||||
|
Some image types support a second image for additional data. For these types,
|
||||||
|
use \-R to specify this second image.
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
.BI "\-d [" "image data file" "]"
|
.BI "\-d [" "image data file" "]"
|
||||||
Use image data from 'image data file'.
|
Use image data from 'image data file'.
|
||||||
@@ -99,6 +108,15 @@ Use image data from 'image data file'.
|
|||||||
.BI "\-x"
|
.BI "\-x"
|
||||||
Set XIP (execute in place) flag.
|
Set XIP (execute in place) flag.
|
||||||
|
|
||||||
|
.TP
|
||||||
|
.BI "\-s"
|
||||||
|
Create an image with no data. The header will be created, but the image itself
|
||||||
|
will not contain data (such as U-Boot or any specified kernel).
|
||||||
|
|
||||||
|
.TP
|
||||||
|
.BI "\-v"
|
||||||
|
Verbose. Print file names as they are added to the image.
|
||||||
|
|
||||||
.P
|
.P
|
||||||
.B Create FIT image:
|
.B Create FIT image:
|
||||||
|
|
||||||
@@ -126,6 +144,11 @@ 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)
|
A 'data-offset' of 0 indicates that it starts in the first (4-byte aligned)
|
||||||
byte after the FIT.
|
byte after the FIT.
|
||||||
|
|
||||||
|
.TP
|
||||||
|
.BI "\-B [" "alignment" "]"
|
||||||
|
The alignment, in hexadecimal, that external data will be aligned to. This
|
||||||
|
option only has an effect when \-E is specified.
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
.BI "\-f [" "image tree source file" " | " "auto" "]"
|
.BI "\-f [" "image tree source file" " | " "auto" "]"
|
||||||
Image tree source file that describes the structure and contents of the
|
Image tree source file that describes the structure and contents of the
|
||||||
@@ -161,6 +184,11 @@ 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
|
verification. Typically the file here is the device tree binary used by
|
||||||
CONFIG_OF_CONTROL in U-Boot.
|
CONFIG_OF_CONTROL in U-Boot.
|
||||||
|
|
||||||
|
.TP
|
||||||
|
.BI "\-G [" "key_file" "]"
|
||||||
|
Specifies the private key file to use when signing. This option may be used
|
||||||
|
instead of \-k.
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
.BI "\-o [" "signing algorithm" "]"
|
.BI "\-o [" "signing algorithm" "]"
|
||||||
Specifies the algorithm to be used for signing a FIT image. The default is
|
Specifies the algorithm to be used for signing a FIT image. The default is
|
||||||
@@ -173,11 +201,17 @@ 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.
|
use 'data-position' as the absolute position from the base of the FIT.
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
.BI "\-r
|
.BI "\-r"
|
||||||
Specifies that keys used to sign the FIT are required. This means that they
|
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
|
must be verified for the image to boot. Without this option, the verification
|
||||||
will be optional (useful for testing but not for release).
|
will be optional (useful for testing but not for release).
|
||||||
|
|
||||||
|
.TP
|
||||||
|
.BI "\-N [" "engine" "]"
|
||||||
|
The openssl engine to use when signing and verifying the image. For a complete list of
|
||||||
|
available engines, refer to
|
||||||
|
.BR engine (1).
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
.BI "\-t
|
.BI "\-t
|
||||||
Update the timestamp in the FIT.
|
Update the timestamp in the FIT.
|
||||||
|
@@ -84,7 +84,8 @@ static void usage(const char *msg)
|
|||||||
fprintf(stderr, "Error: %s\n", msg);
|
fprintf(stderr, "Error: %s\n", msg);
|
||||||
fprintf(stderr, "Usage: %s [-T type] -l image\n"
|
fprintf(stderr, "Usage: %s [-T type] -l image\n"
|
||||||
" -l ==> list image header information\n"
|
" -l ==> list image header information\n"
|
||||||
" -T ==> parse image file as 'type'\n",
|
" -T ==> parse image file as 'type'\n"
|
||||||
|
" -q ==> quiet\n",
|
||||||
params.cmdname);
|
params.cmdname);
|
||||||
fprintf(stderr,
|
fprintf(stderr,
|
||||||
" %s [-x] -A arch -O os -T type -C comp -a addr -e ep -n name -d data_file[:data_file...] image\n"
|
" %s [-x] -A arch -O os -T type -C comp -a addr -e ep -n name -d data_file[:data_file...] image\n"
|
||||||
@@ -95,8 +96,11 @@ static void usage(const char *msg)
|
|||||||
" -a ==> set load address to 'addr' (hex)\n"
|
" -a ==> set load address to 'addr' (hex)\n"
|
||||||
" -e ==> set entry point to 'ep' (hex)\n"
|
" -e ==> set entry point to 'ep' (hex)\n"
|
||||||
" -n ==> set image name to 'name'\n"
|
" -n ==> set image name to 'name'\n"
|
||||||
|
" -R ==> set second image name to 'name'\n"
|
||||||
" -d ==> use image data from 'datafile'\n"
|
" -d ==> use image data from 'datafile'\n"
|
||||||
" -x ==> set XIP (execute in place)\n",
|
" -x ==> set XIP (execute in place)\n"
|
||||||
|
" -s ==> create an image with no data\n"
|
||||||
|
" -v ==> verbose\n",
|
||||||
params.cmdname);
|
params.cmdname);
|
||||||
fprintf(stderr,
|
fprintf(stderr,
|
||||||
" %s [-D dtc_options] [-f fit-image.its|-f auto|-F] [-b <dtb> [-b <dtb>]] [-E] [-B size] [-i <ramdisk.cpio.gz>] fit-image\n"
|
" %s [-D dtc_options] [-f fit-image.its|-f auto|-F] [-b <dtb> [-b <dtb>]] [-E] [-B size] [-i <ramdisk.cpio.gz>] fit-image\n"
|
||||||
@@ -107,7 +111,9 @@ static void usage(const char *msg)
|
|||||||
" -f => input filename for FIT source\n"
|
" -f => input filename for FIT source\n"
|
||||||
" -i => input filename for ramdisk file\n"
|
" -i => input filename for ramdisk file\n"
|
||||||
" -E => place data outside of the FIT structure\n"
|
" -E => place data outside of the FIT structure\n"
|
||||||
" -B => align size in hex for FIT structure and header\n");
|
" -B => align size in hex for FIT structure and header\n"
|
||||||
|
" -b => append the device tree binary to the FIT\n"
|
||||||
|
" -t => update the timestamp in the FIT\n");
|
||||||
#ifdef CONFIG_FIT_SIGNATURE
|
#ifdef CONFIG_FIT_SIGNATURE
|
||||||
fprintf(stderr,
|
fprintf(stderr,
|
||||||
"Signing / verified boot options: [-k keydir] [-K dtb] [ -c <comment>] [-p addr] [-r] [-N engine]\n"
|
"Signing / verified boot options: [-k keydir] [-K dtb] [ -c <comment>] [-p addr] [-r] [-N engine]\n"
|
||||||
@@ -118,7 +124,8 @@ static void usage(const char *msg)
|
|||||||
" -F => re-sign existing FIT image\n"
|
" -F => re-sign existing FIT image\n"
|
||||||
" -p => place external data at a static position\n"
|
" -p => place external data at a static position\n"
|
||||||
" -r => mark keys used as 'required' in dtb\n"
|
" -r => mark keys used as 'required' in dtb\n"
|
||||||
" -N => openssl engine to use for signing\n");
|
" -N => openssl engine to use for signing\n"
|
||||||
|
" -o => algorithm to use for signing\n");
|
||||||
#else
|
#else
|
||||||
fprintf(stderr,
|
fprintf(stderr,
|
||||||
"Signing / verified boot not supported (CONFIG_FIT_SIGNATURE undefined)\n");
|
"Signing / verified boot not supported (CONFIG_FIT_SIGNATURE undefined)\n");
|
||||||
|
Reference in New Issue
Block a user