colin/u-boot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: mkimage: Use empty request instead of blank lines

Browse Source 
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>
This commit is contained in:
Sean Anderson
2022-06-25 13:12:09 -04:00
committed by Heinrich Schuchardt
parent a568554ee0
commit 7ec625f180
1 changed files with 54 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

108
doc/mkimage.1
View File

@@ -1,5 +1,5 @@
.TH MKIMAGE 1 "2022-02-07" .TH MKIMAGE 1 "2022-02-07"
.
.SH NAME .SH NAME
mkimage \- Generate image for U-Boot mkimage \- Generate image for U-Boot
.SH SYNOPSIS .SH SYNOPSIS
@@ -7,35 +7,35 @@ mkimage \- Generate image for U-Boot
.OP \-T type .OP \-T type
.BI \-l\~ image-file-name .BI \-l\~ image-file-name
.YS .YS
.
.SY mkimage .SY mkimage
.RI [ option\~ .\|.\|.\&] .RI [ option\~ .\|.\|.\&]
.OP \-T type .OP \-T type
.I image-file-name .I image-file-name
.YS .YS
.
.SY mkimage .SY mkimage
.RI [ option\~ .\|.\|.\&] .RI [ option\~ .\|.\|.\&]
.BI \-f\~ image-tree-source-file\c .BI \-f\~ image-tree-source-file\c
.RB | auto .RB | auto
.I image-file-name .I image-file-name
.YS .YS
.
.SY mkimage .SY mkimage
.RI [ option\~ .\|.\|.\&] .RI [ option\~ .\|.\|.\&]
.BI \-F\~ image-file-name .BI \-F\~ image-file-name
.YS .YS
.
.SH "DESCRIPTION" .SH "DESCRIPTION"
The The
.B mkimage .B mkimage
command is used to create images for use with the U-Boot boot loader. command is used to create images for use with the U-Boot boot loader.
These images can contain the linux kernel, device tree blob, root file These images can contain the linux kernel, device tree blob, root file
system image, firmware images etc., either separate or combined. system image, firmware images etc., either separate or combined.
.P
.B mkimage .B mkimage
supports two different formats: supports two different formats:
.P
The old The old
.I legacy image .I legacy image
format concatenates the individual parts (for example, kernel image, format concatenates the individual parts (for example, kernel image,
@@ -43,69 +43,69 @@ device tree blob and ramdisk image) and adds a 64 bytes header
containing information about target architecture, operating system, containing information about target architecture, operating system,
image type, compression method, entry points, time stamp, checksums, image type, compression method, entry points, time stamp, checksums,
etc. etc.
.P
The new The new
.I FIT (Flattened Image Tree) format .I FIT (Flattened Image Tree) format
allows for more flexibility in handling images of various types and also allows for more flexibility in handling images of various types and also
enhances integrity protection of images with stronger checksums. It also enhances integrity protection of images with stronger checksums. It also
supports verified boot. supports verified boot.
.
.SH "OPTIONS" .SH "OPTIONS"
.
.B List image information: .B List image information:
.
.TP .TP
.BI "\-l [" "uimage file name" "]" .BI "\-l [" "uimage file name" "]"
mkimage lists the information contained in the header of an existing U-Boot image. mkimage lists the information contained in the header of an existing U-Boot image.
.
.TP .TP
.BI "\-T [" "image type" "]" .BI "\-T [" "image type" "]"
Parse image file as type. 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 .TP
.BI "\-q" .BI "\-q"
Quiet. Don't print the image header on successful verification. Quiet. Don't print the image header on successful verification.
.
.P .P
.B Create old legacy image: .B Create old legacy image:
.
.TP .TP
.BI "\-A [" "architecture" "]" .BI "\-A [" "architecture" "]"
Set architecture. Pass \-h as the architecture to see the list of supported architectures. Set architecture. Pass \-h as the architecture to see the list of supported architectures.
.
.TP .TP
.BI "\-O [" "os" "]" .BI "\-O [" "os" "]"
Set operating system. bootm command of u-boot changes boot method by os type. Set operating system. bootm command of u-boot changes boot method by os type.
Pass \-h as the OS to see the list of supported OS. Pass \-h as the OS to see the list of supported OS.
.
.TP .TP
.BI "\-T [" "image type" "]" .BI "\-T [" "image type" "]"
Set image type. Set image 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.
.
.TP .TP
.BI "\-C [" "compression type" "]" .BI "\-C [" "compression type" "]"
Set compression type. Set compression type.
Pass \-h as the compression to see the list of supported compression type. Pass \-h as the compression to see the list of supported compression type.
.
.TP .TP
.BI "\-a [" "load address" "]" .BI "\-a [" "load address" "]"
Set load address with a hex number. Set load address with a hex number.
.
.TP .TP
.BI "\-e [" "entry point" "]" .BI "\-e [" "entry point" "]"
Set entry point with a hex number. Set entry point with a hex number.
.
.TP .TP
.BI "\-l" .BI "\-l"
List the contents of an image. List the contents of an image.
.
.TP .TP
.BI "\-n [" "image name" "]" .BI "\-n [" "image name" "]"
Set image name to 'image name'. Set image name to 'image name'.
.
.TP .TP
.BI "\-R [" "secondary image name" "]" .BI "\-R [" "secondary image name" "]"
Some image types support a second image for additional data. For these types, Some image types support a second image for additional data. For these types,
@@ -134,42 +134,42 @@ when loading the image. At most 256 parameters may be specified in this
manner. manner.
T} T}
.TE .TE
.
.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'.
.
.TP .TP
.BI "\-x" .BI "\-x"
Set XIP (execute in place) flag. Set XIP (execute in place) flag.
.
.TP .TP
.BI "\-s" .BI "\-s"
Don't copy in the image data. Depending on the image type, this may create 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. just the header, everything but the image data, or nothing at all.
.
.TP .TP
.BI "\-v" .BI "\-v"
Verbose. Print file names as they are added to the image. Verbose. Print file names as they are added to the image.
.
.P .P
.B Create FIT image: .B Create FIT image:
.
.TP .TP
.BI "\-b [" "device tree file" "] .BI "\-b [" "device tree file" "]
Appends the device tree binary file (.dtb) to the FIT. Appends the device tree binary file (.dtb) to the FIT.
.
.TP .TP
.BI "\-c [" "comment" "]" .BI "\-c [" "comment" "]"
Specifies a comment to be added when signing. This is typically a useful 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 message which describes how the image was signed or some other useful
information. information.
.
.TP .TP
.BI "\-D [" "dtc options" "]" .BI "\-D [" "dtc options" "]"
Provide special options to the device tree compiler that is used to Provide special options to the device tree compiler that is used to
create the image. create the image.
.
.TP .TP
.BI "\-E .BI "\-E
After processing, move the image data outside the FIT and store a data offset After processing, move the image data outside the FIT and store a data offset
@@ -178,44 +178,44 @@ 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. 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 .TP
.BI "\-B [" "alignment" "]" .BI "\-B [" "alignment" "]"
The alignment, in hexadecimal, that external data will be aligned to. This The alignment, in hexadecimal, that external data will be aligned to. This
option only has an effect when \-E is specified. 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
FIT image. FIT image.
.IP
This can be automatically generated for some simple cases. 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 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. and -e are used to specify the image to include in the FIT and its attributes.
No .its file is required. No .its file is required.
.
.TP .TP
.BI "\-F" .BI "\-F"
Indicates that an existing FIT image should be modified. No dtc Indicates that an existing FIT image should be modified. No dtc
compilation is performed and the \-f flag should not be given. compilation is performed and the \-f flag should not be given.
This can be used to sign images with additional keys after initial image This can be used to sign images with additional keys after initial image
creation. creation.
.
.TP .TP
.BI "\-i [" "ramdisk_file" "]" .BI "\-i [" "ramdisk_file" "]"
Appends the ramdisk file to the FIT. Appends the ramdisk file to the FIT.
.
.TP .TP
.BI "\-k [" "key_directory" "]" .BI "\-k [" "key_directory" "]"
Specifies the directory containing keys to use for signing. This directory 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 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. certificate <name>.crt (containing the public key) for use with verification.
.
.TP .TP
.BI "\-G [" "key_file" "]" .BI "\-G [" "key_file" "]"
Specifies the private key file to use when signing. This option may be used Specifies the private key file to use when signing. This option may be used
instead of \-k. instead of \-k.
.
.TP .TP
.BI "\-K [" "key_destination" "]" .BI "\-K [" "key_destination" "]"
Specifies a compiled device tree binary file (typically .dtb) to write Specifies a compiled device tree binary file (typically .dtb) to write
@@ -223,53 +223,53 @@ 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 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 .TP
.BI "\-G [" "key_file" "]" .BI "\-G [" "key_file" "]"
Specifies the private key file to use when signing. This option may be used Specifies the private key file to use when signing. This option may be used
instead of \-k. instead of \-k.
.
.TP .TP
.BI "\-g [" "key_name_hint" "]" .BI "\-g [" "key_name_hint" "]"
Sets the key-name-hint property when used with \-f auto. This is the <name> 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 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 that the images included in the FIT should be signed. If this option is
specified, \-o must be specified as well. specified, \-o must be specified as well.
.
.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
taken from the signature node's 'algo' property. taken from the signature node's 'algo' property.
.
.TP .TP
.BI "\-p [" "external position" "]" .BI "\-p [" "external position" "]"
Place external data at a static external position. See \-E. Instead of writing 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 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 .TP
.BI "\-N [" "engine" "]" .BI "\-N [" "engine" "]"
The openssl engine to use when signing and verifying the image. For a complete list of The openssl engine to use when signing and verifying the image. For a complete list of
available engines, refer to available engines, refer to
.BR engine (1). .BR engine (1).
.
.TP .TP
.BI "\-t .BI "\-t
Update the timestamp in the FIT. Update the timestamp in the FIT.
.IP
Normally the FIT timestamp is created the first time mkimage is run on a FIT, 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 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 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. (already compiled) then the timestamp is assumed to have been set previously.
.
.SH EXAMPLES .SH EXAMPLES
.
List image information: List image information:
.nf .nf
.B mkimage -l uImage .B mkimage -l uImage
@@ -295,7 +295,7 @@ skipping those for which keys cannot be found. Also add a comment.
.br .br
.B -c """Kernel 3.8 image for production devices""" kernel.itb .B -c """Kernel 3.8 image for production devices""" kernel.itb
.fi .fi
.
.P .P
Add public keys to u-boot.dtb without needing a FIT to sign. This will also Add public keys to u-boot.dtb without needing a FIT to sign. This will also
create a FIT containing an images node with no data named unused.itb. create a FIT containing an images node with no data named unused.itb.
@@ -304,7 +304,7 @@ create a FIT containing an images node with no data named unused.itb.
.br .br
.B -o sha256,rsa2048 -K u-boot.dtb unused.itb .B -o sha256,rsa2048 -K u-boot.dtb unused.itb
.fi .fi
.
.P .P
Update an existing FIT image, signing it with additional keys. Update an existing FIT image, signing it with additional keys.
Add corresponding public keys into u-boot.dtb. This will resign all images Add corresponding public keys into u-boot.dtb. This will resign all images
@@ -315,7 +315,7 @@ with unavailable keys are skipped.
.br .br
.B -c """Kernel 3.8 image for production devices""" kernel.itb .B -c """Kernel 3.8 image for production devices""" kernel.itb
.fi .fi
.
.P .P
Create a FIT image containing a kernel, using automatic mode. No .its file Create a FIT image containing a kernel, using automatic mode. No .its file
is required. is required.
@@ -341,7 +341,7 @@ file is required.
.br .br
.B -d vmlinuz -k /secret/signing-keys -g dev -o sha256,rsa2048 kernel.itb .B -d vmlinuz -k /secret/signing-keys -g dev -o sha256,rsa2048 kernel.itb
.fi .fi
.
.SH HOMEPAGE .SH HOMEPAGE
http://www.denx.de/wiki/U-Boot/WebHome http://www.denx.de/wiki/U-Boot/WebHome
.PP .PP