summaryrefslogtreecommitdiff
path: root/doc/usage/cmd
diff options
context:
space:
mode:
authorTom Rini <[email protected]>2023-06-16 19:05:52 -0400
committerTom Rini <[email protected]>2023-06-16 19:05:52 -0400
commit1c30e10017ec8bcd0ffec0d8c7d17539ae73dfa7 (patch)
tree6120a7d1a99c25b50896a7d932d431145570f5a4 /doc/usage/cmd
parent2f4664f5c3edc55b18d8906f256a4c8e303243c0 (diff)
parent5669591dd8d2b21bc79237b161107300eb7f2b12 (diff)
Merge tag 'efi-2023-07-rc5' of https://source.denx.de/u-boot/custodians/u-boot-efi
Pull request efi-2023-07-rc5 Documentation: * man-page for imxtract * correct EVT_DM_POST_INIT_F description UEFI: * bootm: don't call booti_setup for EFI images * simplify efi_disk_remove * fix tests that failed when executed repeatedly
Diffstat (limited to 'doc/usage/cmd')
-rw-r--r--doc/usage/cmd/imxtract.rst81
1 files changed, 81 insertions, 0 deletions
diff --git a/doc/usage/cmd/imxtract.rst b/doc/usage/cmd/imxtract.rst
new file mode 100644
index 00000000000..eb64b1cefab
--- /dev/null
+++ b/doc/usage/cmd/imxtract.rst
@@ -0,0 +1,81 @@
+.. SPDX-License-Identifier: GPL-2.0+:
+
+imxtract command
+================
+
+Synopsis
+--------
+
+::
+
+ imxtract addr part [dest]
+ imxtract addr uname [dest]
+
+Description
+-----------
+
+The imxtract command is used to extract a part of a multi-image file.
+
+Two different file formats are supported:
+
+* FIT images
+* legacy U-Boot images
+
+addr
+ Address of the multi-image file from which a part shall be extracted
+
+part
+ Index (hexadecimal) of the part of a legacy U-Boot image to be extracted
+
+uname
+ Name of the part of a FIT image to be extracted
+
+dest
+ Destination address (defaults to 0x0)
+
+The value of environment variable *verify* controls if the hashes and
+signatures of FIT images or the check sums of legacy U-Boot images are checked.
+To enable checking set *verify* to one of the values *1*, *yes*, *true*.
+(Actually only the first letter is checked disregarding the case.)
+
+To list the parts of an image the *iminfo* command can be used.
+
+Examples
+--------
+
+With verify=no incorrect hashes, signatures, or check sums don't stop the
+extraction. But correct hashes are still indicated in the output
+(here: md5, sha1).
+
+.. code-block:: console
+
+ => setenv verify no
+ => imxtract $loadaddr kernel-1 $kernel_addr_r
+ ## Copying 'kernel-1' subimage from FIT image at 40200000 ...
+ md5+ sha1+ Loading part 0 ... OK
+ =>
+
+With verify=yes incorrect hashes, signatures, or check sums stop the extraction.
+
+.. code-block:: console
+
+ => setenv verify yes
+ => imxtract $loadaddr kernel-1 $kernel_addr_r
+ ## Copying 'kernel-1' subimage from FIT image at 40200000 ...
+ md5 error!
+ Bad hash value for 'hash-1' hash node in 'kernel-1' image node
+ Bad Data Hash
+ =>
+
+Configuration
+-------------
+
+The imxtract command is only available if CONFIG_CMD_XIMG=y. Support for FIT
+images requires CONFIG_FIT=y. Support for legacy U-Boot images requires
+CONFIG_LEGACY_IMAGE_FORMAT=y.
+
+Return value
+------------
+
+On success the return value $? of the command is 0 (true). On failure the
+return value is 1 (false).