Commit
488445cefa1 ("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>
Flexible and powerful format based on Flattened Image Tree -- FIT (similar
to Flattened Device Tree). It allows the use of images with multiple
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
- Test
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
- u-boot doc/uImage.FIT/ folder.
+ u-boot doc/usage/fit/ folder.
property will not be loaded. This limitation also applies to FPGA
images with the correct "compatible" string.
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".
"linux" images are also supported with Falcon boot mode.
To create FIT image for download one should follow the update tftp README file
(./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 {
update@1 {
If proper fdt file exists then it will be automatically loaded,
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"
Default boot command: "autoboot"
U-Boot supports an image verification method called "Verified Boot".
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
other boards including 32 bit SoCs.
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
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.
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
replacing U-Boot image on a system.
where the update will be placed is correct. Making mistake here and
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,
ramdisk and FDT blob stored in Flash. The procedure for preparing the update
Generate FIT image (optional)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-See doc/uImage.FIT for more details
+See doc/usage/fit for more details
Pack android boot image
^^^^^^^^^^^^^^^^^^^^^^^
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
-doc/uImage.FIT
+doc/usage/fit
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
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).
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
specified in the kernel.its file). Here's how to create the image and inspect
its contents:
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
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
the current working directory -- image source file kernel_fdt.its can be
modified to take the files from some other location if needed):
This enables the ECDSA (elliptic curve signature) algorithm for FIT
image verification in U-Boot. The ECDSA algorithm is implemented
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.
if ECDSA
help
RSA support. This enables the RSA algorithm used for FIT image
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
driver model. So CONFIG_DM needs to be enabled by default for this
library to function.
Enables driver for modular exponentiation in software. This is a RSA
algorithm used in FIT image verification. It required RSA Key as
input.
- See doc/uImage.FIT/signature.txt for more details.
+ See doc/usage/fit/signature.rst for more details.
config RSA_FREESCALE_EXP
bool "Enable RSA Modular Exponentiation with FSL crypto accelerator"
* |- algo = "sha1"
* |- 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)
* @keydest FDT Blob to write public keys into (NULL if none)