mirror of
https://source.denx.de/u-boot/u-boot.git
synced 2026-06-02 09:46:37 +03:00
treewide: fix uImage.FIT document paths
Commit 488445cefa ("doc: Move FIT into its own directory") moved the
documentation in doc/uImage.FIT to doc/usage/fit, subsequently all
documents and example sources have been converted to reStructuredText.
Fix (almost) all of the remaining occurrences of the old path and
filenames across the tree.
The exception is doc/uImage.FIT/command_syntax_extensions.txt which
apparently has been removed entirely, or at least I was unable to
locate where that document is now.
Signed-off-by: Daniel Golle <daniel@makrotopia.org>
This commit is contained in:
committed by
Heinrich Schuchardt
parent
c24a72c35a
commit
72cc446490
2
README
2
README
@@ -1662,7 +1662,7 @@ New uImage format (FIT)
|
|||||||
Flexible and powerful format based on Flattened Image Tree -- FIT (similar
|
Flexible and powerful format based on Flattened Image Tree -- FIT (similar
|
||||||
to Flattened Device Tree). It allows the use of images with multiple
|
to Flattened Device Tree). It allows the use of images with multiple
|
||||||
components (several kernels, ramdisks, etc.), with contents protected by
|
components (several kernels, ramdisks, etc.), with contents protected by
|
||||||
SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
|
SHA1, MD5 or CRC32. More details are found in the doc/usage/fit directory.
|
||||||
|
|
||||||
|
|
||||||
Old uImage format
|
Old uImage format
|
||||||
|
|||||||
@@ -41,4 +41,4 @@ fiptool_images. Run below command in ATF folder to generate FIP image.
|
|||||||
- Test
|
- Test
|
||||||
Just boot up your board and wait for u-boot start up after ATF's log.
|
Just boot up your board and wait for u-boot start up after ATF's log.
|
||||||
For booting Linux in FIT image, please reference the FIT files in
|
For booting Linux in FIT image, please reference the FIT files in
|
||||||
u-boot doc/uImage.FIT/ folder.
|
u-boot doc/usage/fit/ folder.
|
||||||
|
|||||||
@@ -335,7 +335,7 @@ config TPL_LOAD_FIT
|
|||||||
property will not be loaded. This limitation also applies to FPGA
|
property will not be loaded. This limitation also applies to FPGA
|
||||||
images with the correct "compatible" string.
|
images with the correct "compatible" string.
|
||||||
2. For FPGA images, the supported "compatible" list is in the
|
2. For FPGA images, the supported "compatible" list is in the
|
||||||
doc/uImage.FIT/source_file_format.txt.
|
doc/usage/fit/source_file_format.rst.
|
||||||
3. FDTs are only loaded for images with an "os" property of "u-boot".
|
3. FDTs are only loaded for images with an "os" property of "u-boot".
|
||||||
"linux" images are also supported with Falcon boot mode.
|
"linux" images are also supported with Falcon boot mode.
|
||||||
|
|
||||||
|
|||||||
@@ -94,7 +94,7 @@ FIT image format for download
|
|||||||
To create FIT image for download one should follow the update tftp README file
|
To create FIT image for download one should follow the update tftp README file
|
||||||
(./doc/README.update) with one notable difference:
|
(./doc/README.update) with one notable difference:
|
||||||
|
|
||||||
The original snippet of ./doc/uImage.FIT/update_uboot.its
|
The original snippet of ./doc/usage/fit/update_uboot.rst
|
||||||
|
|
||||||
images {
|
images {
|
||||||
update@1 {
|
update@1 {
|
||||||
|
|||||||
@@ -152,7 +152,7 @@ Two for both, kernel with device tree support and also without it:
|
|||||||
If proper fdt file exists then it will be automatically loaded,
|
If proper fdt file exists then it will be automatically loaded,
|
||||||
so for old kernel types, please remove fdt file from boot partition.
|
so for old kernel types, please remove fdt file from boot partition.
|
||||||
|
|
||||||
The third boot option for multi image support (more info: doc/uImage.FIT/)
|
The third boot option for multi image support (more info: doc/usage/fit/)
|
||||||
- boot_fit - for binary file: "Image.itb"
|
- boot_fit - for binary file: "Image.itb"
|
||||||
|
|
||||||
Default boot command: "autoboot"
|
Default boot command: "autoboot"
|
||||||
|
|||||||
@@ -112,7 +112,7 @@ Verified Boot
|
|||||||
|
|
||||||
U-Boot supports an image verification method called "Verified Boot".
|
U-Boot supports an image verification method called "Verified Boot".
|
||||||
This is a brief tutorial to utilize this feature for the UniPhier platform.
|
This is a brief tutorial to utilize this feature for the UniPhier platform.
|
||||||
You will find details documents in the doc/uImage.FIT directory.
|
You will find details documents in the doc/usage/fit directory.
|
||||||
|
|
||||||
Here, we take LD20 reference board for example, but it should work for any
|
Here, we take LD20 reference board for example, but it should work for any
|
||||||
other boards including 32 bit SoCs.
|
other boards including 32 bit SoCs.
|
||||||
|
|||||||
@@ -48,14 +48,14 @@ The auto-update feature uses the following configuration knobs:
|
|||||||
Since the update file is in FIT format, it is created from an *.its file using
|
Since the update file is in FIT format, it is created from an *.its file using
|
||||||
the mkimage tool. dtc tool with support for binary includes, e.g. in version
|
the mkimage tool. dtc tool with support for binary includes, e.g. in version
|
||||||
1.2.0 or later, must also be available on the system where the update file is
|
1.2.0 or later, must also be available on the system where the update file is
|
||||||
to be prepared. Refer to the doc/uImage.FIT/ directory for more details on FIT
|
to be prepared. Refer to the doc/usage/fit/ directory for more details on FIT
|
||||||
images.
|
images.
|
||||||
|
|
||||||
|
|
||||||
Example .its files
|
Example .its files
|
||||||
------------------
|
------------------
|
||||||
|
|
||||||
- doc/uImage.FIT/update_uboot.its
|
- doc/usage/fit/update_uboot.rst
|
||||||
|
|
||||||
A simple example that can be used to create an update file for automatically
|
A simple example that can be used to create an update file for automatically
|
||||||
replacing U-Boot image on a system.
|
replacing U-Boot image on a system.
|
||||||
@@ -83,7 +83,7 @@ Example .its files
|
|||||||
where the update will be placed is correct. Making mistake here and
|
where the update will be placed is correct. Making mistake here and
|
||||||
attempting the auto-update can render the system unusable.
|
attempting the auto-update can render the system unusable.
|
||||||
|
|
||||||
- doc/uImage.FIT/update3.its
|
- doc/usage/fit/update3.rst
|
||||||
|
|
||||||
An example containing three updates. It can be used to update Linux kernel,
|
An example containing three updates. It can be used to update Linux kernel,
|
||||||
ramdisk and FDT blob stored in Flash. The procedure for preparing the update
|
ramdisk and FDT blob stored in Flash. The procedure for preparing the update
|
||||||
|
|||||||
@@ -27,7 +27,7 @@ We will build ``u-boot-nodtb.bin`` from the u-boot source tree.
|
|||||||
|
|
||||||
Generate FIT image (optional)
|
Generate FIT image (optional)
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
See doc/uImage.FIT for more details
|
See doc/usage/fit for more details
|
||||||
|
|
||||||
Pack android boot image
|
Pack android boot image
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Package U-Boot
|
|||||||
|
|
||||||
U-Boot uses Flat Image Tree (FIT) as a standard file format for packaging
|
U-Boot uses Flat Image Tree (FIT) as a standard file format for packaging
|
||||||
images that it reads and boots. Documentation about FIT is available at
|
images that it reads and boots. Documentation about FIT is available at
|
||||||
doc/uImage.FIT
|
doc/usage/fit
|
||||||
|
|
||||||
U-Boot also provides binman for cases not covered by FIT. Examples include
|
U-Boot also provides binman for cases not covered by FIT. Examples include
|
||||||
initial execution (since FIT itself does not have an executable header) and
|
initial execution (since FIT itself does not have an executable header) and
|
||||||
|
|||||||
@@ -157,7 +157,7 @@ development host is to be booted old-style (non-FDT) by U-Boot on an embedded
|
|||||||
target. Assume that the outcome of the build is vmlinux.bin.gz, a file which
|
target. Assume that the outcome of the build is vmlinux.bin.gz, a file which
|
||||||
contains a gzip-compressed PPC Linux kernel (the only data file in this case).
|
contains a gzip-compressed PPC Linux kernel (the only data file in this case).
|
||||||
The uImage can be produced using the image source file
|
The uImage can be produced using the image source file
|
||||||
doc/uImage.FIT/kernel.its (note that kernel.its assumes that vmlinux.bin.gz is
|
doc/usage/fit/kernel.rst (note that kernel.its assumes that vmlinux.bin.gz is
|
||||||
in the current working directory; if desired, an alternative path can be
|
in the current working directory; if desired, an alternative path can be
|
||||||
specified in the kernel.its file). Here's how to create the image and inspect
|
specified in the kernel.its file). Here's how to create the image and inspect
|
||||||
its contents:
|
its contents:
|
||||||
@@ -269,7 +269,7 @@ Example 2 -- new-style (FDT) kernel booting
|
|||||||
Consider another simple scenario, where a PPC Linux kernel is to be booted
|
Consider another simple scenario, where a PPC Linux kernel is to be booted
|
||||||
new-style, i.e., with a FDT blob. In this case there are two prerequisite data
|
new-style, i.e., with a FDT blob. In this case there are two prerequisite data
|
||||||
files: vmlinux.bin.gz (Linux kernel) and target.dtb (FDT blob). The uImage can
|
files: vmlinux.bin.gz (Linux kernel) and target.dtb (FDT blob). The uImage can
|
||||||
be produced using image source file doc/uImage.FIT/kernel_fdt.its like this
|
be produced using image source file doc/usage/fit/kernel_fdt.rst like this
|
||||||
(note again, that both prerequisite data files are assumed to be present in
|
(note again, that both prerequisite data files are assumed to be present in
|
||||||
the current working directory -- image source file kernel_fdt.its can be
|
the current working directory -- image source file kernel_fdt.its can be
|
||||||
modified to take the files from some other location if needed):
|
modified to take the files from some other location if needed):
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ config ECDSA
|
|||||||
This enables the ECDSA (elliptic curve signature) algorithm for FIT
|
This enables the ECDSA (elliptic curve signature) algorithm for FIT
|
||||||
image verification in U-Boot. The ECDSA algorithm is implemented
|
image verification in U-Boot. The ECDSA algorithm is implemented
|
||||||
using the driver model, so CONFIG_DM is required by this library.
|
using the driver model, so CONFIG_DM is required by this library.
|
||||||
See doc/uImage.FIT/signature.txt for more details.
|
See doc/usage/fit/signature.rst for more details.
|
||||||
ECDSA is enabled for mkimage regardless of this option.
|
ECDSA is enabled for mkimage regardless of this option.
|
||||||
|
|
||||||
if ECDSA
|
if ECDSA
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ config RSA
|
|||||||
help
|
help
|
||||||
RSA support. This enables the RSA algorithm used for FIT image
|
RSA support. This enables the RSA algorithm used for FIT image
|
||||||
verification in U-Boot.
|
verification in U-Boot.
|
||||||
See doc/uImage.FIT/signature.txt for more details.
|
See doc/usage/fit/signature.rst for more details.
|
||||||
The Modular Exponentiation algorithm in RSA is implemented using
|
The Modular Exponentiation algorithm in RSA is implemented using
|
||||||
driver model. So CONFIG_DM needs to be enabled by default for this
|
driver model. So CONFIG_DM needs to be enabled by default for this
|
||||||
library to function.
|
library to function.
|
||||||
@@ -88,7 +88,7 @@ config RSA_SOFTWARE_EXP
|
|||||||
Enables driver for modular exponentiation in software. This is a RSA
|
Enables driver for modular exponentiation in software. This is a RSA
|
||||||
algorithm used in FIT image verification. It required RSA Key as
|
algorithm used in FIT image verification. It required RSA Key as
|
||||||
input.
|
input.
|
||||||
See doc/uImage.FIT/signature.txt for more details.
|
See doc/usage/fit/signature.rst for more details.
|
||||||
|
|
||||||
config RSA_FREESCALE_EXP
|
config RSA_FREESCALE_EXP
|
||||||
bool "Enable RSA Modular Exponentiation with FSL crypto accelerator"
|
bool "Enable RSA Modular Exponentiation with FSL crypto accelerator"
|
||||||
|
|||||||
@@ -650,7 +650,7 @@ int fit_image_cipher_data(const char *keydir, void *keydest,
|
|||||||
* |- algo = "sha1"
|
* |- algo = "sha1"
|
||||||
* |- value = sha1(data)
|
* |- value = sha1(data)
|
||||||
*
|
*
|
||||||
* For signature details, please see doc/uImage.FIT/signature.txt
|
* For signature details, please see doc/usage/fit/signature.rst
|
||||||
*
|
*
|
||||||
* @keydir Directory containing *.key and *.crt files (or NULL)
|
* @keydir Directory containing *.key and *.crt files (or NULL)
|
||||||
* @keydest FDT Blob to write public keys into (NULL if none)
|
* @keydest FDT Blob to write public keys into (NULL if none)
|
||||||
|
|||||||
Reference in New Issue
Block a user